Search/Lucene/Search/QueryParser.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: QueryParser.php 21638 2010-03-24 17:56:46Z alexander $
Classes: Zend_Search_Lucene_Search_QueryParser

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_QueryParser
jump to top

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: B_OR; B_AND; ST_COMMON_QUERY_ELEMENT; ST_CLOSEDINT_RQ_START; ST_CLOSEDINT_RQ_FIRST_TERM; ST_CLOSEDINT_RQ_TO_TERM; ST_CLOSEDINT_RQ_LAST_TERM; ST_CLOSEDINT_RQ_END; ST_OPENEDINT_RQ_START; ST_OPENEDINT_RQ_FIRST_TERM; ST_OPENEDINT_RQ_TO_TERM; ST_OPENEDINT_RQ_LAST_TERM; ST_OPENEDINT_RQ_END
Properties: $_instance; $_lexer; $_tokens; $_currentToken; $_lastToken; $_rqFirstTerm; $_context; $_contextStack; $_encoding; $_defaultEncoding; $_suppressQueryParsingExceptions; $_defaultOperator
Methods: __construct; _getInstance; setDefaultEncoding; getDefaultEncoding; setDefaultOperator; getDefaultOperator; suppressQueryParsingExceptions; dontSuppressQueryParsingExceptions; queryParsingExceptionsSuppressed; escape; parse; addTermEntry; addPhraseEntry; setField; setSign; processFuzzyProximityModifier; processModifierParameter; subqueryStart; subqueryEnd; logicalOperator; openedRQFirstTerm; openedRQLastTerm; closedRQFirstTerm; closedRQLastTerm

Description

Constants

B_OR
jump to class

 B_OR = '0'

Boolean operators constants

Details

value: 0

B_AND
jump to class

 B_AND = '1'

Details

value: 1

ST_COMMON_QUERY_ELEMENT
jump to class

 ST_COMMON_QUERY_ELEMENT = '0'

Query parser State Machine states

Details

value: 0

ST_CLOSEDINT_RQ_START
jump to class

 ST_CLOSEDINT_RQ_START = '1'

Details

value: 1

ST_CLOSEDINT_RQ_FIRST_TERM
jump to class

 ST_CLOSEDINT_RQ_FIRST_TERM = '2'

Details

value: 2

ST_CLOSEDINT_RQ_TO_TERM
jump to class

 ST_CLOSEDINT_RQ_TO_TERM = '3'

Details

value: 3

ST_CLOSEDINT_RQ_LAST_TERM
jump to class

 ST_CLOSEDINT_RQ_LAST_TERM = '4'

Details

value: 4

ST_CLOSEDINT_RQ_END
jump to class

 ST_CLOSEDINT_RQ_END = '5'

Details

value: 5

ST_OPENEDINT_RQ_START
jump to class

 ST_OPENEDINT_RQ_START = '6'

Details

value: 6

ST_OPENEDINT_RQ_FIRST_TERM
jump to class

 ST_OPENEDINT_RQ_FIRST_TERM = '7'

Details

value: 7

ST_OPENEDINT_RQ_TO_TERM
jump to class

 ST_OPENEDINT_RQ_TO_TERM = '8'

Details

value: 8

ST_OPENEDINT_RQ_LAST_TERM
jump to class

 ST_OPENEDINT_RQ_LAST_TERM = '9'

Details

value: 9

ST_OPENEDINT_RQ_END
jump to class

 ST_OPENEDINT_RQ_END = '10'

Details

value: 10

Properties

$_context
jump to class

Zend_Search_Lucene_Search_QueryParserContext $_context = ''

Current query parser context

Details

$_context: Zend_Search_Lucene_Search_QueryParserContext
visibility: private
default
final: false
static: false

$_contextStack
jump to class

array $_contextStack = ''

Context stack

Details

$_contextStack: array
visibility: private
default
final: false
static: false

$_currentToken
jump to class

integer|string $_currentToken = ''

Current token

Details

$_currentToken: integer|string
visibility: private
default
final: false
static: false

$_defaultEncoding
jump to class

string $_defaultEncoding = ''

Query string default encoding

Details

$_defaultEncoding: string
visibility: private
default
final: false
static: false

$_defaultOperator
jump to class

integer $_defaultOperator = 'self'

Default boolean queries operator

Details

$_defaultOperator: integer
visibility: private
default: self
final: false
static: false

$_encoding
jump to class

string $_encoding = ''

Query string encoding

Details

$_encoding: string
visibility: private
default
final: false
static: false

$_instance
jump to class

Zend_Search_Lucene_Search_QueryParser $_instance = 'null'

Parser instance

Details

$_instance: Zend_Search_Lucene_Search_QueryParser
visibility: private
default: null
final: false
static: true

$_lastToken
jump to class

Zend_Search_Lucene_Search_QueryToken $_lastToken = 'null'

Last token

It can be processed within FSM states, but this addirional state simplifies FSM

Details

$_lastToken: Zend_Search_Lucene_Search_QueryToken
visibility: private
default: null
final: false
static: false

$_lexer
jump to class

Zend_Search_Lucene_Search_QueryLexer $_lexer = ''

Query lexer

Details

$_lexer: Zend_Search_Lucene_Search_QueryLexer
visibility: private
default
final: false
static: false

$_rqFirstTerm
jump to class

string $_rqFirstTerm = 'null'

Range query first term

Details

$_rqFirstTerm: string
visibility: private
default: null
final: false
static: false

$_suppressQueryParsingExceptions
jump to class

boolean $_suppressQueryParsingExceptions = 'true'

Defines query parsing mode.

If this option is turned on, then query parser suppress query parser exceptions and constructs multi-term query using all words from a query.

That helps to avoid exceptions caused by queries, which don't conform to query language, but limits possibilities to check, that query entered by user has some inconsistencies.

Default is true.

Use {@link Zend_Search_Lucene::suppressQueryParsingExceptions()}, {@link Zend_Search_Lucene::dontSuppressQueryParsingExceptions()} and {@link Zend_Search_Lucene::checkQueryParsingExceptionsSuppressMode()} to operate with this setting.

Details

$_suppressQueryParsingExceptions: boolean
visibility: private
default: true
final: false
static: false

$_tokens
jump to class

array $_tokens = ''

Tokens list Array of Zend_Search_Lucene_Search_QueryToken objects

Details

$_tokens: array
visibility: private
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

Parser constructor

Details

visibility: public
final: false
static: false

_getInstance
jump to class

_getInstance(
          
          )
        
        :
        Zend_Search_Lucene_Search_QueryParser

Get query parser instance

Output

Zend_Search_Lucene_Search_QueryParser

Details

visibility: private
final: false
static: true

addPhraseEntry
jump to class

addPhraseEntry(
          
          )
        
        :

Add phrase to a query

Details

visibility: public
final: false
static: false

addTermEntry
jump to class

addTermEntry(
          
          )
        
        :

Add term to a query

Details

visibility: public
final: false
static: false

closedRQFirstTerm
jump to class

closedRQFirstTerm(
          
          )
        
        :

Process first range query term (closed interval)

Details

visibility: public
final: false
static: false

closedRQLastTerm
jump to class

closedRQLastTerm(
          
          )
        
        :

Process last range query term (closed interval)

Details

visibility: public
final: false
static: false
throws

dontSuppressQueryParsingExceptions
jump to class

dontSuppressQueryParsingExceptions(
          
          )
        
        :

Turn off 'suppress query parser exceptions' mode.

Details

visibility: public
final: false
static: true

escape
jump to class

escape(
          string $keyword
          )
        
        :
        string

Escape keyword to force it to be parsed as one term

Arguments

$keyword: string

Output

string

Details

visibility: public
final: false
static: true

getDefaultEncoding
jump to class

getDefaultEncoding(
          
          )
        
        :
        string

Get query string default encoding

Output

string

Details

visibility: public
final: false
static: true

getDefaultOperator
jump to class

getDefaultOperator(
          
          )
        
        :
        integer

Get default boolean operator

Output

integer

Details

visibility: public
final: false
static: true

logicalOperator
jump to class

logicalOperator(
          
          )
        
        :

Process logical operator

Details

visibility: public
final: false
static: false

openedRQFirstTerm
jump to class

openedRQFirstTerm(
          
          )
        
        :

Process first range query term (opened interval)

Details

visibility: public
final: false
static: false

openedRQLastTerm
jump to class

openedRQLastTerm(
          
          )
        
        :

Process last range query term (opened interval)

Details

visibility: public
final: false
static: false
throws

parse
jump to class

parse(
          string $strQuery, string $encoding
              =
              null
          )
        
        :
        Zend_Search_Lucene_Search_Query

Parses a query string

Arguments

$strQuery: string
$encoding: string

Output

Zend_Search_Lucene_Search_Query

Details

visibility: public
final: false
static: true
throws

processFuzzyProximityModifier
jump to class

processFuzzyProximityModifier(
          
          )
        
        :

Process fuzzy search/proximity modifier - '~'

Details

visibility: public
final: false
static: false

processModifierParameter
jump to class

processModifierParameter(
          
          )
        
        :

Process modifier parameter

Details

visibility: public
final: false
static: false
throws

queryParsingExceptionsSuppressed
jump to class

queryParsingExceptionsSuppressed(
          
          )
        
        :
        boolean

Check 'suppress query parser exceptions' mode.

Output

boolean

Details

visibility: public
final: false
static: true

setDefaultEncoding
jump to class

setDefaultEncoding(
          string $encoding
          )
        
        :

Set query string default encoding

Arguments

$encoding: string

Details

visibility: public
final: false
static: true

setDefaultOperator
jump to class

setDefaultOperator(
          integer $operator
          )
        
        :

Set default boolean operator

Arguments

$operator: integer

Details

visibility: public
final: false
static: true

setField
jump to class

setField(
          
          )
        
        :

Set entry field

Details

visibility: public
final: false
static: false

setSign
jump to class

Set entry sign

Details

visibility: public
final: false
static: false

subqueryEnd
jump to class

subqueryEnd(
          
          )
        
        :

End subquery

Details

visibility: public
final: false
static: false

subqueryStart
jump to class

subqueryStart(
          
          )
        
        :

Start subquery

Details

visibility: public
final: false
static: false

suppressQueryParsingExceptions
jump to class

suppressQueryParsingExceptions(
          
          )
        
        :

Turn on 'suppress query parser exceptions' mode.

Details

visibility: public
final: false
static: true

API Documentation

Search/Lucene/Search/QueryParser.php

Description

Zend_Search_Lucene_Search_QueryParserjump to top

Description

Constants

B_ORjump to class

Details

B_ANDjump to class

Details

ST_COMMON_QUERY_ELEMENTjump to class

Details

ST_CLOSEDINT_RQ_STARTjump to class

Details

ST_CLOSEDINT_RQ_FIRST_TERMjump to class

Details

ST_CLOSEDINT_RQ_TO_TERMjump to class

Details

ST_CLOSEDINT_RQ_LAST_TERMjump to class

Details

ST_CLOSEDINT_RQ_ENDjump to class

Details

ST_OPENEDINT_RQ_STARTjump to class

Details

ST_OPENEDINT_RQ_FIRST_TERMjump to class

Details

ST_OPENEDINT_RQ_TO_TERMjump to class

Details

ST_OPENEDINT_RQ_LAST_TERMjump to class

Details

ST_OPENEDINT_RQ_ENDjump to class

Details

Properties

$_contextjump to class

Details

$_contextStackjump to class

Details

$_currentTokenjump to class

Details

$_defaultEncodingjump to class

Details

$_defaultOperatorjump to class

Details

$_encodingjump to class

Details

$_instancejump to class

Details

$_lastTokenjump to class

Details

$_lexerjump to class

Details

$_rqFirstTermjump to class

Details

$_suppressQueryParsingExceptionsjump to class

Details

$_tokensjump to class

Details

Methods

__constructjump to class

Details

_getInstancejump to class

Output

Details

addPhraseEntryjump to class

Details

addTermEntryjump to class

Details

closedRQFirstTermjump to class

Details

closedRQLastTermjump to class

Details

dontSuppressQueryParsingExceptionsjump to class

Details

escapejump to class

Arguments

Output

Details

getDefaultEncodingjump to class

Output

Details

Zend_Search_Lucene_Search_QueryParser
jump to top

B_OR
jump to class

B_AND
jump to class

ST_COMMON_QUERY_ELEMENT
jump to class

ST_CLOSEDINT_RQ_START
jump to class

ST_CLOSEDINT_RQ_FIRST_TERM
jump to class

ST_CLOSEDINT_RQ_TO_TERM
jump to class

ST_CLOSEDINT_RQ_LAST_TERM
jump to class

ST_CLOSEDINT_RQ_END
jump to class

ST_OPENEDINT_RQ_START
jump to class

ST_OPENEDINT_RQ_FIRST_TERM
jump to class

ST_OPENEDINT_RQ_TO_TERM
jump to class

ST_OPENEDINT_RQ_LAST_TERM
jump to class

ST_OPENEDINT_RQ_END
jump to class

$_context
jump to class

$_contextStack
jump to class

$_currentToken
jump to class

$_defaultEncoding
jump to class

$_defaultOperator
jump to class

$_encoding
jump to class

$_instance
jump to class

$_lastToken
jump to class

$_lexer
jump to class

$_rqFirstTerm
jump to class

$_suppressQueryParsingExceptions
jump to class

$_tokens
jump to class

__construct
jump to class

_getInstance
jump to class

addPhraseEntry
jump to class

addTermEntry
jump to class

closedRQFirstTerm
jump to class

closedRQLastTerm
jump to class

dontSuppressQueryParsingExceptions
jump to class

escape
jump to class

getDefaultEncoding
jump to class

getDefaultOperator
jump to class

logicalOperator
jump to class

openedRQFirstTerm
jump to class

openedRQLastTerm
jump to class

parse
jump to class

processFuzzyProximityModifier
jump to class

processModifierParameter
jump to class

queryParsingExceptionsSuppressed
jump to class

setDefaultEncoding
jump to class

setDefaultOperator
jump to class

setField
jump to class

setSign
jump to class

subqueryEnd
jump to class

subqueryStart
jump to class

suppressQueryParsingExceptions
jump to class