Function Hook_search_catalogue_entries->index_for_search

Definitions

sources/hooks/modules/search/catalogue_entries.php

  • Perform indexing using the fast custom index.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$since ?TIME No No Null N/A N/A Only index records newer than this (null: no limit)
&$total_singular_ngram_tokens ?integer Yes No Null N/A N/A Write into a count of singular ngrams (typically, words) in here (null: do not count)
&$statistics_map ?array Yes No Null N/A N/A Write into this map of singular ngram (typically, words) to number of occurrences (null: do not maintain a map)

Preview

Code (PHP)

/**
 * Perform indexing using the fast custom index.
 *
 * @param  ?TIME $since Only index records newer than this (null: no limit)
 * @param  ?integer $total_singular_ngram_tokens Write into a count of singular ngrams (typically, words) in here (null: do not count)
 * @param  ?array $statistics_map Write into this map of singular ngram (typically, words) to number of occurrences (null: do not maintain a map)
 */
public function index_for_search(?int $since = null, ?int &$total_singular_ngram_tokens = null, ?array &$statistics_map = null)