API Documentation

Zend/Search/Lucene/Search/QueryToken.php

Show: inherited
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: QueryToken.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Search_Lucene_Search_QueryToken

Package: Zend\Search\Lucene\Search

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

Constants

Constant  TT_WORD = 0

Token types.

Constant  TT_PHRASE = 1
Constant  TT_FIELD = 2
Constant  TT_FIELD_INDICATOR = 3
Constant  TT_REQUIRED = 4
Constant  TT_PROHIBITED = 5
Constant  TT_FUZZY_PROX_MARK = 6
Constant  TT_BOOSTING_MARK = 7
Constant  TT_RANGE_INCL_START = 8
Constant  TT_RANGE_INCL_END = 9
Constant  TT_RANGE_EXCL_START = 10
Constant  TT_RANGE_EXCL_END = 11
Constant  TT_SUBQUERY_START = 12
Constant  TT_SUBQUERY_END = 13
Constant  TT_AND_LEXEME = 14
Constant  TT_OR_LEXEME = 15
Constant  TT_NOT_LEXEME = 16
Constant  TT_TO_LEXEME = 17
Constant  TT_NUMBER = 18
Constant  TC_WORD = 0

TokenCategories

Constant  TC_PHRASE = 1
Constant  TC_NUMBER = 2
Constant  TC_SYNTAX_ELEMENT = 3

Properties

Propertypublicinteger  $position= ''

Token position within query.

Details
Type
integer
Propertypublicinteger  $text= ''

Token text.

Details
Type
integer
Propertypublicinteger  $type= ''

Token type.

Details
Type
integer

Methods

methodpublic__construct( integer $tokenCategory,  $tokenText, integer $position ) : void

IndexReader constructor needs token type and token text as a parameters.

Parameters
Name Type Description
$tokenCategory integer
$tokenText
$position integer
methodpublicgetTypes( ) : array
static

Returns all possible lexeme types.

It's used for syntax analyzer state machine initialization

Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.