source: sandbox/expresso-solr/expressoMail1_2/solrclient/library/Solarium/Result/Analysis/Document.php @ 7588

Revision 7588, 3.9 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 * Analysis document query result
41 *
42 * @package Solarium
43 * @subpackage Result
44 */
45class Solarium_Result_Analysis_Document extends Solarium_Result_QueryType
46    implements IteratorAggregate, Countable
47{
48
49    /**
50     * Document instances array
51     *
52     * @var array
53     */
54    protected $_items;
55
56    /**
57     * Status code returned by Solr
58     *
59     * @var int
60     */
61    protected $_status;
62
63    /**
64     * Solr index queryTime
65     *
66     * This doesn't include things like the HTTP responsetime. Purely the Solr
67     * query execution time.
68     *
69     * @var int
70     */
71    protected $_queryTime;
72
73    /**
74     * Get Solr status code
75     *
76     * This is not the HTTP status code! The normal value for success is 0.
77     *
78     * @return int
79     */
80    public function getStatus()
81    {
82        $this->_parseResponse();
83
84        return $this->_status;
85    }
86
87    /**
88     * Get Solr query time
89     *
90     * This doesn't include things like the HTTP responsetime. Purely the Solr
91     * query execution time.
92     *
93     * @return int
94     */
95    public function getQueryTime()
96    {
97        $this->_parseResponse();
98
99        return $this->_queryTime;
100    }
101
102    /**
103     * Get all documents
104     *
105     * @return array
106     */
107    public function getDocuments()
108    {
109        $this->_parseResponse();
110
111        return $this->_items;
112    }
113
114    /**
115     * IteratorAggregate implementation
116     *
117     * @return ArrayIterator
118     */
119    public function getIterator()
120    {
121        $this->_parseResponse();
122
123        return new ArrayIterator($this->_items);
124    }
125
126    /**
127     * Countable implementation
128     *
129     * @return int
130     */
131    public function count()
132    {
133        $this->_parseResponse();
134
135        return count($this->_items);
136    }
137
138    /**
139     * Get a document by uniquekey value
140     *
141     * @param string $key
142     * @return Solarium_Result_Analysis_List|null
143     */
144    public function getDocument($key)
145    {
146        $this->_parseResponse();
147
148        if (isset($this->_items[$key])) {
149            return $this->_items[$key];
150        } else {
151            return null;
152        }
153    }
154
155}
Note: See TracBrowser for help on using the repository browser.