Initial commit
[moodle.git] / search / Zend / Search / Lucene / Index / Term.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 Index
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 /**
24  * A Term represents a word from text.  This is the unit of search.  It is
25  * composed of two elements, the text of the word, as a string, and the name of
26  * the field that the text occured in, an interned string.
27  *
28  * Note that terms may represent more than words from text fields, but also
29  * things like dates, email addresses, urls, etc.
30  *
31  * @category   Zend
32  * @package    Zend_Search_Lucene
33  * @subpackage Index
34  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
35  * @license    http://framework.zend.com/license/new-bsd     New BSD License
36  */
37 class Zend_Search_Lucene_Index_Term
38 {
39     /**
40      * Field name or field number (depending from context)
41      *
42      * @var mixed
43      */
44     public $field;
46     /**
47      * Term value
48      *
49      * @var string
50      */
51     public $text;
54     /**
55      * @todo docblock
56      */
57     public function __construct( $text, $field = 'contents' )
58     {
59         $this->field = $field;
60         $this->text = $text;
61     }
64     /**
65      * @todo docblock
66      */
67     public function key()
68     {
69         return $this->field . chr(0) . $this->text;
70     }
71 }