Initial commit
[moodle.git] / search / Zend / Search / Lucene / Search / QueryToken.php
1 <?php
2 /**
3  * Zend Framework
4  *
5  * LICENSE
6  *
7  * This source file is subject to the new BSD license that is bundled
8  * with this package in the file LICENSE.txt.
9  * It is also available through the world-wide-web at this URL:
10  * http://framework.zend.com/license/new-bsd
11  * If you did not receive a copy of the license and are unable to
12  * obtain it through the world-wide-web, please send an email
13  * to license@zend.com so we can send you a copy immediately.
14  *
15  * @category   Zend
16  * @package    Zend_Search_Lucene
17  * @subpackage Search
18  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20  */
23 /** Zend_Search_Lucene_Exception */
24 require_once 'Zend/Search/Lucene/Exception.php';
27 /**
28  * @category   Zend
29  * @package    Zend_Search_Lucene
30  * @subpackage Search
31  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
32  * @license    http://framework.zend.com/license/new-bsd     New BSD License
33  */
34 class Zend_Search_Lucene_Search_QueryToken
35 {
36     /**
37      * Token type Word.
38      */
39     const TOKTYPE_WORD = 0;
41     /**
42      * Token type Field.
43      * Field indicator in 'field:word' pair
44      */
45     const TOKTYPE_FIELD = 1;
47     /**
48      * Token type Sign.
49      * '+' (required) or '-' (absentee) sign
50      */
51     const TOKTYPE_SIGN = 2;
53     /**
54      * Token type Bracket.
55      * '(' or ')'
56      */
57     const TOKTYPE_BRACKET = 3;
60     /**
61      * Token type.
62      *
63      * @var integer
64      */
65     public $type;
67     /**
68      * Token text.
69      *
70      * @var integer
71      */
72     public $text;
75     /**
76      * IndexReader constructor needs token type and token text as a parameters.
77      *
78      * @param $tokType integer
79      * @param $tokText string
80      */
81     public function __construct($tokType, $tokText)
82     {
83         switch ($tokType) {
84             case self::TOKTYPE_BRACKET:
85                 // fall through to the next case
86             case self::TOKTYPE_FIELD:
87                 // fall through to the next case
88             case self::TOKTYPE_SIGN:
89                 // fall through to the next case
90             case self::TOKTYPE_WORD:
91                 break;
92             default:
93                 throw new Zend_Search_Lucene_Exception("Unrecognized token type \"$tokType\".");
94         }
96         if (!strlen($tokText)) {
97             throw new Zend_Search_Lucene_Exception('Token text must be supplied.');
98         }
100         $this->type = $tokType;
101         $this->text = $tokText;
102     }