| 1 |
lars |
1 |
<?php
|
|
|
2 |
/*
|
|
|
3 |
* $Id$
|
|
|
4 |
*
|
|
|
5 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
6 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
7 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
8 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
9 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
10 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
11 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
12 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
13 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
14 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
15 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
16 |
*
|
|
|
17 |
* This software consists of voluntary contributions made by many individuals
|
|
|
18 |
* and is licensed under the LGPL. For more information, see
|
|
|
19 |
* <http://www.doctrine-project.org>.
|
|
|
20 |
*/
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Doctrine_Template_Searchable
|
|
|
24 |
*
|
|
|
25 |
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
|
|
|
26 |
* @package Doctrine
|
|
|
27 |
* @subpackage Template
|
|
|
28 |
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
|
29 |
* @version $Revision$
|
|
|
30 |
* @link www.doctrine-project.org
|
|
|
31 |
* @since 1.0
|
|
|
32 |
*/
|
|
|
33 |
class Doctrine_Template_Searchable extends Doctrine_Template
|
|
|
34 |
{
|
|
|
35 |
/**
|
|
|
36 |
* __construct
|
|
|
37 |
*
|
|
|
38 |
* @param array $options
|
|
|
39 |
* @return void
|
|
|
40 |
*/
|
|
|
41 |
public function __construct(array $options = array())
|
|
|
42 |
{
|
|
|
43 |
parent::__construct($options);
|
|
|
44 |
$this->_plugin = new Doctrine_Search($this->_options);
|
|
|
45 |
}
|
|
|
46 |
|
|
|
47 |
/**
|
|
|
48 |
* Setup the Searchable template behavior
|
|
|
49 |
*
|
|
|
50 |
* @return void
|
|
|
51 |
*/
|
|
|
52 |
public function setUp()
|
|
|
53 |
{
|
|
|
54 |
$this->_plugin->initialize($this->_table);
|
|
|
55 |
|
|
|
56 |
$this->addListener(new Doctrine_Search_Listener($this->_plugin));
|
|
|
57 |
}
|
|
|
58 |
|
|
|
59 |
/**
|
|
|
60 |
* Make the batchUpdateIndex() function available to the template so Doctrine_Record child classes
|
|
|
61 |
* with the behavior enabled can all the function
|
|
|
62 |
*
|
|
|
63 |
* @param integer $limit
|
|
|
64 |
* @param integer $offset
|
|
|
65 |
* @return void
|
|
|
66 |
*/
|
|
|
67 |
public function batchUpdateIndex($limit = null, $offset = null, $encoding = null)
|
|
|
68 |
{
|
|
|
69 |
$this->_plugin->batchUpdateIndex($limit, $offset, $encoding);
|
|
|
70 |
}
|
|
|
71 |
|
|
|
72 |
/**
|
|
|
73 |
* Proxy method so the batch updating can be called from table classes
|
|
|
74 |
*
|
|
|
75 |
* @param integer $limit
|
|
|
76 |
* @param integer $offset
|
|
|
77 |
* @return void
|
|
|
78 |
*/
|
|
|
79 |
public function batchUpdateIndexTableProxy($limit = null, $offset = null, $encoding = null)
|
|
|
80 |
{
|
|
|
81 |
$this->batchUpdateIndex($limit, $offset, $encoding);
|
|
|
82 |
}
|
|
|
83 |
|
|
|
84 |
/**
|
|
|
85 |
* Searchable keyword search proxy for Doctrine_Table
|
|
|
86 |
*
|
|
|
87 |
* @param string $string Keyword string to search for
|
|
|
88 |
* @param Doctrine_Query $query Query object to alter. Adds where condition to limit the results using the search index
|
|
|
89 |
* @return array ids and relevancy
|
|
|
90 |
*/
|
|
|
91 |
public function searchTableProxy($string, $query = null)
|
|
|
92 |
{
|
|
|
93 |
return $this->_plugin->search($string, $query);
|
|
|
94 |
}
|
|
|
95 |
}
|