diff options
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/Filter/AbstractFilter.php')
| -rw-r--r-- | vendor/ruflin/elastica/lib/Elastica/Filter/AbstractFilter.php | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/Filter/AbstractFilter.php b/vendor/ruflin/elastica/lib/Elastica/Filter/AbstractFilter.php index 665f155f..7c7dc4f7 100644 --- a/vendor/ruflin/elastica/lib/Elastica/Filter/AbstractFilter.php +++ b/vendor/ruflin/elastica/lib/Elastica/Filter/AbstractFilter.php @@ -1,25 +1,24 @@ <?php - namespace Elastica\Filter; use Elastica\Exception\InvalidException; use Elastica\Param; /** - * Abstract filter object. Should be extended by all filter types + * Abstract filter object. Should be extended by all filter types. * - * @category Xodoa - * @package Elastica * @author Nicolas Ruflin <spam@ruflin.com> - * @link http://www.elasticsearch.org/guide/reference/query-dsl/ + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-filters.html */ abstract class AbstractFilter extends Param { /** - * Sets the filter cache + * Sets the filter cache. + * + * @param bool $cached Cached * - * @param boolean $cached Cached - * @return \Elastica\Filter\AbstractFilter + * @return $this */ public function setCached($cached = true) { @@ -27,11 +26,13 @@ abstract class AbstractFilter extends Param } /** - * Sets the filter cache key + * Sets the filter cache key. * - * @param string $cacheKey Cache key - * @throws \Elastica\Exception\InvalidException - * @return \Elastica\Filter\AbstractFilter + * @param string $cacheKey Cache key + * + * @throws \Elastica\Exception\InvalidException If given key is empty + * + * @return $this */ public function setCacheKey($cacheKey) { @@ -45,10 +46,11 @@ abstract class AbstractFilter extends Param } /** - * Sets the filter name + * Sets the filter name. + * + * @param string $name Name * - * @param string $name Name - * @return \Elastica\Filter\AbstractFilter + * @return $this */ public function setName($name) { |