blob: 743cefe1ff5f0aa2e0bd64c13ea1d6930c2785c6 (
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<?php
namespace Elastica\Facet;
use Elastica\Exception\InvalidException;
use Elastica\Filter\AbstractFilter;
use Elastica\Param;
/**
* Abstract facet object. Should be extended by all facet types.
*
* @author Nicolas Ruflin <spam@ruflin.com>
* @author Jasper van Wanrooy <jasper@vanwanrooy.net>
*
* @deprecated Facets are deprecated and will be removed in a future release. You are encouraged to migrate to aggregations instead.
*/
abstract class AbstractFacet extends Param
{
/**
* @var string Holds the name of the facet.
*/
protected $_name = '';
/**
* @var array Holds all facet parameters.
*/
protected $_facet = array();
/**
* Constructs a Facet object.
*
* @param string $name The name of the facet.
*/
public function __construct($name)
{
$this->setName($name);
}
/**
* Sets the name of the facet. It is automatically set by
* the constructor.
*
* @param string $name The name of the facet.
*
* @throws \Elastica\Exception\InvalidException If name is empty
*
* @return $this
*/
public function setName($name)
{
if (empty($name)) {
throw new InvalidException('Facet name has to be set');
}
$this->_name = $name;
return $this;
}
/**
* Gets the name of the facet.
*
* @return string
*/
public function getName()
{
return $this->_name;
}
/**
* Sets a filter for this facet.
*
* @param \Elastica\Filter\AbstractFilter $filter A filter to apply on the facet.
*
* @return $this
*/
public function setFilter(AbstractFilter $filter)
{
return $this->_setFacetParam('facet_filter', $filter->toArray());
}
/**
* Sets the flag to either run the facet globally or bound to the
* current search query. When not set, it defaults to the
* Elasticsearch default value.
*
* @param bool $global Flag to either run the facet globally.
*
* @return $this
*/
public function setGlobal($global = true)
{
return $this->_setFacetParam('global', (bool) $global);
}
/**
* Sets the path to the nested document.
*
* @param string $nestedPath Nested path
*
* @return $this
*/
public function setNested($nestedPath)
{
return $this->_setFacetParam('nested', $nestedPath);
}
/**
* Sets the scope.
*
* @param string $scope Scope
*
* @return $this
*/
public function setScope($scope)
{
return $this->_setFacetParam('scope', $scope);
}
/**
* Basic definition of all specs of the facet. Each implementation
* should override this function in order to set it's specific
* settings.
*
* @return array
*/
public function toArray()
{
return $this->_facet;
}
/**
* Sets a param for the facet. Each facet implementation needs to take
* care of handling their own params.
*
* @param string $key The key of the param to set.
* @param mixed $value The value of the param.
*
* @return $this
*/
protected function _setFacetParam($key, $value)
{
$this->_facet[$key] = $value;
return $this;
}
}
|
