summaryrefslogtreecommitdiff
path: root/vendor/ruflin/elastica/lib/Elastica/Query/Filtered.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/Query/Filtered.php')
-rw-r--r--vendor/ruflin/elastica/lib/Elastica/Query/Filtered.php34
1 files changed, 18 insertions, 16 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/Query/Filtered.php b/vendor/ruflin/elastica/lib/Elastica/Query/Filtered.php
index c28d4cdd..ac085037 100644
--- a/vendor/ruflin/elastica/lib/Elastica/Query/Filtered.php
+++ b/vendor/ruflin/elastica/lib/Elastica/Query/Filtered.php
@@ -1,36 +1,36 @@
<?php
-
namespace Elastica\Query;
-use Elastica\Filter\AbstractFilter;
use Elastica\Exception\InvalidException;
+use Elastica\Filter\AbstractFilter;
/**
- * Filtered query. Needs a query and a filter
+ * Filtered query. Needs a query and a filter.
*
- * @category Xodoa
- * @package Elastica
* @author Nicolas Ruflin <spam@ruflin.com>
- * @link http://www.elasticsearch.org/guide/reference/query-dsl/filtered-query.html
+ *
+ * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-filtered-query.html
*/
class Filtered extends AbstractQuery
{
/**
- * Constructs a filtered query
+ * Constructs a filtered query.
*
* @param \Elastica\Query\AbstractQuery $query OPTIONAL Query object
* @param \Elastica\Filter\AbstractFilter $filter OPTIONAL Filter object
*/
- public function __construct(AbstractQuery $query = null, AbstractFilter $filter = null) {
+ public function __construct(AbstractQuery $query = null, AbstractFilter $filter = null)
+ {
$this->setQuery($query);
$this->setFilter($filter);
}
/**
- * Sets a query
+ * Sets a query.
*
- * @param \Elastica\Query\AbstractQuery $query Query object
- * @return \Elastica\Query\Filtered Current object
+ * @param \Elastica\Query\AbstractQuery $query Query object
+ *
+ * @return $this
*/
public function setQuery(AbstractQuery $query = null)
{
@@ -38,10 +38,11 @@ class Filtered extends AbstractQuery
}
/**
- * Sets the filter
+ * Sets the filter.
+ *
+ * @param \Elastica\Filter\AbstractFilter $filter Filter object
*
- * @param \Elastica\Filter\AbstractFilter $filter Filter object
- * @return \Elastica\Query\Filtered Current object
+ * @return $this
*/
public function setFilter(AbstractFilter $filter = null)
{
@@ -69,9 +70,10 @@ class Filtered extends AbstractQuery
}
/**
- * Converts query to array
+ * Converts query to array.
*
* @return array Query array
+ *
* @see \Elastica\Query\AbstractQuery::toArray()
*/
public function toArray()
@@ -89,7 +91,7 @@ class Filtered extends AbstractQuery
if (empty($filtered)) {
throw new InvalidException('A query and/or filter is required');
}
-
+
return array('filtered' => $filtered);
}
}