/
ORM.php
1578 lines (1384 loc) · 37.4 KB
/
ORM.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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php defined('SYSPATH') OR die('No direct access allowed.');
/**
* [Object Relational Mapping][ref-orm] (ORM) is a method of abstracting database
* access to standard PHP calls. All table rows are represented as model objects,
* with object properties representing row data. ORM in Kohana generally follows
* the [Active Record][ref-act] pattern.
*
* [ref-orm]: http://wikipedia.org/wiki/Object-relational_mapping
* [ref-act]: http://wikipedia.org/wiki/Active_record
*
* $Id: ORM.php 4682 2009-11-11 20:53:23Z isaiah $
*
* @package ORM
* @author Kohana Team
* @copyright (c) 2007-2009 Kohana Team
* @license http://kohanaphp.com/license
*/
class ORM_Core {
// Current relationships
protected $has_one = array();
protected $belongs_to = array();
protected $has_many = array();
protected $has_and_belongs_to_many = array();
protected $has_many_through = array();
// Relationships that should always be joined
protected $load_with = array();
// Current object
protected $object = array();
protected $changed = array();
protected $related = array();
protected $_valid = FALSE;
protected $_loaded = FALSE;
protected $_saved = FALSE;
protected $sorting;
protected $rules = array();
// Related objects
protected $object_relations = array();
protected $changed_relations = array();
// Model table information
protected $object_name;
protected $object_plural;
protected $table_name;
protected $table_columns;
protected $ignored_columns;
// Auto-update columns for creation and updates
protected $updated_column = NULL;
protected $created_column = NULL;
// Table primary key and value
protected $primary_key = 'id';
protected $primary_val = 'name';
// Array of foreign key name overloads
protected $foreign_key = array();
// Model configuration
protected $table_names_plural = TRUE;
protected $reload_on_wakeup = TRUE;
// Database configuration
protected $db = 'default';
protected $db_applied = array();
protected $db_builder;
// With calls already applied
protected $with_applied = array();
// Stores column information for ORM models
protected static $column_cache = array();
/**
* Creates and returns a new model.
*
* @chainable
* @param string model name
* @param mixed parameter for find()
* @return ORM
*/
public static function factory($model, $id = NULL)
{
// Set class name
$model = ucfirst($model).'_Model';
return new $model($id);
}
/**
* Prepares the model database connection and loads the object.
*
* @param mixed parameter for find or object to load
* @return void
*/
public function __construct($id = NULL)
{
// Set the object name and plural name
$this->object_name = strtolower(substr(get_class($this), 0, -6));
$this->object_plural = inflector::plural($this->object_name);
if (!isset($this->sorting))
{
// Default sorting
$this->sorting = array($this->primary_key => 'asc');
}
// Initialize database
$this->__initialize();
// Clear the object
$this->clear();
if (is_object($id))
{
// Load an object
$this->_load_values((array) $id);
}
elseif (!empty($id))
{
// Set the object's primary key, but don't load it until needed
$this->object[$this->primary_key] = $id;
// Object is considered saved until something is set
$this->_saved = TRUE;
}
}
/**
* Prepares the model database connection, determines the table name,
* and loads column information.
*
* @return void
*/
public function __initialize()
{
if ( ! is_object($this->db))
{
// Get database instance
$this->db = Database::instance($this->db);
}
if (empty($this->table_name))
{
// Table name is the same as the object name
$this->table_name = $this->object_name;
if ($this->table_names_plural === TRUE)
{
// Make the table name plural
$this->table_name = inflector::plural($this->table_name);
}
}
if (is_array($this->ignored_columns))
{
// Make the ignored columns mirrored = mirrored
$this->ignored_columns = array_combine($this->ignored_columns, $this->ignored_columns);
}
// Load column information
$this->reload_columns();
// Initialize the builder
$this->db_builder = db::build();
}
/**
* Allows serialization of only the object data and state, to prevent
* "stale" objects being unserialized, which also requires less memory.
*
* @return array
*/
public function __sleep()
{
// Store only information about the object
return array('object_name', 'object', 'changed', '_loaded', '_saved', 'sorting');
}
/**
* Prepares the database connection and reloads the object.
*
* @return void
*/
public function __wakeup()
{
// Initialize database
$this->__initialize();
if ($this->reload_on_wakeup === TRUE)
{
// Reload the object
$this->reload();
}
}
/**
* Handles pass-through to database methods. Calls to query methods
* (query, get, insert, update) are not allowed. Query builder methods
* are chainable.
*
* @param string method name
* @param array method arguments
* @return mixed
*/
public function __call($method, array $args)
{
if (method_exists($this->db_builder, $method))
{
if (in_array($method, array('execute', 'insert', 'update', 'delete')))
throw new Kohana_Exception('Query methods cannot be used through ORM');
// Method has been applied to the database
$this->db_applied[$method] = $method;
// Number of arguments passed
$num_args = count($args);
if ($method === 'select' AND $num_args > 3)
{
// Call select() manually to avoid call_user_func_array
$this->db_builder->select($args);
}
else
{
// We use switch here to manually call the database methods. This is
// done for speed: call_user_func_array can take over 300% longer to
// make calls. Most database methods are 4 arguments or less, so this
// avoids almost any calls to call_user_func_array.
switch ($num_args)
{
case 0:
if (in_array($method, array('open', 'close', 'cache')))
{
// Should return ORM, not Database
$this->db_builder->$method();
}
else
{
// Support for things like reset_select, reset_write, list_tables
$this->db_builder->$method();
}
break;
case 1:
$this->db_builder->$method($args[0]);
break;
case 2:
$this->db_builder->$method($args[0], $args[1]);
break;
case 3:
$this->db_builder->$method($args[0], $args[1], $args[2]);
break;
case 4:
$this->db_builder->$method($args[0], $args[1], $args[2], $args[3]);
break;
default:
// Here comes the snail...
call_user_func_array(array($this->db, $method), $args);
break;
}
}
return $this;
}
else
{
throw new Kohana_Exception('Invalid method :method called in :class',
array(':method' => $method, ':class' => get_class($this)));
}
}
/**
* Handles retrieval of all model values, relationships, and metadata.
*
* @param string column name
* @return mixed
*/
public function __get($column)
{
if (array_key_exists($column, $this->object))
{
if( ! $this->loaded() AND ! $this->empty_primary_key())
{
// Column asked for but the object hasn't been loaded yet, so do it now
// Ignore loading of any columns that have been changed
$this->find($this->object[$this->primary_key], TRUE);
}
return $this->object[$column];
}
elseif (isset($this->related[$column]))
{
return $this->related[$column];
}
elseif ($column === 'primary_key_value')
{
if( ! $this->loaded() AND ! $this->empty_primary_key() AND $this->unique_key($this->object[$this->primary_key]) !== $this->primary_key)
{
// Load if object hasn't been loaded and the key given isn't the primary_key
// that we need (i.e. passing an email address to ORM::factory rather than the id)
$this->find($this->object[$this->primary_key], TRUE);
}
return $this->object[$this->primary_key];
}
elseif ($model = $this->related_object($column))
{
// This handles the has_one and belongs_to relationships
if (in_array($model->object_name, $this->belongs_to))
{
if ( ! $this->loaded() AND ! $this->empty_primary_key())
{
// Load this object first so we know what id to look for in the foreign table
$this->find($this->object[$this->primary_key], TRUE);
}
// Foreign key lies in this table (this model belongs_to target model)
$where = array($model->foreign_key(TRUE) => $this->object[$this->foreign_key($column)]);
}
else
{
// Foreign key lies in the target table (this model has_one target model)
$where = array($this->foreign_key($column, $model->table_name) => $this->primary_key_value);
}
// one<>alias:one relationship
return $this->related[$column] = $model->find($where);
}
elseif (isset($this->has_many_through[$column]))
{
// Load the "middle" model
$through = ORM::factory(inflector::singular($this->has_many_through[$column]));
// Load the "end" model
$model = ORM::factory(inflector::singular($column));
// Join ON target model's primary key set to 'through' model's foreign key
// User-defined foreign keys must be defined in the 'through' model
$join_table = $through->table_name;
$join_col1 = $through->foreign_key($model->object_name, $join_table);
$join_col2 = $model->foreign_key(TRUE);
// one<>alias:many relationship
return $model
->join($join_table, $join_col1, $join_col2)
->where($through->foreign_key($this->object_name, $join_table), '=', $this->primary_key_value);
}
elseif (isset($this->has_many[$column]))
{
// one<>many aliased relationship
$model_name = $this->has_many[$column];
$model = ORM::factory(inflector::singular($model_name));
return $model->where($this->foreign_key($column, $model->table_name), '=', $this->primary_key_value);
}
elseif (in_array($column, $this->has_many))
{
// one<>many relationship
$model = ORM::factory(inflector::singular($column));
return $model->where($this->foreign_key($column, $model->table_name), '=', $this->primary_key_value);
}
elseif (in_array($column, $this->has_and_belongs_to_many))
{
// Load the remote model, always singular
$model = ORM::factory(inflector::singular($column));
if ($this->has($model, TRUE))
{
// many<>many relationship
return $model->where($model->foreign_key(TRUE), 'IN', $this->changed_relations[$column]);
}
else
{
// empty many<>many relationship
return $model->where($model->foreign_key(TRUE), 'IS', NULL);
}
}
elseif (isset($this->ignored_columns[$column]))
{
return NULL;
}
elseif (in_array($column, array
(
'object_name', 'object_plural','_valid', // Object
'primary_key', 'primary_val', 'table_name', 'table_columns', // Table
'has_one', 'belongs_to', 'has_many', 'has_many_through', 'has_and_belongs_to_many', 'load_with' // Relationships
)))
{
// Model meta information
return $this->$column;
}
else
{
throw new Kohana_Exception('The :property property does not exist in the :class class',
array(':property' => $column, ':class' => get_class($this)));
}
}
/**
* Tells you if the Model has been loaded or not
*
* @return bool
*/
public function loaded() {
if ( ! $this->_loaded AND ! $this->empty_primary_key())
{
// If returning the loaded member and no load has been attempted, do it now
$this->find($this->object[$this->primary_key], TRUE);
}
return $this->_loaded;
}
/**
* Tells you if the model was saved successfully or not
*
* @return bool
*/
public function saved() {
return $this->_saved;
}
/**
* Handles setting of all model values, and tracks changes between values.
*
* @param string column name
* @param mixed column value
* @return void
*/
public function __set($column, $value)
{
if (isset($this->ignored_columns[$column]))
{
return NULL;
}
elseif (isset($this->object[$column]) OR array_key_exists($column, $this->object))
{
if (isset($this->table_columns[$column]))
{
// Data has changed
$this->changed[$column] = $column;
// Object is no longer saved
$this->_saved = FALSE;
}
$this->object[$column] = $this->load_type($column, $value);
}
elseif (in_array($column, $this->has_and_belongs_to_many) AND is_array($value))
{
// Load relations
$model = ORM::factory(inflector::singular($column));
if ( ! isset($this->object_relations[$column]))
{
// Load relations
$this->has($model);
}
// Change the relationships
$this->changed_relations[$column] = $value;
if (isset($this->related[$column]))
{
// Force a reload of the relationships
unset($this->related[$column]);
}
}
else
{
throw new Kohana_Exception('The :property: property does not exist in the :class: class',
array(':property:' => $column, ':class:' => get_class($this)));
}
}
/**
* Chainable set method
*
* @param string name of field or array of key => val
* @param mixed value
* @return ORM
*/
public function set($name, $value = NULL)
{
if (is_array($name))
{
foreach ($name as $key => $value)
{
$this->__set($key, $value);
}
}
else
{
$this->__set($name, $value);
}
return $this;
}
/**
* Checks if object data is set.
*
* @param string column name
* @return boolean
*/
public function __isset($column)
{
return (isset($this->object[$column]) OR isset($this->related[$column]));
}
/**
* Unsets object data.
*
* @param string column name
* @return void
*/
public function __unset($column)
{
unset($this->object[$column], $this->changed[$column], $this->related[$column]);
}
/**
* Displays the primary key of a model when it is converted to a string.
*
* @return string
*/
public function __toString()
{
return (string) $this->primary_key_value;
}
/**
* Returns the values of this object as an array.
*
* @return array
*/
public function as_array()
{
$object = array();
foreach ($this->object as $key => $val)
{
// Reconstruct the array (calls __get)
$object[$key] = $this->$key;
}
foreach ($this->with_applied as $model => $enabled)
{
// Generate arrays for relationships
if ($enabled)
{
$object[$model] = $this->$model->as_array();
}
}
return $object;
}
/**
* Binds another one-to-one object to this model. One-to-one objects
* can be nested using 'object1:object2' syntax
*
* @param string target model to bind to
* @return void
*/
public function with($target_path)
{
if (isset($this->with_applied[$target_path]))
{
// Don't join anything already joined
return $this;
}
// Split object parts
$objects = explode(':', $target_path);
$target = $this;
foreach ($objects as $object)
{
// Go down the line of objects to find the given target
$parent = $target;
$target = $parent->related_object($object);
if ( ! $target)
{
// Can't find related object
return $this;
}
}
$target_name = $object;
// Pop-off top object to get the parent object (user:photo:tag becomes user:photo - the parent table prefix)
array_pop($objects);
$parent_path = implode(':', $objects);
if (empty($parent_path))
{
// Use this table name itself for the parent object
$parent_path = $this->table_name;
}
else
{
if( ! isset($this->with_applied[$parent_path]))
{
// If the parent object hasn't been joined yet, do it first (otherwise LEFT JOINs fail)
$this->with($parent_path);
}
}
// Add to with_applied to prevent duplicate joins
$this->with_applied[$target_path] = TRUE;
$select = array();
// Use the keys of the empty object to determine the columns
foreach (array_keys($target->object) as $column)
{
// Add the prefix so that load_result can determine the relationship
$select[$target_path.':'.$column] = $target_path.'.'.$column;
}
// Select all of the prefixed keys in the object
$this->db_builder->select($select);
if (in_array($target->object_name, $parent->belongs_to))
{
// Parent belongs_to target, use target's primary key as join column
$join_col1 = $target->foreign_key(TRUE, $target_path);
$join_col2 = $parent->foreign_key($target_name, $parent_path);
}
else
{
// Parent has_one target, use parent's primary key as join column
$join_col2 = $parent->foreign_key(TRUE, $parent_path);
$join_col1 = $parent->foreign_key($target_name, $target_path);
}
// This trick allows for models to use different table prefixes (sharing the same database)
$join_table = array($this->db->quote_table($target_path) => $target->db->quote_table($target->table_name));
// Join the related object into the result
// Use Database_Expression to disable prefixing
$this->db_builder->join(new Database_Expression($join_table), $join_col1, $join_col2, 'LEFT');
return $this;
}
/**
* Finds and loads a single database row into the object.
*
* @chainable
* @param mixed primary key or an array of clauses
* @param bool ignore loading of columns that have been modified
* @return ORM
*/
public function find($id = NULL, $ignore_changed = FALSE)
{
if ($id !== NULL)
{
if (is_array($id))
{
// Search for all clauses
$this->db_builder->where($id);
}
else
{
// Search for a specific column
$this->db_builder->where($this->table_name.'.'.$this->unique_key($id), '=', $id);
}
}
return $this->load_result(FALSE, $ignore_changed);
}
/**
* Finds multiple database rows and returns an iterator of the rows found.
*
* @chainable
* @param integer SQL limit
* @param integer SQL offset
* @return ORM_Iterator
*/
public function find_all($limit = NULL, $offset = NULL)
{
if ($limit !== NULL AND ! isset($this->db_applied['limit']))
{
// Set limit
$this->limit($limit);
}
if ($offset !== NULL AND ! isset($this->db_applied['offset']))
{
// Set offset
$this->offset($offset);
}
return $this->load_result(TRUE);
}
/**
* Creates a key/value array from all of the objects available. Uses find_all
* to find the objects.
*
* @param string key column
* @param string value column
* @return array
*/
public function select_list($key = NULL, $val = NULL)
{
if ($key === NULL)
{
$key = $this->primary_key;
}
if ($val === NULL)
{
$val = $this->primary_val;
}
// Return a select list from the results
return $this->select($this->table_name.'.'.$key, $this->table_name.'.'.$val)->find_all()->select_list($key, $val);
}
/**
* Validates the current object. This method requires that rules are set to be useful, if called with out
* any rules set, or if a Validation object isn't passed, nothing happens.
*
* @param object Validation array
* @param boolean Save on validate
* @return ORM
* @chainable
*/
public function validate(Validation $array = NULL)
{
if ($array === NULL)
$array = new Validation($this->object);
if (count($this->rules) > 0)
{
foreach ($this->rules as $field => $parameters)
{
foreach ($parameters as $type => $value) {
switch ($type) {
case 'pre_filter':
$array->pre_filter($value,$field);
break;
case 'rules':
$rules = array_merge(array($field),$value);
call_user_func_array(array($array,'add_rules'), $rules);
break;
case 'callbacks':
$callbacks = array_merge(array($field),$value);
call_user_func_array(array($array,'add_callbacks'), $callbacks);
break;
}
}
}
}
// Validate the array
if (($this->_valid = $array->validate()) === FALSE)
{
ORM_Validation_Exception::handle_validation($this->table_name, $array);
}
// Return validation status
return $this;
}
/**
* Saves the current object.
*
* @chainable
* @return ORM
*/
public function save()
{
if ( ! empty($this->changed))
{
// Require model validation before saving
if (!$this->_valid)
$this->validate();
$data = array();
foreach ($this->changed as $column)
{
// Compile changed data
$data[$column] = $this->object[$column];
}
if ( ! $this->empty_primary_key() AND ! isset($this->changed[$this->primary_key]))
{
// Primary key isn't empty and hasn't been changed so do an update
if (is_array($this->updated_column))
{
// Fill the updated column
$column = $this->updated_column['column'];
$format = $this->updated_column['format'];
$data[$column] = $this->object[$column] = ($format === TRUE) ? time() : date($format);
}
$query = db::update($this->table_name)
->set($data)
->where($this->primary_key, '=', $this->primary_key_value)
->execute($this->db);
// Object has been saved
$this->_saved = TRUE;
}
else
{
if (is_array($this->created_column))
{
// Fill the created column
$column = $this->created_column['column'];
$format = $this->created_column['format'];
$data[$column] = $this->object[$column] = ($format === TRUE) ? time() : date($format);
}
$result = db::insert($this->table_name)
->columns(array_keys($data))
->values(array_values($data))
->execute($this->db);
if ($result->count() > 0)
{
if (empty($this->object[$this->primary_key]))
{
// Load the insert id as the primary key
$this->object[$this->primary_key] = $result->insert_id();
}
// Object is now loaded and saved
$this->_loaded = $this->_saved = TRUE;
}
}
if ($this->saved() === TRUE)
{
// All changes have been saved
$this->changed = array();
}
}
if ($this->saved() === TRUE AND ! empty($this->changed_relations))
{
foreach ($this->changed_relations as $column => $values)
{
// All values that were added
$added = array_diff($values, $this->object_relations[$column]);
// All values that were saved
$removed = array_diff($this->object_relations[$column], $values);
if (empty($added) AND empty($removed))
{
// No need to bother
continue;
}
// Clear related columns
unset($this->related[$column]);
// Load the model
$model = ORM::factory(inflector::singular($column));
if (($join_table = array_search($column, $this->has_and_belongs_to_many)) === FALSE)
continue;
if (is_int($join_table))
{
// No "through" table, load the default JOIN table
$join_table = $model->join_table($this->table_name);
}
// Foreign keys for the join table
$object_fk = $this->foreign_key(NULL);
$related_fk = $model->foreign_key(NULL);
if ( ! empty($added))
{
foreach ($added as $id)
{
// Insert the new relationship
db::insert($join_table)
->columns($object_fk, $related_fk)
->values($this->primary_key_value, $id)
->execute($this->db);
}
}
if ( ! empty($removed))
{
db::delete($join_table)
->where($object_fk, '=', $this->primary_key_value)
->where($related_fk, 'IN', $removed)
->execute($this->db);
}
// Clear all relations for this column
unset($this->object_relations[$column], $this->changed_relations[$column]);
}
}
return $this;
}
/**
* Deletes the current object from the database. This does NOT destroy
* relationships that have been created with other objects.
*
* @chainable
* @param mixed id to delete
* @return ORM
*/
public function delete($id = NULL)
{
if ($id === NULL)
{
// Use the the primary key value
$id = $this->primary_key_value;
}
// Delete this object
db::delete($this->table_name)
->where($this->primary_key, '=', $id)
->execute($this->db);
return $this->clear();
}
/**
* Delete all objects in the associated table. This does NOT destroy
* relationships that have been created with other objects.
*
* @chainable
* @param array ids to delete
* @return ORM
*/
public function delete_all($ids = NULL)
{
if (is_array($ids))
{
// Delete only given ids
db::delete($this->table_name)
->where($this->primary_key, 'IN', $ids)
->execute($this->db);
}
elseif ($ids === NULL)
{
// Delete all records
db::delete($this->table_name)
->execute($this->db);
}
else
{
// Do nothing - safeguard
return $this;
}
return $this->clear();
}
/**
* Unloads the current object and clears the status.
*
* @chainable
* @return ORM
*/
public function clear()
{
// Create an array with all the columns set to NULL
$columns = array_keys($this->table_columns);
$values = array_combine($columns, array_fill(0, count($columns), NULL));
// Replace the current object with an empty one
$this->_load_values($values);
return $this;
}
/**
* Reloads the current object from the database.
*
* @chainable
* @return ORM
*/
public function reload()
{
return $this->find($this->object[$this->primary_key]);
}
/**