\FinderIndexerQuery

Query class for the Finder indexer package.

Synopsis

class FinderIndexerQuery {

• // members
• public  $search;
• public  $input;
• public  $language;
• public  $mode;
• public  $included;
• public  $excluded;
• public  $ignored;
• public  $operators;
• public  $highlight;
• public  $terms;
• public  $filter;
• public  $filters;
• public  $date1;
• public  $date2;
• public  $when1;
• public  $when2;
• // methods
• public void __construct()
• public string toURI()
• public array getExcludedTermIds()
• public array getIncludedTermIds()
• public array getRequiredTermIds()
• protected boolean processStaticTaxonomy()
• protected boolean processDynamicTaxonomy()
• protected boolean processDates()
• protected boolean processString()
• protected FinderIndexerToken getTokenData()
}


Tasks

Tasks

Line	Task
1319	PostgreSQL doesn't support SOUNDEX out of the box

Members

public

• $date1 — string
  The start date filter.
• $date2 — string
  The end date filter.
• $excluded — array
  The excluded tokens.
• $filter — string
  The static filter id.
• $filters — array
  The taxonomy filters. This is a multi-dimensional array of taxonomy branches as the first level and then the taxonomy nodes as the values.
• $highlight — array
  The terms to highlight as matches.
• $ignored — array
  The tokens to ignore because no matches exist.
• $included — array
  The included tokens.
• $input — string
  The query input string.
• $language — string
  The language of the query.
• $mode — string
  The query string matching mode.
• $operators — array
  The operators used in the query input string.
• $search — boolean
  Flag to show whether the query can return results.
• $terms — integer
  The number of matching terms for the query input.
• $when1 — string
  The start date filter modifier.
• $when2 — string
  The end date filter modifier.

Methods

protected

• getTokenData() — 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.
• processDates() — Method to process the query date filters to determine start and end date limitations.
• processDynamicTaxonomy() — 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.
• processStaticTaxonomy() — 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.
• processString() — Method to process the query input string and extract required, optional, and excluded tokens; taxonomy filters; and date filters.

public

• __construct() — Method to instantiate the query object.
• getExcludedTermIds() — Method to get a list of excluded search term ids.
• getIncludedTermIds() — Method to get a list of included search term ids.
• getRequiredTermIds() — Method to get a list of required search term ids.
• toURI() — Method to convert the query object into a URI string.