This repository has been archived by the owner on May 16, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 17
/
base.php
552 lines (466 loc) · 17.2 KB
/
base.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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
<?php
# This file is part of the Akelos Framework
# (Copyright) 2004-2010 Bermi Ferrer bermi a t bermilabs com
# See LICENSE and CREDITS for details
class AkActiveDocument extends AkBaseModel
{
public $default_error_messages = array();
public $skip_attributes = array();
protected $_primary_key;
protected $_record_timestamps = true;
private $_Adapter;
private $_internals = array();
private $_attributes = array();
public function __construct(){
$attributes = (array)func_get_args();
if(isset($attributes[0]['init']) && $attributes[0]['init'] == false){
return;
}
return $this->init($attributes);
}
public function init($attributes = array()){
$this->_enableLazyLoadingExtenssions();
if(isset($attributes[0]) && count($attributes) === 1 && array_key_exists(0, $attributes) && !is_array($attributes[0])){
return $this->_loadFromDatabase($attributes[0]);
}elseif(!empty($attributes[0]) && is_array($attributes[0])){
$this->setAttributes($attributes[0]);
}
}
/**
* Creates an object, instantly saves it as a record (if the validation permits it), and returns it.
* If the save fail under validations, the unsaved object is still returned.
*/
public function &create($attributes = array()){
$model = $this->getModelName();
$object = new $model();
if(!empty($this->_Adapter)){
$object->setAdapter($this->getAdapter());
}
$object->setAttributes($attributes);
$object->save();
return $object;
}
/**
* Deletes the record with the given id without instantiating an object first. If an array of
* ids is provided, all of them are deleted.
*/
public function delete($id) {
$ids = is_array($id) ? $id : array($id);
foreach ($ids as $id){
$this->getAdapter()->delete($this->getCollectionName(), $id);
}
}
public function destroy($id = null) {
if(!$this->_callback('beforeDestroy')) return false;
$this->delete(empty($id) ? $this->getId() : $id);
unset($this->_internals['existing_record']);
if(!$this->_callback('afterDestroy')) return false;
return true;
}
/**
* - No record exists: Creates a new record with values matching those of the object attributes.
* - A record does exist: Updates the record with values matching those of the object attributes.
*/
public function save($validate = true){
return $this->_createOrUpdate($validate);
}
/**
* Reloads the attributes of this object from the database.
*/
public function reload() {
return $this->_loadFromDatabase($this->getId());
}
public function isValid(){
$this->clearErrors();
$new_record = $this->isNewRecord();
return
(
!($this->_callback('beforeValidation')) ||
!($new_record ? $this->_callback('beforeValidationOnCreate') : $this->_callback('beforeValidationOnUpdate')) ||
!($this->validate() !== false && !$this->hasErrors()) ||
!(($new_record ? $this->validateOnCreate() !== false : $this->validateOnUpdate() !== false) && !$this->hasErrors()) ||
!($this->_callback('afterValidation')) ||
!($new_record ? $this->_callback('afterValidationOnCreate') : $this->_callback('afterValidationOnUpdate'))
) ? false : true;
}
public function isNewRecord(){
return empty($this->_internals['existing_record']);
}
private function _createOrUpdate($validate = true){
if($validate && $this->needsValidation() && !$this->isValid()){
return false;
}
$this->_setRecordTimestamps();
return
(
!($this->_callback('beforeSave')) ||
!($this->isNewRecord() ? $this->_create() : $this->_update()) ||
!($this->_callback('afterSave'))
) ? false : true;
}
/**
* Creates a new record with values matching those of the instance attributes.
* Must be called as a result of a call to _createOrUpdate.
*/
private function _create(){
if(!$this->_callback('beforeCreate')) return false;
if($record = $this->getAdapter()->createRecord($this->getCollectionName(), $this->_getAttributesCastedForDatabase())){
$this->_matchCurrentModelWithDatabaseRecord($record);
if(!$this->_callback('afterCreate')) return false;
return true;
}
return false;
}
/**
* Updates the associated record with values matching those of the instance attributes.
* Must be called as a result of a call to _createOrUpdate.
*/
private function _update(){
if(!$this->_callback('beforeUpdate')) return false;
if($record = $this->getAdapter()->updateRecord($this->getCollectionName(), $this->_getAttributesCastedForDatabase())){
$this->_matchCurrentModelWithDatabaseRecord($record);
if(!$this->_callback('afterUpdate')) return false;
return true;
}
return false;
}
// Finder
public function &find() {
$args = func_get_args();
$options = $this->_extractOptionsFromArgs($args);
list($fetch, $options) = $this->_extractConditionsFromArgs($args, $options);
switch ($fetch) {
case 'first':
return $this->_findInitial($options);
default:
return $this->_findEvery($options);
}
}
public function &findFirst() {
$args = func_get_args();
$result = call_user_func_array(array($this,'find'), array_merge(array('first'),$args));
return $result;
}
public function &findAll() {
$args = func_get_args();
$result = call_user_func_array(array($this,'find'), array_merge(array('all'),$args));
return $result;
}
private function &_findInitial($options){
$options['limit'] = 1;
$result = $this->_findEvery($options);
if(!empty($result)){
$result->rewind();
$reference = $result->current();
return $reference;
}else{
$result = false;
return $result;
}
}
private function &_findEvery($options){
$result = $this->getAdapter()->find($this->getCollectionName(), $options);
if(!empty($result)){
$result = new AkActiveDocumentIterator($result, $this);
}
return $result;
}
private function _extractOptionsFromArgs(&$args) {
$last_arg = count($args)-1;
return isset($args[$last_arg]) && is_array($args[$last_arg]) && $this->_isOptionsHash($args[$last_arg]) ? array_pop($args) : array();
}
private function _isOptionsHash($options) {
if (isset($options[0])) return false;
$valid_keys = array('conditions', 'limit', 'offset', 'order', 'sort');
return count($options) != count(array_diff(array_keys($options), $valid_keys));
}
private function _extractConditionsFromArgs($args, $options){
$fetch = 'all';
$num_args = count($args);
if(!empty($args) && count($args) == 1 && array_key_exists(0, $args)){
$fetch = 'first';
if($args[0] != 'first'){
$options['attributes'][$this->getPrimaryKey()] = $args[0];
}
}
if ($num_args > 1 && is_array($args[1])) {
$fetch = array_shift($args);
$options = array_merge($options, array('conditions'=>$args[0]));
}
return array($fetch, $options);
}
// Attributes
public function hasColumn($column_name){
return !in_array($column_name, $this->skip_attributes);
}
public function getPrimaryKey(){
if(empty($this->_primary_key)){
$this->setPrimaryKey($this->getAdapter()->getDefaultPrimaryKey());
}
return $this->_primary_key;
}
public function setPrimaryKey($primary_key){
$this->_primary_key = $primary_key;
}
public function setId($id){
$this->{$this->getPrimaryKey()} = $id;
}
public function getId(){
$pk = $this->getPrimaryKey();
return isset($this->_attributes[$pk]) ? (string)$this->$pk : null;
}
public function setAttributes($attributes = array()){
foreach ($attributes as $k => $v){
$this->setAttribute($k, $v);
}
}
public function setAttribute($name, $value){
$this->$name = $value;
}
public function set($name, $value){
$this->setAttribute($name, $value);
}
public function getAttribute($name){
return $this->$name;
}
public function get($name){
return $this->getAttribute($name);
}
public function getAttributes(){
return $this->_attributes;
}
public function setAttributesFromDatabase($attributes){
$this->_internals['existing_record'] = true;
$this->setAttributes($attributes);
}
public function castAttributeForDatabase($attribute, $value){
return $value;
if(preg_match('/^(is_|has_|do_|does_|are_)/', $attribute, $matches)){
return (bool)$value;
}
if(preg_match('/.+_(at|on)$/', $attribute, $matches)){
//return (bool)$matches[0];
}
}
public function castAttributeFromDatabase($attribute, $value){
return $value;
}
protected function _setRecordTimestamps(){
if (!$this->_record_timestamps) return;
$this->setAttribute($this->isNewRecord() ? 'created_at' : 'updated_at', Ak::getDate());
}
private function _getAttributesCastedForDatabase(){
$attributes = array();
foreach ($this->getAttributes() as $k => $v){
$attributes[$k] = $this->castAttributeForDatabase($k ,$v);
}
return array_diff($attributes, array(''));
}
private function _matchCurrentModelWithDatabaseRecord($record){
$this->setId($record[$this->getPrimaryKey()]);
$this->_internals['existing_record'] = true;
}
private function _loadFromDatabase($id){
if($record = $this->find($id)){
$this->setAttributesFromDatabase($record->getAttributes());
return $this->_callback('afterInstantiate');
}
return false;
}
// Database adapter
public function getModelName(){
return get_class($this);
}
public function getCollectionName(){
if(empty($this->_internals['collection_name'])){
$this->_internals['collection_name'] = AkInflector::tableize($this->getModelName());
}
return $this->_internals['collection_name'];
}
public function getTableName(){
return $this->getCollectionName();
}
public function setAdapter(&$Adapter){
$this->_Adapter = $Adapter;
Ak::setStaticVar($this->getModelName().'_last_used_Adapter', $Adapter);
Ak::setStaticVar('AkActiveDocument_last_used_Adapter', $Adapter);
}
public function &getAdapter(){
if(empty($this->_Adapter)){
if(!$this->_Adapter = Ak::getStaticVar($this->getModelName().'_last_used_Adapter')){
if(!$this->_Adapter = Ak::getStaticVar('AkActiveDocument_last_used_Adapter')){
$db = new AkOdbAdapter();
$db->connect();
$this->setAdapter($db);
}
}
}
return $this->_Adapter;
}
/**
Callbacks
====================================================================
See also: Observers.
*
* Callbacks are hooks into the life-cycle of an Active Document object that allows you to trigger logic
* before or after an alteration of the object state. This can be used to make sure that associated and
* dependent objects are deleted when destroy is called (by overwriting beforeDestroy) or to massage attributes
* before they're validated (by overwriting beforeValidation). As an example of the callbacks initiated, consider
* the AkActiveDocument->save() call:
*
* - (-) save()
* - (-) needsValidation()
* - (1) beforeValidation()
* - (2) beforeValidationOnCreate() / beforeValidationOnUpdate()
* - (-) validate()
* - (-) validateOnCreate()
* - (4) afterValidation()
* - (5) afterValidationOnCreate() / afterValidationOnUpdate()
* - (6) beforeSave()
* - (7) beforeCreate() / beforeUpdate()
* - (-) create()
* - (8) afterCreate() / afterUpdate()
* - (9) afterSave()
* - (10) afterDestroy()
* - (11) beforeDestroy()
*
*
* That's a total of 15 callbacks, which gives you immense power to react and prepare for each state in the
* Active Document lifecycle.
*
* Examples:
* class CreditCard extends ActiveDocument
* {
* // Strip everything but digits, so the user can specify "555 234 34" or
* // "5552-3434" or both will mean "55523434"
* private function _beforeValidationOnCreate
* {
* if(!empty($this->number)){
* $this->number = preg_replace('/([^0-9]*)/','',$this->number);
* }
* }
* }
*
* class Subscription extends ActiveDocument
* {
* // Note: This is not implemented yet
* public $beforeCreate = 'recordSignup';
*
* public function recordSignup()
* {
* $this->signed_up_on = date("Y-m-d");
* }
* }
*
* class Firm extends ActiveDocument
* {
* //Destroys the associated clients and people when the firm is destroyed
* // Note: This is not implemented yet
* public $beforeDestroy = array('destroyAssociatedPeople', 'destroyAssociatedClients');
*
* public function destroyAssociatedPeople()
* {
* $Person = new Person();
* $Person->destroyAll("firm_id=>", $this->id);
* }
*
* public function destroyAssociatedClients()
* {
* $Client = new Client();
* $Client->destroyAll("client_of=>", $this->id);
* }
* }
*
*
* == Canceling callbacks ==
*
* If a before* callback returns false, all the later callbacks and the associated action are cancelled. If an after* callback returns
* false, all the later callbacks are cancelled. Callbacks are generally run in the order they are defined, with the exception of callbacks
* defined as methods on the model, which are called last.
*
* Override this methods to hook Active Documents
*/
private function _callback($type){
$result = true;
if(method_exists($this, $type)){
$result = $this->$type();
}
return $result ? $this->notifyObservers($type) : false;
}
/*/Callbacks*/
// Lazy loading
protected function _enableLazyLoadingExtenssions($options = array()) {
empty($options['skip_observers']) && $this->_enableObservers();
empty($options['skip_errors']) && $this->_enableErrors();
empty($options['skip_validations']) && $this->_enableValidations();
}
// Magic callback methods
public function __get($attribute){
return $this->_attributes[$attribute];
}
public function __set($attribute, $value){
$this->_attributes[$attribute] = $value;
}
}
class AkActiveDocumentIterator implements Iterator, ArrayAccess
{
private $_AdapterIterator;
private $_Model;
private $_ModelInstance;
private $_documents = array();
public function __construct(&$AdapterIterator, &$Model){
$this->_AdapterIterator = $AdapterIterator;
$this->_Model = $Model;
$class_name = $Model->getModelName();
$this->_ModelInstance = new $class_name;
}
public function rewind() {
$this->_AdapterIterator->rewind();
}
public function current() {
$Model = clone($this->_ModelInstance);
$Model->setAttributesFromDatabase($this->_AdapterIterator->current());
return $Model;
}
public function key() {
return $this->_AdapterIterator->key();
}
public function next() {
return $this->_AdapterIterator->next();
}
public function valid() {
return $this->_AdapterIterator->valid();
}
private function _enableArrayAccess(){
if(empty($this->_documents)){
$this->rewind();
$i = 0;
foreach ($this as $Document){
$this->_documents[$i] = $Document;
$i++;
}
}
}
public function offsetSet($offset, $value) {
$this->_enableArrayAccess();
$this->_documents[$offset] = $value;
}
public function offsetExists($offset) {
$this->_enableArrayAccess();
return isset($this->_documents[$offset]);
}
public function offsetUnset($offset) {
unset($this->_documents[$offset]);
}
public function offsetGet($offset) {
$this->_enableArrayAccess();
return isset($this->_documents[$offset]) ? $this->_documents[$offset] : null;
}
}
class AkActiveDocumentExtenssion
{
protected $_ActiveDocument;
public function setExtendedBy(&$ActiveDocument){
$this->_ActiveDocument = $ActiveDocument;
}
}