Function Module_search->results

Definitions

site/pages/modules/search.php

  • The actualiser of a search.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id ID_TEXT No No required parameter N/A N/A Codename for what's being searched (blank: mixed search)
$author string No No required parameter N/A N/A Author name
$author_id ?AUTO_LINK No No required parameter N/A N/A Author ID (null: none given)
$cutoff mixed No No required parameter N/A N/A Cutoff date (TIME or a pair representing the range or null)
$sort ID_TEXT No No required parameter N/A N/A Sort key
$direction ID_TEXT No No required parameter ASC DESC N/A Sort direction
$only_titles boolean No No required parameter N/A N/A Whether to only search titles
$search_under string No No required parameter N/A N/A Comma-separated list of categories to search under

Returns

  • A triple: The results, pagination, the number of results
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * The actualiser of a search.
 *
 * @param  ID_TEXT $id Codename for what's being searched (blank: mixed search)
 * @param  string $author Author name
 * @param  ?AUTO_LINK $author_id Author ID (null: none given)
 * @param  mixed $cutoff Cutoff date (TIME or a pair representing the range or null)
 * @param  ID_TEXT $sort Sort key
 * @param  ID_TEXT $direction Sort direction
 * @set ASC DESC
 * @param  boolean $only_titles Whether to only search titles
 * @param  string $search_under Comma-separated list of categories to search under
 * @return array A triple: The results, pagination, the number of results
 */
public function results(string $id, string $author, ?int $author_id, $cutoff, string $sort, string $direction, bool $only_titles, string $search_under) : array