CirrusSearch\Extra\Query\TokenCountRouter Class Reference

TokenCountRouter query used to trigger a particular query by counting the number of tokens in the user query. More...

Inheritance diagram for CirrusSearch\Extra\Query\TokenCountRouter:

Collaboration diagram for CirrusSearch\Extra\Query\TokenCountRouter:

Public Member Functions
	__construct ( $text, AbstractQuery $fallbackQuery, $field=null, $analyzer=null)
	setText ( $text)
	setFallback (AbstractQuery $query)
	setField ( $field)
	setAnalyzer ( $analyzer)
	addCondition ( $type, $value, AbstractQuery $query)
	Adds a new condition The first condition that evaluates to true is applied.

Public Attributes
const	GT = 'gt'
	@const string greater than
const	GTE = 'gte'
	@const string greater or equal
const	EQ = 'eq'
	@const string equal
const	NEQ = 'neq'
	@const string not equal
const	LTE = 'lte'
	@const string less than or equal
const	LT = 'lt'
	@const string less than

Detailed Description

TokenCountRouter query used to trigger a particular query by counting the number of tokens in the user query.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Constructor & Destructor Documentation

__construct()

CirrusSearch\Extra\Query\TokenCountRouter::__construct	(		$text,
		AbstractQuery	$fallbackQuery,
			$field = null,
			$analyzer = null )

Parameters

string	$text	the text to analyze
AbstractQuery	$fallbackQuery	the query to run when no conditions match
string | null	$field	use the analyzer of this field
string | null	$analyzer	use this analyzer

Member Function Documentation

addCondition()

CirrusSearch\Extra\Query\TokenCountRouter::addCondition	(		$type,
			$value,
		AbstractQuery	$query )

Adds a new condition The first condition that evaluates to true is applied.

If none match the fallback query is applied.

Parameters

string	$type	the condition to apply
int	$value	the value to compare
AbstractQuery	$query	the query to run if the condition is true ignoring all remaining conditions

Returns

self

setAnalyzer()

CirrusSearch\Extra\Query\TokenCountRouter::setAnalyzer

(

$analyzer

)

Parameters

string

$analyzer

the field to fetch analyzer info

Returns

self

setFallback()

CirrusSearch\Extra\Query\TokenCountRouter::setFallback

(

AbstractQuery

$query

)

Parameters

AbstractQuery

$query

Returns

self

setField()

CirrusSearch\Extra\Query\TokenCountRouter::setField

(

$field

)

Parameters

string

$field

the field to fetch analyzer info

Returns

self

setText()

CirrusSearch\Extra\Query\TokenCountRouter::setText

(

$text

)

Parameters

string

$text

count tokens from this text

Returns

self

---

The documentation for this class was generated from the following file:

• includes/Extra/Query/TokenCountRouter.php