diff options
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/Query/Builder.php')
| -rw-r--r-- | vendor/ruflin/elastica/lib/Elastica/Query/Builder.php | 186 |
1 files changed, 94 insertions, 92 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/Query/Builder.php b/vendor/ruflin/elastica/lib/Elastica/Query/Builder.php index 2a5e8baa..55b6b903 100644 --- a/vendor/ruflin/elastica/lib/Elastica/Query/Builder.php +++ b/vendor/ruflin/elastica/lib/Elastica/Query/Builder.php @@ -1,5 +1,4 @@ <?php - namespace Elastica\Query; use Elastica\Exception\InvalidException; @@ -9,10 +8,10 @@ use Elastica\JSON; /** * Query Builder. * - * @category Xodoa - * @package Elastica * @author Chris Gedrim <chris@gedr.im> - * @link http://www.elasticsearch.org/ + * + * @link http://www.elastic.co/ + * @deprecated This builder is deprecated and will be removed. Use new Elastica\QueryBuilder instead. **/ class Builder extends AbstractQuery { @@ -28,21 +27,21 @@ class Builder extends AbstractQuery * * @param string $string JSON encoded string to use as query. * - * @return \Elastica\Query\Builder + * @return self */ public static function factory($string = null) { - return new Builder($string); + return new self($string); } /** - * Constructor + * Constructor. * * @param string $string JSON encoded string to use as query. */ public function __construct($string = null) { - if (! $string == null) { + if (!$string == null) { $this->_string .= substr($string, 1, -1); } } @@ -63,18 +62,21 @@ class Builder extends AbstractQuery public function toArray() { try { - return JSON::parse($this->__toString()); + return JSON::parse($input = $this->__toString()); } catch (JSONParseException $e) { - throw new InvalidException('The query produced is invalid'); + throw new InvalidException(sprintf( + 'The produced query is not a valid json string : "%s"', + $input + )); } } /** * Allow wildcards (*, ?) as the first character in a query. * - * @param boolean $bool Defaults to true. + * @param bool $bool Defaults to true. * - * @return \Elastica\Query\Builder + * @return $this */ public function allowLeadingWildcard($bool = true) { @@ -84,9 +86,9 @@ class Builder extends AbstractQuery /** * Enable best effort analysis of wildcard terms. * - * @param boolean $bool Defaults to true. + * @param bool $bool Defaults to true. * - * @return \Elastica\Query\Builder + * @return $this */ public function analyzeWildcard($bool = true) { @@ -98,7 +100,7 @@ class Builder extends AbstractQuery * * @param string $analyzer Analyzer to use. * - * @return \Elastica\Query\Builder + * @return $this */ public function analyzer($analyzer) { @@ -108,9 +110,9 @@ class Builder extends AbstractQuery /** * Autogenerate phrase queries. * - * @param boolean $bool Defaults to true. + * @param bool $bool Defaults to true. * - * @return \Elastica\Query\Builder + * @return $this */ public function autoGeneratePhraseQueries($bool = true) { @@ -129,7 +131,7 @@ class Builder extends AbstractQuery * * The occurrence types are: must, should, must_not. * - * @return \Elastica\Query\Builder + * @return $this */ public function bool() { @@ -141,7 +143,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function boolClose() { @@ -153,7 +155,7 @@ class Builder extends AbstractQuery * * @param float $boost Defaults to 1.0. * - * @return \Elastica\Query\Builder + * @return $this */ public function boost($boost = 1.0) { @@ -163,7 +165,7 @@ class Builder extends AbstractQuery /** * Close a previously opened brace. * - * @return \Elastica\Query\Builder + * @return $this */ public function close() { @@ -180,7 +182,7 @@ class Builder extends AbstractQuery * * Maps to Lucene ConstantScoreQuery. * - * @return \Elastica\Query\Builder + * @return $this */ public function constantScore() { @@ -192,7 +194,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function constantScoreClose() { @@ -204,7 +206,7 @@ class Builder extends AbstractQuery * * @param string $field Defaults to _all. * - * @return \Elastica\Query\Builder + * @return $this */ public function defaultField($field = '_all') { @@ -220,7 +222,7 @@ class Builder extends AbstractQuery * * @param string $operator Defaults to OR. * - * @return \Elastica\Query\Builder + * @return $this */ public function defaultOperator($operator = 'OR') { @@ -235,7 +237,7 @@ class Builder extends AbstractQuery * produced by any subquery, plus a tie breaking increment for any additional * matching subqueries. * - * @return \Elastica\Query\Builder + * @return $this */ public function disMax() { @@ -247,7 +249,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function disMaxClose() { @@ -257,9 +259,9 @@ class Builder extends AbstractQuery /** * Enable position increments in result queries. * - * @param boolean $bool Defaults to true. + * @param bool $bool Defaults to true. * - * @return \Elastica\Query\Builder + * @return $this */ public function enablePositionIncrements($bool = true) { @@ -269,9 +271,9 @@ class Builder extends AbstractQuery /** * Enables explanation for each hit on how its score was computed. * - * @param boolean $value Turn on / off explain. + * @param bool $value Turn on / off explain. * - * @return \Elastica\Query\Builder + * @return $this */ public function explain($value = true) { @@ -289,7 +291,7 @@ class Builder extends AbstractQuery * Elasticsearch supports more advanced facet implementations, such as * statistical or date histogram facets. * - * @return \Elastica\Query\Builder + * @return $this */ public function facets() { @@ -301,7 +303,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function facetsClose() { @@ -314,12 +316,12 @@ class Builder extends AbstractQuery * @param string $name Field to add. * @param mixed $value Value to set. * - * @return \Elastica\Query\Builder + * @return $this */ public function field($name, $value) { if (is_bool($value)) { - $value = '"'. var_export($value, true) . '"'; + $value = '"'.var_export($value, true).'"'; } elseif (is_array($value)) { $value = '["'.implode('","', $value).'"]'; } else { @@ -348,7 +350,7 @@ class Builder extends AbstractQuery * ->rangeClose() * ->queryClose(); * - * @return \Elastica\Query\Builder + * @return $this */ public function fieldClose() { @@ -360,7 +362,7 @@ class Builder extends AbstractQuery * * @param string $name Field name. * - * @return \Elastica\Query\Builder + * @return $this */ public function fieldOpen($name) { @@ -375,7 +377,7 @@ class Builder extends AbstractQuery * * @param array $fields Array of fields to return. * - * @return \Elastica\Query\Builder + * @return $this */ public function fields(array $fields) { @@ -393,7 +395,7 @@ class Builder extends AbstractQuery /** * Open a 'filter' block. * - * @return \Elastica\Query\Builder + * @return $this */ public function filter() { @@ -403,7 +405,7 @@ class Builder extends AbstractQuery /** * Close a filter block. * - * @return \Elastica\Query\Builder + * @return $this */ public function filterClose() { @@ -413,7 +415,7 @@ class Builder extends AbstractQuery /** * Query. * - * @return \Elastica\Query\Builder + * @return $this */ public function filteredQuery() { @@ -425,7 +427,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function filteredQueryClose() { @@ -435,9 +437,9 @@ class Builder extends AbstractQuery /** * Set the from parameter (offset). * - * @param integer $value Result number to start from. + * @param int $value Result number to start from. * - * @return \Elastica\Query\Builder + * @return $this */ public function from($value = 0) { @@ -449,7 +451,7 @@ class Builder extends AbstractQuery * * @param float $value Defaults to 0.5. * - * @return \Elastica\Query\Builder + * @return $this */ public function fuzzyMinSim($value = 0.5) { @@ -459,9 +461,9 @@ class Builder extends AbstractQuery /** * Set the prefix length for fuzzy queries. * - * @param integer $value Defaults to 0. + * @param int $value Defaults to 0. * - * @return \Elastica\Query\Builder + * @return $this */ public function fuzzyPrefixLength($value = 0) { @@ -475,7 +477,7 @@ class Builder extends AbstractQuery * * @param mixed $value Value to be gt. * - * @return \Elastica\Query\Builder + * @return $this */ public function gt($value) { @@ -489,7 +491,7 @@ class Builder extends AbstractQuery * * @param mixed $value Value to be gte to. * - * @return \Elastica\Query\Builder + * @return $this */ public function gte($value) { @@ -499,9 +501,9 @@ class Builder extends AbstractQuery /** * Automatically lower-case terms of wildcard, prefix, fuzzy, and range queries. * - * @param boolean $bool Defaults to true. + * @param bool $bool Defaults to true. * - * @return \Elastica\Query\Builder + * @return $this */ public function lowercaseExpandedTerms($bool = true) { @@ -515,7 +517,7 @@ class Builder extends AbstractQuery * * @param mixed $value Value to be lt. * - * @return \Elastica\Query\Builder + * @return $this */ public function lt($value) { @@ -529,7 +531,7 @@ class Builder extends AbstractQuery * * @param mixed $value Value to be lte to. * - * @return \Elastica\Query\Builder + * @return $this */ public function lte($value) { @@ -545,13 +547,13 @@ class Builder extends AbstractQuery * * @param float $boost Boost to use. * - * @return \Elastica\Query\Builder + * @return $this */ public function matchAll($boost = null) { $this->fieldOpen('match_all'); - if ( ! $boost == null && is_numeric($boost)) { + if (!$boost == null && is_numeric($boost)) { $this->field('boost', (float) $boost); } @@ -561,9 +563,9 @@ class Builder extends AbstractQuery /** * The minimum number of should clauses to match. * - * @param integer $minimum Minimum number that should match. + * @param int $minimum Minimum number that should match. * - * @return \Elastica\Query\Builder + * @return $this */ public function minimumNumberShouldMatch($minimum) { @@ -573,7 +575,7 @@ class Builder extends AbstractQuery /** * The clause (query) must appear in matching documents. * - * @return \Elastica\Query\Builder + * @return $this */ public function must() { @@ -585,7 +587,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function mustClose() { @@ -598,7 +600,7 @@ class Builder extends AbstractQuery * Note that it is not possible to search on documents that only consists of * a must_not clauses. * - * @return \Elastica\Query\Builder + * @return $this */ public function mustNot() { @@ -610,7 +612,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function mustNotClose() { @@ -620,7 +622,7 @@ class Builder extends AbstractQuery /** * Add an opening brace. * - * @return \Elastica\Query\Builder + * @return $this */ public function open() { @@ -634,9 +636,9 @@ class Builder extends AbstractQuery * * If zero, then exact phrase matches are required. * - * @param integer $value Defaults to 0. + * @param int $value Defaults to 0. * - * @return \Elastica\Query\Builder + * @return $this */ public function phraseSlop($value = 0) { @@ -646,7 +648,7 @@ class Builder extends AbstractQuery /** * Query. * - * @return \Elastica\Query\Builder + * @return $this */ public function prefix() { @@ -658,7 +660,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function prefixClose() { @@ -670,7 +672,7 @@ class Builder extends AbstractQuery * * @param array $queries Array of queries. * - * @return \Elastica\Query\Builder + * @return $this */ public function queries(array $queries) { @@ -688,7 +690,7 @@ class Builder extends AbstractQuery /** * Open a query block. * - * @return \Elastica\Query\Builder + * @return $this */ public function query() { @@ -700,7 +702,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function queryClose() { @@ -712,7 +714,7 @@ class Builder extends AbstractQuery * * A query that uses a query parser in order to parse its content * - * @return \Elastica\Query\Builder + * @return $this */ public function queryString() { @@ -724,7 +726,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function queryStringClose() { @@ -734,7 +736,7 @@ class Builder extends AbstractQuery /** * Open a range block. * - * @return \Elastica\Query\Builder + * @return $this */ public function range() { @@ -746,7 +748,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function rangeClose() { @@ -759,7 +761,7 @@ class Builder extends AbstractQuery * A boolean query with no must clauses, one or more should clauses must * match a document. * - * @return \Elastica\Query\Builder + * @return $this */ public function should() { @@ -771,7 +773,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function shouldClose() { @@ -781,9 +783,9 @@ class Builder extends AbstractQuery /** * Set the size parameter (number of records to return). * - * @param integer $value Number of records to return. + * @param int $value Number of records to return. * - * @return \Elastica\Query\Builder + * @return $this */ public function size($value = 10) { @@ -793,7 +795,7 @@ class Builder extends AbstractQuery /** * Allows to add one or more sort on specific fields. * - * @return \Elastica\Query\Builder + * @return $this */ public function sort() { @@ -805,7 +807,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function sortClose() { @@ -815,10 +817,10 @@ class Builder extends AbstractQuery /** * Add a field to sort on. * - * @param string $name Field to sort. - * @param boolean $reverse Reverse direction. + * @param string $name Field to sort. + * @param bool $reverse Reverse direction. * - * @return \Elastica\Query\Builder + * @return $this */ public function sortField($name, $reverse = false) { @@ -831,12 +833,12 @@ class Builder extends AbstractQuery } /** - * Sort on multiple fields + * Sort on multiple fields. * * @param array $fields Associative array where the keys are field names to sort on, and the * values are the sort order: "asc" or "desc" * - * @return \Elastica\Query\Builder + * @return $this */ public function sortFields(array $fields) { @@ -846,7 +848,7 @@ class Builder extends AbstractQuery $this->_string .= '{"'.$fieldName.'":"'.$order.'"},'; } - $this->_string = rtrim($this->_string, ',') . '],'; + $this->_string = rtrim($this->_string, ',').'],'; return $this; } @@ -858,7 +860,7 @@ class Builder extends AbstractQuery * * The term query maps to Lucene TermQuery. * - * @return \Elastica\Query\Builder + * @return $this */ public function term() { @@ -870,7 +872,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function termClose() { @@ -880,7 +882,7 @@ class Builder extends AbstractQuery /** * Open a 'text_phrase' block. * - * @return \Elastica\Query\Builder + * @return $this */ public function textPhrase() { @@ -890,7 +892,7 @@ class Builder extends AbstractQuery /** * Close a 'text_phrase' block. * - * @return \Elastica\Query\Builder + * @return $this */ public function textPhraseClose() { @@ -902,7 +904,7 @@ class Builder extends AbstractQuery * * @param float $multiplier Multiplier to use. * - * @return \Elastica\Query\Builder + * @return $this */ public function tieBreakerMultiplier($multiplier) { @@ -912,7 +914,7 @@ class Builder extends AbstractQuery /** * Query. * - * @return \Elastica\Query\Builder + * @return $this */ public function wildcard() { @@ -924,7 +926,7 @@ class Builder extends AbstractQuery * * Alias of close() for ease of reading in source. * - * @return \Elastica\Query\Builder + * @return $this */ public function wildcardClose() { |