Location: PHPKode > scripts > Fantastic ElasticSearch > wordpress-fantastic-elasticsearch-1.1.2/lib/Elastica/Query.php
<?php
/**
 * Elastica query object
 *
 * Creates different types of queries
 *
 * @category Xodoa
 * @package Elastica
 * @author Nicolas Ruflin <hide@address.com>
 * @link http://www.elasticsearch.org/guide/reference/api/search/
 */
class Elastica_Query extends Elastica_Param
{
    /**
     * Params
     *
     * @var array Params
     */
    protected $_params = array();

    /**
     * Creates a query object
     *
     * @param array|Elastica_Query_Abstract $query OPTIONAL Query object (default = null)
     */
    public function __construct($query = null)
    {
        if (is_array($query)) {
            $this->setRawQuery($query);
        } elseif ($query instanceof Elastica_Query_Abstract) {
            $this->setQuery($query);
        }
    }

    /**
     * Transforms a string or an array to a query object
     *
     * If query is empty,
     *
     * @param  mixed          $query
     * @return Elastica_Query
     **/
    public static function create($query)
    {
        switch (true) {
            case $query instanceof Elastica_Query:
                return $query;
            case $query instanceof Elastica_Query_Abstract:
                return new self($query);
            case $query instanceof Elastica_Filter_Abstract:
                $newQuery = new Elastica_Query();
                $newQuery->setFilter($query);

                return $newQuery;
            case empty($query):
                return new self(new Elastica_Query_MatchAll());
            case is_string($query):
                return new self(new Elastica_Query_QueryString($query));

        }

        // TODO: Implement queries without
        throw new Elastica_Exception_NotImplemented();
    }

    /**
     * Sets query as raw array. Will overwrite all already set arguments
     *
     * @param  array          $query Query array
     * @return Elastica_Query Query object
     */
    public function setRawQuery(array $query)
    {
        $this->_params = $query;

        return $this;
    }

    /**
     * Sets the query
     *
     * @param  Elastica_Query_Abstract $query Query object
     * @return Elastica_Query          Query object
     */
    public function setQuery(Elastica_Query_Abstract $query)
    {
        return $this->setParam('query', $query->toArray());
    }

    /**
     * Gets the query array
     *
     * @return array
     **/
    public function getQuery()
    {
        return $this->getParam('query');
    }

    /**
     * Set Filter
     *
     * @param  Elastica_Filter_Abstract $filter Filter object
     * @return Elastica_Query           Current object
     */
    public function setFilter(Elastica_Filter_Abstract $filter)
    {
        return $this->setParam('filter', $filter->toArray());
    }

    /**
     * Sets the start from which the search results should be returned
     *
     * @param  int            $from
     * @return Elastica_Query Query object
     */
    public function setFrom($from)
    {
        return $this->setParam('from', $from);
    }

    /**
     * Sets sort arguments for the query
     * Replaces existing values
     *
     * @param  array          $sortArgs Sorting arguments
     * @return Elastica_Query Query object
     * @link http://www.elasticsearch.org/guide/reference/api/search/sort.html
     */
    public function setSort(array $sortArgs)
    {
        return $this->setParam('sort', $sortArgs);
    }

    /**
     * Adds a sort param to the query
     *
     * @param  mixed          $sort Sort parameter
     * @return Elastica_Query Query object
     * @link http://www.elasticsearch.org/guide/reference/api/search/sort.html
     */
    public function addSort($sort)
    {
        return $this->addParam('sort', $sort);
    }

    /**
     * Sets highlight arguments for the query
     *
     * @param  array          $highlightArgs Set all highlight arguments
     * @return Elastica_Query Query object
     * @link http://www.elasticsearch.org/guide/reference/api/search/highlighting.html
     */
    public function setHighlight(array $highlightArgs)
    {
        return $this->setParam('highlight', $highlightArgs);
    }

    /**
     * Adds a highlight argument
     *
     * @param  mixed          $highlight Add highlight argument
     * @return Elastica_Query Query object
     * @link http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/highlighting/
     */
    public function addHighlight($highlight)
    {
        return $this->addParam('highlight', $highlight);
    }

    /**
     * Alias for setLimit
     *
     * @param  int            $limit OPTIONAL Maximal number of results for query (default = 10)
     * @return Elastica_Query Query object
     */
    public function setSize($limit = 10)
    {
        return $this->setLimit($limit);
    }

    /**
     * Sets maximum number of results for this query
     *
     * Setting the limit to 0, means no limit
     *
     * @param  int            $limit OPTIONAL Maximal number of results for query (default = 10)
     * @return Elastica_Query Query object
     */
    public function setLimit($limit = 10)
    {
        return $this->setParam('size', $limit);
    }

    /**
     * Enables explain on the query
     *
     * @param  bool           $explain OPTIONAL Enabled or disable explain (default = true)
     * @return Elastica_Query Current object
     * @link http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/explain/
     */
    public function setExplain($explain = true)
    {
        return $this->setParam('explain', $explain);
    }

    /**
     * Enables version on the query
     *
     * @param  bool           $version OPTIONAL Enabled or disable version (default = true)
     * @return Elastica_Query Current object
     * @link http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/version/
     */
    public function setVersion($version = true)
    {
        return $this->setParam('version', $version);
    }

    /**
     * Sets the fields to be returned by the search
     *
     * @param  array          $fields Fields to be returne
     * @return Elastica_Query Current object
     * @link http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/fields/
     */
    public function setFields(array $fields)
    {
        return $this->setParam('fields', $fields);
    }

    /**
     * Set script fields
     *
     * @param  array|Elastica_ScriptFields $scriptFields Script fields
     * @return Elastica_Query              Current object
     * @link http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/script_fields/
     */
    public function setScriptFields($scriptFields)
    {
        if (is_array($scriptFields)) {
            $scriptFields = new Elastica_ScriptFields($scriptFields);
        }

        return $this->setParam('script_fields', $scriptFields->toArray());
    }

    /**
     * Adds a Script to the query
     *
     * @param  Elastica_Script $script Script object
     * @return Elastica_Query  Query object
     */
    public function addScriptField($name, Elastica_Script $script)
    {
        $this->_params['script_fields'][$name] = $script->toArray();

        return $this;
    }

    /**
     * Sets all facets for this query object. Replaces existing facets
     *
     * @param  array          $facets List of facet objects
     * @return Elastica_Query Query object
     * @link http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/facets
     */
    public function setFacets(array $facets)
    {
        $this->_params['facets'] = array();
        foreach ($facets as $facet) {
            $this->addFacet($facet);
        }

        return $this;
    }

    /**
     * Adds a Facet to the query
     *
     * @param  Elastica_Facet_Abstract $facet Facet object
     * @return Elastica_Query          Query object
     */
    public function addFacet(Elastica_Facet_Abstract $facet)
    {
        $this->_params['facets'][$facet->getName()] = $facet->toArray();

        return $this;
    }

    /**
     * Converts all query params to an array
     *
     * @return array Query array
     */
    public function toArray()
    {
        // If no query is set, all query is chosen by default
        if (!isset($this->_params['query'])) {
            $this->setQuery(new Elastica_Query_MatchAll());
        }

        return $this->_params;
    }

    /**
     * Allows filtering of documents based on a minimum score
     *
     * @param  int|double     $minScore Minimum score to filter documents by
     * @return Elastica_Query Query object
     */
    public function setMinScore($minScore)
    {
        if (!is_numeric($minScore)) {
            throw new Elastica_Exception_Invalid('has to be numeric param');
        }

        return $this->setParam('min_score', $minScore);
    }
}
Return current item: Fantastic ElasticSearch