Function Fast_custom_index->get_search_rows

Definitions

sources/database_search.php

  • Get some rows, queried from the database according to the search parameters, using the fast custom index.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$db object required parameter N/A N/A Database connection
$index_table string required parameter N/A N/A Table containing our custom index
$content_table string required parameter N/A N/A The content table to query (may contain JOIN components)
$key_transfer_map array required parameter N/A N/A A map to show how keys relate between the index table and the content table, used to construct a JOIN
$where_clause string required parameter N/A N/A Special WHERE clause querying things from content table (i.e. stuff not covered in our index)
$extra_join_clause string required parameter N/A N/A Extra SQL to insert into the JOIN clauses of each keyword, used to enforce query constraints handled within our indexing
$search_query string required parameter N/A N/A Search query
$only_search_meta boolean required parameter N/A N/A Whether to only do a META (tags) search
$only_titles boolean required parameter N/A N/A Whether to only search titles (as opposed to both titles and content)
$max integer required parameter N/A N/A Start position in total results
$start integer required parameter N/A N/A Maximum results to return in total
$order ID_TEXT required parameter N/A N/A What to order by
$direction ID_TEXT required parameter N/A N/A Order direction
$permissions_module ?string Null N/A N/A The permission module to check category access for (null: none)
$index_permissions_field ?string Null N/A N/A The field that specifies the permissions ID to check category access for (null: none)
$permissions_field_is_string boolean False N/A N/A Whether the permissions field is a string
$force_index ?string Null N/A N/A Force a specific index to be used (null: none)

Return

  • The rows found
  • Type: array
  • Set: N/A
  • Range: N/A