blob: 648102d206003ba8ba2ae9c9e666b9d323e8cfbf (
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?php
namespace Elastica\Type;
use Elastica\Client;
use Elastica\Exception\InvalidException;
use Elastica\Index;
use Elastica\SearchableInterface;
use Elastica\Type as BaseType;
use Elastica\Util;
/**
* Abstract helper class to implement search indices based on models.
*
* This abstract model should help creating search index and a subtype
* with some easy config entries that are overloaded.
*
* The following variables have to be set:
* - $_indexName
* - $_typeName
*
* The following variables can be set for additional configuration
* - $_mapping: Value type mapping for the given type
* - $_indexParams: Parameters for the index
*
* @todo Add some settings examples to code
*
* @author Nicolas Ruflin <spam@ruflin.com>
*/
abstract class AbstractType implements SearchableInterface
{
const MAX_DOCS_PER_REQUEST = 1000;
/**
* Index name.
*
* @var string Index name
*/
protected $_indexName = '';
/**
* Index name.
*
* @var string Index name
*/
protected $_typeName = '';
/**
* Client.
*
* @var \Elastica\Client Client object
*/
protected $_client = null;
/**
* Index.
*
* @var \Elastica\Index Index object
*/
protected $_index = null;
/**
* Type.
*
* @var \Elastica\Type Type object
*/
protected $_type = null;
/**
* Mapping.
*
* @var array Mapping
*/
protected $_mapping = array();
/**
* Index params.
*
* @var array Index params
*/
protected $_indexParams = array();
/**
* Source.
*
* @var bool Source
*/
protected $_source = true;
/**
* Creates index object with client connection.
*
* Reads index and type name from protected vars _indexName and _typeName.
* Has to be set in child class
*
* @param \Elastica\Client $client OPTIONAL Client object
*
* @throws \Elastica\Exception\InvalidException
*/
public function __construct(Client $client = null)
{
if (!$client) {
$client = new Client();
}
if (empty($this->_indexName)) {
throw new InvalidException('Index name has to be set');
}
if (empty($this->_typeName)) {
throw new InvalidException('Type name has to be set');
}
$this->_client = $client;
$this->_index = new Index($this->_client, $this->_indexName);
$this->_type = new BaseType($this->_index, $this->_typeName);
}
/**
* Creates the index and sets the mapping for this type.
*
* @param bool $recreate OPTIONAL Recreates the index if true (default = false)
*/
public function create($recreate = false)
{
$this->getIndex()->create($this->_indexParams, $recreate);
$mapping = new Mapping($this->getType());
$mapping->setProperties($this->_mapping);
$mapping->setSource(array('enabled' => $this->_source));
$mapping->send();
}
/**
* @param \Elastica\Query $query
* @param array|int $options
*
* @return \Elastica\Search
*/
public function createSearch($query = '', $options = null)
{
return $this->getType()->createSearch($query, $options);
}
/**
* Search on the type.
*
* @param string|array|\Elastica\Query $query Array with all query data inside or a Elastica\Query object
*
* @return \Elastica\ResultSet ResultSet with all results inside
*
* @see \Elastica\SearchableInterface::search
*/
public function search($query = '', $options = null)
{
return $this->getType()->search($query, $options = null);
}
/**
* Count docs in the type based on query.
*
* @param string|array|\Elastica\Query $query Array with all query data inside or a Elastica\Query object
*
* @return int number of documents matching the query
*
* @see \Elastica\SearchableInterface::count
*/
public function count($query = '')
{
return $this->getType()->count($query);
}
/**
* Returns the search index.
*
* @return \Elastica\Index Index object
*/
public function getIndex()
{
return $this->_index;
}
/**
* Returns type object.
*
* @return \Elastica\Type Type object
*/
public function getType()
{
return $this->_type;
}
/**
* Converts given time to format: 1995-12-31T23:59:59Z.
*
* This is the lucene date format
*
* @param int $date Date input (could be string etc.) -> must be supported by strtotime
*
* @return string Converted date string
*/
public function convertDate($date)
{
return Util::convertDate($date);
}
}
|
