Completed
Pull Request — 4.0 (#73)
by David
06:22
created
src/Mouf/Database/TDBM/AbstractTDBMObject.php 1 patch
Indentation   +486 added lines, -486 removed lines patch added patch discarded remove patch
@@ -31,495 +31,495 @@
 block discarded – undo
31 31
  */
32 32
 abstract class AbstractTDBMObject implements JsonSerializable
33 33
 {
34
-    /**
35
-     * The service this object is bound to.
36
-     *
37
-     * @var TDBMService
38
-     */
39
-    protected $tdbmService;
40
-
41
-    /**
42
-     * An array of DbRow, indexed by table name.
43
-     *
44
-     * @var DbRow[]
45
-     */
46
-    protected $dbRows = array();
47
-
48
-    /**
49
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
50
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
51
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
52
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
53
-     *
54
-     * @var string
55
-     */
56
-    private $status;
57
-
58
-    /**
59
-     * Array storing beans related via many to many relationships (pivot tables).
60
-     *
61
-     * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage
62
-     */
63
-    private $relationships = [];
64
-
65
-    /**
66
-     * @var bool[] Key: pivot table name, value: whether a query was performed to load the data.
67
-     */
68
-    private $loadedRelationships = [];
69
-
70
-    /**
71
-     * Used with $primaryKeys when we want to retrieve an existing object
72
-     * and $primaryKeys=[] if we want a new object.
73
-     *
74
-     * @param string      $tableName
75
-     * @param array       $primaryKeys
76
-     * @param TDBMService $tdbmService
77
-     *
78
-     * @throws TDBMException
79
-     * @throws TDBMInvalidOperationException
80
-     */
81
-    public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null)
82
-    {
83
-        // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
84
-        if (!empty($tableName)) {
85
-            $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
86
-        }
87
-
88
-        if ($tdbmService === null) {
89
-            $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED);
90
-        } else {
91
-            $this->_attach($tdbmService);
92
-            if (!empty($primaryKeys)) {
93
-                $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
94
-            } else {
95
-                $this->_setStatus(TDBMObjectStateEnum::STATE_NEW);
96
-            }
97
-        }
98
-    }
99
-
100
-    /**
101
-     * Alternative constructor called when data is fetched from database via a SELECT.
102
-     *
103
-     * @param array       $beanData    array<table, array<column, value>>
104
-     * @param TDBMService $tdbmService
105
-     */
106
-    public function _constructFromData(array $beanData, TDBMService $tdbmService)
107
-    {
108
-        $this->tdbmService = $tdbmService;
109
-
110
-        foreach ($beanData as $table => $columns) {
111
-            $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns);
112
-        }
113
-
114
-        $this->status = TDBMObjectStateEnum::STATE_LOADED;
115
-    }
116
-
117
-    /**
118
-     * Alternative constructor called when bean is lazily loaded.
119
-     *
120
-     * @param string      $tableName
121
-     * @param array       $primaryKeys
122
-     * @param TDBMService $tdbmService
123
-     */
124
-    public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService)
125
-    {
126
-        $this->tdbmService = $tdbmService;
127
-
128
-        $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
129
-
130
-        $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
131
-    }
132
-
133
-    public function _attach(TDBMService $tdbmService)
134
-    {
135
-        if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
136
-            throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
137
-        }
138
-        $this->tdbmService = $tdbmService;
139
-
140
-        // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level)
141
-        $tableNames = array_keys($this->dbRows);
142
-        $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames);
143
-        $tableNames = array_reverse($tableNames);
144
-
145
-        $newDbRows = [];
146
-
147
-        foreach ($tableNames as $table) {
148
-            if (!isset($this->dbRows[$table])) {
149
-                $this->registerTable($table);
150
-            }
151
-            $newDbRows[$table] = $this->dbRows[$table];
152
-        }
153
-        $this->dbRows = $newDbRows;
154
-
155
-        $this->status = TDBMObjectStateEnum::STATE_NEW;
156
-        foreach ($this->dbRows as $dbRow) {
157
-            $dbRow->_attach($tdbmService);
158
-        }
159
-    }
160
-
161
-    /**
162
-     * Sets the state of the TDBM Object
163
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
164
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
165
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
166
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
167
-     *
168
-     * @param string $state
169
-     */
170
-    public function _setStatus($state)
171
-    {
172
-        $this->status = $state;
173
-
174
-        // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
175
-        foreach ($this->dbRows as $dbRow) {
176
-            $dbRow->_setStatus($state);
177
-        }
178
-    }
179
-
180
-    /**
181
-     * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null"
182
-     * or throws an error.
183
-     *
184
-     * @param string $tableName
185
-     *
186
-     * @return string
187
-     */
188
-    private function checkTableName($tableName = null)
189
-    {
190
-        if ($tableName === null) {
191
-            if (count($this->dbRows) > 1) {
192
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
193
-            } elseif (count($this->dbRows) === 1) {
194
-                $tableName = array_keys($this->dbRows)[0];
195
-            }
196
-        }
197
-
198
-        if (!isset($this->dbRows[$tableName])) {
199
-            if (count($this->dbRows[$tableName] === 0)) {
200
-                throw new TDBMException('Object is not yet bound to any table.');
201
-            } else {
202
-                throw new TDBMException('Unknown table "'.$tableName.'"" in object.');
203
-            }
204
-        }
205
-
206
-        return $tableName;
207
-    }
208
-
209
-    protected function get($var, $tableName = null)
210
-    {
211
-        $tableName = $this->checkTableName($tableName);
212
-
213
-        return $this->dbRows[$tableName]->get($var);
214
-    }
215
-
216
-    protected function set($var, $value, $tableName = null)
217
-    {
218
-        if ($tableName === null) {
219
-            if (count($this->dbRows) > 1) {
220
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
221
-            } elseif (count($this->dbRows) === 1) {
222
-                $tableName = array_keys($this->dbRows)[0];
223
-            } else {
224
-                throw new TDBMException('Please specify a table for this object.');
225
-            }
226
-        }
227
-
228
-        if (!isset($this->dbRows[$tableName])) {
229
-            $this->registerTable($tableName);
230
-        }
231
-
232
-        $this->dbRows[$tableName]->set($var, $value);
233
-        if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
234
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
235
-        }
236
-    }
237
-
238
-    /**
239
-     * @param string             $foreignKeyName
240
-     * @param AbstractTDBMObject $bean
241
-     */
242
-    protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null)
243
-    {
244
-        if ($tableName === null) {
245
-            if (count($this->dbRows) > 1) {
246
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
247
-            } elseif (count($this->dbRows) === 1) {
248
-                $tableName = array_keys($this->dbRows)[0];
249
-            } else {
250
-                throw new TDBMException('Please specify a table for this object.');
251
-            }
252
-        }
253
-
254
-        if (!isset($this->dbRows[$tableName])) {
255
-            $this->registerTable($tableName);
256
-        }
257
-
258
-        $this->dbRows[$tableName]->setRef($foreignKeyName, $bean);
259
-        if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
260
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
261
-        }
262
-    }
263
-
264
-    /**
265
-     * @param string $foreignKeyName A unique name for this reference
266
-     *
267
-     * @return AbstractTDBMObject|null
268
-     */
269
-    protected function getRef($foreignKeyName, $tableName = null)
270
-    {
271
-        $tableName = $this->checkTableName($tableName);
272
-
273
-        return $this->dbRows[$tableName]->getRef($foreignKeyName);
274
-    }
275
-
276
-    /**
277
-     * Adds a many to many relationship to this bean.
278
-     *
279
-     * @param string             $pivotTableName
280
-     * @param AbstractTDBMObject $remoteBean
281
-     */
282
-    protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
283
-    {
284
-        $this->setRelationship($pivotTableName, $remoteBean, 'new');
285
-    }
286
-
287
-    /**
288
-     * Returns true if there is a relationship to this bean.
289
-     *
290
-     * @param string             $pivotTableName
291
-     * @param AbstractTDBMObject $remoteBean
292
-     *
293
-     * @return bool
294
-     */
295
-    protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
296
-    {
297
-        $storage = $this->retrieveRelationshipsStorage($pivotTableName);
298
-
299
-        if ($storage->contains($remoteBean)) {
300
-            if ($storage[$remoteBean]['status'] !== 'delete') {
301
-                return true;
302
-            }
303
-        }
304
-
305
-        return false;
306
-    }
307
-
308
-    /**
309
-     * Internal TDBM method. Removes a many to many relationship from this bean.
310
-     *
311
-     * @param string             $pivotTableName
312
-     * @param AbstractTDBMObject $remoteBean
313
-     */
314
-    public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
315
-    {
316
-        if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') {
317
-            unset($this->relationships[$pivotTableName][$remoteBean]);
318
-            unset($remoteBean->relationships[$pivotTableName][$this]);
319
-        } else {
320
-            $this->setRelationship($pivotTableName, $remoteBean, 'delete');
321
-        }
322
-    }
323
-
324
-    /**
325
-     * Returns the list of objects linked to this bean via $pivotTableName.
326
-     *
327
-     * @param $pivotTableName
328
-     *
329
-     * @return \SplObjectStorage
330
-     */
331
-    private function retrieveRelationshipsStorage($pivotTableName)
332
-    {
333
-        $storage = $this->getRelationshipStorage($pivotTableName);
334
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) {
335
-            return $storage;
336
-        }
337
-
338
-        $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this);
339
-        $this->loadedRelationships[$pivotTableName] = true;
340
-
341
-        foreach ($beans as $bean) {
342
-            if (isset($storage[$bean])) {
343
-                $oldStatus = $storage[$bean]['status'];
344
-                if ($oldStatus === 'delete') {
345
-                    // Keep deleted things deleted
346
-                    continue;
347
-                }
348
-            }
349
-            $this->setRelationship($pivotTableName, $bean, 'loaded');
350
-        }
351
-
352
-        return $storage;
353
-    }
354
-
355
-    /**
356
-     * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
357
-     *
358
-     * @param $pivotTableName
359
-     *
360
-     * @return AbstractTDBMObject[]
361
-     */
362
-    public function _getRelationships($pivotTableName)
363
-    {
364
-        return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
365
-    }
366
-
367
-    private function relationshipStorageToArray(\SplObjectStorage $storage)
368
-    {
369
-        $beans = [];
370
-        foreach ($storage as $bean) {
371
-            $statusArr = $storage[$bean];
372
-            if ($statusArr['status'] !== 'delete') {
373
-                $beans[] = $bean;
374
-            }
375
-        }
376
-
377
-        return $beans;
378
-    }
379
-
380
-    /**
381
-     * Declares a relationship between.
382
-     *
383
-     * @param string             $pivotTableName
384
-     * @param AbstractTDBMObject $remoteBean
385
-     * @param string             $status
386
-     */
387
-    private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status)
388
-    {
389
-        $storage = $this->getRelationshipStorage($pivotTableName);
390
-        $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
391
-        if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
392
-            $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
393
-        }
394
-
395
-        $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
396
-        $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
397
-    }
398
-
399
-    /**
400
-     * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
401
-     *
402
-     * @param $pivotTableName
403
-     *
404
-     * @return \SplObjectStorage
405
-     */
406
-    private function getRelationshipStorage($pivotTableName)
407
-    {
408
-        if (isset($this->relationships[$pivotTableName])) {
409
-            $storage = $this->relationships[$pivotTableName];
410
-        } else {
411
-            $storage = new \SplObjectStorage();
412
-            $this->relationships[$pivotTableName] = $storage;
413
-        }
414
-
415
-        return $storage;
416
-    }
417
-
418
-    /**
419
-     * Reverts any changes made to the object and resumes it to its DB state.
420
-     * This can only be called on objects that come from database and that have not been deleted.
421
-     * Otherwise, this will throw an exception.
422
-     *
423
-     * @throws TDBMException
424
-     */
425
-    public function discardChanges()
426
-    {
427
-        if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) {
428
-            throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved.");
429
-        }
430
-
431
-        if ($this->status === TDBMObjectStateEnum::STATE_DELETED) {
432
-            throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.');
433
-        }
434
-
435
-        $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
436
-    }
437
-
438
-    /**
439
-     * Method used internally by TDBM. You should not use it directly.
440
-     * This method returns the status of the TDBMObject.
441
-     * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
442
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
443
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
444
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
445
-     *
446
-     * @return string
447
-     */
448
-    public function _getStatus()
449
-    {
450
-        return $this->status;
451
-    }
452
-
453
-    /**
454
-     * Override the native php clone function for TDBMObjects.
455
-     */
456
-    public function __clone()
457
-    {
458
-        // Let's clone the many to many relationships
459
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) {
460
-            $pivotTableList = array_keys($this->relationships);
461
-        } else {
462
-            $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this);
463
-        }
464
-
465
-        foreach ($pivotTableList as $pivotTable) {
466
-            $storage = $this->retrieveRelationshipsStorage($pivotTable);
467
-
468
-            // Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!!
469
-            /*foreach ($storage as $remoteBean) {
34
+	/**
35
+	 * The service this object is bound to.
36
+	 *
37
+	 * @var TDBMService
38
+	 */
39
+	protected $tdbmService;
40
+
41
+	/**
42
+	 * An array of DbRow, indexed by table name.
43
+	 *
44
+	 * @var DbRow[]
45
+	 */
46
+	protected $dbRows = array();
47
+
48
+	/**
49
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
50
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
51
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
52
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
53
+	 *
54
+	 * @var string
55
+	 */
56
+	private $status;
57
+
58
+	/**
59
+	 * Array storing beans related via many to many relationships (pivot tables).
60
+	 *
61
+	 * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage
62
+	 */
63
+	private $relationships = [];
64
+
65
+	/**
66
+	 * @var bool[] Key: pivot table name, value: whether a query was performed to load the data.
67
+	 */
68
+	private $loadedRelationships = [];
69
+
70
+	/**
71
+	 * Used with $primaryKeys when we want to retrieve an existing object
72
+	 * and $primaryKeys=[] if we want a new object.
73
+	 *
74
+	 * @param string      $tableName
75
+	 * @param array       $primaryKeys
76
+	 * @param TDBMService $tdbmService
77
+	 *
78
+	 * @throws TDBMException
79
+	 * @throws TDBMInvalidOperationException
80
+	 */
81
+	public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null)
82
+	{
83
+		// FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
84
+		if (!empty($tableName)) {
85
+			$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
86
+		}
87
+
88
+		if ($tdbmService === null) {
89
+			$this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED);
90
+		} else {
91
+			$this->_attach($tdbmService);
92
+			if (!empty($primaryKeys)) {
93
+				$this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
94
+			} else {
95
+				$this->_setStatus(TDBMObjectStateEnum::STATE_NEW);
96
+			}
97
+		}
98
+	}
99
+
100
+	/**
101
+	 * Alternative constructor called when data is fetched from database via a SELECT.
102
+	 *
103
+	 * @param array       $beanData    array<table, array<column, value>>
104
+	 * @param TDBMService $tdbmService
105
+	 */
106
+	public function _constructFromData(array $beanData, TDBMService $tdbmService)
107
+	{
108
+		$this->tdbmService = $tdbmService;
109
+
110
+		foreach ($beanData as $table => $columns) {
111
+			$this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns);
112
+		}
113
+
114
+		$this->status = TDBMObjectStateEnum::STATE_LOADED;
115
+	}
116
+
117
+	/**
118
+	 * Alternative constructor called when bean is lazily loaded.
119
+	 *
120
+	 * @param string      $tableName
121
+	 * @param array       $primaryKeys
122
+	 * @param TDBMService $tdbmService
123
+	 */
124
+	public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService)
125
+	{
126
+		$this->tdbmService = $tdbmService;
127
+
128
+		$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
129
+
130
+		$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
131
+	}
132
+
133
+	public function _attach(TDBMService $tdbmService)
134
+	{
135
+		if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
136
+			throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
137
+		}
138
+		$this->tdbmService = $tdbmService;
139
+
140
+		// If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level)
141
+		$tableNames = array_keys($this->dbRows);
142
+		$tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames);
143
+		$tableNames = array_reverse($tableNames);
144
+
145
+		$newDbRows = [];
146
+
147
+		foreach ($tableNames as $table) {
148
+			if (!isset($this->dbRows[$table])) {
149
+				$this->registerTable($table);
150
+			}
151
+			$newDbRows[$table] = $this->dbRows[$table];
152
+		}
153
+		$this->dbRows = $newDbRows;
154
+
155
+		$this->status = TDBMObjectStateEnum::STATE_NEW;
156
+		foreach ($this->dbRows as $dbRow) {
157
+			$dbRow->_attach($tdbmService);
158
+		}
159
+	}
160
+
161
+	/**
162
+	 * Sets the state of the TDBM Object
163
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
164
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
165
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
166
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
167
+	 *
168
+	 * @param string $state
169
+	 */
170
+	public function _setStatus($state)
171
+	{
172
+		$this->status = $state;
173
+
174
+		// TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
175
+		foreach ($this->dbRows as $dbRow) {
176
+			$dbRow->_setStatus($state);
177
+		}
178
+	}
179
+
180
+	/**
181
+	 * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null"
182
+	 * or throws an error.
183
+	 *
184
+	 * @param string $tableName
185
+	 *
186
+	 * @return string
187
+	 */
188
+	private function checkTableName($tableName = null)
189
+	{
190
+		if ($tableName === null) {
191
+			if (count($this->dbRows) > 1) {
192
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
193
+			} elseif (count($this->dbRows) === 1) {
194
+				$tableName = array_keys($this->dbRows)[0];
195
+			}
196
+		}
197
+
198
+		if (!isset($this->dbRows[$tableName])) {
199
+			if (count($this->dbRows[$tableName] === 0)) {
200
+				throw new TDBMException('Object is not yet bound to any table.');
201
+			} else {
202
+				throw new TDBMException('Unknown table "'.$tableName.'"" in object.');
203
+			}
204
+		}
205
+
206
+		return $tableName;
207
+	}
208
+
209
+	protected function get($var, $tableName = null)
210
+	{
211
+		$tableName = $this->checkTableName($tableName);
212
+
213
+		return $this->dbRows[$tableName]->get($var);
214
+	}
215
+
216
+	protected function set($var, $value, $tableName = null)
217
+	{
218
+		if ($tableName === null) {
219
+			if (count($this->dbRows) > 1) {
220
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
221
+			} elseif (count($this->dbRows) === 1) {
222
+				$tableName = array_keys($this->dbRows)[0];
223
+			} else {
224
+				throw new TDBMException('Please specify a table for this object.');
225
+			}
226
+		}
227
+
228
+		if (!isset($this->dbRows[$tableName])) {
229
+			$this->registerTable($tableName);
230
+		}
231
+
232
+		$this->dbRows[$tableName]->set($var, $value);
233
+		if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
234
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
235
+		}
236
+	}
237
+
238
+	/**
239
+	 * @param string             $foreignKeyName
240
+	 * @param AbstractTDBMObject $bean
241
+	 */
242
+	protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null)
243
+	{
244
+		if ($tableName === null) {
245
+			if (count($this->dbRows) > 1) {
246
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
247
+			} elseif (count($this->dbRows) === 1) {
248
+				$tableName = array_keys($this->dbRows)[0];
249
+			} else {
250
+				throw new TDBMException('Please specify a table for this object.');
251
+			}
252
+		}
253
+
254
+		if (!isset($this->dbRows[$tableName])) {
255
+			$this->registerTable($tableName);
256
+		}
257
+
258
+		$this->dbRows[$tableName]->setRef($foreignKeyName, $bean);
259
+		if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
260
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
261
+		}
262
+	}
263
+
264
+	/**
265
+	 * @param string $foreignKeyName A unique name for this reference
266
+	 *
267
+	 * @return AbstractTDBMObject|null
268
+	 */
269
+	protected function getRef($foreignKeyName, $tableName = null)
270
+	{
271
+		$tableName = $this->checkTableName($tableName);
272
+
273
+		return $this->dbRows[$tableName]->getRef($foreignKeyName);
274
+	}
275
+
276
+	/**
277
+	 * Adds a many to many relationship to this bean.
278
+	 *
279
+	 * @param string             $pivotTableName
280
+	 * @param AbstractTDBMObject $remoteBean
281
+	 */
282
+	protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
283
+	{
284
+		$this->setRelationship($pivotTableName, $remoteBean, 'new');
285
+	}
286
+
287
+	/**
288
+	 * Returns true if there is a relationship to this bean.
289
+	 *
290
+	 * @param string             $pivotTableName
291
+	 * @param AbstractTDBMObject $remoteBean
292
+	 *
293
+	 * @return bool
294
+	 */
295
+	protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
296
+	{
297
+		$storage = $this->retrieveRelationshipsStorage($pivotTableName);
298
+
299
+		if ($storage->contains($remoteBean)) {
300
+			if ($storage[$remoteBean]['status'] !== 'delete') {
301
+				return true;
302
+			}
303
+		}
304
+
305
+		return false;
306
+	}
307
+
308
+	/**
309
+	 * Internal TDBM method. Removes a many to many relationship from this bean.
310
+	 *
311
+	 * @param string             $pivotTableName
312
+	 * @param AbstractTDBMObject $remoteBean
313
+	 */
314
+	public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
315
+	{
316
+		if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') {
317
+			unset($this->relationships[$pivotTableName][$remoteBean]);
318
+			unset($remoteBean->relationships[$pivotTableName][$this]);
319
+		} else {
320
+			$this->setRelationship($pivotTableName, $remoteBean, 'delete');
321
+		}
322
+	}
323
+
324
+	/**
325
+	 * Returns the list of objects linked to this bean via $pivotTableName.
326
+	 *
327
+	 * @param $pivotTableName
328
+	 *
329
+	 * @return \SplObjectStorage
330
+	 */
331
+	private function retrieveRelationshipsStorage($pivotTableName)
332
+	{
333
+		$storage = $this->getRelationshipStorage($pivotTableName);
334
+		if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) {
335
+			return $storage;
336
+		}
337
+
338
+		$beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this);
339
+		$this->loadedRelationships[$pivotTableName] = true;
340
+
341
+		foreach ($beans as $bean) {
342
+			if (isset($storage[$bean])) {
343
+				$oldStatus = $storage[$bean]['status'];
344
+				if ($oldStatus === 'delete') {
345
+					// Keep deleted things deleted
346
+					continue;
347
+				}
348
+			}
349
+			$this->setRelationship($pivotTableName, $bean, 'loaded');
350
+		}
351
+
352
+		return $storage;
353
+	}
354
+
355
+	/**
356
+	 * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
357
+	 *
358
+	 * @param $pivotTableName
359
+	 *
360
+	 * @return AbstractTDBMObject[]
361
+	 */
362
+	public function _getRelationships($pivotTableName)
363
+	{
364
+		return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
365
+	}
366
+
367
+	private function relationshipStorageToArray(\SplObjectStorage $storage)
368
+	{
369
+		$beans = [];
370
+		foreach ($storage as $bean) {
371
+			$statusArr = $storage[$bean];
372
+			if ($statusArr['status'] !== 'delete') {
373
+				$beans[] = $bean;
374
+			}
375
+		}
376
+
377
+		return $beans;
378
+	}
379
+
380
+	/**
381
+	 * Declares a relationship between.
382
+	 *
383
+	 * @param string             $pivotTableName
384
+	 * @param AbstractTDBMObject $remoteBean
385
+	 * @param string             $status
386
+	 */
387
+	private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status)
388
+	{
389
+		$storage = $this->getRelationshipStorage($pivotTableName);
390
+		$storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
391
+		if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
392
+			$this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
393
+		}
394
+
395
+		$remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
396
+		$remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
397
+	}
398
+
399
+	/**
400
+	 * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
401
+	 *
402
+	 * @param $pivotTableName
403
+	 *
404
+	 * @return \SplObjectStorage
405
+	 */
406
+	private function getRelationshipStorage($pivotTableName)
407
+	{
408
+		if (isset($this->relationships[$pivotTableName])) {
409
+			$storage = $this->relationships[$pivotTableName];
410
+		} else {
411
+			$storage = new \SplObjectStorage();
412
+			$this->relationships[$pivotTableName] = $storage;
413
+		}
414
+
415
+		return $storage;
416
+	}
417
+
418
+	/**
419
+	 * Reverts any changes made to the object and resumes it to its DB state.
420
+	 * This can only be called on objects that come from database and that have not been deleted.
421
+	 * Otherwise, this will throw an exception.
422
+	 *
423
+	 * @throws TDBMException
424
+	 */
425
+	public function discardChanges()
426
+	{
427
+		if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) {
428
+			throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved.");
429
+		}
430
+
431
+		if ($this->status === TDBMObjectStateEnum::STATE_DELETED) {
432
+			throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.');
433
+		}
434
+
435
+		$this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
436
+	}
437
+
438
+	/**
439
+	 * Method used internally by TDBM. You should not use it directly.
440
+	 * This method returns the status of the TDBMObject.
441
+	 * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
442
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
443
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
444
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
445
+	 *
446
+	 * @return string
447
+	 */
448
+	public function _getStatus()
449
+	{
450
+		return $this->status;
451
+	}
452
+
453
+	/**
454
+	 * Override the native php clone function for TDBMObjects.
455
+	 */
456
+	public function __clone()
457
+	{
458
+		// Let's clone the many to many relationships
459
+		if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) {
460
+			$pivotTableList = array_keys($this->relationships);
461
+		} else {
462
+			$pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this);
463
+		}
464
+
465
+		foreach ($pivotTableList as $pivotTable) {
466
+			$storage = $this->retrieveRelationshipsStorage($pivotTable);
467
+
468
+			// Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!!
469
+			/*foreach ($storage as $remoteBean) {
470 470
                 $metadata = $storage[$remoteBean];
471 471
 
472 472
                 $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable);
473 473
                 $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]);
474 474
             }*/
475
-        }
476
-
477
-        // Let's clone each row
478
-        foreach ($this->dbRows as $key => &$dbRow) {
479
-            $dbRow = clone $dbRow;
480
-            $dbRow->setTDBMObject($this);
481
-        }
482
-
483
-        // Let's set the status to new (to enter the save function)
484
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
485
-    }
486
-
487
-    /**
488
-     * Returns raw database rows.
489
-     *
490
-     * @return DbRow[] Key: table name, Value: DbRow object
491
-     */
492
-    public function _getDbRows()
493
-    {
494
-        return $this->dbRows;
495
-    }
496
-
497
-    private function registerTable($tableName)
498
-    {
499
-        $dbRow = new DbRow($this, $tableName);
500
-
501
-        if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
502
-            // Let's get the primary key for the new table
503
-            $anotherDbRow = array_values($this->dbRows)[0];
504
-            /* @var $anotherDbRow DbRow */
505
-            $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys());
506
-            $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys);
507
-            $dbRow->_setPrimaryKeys($primaryKeys);
508
-        }
509
-
510
-        $dbRow->_setStatus($this->status);
511
-
512
-        $this->dbRows[$tableName] = $dbRow;
513
-        // TODO: look at status (if not new)=> get primary key from tdbmservice
514
-    }
515
-
516
-    /**
517
-     * Internal function: return the list of relationships.
518
-     *
519
-     * @return \SplObjectStorage[]
520
-     */
521
-    public function _getCachedRelationships()
522
-    {
523
-        return $this->relationships;
524
-    }
475
+		}
476
+
477
+		// Let's clone each row
478
+		foreach ($this->dbRows as $key => &$dbRow) {
479
+			$dbRow = clone $dbRow;
480
+			$dbRow->setTDBMObject($this);
481
+		}
482
+
483
+		// Let's set the status to new (to enter the save function)
484
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
485
+	}
486
+
487
+	/**
488
+	 * Returns raw database rows.
489
+	 *
490
+	 * @return DbRow[] Key: table name, Value: DbRow object
491
+	 */
492
+	public function _getDbRows()
493
+	{
494
+		return $this->dbRows;
495
+	}
496
+
497
+	private function registerTable($tableName)
498
+	{
499
+		$dbRow = new DbRow($this, $tableName);
500
+
501
+		if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
502
+			// Let's get the primary key for the new table
503
+			$anotherDbRow = array_values($this->dbRows)[0];
504
+			/* @var $anotherDbRow DbRow */
505
+			$indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys());
506
+			$primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys);
507
+			$dbRow->_setPrimaryKeys($primaryKeys);
508
+		}
509
+
510
+		$dbRow->_setStatus($this->status);
511
+
512
+		$this->dbRows[$tableName] = $dbRow;
513
+		// TODO: look at status (if not new)=> get primary key from tdbmservice
514
+	}
515
+
516
+	/**
517
+	 * Internal function: return the list of relationships.
518
+	 *
519
+	 * @return \SplObjectStorage[]
520
+	 */
521
+	public function _getCachedRelationships()
522
+	{
523
+		return $this->relationships;
524
+	}
525 525
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/DbRow.php 1 patch
Indentation   +374 added lines, -374 removed lines patch added patch discarded remove patch
@@ -27,170 +27,170 @@  discard block
 block discarded – undo
27 27
  */
28 28
 class DbRow
29 29
 {
30
-    /**
31
-     * The service this object is bound to.
32
-     *
33
-     * @var TDBMService
34
-     */
35
-    protected $tdbmService;
36
-
37
-    /**
38
-     * The object containing this db row.
39
-     *
40
-     * @var AbstractTDBMObject
41
-     */
42
-    private $object;
43
-
44
-    /**
45
-     * The name of the table the object if issued from.
46
-     *
47
-     * @var string
48
-     */
49
-    private $dbTableName;
50
-
51
-    /**
52
-     * The array of columns returned from database.
53
-     *
54
-     * @var array
55
-     */
56
-    private $dbRow = array();
57
-
58
-    /**
59
-     * @var AbstractTDBMObject[]
60
-     */
61
-    private $references = array();
62
-
63
-    /**
64
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
65
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
66
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
67
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
68
-     *
69
-     * @var string
70
-     */
71
-    private $status;
72
-
73
-    /**
74
-     * The values of the primary key.
75
-     * This is set when the object is in "loaded" state.
76
-     *
77
-     * @var array An array of column => value
78
-     */
79
-    private $primaryKeys;
80
-
81
-    /**
82
-     * You should never call the constructor directly. Instead, you should use the
83
-     * TDBMService class that will create TDBMObjects for you.
84
-     *
85
-     * Used with id!=false when we want to retrieve an existing object
86
-     * and id==false if we want a new object
87
-     *
88
-     * @param AbstractTDBMObject $object      The object containing this db row.
89
-     * @param string             $table_name
90
-     * @param array              $primaryKeys
91
-     * @param TDBMService        $tdbmService
92
-     *
93
-     * @throws TDBMException
94
-     * @throws TDBMInvalidOperationException
95
-     */
96
-    public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array())
97
-    {
98
-        $this->object = $object;
99
-        $this->dbTableName = $table_name;
100
-
101
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
102
-
103
-        if ($tdbmService === null) {
104
-            if (!empty($primaryKeys)) {
105
-                throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.');
106
-            }
107
-        } else {
108
-            $this->tdbmService = $tdbmService;
109
-
110
-            if (!empty($primaryKeys)) {
111
-                $this->_setPrimaryKeys($primaryKeys);
112
-                if (!empty($dbRow)) {
113
-                    $this->dbRow = $dbRow;
114
-                    $this->status = TDBMObjectStateEnum::STATE_LOADED;
115
-                } else {
116
-                    $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
117
-                }
118
-                $tdbmService->_addToCache($this);
119
-            } else {
120
-                $this->status = TDBMObjectStateEnum::STATE_NEW;
121
-                $this->tdbmService->_addToToSaveObjectList($this);
122
-            }
123
-        }
124
-    }
125
-
126
-    public function _attach(TDBMService $tdbmService)
127
-    {
128
-        if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
129
-            throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
130
-        }
131
-        $this->tdbmService = $tdbmService;
132
-        $this->status = TDBMObjectStateEnum::STATE_NEW;
133
-        $this->tdbmService->_addToToSaveObjectList($this);
134
-    }
135
-
136
-    /**
137
-     * Sets the state of the TDBM Object
138
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
139
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
140
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
141
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
142
-     *
143
-     * @param string $state
144
-     */
145
-    public function _setStatus($state)
146
-    {
147
-        $this->status = $state;
148
-    }
149
-
150
-    /**
151
-     * This is an internal method. You should not call this method yourself. The TDBM library will do it for you.
152
-     * If the object is in state 'not loaded', this method performs a query in database to load the object.
153
-     *
154
-     * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified
155
-     * cannot be found).
156
-     */
157
-    public function _dbLoadIfNotLoaded()
158
-    {
159
-        if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) {
160
-            $connection = $this->tdbmService->getConnection();
161
-
162
-            /// buildFilterFromFilterBag($filter_bag)
163
-            list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys);
164
-
165
-            $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
166
-            $result = $connection->executeQuery($sql, $parameters);
167
-
168
-            if ($result->rowCount() === 0) {
169
-                throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\".");
170
-            }
171
-
172
-            $row = $result->fetch(\PDO::FETCH_ASSOC);
173
-
174
-            $this->dbRow = [];
175
-            $types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName);
176
-
177
-            foreach ($row as $key => $value) {
178
-                $this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform());
179
-            }
180
-
181
-            $result->closeCursor();
182
-
183
-            $this->status = TDBMObjectStateEnum::STATE_LOADED;
184
-        }
185
-    }
186
-
187
-    public function get($var)
188
-    {
189
-        $this->_dbLoadIfNotLoaded();
190
-
191
-        // Let's first check if the key exist.
192
-        if (!isset($this->dbRow[$var])) {
193
-            /*
30
+	/**
31
+	 * The service this object is bound to.
32
+	 *
33
+	 * @var TDBMService
34
+	 */
35
+	protected $tdbmService;
36
+
37
+	/**
38
+	 * The object containing this db row.
39
+	 *
40
+	 * @var AbstractTDBMObject
41
+	 */
42
+	private $object;
43
+
44
+	/**
45
+	 * The name of the table the object if issued from.
46
+	 *
47
+	 * @var string
48
+	 */
49
+	private $dbTableName;
50
+
51
+	/**
52
+	 * The array of columns returned from database.
53
+	 *
54
+	 * @var array
55
+	 */
56
+	private $dbRow = array();
57
+
58
+	/**
59
+	 * @var AbstractTDBMObject[]
60
+	 */
61
+	private $references = array();
62
+
63
+	/**
64
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
65
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
66
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
67
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
68
+	 *
69
+	 * @var string
70
+	 */
71
+	private $status;
72
+
73
+	/**
74
+	 * The values of the primary key.
75
+	 * This is set when the object is in "loaded" state.
76
+	 *
77
+	 * @var array An array of column => value
78
+	 */
79
+	private $primaryKeys;
80
+
81
+	/**
82
+	 * You should never call the constructor directly. Instead, you should use the
83
+	 * TDBMService class that will create TDBMObjects for you.
84
+	 *
85
+	 * Used with id!=false when we want to retrieve an existing object
86
+	 * and id==false if we want a new object
87
+	 *
88
+	 * @param AbstractTDBMObject $object      The object containing this db row.
89
+	 * @param string             $table_name
90
+	 * @param array              $primaryKeys
91
+	 * @param TDBMService        $tdbmService
92
+	 *
93
+	 * @throws TDBMException
94
+	 * @throws TDBMInvalidOperationException
95
+	 */
96
+	public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array())
97
+	{
98
+		$this->object = $object;
99
+		$this->dbTableName = $table_name;
100
+
101
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
102
+
103
+		if ($tdbmService === null) {
104
+			if (!empty($primaryKeys)) {
105
+				throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.');
106
+			}
107
+		} else {
108
+			$this->tdbmService = $tdbmService;
109
+
110
+			if (!empty($primaryKeys)) {
111
+				$this->_setPrimaryKeys($primaryKeys);
112
+				if (!empty($dbRow)) {
113
+					$this->dbRow = $dbRow;
114
+					$this->status = TDBMObjectStateEnum::STATE_LOADED;
115
+				} else {
116
+					$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
117
+				}
118
+				$tdbmService->_addToCache($this);
119
+			} else {
120
+				$this->status = TDBMObjectStateEnum::STATE_NEW;
121
+				$this->tdbmService->_addToToSaveObjectList($this);
122
+			}
123
+		}
124
+	}
125
+
126
+	public function _attach(TDBMService $tdbmService)
127
+	{
128
+		if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
129
+			throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
130
+		}
131
+		$this->tdbmService = $tdbmService;
132
+		$this->status = TDBMObjectStateEnum::STATE_NEW;
133
+		$this->tdbmService->_addToToSaveObjectList($this);
134
+	}
135
+
136
+	/**
137
+	 * Sets the state of the TDBM Object
138
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
139
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
140
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
141
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
142
+	 *
143
+	 * @param string $state
144
+	 */
145
+	public function _setStatus($state)
146
+	{
147
+		$this->status = $state;
148
+	}
149
+
150
+	/**
151
+	 * This is an internal method. You should not call this method yourself. The TDBM library will do it for you.
152
+	 * If the object is in state 'not loaded', this method performs a query in database to load the object.
153
+	 *
154
+	 * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified
155
+	 * cannot be found).
156
+	 */
157
+	public function _dbLoadIfNotLoaded()
158
+	{
159
+		if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) {
160
+			$connection = $this->tdbmService->getConnection();
161
+
162
+			/// buildFilterFromFilterBag($filter_bag)
163
+			list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys);
164
+
165
+			$sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
166
+			$result = $connection->executeQuery($sql, $parameters);
167
+
168
+			if ($result->rowCount() === 0) {
169
+				throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\".");
170
+			}
171
+
172
+			$row = $result->fetch(\PDO::FETCH_ASSOC);
173
+
174
+			$this->dbRow = [];
175
+			$types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName);
176
+
177
+			foreach ($row as $key => $value) {
178
+				$this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform());
179
+			}
180
+
181
+			$result->closeCursor();
182
+
183
+			$this->status = TDBMObjectStateEnum::STATE_LOADED;
184
+		}
185
+	}
186
+
187
+	public function get($var)
188
+	{
189
+		$this->_dbLoadIfNotLoaded();
190
+
191
+		// Let's first check if the key exist.
192
+		if (!isset($this->dbRow[$var])) {
193
+			/*
194 194
             // Unable to find column.... this is an error if the object has been retrieved from database.
195 195
             // If it's a new object, well, that may not be an error after all!
196 196
             // Let's check if the column does exist in the table
@@ -210,39 +210,39 @@  discard block
 block discarded – undo
210 210
             $str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'";
211 211
 
212 212
             throw new TDBMException($str);*/
213
-            return;
214
-        }
215
-
216
-        $value = $this->dbRow[$var];
217
-        if ($value instanceof \DateTime) {
218
-            if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
219
-                return \DateTimeImmutable::createFromMutable($value);
220
-            } else {
221
-                return new \DateTimeImmutable($value->format('c'));
222
-            }
223
-        }
224
-
225
-        return $this->dbRow[$var];
226
-    }
227
-
228
-    /**
229
-     * Returns true if a column is set, false otherwise.
230
-     *
231
-     * @param string $var
232
-     *
233
-     * @return bool
234
-     */
235
-    /*public function has($var) {
213
+			return;
214
+		}
215
+
216
+		$value = $this->dbRow[$var];
217
+		if ($value instanceof \DateTime) {
218
+			if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
219
+				return \DateTimeImmutable::createFromMutable($value);
220
+			} else {
221
+				return new \DateTimeImmutable($value->format('c'));
222
+			}
223
+		}
224
+
225
+		return $this->dbRow[$var];
226
+	}
227
+
228
+	/**
229
+	 * Returns true if a column is set, false otherwise.
230
+	 *
231
+	 * @param string $var
232
+	 *
233
+	 * @return bool
234
+	 */
235
+	/*public function has($var) {
236 236
         $this->_dbLoadIfNotLoaded();
237 237
 
238 238
         return isset($this->dbRow[$var]);
239 239
     }*/
240 240
 
241
-    public function set($var, $value)
242
-    {
243
-        $this->_dbLoadIfNotLoaded();
241
+	public function set($var, $value)
242
+	{
243
+		$this->_dbLoadIfNotLoaded();
244 244
 
245
-        /*
245
+		/*
246 246
         // Ok, let's start by checking the column type
247 247
         $type = $this->db_connection->getColumnType($this->dbTableName, $var);
248 248
 
@@ -252,188 +252,188 @@  discard block
 block discarded – undo
252 252
         }
253 253
         */
254 254
 
255
-        /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
255
+		/*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
256 256
             throw new TDBMException("Error! Changing primary key value is forbidden.");*/
257
-        $this->dbRow[$var] = $value;
258
-        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
259
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
260
-            $this->tdbmService->_addToToSaveObjectList($this);
261
-        }
262
-    }
263
-
264
-    /**
265
-     * @param string             $foreignKeyName
266
-     * @param AbstractTDBMObject $bean
267
-     */
268
-    public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
269
-    {
270
-        $this->references[$foreignKeyName] = $bean;
271
-
272
-        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
273
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
274
-            $this->tdbmService->_addToToSaveObjectList($this);
275
-        }
276
-    }
277
-
278
-    /**
279
-     * @param string $foreignKeyName A unique name for this reference
280
-     *
281
-     * @return AbstractTDBMObject|null
282
-     */
283
-    public function getRef($foreignKeyName)
284
-    {
285
-        if (array_key_exists($foreignKeyName, $this->references)) {
286
-            return $this->references[$foreignKeyName];
287
-        } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
288
-            // If the object is new and has no property, then it has to be empty.
289
-            return;
290
-        } else {
291
-            $this->_dbLoadIfNotLoaded();
292
-
293
-            // Let's match the name of the columns to the primary key values
294
-            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
295
-
296
-            $values = [];
297
-            foreach ($fk->getLocalColumns() as $column) {
298
-                $val = $this->dbRow[$column];
299
-                if ($val === null) {
300
-                    return;
301
-                }
302
-                $values[] = $val;
303
-            }
304
-
305
-            $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
306
-
307
-            return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
308
-        }
309
-    }
310
-
311
-    /**
312
-     * Returns the name of the table this object comes from.
313
-     *
314
-     * @return string
315
-     */
316
-    public function _getDbTableName()
317
-    {
318
-        return $this->dbTableName;
319
-    }
320
-
321
-    /**
322
-     * Method used internally by TDBM. You should not use it directly.
323
-     * This method returns the status of the TDBMObject.
324
-     * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
325
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
326
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
327
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
328
-     *
329
-     * @return string
330
-     */
331
-    public function _getStatus()
332
-    {
333
-        return $this->status;
334
-    }
335
-
336
-    /**
337
-     * Override the native php clone function for TDBMObjects.
338
-     */
339
-    public function __clone()
340
-    {
341
-        // Let's load the row (before we lose the ID!)
342
-        $this->_dbLoadIfNotLoaded();
343
-
344
-        //Let's set the status to detached
345
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
346
-
347
-        $this->primaryKeys = [];
348
-
349
-        //Now unset the PK from the row
350
-        if ($this->tdbmService) {
351
-            $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
352
-            foreach ($pk_array as $pk) {
353
-                $this->dbRow[$pk] = null;
354
-            }
355
-        }
356
-    }
357
-
358
-    /**
359
-     * Returns raw database row.
360
-     *
361
-     * @return array
362
-     */
363
-    public function _getDbRow()
364
-    {
365
-        // Let's merge $dbRow and $references
366
-        $dbRow = $this->dbRow;
367
-
368
-        foreach ($this->references as $foreignKeyName => $reference) {
369
-            // Let's match the name of the columns to the primary key values
370
-            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
371
-            $refDbRows = $reference->_getDbRows();
372
-            $firstRefDbRow = reset($refDbRows);
373
-            $pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
374
-            $localColumns = $fk->getLocalColumns();
375
-
376
-            for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
377
-                $dbRow[$localColumns[$i]] = $pkValues[$i];
378
-            }
379
-        }
380
-
381
-        return $dbRow;
382
-    }
383
-
384
-    /**
385
-     * Returns references array.
386
-     *
387
-     * @return AbstractTDBMObject[]
388
-     */
389
-    public function _getReferences()
390
-    {
391
-        return $this->references;
392
-    }
393
-
394
-    /**
395
-     * Returns the values of the primary key.
396
-     * This is set when the object is in "loaded" state.
397
-     *
398
-     * @return array
399
-     */
400
-    public function _getPrimaryKeys()
401
-    {
402
-        return $this->primaryKeys;
403
-    }
404
-
405
-    /**
406
-     * Sets the values of the primary key.
407
-     * This is set when the object is in "loaded" state.
408
-     *
409
-     * @param array $primaryKeys
410
-     */
411
-    public function _setPrimaryKeys(array $primaryKeys)
412
-    {
413
-        $this->primaryKeys = $primaryKeys;
414
-        foreach ($this->primaryKeys as $column => $value) {
415
-            $this->dbRow[$column] = $value;
416
-        }
417
-    }
418
-
419
-    /**
420
-     * Returns the TDBMObject this bean is associated to.
421
-     *
422
-     * @return AbstractTDBMObject
423
-     */
424
-    public function getTDBMObject()
425
-    {
426
-        return $this->object;
427
-    }
428
-
429
-    /**
430
-     * Sets the TDBMObject this bean is associated to.
431
-     * Only used when cloning.
432
-     *
433
-     * @param AbstractTDBMObject $object
434
-     */
435
-    public function setTDBMObject(AbstractTDBMObject $object)
436
-    {
437
-        $this->object = $object;
438
-    }
257
+		$this->dbRow[$var] = $value;
258
+		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
259
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
260
+			$this->tdbmService->_addToToSaveObjectList($this);
261
+		}
262
+	}
263
+
264
+	/**
265
+	 * @param string             $foreignKeyName
266
+	 * @param AbstractTDBMObject $bean
267
+	 */
268
+	public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
269
+	{
270
+		$this->references[$foreignKeyName] = $bean;
271
+
272
+		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
273
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
274
+			$this->tdbmService->_addToToSaveObjectList($this);
275
+		}
276
+	}
277
+
278
+	/**
279
+	 * @param string $foreignKeyName A unique name for this reference
280
+	 *
281
+	 * @return AbstractTDBMObject|null
282
+	 */
283
+	public function getRef($foreignKeyName)
284
+	{
285
+		if (array_key_exists($foreignKeyName, $this->references)) {
286
+			return $this->references[$foreignKeyName];
287
+		} elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
288
+			// If the object is new and has no property, then it has to be empty.
289
+			return;
290
+		} else {
291
+			$this->_dbLoadIfNotLoaded();
292
+
293
+			// Let's match the name of the columns to the primary key values
294
+			$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
295
+
296
+			$values = [];
297
+			foreach ($fk->getLocalColumns() as $column) {
298
+				$val = $this->dbRow[$column];
299
+				if ($val === null) {
300
+					return;
301
+				}
302
+				$values[] = $val;
303
+			}
304
+
305
+			$filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
306
+
307
+			return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
308
+		}
309
+	}
310
+
311
+	/**
312
+	 * Returns the name of the table this object comes from.
313
+	 *
314
+	 * @return string
315
+	 */
316
+	public function _getDbTableName()
317
+	{
318
+		return $this->dbTableName;
319
+	}
320
+
321
+	/**
322
+	 * Method used internally by TDBM. You should not use it directly.
323
+	 * This method returns the status of the TDBMObject.
324
+	 * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
325
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
326
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
327
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
328
+	 *
329
+	 * @return string
330
+	 */
331
+	public function _getStatus()
332
+	{
333
+		return $this->status;
334
+	}
335
+
336
+	/**
337
+	 * Override the native php clone function for TDBMObjects.
338
+	 */
339
+	public function __clone()
340
+	{
341
+		// Let's load the row (before we lose the ID!)
342
+		$this->_dbLoadIfNotLoaded();
343
+
344
+		//Let's set the status to detached
345
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
346
+
347
+		$this->primaryKeys = [];
348
+
349
+		//Now unset the PK from the row
350
+		if ($this->tdbmService) {
351
+			$pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
352
+			foreach ($pk_array as $pk) {
353
+				$this->dbRow[$pk] = null;
354
+			}
355
+		}
356
+	}
357
+
358
+	/**
359
+	 * Returns raw database row.
360
+	 *
361
+	 * @return array
362
+	 */
363
+	public function _getDbRow()
364
+	{
365
+		// Let's merge $dbRow and $references
366
+		$dbRow = $this->dbRow;
367
+
368
+		foreach ($this->references as $foreignKeyName => $reference) {
369
+			// Let's match the name of the columns to the primary key values
370
+			$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
371
+			$refDbRows = $reference->_getDbRows();
372
+			$firstRefDbRow = reset($refDbRows);
373
+			$pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
374
+			$localColumns = $fk->getLocalColumns();
375
+
376
+			for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
377
+				$dbRow[$localColumns[$i]] = $pkValues[$i];
378
+			}
379
+		}
380
+
381
+		return $dbRow;
382
+	}
383
+
384
+	/**
385
+	 * Returns references array.
386
+	 *
387
+	 * @return AbstractTDBMObject[]
388
+	 */
389
+	public function _getReferences()
390
+	{
391
+		return $this->references;
392
+	}
393
+
394
+	/**
395
+	 * Returns the values of the primary key.
396
+	 * This is set when the object is in "loaded" state.
397
+	 *
398
+	 * @return array
399
+	 */
400
+	public function _getPrimaryKeys()
401
+	{
402
+		return $this->primaryKeys;
403
+	}
404
+
405
+	/**
406
+	 * Sets the values of the primary key.
407
+	 * This is set when the object is in "loaded" state.
408
+	 *
409
+	 * @param array $primaryKeys
410
+	 */
411
+	public function _setPrimaryKeys(array $primaryKeys)
412
+	{
413
+		$this->primaryKeys = $primaryKeys;
414
+		foreach ($this->primaryKeys as $column => $value) {
415
+			$this->dbRow[$column] = $value;
416
+		}
417
+	}
418
+
419
+	/**
420
+	 * Returns the TDBMObject this bean is associated to.
421
+	 *
422
+	 * @return AbstractTDBMObject
423
+	 */
424
+	public function getTDBMObject()
425
+	{
426
+		return $this->object;
427
+	}
428
+
429
+	/**
430
+	 * Sets the TDBMObject this bean is associated to.
431
+	 * Only used when cloning.
432
+	 *
433
+	 * @param AbstractTDBMObject $object
434
+	 */
435
+	public function setTDBMObject(AbstractTDBMObject $object)
436
+	{
437
+		$this->object = $object;
438
+	}
439 439
 }
Please login to merge, or discard this patch.