API Documentation

Search/Lucene/Search/QueryToken.php

Classes 
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: QueryToken.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Search_Lucene_Search_QueryToken

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_QueryToken

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
TT_WORD
TT_PHRASE
TT_FIELD
TT_FIELD_INDICATOR
TT_REQUIRED
TT_PROHIBITED
TT_FUZZY_PROX_MARK
TT_BOOSTING_MARK
TT_RANGE_INCL_START
TT_RANGE_INCL_END
TT_RANGE_EXCL_START
TT_RANGE_EXCL_END
TT_SUBQUERY_START
TT_SUBQUERY_END
TT_AND_LEXEME
TT_OR_LEXEME
TT_NOT_LEXEME
TT_TO_LEXEME
TT_NUMBER
TC_WORD
TC_PHRASE
TC_NUMBER
TC_SYNTAX_ELEMENT
Properties
$type
$text
$position
Methods
getTypes
__construct

Description

Constants

TT_WORD

 TT_WORD = '0'

Token types.

Details

value
0

TT_PHRASE

 TT_PHRASE = '1'

Details

value
1

TT_FIELD

 TT_FIELD = '2'

Details

value
2

TT_FIELD_INDICATOR

 TT_FIELD_INDICATOR = '3'

Details

value
3

TT_REQUIRED

 TT_REQUIRED = '4'

Details

value
4

TT_PROHIBITED

 TT_PROHIBITED = '5'

Details

value
5

TT_FUZZY_PROX_MARK

 TT_FUZZY_PROX_MARK = '6'

Details

value
6

TT_BOOSTING_MARK

 TT_BOOSTING_MARK = '7'

Details

value
7

TT_RANGE_INCL_START

 TT_RANGE_INCL_START = '8'

Details

value
8

TT_RANGE_INCL_END

 TT_RANGE_INCL_END = '9'

Details

value
9

TT_RANGE_EXCL_START

 TT_RANGE_EXCL_START = '10'

Details

value
10

TT_RANGE_EXCL_END

 TT_RANGE_EXCL_END = '11'

Details

value
11

TT_SUBQUERY_START

 TT_SUBQUERY_START = '12'

Details

value
12

TT_SUBQUERY_END

 TT_SUBQUERY_END = '13'

Details

value
13

TT_AND_LEXEME

 TT_AND_LEXEME = '14'

Details

value
14

TT_OR_LEXEME

 TT_OR_LEXEME = '15'

Details

value
15

TT_NOT_LEXEME

 TT_NOT_LEXEME = '16'

Details

value
16

TT_TO_LEXEME

 TT_TO_LEXEME = '17'

Details

value
17

TT_NUMBER

 TT_NUMBER = '18'

Details

value
18

TC_WORD

 TC_WORD = '0'

TokenCategories

Details

value
0

TC_PHRASE

 TC_PHRASE = '1'

Details

value
1

TC_NUMBER

 TC_NUMBER = '2'

Details

value
2

TC_SYNTAX_ELEMENT

 TC_SYNTAX_ELEMENT = '3'

Details

value
3

Properties

$position

integer $position = ''

Token position within query.

Details

$position
integer
visibility
public
default
final
false
static
false

$text

integer $text = ''

Token text.

Details

$text
integer
visibility
public
default
final
false
static
false

$type

integer $type = ''

Token type.

Details

$type
integer
visibility
public
default
final
false
static
false

Methods

__construct

__construct( integer $tokenCategory,  $tokenText, integer $position ) :

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

Arguments
$tokenCategory
integer
$tokenText
$position
integer
Details
visibility
public
final
false
static
false

getTypes

getTypes( ) : array

Returns all possible lexeme types.

It's used for syntax analyzer state machine initialization

Output
array
Details
visibility
public
final
false
static
true
Documentation was generated by DocBlox.