Function __global->build_search_results_interface

Definitions

sources/database_search.php

  • Build a templated list of the given search results, for viewing.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$results array No No required parameter N/A N/A Search results
$start integer No No required parameter N/A N/A Start index
$max integer No No required parameter N/A N/A Maximum index
$direction string No No required parameter ASC DESC N/A Sort direction
$general_search boolean No No False N/A N/A Whether this is a general search, rather than a search for a specific result-type (such as all members)

Returns

  • Interface
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Build a templated list of the given search results, for viewing.
 *
 * @param  array $results Search results
 * @param  integer $start Start index
 * @param  integer $max Maximum index
 * @param  string $direction Sort direction
 * @set ASC DESC
 * @param  boolean $general_search Whether this is a general search, rather than a search for a specific result-type (such as all members)
 * @return Tempcode Interface
 */
function build_search_results_interface(array $results, int $start, int $max, string $direction, bool $general_search = false) : object