PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of Query.php

(no description)

Copyright:	(C) 2011 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	1332 lines (46 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Query:: (10 methods):
  __construct()
  toUri()
  getExcludedTermIds()
  getIncludedTermIds()
  getRequiredTermIds()
  processStaticTaxonomy()
  processDynamicTaxonomy()
  processDates()
  processString()
  getTokenData()

Class: Query - X-Ref

Query class for the Finder indexer package.

__construct($options, DatabaseInterface $db = null) X-Ref

Method to instantiate the query object.

param: array $options An array of query options.

toUri($base = '') X-Ref

Method to convert the query object into a URI string.

param: string $base The base URI. [optional]
return: string The complete query URI.

getExcludedTermIds() X-Ref

Method to get a list of excluded search term ids.

return: array An array of excluded term ids.

getIncludedTermIds() X-Ref

Method to get a list of included search term ids.

return: array An array of included term ids.

getRequiredTermIds() X-Ref

Method to get a list of required search term ids.

return: array An array of required term ids.

processStaticTaxonomy($filterId) X-Ref

Method to process the static taxonomy input. The static taxonomy input
comes in the form of a pre-defined search filter that is assigned to the
search form.

param: integer $filterId The id of static filter.
return: boolean True on success, false on failure.

processDynamicTaxonomy($filters) X-Ref

Method to process the dynamic taxonomy input. The dynamic taxonomy input
comes in the form of select fields that the user chooses from. The
dynamic taxonomy input is processed AFTER the static taxonomy input
because the dynamic options can be used to further narrow a static
taxonomy filter.

param: array $filters An array of taxonomy node ids.
return: boolean True on success.

processDates($date1, $date2, $when1, $when2) X-Ref

Method to process the query date filters to determine start and end
date limitations.

param: string  $date1  The first date filter.
param: string  $date2  The second date filter.
param: string  $when1  The first date modifier.
param: string  $when2  The second date modifier.
return: boolean  True on success.

processString($input, $lang, $mode) X-Ref

Method to process the query input string and extract required, optional,
and excluded tokens; taxonomy filters; and date filters.

param: string  $input  The query input string.
param: string  $lang   The query input language.
param: string  $mode   The query matching mode.
return: boolean  True on success.

getTokenData($token) X-Ref

Method to get the base and similar term ids and, if necessary, suggested
term data from the database. The terms ids are identified based on a
'like' match in MySQL and/or a common stem. If no term ids could be
found, then we know that we will not be able to return any results for
that term and we should try to find a similar term to use that we can
match so that we can suggest the alternative search query to the user.

param: Token $token A Token object.
return: Token A Token object.

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_finder/src/Indexer/ -> Query.php (summary)

Defines 1 class