Search/Lucene/Search/QueryLexer.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Search_QueryLexer

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Search_Lucene
Subpackage: Search
Version: $Id: QueryLexer.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Search_Lucene_Search_QueryLexer
jump to top

Package: Zend\Search\Lucene\Search

Abstract Finite State Machine

Take a look on Wikipedia state machine description: http://en.wikipedia.org/wiki/Finite_state_machine

Any type of Transducers (Moore machine or Mealy machine) also may be implemented by using this abstract FSM. process() methods invokes a specified actions which may construct FSM output. Actions may be also used to signal, that we have reached Accept State

Parent(s): \Zend_Search_Lucene_FSM
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                ST_WHITE_SPACE
                = 0

State Machine states

 
                ST_SYNT_LEXEME
                = 1

 
                ST_LEXEME
                = 2

 
                ST_QUOTED_LEXEME
                = 3

 
                ST_ESCAPED_CHAR
                = 4

 
                ST_ESCAPED_QCHAR
                = 5

 
                ST_LEXEME_MODIFIER
                = 6

 
                ST_NUMBER
                = 7

 
                ST_MANTISSA
                = 8

 
                ST_ERROR
                = 9

 
                IN_WHITE_SPACE
                = 0

Input symbols

 
                IN_SYNT_CHAR
                = 1

 
                IN_LEXEME_MODIFIER
                = 2

 
                IN_ESCAPE_CHAR
                = 3

 
                IN_QUOTE
                = 4

 
                IN_DECIMAL_POINT
                = 5

 
                IN_ASCII_DIGIT
                = 6

 
                IN_CHAR
                = 7

 
                IN_MUTABLE_CHAR
                = 8

 
                QUERY_WHITE_SPACE_CHARS
                = " \n\r\t"

 
                QUERY_SYNT_CHARS
                = ':()[]{}!|&'

 
                QUERY_MUTABLE_CHARS
                = '+-'

 
                QUERY_DOUBLECHARLEXEME_CHARS
                = '|&'

 
                QUERY_LEXEMEMODIFIER_CHARS
                = '~^'

 
                QUERY_ASCIIDIGITS_CHARS
                = '0123456789'

Properties

string $_currentLexeme

Recognized part of current lexeme

Details

Type: string

integer|string $_currentState = null

inherited

Current state

Inherited from: \Zend_Search_Lucene_FSM::$$_currentState

Default valuenullDetails

Type: integer | string
Inherited_from: \Zend_Search_Lucene_FSM::$$_currentState

array $_entryActions = array()

inherited

List of entry actions Each action executes when entering the state

Inherited from: \Zend_Search_Lucene_FSM::$$_entryActions

[state] => action

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_FSM::$$_entryActions

array $_exitActions = array()

inherited

List of exit actions Each action executes when exiting the state

Inherited from: \Zend_Search_Lucene_FSM::$$_exitActions

[state] => action

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_FSM::$$_exitActions

array $_inputActions = array()

inherited

List of input actions Each action executes when entering the state

Inherited from: \Zend_Search_Lucene_FSM::$$_inputActions

[state][input] => action

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_FSM::$$_inputActions

array $_inputAphabet = array()

inherited

Input alphabet

Inherited from: \Zend_Search_Lucene_FSM::$$_inputAphabet

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_FSM::$$_inputAphabet

array $_lexemes

List of recognized lexemes

Details

Type: array

array $_queryString

Query string (array of single- or non single-byte characters)

Details

Type: array

integer $_queryStringPosition

Current position within a query string Used to create appropriate error messages

Details

Type: integer

array $_rules = array()

inherited

State transition table

Inherited from: \Zend_Search_Lucene_FSM::$$_rules

[sourceState][input] => targetState

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_FSM::$$_rules

array $_states = array()

inherited

Machine States alphabet

Inherited from: \Zend_Search_Lucene_FSM::$$_states

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_FSM::$$_states

array $_transitionActions = array()

inherited

List of input actions Each action executes when entering the state

Inherited from: \Zend_Search_Lucene_FSM::$$_transitionActions

[state1][state2] => action

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_FSM::$$_transitionActions

Methods

__construct() : void

Finite State machine constructor

$states is an array of integers or strings with a list of possible machine states constructor treats fist list element as a sturt state (assignes it to $_current state). It may be reassigned by setState() call. States list may be empty and can be extended later by addState() or addStates() calls.

$inputAphabet is the same as $states, but represents input alphabet it also may be extended later by addInputSymbols() or addInputSymbol() calls.

$rules parameter describes FSM transitions and has a structure: array( array(sourseState, input, targetState[, inputAction]), array(sourseState, input, targetState[, inputAction]), array(sourseState, input, targetState[, inputAction]), ... ) Rules also can be added later by addRules() and addRule() calls.

FSM actions are very flexible and may be defined by addEntryAction(), addExitAction(), addInputAction() and addTransitionAction() calls.

_positionMsg() : string

Position message

Returns

Type	Description
string

_translateInput(string $char) : integer

Translate input char to an input symbol of state machine

Parameters

Name	Type	Description
$char	string

Returns

Type	Description
integer

addEntryAction(integer | string $state, \Zend_Search_Lucene_FSMAction $action) : void

inherited

Add state entry action.

Inherited from: \Zend_Search_Lucene_FSM::addEntryAction()

Several entry actions are allowed. Action execution order is defined by addEntryAction() calls

Parameters

Name	Type	Description
$state	integer \| string
$action	\Zend_Search_Lucene_FSMAction

addExitAction(integer | string $state, \Zend_Search_Lucene_FSMAction $action) : void

inherited

Add state exit action.

Inherited from: \Zend_Search_Lucene_FSM::addExitAction()

Several exit actions are allowed. Action execution order is defined by addEntryAction() calls

Parameters

Name	Type	Description
$state	integer \| string
$action	\Zend_Search_Lucene_FSMAction

addInputAction(integer | string $state, $inputSymbol, \Zend_Search_Lucene_FSMAction $action) : void

inherited

Add input action (defined by {state, input} pair).

Inherited from: \Zend_Search_Lucene_FSM::addInputAction()

Several input actions are allowed. Action execution order is defined by addInputAction() calls

Parameters

Name	Type	Description
$state	integer \| string
$inputSymbol
$action	\Zend_Search_Lucene_FSMAction

addInputSymbol(integer | string $inputSymbol) : void

inherited

Add symbol to the input alphabet

Inherited from: \Zend_Search_Lucene_FSM::addInputSymbol()

Parameters

Name	Type	Description
$inputSymbol	integer \| string

addInputSymbols(array $inputAphabet) : void

inherited

Add symbols to the input alphabet

Inherited from: \Zend_Search_Lucene_FSM::addInputSymbols()

Parameters

Name	Type	Description
$inputAphabet	array

addLexeme() : void

Add lexeme

addLexemeChar() : void

Extend lexeme by one char

addLexemeModifier() : void

Add lexeme modifier

addNumberLexeme() : void

Add number lexeme

addQuerySyntaxLexeme() : void

Add query syntax lexeme

Throws

Exception	Description
\Zend_Search_Lucene_Search_QueryParserException

addQuotedLexeme() : void

Add quoted lexeme

addRule(integer | string $sourceState, integer | string $input, integer | string $targetState, \Zend_Search_Lucene_FSMAction | null $inputAction = null) : void

inherited

Add symbol to the input alphabet

Inherited from: \Zend_Search_Lucene_FSM::addRule()

Parameters

Name	Type	Description
$sourceState	integer \| string
$input	integer \| string
$targetState	integer \| string
$inputAction	\Zend_Search_Lucene_FSMAction \| null

Throws

Exception	Description
\Zend_Search_Exception

addRules(array $rules) : void

inherited

Add transition rules

Inherited from: \Zend_Search_Lucene_FSM::addRules()

array structure: array( array(sourseState, input, targetState[, inputAction]), array(sourseState, input, targetState[, inputAction]), array(sourseState, input, targetState[, inputAction]), ... )

Parameters

Name	Type	Description
$rules	array

addState(integer | string $state) : void

inherited

Add state to the state machine

Inherited from: \Zend_Search_Lucene_FSM::addState()

Parameters

Name	Type	Description
$state	integer \| string

addStates(array $states) : void

inherited

Add states to the state machine

Inherited from: \Zend_Search_Lucene_FSM::addStates()

Parameters

Name	Type	Description
$states	array

addTransitionAction(integer | string $sourceState, integer | string $targetState, \Zend_Search_Lucene_FSMAction $action) : void

inherited

Add transition action (defined by {state, input} pair).

Inherited from: \Zend_Search_Lucene_FSM::addTransitionAction()

Several transition actions are allowed. Action execution order is defined by addTransitionAction() calls

Parameters

Name	Type	Description
$sourceState	integer \| string
$targetState	integer \| string
$action	\Zend_Search_Lucene_FSMAction

getState() : integer | string

inherited

Get FSM state.

Inherited from: \Zend_Search_Lucene_FSM::getState()

Returns

Type	Description
integer \| string	$state\|null

lexModifierErrException() : void

process(mixed $input) : void

inherited

Process an input

Inherited from: \Zend_Search_Lucene_FSM::process()

Parameters

Name	Type	Description
$input	mixed

Throws

Exception	Description
\Zend_Search_Exception

quoteWithinLexemeErrException() : void

reset() : void

inherited

Inherited from: \Zend_Search_Lucene_FSM::reset()

setState(integer | string $state) : void

inherited

Set FSM state.

Inherited from: \Zend_Search_Lucene_FSM::setState()

No any action is invoked

Parameters

Name	Type	Description
$state	integer \| string

Throws

Exception	Description
\Zend_Search_Exception

tokenize(string $inputString, string $encoding) : array

This method is used to tokenize query string into lexemes

Parameters

Name	Type	Description
$inputString	string
$encoding	string

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Search_Lucene_Search_QueryParserException

wrongNumberErrException() : void

Search/Lucene/Search/QueryLexer.php

\Zend_Search_Lucene_Search_QueryLexerjump to top

Constants

Properties

Methods

\Zend_Search_Lucene_Search_QueryLexer
jump to top