Search/Lucene/Search/QueryLexer.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Search
- version
- $Id: QueryLexer.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Search_Lucene_Search_QueryLexer
Description
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.
Zend_Search_Lucene_Search_QueryLexer
- Extends from
- Zend_Search_Lucene_FSM
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Search_Lucene
- subpackage
- Search
- Constants
- ST_WHITE_SPACE
- ST_SYNT_LEXEME
- ST_LEXEME
- ST_QUOTED_LEXEME
- ST_ESCAPED_CHAR
- ST_ESCAPED_QCHAR
- ST_LEXEME_MODIFIER
- ST_NUMBER
- ST_MANTISSA
- ST_ERROR
- IN_WHITE_SPACE
- IN_SYNT_CHAR
- IN_LEXEME_MODIFIER
- IN_ESCAPE_CHAR
- IN_QUOTE
- IN_DECIMAL_POINT
- IN_ASCII_DIGIT
- IN_CHAR
- IN_MUTABLE_CHAR
- QUERY_WHITE_SPACE_CHARS
- QUERY_SYNT_CHARS
- QUERY_MUTABLE_CHARS
- QUERY_DOUBLECHARLEXEME_CHARS
- QUERY_LEXEMEMODIFIER_CHARS
- QUERY_ASCIIDIGITS_CHARS
- Properties
- $_lexemes
- $_queryString
- $_queryStringPosition
- $_currentLexeme
- Methods
- __construct
- _translateInput
- tokenize
- addQuerySyntaxLexeme
- addLexemeModifier
- addLexeme
- addQuotedLexeme
- addNumberLexeme
- addLexemeChar
- _positionMsg
- lexModifierErrException
- quoteWithinLexemeErrException
- wrongNumberErrException
Description
Constants
ST_WHITE_SPACE
ST_WHITE_SPACE = '0'
State Machine states
Details
- value
- 0
ST_SYNT_LEXEME
ST_SYNT_LEXEME = '1'
Details
- value
- 1
ST_LEXEME
ST_LEXEME = '2'
Details
- value
- 2
ST_QUOTED_LEXEME
ST_QUOTED_LEXEME = '3'
Details
- value
- 3
ST_ESCAPED_CHAR
ST_ESCAPED_CHAR = '4'
Details
- value
- 4
ST_ESCAPED_QCHAR
ST_ESCAPED_QCHAR = '5'
Details
- value
- 5
ST_LEXEME_MODIFIER
ST_LEXEME_MODIFIER = '6'
Details
- value
- 6
ST_NUMBER
ST_NUMBER = '7'
Details
- value
- 7
ST_MANTISSA
ST_MANTISSA = '8'
Details
- value
- 8
ST_ERROR
ST_ERROR = '9'
Details
- value
- 9
IN_WHITE_SPACE
IN_WHITE_SPACE = '0'
Input symbols
Details
- value
- 0
IN_SYNT_CHAR
IN_SYNT_CHAR = '1'
Details
- value
- 1
IN_LEXEME_MODIFIER
IN_LEXEME_MODIFIER = '2'
Details
- value
- 2
IN_ESCAPE_CHAR
IN_ESCAPE_CHAR = '3'
Details
- value
- 3
IN_QUOTE
IN_QUOTE = '4'
Details
- value
- 4
IN_DECIMAL_POINT
IN_DECIMAL_POINT = '5'
Details
- value
- 5
IN_ASCII_DIGIT
IN_ASCII_DIGIT = '6'
Details
- value
- 6
IN_CHAR
IN_CHAR = '7'
Details
- value
- 7
IN_MUTABLE_CHAR
IN_MUTABLE_CHAR = '8'
Details
- value
- 8
QUERY_WHITE_SPACE_CHARS
QUERY_WHITE_SPACE_CHARS = ' \n\r\t'
Details
- value
- \n\r\t
QUERY_SYNT_CHARS
QUERY_SYNT_CHARS = ':()[]{}!|&'
Details
- value
- :()[]{}!|&
QUERY_MUTABLE_CHARS
QUERY_MUTABLE_CHARS = '+-'
Details
- value
- +-
QUERY_DOUBLECHARLEXEME_CHARS
QUERY_DOUBLECHARLEXEME_CHARS = '|&'
Details
- value
- |&
QUERY_LEXEMEMODIFIER_CHARS
QUERY_LEXEMEMODIFIER_CHARS = '~^'
Details
- value
- ~^
QUERY_ASCIIDIGITS_CHARS
QUERY_ASCIIDIGITS_CHARS = '0123456789'
Details
- value
- 0123456789
Properties
$_currentLexeme
string $_currentLexeme = ''Recognized part of current lexeme
Details
- $_currentLexeme
- string
- visibility
- private
- default
- final
- false
- static
- false
$_lexemes
array $_lexemes = ''List of recognized lexemes
Details
- $_lexemes
- array
- visibility
- private
- default
- final
- false
- static
- false
$_queryString
array $_queryString = ''Query string (array of single- or non single-byte characters)
Details
- $_queryString
- array
- visibility
- private
- default
- final
- false
- static
- false
$_queryStringPosition
integer $_queryStringPosition = ''Current position within a query string Used to create appropriate error messages
Details
- $_queryStringPosition
- integer
- visibility
- private
- default
- final
- false
- static
- false
Methods
__construct
__construct(
)
:
Details
- visibility
- public
- final
- false
- static
- false
_positionMsg
_positionMsg(
)
:
stringPosition message
Output
- string
Details
- visibility
- private
- final
- false
- static
- false
_translateInput
_translateInput(
string $char
)
:
integerTranslate input char to an input symbol of state machine
Arguments
- $char
- string
Output
- integer
Details
- visibility
- private
- final
- false
- static
- false
addLexeme
addLexeme(
)
:
Add lexeme
Details
- visibility
- public
- final
- false
- static
- false
addLexemeChar
addLexemeChar(
)
:
Extend lexeme by one char
Details
- visibility
- public
- final
- false
- static
- false
addLexemeModifier
addLexemeModifier(
)
:
Add lexeme modifier
Details
- visibility
- public
- final
- false
- static
- false
addNumberLexeme
addNumberLexeme(
)
:
Add number lexeme
Details
- visibility
- public
- final
- false
- static
- false
addQuerySyntaxLexeme
addQuerySyntaxLexeme(
)
:
Add query syntax lexeme
Details
- visibility
- public
- final
- false
- static
- false
- throws
addQuotedLexeme
addQuotedLexeme(
)
:
Add quoted lexeme
Details
- visibility
- public
- final
- false
- static
- false
lexModifierErrException
lexModifierErrException(
)
:
Details
- visibility
- public
- final
- false
- static
- false
quoteWithinLexemeErrException
quoteWithinLexemeErrException(
)
:
Details
- visibility
- public
- final
- false
- static
- false
tokenize
tokenize(
string $inputString, string $encoding
)
:
arrayThis method is used to tokenize query string into lexemes
Arguments
- $inputString
- string
- $encoding
- string
Output
- array
Details
- visibility
- public
- final
- false
- static
- false
- throws
wrongNumberErrException
wrongNumberErrException(
)
:
Details
- visibility
- public
- final
- false
- static
- false