Zend_Search_Lucene_Search_QueryParser Class Reference

Public Member Functions
	__construct ()
	Parser constructor.
	addTermEntry ()
	Add term to a query.
	addPhraseEntry ()
	Add phrase to a query.
	setField ()
	Set entry field.
	setSign ()
	Set entry sign.
	processFuzzyProximityModifier ()
	Process fuzzy search/proximity modifier - '~'.
	processModifierParameter ()
	Process modifier parameter.
	subqueryStart ()
	Start subquery.
	subqueryEnd ()
	End subquery.
	logicalOperator ()
	Process logical operator.
	openedRQFirstTerm ()
	Process first range query term (opened interval)
	openedRQLastTerm ()
	Process last range query term (opened interval)
	closedRQFirstTerm ()
	Process first range query term (closed interval)
	closedRQLastTerm ()
	Process last range query term (closed interval)
Public Member Functions inherited from Zend_Search_Lucene_FSM
	__construct ($states=array(), $inputAphabet=array(), $rules=array())
	Finite State machine constructor.
	addStates ($states)
	Add states to the state machine.
	addState ($state)
	Add state to the state machine.
	setState ($state)
	Set FSM state.
	getState ()
	Get FSM state.
	addInputSymbols ($inputAphabet)
	Add symbols to the input alphabet.
	addInputSymbol ($inputSymbol)
	Add symbol to the input alphabet.
	addRules ($rules)
	Add transition rules.
	addRule ($sourceState, $input, $targetState, $inputAction=null)
	Add symbol to the input alphabet.
	addEntryAction ($state, Zend_Search_Lucene_FSMAction $action)
	Add state entry action.
	addExitAction ($state, Zend_Search_Lucene_FSMAction $action)
	Add state exit action.
	addInputAction ($state, $inputSymbol, Zend_Search_Lucene_FSMAction $action)
	Add input action (defined by {state, input} pair).
	addTransitionAction ($sourceState, $targetState, Zend_Search_Lucene_FSMAction $action)
	Add transition action (defined by {state, input} pair).
	process ($input)
	Process an input.
	reset ()

Static Public Member Functions
static	setDefaultEncoding ($encoding)
	Set query string default encoding.
static	getDefaultEncoding ()
	Get query string default encoding.
static	setDefaultOperator ($operator)
	Set default boolean operator.
static	getDefaultOperator ()
	Get default boolean operator.
static	suppressQueryParsingExceptions ()
	Turn on 'suppress query parser exceptions' mode.
static	dontSuppressQueryParsingExceptions ()
	Turn off 'suppress query parser exceptions' mode.
static	queryParsingExceptionsSuppressed ()
	Check 'suppress query parser exceptions' mode.
static	escape ($keyword)
	Escape keyword to force it to be parsed as one term.
static	parse ($strQuery, $encoding=null)
	Parses a query string.

Public Attributes
const	B_OR = 0
	Boolean operators constants.
const	B_AND = 1
const	ST_COMMON_QUERY_ELEMENT = 0
	Query parser State Machine states.
const	ST_CLOSEDINT_RQ_START = 1
const	ST_CLOSEDINT_RQ_FIRST_TERM = 2
const	ST_CLOSEDINT_RQ_TO_TERM = 3
const	ST_CLOSEDINT_RQ_LAST_TERM = 4
const	ST_CLOSEDINT_RQ_END = 5
const	ST_OPENEDINT_RQ_START = 6
const	ST_OPENEDINT_RQ_FIRST_TERM = 7
const	ST_OPENEDINT_RQ_TO_TERM = 8
const	ST_OPENEDINT_RQ_LAST_TERM = 9
const	ST_OPENEDINT_RQ_END = 10

Constructor & Destructor Documentation

__construct

(

)

Parser constructor.

Member Function Documentation

addPhraseEntry

(

)

Add phrase to a query.

addTermEntry

(

)

Add term to a query.

closedRQFirstTerm

(

)

Process first range query term (closed interval)

closedRQLastTerm

(

)

Process last range query term (closed interval)

Exceptions

Zend_Search_Lucene_Search_QueryParserException

static dontSuppressQueryParsingExceptions ( )

static

Turn off 'suppress query parser exceptions' mode.

static escape (   $keyword )

static

Escape keyword to force it to be parsed as one term.

Parameters

string

$keyword

Returns

string

static getDefaultEncoding ( )

static

Get query string default encoding.

Returns

string

static getDefaultOperator ( )

static

Get default boolean operator.

Returns

integer

logicalOperator

(

)

Process logical operator.

openedRQFirstTerm

(

)

Process first range query term (opened interval)

openedRQLastTerm

(

)

Process last range query term (opened interval)

Exceptions

Zend_Search_Lucene_Search_QueryParserException

static parse (   $strQuery,   $encoding = null  )

static

Parses a query string.

Parameters

string	$strQuery
string	$encoding

Returns

Zend_Search_Lucene_Search_Query

Exceptions

Zend_Search_Lucene_Search_QueryParserException

processFuzzyProximityModifier

(

)

Process fuzzy search/proximity modifier - '~'.

processModifierParameter

(

)

Process modifier parameter.

Exceptions

Zend_Search_Lucene_Exception

static queryParsingExceptionsSuppressed ( )

static

Check 'suppress query parser exceptions' mode.

Returns

boolean

static setDefaultEncoding (   $encoding )

static

Set query string default encoding.

Parameters

string

$encoding

static setDefaultOperator (   $operator )

static

Set default boolean operator.

Parameters

integer

$operator

setField

(

)

Set entry field.

setSign

(

)

Set entry sign.

subqueryEnd

(

)

End subquery.

subqueryStart

(

)

Start subquery.

static suppressQueryParsingExceptions ( )

static

Turn on 'suppress query parser exceptions' mode.

Member Data Documentation

const B_AND = 1

const B_OR = 0

Boolean operators constants.

const ST_CLOSEDINT_RQ_END = 5

const ST_CLOSEDINT_RQ_FIRST_TERM = 2

const ST_CLOSEDINT_RQ_LAST_TERM = 4

const ST_CLOSEDINT_RQ_START = 1

const ST_CLOSEDINT_RQ_TO_TERM = 3

const ST_COMMON_QUERY_ELEMENT = 0

Query parser State Machine states.

const ST_OPENEDINT_RQ_END = 10

const ST_OPENEDINT_RQ_FIRST_TERM = 7

const ST_OPENEDINT_RQ_LAST_TERM = 9

const ST_OPENEDINT_RQ_START = 6

const ST_OPENEDINT_RQ_TO_TERM = 8