Search/Lucene/Search/QueryParserContext.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: QueryParserContext.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Search_Lucene_Search_QueryParserContext

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

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: GM_SIGNS; GM_BOOLEAN
Properties: $_defaultField; $_nextEntryField; $_nextEntrySign; $_mode; $_signs; $_entries; $_encoding
Methods: __construct; getField; setNextEntryField; setNextEntrySign; addEntry; processFuzzyProximityModifier; boost; addLogicalOperator; _signStyleExpressionQuery; _booleanExpressionQuery; getQuery

Description

Constants

GM_SIGNS
jump to class

 GM_SIGNS = '0'

Entries grouping mode

Details

value: 0

GM_BOOLEAN
jump to class

 GM_BOOLEAN = '1'

Details

value: 1

Properties

$_defaultField
jump to class

string|null $_defaultField = ''

Default field for the context.

null means, that term should be searched through all fields Zend_Search_Lucene_Search_Query::rewriteQuery($index) transletes such queries to several

Details

$_defaultField: string|null
visibility: private
default
final: false
static: false

$_encoding
jump to class

string $_encoding = ''

Query string encoding

Details

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

$_entries
jump to class

array $_entries = 'array'

Query entries Each entry is a Zend_Search_Lucene_Search_QueryEntry object or boolean operator (Zend_Search_Lucene_Search_QueryToken class constant)

Details

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

$_mode
jump to class

integer $_mode = 'null'

Grouping mode

Details

$_mode: integer
visibility: private
default: null
final: false
static: false

$_nextEntryField
jump to class

string $_nextEntryField = 'null'

Field specified for next entry

Details

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

$_nextEntrySign
jump to class

boolean $_nextEntrySign = 'null'

True means, that term is required.

False means, that term is prohibited. null means, that term is neither prohibited, nor required

Details

$_nextEntrySign: boolean
visibility: private
default: null
final: false
static: false

$_signs
jump to class

arrays $_signs = 'array'

Entries signs.

Used in GM_SIGNS grouping mode

Details

$_signs: arrays
visibility: private
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $encoding, string|null $defaultField
              =
              null
          )
        
        :

Context object constructor

Arguments

$encoding: string
$defaultField: stringnull

Details

visibility: public
final: false
static: false

_booleanExpressionQuery
jump to class

_booleanExpressionQuery(
          
          )
        
        :
        Zend_Search_Lucene_Search_Query

Generate 'boolean style' query from the context 'term1 and term2 or term3 and (<subquery1>) and not (<subquery2>)'

Output

Zend_Search_Lucene_Search_Query

Details

visibility: private
final: false
static: false
throws

_signStyleExpressionQuery
jump to class

_signStyleExpressionQuery(
          
          )
        
        :
        Zend_Search_Lucene_Search_Query

Generate 'signs style' query from the context '+term1 term2 -term3 +(<subquery1>) ...'

Output

Zend_Search_Lucene_Search_Query

Details

visibility: public
final: false
static: false

addEntry
jump to class

addEntry(
          Zend_Search_Lucene_Search_QueryEntry $entry
          )
        
        :

Add entry to a query

Arguments

$entry: Zend_Search_Lucene_Search_QueryEntry

Details

visibility: public
final: false
static: false

addLogicalOperator
jump to class

addLogicalOperator(
          integer $operator
          )
        
        :

Process logical operator

Arguments

$operator: integer

Details

visibility: public
final: false
static: false

boost
jump to class

boost(
          float $boostFactor
          )
        
        :

Set boost factor to the entry

Arguments

$boostFactor: float

Details

visibility: public
final: false
static: false

getField
jump to class

getField(
          
          )
        
        :
        string|null

Get context default field

Output

string|null

Details

visibility: public
final: false
static: false

getQuery
jump to class

getQuery(
          
          )
        
        :
        Zend_Search_Lucene_Search_Query

Generate query from current context

Output

Zend_Search_Lucene_Search_Query

Details

visibility: public
final: false
static: false

processFuzzyProximityModifier
jump to class

processFuzzyProximityModifier(
           $parameter
              =
              null
          )
        
        :

Process fuzzy search or proximity search modifier

Arguments

$parameter

Details

visibility: public
final: false
static: false
throws

setNextEntryField
jump to class

setNextEntryField(
          string $field
          )
        
        :

Set field for next entry

Arguments

$field: string

Details

visibility: public
final: false
static: false

setNextEntrySign
jump to class

setNextEntrySign(
          integer $sign
          )
        
        :

Set sign for next entry

Arguments

$sign: integer

Details

visibility: public
final: false
static: false
throws

API Documentation

Search/Lucene/Search/QueryParserContext.php

Description

Zend_Search_Lucene_Search_QueryParserContextjump to top

Description

Constants

GM_SIGNSjump to class

Details

GM_BOOLEANjump to class

Details

Properties

$_defaultFieldjump to class

Details

$_encodingjump to class

Details

$_entriesjump to class

Details

$_modejump to class

Details

$_nextEntryFieldjump to class

Details

$_nextEntrySignjump to class

Details

$_signsjump to class

Details

Methods

__constructjump to class

Arguments

Details

_booleanExpressionQueryjump to class

Output

Details

_signStyleExpressionQueryjump to class

Output

Details

addEntryjump to class

Arguments

Details

addLogicalOperatorjump to class

Arguments

Details

boostjump to class

Arguments

Details

getFieldjump to class

Output

Details

getQueryjump to class

Output

Details

processFuzzyProximityModifierjump to class

Arguments

Details

setNextEntryFieldjump to class

Arguments

Details

setNextEntrySignjump to class

Arguments

Details

Zend_Search_Lucene_Search_QueryParserContext
jump to top

GM_SIGNS
jump to class

GM_BOOLEAN
jump to class

$_defaultField
jump to class

$_encoding
jump to class

$_entries
jump to class

$_mode
jump to class

$_nextEntryField
jump to class

$_nextEntrySign
jump to class

$_signs
jump to class

__construct
jump to class

_booleanExpressionQuery
jump to class

_signStyleExpressionQuery
jump to class

addEntry
jump to class

addLogicalOperator
jump to class

boost
jump to class

getField
jump to class

getQuery
jump to class

processFuzzyProximityModifier
jump to class

setNextEntryField
jump to class

setNextEntrySign
jump to class