diff options
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/ResultSet.php')
| -rw-r--r-- | vendor/ruflin/elastica/lib/Elastica/ResultSet.php | 383 |
1 files changed, 0 insertions, 383 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/ResultSet.php b/vendor/ruflin/elastica/lib/Elastica/ResultSet.php deleted file mode 100644 index 3bb94fb0..00000000 --- a/vendor/ruflin/elastica/lib/Elastica/ResultSet.php +++ /dev/null @@ -1,383 +0,0 @@ -<?php - -namespace Elastica; -use Elastica\Exception\InvalidException; - -/** - * Elastica result set - * - * List of all hits that are returned for a search on elasticsearch - * Result set implements iterator - * - * @category Xodoa - * @package Elastica - * @author Nicolas Ruflin <spam@ruflin.com> - */ -class ResultSet implements \Iterator, \Countable, \ArrayAccess -{ - /** - * Results - * - * @var array Results - */ - protected $_results = array(); - - /** - * Current position - * - * @var int Current position - */ - protected $_position = 0; - - /** - * Response - * - * @var \Elastica\Response Response object - */ - protected $_response = null; - - /** - * Query - * - * @var \Elastica\Query Query object - */ - protected $_query; - - /** - * @var int - */ - protected $_took = 0; - - /** - * @var boolean - */ - protected $_timedOut = false; - - /** - * @var int - */ - protected $_totalHits = 0; - - /** - * @var float - */ - protected $_maxScore = 0; - - /** - * Constructs ResultSet object - * - * @param \Elastica\Response $response Response object - * @param \Elastica\Query $query Query object - */ - public function __construct(Response $response, Query $query) - { - $this->rewind(); - $this->_init($response); - $this->_query = $query; - } - - /** - * Loads all data into the results object (initialisation) - * - * @param \Elastica\Response $response Response object - */ - protected function _init(Response $response) - { - $this->_response = $response; - $result = $response->getData(); - $this->_totalHits = isset($result['hits']['total']) ? $result['hits']['total'] : 0; - $this->_maxScore = isset($result['hits']['max_score']) ? $result['hits']['max_score'] : 0; - $this->_took = isset($result['took']) ? $result['took'] : 0; - $this->_timedOut = !empty($result['timed_out']); - if (isset($result['hits']['hits'])) { - foreach ($result['hits']['hits'] as $hit) { - $this->_results[] = new Result($hit); - } - } - } - - /** - * Returns all results - * - * @return Result[] Results - */ - public function getResults() - { - return $this->_results; - } - - /** - * Returns true if the response contains suggestion results; false otherwise - * @return bool - */ - public function hasSuggests(){ - $data = $this->_response->getData(); - return isset($data['suggest']); - } - - /** - * Return all suggests - * - * @return array suggest results - */ - public function getSuggests() - { - $data = $this->_response->getData(); - return isset($data['suggest']) ? $data['suggest'] : array(); - } - - /** - * Returns whether facets exist - * - * @return boolean Facet existence - */ - public function hasFacets() - { - $data = $this->_response->getData(); - - return isset($data['facets']); - } - - /** - * Returns whether aggregations exist - * - * @return boolean Aggregation existence - */ - public function hasAggregations() - { - $data = $this->_response->getData(); - - return isset($data['aggregations']); - } - - /** - * Returns all aggregation results - * - * @return array - */ - public function getAggregations() - { - $data = $this->_response->getData(); - - return isset($data['aggregations']) ? $data['aggregations'] : array(); - } - - /** - * Retrieve a specific aggregation from this result set - * @param string $name the name of the desired aggregation - * @return array - * @throws Exception\InvalidException if an aggregation by the given name cannot be found - */ - public function getAggregation($name) - { - $data = $this->_response->getData(); - - if (isset($data['aggregations']) && isset($data['aggregations'][$name])) { - return $data['aggregations'][$name]; - } - throw new InvalidException("This result set does not contain an aggregation named {$name}."); - } - - /** - * Returns all facets results - * - * @return array Facet results - */ - public function getFacets() - { - $data = $this->_response->getData(); - - return isset($data['facets']) ? $data['facets'] : array(); - } - - /** - * Returns the total number of found hits - * - * @return int Total hits - */ - public function getTotalHits() - { - return (int) $this->_totalHits; - } - - /** - * Returns the max score of the results found - * - * @return float Max Score - */ - public function getMaxScore() - { - return (float) $this->_maxScore; - } - - /** - * Returns the total number of ms for this search to complete - * - * @return int Total time - */ - public function getTotalTime() - { - return (int) $this->_took; - } - - /** - * Returns true iff the query has timed out - * - * @return bool Timed out - */ - public function hasTimedOut() - { - return (bool) $this->_timedOut; - } - - /** - * Returns response object - * - * @return \Elastica\Response Response object - */ - public function getResponse() - { - return $this->_response; - } - - /** - * @return \Elastica\Query - */ - public function getQuery() - { - return $this->_query; - } - - /** - * Returns size of current set - * - * @return int Size of set - */ - public function count() - { - return sizeof($this->_results); - } - - /** - * Returns size of current suggests - * - * @return int Size of suggests - */ - public function countSuggests() - { - return sizeof($this->getSuggests()); - } - - /** - * Returns the current object of the set - * - * @return \Elastica\Result|bool Set object or false if not valid (no more entries) - */ - public function current() - { - if ($this->valid()) { - return $this->_results[$this->key()]; - } else { - return false; - } - } - - /** - * Sets pointer (current) to the next item of the set - */ - public function next() - { - $this->_position++; - - return $this->current(); - } - - /** - * Returns the position of the current entry - * - * @return int Current position - */ - public function key() - { - return $this->_position; - } - - /** - * Check if an object exists at the current position - * - * @return bool True if object exists - */ - public function valid() - { - return isset($this->_results[$this->key()]); - } - - /** - * Resets position to 0, restarts iterator - */ - public function rewind() - { - $this->_position = 0; - } - - /** - * Whether a offset exists - * @link http://php.net/manual/en/arrayaccess.offsetexists.php - * - * @param integer $offset - * @return boolean true on success or false on failure. - */ - public function offsetExists($offset) - { - return isset($this->_results[$offset]); - } - - /** - * Offset to retrieve - * @link http://php.net/manual/en/arrayaccess.offsetget.php - * - * @param integer $offset - * @throws Exception\InvalidException - * @return Result|null - */ - public function offsetGet($offset) - { - if ($this->offsetExists($offset)) { - return $this->_results[$offset]; - } else { - throw new InvalidException("Offset does not exist."); - } - } - - /** - * Offset to set - * @link http://php.net/manual/en/arrayaccess.offsetset.php - * - * @param integer $offset - * @param Result $value - * @throws Exception\InvalidException - */ - public function offsetSet($offset, $value) - { - if (!($value instanceof Result)) { - throw new InvalidException("ResultSet is a collection of Result only."); - } - - if (!isset($this->_results[$offset])) { - throw new InvalidException("Offset does not exist."); - } - - $this->_results[$offset] = $value; - } - - /** - * Offset to unset - * @link http://php.net/manual/en/arrayaccess.offsetunset.php - * - * @param integer $offset - */ - public function offsetUnset($offset) - { - unset($this->_results[$offset]); - } -} |