blob: 7c7dc4f78c0223bfcb1bb4de3a71d937d4f253f5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
<?php
namespace Elastica\Filter;
use Elastica\Exception\InvalidException;
use Elastica\Param;
/**
* Abstract filter object. Should be extended by all filter types.
*
* @author Nicolas Ruflin <spam@ruflin.com>
*
* @link http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-filters.html
*/
abstract class AbstractFilter extends Param
{
/**
* Sets the filter cache.
*
* @param bool $cached Cached
*
* @return $this
*/
public function setCached($cached = true)
{
return $this->setParam('_cache', (bool) $cached);
}
/**
* Sets the filter cache key.
*
* @param string $cacheKey Cache key
*
* @throws \Elastica\Exception\InvalidException If given key is empty
*
* @return $this
*/
public function setCacheKey($cacheKey)
{
$cacheKey = (string) $cacheKey;
if (empty($cacheKey)) {
throw new InvalidException('Invalid parameter. Has to be a non empty string');
}
return $this->setParam('_cache_key', (string) $cacheKey);
}
/**
* Sets the filter name.
*
* @param string $name Name
*
* @return $this
*/
public function setName($name)
{
return $this->setParam('_name', $name);
}
}
|
