source: sandbox/expresso-solr/expressoMail1_2/inc/solrclient/library/Solarium/Result/Suggester.php @ 7576

Revision 7576, 4.2 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade

Line 
1<?php
2/**
3 * Copyright 2011 Bas de Nooijer. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice,
9 *    this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 *    this listof conditions and the following disclaimer in the documentation
13 *    and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
26 *
27 * The views and conclusions contained in the software and documentation are
28 * those of the authors and should not be interpreted as representing official
29 * policies, either expressed or implied, of the copyright holder.
30 *
31 * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
32 * @license http://github.com/basdenooijer/solarium/raw/master/COPYING
33 * @link http://www.solarium-project.org/
34 *
35 * @package Solarium
36 * @subpackage Result
37 */
38
39/**
40 * Suggester query result
41 *
42 * @package Solarium
43 * @subpackage Result
44 */
45class Solarium_Result_Suggester extends Solarium_Result_QueryType implements IteratorAggregate, Countable
46{
47    /**
48     * Status code returned by Solr
49     *
50     * @var int
51     */
52    protected $_status;
53
54    /**
55     * Solr index queryTime
56     *
57     * This doesn't include things like the HTTP responsetime. Purely the Solr
58     * query execution time.
59     *
60     * @var int
61     */
62    protected $_queryTime;
63
64    /**
65     * Suggester results
66     *
67     * @var array
68     */
69    protected $_results;
70
71    /**
72     * Collation result
73     *
74     * Only available when collate is enabled in the suggester query
75     *
76     * @var string
77     */
78    protected $_collation;
79
80    /**
81     * Get Solr status code
82     *
83     * This is not the HTTP status code! The normal value for success is 0.
84     *
85     * @return int
86     */
87    public function getStatus()
88    {
89        $this->_parseResponse();
90
91        return $this->_status;
92    }
93
94    /**
95     * Get Solr query time
96     *
97     * This doesn't include things like the HTTP responsetime. Purely the Solr
98     * query execution time.
99     *
100     * @return int
101     */
102    public function getQueryTime()
103    {
104        $this->_parseResponse();
105
106        return $this->_queryTime;
107    }
108
109    /**
110     * Get all results
111     *
112     * @return array
113     */
114    public function getResults()
115    {
116        $this->_parseResponse();
117
118        return $this->_results;
119    }
120
121    /**
122     * Get results for a specific term
123     *
124     * @param string $term
125     * @return array
126     */
127    public function getTerm($term)
128    {
129        $this->_parseResponse();
130
131        if (isset($this->_results[$term])) {
132            return $this->_results[$term];
133        } else {
134            return array();
135        }
136    }
137
138    /**
139     * IteratorAggregate implementation
140     *
141     * @return ArrayIterator
142     */
143    public function getIterator()
144    {
145        $this->_parseResponse();
146
147        return new ArrayIterator($this->_results);
148    }
149
150    /**
151     * Countable implementation
152     *
153     * @return int
154     */
155    public function count()
156    {
157        $this->_parseResponse();
158
159        return count($this->_results);
160    }
161
162    /**
163     * Get collation
164     *
165     * @return null|string
166     */
167    public function getCollation()
168    {
169        $this->_parseResponse();
170
171        return $this->_collation;
172    }
173}
Note: See TracBrowser for help on using the repository browser.