-
Notifications
You must be signed in to change notification settings - Fork 2
/
BaseModel.php
344 lines (318 loc) · 8.89 KB
/
BaseModel.php
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
<?php
/**
* radium: lithium application framework
*
* @copyright Copyright 2013, brünsicke.com GmbH (http://bruensicke.com)
* @license http://opensource.org/licenses/BSD-3-Clause The BSD License
*/
namespace radium\models;
use radium\models\Configurations;
use lithium\core\Libraries;
use lithium\util\Set;
use lithium\util\Validator;
use lithium\util\Inflector;
/**
* Base class for all Models
*
* If you have models in your app, you should extend this class like that:
*
* {{{
* class MyModel extends \radium\models\BaseModel {
* }}}
*
* @see app\models
* @see lithium\data\Model
*/
class BaseModel extends \lithium\data\Model {
/**
* Custom status options
*
* @var array
*/
public static $_status = array(
'active' => 'active',
'inactive' => 'inactive',
);
/**
* Custom type options
*
* @var array
*/
public static $_types = array();
/**
* Custom find query properties, indexed by name.
*
* @var array
*/
public static $__finders = array(
'deleted' => array(
'conditions' => array(
'deleted' => 'IS NOT NULL',
)
)
);
/**
* initialize method
*
* @see lithium\data\Model
* @return void
*/
public static function __init() {
if (!Validator::rules('slug')) {
Validator::add('slug', '/^[a-z0-9\_\-\.]*$/');
}
if (!Validator::rules('loose_slug')) {
Validator::add('loose_slug', '/^[a-zA-Z0-9\_\-\.]*$/');
}
if (!Validator::rules('strict_slug')) {
Validator::add('strict_slug', '/^[a-z][a-z0-9\_\-]*$/');
}
if (!Validator::rules('isUnique')) {
Validator::add('isUnique', function ($value, $format, $options) {
$conditions = array($options['field'] => $value);
foreach((array) $options['model']::meta('key') as $field) {
if (!empty($options['values'][$field])) {
$conditions[$field] = array('!=' => $options['values'][$field]);
}
}
$fields = $options['field'];
return is_null($options['model']::find('first', compact('fields', 'conditions')));
});
}
// auto-update the created and updated fields
static::applyFilter('save', function ($self, $params, $chain) {
$field = ($params['entity']->exists()) ? 'updated' : 'created';
$params['entity']->$field = time();
return $chain->next($self, $params, $chain);
});
// soft-delete on all rows, that have a 'deleted' field in schema
static::applyFilter('delete', function ($self, $params, $chain) {
$deleted = $params['entity']->schema('deleted');
if(is_null($deleted)) {
return $chain->next($self, $params, $chain);
}
$params['entity']->deleted = time();
return $params['entity']->save();
});
}
/**
* all types for current model
*
* @param string $type type to look for
* @return mixed all types with keys and their name, or value of `$type` if given
*/
public static function types($type = null) {
if (!empty($type)) {
return (isset(static::$_types[$type])) ? static::$_types[$type] : false;
}
return static::$_types;
}
/**
* all status for current model
*
* @param string $status status to look for
* @return mixed all status with keys and their name, or value of `$status` if given
*/
public static function status($status = null) {
if (!empty($status)) {
return (isset(static::$_status[$status])) ? static::$_status[$status] : false;
}
return static::$_status;
}
/**
* finds and loads entities that match slug subpattern
*
* @see lithium\data\Model::find()
* @param string $slug short unique string to look for
* @param string $status status must have
* @param array $options additional options to be merged into find options
* @return object|boolean found results as collection or false, if none found
* @filter
*/
public static function search($slug, $status = 'active', array $options = array()) {
$params = compact('slug', 'status', 'options');
return static::_filter(__METHOD__, $params, function($self, $params) {
extract($params);
$options['conditions'] = array(
'slug' => array('like' => "/$slug/i"),
'status' => $status,
'deleted' => array('<=' => null), // only not deleted
);
$result = $self::find('all', $options);
if (!$result) {
return false;
}
return $result;
});
}
/**
* finds and loads entity with given slug
*
* @param string $slug short unique string to identify entity
* @param string $status status entity must have
* @return object|boolean found entity entity or false, if none found
* @filter
*/
public static function slug($slug, $status = 'active', array $options = array()) {
$params = compact('slug', 'status', 'options');
return static::_filter(__METHOD__, $params, function($self, $params) {
extract($params);
$deleted = array('<=' => null); // only not deleted
$options['conditions'] = compact('slug', 'status', 'deleted');
$result = $self::find('first', $options);
if (!$result) {
return false;
}
return $result;
});
}
/**
* finds and loads active entity for given id
*
* @param string $id id of entity to load
* @return object|boolean entity if found and active, false otherwise
* @filter
*/
public static function load($id, $status = 'active', array $options = array()) {
$params = compact('id', 'status', 'options');
return static::_filter(__METHOD__, $params, function($self, $params) {
extract($params);
$defaults = array();
$options += $defaults;
$key = $self::key();
$options['conditions'] = array($key => $id);
$result = $self::find('first', $options);
if (!$result) {
return false;
}
if ($result->status != $status) {
return false;
}
if (!empty($result->deleted)) {
return false;
}
return $result;
});
}
/**
* Allows to pass in a query to do, what a man needs to do.
* Make sure, you are not trying to be james bond, without
* beeing sure, you know what you are doing.
*
* Returns a lithium\data\source\database\adapter\my_sql\Result object
*
* @param string $sql
* @return object
*/
public static function execute($sql) {
return static::connection()->invokeMethod('_execute', array($sql));
}
/**
* Returns all schema-fields, without their types
*
* @return array
*/
public static function fields() {
$schema = static::schema();
return $schema->names();
}
/**
* updates fields for records, specified by key => value
*
* @param array $data array keys are primary keys, values will be set
* @param string $field name of field to update
* @return array an array containing all results
*/
public static function updateFields($data, $field, array $options = array()) {
$defaults = array('updated' => true);
$options += $defaults;
$key = static::key();
$result = array();
foreach ($data as $id => $value) {
$update = array($field => $value);
if ($options['updated']) {
$update['updated'] = time();
}
$result[$id] = static::update($update, array($key => $id));
}
return $result;
}
/**
* undeletes a record, in case it was marked as deleted
*
* @param object $entity current instance
* @return boolean true on success, false otherwise
*/
public function undelete($entity) {
unset($entity->deleted);
return is_null($entity->deleted) && $entity->save();
}
/**
* fetches the associated config record
*
* @param object $entity current instance
* @return array client data
*/
public function configuration($entity) {
return $entity->config = Configurations::first($entity->config_id);
}
/**
* fetches the associated record
*
* @param object $entity current instance
* @param string|array $name name of model to load
* @return array remote object data
*/
public function resolve($entity, $fields = null) {
$get_class = function($name) {
$modelname = Inflector::pluralize(Inflector::classify($name));
return Libraries::locate('models', $modelname);
};
switch (true) {
case is_string($fields):
$fields = array("{$fields}_id");
break;
case empty($fields):
$fields = self::fields();
break;
case is_array($fields):
$fields = array_map(function($field){
return (stristr($field, '_id')) ? $field : "{$field}_id";
}, $fields);
break;
}
$return = null;
foreach ($fields as $field) {
if (preg_match('/^(.+)_id$/', $field, $matches)) {
list($attribute, $name) = $matches;
$model = $get_class($name);
if (empty($model)) {
$entity->$name = null;
continue;
}
$id = (string) $entity->$attribute;
if (!$id) {
continue;
}
$res = $model::first($id);
if ($res) {
$return = $res;
$entity->$name = $res->data();
}
}
}
return (count($fields) > 1) ? $entity : $return;
}
/**
* fetches the associated configuration
*
* @param object $entity current instance
* @param string $field name of configuration to return
* @return array client data
*/
public function value($entity, $field = null, array $options = array()) {
$entity->config = Configurations::first($entity->config_id);
return $entity->val($field, $options);
}
}
?>