Completed
Pull Request — 4.0 (#48)
by Marc
05:40
created
src/Mouf/Database/TDBM/ResultIterator.php 3 patches
Doc Comments   +8 added lines patch added patch discarded remove patch
@@ -66,6 +66,13 @@  discard block
 block discarded – undo
66 66
 
67 67
     private $mode;
68 68
 
69
+    /**
70
+     * @param string $magicSql
71
+     * @param string $magicSqlCount
72
+     * @param WeakrefObjectStorage $objectStorage
73
+     * @param string|null $className
74
+     * @param integer $mode
75
+     */
69 76
     public function __construct($magicSql, $magicSqlCount, array $parameters, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode)
70 77
     {
71 78
         $this->magicSql = $magicSql;
@@ -147,6 +154,7 @@  discard block
 block discarded – undo
147 154
 
148 155
     /**
149 156
      * @param int $offset
157
+     * @param integer $limit
150 158
      *
151 159
      * @return PageIterator
152 160
      */
Please login to merge, or discard this patch.
Indentation   +215 added lines, -215 removed lines patch added patch discarded remove patch
@@ -30,219 +30,219 @@
 block discarded – undo
30 30
  */
31 31
 class ResultIterator implements Result, \ArrayAccess, \JsonSerializable
32 32
 {
33
-    /**
34
-     * @var Statement
35
-     */
36
-    protected $statement;
37
-
38
-    protected $fetchStarted = false;
39
-    private $objectStorage;
40
-    private $className;
41
-
42
-    private $tdbmService;
43
-    private $magicSql;
44
-    private $magicSqlCount;
45
-    private $parameters;
46
-    private $columnDescriptors;
47
-    private $magicQuery;
48
-
49
-    /**
50
-     * @var InnerResultIterator
51
-     */
52
-    private $innerResultIterator;
53
-
54
-    /**
55
-     * The key of the current retrieved object.
56
-     *
57
-     * @var int
58
-     */
59
-    protected $key = -1;
60
-
61
-    protected $current = null;
62
-
63
-    private $databasePlatform;
64
-
65
-    private $totalCount;
66
-
67
-    private $mode;
68
-
69
-    public function __construct($magicSql, $magicSqlCount, array $parameters, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode)
70
-    {
71
-        $this->magicSql = $magicSql;
72
-        $this->magicSqlCount = $magicSqlCount;
73
-        $this->objectStorage = $objectStorage;
74
-        $this->className = $className;
75
-        $this->tdbmService = $tdbmService;
76
-        $this->parameters = $parameters;
77
-        $this->columnDescriptors = $columnDescriptors;
78
-        $this->magicQuery = $magicQuery;
79
-        $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
80
-        $this->mode = $mode;
81
-    }
82
-
83
-    protected function executeCountQuery()
84
-    {
85
-        $sql = $this->magicQuery->build($this->magicSqlCount, $this->parameters);
86
-        $this->totalCount = $this->tdbmService->getConnection()->fetchColumn($sql, $this->parameters);
87
-    }
88
-
89
-    /**
90
-     * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings).
91
-     *
92
-     * @return int
93
-     */
94
-    public function count()
95
-    {
96
-        if ($this->totalCount === null) {
97
-            $this->executeCountQuery();
98
-        }
99
-
100
-        return $this->totalCount;
101
-    }
102
-
103
-    /**
104
-     * Casts the result set to a PHP array.
105
-     *
106
-     * @return array
107
-     */
108
-    public function toArray()
109
-    {
110
-        return iterator_to_array($this->getIterator());
111
-    }
112
-
113
-    /**
114
-     * Returns a new iterator mapping any call using the $callable function.
115
-     *
116
-     * @param callable $callable
117
-     *
118
-     * @return MapIterator
119
-     */
120
-    public function map(callable $callable)
121
-    {
122
-        return new MapIterator($this->getIterator(), $callable);
123
-    }
124
-
125
-    /**
126
-     * Retrieve an external iterator.
127
-     *
128
-     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
129
-     *
130
-     * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or
131
-     *                             <b>Traversable</b>
132
-     *
133
-     * @since 5.0.0
134
-     */
135
-    public function getIterator()
136
-    {
137
-        if ($this->innerResultIterator === null) {
138
-            if ($this->mode === TDBMService::MODE_CURSOR) {
139
-                $this->innerResultIterator = new InnerResultIterator($this->magicSql, $this->parameters, null, null, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery);
140
-            } else {
141
-                $this->innerResultIterator = new InnerResultArray($this->magicSql, $this->parameters, null, null, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery);
142
-            }
143
-        }
144
-
145
-        return $this->innerResultIterator;
146
-    }
147
-
148
-    /**
149
-     * @param int $offset
150
-     *
151
-     * @return PageIterator
152
-     */
153
-    public function take($offset, $limit)
154
-    {
155
-        return new PageIterator($this, $this->magicSql, $this->parameters, $limit, $offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->mode);
156
-    }
157
-
158
-    /**
159
-     * Whether a offset exists.
160
-     *
161
-     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
162
-     *
163
-     * @param mixed $offset <p>
164
-     *                      An offset to check for.
165
-     *                      </p>
166
-     *
167
-     * @return bool true on success or false on failure.
168
-     *              </p>
169
-     *              <p>
170
-     *              The return value will be casted to boolean if non-boolean was returned.
171
-     *
172
-     * @since 5.0.0
173
-     */
174
-    public function offsetExists($offset)
175
-    {
176
-        return $this->getIterator()->offsetExists($offset);
177
-    }
178
-
179
-    /**
180
-     * Offset to retrieve.
181
-     *
182
-     * @link http://php.net/manual/en/arrayaccess.offsetget.php
183
-     *
184
-     * @param mixed $offset <p>
185
-     *                      The offset to retrieve.
186
-     *                      </p>
187
-     *
188
-     * @return mixed Can return all value types.
189
-     *
190
-     * @since 5.0.0
191
-     */
192
-    public function offsetGet($offset)
193
-    {
194
-        return $this->getIterator()->offsetGet($offset);
195
-    }
196
-
197
-    /**
198
-     * Offset to set.
199
-     *
200
-     * @link http://php.net/manual/en/arrayaccess.offsetset.php
201
-     *
202
-     * @param mixed $offset <p>
203
-     *                      The offset to assign the value to.
204
-     *                      </p>
205
-     * @param mixed $value  <p>
206
-     *                      The value to set.
207
-     *                      </p>
208
-     *
209
-     * @since 5.0.0
210
-     */
211
-    public function offsetSet($offset, $value)
212
-    {
213
-        return $this->getIterator()->offsetSet($offset, $value);
214
-    }
215
-
216
-    /**
217
-     * Offset to unset.
218
-     *
219
-     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
220
-     *
221
-     * @param mixed $offset <p>
222
-     *                      The offset to unset.
223
-     *                      </p>
224
-     *
225
-     * @since 5.0.0
226
-     */
227
-    public function offsetUnset($offset)
228
-    {
229
-        return $this->getIterator()->offsetUnset($offset);
230
-    }
231
-
232
-    /**
233
-     * Specify data which should be serialized to JSON.
234
-     *
235
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
236
-     *
237
-     * @return mixed data which can be serialized by <b>json_encode</b>,
238
-     *               which is a value of any type other than a resource.
239
-     *
240
-     * @since 5.4.0
241
-     */
242
-    public function jsonSerialize()
243
-    {
244
-        return array_map(function (AbstractTDBMObject $item) {
245
-            return $item->jsonSerialize();
246
-        }, $this->toArray());
247
-    }
33
+	/**
34
+	 * @var Statement
35
+	 */
36
+	protected $statement;
37
+
38
+	protected $fetchStarted = false;
39
+	private $objectStorage;
40
+	private $className;
41
+
42
+	private $tdbmService;
43
+	private $magicSql;
44
+	private $magicSqlCount;
45
+	private $parameters;
46
+	private $columnDescriptors;
47
+	private $magicQuery;
48
+
49
+	/**
50
+	 * @var InnerResultIterator
51
+	 */
52
+	private $innerResultIterator;
53
+
54
+	/**
55
+	 * The key of the current retrieved object.
56
+	 *
57
+	 * @var int
58
+	 */
59
+	protected $key = -1;
60
+
61
+	protected $current = null;
62
+
63
+	private $databasePlatform;
64
+
65
+	private $totalCount;
66
+
67
+	private $mode;
68
+
69
+	public function __construct($magicSql, $magicSqlCount, array $parameters, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode)
70
+	{
71
+		$this->magicSql = $magicSql;
72
+		$this->magicSqlCount = $magicSqlCount;
73
+		$this->objectStorage = $objectStorage;
74
+		$this->className = $className;
75
+		$this->tdbmService = $tdbmService;
76
+		$this->parameters = $parameters;
77
+		$this->columnDescriptors = $columnDescriptors;
78
+		$this->magicQuery = $magicQuery;
79
+		$this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
80
+		$this->mode = $mode;
81
+	}
82
+
83
+	protected function executeCountQuery()
84
+	{
85
+		$sql = $this->magicQuery->build($this->magicSqlCount, $this->parameters);
86
+		$this->totalCount = $this->tdbmService->getConnection()->fetchColumn($sql, $this->parameters);
87
+	}
88
+
89
+	/**
90
+	 * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings).
91
+	 *
92
+	 * @return int
93
+	 */
94
+	public function count()
95
+	{
96
+		if ($this->totalCount === null) {
97
+			$this->executeCountQuery();
98
+		}
99
+
100
+		return $this->totalCount;
101
+	}
102
+
103
+	/**
104
+	 * Casts the result set to a PHP array.
105
+	 *
106
+	 * @return array
107
+	 */
108
+	public function toArray()
109
+	{
110
+		return iterator_to_array($this->getIterator());
111
+	}
112
+
113
+	/**
114
+	 * Returns a new iterator mapping any call using the $callable function.
115
+	 *
116
+	 * @param callable $callable
117
+	 *
118
+	 * @return MapIterator
119
+	 */
120
+	public function map(callable $callable)
121
+	{
122
+		return new MapIterator($this->getIterator(), $callable);
123
+	}
124
+
125
+	/**
126
+	 * Retrieve an external iterator.
127
+	 *
128
+	 * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
129
+	 *
130
+	 * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or
131
+	 *                             <b>Traversable</b>
132
+	 *
133
+	 * @since 5.0.0
134
+	 */
135
+	public function getIterator()
136
+	{
137
+		if ($this->innerResultIterator === null) {
138
+			if ($this->mode === TDBMService::MODE_CURSOR) {
139
+				$this->innerResultIterator = new InnerResultIterator($this->magicSql, $this->parameters, null, null, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery);
140
+			} else {
141
+				$this->innerResultIterator = new InnerResultArray($this->magicSql, $this->parameters, null, null, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery);
142
+			}
143
+		}
144
+
145
+		return $this->innerResultIterator;
146
+	}
147
+
148
+	/**
149
+	 * @param int $offset
150
+	 *
151
+	 * @return PageIterator
152
+	 */
153
+	public function take($offset, $limit)
154
+	{
155
+		return new PageIterator($this, $this->magicSql, $this->parameters, $limit, $offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->mode);
156
+	}
157
+
158
+	/**
159
+	 * Whether a offset exists.
160
+	 *
161
+	 * @link http://php.net/manual/en/arrayaccess.offsetexists.php
162
+	 *
163
+	 * @param mixed $offset <p>
164
+	 *                      An offset to check for.
165
+	 *                      </p>
166
+	 *
167
+	 * @return bool true on success or false on failure.
168
+	 *              </p>
169
+	 *              <p>
170
+	 *              The return value will be casted to boolean if non-boolean was returned.
171
+	 *
172
+	 * @since 5.0.0
173
+	 */
174
+	public function offsetExists($offset)
175
+	{
176
+		return $this->getIterator()->offsetExists($offset);
177
+	}
178
+
179
+	/**
180
+	 * Offset to retrieve.
181
+	 *
182
+	 * @link http://php.net/manual/en/arrayaccess.offsetget.php
183
+	 *
184
+	 * @param mixed $offset <p>
185
+	 *                      The offset to retrieve.
186
+	 *                      </p>
187
+	 *
188
+	 * @return mixed Can return all value types.
189
+	 *
190
+	 * @since 5.0.0
191
+	 */
192
+	public function offsetGet($offset)
193
+	{
194
+		return $this->getIterator()->offsetGet($offset);
195
+	}
196
+
197
+	/**
198
+	 * Offset to set.
199
+	 *
200
+	 * @link http://php.net/manual/en/arrayaccess.offsetset.php
201
+	 *
202
+	 * @param mixed $offset <p>
203
+	 *                      The offset to assign the value to.
204
+	 *                      </p>
205
+	 * @param mixed $value  <p>
206
+	 *                      The value to set.
207
+	 *                      </p>
208
+	 *
209
+	 * @since 5.0.0
210
+	 */
211
+	public function offsetSet($offset, $value)
212
+	{
213
+		return $this->getIterator()->offsetSet($offset, $value);
214
+	}
215
+
216
+	/**
217
+	 * Offset to unset.
218
+	 *
219
+	 * @link http://php.net/manual/en/arrayaccess.offsetunset.php
220
+	 *
221
+	 * @param mixed $offset <p>
222
+	 *                      The offset to unset.
223
+	 *                      </p>
224
+	 *
225
+	 * @since 5.0.0
226
+	 */
227
+	public function offsetUnset($offset)
228
+	{
229
+		return $this->getIterator()->offsetUnset($offset);
230
+	}
231
+
232
+	/**
233
+	 * Specify data which should be serialized to JSON.
234
+	 *
235
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
236
+	 *
237
+	 * @return mixed data which can be serialized by <b>json_encode</b>,
238
+	 *               which is a value of any type other than a resource.
239
+	 *
240
+	 * @since 5.4.0
241
+	 */
242
+	public function jsonSerialize()
243
+	{
244
+		return array_map(function (AbstractTDBMObject $item) {
245
+			return $item->jsonSerialize();
246
+		}, $this->toArray());
247
+	}
248 248
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -241,7 +241,7 @@
 block discarded – undo
241 241
      */
242 242
     public function jsonSerialize()
243 243
     {
244
-        return array_map(function (AbstractTDBMObject $item) {
244
+        return array_map(function(AbstractTDBMObject $item) {
245 245
             return $item->jsonSerialize();
246 246
         }, $this->toArray());
247 247
     }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/TDBMService.php 4 patches
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -777,7 +777,7 @@  discard block
 block discarded – undo
777 777
      * This is used internally by TDBM to add an object to the list of objects that have been
778 778
      * created/updated but not saved yet.
779 779
      *
780
-     * @param AbstractTDBMObject $myObject
780
+     * @param DbRow $myObject
781 781
      */
782 782
     public function _addToToSaveObjectList(DbRow $myObject)
783 783
     {
@@ -1441,7 +1441,7 @@  discard block
 block discarded – undo
1441 1441
     }
1442 1442
 
1443 1443
     /**
1444
-     * @param $table
1444
+     * @param string $table
1445 1445
      * @param array  $primaryKeys
1446 1446
      * @param array  $additionalTablesFetch
1447 1447
      * @param bool   $lazy                  Whether to perform lazy loading on this object or not.
@@ -1616,7 +1616,7 @@  discard block
 block discarded – undo
1616 1616
      * @param $pivotTableName
1617 1617
      * @param AbstractTDBMObject $bean
1618 1618
      *
1619
-     * @return AbstractTDBMObject[]
1619
+     * @return ResultIterator
1620 1620
      */
1621 1621
     public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean)
1622 1622
     {
Please login to merge, or discard this patch.
Unused Use Statements   -2 removed lines patch added patch discarded remove patch
@@ -23,9 +23,7 @@
 block discarded – undo
23 23
 use Doctrine\Common\Cache\Cache;
24 24
 use Doctrine\Common\Cache\VoidCache;
25 25
 use Doctrine\DBAL\Connection;
26
-use Doctrine\DBAL\Schema\Column;
27 26
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
28
-use Doctrine\DBAL\Schema\Schema;
29 27
 use Doctrine\DBAL\Schema\Table;
30 28
 use Mouf\Database\MagicQuery;
31 29
 use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -1201,7 +1201,7 @@  discard block
 block discarded – undo
1201 1201
         sort($tables);
1202 1202
 
1203 1203
         return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1204
-            function () use ($tables) {
1204
+            function() use ($tables) {
1205 1205
                 return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1206 1206
             });
1207 1207
     }
@@ -1249,7 +1249,7 @@  discard block
 block discarded – undo
1249 1249
      */
1250 1250
     public function _getRelatedTablesByInheritance($table)
1251 1251
     {
1252
-        return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1252
+        return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function() use ($table) {
1253 1253
             return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1254 1254
         });
1255 1255
     }
@@ -1509,7 +1509,7 @@  discard block
 block discarded – undo
1509 1509
         $objects = $this->findObjects($mainTable, $filterString, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1510 1510
         $page = $objects->take(0, 2);
1511 1511
         $count = $page->count();
1512
-        if ($count > 1) {
1512
+        if ($count>1) {
1513 1513
             throw new DuplicateRowException("Error while querying an object for table '$mainTable': More than 1 row have been returned, but we should have received at most one.");
1514 1514
         } elseif ($count === 0) {
1515 1515
             return;
@@ -1626,7 +1626,7 @@  discard block
 block discarded – undo
1626 1626
         $remoteTable = $remoteFk->getForeignTableName();
1627 1627
 
1628 1628
         $primaryKeys = $this->getPrimaryKeyValues($bean);
1629
-        $columnNames = array_map(function ($name) use ($pivotTableName) { return $pivotTableName.'.'.$name; }, $localFk->getLocalColumns());
1629
+        $columnNames = array_map(function($name) use ($pivotTableName) { return $pivotTableName.'.'.$name; }, $localFk->getLocalColumns());
1630 1630
 
1631 1631
         $filter = array_combine($columnNames, $primaryKeys);
1632 1632
 
@@ -1647,7 +1647,7 @@  discard block
 block discarded – undo
1647 1647
         $table1 = $fks[0]->getForeignTableName();
1648 1648
         $table2 = $fks[1]->getForeignTableName();
1649 1649
 
1650
-        $beanTables = array_map(function (DbRow $dbRow) { return $dbRow->_getDbTableName(); }, $bean->_getDbRows());
1650
+        $beanTables = array_map(function(DbRow $dbRow) { return $dbRow->_getDbTableName(); }, $bean->_getDbRows());
1651 1651
 
1652 1652
         if (in_array($table1, $beanTables)) {
1653 1653
             return [$fks[0], $fks[1]];
Please login to merge, or discard this patch.
Indentation   +1321 added lines, -1321 removed lines patch added patch discarded remove patch
@@ -41,213 +41,213 @@  discard block
 block discarded – undo
41 41
  */
42 42
 class TDBMService
43 43
 {
44
-    const MODE_CURSOR = 1;
45
-    const MODE_ARRAY = 2;
46
-
47
-    /**
48
-     * The database connection.
49
-     *
50
-     * @var Connection
51
-     */
52
-    private $connection;
53
-
54
-    /**
55
-     * @var SchemaAnalyzer
56
-     */
57
-    private $schemaAnalyzer;
58
-
59
-    /**
60
-     * @var MagicQuery
61
-     */
62
-    private $magicQuery;
63
-
64
-    /**
65
-     * @var TDBMSchemaAnalyzer
66
-     */
67
-    private $tdbmSchemaAnalyzer;
68
-
69
-    /**
70
-     * @var string
71
-     */
72
-    private $cachePrefix;
73
-
74
-    /**
75
-     * Cache of table of primary keys.
76
-     * Primary keys are stored by tables, as an array of column.
77
-     * For instance $primary_key['my_table'][0] will return the first column of the primary key of table 'my_table'.
78
-     *
79
-     * @var string[]
80
-     */
81
-    private $primaryKeysColumns;
82
-
83
-    /**
84
-     * Service storing objects in memory.
85
-     * Access is done by table name and then by primary key.
86
-     * If the primary key is split on several columns, access is done by an array of columns, serialized.
87
-     *
88
-     * @var StandardObjectStorage|WeakrefObjectStorage
89
-     */
90
-    private $objectStorage;
91
-
92
-    /**
93
-     * The fetch mode of the result sets returned by `getObjects`.
94
-     * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY or TDBMObjectArray::MODE_COMPATIBLE_ARRAY.
95
-     *
96
-     * In 'MODE_ARRAY' mode (default), the result is an array. Use this mode by default (unless the list returned is very big).
97
-     * In 'MODE_CURSOR' mode, the result is a Generator which is an iterable collection that can be scanned only once (only one "foreach") on it,
98
-     * and it cannot be accessed via key. Use this mode for large datasets processed by batch.
99
-     * In 'MODE_COMPATIBLE_ARRAY' mode, the result is an old TDBMObjectArray (used up to TDBM 3.2).
100
-     * You can access the array by key, or using foreach, several times.
101
-     *
102
-     * @var int
103
-     */
104
-    private $mode = self::MODE_ARRAY;
105
-
106
-    /**
107
-     * Table of new objects not yet inserted in database or objects modified that must be saved.
108
-     *
109
-     * @var \SplObjectStorage of DbRow objects
110
-     */
111
-    private $toSaveObjects;
112
-
113
-    /**
114
-     * The content of the cache variable.
115
-     *
116
-     * @var array<string, mixed>
117
-     */
118
-    private $cache;
119
-
120
-    /**
121
-     * Map associating a table name to a fully qualified Bean class name.
122
-     *
123
-     * @var array
124
-     */
125
-    private $tableToBeanMap = [];
126
-
127
-    /**
128
-     * @var \ReflectionClass[]
129
-     */
130
-    private $reflectionClassCache = array();
131
-
132
-    /**
133
-     * @param Connection     $connection     The DBAL DB connection to use
134
-     * @param Cache|null     $cache          A cache service to be used
135
-     * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
136
-     *                                       Will be automatically created if not passed.
137
-     */
138
-    public function __construct(Connection $connection, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null)
139
-    {
140
-        if (extension_loaded('weakref')) {
141
-            $this->objectStorage = new WeakrefObjectStorage();
142
-        } else {
143
-            $this->objectStorage = new StandardObjectStorage();
144
-        }
145
-        $this->connection = $connection;
146
-        if ($cache !== null) {
147
-            $this->cache = $cache;
148
-        } else {
149
-            $this->cache = new VoidCache();
150
-        }
151
-        if ($schemaAnalyzer) {
152
-            $this->schemaAnalyzer = $schemaAnalyzer;
153
-        } else {
154
-            $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
155
-        }
156
-
157
-        $this->magicQuery = new MagicQuery($this->connection, $this->cache, $this->schemaAnalyzer);
158
-
159
-        $this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, $this->cache, $this->schemaAnalyzer);
160
-        $this->cachePrefix = $this->tdbmSchemaAnalyzer->getCachePrefix();
161
-
162
-        $this->toSaveObjects = new \SplObjectStorage();
163
-    }
164
-
165
-    /**
166
-     * Returns the object used to connect to the database.
167
-     *
168
-     * @return Connection
169
-     */
170
-    public function getConnection()
171
-    {
172
-        return $this->connection;
173
-    }
174
-
175
-    /**
176
-     * Creates a unique cache key for the current connection.
177
-     *
178
-     * @return string
179
-     */
180
-    private function getConnectionUniqueId()
181
-    {
182
-        return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
183
-    }
184
-
185
-    /**
186
-     * Sets the default fetch mode of the result sets returned by `findObjects`.
187
-     * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY.
188
-     *
189
-     * In 'MODE_ARRAY' mode (default), the result is a ResultIterator object that behaves like an array. Use this mode by default (unless the list returned is very big).
190
-     * In 'MODE_CURSOR' mode, the result is a ResultIterator object. If you scan it many times (by calling several time a foreach loop), the query will be run
191
-     * several times. In cursor mode, you cannot access the result set by key. Use this mode for large datasets processed by batch.
192
-     *
193
-     * @param int $mode
194
-     *
195
-     * @return $this
196
-     *
197
-     * @throws TDBMException
198
-     */
199
-    public function setFetchMode($mode)
200
-    {
201
-        if ($mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
202
-            throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
203
-        }
204
-        $this->mode = $mode;
205
-
206
-        return $this;
207
-    }
208
-
209
-    /**
210
-     * Returns a TDBMObject associated from table "$table_name".
211
-     * If the $filters parameter is an int/string, the object returned will be the object whose primary key = $filters.
212
-     * $filters can also be a set of TDBM_Filters (see the findObjects method for more details).
213
-     *
214
-     * For instance, if there is a table 'users', with a primary key on column 'user_id' and a column 'user_name', then
215
-     * 			$user = $tdbmService->getObject('users',1);
216
-     * 			echo $user->name;
217
-     * will return the name of the user whose user_id is one.
218
-     *
219
-     * If a table has a primary key over several columns, you should pass to $id an array containing the the value of the various columns.
220
-     * For instance:
221
-     * 			$group = $tdbmService->getObject('groups',array(1,2));
222
-     *
223
-     * Note that TDBMObject performs caching for you. If you get twice the same object, the reference of the object you will get
224
-     * will be the same.
225
-     *
226
-     * For instance:
227
-     * 			$user1 = $tdbmService->getObject('users',1);
228
-     * 			$user2 = $tdbmService->getObject('users',1);
229
-     * 			$user1->name = 'John Doe';
230
-     * 			echo $user2->name;
231
-     * will return 'John Doe'.
232
-     *
233
-     * You can use filters instead of passing the primary key. For instance:
234
-     * 			$user = $tdbmService->getObject('users',new EqualFilter('users', 'login', 'jdoe'));
235
-     * This will return the user whose login is 'jdoe'.
236
-     * Please note that if 2 users have the jdoe login in database, the method will throw a TDBM_DuplicateRowException.
237
-     *
238
-     * Also, you can specify the return class for the object (provided the return class extends TDBMObject).
239
-     * For instance:
240
-     *  	$user = $tdbmService->getObject('users',1,'User');
241
-     * will return an object from the "User" class. The "User" class must extend the "TDBMObject" class.
242
-     * Please be sure not to override any method or any property unless you perfectly know what you are doing!
243
-     *
244
-     * @param string $table_name   The name of the table we retrieve an object from.
245
-     * @param mixed  $filters      If the filter is a string/integer, it will be considered as the id of the object (the value of the primary key). Otherwise, it can be a filter bag (see the filterbag parameter of the findObjects method for more details about filter bags)
246
-     * @param string $className    Optional: The name of the class to instanciate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
247
-     * @param bool   $lazy_loading If set to true, and if the primary key is passed in parameter of getObject, the object will not be queried in database. It will be queried when you first try to access a column. If at that time the object cannot be found in database, an exception will be thrown.
248
-     *
249
-     * @return TDBMObject
250
-     */
44
+	const MODE_CURSOR = 1;
45
+	const MODE_ARRAY = 2;
46
+
47
+	/**
48
+	 * The database connection.
49
+	 *
50
+	 * @var Connection
51
+	 */
52
+	private $connection;
53
+
54
+	/**
55
+	 * @var SchemaAnalyzer
56
+	 */
57
+	private $schemaAnalyzer;
58
+
59
+	/**
60
+	 * @var MagicQuery
61
+	 */
62
+	private $magicQuery;
63
+
64
+	/**
65
+	 * @var TDBMSchemaAnalyzer
66
+	 */
67
+	private $tdbmSchemaAnalyzer;
68
+
69
+	/**
70
+	 * @var string
71
+	 */
72
+	private $cachePrefix;
73
+
74
+	/**
75
+	 * Cache of table of primary keys.
76
+	 * Primary keys are stored by tables, as an array of column.
77
+	 * For instance $primary_key['my_table'][0] will return the first column of the primary key of table 'my_table'.
78
+	 *
79
+	 * @var string[]
80
+	 */
81
+	private $primaryKeysColumns;
82
+
83
+	/**
84
+	 * Service storing objects in memory.
85
+	 * Access is done by table name and then by primary key.
86
+	 * If the primary key is split on several columns, access is done by an array of columns, serialized.
87
+	 *
88
+	 * @var StandardObjectStorage|WeakrefObjectStorage
89
+	 */
90
+	private $objectStorage;
91
+
92
+	/**
93
+	 * The fetch mode of the result sets returned by `getObjects`.
94
+	 * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY or TDBMObjectArray::MODE_COMPATIBLE_ARRAY.
95
+	 *
96
+	 * In 'MODE_ARRAY' mode (default), the result is an array. Use this mode by default (unless the list returned is very big).
97
+	 * In 'MODE_CURSOR' mode, the result is a Generator which is an iterable collection that can be scanned only once (only one "foreach") on it,
98
+	 * and it cannot be accessed via key. Use this mode for large datasets processed by batch.
99
+	 * In 'MODE_COMPATIBLE_ARRAY' mode, the result is an old TDBMObjectArray (used up to TDBM 3.2).
100
+	 * You can access the array by key, or using foreach, several times.
101
+	 *
102
+	 * @var int
103
+	 */
104
+	private $mode = self::MODE_ARRAY;
105
+
106
+	/**
107
+	 * Table of new objects not yet inserted in database or objects modified that must be saved.
108
+	 *
109
+	 * @var \SplObjectStorage of DbRow objects
110
+	 */
111
+	private $toSaveObjects;
112
+
113
+	/**
114
+	 * The content of the cache variable.
115
+	 *
116
+	 * @var array<string, mixed>
117
+	 */
118
+	private $cache;
119
+
120
+	/**
121
+	 * Map associating a table name to a fully qualified Bean class name.
122
+	 *
123
+	 * @var array
124
+	 */
125
+	private $tableToBeanMap = [];
126
+
127
+	/**
128
+	 * @var \ReflectionClass[]
129
+	 */
130
+	private $reflectionClassCache = array();
131
+
132
+	/**
133
+	 * @param Connection     $connection     The DBAL DB connection to use
134
+	 * @param Cache|null     $cache          A cache service to be used
135
+	 * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
136
+	 *                                       Will be automatically created if not passed.
137
+	 */
138
+	public function __construct(Connection $connection, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null)
139
+	{
140
+		if (extension_loaded('weakref')) {
141
+			$this->objectStorage = new WeakrefObjectStorage();
142
+		} else {
143
+			$this->objectStorage = new StandardObjectStorage();
144
+		}
145
+		$this->connection = $connection;
146
+		if ($cache !== null) {
147
+			$this->cache = $cache;
148
+		} else {
149
+			$this->cache = new VoidCache();
150
+		}
151
+		if ($schemaAnalyzer) {
152
+			$this->schemaAnalyzer = $schemaAnalyzer;
153
+		} else {
154
+			$this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
155
+		}
156
+
157
+		$this->magicQuery = new MagicQuery($this->connection, $this->cache, $this->schemaAnalyzer);
158
+
159
+		$this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, $this->cache, $this->schemaAnalyzer);
160
+		$this->cachePrefix = $this->tdbmSchemaAnalyzer->getCachePrefix();
161
+
162
+		$this->toSaveObjects = new \SplObjectStorage();
163
+	}
164
+
165
+	/**
166
+	 * Returns the object used to connect to the database.
167
+	 *
168
+	 * @return Connection
169
+	 */
170
+	public function getConnection()
171
+	{
172
+		return $this->connection;
173
+	}
174
+
175
+	/**
176
+	 * Creates a unique cache key for the current connection.
177
+	 *
178
+	 * @return string
179
+	 */
180
+	private function getConnectionUniqueId()
181
+	{
182
+		return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
183
+	}
184
+
185
+	/**
186
+	 * Sets the default fetch mode of the result sets returned by `findObjects`.
187
+	 * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY.
188
+	 *
189
+	 * In 'MODE_ARRAY' mode (default), the result is a ResultIterator object that behaves like an array. Use this mode by default (unless the list returned is very big).
190
+	 * In 'MODE_CURSOR' mode, the result is a ResultIterator object. If you scan it many times (by calling several time a foreach loop), the query will be run
191
+	 * several times. In cursor mode, you cannot access the result set by key. Use this mode for large datasets processed by batch.
192
+	 *
193
+	 * @param int $mode
194
+	 *
195
+	 * @return $this
196
+	 *
197
+	 * @throws TDBMException
198
+	 */
199
+	public function setFetchMode($mode)
200
+	{
201
+		if ($mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
202
+			throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
203
+		}
204
+		$this->mode = $mode;
205
+
206
+		return $this;
207
+	}
208
+
209
+	/**
210
+	 * Returns a TDBMObject associated from table "$table_name".
211
+	 * If the $filters parameter is an int/string, the object returned will be the object whose primary key = $filters.
212
+	 * $filters can also be a set of TDBM_Filters (see the findObjects method for more details).
213
+	 *
214
+	 * For instance, if there is a table 'users', with a primary key on column 'user_id' and a column 'user_name', then
215
+	 * 			$user = $tdbmService->getObject('users',1);
216
+	 * 			echo $user->name;
217
+	 * will return the name of the user whose user_id is one.
218
+	 *
219
+	 * If a table has a primary key over several columns, you should pass to $id an array containing the the value of the various columns.
220
+	 * For instance:
221
+	 * 			$group = $tdbmService->getObject('groups',array(1,2));
222
+	 *
223
+	 * Note that TDBMObject performs caching for you. If you get twice the same object, the reference of the object you will get
224
+	 * will be the same.
225
+	 *
226
+	 * For instance:
227
+	 * 			$user1 = $tdbmService->getObject('users',1);
228
+	 * 			$user2 = $tdbmService->getObject('users',1);
229
+	 * 			$user1->name = 'John Doe';
230
+	 * 			echo $user2->name;
231
+	 * will return 'John Doe'.
232
+	 *
233
+	 * You can use filters instead of passing the primary key. For instance:
234
+	 * 			$user = $tdbmService->getObject('users',new EqualFilter('users', 'login', 'jdoe'));
235
+	 * This will return the user whose login is 'jdoe'.
236
+	 * Please note that if 2 users have the jdoe login in database, the method will throw a TDBM_DuplicateRowException.
237
+	 *
238
+	 * Also, you can specify the return class for the object (provided the return class extends TDBMObject).
239
+	 * For instance:
240
+	 *  	$user = $tdbmService->getObject('users',1,'User');
241
+	 * will return an object from the "User" class. The "User" class must extend the "TDBMObject" class.
242
+	 * Please be sure not to override any method or any property unless you perfectly know what you are doing!
243
+	 *
244
+	 * @param string $table_name   The name of the table we retrieve an object from.
245
+	 * @param mixed  $filters      If the filter is a string/integer, it will be considered as the id of the object (the value of the primary key). Otherwise, it can be a filter bag (see the filterbag parameter of the findObjects method for more details about filter bags)
246
+	 * @param string $className    Optional: The name of the class to instanciate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
247
+	 * @param bool   $lazy_loading If set to true, and if the primary key is passed in parameter of getObject, the object will not be queried in database. It will be queried when you first try to access a column. If at that time the object cannot be found in database, an exception will be thrown.
248
+	 *
249
+	 * @return TDBMObject
250
+	 */
251 251
 /*	public function getObject($table_name, $filters, $className = null, $lazy_loading = false) {
252 252
 
253 253
         if (is_array($filters) || $filters instanceof FilterInterface) {
@@ -333,233 +333,233 @@  discard block
 block discarded – undo
333 333
         return $obj;
334 334
     }*/
335 335
 
336
-    /**
337
-     * Removes the given object from database.
338
-     * This cannot be called on an object that is not attached to this TDBMService
339
-     * (will throw a TDBMInvalidOperationException).
340
-     *
341
-     * @param AbstractTDBMObject $object the object to delete.
342
-     *
343
-     * @throws TDBMException
344
-     * @throws TDBMInvalidOperationException
345
-     */
346
-    public function delete(AbstractTDBMObject $object)
347
-    {
348
-        switch ($object->_getStatus()) {
349
-            case TDBMObjectStateEnum::STATE_DELETED:
350
-                // Nothing to do, object already deleted.
351
-                return;
352
-            case TDBMObjectStateEnum::STATE_DETACHED:
353
-                throw new TDBMInvalidOperationException('Cannot delete a detached object');
354
-            case TDBMObjectStateEnum::STATE_NEW:
355
-                $this->deleteManyToManyRelationships($object);
356
-                foreach ($object->_getDbRows() as $dbRow) {
357
-                    $this->removeFromToSaveObjectList($dbRow);
358
-                }
359
-                break;
360
-            case TDBMObjectStateEnum::STATE_DIRTY:
361
-                foreach ($object->_getDbRows() as $dbRow) {
362
-                    $this->removeFromToSaveObjectList($dbRow);
363
-                }
364
-                // And continue deleting...
365
-            case TDBMObjectStateEnum::STATE_NOT_LOADED:
366
-            case TDBMObjectStateEnum::STATE_LOADED:
367
-                $this->deleteManyToManyRelationships($object);
368
-                // Let's delete db rows, in reverse order.
369
-                foreach (array_reverse($object->_getDbRows()) as $dbRow) {
370
-                    $tableName = $dbRow->_getDbTableName();
371
-                    $primaryKeys = $dbRow->_getPrimaryKeys();
372
-                    $this->connection->delete($tableName, $primaryKeys);
373
-                    $this->objectStorage->remove($dbRow->_getDbTableName(), $this->getObjectHash($primaryKeys));
374
-                }
375
-                break;
376
-            // @codeCoverageIgnoreStart
377
-            default:
378
-                throw new TDBMInvalidOperationException('Unexpected status for bean');
379
-            // @codeCoverageIgnoreEnd
380
-        }
381
-
382
-        $object->_setStatus(TDBMObjectStateEnum::STATE_DELETED);
383
-    }
384
-
385
-    /**
386
-     * Removes all many to many relationships for this object.
387
-     *
388
-     * @param AbstractTDBMObject $object
389
-     */
390
-    private function deleteManyToManyRelationships(AbstractTDBMObject $object)
391
-    {
392
-        foreach ($object->_getDbRows() as $tableName => $dbRow) {
393
-            $pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
394
-            foreach ($pivotTables as $pivotTable) {
395
-                $remoteBeans = $object->_getRelationships($pivotTable);
396
-                foreach ($remoteBeans as $remoteBean) {
397
-                    $object->_removeRelationship($pivotTable, $remoteBean);
398
-                }
399
-            }
400
-        }
401
-        $this->persistManyToManyRelationships($object);
402
-    }
403
-
404
-    /**
405
-     * This function removes the given object from the database. It will also remove all objects relied to the one given
406
-     * by parameter before all.
407
-     *
408
-     * Notice: if the object has a multiple primary key, the function will not work.
409
-     *
410
-     * @param AbstractTDBMObject $objToDelete
411
-     */
412
-    public function deleteCascade(AbstractTDBMObject $objToDelete)
413
-    {
414
-        $this->deleteAllConstraintWithThisObject($objToDelete);
415
-        $this->delete($objToDelete);
416
-    }
417
-
418
-    /**
419
-     * This function is used only in TDBMService (private function)
420
-     * It will call deleteCascade function foreach object relied with a foreign key to the object given by parameter.
421
-     *
422
-     * @param AbstractTDBMObject $obj
423
-     */
424
-    private function deleteAllConstraintWithThisObject(AbstractTDBMObject $obj)
425
-    {
426
-        $dbRows = $obj->_getDbRows();
427
-        foreach ($dbRows as $dbRow) {
428
-            $tableName = $dbRow->_getDbTableName();
429
-            $pks = array_values($dbRow->_getPrimaryKeys());
430
-            if (!empty($pks)) {
431
-                $incomingFks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($tableName);
432
-
433
-                foreach ($incomingFks as $incomingFk) {
434
-                    $filter = array_combine($incomingFk->getLocalColumns(), $pks);
435
-
436
-                    $results = $this->findObjects($incomingFk->getLocalTableName(), $filter);
437
-
438
-                    foreach ($results as $bean) {
439
-                        $this->deleteCascade($bean);
440
-                    }
441
-                }
442
-            }
443
-        }
444
-    }
445
-
446
-    /**
447
-     * This function performs a save() of all the objects that have been modified.
448
-     */
449
-    public function completeSave()
450
-    {
451
-        foreach ($this->toSaveObjects as $dbRow) {
452
-            $this->save($dbRow->getTDBMObject());
453
-        }
454
-    }
455
-
456
-    /**
457
-     * Takes in input a filter_bag (which can be about anything from a string to an array of TDBMObjects... see above from documentation),
458
-     * and gives back a proper Filter object.
459
-     *
460
-     * @param mixed $filter_bag
461
-     * @param int   $counter
462
-     *
463
-     * @return array First item: filter string, second item: parameters.
464
-     *
465
-     * @throws TDBMException
466
-     */
467
-    public function buildFilterFromFilterBag($filter_bag, $counter = 1)
468
-    {
469
-        if ($filter_bag === null) {
470
-            return ['', []];
471
-        } elseif (is_string($filter_bag)) {
472
-            return [$filter_bag, []];
473
-        } elseif (is_array($filter_bag)) {
474
-            $sqlParts = [];
475
-            $parameters = [];
476
-            foreach ($filter_bag as $column => $value) {
477
-                if (is_int($column)) {
478
-                    list($subSqlPart, $subParameters) = $this->buildFilterFromFilterBag($value, $counter);
479
-                    $sqlParts[] = $subSqlPart;
480
-                    $parameters += $subParameters;
481
-                } else {
482
-                    $paramName = 'tdbmparam'.$counter;
483
-                    if (is_array($value)) {
484
-                        $sqlParts[] = $this->connection->quoteIdentifier($column).' IN :'.$paramName;
485
-                    } else {
486
-                        $sqlParts[] = $this->connection->quoteIdentifier($column).' = :'.$paramName;
487
-                    }
488
-                    $parameters[$paramName] = $value;
489
-                    ++$counter;
490
-                }
491
-            }
492
-
493
-            return [implode(' AND ', $sqlParts), $parameters];
494
-        } elseif ($filter_bag instanceof AbstractTDBMObject) {
495
-            $sqlParts = [];
496
-            $parameters = [];
497
-            $dbRows = $filter_bag->_getDbRows();
498
-            $dbRow = reset($dbRows);
499
-            $primaryKeys = $dbRow->_getPrimaryKeys();
500
-
501
-            foreach ($primaryKeys as $column => $value) {
502
-                $paramName = 'tdbmparam'.$counter;
503
-                $sqlParts[] = $this->connection->quoteIdentifier($dbRow->_getDbTableName()).'.'.$this->connection->quoteIdentifier($column).' = :'.$paramName;
504
-                $parameters[$paramName] = $value;
505
-                ++$counter;
506
-            }
507
-
508
-            return [implode(' AND ', $sqlParts), $parameters];
509
-        } elseif ($filter_bag instanceof \Iterator) {
510
-            return $this->buildFilterFromFilterBag(iterator_to_array($filter_bag), $counter);
511
-        } else {
512
-            throw new TDBMException('Error in filter. An object has been passed that is neither a SQL string, nor an array, nor a bean, nor null.');
513
-        }
514
-    }
515
-
516
-    /**
517
-     * Takes in input an order_bag (which can be about anything from a string to an array of OrderByColumn objects... see above from documentation),
518
-     * and gives back an array of OrderByColumn / OrderBySQLString objects.
519
-     *
520
-     * @param unknown_type $orderby_bag
521
-     *
522
-     * @return array
523
-     */
524
-    public function buildOrderArrayFromOrderBag($orderby_bag)
525
-    {
526
-        // Fourth, let's apply the same steps to the orderby_bag
527
-        // 4-1 orderby_bag should be an array, if it is a singleton, let's put it in an array.
528
-
529
-        if (!is_array($orderby_bag)) {
530
-            $orderby_bag = array($orderby_bag);
531
-        }
532
-
533
-        // 4-2, let's take all the objects out of the orderby bag, and let's make objects from them
534
-        $orderby_bag2 = array();
535
-        foreach ($orderby_bag as $thing) {
536
-            if (is_a($thing, 'Mouf\\Database\\TDBM\\Filters\\OrderBySQLString')) {
537
-                $orderby_bag2[] = $thing;
538
-            } elseif (is_a($thing, 'Mouf\\Database\\TDBM\\Filters\\OrderByColumn')) {
539
-                $orderby_bag2[] = $thing;
540
-            } elseif (is_string($thing)) {
541
-                $orderby_bag2[] = new OrderBySQLString($thing);
542
-            } elseif ($thing !== null) {
543
-                throw new TDBMException('Error in orderby bag in getObjectsByFilter. An object has been passed that is neither a OrderBySQLString, nor a OrderByColumn, nor a string, nor null.');
544
-            }
545
-        }
546
-
547
-        return $orderby_bag2;
548
-    }
549
-
550
-    /**
551
-     * @param string $table
552
-     *
553
-     * @return string[]
554
-     */
555
-    public function getPrimaryKeyColumns($table)
556
-    {
557
-        if (!isset($this->primaryKeysColumns[$table])) {
558
-            $this->primaryKeysColumns[$table] = $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getPrimaryKeyColumns();
559
-
560
-            // TODO TDBM4: See if we need to improve error reporting if table name does not exist.
561
-
562
-            /*$arr = array();
336
+	/**
337
+	 * Removes the given object from database.
338
+	 * This cannot be called on an object that is not attached to this TDBMService
339
+	 * (will throw a TDBMInvalidOperationException).
340
+	 *
341
+	 * @param AbstractTDBMObject $object the object to delete.
342
+	 *
343
+	 * @throws TDBMException
344
+	 * @throws TDBMInvalidOperationException
345
+	 */
346
+	public function delete(AbstractTDBMObject $object)
347
+	{
348
+		switch ($object->_getStatus()) {
349
+			case TDBMObjectStateEnum::STATE_DELETED:
350
+				// Nothing to do, object already deleted.
351
+				return;
352
+			case TDBMObjectStateEnum::STATE_DETACHED:
353
+				throw new TDBMInvalidOperationException('Cannot delete a detached object');
354
+			case TDBMObjectStateEnum::STATE_NEW:
355
+				$this->deleteManyToManyRelationships($object);
356
+				foreach ($object->_getDbRows() as $dbRow) {
357
+					$this->removeFromToSaveObjectList($dbRow);
358
+				}
359
+				break;
360
+			case TDBMObjectStateEnum::STATE_DIRTY:
361
+				foreach ($object->_getDbRows() as $dbRow) {
362
+					$this->removeFromToSaveObjectList($dbRow);
363
+				}
364
+				// And continue deleting...
365
+			case TDBMObjectStateEnum::STATE_NOT_LOADED:
366
+			case TDBMObjectStateEnum::STATE_LOADED:
367
+				$this->deleteManyToManyRelationships($object);
368
+				// Let's delete db rows, in reverse order.
369
+				foreach (array_reverse($object->_getDbRows()) as $dbRow) {
370
+					$tableName = $dbRow->_getDbTableName();
371
+					$primaryKeys = $dbRow->_getPrimaryKeys();
372
+					$this->connection->delete($tableName, $primaryKeys);
373
+					$this->objectStorage->remove($dbRow->_getDbTableName(), $this->getObjectHash($primaryKeys));
374
+				}
375
+				break;
376
+			// @codeCoverageIgnoreStart
377
+			default:
378
+				throw new TDBMInvalidOperationException('Unexpected status for bean');
379
+			// @codeCoverageIgnoreEnd
380
+		}
381
+
382
+		$object->_setStatus(TDBMObjectStateEnum::STATE_DELETED);
383
+	}
384
+
385
+	/**
386
+	 * Removes all many to many relationships for this object.
387
+	 *
388
+	 * @param AbstractTDBMObject $object
389
+	 */
390
+	private function deleteManyToManyRelationships(AbstractTDBMObject $object)
391
+	{
392
+		foreach ($object->_getDbRows() as $tableName => $dbRow) {
393
+			$pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
394
+			foreach ($pivotTables as $pivotTable) {
395
+				$remoteBeans = $object->_getRelationships($pivotTable);
396
+				foreach ($remoteBeans as $remoteBean) {
397
+					$object->_removeRelationship($pivotTable, $remoteBean);
398
+				}
399
+			}
400
+		}
401
+		$this->persistManyToManyRelationships($object);
402
+	}
403
+
404
+	/**
405
+	 * This function removes the given object from the database. It will also remove all objects relied to the one given
406
+	 * by parameter before all.
407
+	 *
408
+	 * Notice: if the object has a multiple primary key, the function will not work.
409
+	 *
410
+	 * @param AbstractTDBMObject $objToDelete
411
+	 */
412
+	public function deleteCascade(AbstractTDBMObject $objToDelete)
413
+	{
414
+		$this->deleteAllConstraintWithThisObject($objToDelete);
415
+		$this->delete($objToDelete);
416
+	}
417
+
418
+	/**
419
+	 * This function is used only in TDBMService (private function)
420
+	 * It will call deleteCascade function foreach object relied with a foreign key to the object given by parameter.
421
+	 *
422
+	 * @param AbstractTDBMObject $obj
423
+	 */
424
+	private function deleteAllConstraintWithThisObject(AbstractTDBMObject $obj)
425
+	{
426
+		$dbRows = $obj->_getDbRows();
427
+		foreach ($dbRows as $dbRow) {
428
+			$tableName = $dbRow->_getDbTableName();
429
+			$pks = array_values($dbRow->_getPrimaryKeys());
430
+			if (!empty($pks)) {
431
+				$incomingFks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($tableName);
432
+
433
+				foreach ($incomingFks as $incomingFk) {
434
+					$filter = array_combine($incomingFk->getLocalColumns(), $pks);
435
+
436
+					$results = $this->findObjects($incomingFk->getLocalTableName(), $filter);
437
+
438
+					foreach ($results as $bean) {
439
+						$this->deleteCascade($bean);
440
+					}
441
+				}
442
+			}
443
+		}
444
+	}
445
+
446
+	/**
447
+	 * This function performs a save() of all the objects that have been modified.
448
+	 */
449
+	public function completeSave()
450
+	{
451
+		foreach ($this->toSaveObjects as $dbRow) {
452
+			$this->save($dbRow->getTDBMObject());
453
+		}
454
+	}
455
+
456
+	/**
457
+	 * Takes in input a filter_bag (which can be about anything from a string to an array of TDBMObjects... see above from documentation),
458
+	 * and gives back a proper Filter object.
459
+	 *
460
+	 * @param mixed $filter_bag
461
+	 * @param int   $counter
462
+	 *
463
+	 * @return array First item: filter string, second item: parameters.
464
+	 *
465
+	 * @throws TDBMException
466
+	 */
467
+	public function buildFilterFromFilterBag($filter_bag, $counter = 1)
468
+	{
469
+		if ($filter_bag === null) {
470
+			return ['', []];
471
+		} elseif (is_string($filter_bag)) {
472
+			return [$filter_bag, []];
473
+		} elseif (is_array($filter_bag)) {
474
+			$sqlParts = [];
475
+			$parameters = [];
476
+			foreach ($filter_bag as $column => $value) {
477
+				if (is_int($column)) {
478
+					list($subSqlPart, $subParameters) = $this->buildFilterFromFilterBag($value, $counter);
479
+					$sqlParts[] = $subSqlPart;
480
+					$parameters += $subParameters;
481
+				} else {
482
+					$paramName = 'tdbmparam'.$counter;
483
+					if (is_array($value)) {
484
+						$sqlParts[] = $this->connection->quoteIdentifier($column).' IN :'.$paramName;
485
+					} else {
486
+						$sqlParts[] = $this->connection->quoteIdentifier($column).' = :'.$paramName;
487
+					}
488
+					$parameters[$paramName] = $value;
489
+					++$counter;
490
+				}
491
+			}
492
+
493
+			return [implode(' AND ', $sqlParts), $parameters];
494
+		} elseif ($filter_bag instanceof AbstractTDBMObject) {
495
+			$sqlParts = [];
496
+			$parameters = [];
497
+			$dbRows = $filter_bag->_getDbRows();
498
+			$dbRow = reset($dbRows);
499
+			$primaryKeys = $dbRow->_getPrimaryKeys();
500
+
501
+			foreach ($primaryKeys as $column => $value) {
502
+				$paramName = 'tdbmparam'.$counter;
503
+				$sqlParts[] = $this->connection->quoteIdentifier($dbRow->_getDbTableName()).'.'.$this->connection->quoteIdentifier($column).' = :'.$paramName;
504
+				$parameters[$paramName] = $value;
505
+				++$counter;
506
+			}
507
+
508
+			return [implode(' AND ', $sqlParts), $parameters];
509
+		} elseif ($filter_bag instanceof \Iterator) {
510
+			return $this->buildFilterFromFilterBag(iterator_to_array($filter_bag), $counter);
511
+		} else {
512
+			throw new TDBMException('Error in filter. An object has been passed that is neither a SQL string, nor an array, nor a bean, nor null.');
513
+		}
514
+	}
515
+
516
+	/**
517
+	 * Takes in input an order_bag (which can be about anything from a string to an array of OrderByColumn objects... see above from documentation),
518
+	 * and gives back an array of OrderByColumn / OrderBySQLString objects.
519
+	 *
520
+	 * @param unknown_type $orderby_bag
521
+	 *
522
+	 * @return array
523
+	 */
524
+	public function buildOrderArrayFromOrderBag($orderby_bag)
525
+	{
526
+		// Fourth, let's apply the same steps to the orderby_bag
527
+		// 4-1 orderby_bag should be an array, if it is a singleton, let's put it in an array.
528
+
529
+		if (!is_array($orderby_bag)) {
530
+			$orderby_bag = array($orderby_bag);
531
+		}
532
+
533
+		// 4-2, let's take all the objects out of the orderby bag, and let's make objects from them
534
+		$orderby_bag2 = array();
535
+		foreach ($orderby_bag as $thing) {
536
+			if (is_a($thing, 'Mouf\\Database\\TDBM\\Filters\\OrderBySQLString')) {
537
+				$orderby_bag2[] = $thing;
538
+			} elseif (is_a($thing, 'Mouf\\Database\\TDBM\\Filters\\OrderByColumn')) {
539
+				$orderby_bag2[] = $thing;
540
+			} elseif (is_string($thing)) {
541
+				$orderby_bag2[] = new OrderBySQLString($thing);
542
+			} elseif ($thing !== null) {
543
+				throw new TDBMException('Error in orderby bag in getObjectsByFilter. An object has been passed that is neither a OrderBySQLString, nor a OrderByColumn, nor a string, nor null.');
544
+			}
545
+		}
546
+
547
+		return $orderby_bag2;
548
+	}
549
+
550
+	/**
551
+	 * @param string $table
552
+	 *
553
+	 * @return string[]
554
+	 */
555
+	public function getPrimaryKeyColumns($table)
556
+	{
557
+		if (!isset($this->primaryKeysColumns[$table])) {
558
+			$this->primaryKeysColumns[$table] = $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getPrimaryKeyColumns();
559
+
560
+			// TODO TDBM4: See if we need to improve error reporting if table name does not exist.
561
+
562
+			/*$arr = array();
563 563
             foreach ($this->connection->getPrimaryKey($table) as $col) {
564 564
                 $arr[] = $col->name;
565 565
             }
@@ -580,129 +580,129 @@  discard block
 block discarded – undo
580 580
                     throw new TDBMException($str);
581 581
                 }
582 582
             }*/
583
-        }
584
-
585
-        return $this->primaryKeysColumns[$table];
586
-    }
587
-
588
-    /**
589
-     * This is an internal function, you should not use it in your application.
590
-     * This is used internally by TDBM to add an object to the object cache.
591
-     *
592
-     * @param DbRow $dbRow
593
-     */
594
-    public function _addToCache(DbRow $dbRow)
595
-    {
596
-        $primaryKey = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
597
-        $hash = $this->getObjectHash($primaryKey);
598
-        $this->objectStorage->set($dbRow->_getDbTableName(), $hash, $dbRow);
599
-    }
600
-
601
-    /**
602
-     * This is an internal function, you should not use it in your application.
603
-     * This is used internally by TDBM to remove the object from the list of objects that have been
604
-     * created/updated but not saved yet.
605
-     *
606
-     * @param DbRow $myObject
607
-     */
608
-    private function removeFromToSaveObjectList(DbRow $myObject)
609
-    {
610
-        unset($this->toSaveObjects[$myObject]);
611
-    }
612
-
613
-    /**
614
-     * This is an internal function, you should not use it in your application.
615
-     * This is used internally by TDBM to add an object to the list of objects that have been
616
-     * created/updated but not saved yet.
617
-     *
618
-     * @param AbstractTDBMObject $myObject
619
-     */
620
-    public function _addToToSaveObjectList(DbRow $myObject)
621
-    {
622
-        $this->toSaveObjects[$myObject] = true;
623
-    }
624
-
625
-    /**
626
-     * Generates all the daos and beans.
627
-     *
628
-     * @param string $daoFactoryClassName The classe name of the DAO factory
629
-     * @param string $daonamespace        The namespace for the DAOs, without trailing \
630
-     * @param string $beannamespace       The Namespace for the beans, without trailing \
631
-     * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
632
-     * @param string $storePath           If it's set, the path to generate daos and beans. By default it's locate with rootPath.
633
-     *
634
-     * @return \string[] the list of tables
635
-     */
636
-    public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $storePath = null)
637
-    {
638
-        $tdbmDaoGenerator = new TDBMDaoGenerator($this->schemaAnalyzer, $this->tdbmSchemaAnalyzer->getSchema(), $this->tdbmSchemaAnalyzer);
639
-        $tdbmDaoGenerator->setRootPath($tdbmDaoGenerator->getRootPath().$storePath);
640
-        return $tdbmDaoGenerator->generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $storePath);
641
-    }
642
-
643
-    /**
644
-     * @param array<string, string> $tableToBeanMap
645
-     */
646
-    public function setTableToBeanMap(array $tableToBeanMap)
647
-    {
648
-        $this->tableToBeanMap = $tableToBeanMap;
649
-    }
650
-
651
-    /**
652
-     * Saves $object by INSERTing or UPDAT(E)ing it in the database.
653
-     *
654
-     * @param AbstractTDBMObject $object
655
-     *
656
-     * @throws TDBMException
657
-     */
658
-    public function save(AbstractTDBMObject $object)
659
-    {
660
-        $status = $object->_getStatus();
661
-
662
-        // Let's attach this object if it is in detached state.
663
-        if ($status === TDBMObjectStateEnum::STATE_DETACHED) {
664
-            $object->_attach($this);
665
-            $status = $object->_getStatus();
666
-        }
667
-
668
-        if ($status === TDBMObjectStateEnum::STATE_NEW) {
669
-            $dbRows = $object->_getDbRows();
670
-
671
-            $unindexedPrimaryKeys = array();
672
-
673
-            foreach ($dbRows as $dbRow) {
674
-                $tableName = $dbRow->_getDbTableName();
675
-
676
-                $schema = $this->tdbmSchemaAnalyzer->getSchema();
677
-                $tableDescriptor = $schema->getTable($tableName);
678
-
679
-                $primaryKeyColumns = $this->getPrimaryKeyColumns($tableName);
680
-
681
-                if (empty($unindexedPrimaryKeys)) {
682
-                    $primaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
683
-                } else {
684
-                    // First insert, the children must have the same primary key as the parent.
685
-                    $primaryKeys = $this->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $unindexedPrimaryKeys);
686
-                    $dbRow->_setPrimaryKeys($primaryKeys);
687
-                }
688
-
689
-                $references = $dbRow->_getReferences();
690
-
691
-                // Let's save all references in NEW or DETACHED state (we need their primary key)
692
-                foreach ($references as $fkName => $reference) {
693
-                    $refStatus = $reference->_getStatus();
694
-                    if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
695
-                        $this->save($reference);
696
-                    }
697
-                }
698
-
699
-                $dbRowData = $dbRow->_getDbRow();
700
-
701
-                // Let's see if the columns for primary key have been set before inserting.
702
-                // We assume that if one of the value of the PK has been set, the PK is set.
703
-                $isPkSet = !empty($primaryKeys);
704
-
705
-                /*if (!$isPkSet) {
583
+		}
584
+
585
+		return $this->primaryKeysColumns[$table];
586
+	}
587
+
588
+	/**
589
+	 * This is an internal function, you should not use it in your application.
590
+	 * This is used internally by TDBM to add an object to the object cache.
591
+	 *
592
+	 * @param DbRow $dbRow
593
+	 */
594
+	public function _addToCache(DbRow $dbRow)
595
+	{
596
+		$primaryKey = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
597
+		$hash = $this->getObjectHash($primaryKey);
598
+		$this->objectStorage->set($dbRow->_getDbTableName(), $hash, $dbRow);
599
+	}
600
+
601
+	/**
602
+	 * This is an internal function, you should not use it in your application.
603
+	 * This is used internally by TDBM to remove the object from the list of objects that have been
604
+	 * created/updated but not saved yet.
605
+	 *
606
+	 * @param DbRow $myObject
607
+	 */
608
+	private function removeFromToSaveObjectList(DbRow $myObject)
609
+	{
610
+		unset($this->toSaveObjects[$myObject]);
611
+	}
612
+
613
+	/**
614
+	 * This is an internal function, you should not use it in your application.
615
+	 * This is used internally by TDBM to add an object to the list of objects that have been
616
+	 * created/updated but not saved yet.
617
+	 *
618
+	 * @param AbstractTDBMObject $myObject
619
+	 */
620
+	public function _addToToSaveObjectList(DbRow $myObject)
621
+	{
622
+		$this->toSaveObjects[$myObject] = true;
623
+	}
624
+
625
+	/**
626
+	 * Generates all the daos and beans.
627
+	 *
628
+	 * @param string $daoFactoryClassName The classe name of the DAO factory
629
+	 * @param string $daonamespace        The namespace for the DAOs, without trailing \
630
+	 * @param string $beannamespace       The Namespace for the beans, without trailing \
631
+	 * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
632
+	 * @param string $storePath           If it's set, the path to generate daos and beans. By default it's locate with rootPath.
633
+	 *
634
+	 * @return \string[] the list of tables
635
+	 */
636
+	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $storePath = null)
637
+	{
638
+		$tdbmDaoGenerator = new TDBMDaoGenerator($this->schemaAnalyzer, $this->tdbmSchemaAnalyzer->getSchema(), $this->tdbmSchemaAnalyzer);
639
+		$tdbmDaoGenerator->setRootPath($tdbmDaoGenerator->getRootPath().$storePath);
640
+		return $tdbmDaoGenerator->generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $storePath);
641
+	}
642
+
643
+	/**
644
+	 * @param array<string, string> $tableToBeanMap
645
+	 */
646
+	public function setTableToBeanMap(array $tableToBeanMap)
647
+	{
648
+		$this->tableToBeanMap = $tableToBeanMap;
649
+	}
650
+
651
+	/**
652
+	 * Saves $object by INSERTing or UPDAT(E)ing it in the database.
653
+	 *
654
+	 * @param AbstractTDBMObject $object
655
+	 *
656
+	 * @throws TDBMException
657
+	 */
658
+	public function save(AbstractTDBMObject $object)
659
+	{
660
+		$status = $object->_getStatus();
661
+
662
+		// Let's attach this object if it is in detached state.
663
+		if ($status === TDBMObjectStateEnum::STATE_DETACHED) {
664
+			$object->_attach($this);
665
+			$status = $object->_getStatus();
666
+		}
667
+
668
+		if ($status === TDBMObjectStateEnum::STATE_NEW) {
669
+			$dbRows = $object->_getDbRows();
670
+
671
+			$unindexedPrimaryKeys = array();
672
+
673
+			foreach ($dbRows as $dbRow) {
674
+				$tableName = $dbRow->_getDbTableName();
675
+
676
+				$schema = $this->tdbmSchemaAnalyzer->getSchema();
677
+				$tableDescriptor = $schema->getTable($tableName);
678
+
679
+				$primaryKeyColumns = $this->getPrimaryKeyColumns($tableName);
680
+
681
+				if (empty($unindexedPrimaryKeys)) {
682
+					$primaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
683
+				} else {
684
+					// First insert, the children must have the same primary key as the parent.
685
+					$primaryKeys = $this->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $unindexedPrimaryKeys);
686
+					$dbRow->_setPrimaryKeys($primaryKeys);
687
+				}
688
+
689
+				$references = $dbRow->_getReferences();
690
+
691
+				// Let's save all references in NEW or DETACHED state (we need their primary key)
692
+				foreach ($references as $fkName => $reference) {
693
+					$refStatus = $reference->_getStatus();
694
+					if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
695
+						$this->save($reference);
696
+					}
697
+				}
698
+
699
+				$dbRowData = $dbRow->_getDbRow();
700
+
701
+				// Let's see if the columns for primary key have been set before inserting.
702
+				// We assume that if one of the value of the PK has been set, the PK is set.
703
+				$isPkSet = !empty($primaryKeys);
704
+
705
+				/*if (!$isPkSet) {
706 706
                     // if there is no autoincrement and no pk set, let's go in error.
707 707
                     $isAutoIncrement = true;
708 708
 
@@ -720,25 +720,25 @@  discard block
 block discarded – undo
720 720
 
721 721
                 }*/
722 722
 
723
-                $types = [];
723
+				$types = [];
724 724
 
725
-                foreach ($dbRowData as $columnName => $value) {
726
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
727
-                    $types[] = $columnDescriptor->getType();
728
-                }
725
+				foreach ($dbRowData as $columnName => $value) {
726
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
727
+					$types[] = $columnDescriptor->getType();
728
+				}
729 729
 
730
-                $this->connection->insert($tableName, $dbRowData, $types);
730
+				$this->connection->insert($tableName, $dbRowData, $types);
731 731
 
732
-                if (!$isPkSet && count($primaryKeyColumns) == 1) {
733
-                    $id = $this->connection->lastInsertId();
734
-                    $primaryKeys[$primaryKeyColumns[0]] = $id;
735
-                }
732
+				if (!$isPkSet && count($primaryKeyColumns) == 1) {
733
+					$id = $this->connection->lastInsertId();
734
+					$primaryKeys[$primaryKeyColumns[0]] = $id;
735
+				}
736 736
 
737
-                // TODO: change this to some private magic accessor in future
738
-                $dbRow->_setPrimaryKeys($primaryKeys);
739
-                $unindexedPrimaryKeys = array_values($primaryKeys);
737
+				// TODO: change this to some private magic accessor in future
738
+				$dbRow->_setPrimaryKeys($primaryKeys);
739
+				$unindexedPrimaryKeys = array_values($primaryKeys);
740 740
 
741
-                /*
741
+				/*
742 742
                  * When attached, on "save", we check if the column updated is part of a primary key
743 743
                  * If this is part of a primary key, we call the _update_id method that updates the id in the list of known objects.
744 744
                  * This method should first verify that the id is not already used (and is not auto-incremented)
@@ -748,7 +748,7 @@  discard block
 block discarded – undo
748 748
                  *
749 749
                  */
750 750
 
751
-                /*try {
751
+				/*try {
752 752
                     $this->db_connection->exec($sql);
753 753
                 } catch (TDBMException $e) {
754 754
                     $this->db_onerror = true;
@@ -767,390 +767,390 @@  discard block
 block discarded – undo
767 767
                     }
768 768
                 }*/
769 769
 
770
-                // Let's remove this object from the $new_objects static table.
771
-                $this->removeFromToSaveObjectList($dbRow);
772
-
773
-                // TODO: change this behaviour to something more sensible performance-wise
774
-                // Maybe a setting to trigger this globally?
775
-                //$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
776
-                //$this->db_modified_state = false;
777
-                //$dbRow = array();
778
-
779
-                // Let's add this object to the list of objects in cache.
780
-                $this->_addToCache($dbRow);
781
-            }
782
-
783
-            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
784
-        } elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
785
-            $dbRows = $object->_getDbRows();
786
-
787
-            foreach ($dbRows as $dbRow) {
788
-                $references = $dbRow->_getReferences();
789
-
790
-                // Let's save all references in NEW state (we need their primary key)
791
-                foreach ($references as $fkName => $reference) {
792
-                    if ($reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
793
-                        $this->save($reference);
794
-                    }
795
-                }
796
-
797
-                // Let's first get the primary keys
798
-                $tableName = $dbRow->_getDbTableName();
799
-                $dbRowData = $dbRow->_getDbRow();
800
-
801
-                $schema = $this->tdbmSchemaAnalyzer->getSchema();
802
-                $tableDescriptor = $schema->getTable($tableName);
803
-
804
-                $primaryKeys = $dbRow->_getPrimaryKeys();
805
-
806
-                $types = [];
807
-
808
-                foreach ($dbRowData as $columnName => $value) {
809
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
810
-                    $types[] = $columnDescriptor->getType();
811
-                }
812
-                foreach ($primaryKeys as $columnName => $value) {
813
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
814
-                    $types[] = $columnDescriptor->getType();
815
-                }
816
-
817
-                $this->connection->update($tableName, $dbRowData, $primaryKeys, $types);
818
-
819
-                // Let's check if the primary key has been updated...
820
-                $needsUpdatePk = false;
821
-                foreach ($primaryKeys as $column => $value) {
822
-                    if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
823
-                        $needsUpdatePk = true;
824
-                        break;
825
-                    }
826
-                }
827
-                if ($needsUpdatePk) {
828
-                    $this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
829
-                    $newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
830
-                    $dbRow->_setPrimaryKeys($newPrimaryKeys);
831
-                    $this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
832
-                }
833
-
834
-                // Let's remove this object from the list of objects to save.
835
-                $this->removeFromToSaveObjectList($dbRow);
836
-            }
837
-
838
-            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
839
-        } elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
840
-            throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
841
-        }
842
-
843
-        // Finally, let's save all the many to many relationships to this bean.
844
-        $this->persistManyToManyRelationships($object);
845
-    }
846
-
847
-    private function persistManyToManyRelationships(AbstractTDBMObject $object)
848
-    {
849
-        foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
850
-            $tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
851
-            list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
852
-
853
-            foreach ($storage as $remoteBean) {
854
-                /* @var $remoteBean AbstractTDBMObject */
855
-                $statusArr = $storage[$remoteBean];
856
-                $status = $statusArr['status'];
857
-                $reverse = $statusArr['reverse'];
858
-                if ($reverse) {
859
-                    continue;
860
-                }
861
-
862
-                if ($status === 'new') {
863
-                    $remoteBeanStatus = $remoteBean->_getStatus();
864
-                    if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
865
-                        // Let's save remote bean if needed.
866
-                        $this->save($remoteBean);
867
-                    }
868
-
869
-                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
870
-
871
-                    $types = [];
872
-
873
-                    foreach ($filters as $columnName => $value) {
874
-                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
875
-                        $types[] = $columnDescriptor->getType();
876
-                    }
877
-
878
-                    $this->connection->insert($pivotTableName, $filters, $types);
879
-
880
-                    // Finally, let's mark relationships as saved.
881
-                    $statusArr['status'] = 'loaded';
882
-                    $storage[$remoteBean] = $statusArr;
883
-                    $remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
884
-                    $remoteStatusArr = $remoteStorage[$object];
885
-                    $remoteStatusArr['status'] = 'loaded';
886
-                    $remoteStorage[$object] = $remoteStatusArr;
887
-                } elseif ($status === 'delete') {
888
-                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
889
-
890
-                    $types = [];
891
-
892
-                    foreach ($filters as $columnName => $value) {
893
-                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
894
-                        $types[] = $columnDescriptor->getType();
895
-                    }
896
-
897
-                    $this->connection->delete($pivotTableName, $filters, $types);
898
-
899
-                    // Finally, let's remove relationships completely from bean.
900
-                    $storage->detach($remoteBean);
901
-                    $remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
902
-                }
903
-            }
904
-        }
905
-    }
906
-
907
-    private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
908
-    {
909
-        $localBeanPk = $this->getPrimaryKeyValues($localBean);
910
-        $remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
911
-        $localColumns = $localFk->getLocalColumns();
912
-        $remoteColumns = $remoteFk->getLocalColumns();
913
-
914
-        $localFilters = array_combine($localColumns, $localBeanPk);
915
-        $remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
916
-
917
-        return array_merge($localFilters, $remoteFilters);
918
-    }
919
-
920
-    /**
921
-     * Returns the "values" of the primary key.
922
-     * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
923
-     *
924
-     * @param AbstractTDBMObject $bean
925
-     *
926
-     * @return array numerically indexed array of values.
927
-     */
928
-    private function getPrimaryKeyValues(AbstractTDBMObject $bean)
929
-    {
930
-        $dbRows = $bean->_getDbRows();
931
-        $dbRow = reset($dbRows);
932
-
933
-        return array_values($dbRow->_getPrimaryKeys());
934
-    }
935
-
936
-    /**
937
-     * Returns a unique hash used to store the object based on its primary key.
938
-     * If the array contains only one value, then the value is returned.
939
-     * Otherwise, a hash representing the array is returned.
940
-     *
941
-     * @param array $primaryKeys An array of columns => values forming the primary key
942
-     *
943
-     * @return string
944
-     */
945
-    public function getObjectHash(array $primaryKeys)
946
-    {
947
-        if (count($primaryKeys) === 1) {
948
-            return reset($primaryKeys);
949
-        } else {
950
-            ksort($primaryKeys);
951
-
952
-            return md5(json_encode($primaryKeys));
953
-        }
954
-    }
955
-
956
-    /**
957
-     * Returns an array of primary keys from the object.
958
-     * The primary keys are extracted from the object columns and not from the primary keys stored in the
959
-     * $primaryKeys variable of the object.
960
-     *
961
-     * @param DbRow $dbRow
962
-     *
963
-     * @return array Returns an array of column => value
964
-     */
965
-    public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
966
-    {
967
-        $table = $dbRow->_getDbTableName();
968
-        $dbRowData = $dbRow->_getDbRow();
969
-
970
-        return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
971
-    }
972
-
973
-    /**
974
-     * Returns an array of primary keys for the given row.
975
-     * The primary keys are extracted from the object columns.
976
-     *
977
-     * @param $table
978
-     * @param array $columns
979
-     *
980
-     * @return array
981
-     */
982
-    public function _getPrimaryKeysFromObjectData($table, array $columns)
983
-    {
984
-        $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
985
-        $values = array();
986
-        foreach ($primaryKeyColumns as $column) {
987
-            if (isset($columns[$column])) {
988
-                $values[$column] = $columns[$column];
989
-            }
990
-        }
991
-
992
-        return $values;
993
-    }
994
-
995
-    /**
996
-     * Attaches $object to this TDBMService.
997
-     * The $object must be in DETACHED state and will pass in NEW state.
998
-     *
999
-     * @param AbstractTDBMObject $object
1000
-     *
1001
-     * @throws TDBMInvalidOperationException
1002
-     */
1003
-    public function attach(AbstractTDBMObject $object)
1004
-    {
1005
-        $object->_attach($this);
1006
-    }
1007
-
1008
-    /**
1009
-     * Returns an associative array (column => value) for the primary keys from the table name and an
1010
-     * indexed array of primary key values.
1011
-     *
1012
-     * @param string $tableName
1013
-     * @param array  $indexedPrimaryKeys
1014
-     */
1015
-    public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
1016
-    {
1017
-        $primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
1018
-
1019
-        if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
1020
-            throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
770
+				// Let's remove this object from the $new_objects static table.
771
+				$this->removeFromToSaveObjectList($dbRow);
772
+
773
+				// TODO: change this behaviour to something more sensible performance-wise
774
+				// Maybe a setting to trigger this globally?
775
+				//$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
776
+				//$this->db_modified_state = false;
777
+				//$dbRow = array();
778
+
779
+				// Let's add this object to the list of objects in cache.
780
+				$this->_addToCache($dbRow);
781
+			}
782
+
783
+			$object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
784
+		} elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
785
+			$dbRows = $object->_getDbRows();
786
+
787
+			foreach ($dbRows as $dbRow) {
788
+				$references = $dbRow->_getReferences();
789
+
790
+				// Let's save all references in NEW state (we need their primary key)
791
+				foreach ($references as $fkName => $reference) {
792
+					if ($reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
793
+						$this->save($reference);
794
+					}
795
+				}
796
+
797
+				// Let's first get the primary keys
798
+				$tableName = $dbRow->_getDbTableName();
799
+				$dbRowData = $dbRow->_getDbRow();
800
+
801
+				$schema = $this->tdbmSchemaAnalyzer->getSchema();
802
+				$tableDescriptor = $schema->getTable($tableName);
803
+
804
+				$primaryKeys = $dbRow->_getPrimaryKeys();
805
+
806
+				$types = [];
807
+
808
+				foreach ($dbRowData as $columnName => $value) {
809
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
810
+					$types[] = $columnDescriptor->getType();
811
+				}
812
+				foreach ($primaryKeys as $columnName => $value) {
813
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
814
+					$types[] = $columnDescriptor->getType();
815
+				}
816
+
817
+				$this->connection->update($tableName, $dbRowData, $primaryKeys, $types);
818
+
819
+				// Let's check if the primary key has been updated...
820
+				$needsUpdatePk = false;
821
+				foreach ($primaryKeys as $column => $value) {
822
+					if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
823
+						$needsUpdatePk = true;
824
+						break;
825
+					}
826
+				}
827
+				if ($needsUpdatePk) {
828
+					$this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
829
+					$newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
830
+					$dbRow->_setPrimaryKeys($newPrimaryKeys);
831
+					$this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
832
+				}
833
+
834
+				// Let's remove this object from the list of objects to save.
835
+				$this->removeFromToSaveObjectList($dbRow);
836
+			}
837
+
838
+			$object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
839
+		} elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
840
+			throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
841
+		}
842
+
843
+		// Finally, let's save all the many to many relationships to this bean.
844
+		$this->persistManyToManyRelationships($object);
845
+	}
846
+
847
+	private function persistManyToManyRelationships(AbstractTDBMObject $object)
848
+	{
849
+		foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
850
+			$tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
851
+			list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
852
+
853
+			foreach ($storage as $remoteBean) {
854
+				/* @var $remoteBean AbstractTDBMObject */
855
+				$statusArr = $storage[$remoteBean];
856
+				$status = $statusArr['status'];
857
+				$reverse = $statusArr['reverse'];
858
+				if ($reverse) {
859
+					continue;
860
+				}
861
+
862
+				if ($status === 'new') {
863
+					$remoteBeanStatus = $remoteBean->_getStatus();
864
+					if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
865
+						// Let's save remote bean if needed.
866
+						$this->save($remoteBean);
867
+					}
868
+
869
+					$filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
870
+
871
+					$types = [];
872
+
873
+					foreach ($filters as $columnName => $value) {
874
+						$columnDescriptor = $tableDescriptor->getColumn($columnName);
875
+						$types[] = $columnDescriptor->getType();
876
+					}
877
+
878
+					$this->connection->insert($pivotTableName, $filters, $types);
879
+
880
+					// Finally, let's mark relationships as saved.
881
+					$statusArr['status'] = 'loaded';
882
+					$storage[$remoteBean] = $statusArr;
883
+					$remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
884
+					$remoteStatusArr = $remoteStorage[$object];
885
+					$remoteStatusArr['status'] = 'loaded';
886
+					$remoteStorage[$object] = $remoteStatusArr;
887
+				} elseif ($status === 'delete') {
888
+					$filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
889
+
890
+					$types = [];
891
+
892
+					foreach ($filters as $columnName => $value) {
893
+						$columnDescriptor = $tableDescriptor->getColumn($columnName);
894
+						$types[] = $columnDescriptor->getType();
895
+					}
896
+
897
+					$this->connection->delete($pivotTableName, $filters, $types);
898
+
899
+					// Finally, let's remove relationships completely from bean.
900
+					$storage->detach($remoteBean);
901
+					$remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
902
+				}
903
+			}
904
+		}
905
+	}
906
+
907
+	private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
908
+	{
909
+		$localBeanPk = $this->getPrimaryKeyValues($localBean);
910
+		$remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
911
+		$localColumns = $localFk->getLocalColumns();
912
+		$remoteColumns = $remoteFk->getLocalColumns();
913
+
914
+		$localFilters = array_combine($localColumns, $localBeanPk);
915
+		$remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
916
+
917
+		return array_merge($localFilters, $remoteFilters);
918
+	}
919
+
920
+	/**
921
+	 * Returns the "values" of the primary key.
922
+	 * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
923
+	 *
924
+	 * @param AbstractTDBMObject $bean
925
+	 *
926
+	 * @return array numerically indexed array of values.
927
+	 */
928
+	private function getPrimaryKeyValues(AbstractTDBMObject $bean)
929
+	{
930
+		$dbRows = $bean->_getDbRows();
931
+		$dbRow = reset($dbRows);
932
+
933
+		return array_values($dbRow->_getPrimaryKeys());
934
+	}
935
+
936
+	/**
937
+	 * Returns a unique hash used to store the object based on its primary key.
938
+	 * If the array contains only one value, then the value is returned.
939
+	 * Otherwise, a hash representing the array is returned.
940
+	 *
941
+	 * @param array $primaryKeys An array of columns => values forming the primary key
942
+	 *
943
+	 * @return string
944
+	 */
945
+	public function getObjectHash(array $primaryKeys)
946
+	{
947
+		if (count($primaryKeys) === 1) {
948
+			return reset($primaryKeys);
949
+		} else {
950
+			ksort($primaryKeys);
951
+
952
+			return md5(json_encode($primaryKeys));
953
+		}
954
+	}
955
+
956
+	/**
957
+	 * Returns an array of primary keys from the object.
958
+	 * The primary keys are extracted from the object columns and not from the primary keys stored in the
959
+	 * $primaryKeys variable of the object.
960
+	 *
961
+	 * @param DbRow $dbRow
962
+	 *
963
+	 * @return array Returns an array of column => value
964
+	 */
965
+	public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
966
+	{
967
+		$table = $dbRow->_getDbTableName();
968
+		$dbRowData = $dbRow->_getDbRow();
969
+
970
+		return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
971
+	}
972
+
973
+	/**
974
+	 * Returns an array of primary keys for the given row.
975
+	 * The primary keys are extracted from the object columns.
976
+	 *
977
+	 * @param $table
978
+	 * @param array $columns
979
+	 *
980
+	 * @return array
981
+	 */
982
+	public function _getPrimaryKeysFromObjectData($table, array $columns)
983
+	{
984
+		$primaryKeyColumns = $this->getPrimaryKeyColumns($table);
985
+		$values = array();
986
+		foreach ($primaryKeyColumns as $column) {
987
+			if (isset($columns[$column])) {
988
+				$values[$column] = $columns[$column];
989
+			}
990
+		}
991
+
992
+		return $values;
993
+	}
994
+
995
+	/**
996
+	 * Attaches $object to this TDBMService.
997
+	 * The $object must be in DETACHED state and will pass in NEW state.
998
+	 *
999
+	 * @param AbstractTDBMObject $object
1000
+	 *
1001
+	 * @throws TDBMInvalidOperationException
1002
+	 */
1003
+	public function attach(AbstractTDBMObject $object)
1004
+	{
1005
+		$object->_attach($this);
1006
+	}
1007
+
1008
+	/**
1009
+	 * Returns an associative array (column => value) for the primary keys from the table name and an
1010
+	 * indexed array of primary key values.
1011
+	 *
1012
+	 * @param string $tableName
1013
+	 * @param array  $indexedPrimaryKeys
1014
+	 */
1015
+	public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
1016
+	{
1017
+		$primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
1018
+
1019
+		if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
1020
+			throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
1021 1021
 			got %s instead.', count($primaryKeyColumns), $tableName, count($indexedPrimaryKeys)));
1022
-        }
1023
-
1024
-        return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1025
-    }
1026
-
1027
-    /**
1028
-     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1029
-     * Tables must be in a single line of inheritance. The method will find missing tables.
1030
-     *
1031
-     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1032
-     * we must be able to find all other tables.
1033
-     *
1034
-     * @param string[] $tables
1035
-     *
1036
-     * @return string[]
1037
-     */
1038
-    public function _getLinkBetweenInheritedTables(array $tables)
1039
-    {
1040
-        sort($tables);
1041
-
1042
-        return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1043
-            function () use ($tables) {
1044
-                return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1045
-            });
1046
-    }
1047
-
1048
-    /**
1049
-     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1050
-     * Tables must be in a single line of inheritance. The method will find missing tables.
1051
-     *
1052
-     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1053
-     * we must be able to find all other tables.
1054
-     *
1055
-     * @param string[] $tables
1056
-     *
1057
-     * @return string[]
1058
-     */
1059
-    private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1060
-    {
1061
-        $schemaAnalyzer = $this->schemaAnalyzer;
1062
-
1063
-        foreach ($tables as $currentTable) {
1064
-            $allParents = [$currentTable];
1065
-            while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1066
-                $currentTable = $currentFk->getForeignTableName();
1067
-                $allParents[] = $currentTable;
1068
-            };
1069
-
1070
-            // Now, does the $allParents contain all the tables we want?
1071
-            $notFoundTables = array_diff($tables, $allParents);
1072
-            if (empty($notFoundTables)) {
1073
-                // We have a winner!
1074
-                return $allParents;
1075
-            }
1076
-        }
1077
-
1078
-        throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1079
-    }
1080
-
1081
-    /**
1082
-     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1083
-     *
1084
-     * @param string $table
1085
-     *
1086
-     * @return string[]
1087
-     */
1088
-    public function _getRelatedTablesByInheritance($table)
1089
-    {
1090
-        return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1091
-            return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1092
-        });
1093
-    }
1094
-
1095
-    /**
1096
-     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1097
-     *
1098
-     * @param string $table
1099
-     *
1100
-     * @return string[]
1101
-     */
1102
-    private function _getRelatedTablesByInheritanceWithoutCache($table)
1103
-    {
1104
-        $schemaAnalyzer = $this->schemaAnalyzer;
1105
-
1106
-        // Let's scan the parent tables
1107
-        $currentTable = $table;
1108
-
1109
-        $parentTables = [];
1110
-
1111
-        // Get parent relationship
1112
-        while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1113
-            $currentTable = $currentFk->getForeignTableName();
1114
-            $parentTables[] = $currentTable;
1115
-        };
1116
-
1117
-        // Let's recurse in children
1118
-        $childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1119
-
1120
-        return array_merge(array_reverse($parentTables), $childrenTables);
1121
-    }
1122
-
1123
-    /**
1124
-     * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1125
-     *
1126
-     * @param string $table
1127
-     *
1128
-     * @return string[]
1129
-     */
1130
-    private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1131
-    {
1132
-        $tables = [$table];
1133
-        $keys = $schemaAnalyzer->getChildrenRelationships($table);
1134
-
1135
-        foreach ($keys as $key) {
1136
-            $tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1137
-        }
1138
-
1139
-        return $tables;
1140
-    }
1141
-
1142
-    /**
1143
-     * Casts a foreign key into SQL, assuming table name is used with no alias.
1144
-     * The returned value does contain only one table. For instance:.
1145
-     *
1146
-     * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1147
-     *
1148
-     * @param ForeignKeyConstraint $fk
1149
-     * @param bool                 $leftTableIsLocal
1150
-     *
1151
-     * @return string
1152
-     */
1153
-    /*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
1022
+		}
1023
+
1024
+		return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1025
+	}
1026
+
1027
+	/**
1028
+	 * Return the list of tables (from child to parent) joining the tables passed in parameter.
1029
+	 * Tables must be in a single line of inheritance. The method will find missing tables.
1030
+	 *
1031
+	 * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1032
+	 * we must be able to find all other tables.
1033
+	 *
1034
+	 * @param string[] $tables
1035
+	 *
1036
+	 * @return string[]
1037
+	 */
1038
+	public function _getLinkBetweenInheritedTables(array $tables)
1039
+	{
1040
+		sort($tables);
1041
+
1042
+		return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1043
+			function () use ($tables) {
1044
+				return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1045
+			});
1046
+	}
1047
+
1048
+	/**
1049
+	 * Return the list of tables (from child to parent) joining the tables passed in parameter.
1050
+	 * Tables must be in a single line of inheritance. The method will find missing tables.
1051
+	 *
1052
+	 * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1053
+	 * we must be able to find all other tables.
1054
+	 *
1055
+	 * @param string[] $tables
1056
+	 *
1057
+	 * @return string[]
1058
+	 */
1059
+	private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1060
+	{
1061
+		$schemaAnalyzer = $this->schemaAnalyzer;
1062
+
1063
+		foreach ($tables as $currentTable) {
1064
+			$allParents = [$currentTable];
1065
+			while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1066
+				$currentTable = $currentFk->getForeignTableName();
1067
+				$allParents[] = $currentTable;
1068
+			};
1069
+
1070
+			// Now, does the $allParents contain all the tables we want?
1071
+			$notFoundTables = array_diff($tables, $allParents);
1072
+			if (empty($notFoundTables)) {
1073
+				// We have a winner!
1074
+				return $allParents;
1075
+			}
1076
+		}
1077
+
1078
+		throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1079
+	}
1080
+
1081
+	/**
1082
+	 * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1083
+	 *
1084
+	 * @param string $table
1085
+	 *
1086
+	 * @return string[]
1087
+	 */
1088
+	public function _getRelatedTablesByInheritance($table)
1089
+	{
1090
+		return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1091
+			return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1092
+		});
1093
+	}
1094
+
1095
+	/**
1096
+	 * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1097
+	 *
1098
+	 * @param string $table
1099
+	 *
1100
+	 * @return string[]
1101
+	 */
1102
+	private function _getRelatedTablesByInheritanceWithoutCache($table)
1103
+	{
1104
+		$schemaAnalyzer = $this->schemaAnalyzer;
1105
+
1106
+		// Let's scan the parent tables
1107
+		$currentTable = $table;
1108
+
1109
+		$parentTables = [];
1110
+
1111
+		// Get parent relationship
1112
+		while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1113
+			$currentTable = $currentFk->getForeignTableName();
1114
+			$parentTables[] = $currentTable;
1115
+		};
1116
+
1117
+		// Let's recurse in children
1118
+		$childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1119
+
1120
+		return array_merge(array_reverse($parentTables), $childrenTables);
1121
+	}
1122
+
1123
+	/**
1124
+	 * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1125
+	 *
1126
+	 * @param string $table
1127
+	 *
1128
+	 * @return string[]
1129
+	 */
1130
+	private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1131
+	{
1132
+		$tables = [$table];
1133
+		$keys = $schemaAnalyzer->getChildrenRelationships($table);
1134
+
1135
+		foreach ($keys as $key) {
1136
+			$tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1137
+		}
1138
+
1139
+		return $tables;
1140
+	}
1141
+
1142
+	/**
1143
+	 * Casts a foreign key into SQL, assuming table name is used with no alias.
1144
+	 * The returned value does contain only one table. For instance:.
1145
+	 *
1146
+	 * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1147
+	 *
1148
+	 * @param ForeignKeyConstraint $fk
1149
+	 * @param bool                 $leftTableIsLocal
1150
+	 *
1151
+	 * @return string
1152
+	 */
1153
+	/*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
1154 1154
         $onClauses = [];
1155 1155
         $foreignTableName = $this->connection->quoteIdentifier($fk->getForeignTableName());
1156 1156
         $foreignColumns = $fk->getForeignColumns();
@@ -1176,370 +1176,370 @@  discard block
 block discarded – undo
1176 1176
         }
1177 1177
     }*/
1178 1178
 
1179
-    /**
1180
-     * Returns an identifier for the group of tables passed in parameter.
1181
-     *
1182
-     * @param string[] $relatedTables
1183
-     *
1184
-     * @return string
1185
-     */
1186
-    private function getTableGroupName(array $relatedTables)
1187
-    {
1188
-        sort($relatedTables);
1189
-
1190
-        return implode('_``_', $relatedTables);
1191
-    }
1192
-
1193
-    /**
1194
-     * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1195
-     *
1196
-     * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1197
-     * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1198
-     *
1199
-     * The findObjects method takes in parameter:
1200
-     * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1201
-     * 			`$mainTable` parameter should be the name of an existing table in database.
1202
-     *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1203
-     *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1204
-     *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1205
-     *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1206
-     *          Instead, please consider passing parameters (see documentation for more details).
1207
-     *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1208
-     *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1209
-     *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1210
-     *
1211
-     * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1212
-     * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1213
-     *
1214
-     * Finally, if filter_bag is null, the whole table is returned.
1215
-     *
1216
-     * @param string            $mainTable             The name of the table queried
1217
-     * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1218
-     * @param array             $parameters
1219
-     * @param string|null       $orderString           The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
1220
-     * @param array             $additionalTablesFetch
1221
-     * @param int               $mode
1222
-     * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1223
-     *
1224
-     * @return ResultIterator An object representing an array of results.
1225
-     *
1226
-     * @throws TDBMException
1227
-     */
1228
-    public function findObjects($mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, $className = null)
1229
-    {
1230
-        // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1231
-        if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1232
-            throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1233
-        }
1234
-
1235
-        list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1236
-
1237
-        $parameters = array_merge($parameters, $additionalParameters);
1238
-
1239
-        // From the table name and the additional tables we want to fetch, let's build a list of all tables
1240
-        // that must be part of the select columns.
1241
-
1242
-        $tableGroups = [];
1243
-        $allFetchedTables = $this->_getRelatedTablesByInheritance($mainTable);
1244
-        $tableGroupName = $this->getTableGroupName($allFetchedTables);
1245
-        foreach ($allFetchedTables as $table) {
1246
-            $tableGroups[$table] = $tableGroupName;
1247
-        }
1248
-
1249
-        foreach ($additionalTablesFetch as $additionalTable) {
1250
-            $relatedTables = $this->_getRelatedTablesByInheritance($additionalTable);
1251
-            $tableGroupName = $this->getTableGroupName($relatedTables);
1252
-            foreach ($relatedTables as $table) {
1253
-                $tableGroups[$table] = $tableGroupName;
1254
-            }
1255
-            $allFetchedTables = array_merge($allFetchedTables, $relatedTables);
1256
-        }
1257
-
1258
-        // Let's remove any duplicate
1259
-        $allFetchedTables = array_flip(array_flip($allFetchedTables));
1260
-
1261
-        $columnsList = [];
1262
-        $columnDescList = [];
1263
-        $schema = $this->tdbmSchemaAnalyzer->getSchema();
1264
-
1265
-        // Now, let's build the column list
1266
-        foreach ($allFetchedTables as $table) {
1267
-            foreach ($schema->getTable($table)->getColumns() as $column) {
1268
-                $columnName = $column->getName();
1269
-                $columnDescList[] = [
1270
-                    'as' => $table.'____'.$columnName,
1271
-                    'table' => $table,
1272
-                    'column' => $columnName,
1273
-                    'type' => $column->getType(),
1274
-                    'tableGroup' => $tableGroups[$table],
1275
-                ];
1276
-                $columnsList[] = $this->connection->quoteIdentifier($table).'.'.$this->connection->quoteIdentifier($columnName).' as '.
1277
-                    $this->connection->quoteIdentifier($table.'____'.$columnName);
1278
-            }
1279
-        }
1280
-
1281
-        $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$mainTable.')';
1282
-        $countSql = 'SELECT COUNT(1) FROM MAGICJOIN('.$mainTable.')';
1283
-
1284
-        if (!empty($filterString)) {
1285
-            $sql .= ' WHERE '.$filterString;
1286
-            $countSql .= ' WHERE '.$filterString;
1287
-        }
1288
-
1289
-        if (!empty($orderString)) {
1290
-            $sql .= ' ORDER BY '.$orderString;
1291
-            $countSql .= ' ORDER BY '.$orderString;
1292
-        }
1293
-
1294
-        if ($mode !== null && $mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
1295
-            throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
1296
-        }
1297
-
1298
-        $mode = $mode ?: $this->mode;
1299
-
1300
-        return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode);
1301
-    }
1302
-
1303
-    /**
1304
-     * @param $table
1305
-     * @param array  $primaryKeys
1306
-     * @param array  $additionalTablesFetch
1307
-     * @param bool   $lazy                  Whether to perform lazy loading on this object or not.
1308
-     * @param string $className
1309
-     *
1310
-     * @return AbstractTDBMObject
1311
-     *
1312
-     * @throws TDBMException
1313
-     */
1314
-    public function findObjectByPk($table, array $primaryKeys, array $additionalTablesFetch = array(), $lazy = false, $className = null)
1315
-    {
1316
-        $primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1317
-        $hash = $this->getObjectHash($primaryKeys);
1318
-
1319
-        if ($this->objectStorage->has($table, $hash)) {
1320
-            $dbRow = $this->objectStorage->get($table, $hash);
1321
-            $bean = $dbRow->getTDBMObject();
1322
-            if ($className !== null && !is_a($bean, $className)) {
1323
-                throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1324
-            }
1325
-
1326
-            return $bean;
1327
-        }
1328
-
1329
-        // Are we performing lazy fetching?
1330
-        if ($lazy === true) {
1331
-            // Can we perform lazy fetching?
1332
-            $tables = $this->_getRelatedTablesByInheritance($table);
1333
-            // Only allowed if no inheritance.
1334
-            if (count($tables) === 1) {
1335
-                if ($className === null) {
1336
-                    $className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1337
-                }
1338
-
1339
-                // Let's construct the bean
1340
-                if (!isset($this->reflectionClassCache[$className])) {
1341
-                    $this->reflectionClassCache[$className] = new \ReflectionClass($className);
1342
-                }
1343
-                // Let's bypass the constructor when creating the bean!
1344
-                $bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1345
-                /* @var $bean AbstractTDBMObject */
1346
-                $bean->_constructLazy($table, $primaryKeys, $this);
1347
-            }
1348
-        }
1349
-
1350
-        // Did not find the object in cache? Let's query it!
1351
-        return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1352
-    }
1353
-
1354
-    /**
1355
-     * Returns a unique bean (or null) according to the filters passed in parameter.
1356
-     *
1357
-     * @param string            $mainTable             The name of the table queried
1358
-     * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1359
-     * @param array             $parameters
1360
-     * @param array             $additionalTablesFetch
1361
-     * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1362
-     *
1363
-     * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters.
1364
-     *
1365
-     * @throws TDBMException
1366
-     */
1367
-    public function findObject($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1368
-    {
1369
-        $objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1370
-        $page = $objects->take(0, 2);
1371
-        $count = $page->count();
1372
-        if ($count > 1) {
1373
-            throw new DuplicateRowException("Error while querying an object for table '$mainTable': More than 1 row have been returned, but we should have received at most one.");
1374
-        } elseif ($count === 0) {
1375
-            return;
1376
-        }
1377
-
1378
-        return $objects[0];
1379
-    }
1380
-
1381
-    /**
1382
-     * Returns a unique bean according to the filters passed in parameter.
1383
-     * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1384
-     *
1385
-     * @param string            $mainTable             The name of the table queried
1386
-     * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1387
-     * @param array             $parameters
1388
-     * @param array             $additionalTablesFetch
1389
-     * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1390
-     *
1391
-     * @return AbstractTDBMObject The object we want
1392
-     *
1393
-     * @throws TDBMException
1394
-     */
1395
-    public function findObjectOrFail($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1396
-    {
1397
-        $bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1398
-        if ($bean === null) {
1399
-            throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1400
-        }
1401
-
1402
-        return $bean;
1403
-    }
1404
-
1405
-    /**
1406
-     * @param array $beanData An array of data: array<table, array<column, value>>
1407
-     *
1408
-     * @return array an array with first item = class name and second item = table name
1409
-     */
1410
-    public function _getClassNameFromBeanData(array $beanData)
1411
-    {
1412
-        if (count($beanData) === 1) {
1413
-            $tableName = array_keys($beanData)[0];
1414
-        } else {
1415
-            $tables = [];
1416
-            foreach ($beanData as $table => $row) {
1417
-                $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1418
-                $pkSet = false;
1419
-                foreach ($primaryKeyColumns as $columnName) {
1420
-                    if ($row[$columnName] !== null) {
1421
-                        $pkSet = true;
1422
-                        break;
1423
-                    }
1424
-                }
1425
-                if ($pkSet) {
1426
-                    $tables[] = $table;
1427
-                }
1428
-            }
1429
-
1430
-            // $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1431
-            $allTables = $this->_getLinkBetweenInheritedTables($tables);
1432
-            $tableName = $allTables[0];
1433
-        }
1434
-
1435
-        // Only one table in this bean. Life is sweat, let's look at its type:
1436
-        if (isset($this->tableToBeanMap[$tableName])) {
1437
-            return [$this->tableToBeanMap[$tableName], $tableName];
1438
-        } else {
1439
-            return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName];
1440
-        }
1441
-    }
1442
-
1443
-    /**
1444
-     * Returns an item from cache or computes it using $closure and puts it in cache.
1445
-     *
1446
-     * @param string   $key
1447
-     * @param callable $closure
1448
-     *
1449
-     * @return mixed
1450
-     */
1451
-    private function fromCache($key, callable $closure)
1452
-    {
1453
-        $item = $this->cache->fetch($key);
1454
-        if ($item === false) {
1455
-            $item = $closure();
1456
-            $this->cache->save($key, $item);
1457
-        }
1458
-
1459
-        return $item;
1460
-    }
1461
-
1462
-    /**
1463
-     * Returns the foreign key object.
1464
-     *
1465
-     * @param string $table
1466
-     * @param string $fkName
1467
-     *
1468
-     * @return ForeignKeyConstraint
1469
-     */
1470
-    public function _getForeignKeyByName($table, $fkName)
1471
-    {
1472
-        return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1473
-    }
1474
-
1475
-    /**
1476
-     * @param $pivotTableName
1477
-     * @param AbstractTDBMObject $bean
1478
-     *
1479
-     * @return AbstractTDBMObject[]
1480
-     */
1481
-    public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean)
1482
-    {
1483
-        list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1484
-        /* @var $localFk ForeignKeyConstraint */
1485
-        /* @var $remoteFk ForeignKeyConstraint */
1486
-        $remoteTable = $remoteFk->getForeignTableName();
1487
-
1488
-        $primaryKeys = $this->getPrimaryKeyValues($bean);
1489
-        $columnNames = array_map(function ($name) use ($pivotTableName) { return $pivotTableName.'.'.$name; }, $localFk->getLocalColumns());
1490
-
1491
-        $filter = array_combine($columnNames, $primaryKeys);
1492
-
1493
-        return $this->findObjects($remoteTable, $filter);
1494
-    }
1495
-
1496
-    /**
1497
-     * @param $pivotTableName
1498
-     * @param AbstractTDBMObject $bean The LOCAL bean
1499
-     *
1500
-     * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean.
1501
-     *
1502
-     * @throws TDBMException
1503
-     */
1504
-    private function getPivotTableForeignKeys($pivotTableName, AbstractTDBMObject $bean)
1505
-    {
1506
-        $fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1507
-        $table1 = $fks[0]->getForeignTableName();
1508
-        $table2 = $fks[1]->getForeignTableName();
1509
-
1510
-        $beanTables = array_map(function (DbRow $dbRow) { return $dbRow->_getDbTableName(); }, $bean->_getDbRows());
1511
-
1512
-        if (in_array($table1, $beanTables)) {
1513
-            return [$fks[0], $fks[1]];
1514
-        } elseif (in_array($table2, $beanTables)) {
1515
-            return [$fks[1], $fks[0]];
1516
-        } else {
1517
-            throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1518
-        }
1519
-    }
1520
-
1521
-    /**
1522
-     * Returns a list of pivot tables linked to $bean.
1523
-     *
1524
-     * @param AbstractTDBMObject $bean
1525
-     *
1526
-     * @return string[]
1527
-     */
1528
-    public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1529
-    {
1530
-        $junctionTables = [];
1531
-        $allJunctionTables = $this->schemaAnalyzer->detectJunctionTables();
1532
-        foreach ($bean->_getDbRows() as $dbRow) {
1533
-            foreach ($allJunctionTables as $table) {
1534
-                // There are exactly 2 FKs since this is a pivot table.
1535
-                $fks = array_values($table->getForeignKeys());
1536
-
1537
-                if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1538
-                    $junctionTables[] = $table->getName();
1539
-                }
1540
-            }
1541
-        }
1542
-
1543
-        return $junctionTables;
1544
-    }
1179
+	/**
1180
+	 * Returns an identifier for the group of tables passed in parameter.
1181
+	 *
1182
+	 * @param string[] $relatedTables
1183
+	 *
1184
+	 * @return string
1185
+	 */
1186
+	private function getTableGroupName(array $relatedTables)
1187
+	{
1188
+		sort($relatedTables);
1189
+
1190
+		return implode('_``_', $relatedTables);
1191
+	}
1192
+
1193
+	/**
1194
+	 * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1195
+	 *
1196
+	 * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1197
+	 * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1198
+	 *
1199
+	 * The findObjects method takes in parameter:
1200
+	 * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1201
+	 * 			`$mainTable` parameter should be the name of an existing table in database.
1202
+	 *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1203
+	 *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1204
+	 *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1205
+	 *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1206
+	 *          Instead, please consider passing parameters (see documentation for more details).
1207
+	 *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1208
+	 *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1209
+	 *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1210
+	 *
1211
+	 * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1212
+	 * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1213
+	 *
1214
+	 * Finally, if filter_bag is null, the whole table is returned.
1215
+	 *
1216
+	 * @param string            $mainTable             The name of the table queried
1217
+	 * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1218
+	 * @param array             $parameters
1219
+	 * @param string|null       $orderString           The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
1220
+	 * @param array             $additionalTablesFetch
1221
+	 * @param int               $mode
1222
+	 * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1223
+	 *
1224
+	 * @return ResultIterator An object representing an array of results.
1225
+	 *
1226
+	 * @throws TDBMException
1227
+	 */
1228
+	public function findObjects($mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, $className = null)
1229
+	{
1230
+		// $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1231
+		if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1232
+			throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1233
+		}
1234
+
1235
+		list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1236
+
1237
+		$parameters = array_merge($parameters, $additionalParameters);
1238
+
1239
+		// From the table name and the additional tables we want to fetch, let's build a list of all tables
1240
+		// that must be part of the select columns.
1241
+
1242
+		$tableGroups = [];
1243
+		$allFetchedTables = $this->_getRelatedTablesByInheritance($mainTable);
1244
+		$tableGroupName = $this->getTableGroupName($allFetchedTables);
1245
+		foreach ($allFetchedTables as $table) {
1246
+			$tableGroups[$table] = $tableGroupName;
1247
+		}
1248
+
1249
+		foreach ($additionalTablesFetch as $additionalTable) {
1250
+			$relatedTables = $this->_getRelatedTablesByInheritance($additionalTable);
1251
+			$tableGroupName = $this->getTableGroupName($relatedTables);
1252
+			foreach ($relatedTables as $table) {
1253
+				$tableGroups[$table] = $tableGroupName;
1254
+			}
1255
+			$allFetchedTables = array_merge($allFetchedTables, $relatedTables);
1256
+		}
1257
+
1258
+		// Let's remove any duplicate
1259
+		$allFetchedTables = array_flip(array_flip($allFetchedTables));
1260
+
1261
+		$columnsList = [];
1262
+		$columnDescList = [];
1263
+		$schema = $this->tdbmSchemaAnalyzer->getSchema();
1264
+
1265
+		// Now, let's build the column list
1266
+		foreach ($allFetchedTables as $table) {
1267
+			foreach ($schema->getTable($table)->getColumns() as $column) {
1268
+				$columnName = $column->getName();
1269
+				$columnDescList[] = [
1270
+					'as' => $table.'____'.$columnName,
1271
+					'table' => $table,
1272
+					'column' => $columnName,
1273
+					'type' => $column->getType(),
1274
+					'tableGroup' => $tableGroups[$table],
1275
+				];
1276
+				$columnsList[] = $this->connection->quoteIdentifier($table).'.'.$this->connection->quoteIdentifier($columnName).' as '.
1277
+					$this->connection->quoteIdentifier($table.'____'.$columnName);
1278
+			}
1279
+		}
1280
+
1281
+		$sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$mainTable.')';
1282
+		$countSql = 'SELECT COUNT(1) FROM MAGICJOIN('.$mainTable.')';
1283
+
1284
+		if (!empty($filterString)) {
1285
+			$sql .= ' WHERE '.$filterString;
1286
+			$countSql .= ' WHERE '.$filterString;
1287
+		}
1288
+
1289
+		if (!empty($orderString)) {
1290
+			$sql .= ' ORDER BY '.$orderString;
1291
+			$countSql .= ' ORDER BY '.$orderString;
1292
+		}
1293
+
1294
+		if ($mode !== null && $mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
1295
+			throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
1296
+		}
1297
+
1298
+		$mode = $mode ?: $this->mode;
1299
+
1300
+		return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode);
1301
+	}
1302
+
1303
+	/**
1304
+	 * @param $table
1305
+	 * @param array  $primaryKeys
1306
+	 * @param array  $additionalTablesFetch
1307
+	 * @param bool   $lazy                  Whether to perform lazy loading on this object or not.
1308
+	 * @param string $className
1309
+	 *
1310
+	 * @return AbstractTDBMObject
1311
+	 *
1312
+	 * @throws TDBMException
1313
+	 */
1314
+	public function findObjectByPk($table, array $primaryKeys, array $additionalTablesFetch = array(), $lazy = false, $className = null)
1315
+	{
1316
+		$primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1317
+		$hash = $this->getObjectHash($primaryKeys);
1318
+
1319
+		if ($this->objectStorage->has($table, $hash)) {
1320
+			$dbRow = $this->objectStorage->get($table, $hash);
1321
+			$bean = $dbRow->getTDBMObject();
1322
+			if ($className !== null && !is_a($bean, $className)) {
1323
+				throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1324
+			}
1325
+
1326
+			return $bean;
1327
+		}
1328
+
1329
+		// Are we performing lazy fetching?
1330
+		if ($lazy === true) {
1331
+			// Can we perform lazy fetching?
1332
+			$tables = $this->_getRelatedTablesByInheritance($table);
1333
+			// Only allowed if no inheritance.
1334
+			if (count($tables) === 1) {
1335
+				if ($className === null) {
1336
+					$className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1337
+				}
1338
+
1339
+				// Let's construct the bean
1340
+				if (!isset($this->reflectionClassCache[$className])) {
1341
+					$this->reflectionClassCache[$className] = new \ReflectionClass($className);
1342
+				}
1343
+				// Let's bypass the constructor when creating the bean!
1344
+				$bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1345
+				/* @var $bean AbstractTDBMObject */
1346
+				$bean->_constructLazy($table, $primaryKeys, $this);
1347
+			}
1348
+		}
1349
+
1350
+		// Did not find the object in cache? Let's query it!
1351
+		return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1352
+	}
1353
+
1354
+	/**
1355
+	 * Returns a unique bean (or null) according to the filters passed in parameter.
1356
+	 *
1357
+	 * @param string            $mainTable             The name of the table queried
1358
+	 * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1359
+	 * @param array             $parameters
1360
+	 * @param array             $additionalTablesFetch
1361
+	 * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1362
+	 *
1363
+	 * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters.
1364
+	 *
1365
+	 * @throws TDBMException
1366
+	 */
1367
+	public function findObject($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1368
+	{
1369
+		$objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1370
+		$page = $objects->take(0, 2);
1371
+		$count = $page->count();
1372
+		if ($count > 1) {
1373
+			throw new DuplicateRowException("Error while querying an object for table '$mainTable': More than 1 row have been returned, but we should have received at most one.");
1374
+		} elseif ($count === 0) {
1375
+			return;
1376
+		}
1377
+
1378
+		return $objects[0];
1379
+	}
1380
+
1381
+	/**
1382
+	 * Returns a unique bean according to the filters passed in parameter.
1383
+	 * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1384
+	 *
1385
+	 * @param string            $mainTable             The name of the table queried
1386
+	 * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1387
+	 * @param array             $parameters
1388
+	 * @param array             $additionalTablesFetch
1389
+	 * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1390
+	 *
1391
+	 * @return AbstractTDBMObject The object we want
1392
+	 *
1393
+	 * @throws TDBMException
1394
+	 */
1395
+	public function findObjectOrFail($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1396
+	{
1397
+		$bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1398
+		if ($bean === null) {
1399
+			throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1400
+		}
1401
+
1402
+		return $bean;
1403
+	}
1404
+
1405
+	/**
1406
+	 * @param array $beanData An array of data: array<table, array<column, value>>
1407
+	 *
1408
+	 * @return array an array with first item = class name and second item = table name
1409
+	 */
1410
+	public function _getClassNameFromBeanData(array $beanData)
1411
+	{
1412
+		if (count($beanData) === 1) {
1413
+			$tableName = array_keys($beanData)[0];
1414
+		} else {
1415
+			$tables = [];
1416
+			foreach ($beanData as $table => $row) {
1417
+				$primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1418
+				$pkSet = false;
1419
+				foreach ($primaryKeyColumns as $columnName) {
1420
+					if ($row[$columnName] !== null) {
1421
+						$pkSet = true;
1422
+						break;
1423
+					}
1424
+				}
1425
+				if ($pkSet) {
1426
+					$tables[] = $table;
1427
+				}
1428
+			}
1429
+
1430
+			// $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1431
+			$allTables = $this->_getLinkBetweenInheritedTables($tables);
1432
+			$tableName = $allTables[0];
1433
+		}
1434
+
1435
+		// Only one table in this bean. Life is sweat, let's look at its type:
1436
+		if (isset($this->tableToBeanMap[$tableName])) {
1437
+			return [$this->tableToBeanMap[$tableName], $tableName];
1438
+		} else {
1439
+			return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName];
1440
+		}
1441
+	}
1442
+
1443
+	/**
1444
+	 * Returns an item from cache or computes it using $closure and puts it in cache.
1445
+	 *
1446
+	 * @param string   $key
1447
+	 * @param callable $closure
1448
+	 *
1449
+	 * @return mixed
1450
+	 */
1451
+	private function fromCache($key, callable $closure)
1452
+	{
1453
+		$item = $this->cache->fetch($key);
1454
+		if ($item === false) {
1455
+			$item = $closure();
1456
+			$this->cache->save($key, $item);
1457
+		}
1458
+
1459
+		return $item;
1460
+	}
1461
+
1462
+	/**
1463
+	 * Returns the foreign key object.
1464
+	 *
1465
+	 * @param string $table
1466
+	 * @param string $fkName
1467
+	 *
1468
+	 * @return ForeignKeyConstraint
1469
+	 */
1470
+	public function _getForeignKeyByName($table, $fkName)
1471
+	{
1472
+		return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1473
+	}
1474
+
1475
+	/**
1476
+	 * @param $pivotTableName
1477
+	 * @param AbstractTDBMObject $bean
1478
+	 *
1479
+	 * @return AbstractTDBMObject[]
1480
+	 */
1481
+	public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean)
1482
+	{
1483
+		list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1484
+		/* @var $localFk ForeignKeyConstraint */
1485
+		/* @var $remoteFk ForeignKeyConstraint */
1486
+		$remoteTable = $remoteFk->getForeignTableName();
1487
+
1488
+		$primaryKeys = $this->getPrimaryKeyValues($bean);
1489
+		$columnNames = array_map(function ($name) use ($pivotTableName) { return $pivotTableName.'.'.$name; }, $localFk->getLocalColumns());
1490
+
1491
+		$filter = array_combine($columnNames, $primaryKeys);
1492
+
1493
+		return $this->findObjects($remoteTable, $filter);
1494
+	}
1495
+
1496
+	/**
1497
+	 * @param $pivotTableName
1498
+	 * @param AbstractTDBMObject $bean The LOCAL bean
1499
+	 *
1500
+	 * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean.
1501
+	 *
1502
+	 * @throws TDBMException
1503
+	 */
1504
+	private function getPivotTableForeignKeys($pivotTableName, AbstractTDBMObject $bean)
1505
+	{
1506
+		$fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1507
+		$table1 = $fks[0]->getForeignTableName();
1508
+		$table2 = $fks[1]->getForeignTableName();
1509
+
1510
+		$beanTables = array_map(function (DbRow $dbRow) { return $dbRow->_getDbTableName(); }, $bean->_getDbRows());
1511
+
1512
+		if (in_array($table1, $beanTables)) {
1513
+			return [$fks[0], $fks[1]];
1514
+		} elseif (in_array($table2, $beanTables)) {
1515
+			return [$fks[1], $fks[0]];
1516
+		} else {
1517
+			throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1518
+		}
1519
+	}
1520
+
1521
+	/**
1522
+	 * Returns a list of pivot tables linked to $bean.
1523
+	 *
1524
+	 * @param AbstractTDBMObject $bean
1525
+	 *
1526
+	 * @return string[]
1527
+	 */
1528
+	public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1529
+	{
1530
+		$junctionTables = [];
1531
+		$allJunctionTables = $this->schemaAnalyzer->detectJunctionTables();
1532
+		foreach ($bean->_getDbRows() as $dbRow) {
1533
+			foreach ($allJunctionTables as $table) {
1534
+				// There are exactly 2 FKs since this is a pivot table.
1535
+				$fks = array_values($table->getForeignKeys());
1536
+
1537
+				if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1538
+					$junctionTables[] = $table->getName();
1539
+				}
1540
+			}
1541
+		}
1542
+
1543
+		return $junctionTables;
1544
+	}
1545 1545
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/Utils/TDBMDaoGenerator.php 4 patches
Unused Use Statements   -1 removed lines patch added patch discarded remove patch
@@ -4,7 +4,6 @@
 block discarded – undo
4 4
 
5 5
 use Doctrine\Common\Inflector\Inflector;
6 6
 use Doctrine\DBAL\Driver\Connection;
7
-use Doctrine\DBAL\Schema\Column;
8 7
 use Doctrine\DBAL\Schema\Schema;
9 8
 use Doctrine\DBAL\Schema\Table;
10 9
 use Doctrine\DBAL\Types\Type;
Please login to merge, or discard this patch.
Doc Comments   +5 added lines, -2 removed lines patch added patch discarded remove patch
@@ -147,7 +147,7 @@  discard block
 block discarded – undo
147 147
     /**
148 148
      * Returns the name of the base bean class from the table name.
149 149
      *
150
-     * @param $tableName
150
+     * @param string $tableName
151 151
      *
152 152
      * @return string
153 153
      */
@@ -159,7 +159,7 @@  discard block
 block discarded – undo
159 159
     /**
160 160
      * Returns the name of the base DAO class from the table name.
161 161
      *
162
-     * @param $tableName
162
+     * @param string $tableName
163 163
      *
164 164
      * @return string
165 165
      */
@@ -176,6 +176,7 @@  discard block
 block discarded – undo
176 176
      * @param Table           $table           The table
177 177
      * @param string          $beannamespace   The namespace of the bean
178 178
      * @param ClassNameMapper $classNameMapper
179
+     * @param boolean $storeInUtc
179 180
      *
180 181
      * @throws TDBMException
181 182
      */
@@ -486,6 +487,8 @@  discard block
 block discarded – undo
486 487
      * Generates the factory bean.
487 488
      *
488 489
      * @param Table[] $tableList
490
+     * @param string $daoFactoryClassName
491
+     * @param string $daoNamespace
489 492
      */
490 493
     private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
491 494
     {
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -77,11 +77,11 @@  discard block
 block discarded – undo
77 77
 
78 78
         // Remove all beans and daos from junction tables
79 79
         $junctionTables = $this->schemaAnalyzer->detectJunctionTables();
80
-        $junctionTableNames = array_map(function (Table $table) {
80
+        $junctionTableNames = array_map(function(Table $table) {
81 81
             return $table->getName();
82 82
         }, $junctionTables);
83 83
 
84
-        $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
84
+        $tableList = array_filter($tableList, function(Table $table) use ($junctionTableNames) {
85 85
             return !in_array($table->getName(), $junctionTableNames);
86 86
         });
87 87
 
@@ -94,7 +94,7 @@  discard block
 block discarded – undo
94 94
         // Ok, let's return the list of all tables.
95 95
         // These will be used by the calling script to create Mouf instances.
96 96
 
97
-        return array_map(function (Table $table) { return $table->getName(); }, $tableList);
97
+        return array_map(function(Table $table) { return $table->getName(); }, $tableList);
98 98
     }
99 99
 
100 100
     /**
@@ -287,7 +287,7 @@  discard block
 block discarded – undo
287 287
         $usedBeans[] = $beanClassName;
288 288
         // Let's suppress duplicates in used beans (if any)
289 289
         $usedBeans = array_flip(array_flip($usedBeans));
290
-        $useStatements = array_map(function ($usedBean) {
290
+        $useStatements = array_map(function($usedBean) {
291 291
             return "use $usedBean;\n";
292 292
         }, $usedBeans);
293 293
 
@@ -587,7 +587,7 @@  discard block
 block discarded – undo
587 587
                 $pos = strpos($str, ' ');
588 588
             }
589 589
             $before = substr($str, 0, $pos);
590
-            $after = substr($str, $pos + 1);
590
+            $after = substr($str, $pos+1);
591 591
             $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
592 592
         }
593 593
 
Please login to merge, or discard this patch.
Indentation   +466 added lines, -466 removed lines patch added patch discarded remove patch
@@ -17,197 +17,197 @@  discard block
 block discarded – undo
17 17
  */
18 18
 class TDBMDaoGenerator
19 19
 {
20
-    /**
21
-     * @var SchemaAnalyzer
22
-     */
23
-    private $schemaAnalyzer;
24
-
25
-    /**
26
-     * @var Schema
27
-     */
28
-    private $schema;
29
-
30
-    /**
31
-     * The root directory of the project.
32
-     *
33
-     * @var string
34
-     */
35
-    private $rootPath;
36
-
37
-    /**
38
-     * @var TDBMSchemaAnalyzer
39
-     */
40
-    private $tdbmSchemaAnalyzer;
41
-
42
-    /**
43
-     * Constructor.
44
-     *
45
-     * @param SchemaAnalyzer     $schemaAnalyzer
46
-     * @param Schema             $schema
47
-     * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
48
-     */
49
-    public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
50
-    {
51
-        $this->schemaAnalyzer = $schemaAnalyzer;
52
-        $this->schema = $schema;
53
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
54
-        $this->rootPath = __DIR__.'/../../../../../../../../';
55
-    }
56
-
57
-    /**
58
-     * Generates all the daos and beans.
59
-     *
60
-     * @param string $daoFactoryClassName The classe name of the DAO factory
61
-     * @param string $daonamespace        The namespace for the DAOs, without trailing \
62
-     * @param string $beannamespace       The Namespace for the beans, without trailing \
63
-     * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
64
-     *
65
-     * @return \string[] the list of tables
66
-     *
67
-     * @throws TDBMException
68
-     */
69
-    public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc)
70
-    {
71
-        // TODO: extract ClassNameMapper in its own package!
72
-        $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.'composer.json');
73
-
74
-        // TODO: check that no class name ends with "Base". Otherwise, there will be name clash.
75
-
76
-        $tableList = $this->schema->getTables();
77
-
78
-        // Remove all beans and daos from junction tables
79
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables();
80
-        $junctionTableNames = array_map(function (Table $table) {
81
-            return $table->getName();
82
-        }, $junctionTables);
83
-
84
-        $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
85
-            return !in_array($table->getName(), $junctionTableNames);
86
-        });
87
-
88
-        foreach ($tableList as $table) {
89
-            $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc);
90
-        }
91
-
92
-        $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper);
93
-
94
-        // Ok, let's return the list of all tables.
95
-        // These will be used by the calling script to create Mouf instances.
96
-
97
-        return array_map(function (Table $table) { return $table->getName(); }, $tableList);
98
-    }
99
-
100
-    /**
101
-     * Generates in one method call the daos and the beans for one table.
102
-     *
103
-     * @param Table           $table
104
-     * @param string          $daonamespace
105
-     * @param string          $beannamespace
106
-     * @param ClassNameMapper $classNameMapper
107
-     * @param bool            $storeInUtc
108
-     *
109
-     * @throws TDBMException
110
-     */
111
-    public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
112
-    {
113
-        $tableName = $table->getName();
114
-        $daoName = $this->getDaoNameFromTableName($tableName);
115
-        $beanName = $this->getBeanNameFromTableName($tableName);
116
-        $baseBeanName = $this->getBaseBeanNameFromTableName($tableName);
117
-        $baseDaoName = $this->getBaseDaoNameFromTableName($tableName);
118
-
119
-        $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer);
120
-
121
-        $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc);
122
-        $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper);
123
-    }
124
-
125
-    /**
126
-     * Returns the name of the bean class from the table name.
127
-     *
128
-     * @param $tableName
129
-     *
130
-     * @return string
131
-     */
132
-    public static function getBeanNameFromTableName($tableName)
133
-    {
134
-        return self::toSingular(self::toCamelCase($tableName)).'Bean';
135
-    }
136
-
137
-    /**
138
-     * Returns the name of the DAO class from the table name.
139
-     *
140
-     * @param $tableName
141
-     *
142
-     * @return string
143
-     */
144
-    public static function getDaoNameFromTableName($tableName)
145
-    {
146
-        return self::toSingular(self::toCamelCase($tableName)).'Dao';
147
-    }
148
-
149
-    /**
150
-     * Returns the name of the base bean class from the table name.
151
-     *
152
-     * @param $tableName
153
-     *
154
-     * @return string
155
-     */
156
-    public static function getBaseBeanNameFromTableName($tableName)
157
-    {
158
-        return self::toSingular(self::toCamelCase($tableName)).'BaseBean';
159
-    }
160
-
161
-    /**
162
-     * Returns the name of the base DAO class from the table name.
163
-     *
164
-     * @param $tableName
165
-     *
166
-     * @return string
167
-     */
168
-    public static function getBaseDaoNameFromTableName($tableName)
169
-    {
170
-        return self::toSingular(self::toCamelCase($tableName)).'BaseDao';
171
-    }
172
-
173
-    /**
174
-     * Writes the PHP bean file with all getters and setters from the table passed in parameter.
175
-     *
176
-     * @param BeanDescriptor  $beanDescriptor
177
-     * @param string          $className       The name of the class
178
-     * @param string          $baseClassName   The name of the base class which will be extended (name only, no directory)
179
-     * @param Table           $table           The table
180
-     * @param string          $beannamespace   The namespace of the bean
181
-     * @param ClassNameMapper $classNameMapper
182
-     *
183
-     * @throws TDBMException
184
-     */
185
-    public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
186
-    {
187
-        $str = $beanDescriptor->generatePhpCode($beannamespace);
188
-
189
-        $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$baseClassName);
190
-        if (empty($possibleBaseFileNames)) {
191
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.');
192
-        }
193
-        $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
194
-
195
-        $this->ensureDirectoryExist($possibleBaseFileName);
196
-        file_put_contents($possibleBaseFileName, $str);
197
-        @chmod($possibleBaseFileName, 0664);
198
-
199
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className);
200
-        if (empty($possibleFileNames)) {
201
-            // @codeCoverageIgnoreStart
202
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.');
203
-            // @codeCoverageIgnoreEnd
204
-        }
205
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
206
-
207
-        if (!file_exists($possibleFileName)) {
208
-            $tableName = $table->getName();
209
-
210
-            $str = "<?php
20
+	/**
21
+	 * @var SchemaAnalyzer
22
+	 */
23
+	private $schemaAnalyzer;
24
+
25
+	/**
26
+	 * @var Schema
27
+	 */
28
+	private $schema;
29
+
30
+	/**
31
+	 * The root directory of the project.
32
+	 *
33
+	 * @var string
34
+	 */
35
+	private $rootPath;
36
+
37
+	/**
38
+	 * @var TDBMSchemaAnalyzer
39
+	 */
40
+	private $tdbmSchemaAnalyzer;
41
+
42
+	/**
43
+	 * Constructor.
44
+	 *
45
+	 * @param SchemaAnalyzer     $schemaAnalyzer
46
+	 * @param Schema             $schema
47
+	 * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
48
+	 */
49
+	public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
50
+	{
51
+		$this->schemaAnalyzer = $schemaAnalyzer;
52
+		$this->schema = $schema;
53
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
54
+		$this->rootPath = __DIR__.'/../../../../../../../../';
55
+	}
56
+
57
+	/**
58
+	 * Generates all the daos and beans.
59
+	 *
60
+	 * @param string $daoFactoryClassName The classe name of the DAO factory
61
+	 * @param string $daonamespace        The namespace for the DAOs, without trailing \
62
+	 * @param string $beannamespace       The Namespace for the beans, without trailing \
63
+	 * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
64
+	 *
65
+	 * @return \string[] the list of tables
66
+	 *
67
+	 * @throws TDBMException
68
+	 */
69
+	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc)
70
+	{
71
+		// TODO: extract ClassNameMapper in its own package!
72
+		$classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.'composer.json');
73
+
74
+		// TODO: check that no class name ends with "Base". Otherwise, there will be name clash.
75
+
76
+		$tableList = $this->schema->getTables();
77
+
78
+		// Remove all beans and daos from junction tables
79
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables();
80
+		$junctionTableNames = array_map(function (Table $table) {
81
+			return $table->getName();
82
+		}, $junctionTables);
83
+
84
+		$tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
85
+			return !in_array($table->getName(), $junctionTableNames);
86
+		});
87
+
88
+		foreach ($tableList as $table) {
89
+			$this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc);
90
+		}
91
+
92
+		$this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper);
93
+
94
+		// Ok, let's return the list of all tables.
95
+		// These will be used by the calling script to create Mouf instances.
96
+
97
+		return array_map(function (Table $table) { return $table->getName(); }, $tableList);
98
+	}
99
+
100
+	/**
101
+	 * Generates in one method call the daos and the beans for one table.
102
+	 *
103
+	 * @param Table           $table
104
+	 * @param string          $daonamespace
105
+	 * @param string          $beannamespace
106
+	 * @param ClassNameMapper $classNameMapper
107
+	 * @param bool            $storeInUtc
108
+	 *
109
+	 * @throws TDBMException
110
+	 */
111
+	public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
112
+	{
113
+		$tableName = $table->getName();
114
+		$daoName = $this->getDaoNameFromTableName($tableName);
115
+		$beanName = $this->getBeanNameFromTableName($tableName);
116
+		$baseBeanName = $this->getBaseBeanNameFromTableName($tableName);
117
+		$baseDaoName = $this->getBaseDaoNameFromTableName($tableName);
118
+
119
+		$beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer);
120
+
121
+		$this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc);
122
+		$this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper);
123
+	}
124
+
125
+	/**
126
+	 * Returns the name of the bean class from the table name.
127
+	 *
128
+	 * @param $tableName
129
+	 *
130
+	 * @return string
131
+	 */
132
+	public static function getBeanNameFromTableName($tableName)
133
+	{
134
+		return self::toSingular(self::toCamelCase($tableName)).'Bean';
135
+	}
136
+
137
+	/**
138
+	 * Returns the name of the DAO class from the table name.
139
+	 *
140
+	 * @param $tableName
141
+	 *
142
+	 * @return string
143
+	 */
144
+	public static function getDaoNameFromTableName($tableName)
145
+	{
146
+		return self::toSingular(self::toCamelCase($tableName)).'Dao';
147
+	}
148
+
149
+	/**
150
+	 * Returns the name of the base bean class from the table name.
151
+	 *
152
+	 * @param $tableName
153
+	 *
154
+	 * @return string
155
+	 */
156
+	public static function getBaseBeanNameFromTableName($tableName)
157
+	{
158
+		return self::toSingular(self::toCamelCase($tableName)).'BaseBean';
159
+	}
160
+
161
+	/**
162
+	 * Returns the name of the base DAO class from the table name.
163
+	 *
164
+	 * @param $tableName
165
+	 *
166
+	 * @return string
167
+	 */
168
+	public static function getBaseDaoNameFromTableName($tableName)
169
+	{
170
+		return self::toSingular(self::toCamelCase($tableName)).'BaseDao';
171
+	}
172
+
173
+	/**
174
+	 * Writes the PHP bean file with all getters and setters from the table passed in parameter.
175
+	 *
176
+	 * @param BeanDescriptor  $beanDescriptor
177
+	 * @param string          $className       The name of the class
178
+	 * @param string          $baseClassName   The name of the base class which will be extended (name only, no directory)
179
+	 * @param Table           $table           The table
180
+	 * @param string          $beannamespace   The namespace of the bean
181
+	 * @param ClassNameMapper $classNameMapper
182
+	 *
183
+	 * @throws TDBMException
184
+	 */
185
+	public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
186
+	{
187
+		$str = $beanDescriptor->generatePhpCode($beannamespace);
188
+
189
+		$possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$baseClassName);
190
+		if (empty($possibleBaseFileNames)) {
191
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.');
192
+		}
193
+		$possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
194
+
195
+		$this->ensureDirectoryExist($possibleBaseFileName);
196
+		file_put_contents($possibleBaseFileName, $str);
197
+		@chmod($possibleBaseFileName, 0664);
198
+
199
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className);
200
+		if (empty($possibleFileNames)) {
201
+			// @codeCoverageIgnoreStart
202
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.');
203
+			// @codeCoverageIgnoreEnd
204
+		}
205
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
206
+
207
+		if (!file_exists($possibleFileName)) {
208
+			$tableName = $table->getName();
209
+
210
+			$str = "<?php
211 211
 /*
212 212
  * This file has been automatically generated by TDBM.
213 213
  * You can edit this file as it will not be overwritten.
@@ -222,76 +222,76 @@  discard block
 block discarded – undo
222 222
 {
223 223
 
224 224
 }";
225
-            $this->ensureDirectoryExist($possibleFileName);
226
-            file_put_contents($possibleFileName, $str);
227
-            @chmod($possibleFileName, 0664);
228
-        }
229
-    }
230
-
231
-    /**
232
-     * Tries to find a @defaultSort annotation in one of the columns.
233
-     *
234
-     * @param Table $table
235
-     *
236
-     * @return array First item: column name, Second item: column order (asc/desc)
237
-     */
238
-    private function getDefaultSortColumnFromAnnotation(Table $table)
239
-    {
240
-        $defaultSort = null;
241
-        $defaultSortDirection = null;
242
-        foreach ($table->getColumns() as $column) {
243
-            $comments = $column->getComment();
244
-            $matches = [];
245
-            if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
246
-                $defaultSort = $column->getName();
247
-                if (count($matches) === 3) {
248
-                    $defaultSortDirection = $matches[2];
249
-                } else {
250
-                    $defaultSortDirection = 'ASC';
251
-                }
252
-            }
253
-        }
254
-
255
-        return [$defaultSort, $defaultSortDirection];
256
-    }
257
-
258
-    /**
259
-     * Writes the PHP bean DAO with simple functions to create/get/save objects.
260
-     *
261
-     * @param BeanDescriptor  $beanDescriptor
262
-     * @param string          $className       The name of the class
263
-     * @param string          $baseClassName
264
-     * @param string          $beanClassName
265
-     * @param Table           $table
266
-     * @param string          $daonamespace
267
-     * @param string          $beannamespace
268
-     * @param ClassNameMapper $classNameMapper
269
-     *
270
-     * @throws TDBMException
271
-     */
272
-    public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper)
273
-    {
274
-        $tableName = $table->getName();
275
-        $primaryKeyColumns = $table->getPrimaryKeyColumns();
276
-
277
-        list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table);
278
-
279
-        // FIXME: lowercase tables with _ in the name should work!
280
-        $tableCamel = self::toSingular(self::toCamelCase($tableName));
281
-
282
-        $beanClassWithoutNameSpace = $beanClassName;
283
-        $beanClassName = $beannamespace.'\\'.$beanClassName;
284
-
285
-        list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace);
286
-
287
-        $usedBeans[] = $beanClassName;
288
-        // Let's suppress duplicates in used beans (if any)
289
-        $usedBeans = array_flip(array_flip($usedBeans));
290
-        $useStatements = array_map(function ($usedBean) {
291
-            return "use $usedBean;\n";
292
-        }, $usedBeans);
293
-
294
-        $str = "<?php
225
+			$this->ensureDirectoryExist($possibleFileName);
226
+			file_put_contents($possibleFileName, $str);
227
+			@chmod($possibleFileName, 0664);
228
+		}
229
+	}
230
+
231
+	/**
232
+	 * Tries to find a @defaultSort annotation in one of the columns.
233
+	 *
234
+	 * @param Table $table
235
+	 *
236
+	 * @return array First item: column name, Second item: column order (asc/desc)
237
+	 */
238
+	private function getDefaultSortColumnFromAnnotation(Table $table)
239
+	{
240
+		$defaultSort = null;
241
+		$defaultSortDirection = null;
242
+		foreach ($table->getColumns() as $column) {
243
+			$comments = $column->getComment();
244
+			$matches = [];
245
+			if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
246
+				$defaultSort = $column->getName();
247
+				if (count($matches) === 3) {
248
+					$defaultSortDirection = $matches[2];
249
+				} else {
250
+					$defaultSortDirection = 'ASC';
251
+				}
252
+			}
253
+		}
254
+
255
+		return [$defaultSort, $defaultSortDirection];
256
+	}
257
+
258
+	/**
259
+	 * Writes the PHP bean DAO with simple functions to create/get/save objects.
260
+	 *
261
+	 * @param BeanDescriptor  $beanDescriptor
262
+	 * @param string          $className       The name of the class
263
+	 * @param string          $baseClassName
264
+	 * @param string          $beanClassName
265
+	 * @param Table           $table
266
+	 * @param string          $daonamespace
267
+	 * @param string          $beannamespace
268
+	 * @param ClassNameMapper $classNameMapper
269
+	 *
270
+	 * @throws TDBMException
271
+	 */
272
+	public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper)
273
+	{
274
+		$tableName = $table->getName();
275
+		$primaryKeyColumns = $table->getPrimaryKeyColumns();
276
+
277
+		list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table);
278
+
279
+		// FIXME: lowercase tables with _ in the name should work!
280
+		$tableCamel = self::toSingular(self::toCamelCase($tableName));
281
+
282
+		$beanClassWithoutNameSpace = $beanClassName;
283
+		$beanClassName = $beannamespace.'\\'.$beanClassName;
284
+
285
+		list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace);
286
+
287
+		$usedBeans[] = $beanClassName;
288
+		// Let's suppress duplicates in used beans (if any)
289
+		$usedBeans = array_flip(array_flip($usedBeans));
290
+		$useStatements = array_map(function ($usedBean) {
291
+			return "use $usedBean;\n";
292
+		}, $usedBeans);
293
+
294
+		$str = "<?php
295 295
 
296 296
 /*
297 297
  * This file has been automatically generated by TDBM.
@@ -368,9 +368,9 @@  discard block
 block discarded – undo
368 368
     }
369 369
     ";
370 370
 
371
-        if (count($primaryKeyColumns) === 1) {
372
-            $primaryKeyColumn = $primaryKeyColumns[0];
373
-            $str .= "
371
+		if (count($primaryKeyColumns) === 1) {
372
+			$primaryKeyColumn = $primaryKeyColumns[0];
373
+			$str .= "
374 374
     /**
375 375
      * Get $beanClassWithoutNameSpace specified by its ID (its primary key)
376 376
      * If the primary key does not exist, an exception is thrown.
@@ -385,8 +385,8 @@  discard block
 block discarded – undo
385 385
         return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading);
386 386
     }
387 387
     ";
388
-        }
389
-        $str .= "
388
+		}
389
+		$str .= "
390 390
     /**
391 391
      * Deletes the $beanClassWithoutNameSpace passed in parameter.
392 392
      *
@@ -444,33 +444,33 @@  discard block
 block discarded – undo
444 444
     }
445 445
 ";
446 446
 
447
-        $str .= $findByDaoCode;
448
-        $str .= '}
447
+		$str .= $findByDaoCode;
448
+		$str .= '}
449 449
 ';
450 450
 
451
-        $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$baseClassName);
452
-        if (empty($possibleBaseFileNames)) {
453
-            // @codeCoverageIgnoreStart
454
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.');
455
-            // @codeCoverageIgnoreEnd
456
-        }
457
-        $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
458
-
459
-        $this->ensureDirectoryExist($possibleBaseFileName);
460
-        file_put_contents($possibleBaseFileName, $str);
461
-        @chmod($possibleBaseFileName, 0664);
462
-
463
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className);
464
-        if (empty($possibleFileNames)) {
465
-            // @codeCoverageIgnoreStart
466
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.');
467
-            // @codeCoverageIgnoreEnd
468
-        }
469
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
470
-
471
-        // Now, let's generate the "editable" class
472
-        if (!file_exists($possibleFileName)) {
473
-            $str = "<?php
451
+		$possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$baseClassName);
452
+		if (empty($possibleBaseFileNames)) {
453
+			// @codeCoverageIgnoreStart
454
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.');
455
+			// @codeCoverageIgnoreEnd
456
+		}
457
+		$possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
458
+
459
+		$this->ensureDirectoryExist($possibleBaseFileName);
460
+		file_put_contents($possibleBaseFileName, $str);
461
+		@chmod($possibleBaseFileName, 0664);
462
+
463
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className);
464
+		if (empty($possibleFileNames)) {
465
+			// @codeCoverageIgnoreStart
466
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.');
467
+			// @codeCoverageIgnoreEnd
468
+		}
469
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
470
+
471
+		// Now, let's generate the "editable" class
472
+		if (!file_exists($possibleFileName)) {
473
+			$str = "<?php
474 474
 
475 475
 /*
476 476
  * This file has been automatically generated by TDBM.
@@ -487,22 +487,22 @@  discard block
 block discarded – undo
487 487
 
488 488
 }
489 489
 ";
490
-            $this->ensureDirectoryExist($possibleFileName);
491
-            file_put_contents($possibleFileName, $str);
492
-            @chmod($possibleFileName, 0664);
493
-        }
494
-    }
495
-
496
-    /**
497
-     * Generates the factory bean.
498
-     *
499
-     * @param Table[] $tableList
500
-     */
501
-    private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
502
-    {
503
-        // For each table, let's write a property.
504
-
505
-        $str = "<?php
490
+			$this->ensureDirectoryExist($possibleFileName);
491
+			file_put_contents($possibleFileName, $str);
492
+			@chmod($possibleFileName, 0664);
493
+		}
494
+	}
495
+
496
+	/**
497
+	 * Generates the factory bean.
498
+	 *
499
+	 * @param Table[] $tableList
500
+	 */
501
+	private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
502
+	{
503
+		// For each table, let's write a property.
504
+
505
+		$str = "<?php
506 506
 
507 507
 /*
508 508
  * This file has been automatically generated by TDBM.
@@ -519,12 +519,12 @@  discard block
 block discarded – undo
519 519
 {
520 520
 ";
521 521
 
522
-        foreach ($tableList as $table) {
523
-            $tableName = $table->getName();
524
-            $daoClassName = $this->getDaoNameFromTableName($tableName);
525
-            $daoInstanceName = self::toVariableName($daoClassName);
522
+		foreach ($tableList as $table) {
523
+			$tableName = $table->getName();
524
+			$daoClassName = $this->getDaoNameFromTableName($tableName);
525
+			$daoInstanceName = self::toVariableName($daoClassName);
526 526
 
527
-            $str .= '    /**
527
+			$str .= '    /**
528 528
      * @var '.$daoClassName.'
529 529
      */
530 530
     private $'.$daoInstanceName.';
@@ -549,163 +549,163 @@  discard block
 block discarded – undo
549 549
     }
550 550
 
551 551
 ';
552
-        }
552
+		}
553 553
 
554
-        $str .= '
554
+		$str .= '
555 555
 }
556 556
 ';
557 557
 
558
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\'.$daoFactoryClassName);
559
-        if (empty($possibleFileNames)) {
560
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.');
561
-        }
562
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
563
-
564
-        $this->ensureDirectoryExist($possibleFileName);
565
-        file_put_contents($possibleFileName, $str);
566
-        @chmod($possibleFileName, 0664);
567
-    }
568
-
569
-    /**
570
-     * Transforms a string to camelCase (except the first letter will be uppercase too).
571
-     * Underscores and spaces are removed and the first letter after the underscore is uppercased.
572
-     *
573
-     * @param $str string
574
-     *
575
-     * @return string
576
-     */
577
-    public static function toCamelCase($str)
578
-    {
579
-        $str = strtoupper(substr($str, 0, 1)).substr($str, 1);
580
-        while (true) {
581
-            if (strpos($str, '_') === false && strpos($str, ' ') === false) {
582
-                break;
583
-            }
584
-
585
-            $pos = strpos($str, '_');
586
-            if ($pos === false) {
587
-                $pos = strpos($str, ' ');
588
-            }
589
-            $before = substr($str, 0, $pos);
590
-            $after = substr($str, $pos + 1);
591
-            $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
592
-        }
593
-
594
-        return $str;
595
-    }
596
-
597
-    /**
598
-     * Tries to put string to the singular form (if it is plural).
599
-     * We assume the table names are in english.
600
-     *
601
-     * @param $str string
602
-     *
603
-     * @return string
604
-     */
605
-    public static function toSingular($str)
606
-    {
607
-        return Inflector::singularize($str);
608
-    }
609
-
610
-    /**
611
-     * Put the first letter of the string in lower case.
612
-     * Very useful to transform a class name into a variable name.
613
-     *
614
-     * @param $str string
615
-     *
616
-     * @return string
617
-     */
618
-    public static function toVariableName($str)
619
-    {
620
-        return strtolower(substr($str, 0, 1)).substr($str, 1);
621
-    }
622
-
623
-    /**
624
-     * Ensures the file passed in parameter can be written in its directory.
625
-     *
626
-     * @param string $fileName
627
-     *
628
-     * @throws TDBMException
629
-     */
630
-    private function ensureDirectoryExist($fileName)
631
-    {
632
-        $dirName = dirname($fileName);
633
-        if (!file_exists($dirName)) {
634
-            $old = umask(0);
635
-            $result = mkdir($dirName, 0775, true);
636
-            umask($old);
637
-            if ($result === false) {
638
-                throw new TDBMException("Unable to create directory: '".$dirName."'.");
639
-            }
640
-        }
641
-    }
642
-
643
-    /**
644
-     * @param string $rootPath
645
-     */
646
-    public function setRootPath($rootPath)
647
-    {
648
-        $this->rootPath = $rootPath;
649
-    }
650
-
651
-    /**
652
-     * @return string
653
-     */
654
-    public function getRootPath()
655
-    {
656
-        return $this->rootPath;
657
-    }
558
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\'.$daoFactoryClassName);
559
+		if (empty($possibleFileNames)) {
560
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.');
561
+		}
562
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
563
+
564
+		$this->ensureDirectoryExist($possibleFileName);
565
+		file_put_contents($possibleFileName, $str);
566
+		@chmod($possibleFileName, 0664);
567
+	}
568
+
569
+	/**
570
+	 * Transforms a string to camelCase (except the first letter will be uppercase too).
571
+	 * Underscores and spaces are removed and the first letter after the underscore is uppercased.
572
+	 *
573
+	 * @param $str string
574
+	 *
575
+	 * @return string
576
+	 */
577
+	public static function toCamelCase($str)
578
+	{
579
+		$str = strtoupper(substr($str, 0, 1)).substr($str, 1);
580
+		while (true) {
581
+			if (strpos($str, '_') === false && strpos($str, ' ') === false) {
582
+				break;
583
+			}
584
+
585
+			$pos = strpos($str, '_');
586
+			if ($pos === false) {
587
+				$pos = strpos($str, ' ');
588
+			}
589
+			$before = substr($str, 0, $pos);
590
+			$after = substr($str, $pos + 1);
591
+			$str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
592
+		}
593
+
594
+		return $str;
595
+	}
596
+
597
+	/**
598
+	 * Tries to put string to the singular form (if it is plural).
599
+	 * We assume the table names are in english.
600
+	 *
601
+	 * @param $str string
602
+	 *
603
+	 * @return string
604
+	 */
605
+	public static function toSingular($str)
606
+	{
607
+		return Inflector::singularize($str);
608
+	}
609
+
610
+	/**
611
+	 * Put the first letter of the string in lower case.
612
+	 * Very useful to transform a class name into a variable name.
613
+	 *
614
+	 * @param $str string
615
+	 *
616
+	 * @return string
617
+	 */
618
+	public static function toVariableName($str)
619
+	{
620
+		return strtolower(substr($str, 0, 1)).substr($str, 1);
621
+	}
622
+
623
+	/**
624
+	 * Ensures the file passed in parameter can be written in its directory.
625
+	 *
626
+	 * @param string $fileName
627
+	 *
628
+	 * @throws TDBMException
629
+	 */
630
+	private function ensureDirectoryExist($fileName)
631
+	{
632
+		$dirName = dirname($fileName);
633
+		if (!file_exists($dirName)) {
634
+			$old = umask(0);
635
+			$result = mkdir($dirName, 0775, true);
636
+			umask($old);
637
+			if ($result === false) {
638
+				throw new TDBMException("Unable to create directory: '".$dirName."'.");
639
+			}
640
+		}
641
+	}
642
+
643
+	/**
644
+	 * @param string $rootPath
645
+	 */
646
+	public function setRootPath($rootPath)
647
+	{
648
+		$this->rootPath = $rootPath;
649
+	}
650
+
651
+	/**
652
+	 * @return string
653
+	 */
654
+	public function getRootPath()
655
+	{
656
+		return $this->rootPath;
657
+	}
658 658
     
659
-    /**
660
-     * Transforms a DBAL type into a PHP type (for PHPDoc purpose).
661
-     *
662
-     * @param Type $type The DBAL type
663
-     *
664
-     * @return string The PHP type
665
-     */
666
-    public static function dbalTypeToPhpType(Type $type)
667
-    {
668
-        $map = [
669
-            Type::TARRAY => 'array',
670
-            Type::SIMPLE_ARRAY => 'array',
671
-            Type::JSON_ARRAY => 'array',
672
-            Type::BIGINT => 'string',
673
-            Type::BOOLEAN => 'bool',
674
-            Type::DATETIME => '\DateTimeInterface',
675
-            Type::DATETIMETZ => '\DateTimeInterface',
676
-            Type::DATE => '\DateTimeInterface',
677
-            Type::TIME => '\DateTimeInterface',
678
-            Type::DECIMAL => 'float',
679
-            Type::INTEGER => 'int',
680
-            Type::OBJECT => 'string',
681
-            Type::SMALLINT => 'int',
682
-            Type::STRING => 'string',
683
-            Type::TEXT => 'string',
684
-            Type::BINARY => 'string',
685
-            Type::BLOB => 'string',
686
-            Type::FLOAT => 'float',
687
-            Type::GUID => 'string',
688
-        ];
689
-
690
-        return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
691
-    }
692
-
693
-    /**
694
-     * @param string $beanNamespace
695
-     *
696
-     * @return \string[] Returns a map mapping table name to beans name
697
-     */
698
-    public function buildTableToBeanMap($beanNamespace)
699
-    {
700
-        $tableToBeanMap = [];
701
-
702
-        $tables = $this->schema->getTables();
703
-
704
-        foreach ($tables as $table) {
705
-            $tableName = $table->getName();
706
-            $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName);
707
-        }
708
-
709
-        return $tableToBeanMap;
710
-    }
659
+	/**
660
+	 * Transforms a DBAL type into a PHP type (for PHPDoc purpose).
661
+	 *
662
+	 * @param Type $type The DBAL type
663
+	 *
664
+	 * @return string The PHP type
665
+	 */
666
+	public static function dbalTypeToPhpType(Type $type)
667
+	{
668
+		$map = [
669
+			Type::TARRAY => 'array',
670
+			Type::SIMPLE_ARRAY => 'array',
671
+			Type::JSON_ARRAY => 'array',
672
+			Type::BIGINT => 'string',
673
+			Type::BOOLEAN => 'bool',
674
+			Type::DATETIME => '\DateTimeInterface',
675
+			Type::DATETIMETZ => '\DateTimeInterface',
676
+			Type::DATE => '\DateTimeInterface',
677
+			Type::TIME => '\DateTimeInterface',
678
+			Type::DECIMAL => 'float',
679
+			Type::INTEGER => 'int',
680
+			Type::OBJECT => 'string',
681
+			Type::SMALLINT => 'int',
682
+			Type::STRING => 'string',
683
+			Type::TEXT => 'string',
684
+			Type::BINARY => 'string',
685
+			Type::BLOB => 'string',
686
+			Type::FLOAT => 'float',
687
+			Type::GUID => 'string',
688
+		];
689
+
690
+		return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
691
+	}
692
+
693
+	/**
694
+	 * @param string $beanNamespace
695
+	 *
696
+	 * @return \string[] Returns a map mapping table name to beans name
697
+	 */
698
+	public function buildTableToBeanMap($beanNamespace)
699
+	{
700
+		$tableToBeanMap = [];
701
+
702
+		$tables = $this->schema->getTables();
703
+
704
+		foreach ($tables as $table) {
705
+			$tableName = $table->getName();
706
+			$tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName);
707
+		}
708
+
709
+		return $tableToBeanMap;
710
+	}
711 711
 }
Please login to merge, or discard this patch.
src/views/installStep2.php 1 patch
Indentation   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -8,7 +8,7 @@
 block discarded – undo
8 8
 <input type="hidden" id="selfedit" name="selfedit" value="<?php echo plainstring_to_htmlprotected($this->selfedit) ?>" />
9 9
 
10 10
 <?php if (!$this->autoloadDetected) {
11
-    ?>
11
+	?>
12 12
 <div class="alert">Warning! TDBM could not detect the autoload section of your composer.json file.
13 13
 Unless you are developing your own autoload system, you should configure <strong>composer.json</strong> to <a href="http://getcomposer.org/doc/01-basic-usage.md#autoloading" target="_blank">define a source directory and a root namespace using PSR-0</a>.</div>
14 14
 <?php 
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/TDBMSchemaAnalyzer.php 2 patches
Indentation   +132 added lines, -132 removed lines patch added patch discarded remove patch
@@ -14,136 +14,136 @@
 block discarded – undo
14 14
  */
15 15
 class TDBMSchemaAnalyzer
16 16
 {
17
-    private $connection;
18
-
19
-    /**
20
-     * @var Schema
21
-     */
22
-    private $schema;
23
-
24
-    /**
25
-     * @var string
26
-     */
27
-    private $cachePrefix;
28
-
29
-    /**
30
-     * @var Cache
31
-     */
32
-    private $cache;
33
-
34
-    /**
35
-     * @var SchemaAnalyzer
36
-     */
37
-    private $schemaAnalyzer;
38
-
39
-    /**
40
-     * @param Connection     $connection     The DBAL DB connection to use
41
-     * @param Cache          $cache          A cache service to be used
42
-     * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
43
-     *                                       Will be automatically created if not passed.
44
-     */
45
-    public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer)
46
-    {
47
-        $this->connection = $connection;
48
-        $this->cache = $cache;
49
-        $this->schemaAnalyzer = $schemaAnalyzer;
50
-    }
51
-
52
-    /**
53
-     * Returns a unique ID for the current connection. Useful for namespacing cache entries in the current connection.
54
-     *
55
-     * @return string
56
-     */
57
-    public function getCachePrefix()
58
-    {
59
-        if ($this->cachePrefix === null) {
60
-            $this->cachePrefix = hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
61
-        }
62
-
63
-        return $this->cachePrefix;
64
-    }
65
-
66
-    /**
67
-     * Returns the (cached) schema.
68
-     *
69
-     * @return Schema
70
-     */
71
-    public function getSchema()
72
-    {
73
-        if ($this->schema === null) {
74
-            $cacheKey = $this->getCachePrefix().'_schema';
75
-            if ($this->cache->contains($cacheKey)) {
76
-                $this->schema = $this->cache->fetch($cacheKey);
77
-            } else {
78
-                $this->schema = $this->connection->getSchemaManager()->createSchema();
79
-                $this->cache->save($cacheKey, $this->schema);
80
-            }
81
-        }
82
-
83
-        return $this->schema;
84
-    }
85
-
86
-    /**
87
-     * Returns the list of pivot tables linked to table $tableName.
88
-     *
89
-     * @param string $tableName
90
-     *
91
-     * @return array|string[]
92
-     */
93
-    public function getPivotTableLinkedToTable($tableName)
94
-    {
95
-        $cacheKey = $this->getCachePrefix().'_pivottables_link';
96
-        if ($this->cache->contains($cacheKey)) {
97
-            return $this->cache->fetch($cacheKey);
98
-        }
99
-
100
-        $pivotTables = [];
101
-
102
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables();
103
-        foreach ($junctionTables as $table) {
104
-            $fks = $table->getForeignKeys();
105
-            foreach ($fks as $fk) {
106
-                if ($fk->getForeignTableName() == $tableName) {
107
-                    $pivotTables[] = $table->getName();
108
-                    break;
109
-                }
110
-            }
111
-        }
112
-
113
-        $this->cache->save($cacheKey, $pivotTables);
114
-
115
-        return $pivotTables;
116
-    }
117
-
118
-    /**
119
-     * Returns the list of foreign keys pointing to the table represented by this bean, excluding foreign keys
120
-     * from junction tables and from inheritance.
121
-     *
122
-     * @return ForeignKeyConstraint[]
123
-     */
124
-    public function getIncomingForeignKeys($tableName)
125
-    {
126
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables();
127
-        $junctionTableNames = array_map(function (Table $table) { return $table->getName(); }, $junctionTables);
128
-        $childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName);
129
-
130
-        $fks = [];
131
-        foreach ($this->getSchema()->getTables() as $table) {
132
-            foreach ($table->getForeignKeys() as $fk) {
133
-                if ($fk->getForeignTableName() === $tableName) {
134
-                    if (in_array($fk->getLocalTableName(), $junctionTableNames)) {
135
-                        continue;
136
-                    }
137
-                    foreach ($childrenRelationships as $childFk) {
138
-                        if ($fk->getLocalTableName() === $childFk->getLocalTableName() && $fk->getLocalColumns() === $childFk->getLocalColumns()) {
139
-                            continue 2;
140
-                        }
141
-                    }
142
-                    $fks[] = $fk;
143
-                }
144
-            }
145
-        }
146
-
147
-        return $fks;
148
-    }
17
+	private $connection;
18
+
19
+	/**
20
+	 * @var Schema
21
+	 */
22
+	private $schema;
23
+
24
+	/**
25
+	 * @var string
26
+	 */
27
+	private $cachePrefix;
28
+
29
+	/**
30
+	 * @var Cache
31
+	 */
32
+	private $cache;
33
+
34
+	/**
35
+	 * @var SchemaAnalyzer
36
+	 */
37
+	private $schemaAnalyzer;
38
+
39
+	/**
40
+	 * @param Connection     $connection     The DBAL DB connection to use
41
+	 * @param Cache          $cache          A cache service to be used
42
+	 * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
43
+	 *                                       Will be automatically created if not passed.
44
+	 */
45
+	public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer)
46
+	{
47
+		$this->connection = $connection;
48
+		$this->cache = $cache;
49
+		$this->schemaAnalyzer = $schemaAnalyzer;
50
+	}
51
+
52
+	/**
53
+	 * Returns a unique ID for the current connection. Useful for namespacing cache entries in the current connection.
54
+	 *
55
+	 * @return string
56
+	 */
57
+	public function getCachePrefix()
58
+	{
59
+		if ($this->cachePrefix === null) {
60
+			$this->cachePrefix = hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
61
+		}
62
+
63
+		return $this->cachePrefix;
64
+	}
65
+
66
+	/**
67
+	 * Returns the (cached) schema.
68
+	 *
69
+	 * @return Schema
70
+	 */
71
+	public function getSchema()
72
+	{
73
+		if ($this->schema === null) {
74
+			$cacheKey = $this->getCachePrefix().'_schema';
75
+			if ($this->cache->contains($cacheKey)) {
76
+				$this->schema = $this->cache->fetch($cacheKey);
77
+			} else {
78
+				$this->schema = $this->connection->getSchemaManager()->createSchema();
79
+				$this->cache->save($cacheKey, $this->schema);
80
+			}
81
+		}
82
+
83
+		return $this->schema;
84
+	}
85
+
86
+	/**
87
+	 * Returns the list of pivot tables linked to table $tableName.
88
+	 *
89
+	 * @param string $tableName
90
+	 *
91
+	 * @return array|string[]
92
+	 */
93
+	public function getPivotTableLinkedToTable($tableName)
94
+	{
95
+		$cacheKey = $this->getCachePrefix().'_pivottables_link';
96
+		if ($this->cache->contains($cacheKey)) {
97
+			return $this->cache->fetch($cacheKey);
98
+		}
99
+
100
+		$pivotTables = [];
101
+
102
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables();
103
+		foreach ($junctionTables as $table) {
104
+			$fks = $table->getForeignKeys();
105
+			foreach ($fks as $fk) {
106
+				if ($fk->getForeignTableName() == $tableName) {
107
+					$pivotTables[] = $table->getName();
108
+					break;
109
+				}
110
+			}
111
+		}
112
+
113
+		$this->cache->save($cacheKey, $pivotTables);
114
+
115
+		return $pivotTables;
116
+	}
117
+
118
+	/**
119
+	 * Returns the list of foreign keys pointing to the table represented by this bean, excluding foreign keys
120
+	 * from junction tables and from inheritance.
121
+	 *
122
+	 * @return ForeignKeyConstraint[]
123
+	 */
124
+	public function getIncomingForeignKeys($tableName)
125
+	{
126
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables();
127
+		$junctionTableNames = array_map(function (Table $table) { return $table->getName(); }, $junctionTables);
128
+		$childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName);
129
+
130
+		$fks = [];
131
+		foreach ($this->getSchema()->getTables() as $table) {
132
+			foreach ($table->getForeignKeys() as $fk) {
133
+				if ($fk->getForeignTableName() === $tableName) {
134
+					if (in_array($fk->getLocalTableName(), $junctionTableNames)) {
135
+						continue;
136
+					}
137
+					foreach ($childrenRelationships as $childFk) {
138
+						if ($fk->getLocalTableName() === $childFk->getLocalTableName() && $fk->getLocalColumns() === $childFk->getLocalColumns()) {
139
+							continue 2;
140
+						}
141
+					}
142
+					$fks[] = $fk;
143
+				}
144
+			}
145
+		}
146
+
147
+		return $fks;
148
+	}
149 149
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -124,7 +124,7 @@
 block discarded – undo
124 124
     public function getIncomingForeignKeys($tableName)
125 125
     {
126 126
         $junctionTables = $this->schemaAnalyzer->detectJunctionTables();
127
-        $junctionTableNames = array_map(function (Table $table) { return $table->getName(); }, $junctionTables);
127
+        $junctionTableNames = array_map(function(Table $table) { return $table->getName(); }, $junctionTables);
128 128
         $childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName);
129 129
 
130 130
         $fks = [];
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/WeakrefObjectStorage.php 1 patch
Indentation   +105 added lines, -105 removed lines patch added patch discarded remove patch
@@ -31,117 +31,117 @@
 block discarded – undo
31 31
  */
32 32
 class WeakrefObjectStorage
33 33
 {
34
-    /**
35
-     * An array of fetched object, accessible via table name and primary key.
36
-     * If the primary key is split on several columns, access is done by an array of columns, serialized.
37
-     *
38
-     * @var array<string, WeakMap<string, TDBMObject>>
39
-     */
40
-    private $objects = array();
34
+	/**
35
+	 * An array of fetched object, accessible via table name and primary key.
36
+	 * If the primary key is split on several columns, access is done by an array of columns, serialized.
37
+	 *
38
+	 * @var array<string, WeakMap<string, TDBMObject>>
39
+	 */
40
+	private $objects = array();
41 41
 
42
-    /**
43
-     * Every 10000 set in the dataset, we perform a cleanup to ensure the WeakRef instances
44
-     * are removed if they are no more valid.
45
-     * This is to avoid having memory used by dangling WeakRef instances.
46
-     *
47
-     * @var int
48
-     */
49
-    private $garbageCollectorCount = 0;
42
+	/**
43
+	 * Every 10000 set in the dataset, we perform a cleanup to ensure the WeakRef instances
44
+	 * are removed if they are no more valid.
45
+	 * This is to avoid having memory used by dangling WeakRef instances.
46
+	 *
47
+	 * @var int
48
+	 */
49
+	private $garbageCollectorCount = 0;
50 50
 
51
-    /**
52
-     * Sets an object in the storage.
53
-     *
54
-     * @param string $tableName
55
-     * @param string $id
56
-     * @param DbRow  $dbRow
57
-     */
58
-    public function set($tableName, $id, DbRow $dbRow)
59
-    {
60
-        $this->objects[$tableName][$id] = new \WeakRef($dbRow);
61
-        ++$this->garbageCollectorCount;
62
-        if ($this->garbageCollectorCount == 10000) {
63
-            $this->garbageCollectorCount = 0;
64
-            $this->cleanupDanglingWeakRefs();
65
-        }
66
-    }
51
+	/**
52
+	 * Sets an object in the storage.
53
+	 *
54
+	 * @param string $tableName
55
+	 * @param string $id
56
+	 * @param DbRow  $dbRow
57
+	 */
58
+	public function set($tableName, $id, DbRow $dbRow)
59
+	{
60
+		$this->objects[$tableName][$id] = new \WeakRef($dbRow);
61
+		++$this->garbageCollectorCount;
62
+		if ($this->garbageCollectorCount == 10000) {
63
+			$this->garbageCollectorCount = 0;
64
+			$this->cleanupDanglingWeakRefs();
65
+		}
66
+	}
67 67
 
68
-    /**
69
-     * Checks if an object is in the storage.
70
-     *
71
-     * @param string $tableName
72
-     * @param string $id
73
-     *
74
-     * @return bool
75
-     */
76
-    public function has($tableName, $id)
77
-    {
78
-        if (isset($this->objects[$tableName][$id])) {
79
-            if ($this->objects[$tableName][$id]->valid()) {
80
-                return true;
81
-            } else {
82
-                unset($this->objects[$tableName][$id]);
83
-            }
84
-        }
68
+	/**
69
+	 * Checks if an object is in the storage.
70
+	 *
71
+	 * @param string $tableName
72
+	 * @param string $id
73
+	 *
74
+	 * @return bool
75
+	 */
76
+	public function has($tableName, $id)
77
+	{
78
+		if (isset($this->objects[$tableName][$id])) {
79
+			if ($this->objects[$tableName][$id]->valid()) {
80
+				return true;
81
+			} else {
82
+				unset($this->objects[$tableName][$id]);
83
+			}
84
+		}
85 85
 
86
-        return false;
87
-    }
86
+		return false;
87
+	}
88 88
 
89
-    /**
90
-     * Returns an object from the storage (or null if no object is set).
91
-     *
92
-     * @param string $tableName
93
-     * @param string $id
94
-     *
95
-     * @return DbRow
96
-     */
97
-    public function get($tableName, $id)
98
-    {
99
-        if (isset($this->objects[$tableName][$id])) {
100
-            if ($this->objects[$tableName][$id]->valid()) {
101
-                return $this->objects[$tableName][$id]->get();
102
-            }
103
-        } else {
104
-            return;
105
-        }
106
-    }
89
+	/**
90
+	 * Returns an object from the storage (or null if no object is set).
91
+	 *
92
+	 * @param string $tableName
93
+	 * @param string $id
94
+	 *
95
+	 * @return DbRow
96
+	 */
97
+	public function get($tableName, $id)
98
+	{
99
+		if (isset($this->objects[$tableName][$id])) {
100
+			if ($this->objects[$tableName][$id]->valid()) {
101
+				return $this->objects[$tableName][$id]->get();
102
+			}
103
+		} else {
104
+			return;
105
+		}
106
+	}
107 107
 
108
-    /**
109
-     * Removes an object from the storage.
110
-     *
111
-     * @param string $tableName
112
-     * @param string $id
113
-     */
114
-    public function remove($tableName, $id)
115
-    {
116
-        unset($this->objects[$tableName][$id]);
117
-    }
108
+	/**
109
+	 * Removes an object from the storage.
110
+	 *
111
+	 * @param string $tableName
112
+	 * @param string $id
113
+	 */
114
+	public function remove($tableName, $id)
115
+	{
116
+		unset($this->objects[$tableName][$id]);
117
+	}
118 118
 
119
-    /**
120
-     * Applies the callback to all objects.
121
-     *
122
-     * @param callable $callback
123
-     */
124
-    public function apply(callable $callback)
125
-    {
126
-        foreach ($this->objects as $tableName => $table) {
127
-            foreach ($table as $id => $obj) {
128
-                if ($obj->valid()) {
129
-                    $callback($obj->get(), $tableName, $id);
130
-                } else {
131
-                    unset($this->objects[$tableName][$id]);
132
-                }
133
-            }
134
-        }
135
-    }
119
+	/**
120
+	 * Applies the callback to all objects.
121
+	 *
122
+	 * @param callable $callback
123
+	 */
124
+	public function apply(callable $callback)
125
+	{
126
+		foreach ($this->objects as $tableName => $table) {
127
+			foreach ($table as $id => $obj) {
128
+				if ($obj->valid()) {
129
+					$callback($obj->get(), $tableName, $id);
130
+				} else {
131
+					unset($this->objects[$tableName][$id]);
132
+				}
133
+			}
134
+		}
135
+	}
136 136
 
137
-    private function cleanupDanglingWeakRefs()
138
-    {
139
-        foreach ($this->objects as $tableName => $table) {
140
-            foreach ($table as $id => $obj) {
141
-                if (!$obj->valid()) {
142
-                    unset($this->objects[$tableName][$id]);
143
-                }
144
-            }
145
-        }
146
-    }
137
+	private function cleanupDanglingWeakRefs()
138
+	{
139
+		foreach ($this->objects as $tableName => $table) {
140
+			foreach ($table as $id => $obj) {
141
+				if (!$obj->valid()) {
142
+					unset($this->objects[$tableName][$id]);
143
+				}
144
+			}
145
+		}
146
+	}
147 147
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/Utils/AbstractBeanPropertyDescriptor.php 1 patch
Indentation   +111 added lines, -111 removed lines patch added patch discarded remove patch
@@ -9,115 +9,115 @@
 block discarded – undo
9 9
  */
10 10
 abstract class AbstractBeanPropertyDescriptor
11 11
 {
12
-    /**
13
-     * @var Table
14
-     */
15
-    protected $table;
16
-
17
-    /**
18
-     * Whether to use the more complex name in case of conflict.
19
-     *
20
-     * @var bool
21
-     */
22
-    protected $alternativeName = false;
23
-
24
-    /**
25
-     * @param Table $table
26
-     */
27
-    public function __construct(Table $table)
28
-    {
29
-        $this->table = $table;
30
-    }
31
-
32
-    /**
33
-     * Use the more complex name in case of conflict.
34
-     */
35
-    public function useAlternativeName()
36
-    {
37
-        $this->alternativeName = true;
38
-    }
39
-
40
-    /**
41
-     * Returns the name of the class linked to this property or null if this is not a foreign key.
42
-     *
43
-     * @return null|string
44
-     */
45
-    abstract public function getClassName();
46
-
47
-    /**
48
-     * Returns the param annotation for this property (useful for constructor).
49
-     *
50
-     * @return string
51
-     */
52
-    abstract public function getParamAnnotation();
53
-
54
-    public function getVariableName()
55
-    {
56
-        return '$'.$this->getLowerCamelCaseName();
57
-    }
58
-
59
-    public function getLowerCamelCaseName()
60
-    {
61
-        return TDBMDaoGenerator::toVariableName($this->getUpperCamelCaseName());
62
-    }
63
-
64
-    abstract public function getUpperCamelCaseName();
65
-
66
-    public function getSetterName()
67
-    {
68
-        return 'set'.$this->getUpperCamelCaseName();
69
-    }
70
-
71
-    public function getGetterName()
72
-    {
73
-        return 'get'.$this->getUpperCamelCaseName();
74
-    }
75
-
76
-    /**
77
-     * Returns the PHP code used in the ben constructor for this property.
78
-     *
79
-     * @return string
80
-     */
81
-    public function getConstructorAssignCode()
82
-    {
83
-        $str = '        $this->%s(%s);';
84
-
85
-        return sprintf($str, $this->getSetterName(), $this->getVariableName());
86
-    }
87
-
88
-    /**
89
-     * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
90
-     *
91
-     * @return bool
92
-     */
93
-    abstract public function isCompulsory();
94
-
95
-    /**
96
-     * Returns true if the property is the primary key.
97
-     *
98
-     * @return bool
99
-     */
100
-    abstract public function isPrimaryKey();
101
-
102
-    /**
103
-     * @return Table
104
-     */
105
-    public function getTable()
106
-    {
107
-        return $this->table;
108
-    }
109
-
110
-    /**
111
-     * Returns the PHP code for getters and setters.
112
-     *
113
-     * @return string
114
-     */
115
-    abstract public function getGetterSetterCode();
116
-
117
-    /**
118
-     * Returns the part of code useful when doing json serialization.
119
-     *
120
-     * @return string
121
-     */
122
-    abstract public function getJsonSerializeCode();
12
+	/**
13
+	 * @var Table
14
+	 */
15
+	protected $table;
16
+
17
+	/**
18
+	 * Whether to use the more complex name in case of conflict.
19
+	 *
20
+	 * @var bool
21
+	 */
22
+	protected $alternativeName = false;
23
+
24
+	/**
25
+	 * @param Table $table
26
+	 */
27
+	public function __construct(Table $table)
28
+	{
29
+		$this->table = $table;
30
+	}
31
+
32
+	/**
33
+	 * Use the more complex name in case of conflict.
34
+	 */
35
+	public function useAlternativeName()
36
+	{
37
+		$this->alternativeName = true;
38
+	}
39
+
40
+	/**
41
+	 * Returns the name of the class linked to this property or null if this is not a foreign key.
42
+	 *
43
+	 * @return null|string
44
+	 */
45
+	abstract public function getClassName();
46
+
47
+	/**
48
+	 * Returns the param annotation for this property (useful for constructor).
49
+	 *
50
+	 * @return string
51
+	 */
52
+	abstract public function getParamAnnotation();
53
+
54
+	public function getVariableName()
55
+	{
56
+		return '$'.$this->getLowerCamelCaseName();
57
+	}
58
+
59
+	public function getLowerCamelCaseName()
60
+	{
61
+		return TDBMDaoGenerator::toVariableName($this->getUpperCamelCaseName());
62
+	}
63
+
64
+	abstract public function getUpperCamelCaseName();
65
+
66
+	public function getSetterName()
67
+	{
68
+		return 'set'.$this->getUpperCamelCaseName();
69
+	}
70
+
71
+	public function getGetterName()
72
+	{
73
+		return 'get'.$this->getUpperCamelCaseName();
74
+	}
75
+
76
+	/**
77
+	 * Returns the PHP code used in the ben constructor for this property.
78
+	 *
79
+	 * @return string
80
+	 */
81
+	public function getConstructorAssignCode()
82
+	{
83
+		$str = '        $this->%s(%s);';
84
+
85
+		return sprintf($str, $this->getSetterName(), $this->getVariableName());
86
+	}
87
+
88
+	/**
89
+	 * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
90
+	 *
91
+	 * @return bool
92
+	 */
93
+	abstract public function isCompulsory();
94
+
95
+	/**
96
+	 * Returns true if the property is the primary key.
97
+	 *
98
+	 * @return bool
99
+	 */
100
+	abstract public function isPrimaryKey();
101
+
102
+	/**
103
+	 * @return Table
104
+	 */
105
+	public function getTable()
106
+	{
107
+		return $this->table;
108
+	}
109
+
110
+	/**
111
+	 * Returns the PHP code for getters and setters.
112
+	 *
113
+	 * @return string
114
+	 */
115
+	abstract public function getGetterSetterCode();
116
+
117
+	/**
118
+	 * Returns the part of code useful when doing json serialization.
119
+	 *
120
+	 * @return string
121
+	 */
122
+	abstract public function getJsonSerializeCode();
123 123
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/Utils/BeanDescriptor.php 2 patches
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -91,7 +91,7 @@  discard block
 block discarded – undo
91 91
      */
92 92
     public function getConstructorProperties()
93 93
     {
94
-        $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
94
+        $constructorProperties = array_filter($this->beanPropertyDescriptors, function(AbstractBeanPropertyDescriptor $property) {
95 95
            return $property->isCompulsory();
96 96
         });
97 97
 
@@ -105,7 +105,7 @@  discard block
 block discarded – undo
105 105
      */
106 106
     public function getExposedProperties()
107 107
     {
108
-        $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
108
+        $exposedProperties = array_filter($this->beanPropertyDescriptors, function(AbstractBeanPropertyDescriptor $property) {
109 109
             return $property->getTable()->getName() == $this->table->getName();
110 110
         });
111 111
 
@@ -271,7 +271,7 @@  discard block
 block discarded – undo
271 271
         $fksByMethodName = [];
272 272
 
273 273
         foreach ($fksByTable as $tableName => $fksForTable) {
274
-            if (count($fksForTable) > 1) {
274
+            if (count($fksForTable)>1) {
275 275
                 foreach ($fksForTable as $fk) {
276 276
                     $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
277 277
 
@@ -385,7 +385,7 @@  discard block
 block discarded – undo
385 385
 
386 386
         $finalDescs = [];
387 387
         foreach ($descs as $descArray) {
388
-            if (count($descArray) > 1) {
388
+            if (count($descArray)>1) {
389 389
                 foreach ($descArray as $desc) {
390 390
                     $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
391 391
                     $finalDescs[] = $desc;
Please login to merge, or discard this patch.
Indentation   +539 added lines, -539 removed lines patch added patch discarded remove patch
@@ -16,213 +16,213 @@  discard block
 block discarded – undo
16 16
  */
17 17
 class BeanDescriptor
18 18
 {
19
-    /**
20
-     * @var Table
21
-     */
22
-    private $table;
23
-
24
-    /**
25
-     * @var SchemaAnalyzer
26
-     */
27
-    private $schemaAnalyzer;
28
-
29
-    /**
30
-     * @var Schema
31
-     */
32
-    private $schema;
33
-
34
-    /**
35
-     * @var AbstractBeanPropertyDescriptor[]
36
-     */
37
-    private $beanPropertyDescriptors = [];
38
-
39
-    /**
40
-     * @var TDBMSchemaAnalyzer
41
-     */
42
-    private $tdbmSchemaAnalyzer;
43
-
44
-    public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
45
-    {
46
-        $this->table = $table;
47
-        $this->schemaAnalyzer = $schemaAnalyzer;
48
-        $this->schema = $schema;
49
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
50
-        $this->initBeanPropertyDescriptors();
51
-    }
52
-
53
-    private function initBeanPropertyDescriptors()
54
-    {
55
-        $this->beanPropertyDescriptors = $this->getProperties($this->table);
56
-    }
57
-
58
-    /**
59
-     * Returns the foreign-key the column is part of, if any. null otherwise.
60
-     *
61
-     * @param Table  $table
62
-     * @param Column $column
63
-     *
64
-     * @return ForeignKeyConstraint|null
65
-     */
66
-    private function isPartOfForeignKey(Table $table, Column $column)
67
-    {
68
-        $localColumnName = $column->getName();
69
-        foreach ($table->getForeignKeys() as $foreignKey) {
70
-            foreach ($foreignKey->getColumns() as $columnName) {
71
-                if ($columnName === $localColumnName) {
72
-                    return $foreignKey;
73
-                }
74
-            }
75
-        }
76
-
77
-        return;
78
-    }
79
-
80
-    /**
81
-     * @return AbstractBeanPropertyDescriptor[]
82
-     */
83
-    public function getBeanPropertyDescriptors()
84
-    {
85
-        return $this->beanPropertyDescriptors;
86
-    }
87
-
88
-    /**
89
-     * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent.
90
-     *
91
-     * @return AbstractBeanPropertyDescriptor[]
92
-     */
93
-    public function getConstructorProperties()
94
-    {
95
-        $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
96
-           return $property->isCompulsory();
97
-        });
98
-
99
-        return $constructorProperties;
100
-    }
101
-
102
-    /**
103
-     * Returns the list of properties exposed as getters and setters in this class.
104
-     *
105
-     * @return AbstractBeanPropertyDescriptor[]
106
-     */
107
-    public function getExposedProperties()
108
-    {
109
-        $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
110
-            return $property->getTable()->getName() == $this->table->getName();
111
-        });
112
-
113
-        return $exposedProperties;
114
-    }
115
-
116
-    /**
117
-     * Returns the list of properties for this table (including parent tables).
118
-     *
119
-     * @param Table $table
120
-     *
121
-     * @return AbstractBeanPropertyDescriptor[]
122
-     */
123
-    private function getProperties(Table $table)
124
-    {
125
-        $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
126
-        if ($parentRelationship) {
127
-            $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());
128
-            $properties = $this->getProperties($parentTable);
129
-            // we merge properties by overriding property names.
130
-            $localProperties = $this->getPropertiesForTable($table);
131
-            foreach ($localProperties as $name => $property) {
132
-                // We do not override properties if this is a primary key!
133
-                if ($property->isPrimaryKey()) {
134
-                    continue;
135
-                }
136
-                $properties[$name] = $property;
137
-            }
138
-        } else {
139
-            $properties = $this->getPropertiesForTable($table);
140
-        }
141
-
142
-        return $properties;
143
-    }
144
-
145
-    /**
146
-     * Returns the list of properties for this table (ignoring parent tables).
147
-     *
148
-     * @param Table $table
149
-     *
150
-     * @return AbstractBeanPropertyDescriptor[]
151
-     */
152
-    private function getPropertiesForTable(Table $table)
153
-    {
154
-        $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
155
-        if ($parentRelationship) {
156
-            $ignoreColumns = $parentRelationship->getLocalColumns();
157
-        } else {
158
-            $ignoreColumns = [];
159
-        }
160
-
161
-        $beanPropertyDescriptors = [];
162
-
163
-        foreach ($table->getColumns() as $column) {
164
-            if (array_search($column->getName(), $ignoreColumns) !== false) {
165
-                continue;
166
-            }
167
-
168
-            $fk = $this->isPartOfForeignKey($table, $column);
169
-            if ($fk !== null) {
170
-                // Check that previously added descriptors are not added on same FK (can happen with multi key FK).
171
-                foreach ($beanPropertyDescriptors as $beanDescriptor) {
172
-                    if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) {
173
-                        continue 2;
174
-                    }
175
-                }
176
-                // Check that this property is not an inheritance relationship
177
-                $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
178
-                if ($parentRelationship === $fk) {
179
-                    continue;
180
-                }
181
-
182
-                $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer);
183
-            } else {
184
-                $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column);
185
-            }
186
-        }
187
-
188
-        // Now, let's get the name of all properties and let's check there is no duplicate.
189
-        /** @var $names AbstractBeanPropertyDescriptor[] */
190
-        $names = [];
191
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
192
-            $name = $beanDescriptor->getUpperCamelCaseName();
193
-            if (isset($names[$name])) {
194
-                $names[$name]->useAlternativeName();
195
-                $beanDescriptor->useAlternativeName();
196
-            } else {
197
-                $names[$name] = $beanDescriptor;
198
-            }
199
-        }
200
-
201
-        // Final check (throw exceptions if problem arises)
202
-        $names = [];
203
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
204
-            $name = $beanDescriptor->getUpperCamelCaseName();
205
-            if (isset($names[$name])) {
206
-                throw new TDBMException('Unsolvable name conflict while generating method name');
207
-            } else {
208
-                $names[$name] = $beanDescriptor;
209
-            }
210
-        }
211
-
212
-        // Last step, let's rebuild the list with a map:
213
-        $beanPropertyDescriptorsMap = [];
214
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
215
-            $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor;
216
-        }
217
-
218
-        return $beanPropertyDescriptorsMap;
219
-    }
220
-
221
-    public function generateBeanConstructor()
222
-    {
223
-        $constructorProperties = $this->getConstructorProperties();
224
-
225
-        $constructorCode = '    /**
19
+	/**
20
+	 * @var Table
21
+	 */
22
+	private $table;
23
+
24
+	/**
25
+	 * @var SchemaAnalyzer
26
+	 */
27
+	private $schemaAnalyzer;
28
+
29
+	/**
30
+	 * @var Schema
31
+	 */
32
+	private $schema;
33
+
34
+	/**
35
+	 * @var AbstractBeanPropertyDescriptor[]
36
+	 */
37
+	private $beanPropertyDescriptors = [];
38
+
39
+	/**
40
+	 * @var TDBMSchemaAnalyzer
41
+	 */
42
+	private $tdbmSchemaAnalyzer;
43
+
44
+	public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
45
+	{
46
+		$this->table = $table;
47
+		$this->schemaAnalyzer = $schemaAnalyzer;
48
+		$this->schema = $schema;
49
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
50
+		$this->initBeanPropertyDescriptors();
51
+	}
52
+
53
+	private function initBeanPropertyDescriptors()
54
+	{
55
+		$this->beanPropertyDescriptors = $this->getProperties($this->table);
56
+	}
57
+
58
+	/**
59
+	 * Returns the foreign-key the column is part of, if any. null otherwise.
60
+	 *
61
+	 * @param Table  $table
62
+	 * @param Column $column
63
+	 *
64
+	 * @return ForeignKeyConstraint|null
65
+	 */
66
+	private function isPartOfForeignKey(Table $table, Column $column)
67
+	{
68
+		$localColumnName = $column->getName();
69
+		foreach ($table->getForeignKeys() as $foreignKey) {
70
+			foreach ($foreignKey->getColumns() as $columnName) {
71
+				if ($columnName === $localColumnName) {
72
+					return $foreignKey;
73
+				}
74
+			}
75
+		}
76
+
77
+		return;
78
+	}
79
+
80
+	/**
81
+	 * @return AbstractBeanPropertyDescriptor[]
82
+	 */
83
+	public function getBeanPropertyDescriptors()
84
+	{
85
+		return $this->beanPropertyDescriptors;
86
+	}
87
+
88
+	/**
89
+	 * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent.
90
+	 *
91
+	 * @return AbstractBeanPropertyDescriptor[]
92
+	 */
93
+	public function getConstructorProperties()
94
+	{
95
+		$constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
96
+		   return $property->isCompulsory();
97
+		});
98
+
99
+		return $constructorProperties;
100
+	}
101
+
102
+	/**
103
+	 * Returns the list of properties exposed as getters and setters in this class.
104
+	 *
105
+	 * @return AbstractBeanPropertyDescriptor[]
106
+	 */
107
+	public function getExposedProperties()
108
+	{
109
+		$exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
110
+			return $property->getTable()->getName() == $this->table->getName();
111
+		});
112
+
113
+		return $exposedProperties;
114
+	}
115
+
116
+	/**
117
+	 * Returns the list of properties for this table (including parent tables).
118
+	 *
119
+	 * @param Table $table
120
+	 *
121
+	 * @return AbstractBeanPropertyDescriptor[]
122
+	 */
123
+	private function getProperties(Table $table)
124
+	{
125
+		$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
126
+		if ($parentRelationship) {
127
+			$parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());
128
+			$properties = $this->getProperties($parentTable);
129
+			// we merge properties by overriding property names.
130
+			$localProperties = $this->getPropertiesForTable($table);
131
+			foreach ($localProperties as $name => $property) {
132
+				// We do not override properties if this is a primary key!
133
+				if ($property->isPrimaryKey()) {
134
+					continue;
135
+				}
136
+				$properties[$name] = $property;
137
+			}
138
+		} else {
139
+			$properties = $this->getPropertiesForTable($table);
140
+		}
141
+
142
+		return $properties;
143
+	}
144
+
145
+	/**
146
+	 * Returns the list of properties for this table (ignoring parent tables).
147
+	 *
148
+	 * @param Table $table
149
+	 *
150
+	 * @return AbstractBeanPropertyDescriptor[]
151
+	 */
152
+	private function getPropertiesForTable(Table $table)
153
+	{
154
+		$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
155
+		if ($parentRelationship) {
156
+			$ignoreColumns = $parentRelationship->getLocalColumns();
157
+		} else {
158
+			$ignoreColumns = [];
159
+		}
160
+
161
+		$beanPropertyDescriptors = [];
162
+
163
+		foreach ($table->getColumns() as $column) {
164
+			if (array_search($column->getName(), $ignoreColumns) !== false) {
165
+				continue;
166
+			}
167
+
168
+			$fk = $this->isPartOfForeignKey($table, $column);
169
+			if ($fk !== null) {
170
+				// Check that previously added descriptors are not added on same FK (can happen with multi key FK).
171
+				foreach ($beanPropertyDescriptors as $beanDescriptor) {
172
+					if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) {
173
+						continue 2;
174
+					}
175
+				}
176
+				// Check that this property is not an inheritance relationship
177
+				$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
178
+				if ($parentRelationship === $fk) {
179
+					continue;
180
+				}
181
+
182
+				$beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer);
183
+			} else {
184
+				$beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column);
185
+			}
186
+		}
187
+
188
+		// Now, let's get the name of all properties and let's check there is no duplicate.
189
+		/** @var $names AbstractBeanPropertyDescriptor[] */
190
+		$names = [];
191
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
192
+			$name = $beanDescriptor->getUpperCamelCaseName();
193
+			if (isset($names[$name])) {
194
+				$names[$name]->useAlternativeName();
195
+				$beanDescriptor->useAlternativeName();
196
+			} else {
197
+				$names[$name] = $beanDescriptor;
198
+			}
199
+		}
200
+
201
+		// Final check (throw exceptions if problem arises)
202
+		$names = [];
203
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
204
+			$name = $beanDescriptor->getUpperCamelCaseName();
205
+			if (isset($names[$name])) {
206
+				throw new TDBMException('Unsolvable name conflict while generating method name');
207
+			} else {
208
+				$names[$name] = $beanDescriptor;
209
+			}
210
+		}
211
+
212
+		// Last step, let's rebuild the list with a map:
213
+		$beanPropertyDescriptorsMap = [];
214
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
215
+			$beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor;
216
+		}
217
+
218
+		return $beanPropertyDescriptorsMap;
219
+	}
220
+
221
+	public function generateBeanConstructor()
222
+	{
223
+		$constructorProperties = $this->getConstructorProperties();
224
+
225
+		$constructorCode = '    /**
226 226
      * The constructor takes all compulsory arguments.
227 227
      *
228 228
 %s
@@ -232,65 +232,65 @@  discard block
 block discarded – undo
232 232
     }
233 233
     ';
234 234
 
235
-        $paramAnnotations = [];
236
-        $arguments = [];
237
-        $assigns = [];
238
-        $parentConstructorArguments = [];
239
-
240
-        foreach ($constructorProperties as $property) {
241
-            $className = $property->getClassName();
242
-            if ($className) {
243
-                $arguments[] = $className.' '.$property->getVariableName();
244
-            } else {
245
-                $arguments[] = $property->getVariableName();
246
-            }
247
-            $paramAnnotations[] = $property->getParamAnnotation();
248
-            if ($property->getTable()->getName() === $this->table->getName()) {
249
-                $assigns[] = $property->getConstructorAssignCode();
250
-            } else {
251
-                $parentConstructorArguments[] = $property->getVariableName();
252
-            }
253
-        }
254
-
255
-        $parentConstrutorCode = sprintf("        parent::__construct(%s);\n", implode(', ', $parentConstructorArguments));
256
-
257
-        return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstrutorCode, implode("\n", $assigns));
258
-    }
259
-
260
-    public function generateDirectForeignKeysCode()
261
-    {
262
-        $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
263
-
264
-        $fksByTable = [];
265
-
266
-        foreach ($fks as $fk) {
267
-            $fksByTable[$fk->getLocalTableName()][] = $fk;
268
-        }
269
-
270
-        /* @var $fksByMethodName ForeignKeyConstraint[] */
271
-        $fksByMethodName = [];
272
-
273
-        foreach ($fksByTable as $tableName => $fksForTable) {
274
-            if (count($fksForTable) > 1) {
275
-                foreach ($fksForTable as $fk) {
276
-                    $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
277
-
278
-                    $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns());
279
-
280
-                    $methodName .= implode('And', $camelizedColumns);
281
-
282
-                    $fksByMethodName[$methodName] = $fk;
283
-                }
284
-            } else {
285
-                $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName());
286
-                $fksByMethodName[$methodName] = $fksForTable[0];
287
-            }
288
-        }
289
-
290
-        $code = '';
291
-
292
-        foreach ($fksByMethodName as $methodName => $fk) {
293
-            $getterCode = '    /**
235
+		$paramAnnotations = [];
236
+		$arguments = [];
237
+		$assigns = [];
238
+		$parentConstructorArguments = [];
239
+
240
+		foreach ($constructorProperties as $property) {
241
+			$className = $property->getClassName();
242
+			if ($className) {
243
+				$arguments[] = $className.' '.$property->getVariableName();
244
+			} else {
245
+				$arguments[] = $property->getVariableName();
246
+			}
247
+			$paramAnnotations[] = $property->getParamAnnotation();
248
+			if ($property->getTable()->getName() === $this->table->getName()) {
249
+				$assigns[] = $property->getConstructorAssignCode();
250
+			} else {
251
+				$parentConstructorArguments[] = $property->getVariableName();
252
+			}
253
+		}
254
+
255
+		$parentConstrutorCode = sprintf("        parent::__construct(%s);\n", implode(', ', $parentConstructorArguments));
256
+
257
+		return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstrutorCode, implode("\n", $assigns));
258
+	}
259
+
260
+	public function generateDirectForeignKeysCode()
261
+	{
262
+		$fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
263
+
264
+		$fksByTable = [];
265
+
266
+		foreach ($fks as $fk) {
267
+			$fksByTable[$fk->getLocalTableName()][] = $fk;
268
+		}
269
+
270
+		/* @var $fksByMethodName ForeignKeyConstraint[] */
271
+		$fksByMethodName = [];
272
+
273
+		foreach ($fksByTable as $tableName => $fksForTable) {
274
+			if (count($fksForTable) > 1) {
275
+				foreach ($fksForTable as $fk) {
276
+					$methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
277
+
278
+					$camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns());
279
+
280
+					$methodName .= implode('And', $camelizedColumns);
281
+
282
+					$fksByMethodName[$methodName] = $fk;
283
+				}
284
+			} else {
285
+				$methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName());
286
+				$fksByMethodName[$methodName] = $fksForTable[0];
287
+			}
288
+		}
289
+
290
+		$code = '';
291
+
292
+		foreach ($fksByMethodName as $methodName => $fk) {
293
+			$getterCode = '    /**
294 294
      * Returns the list of %s pointing to this bean via the %s column.
295 295
      *
296 296
      * @return %s[]|ResultIterator
@@ -302,111 +302,111 @@  discard block
 block discarded – undo
302 302
 
303 303
 ';
304 304
 
305
-            list($sql, $parametersCode) = $this->getFilters($fk);
306
-
307
-            $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
308
-            $code .= sprintf($getterCode,
309
-                $beanClass,
310
-                implode(', ', $fk->getColumns()),
311
-                $beanClass,
312
-                $methodName,
313
-                var_export($fk->getLocalTableName(), true),
314
-                $sql,
315
-                $parametersCode
316
-            );
317
-        }
318
-
319
-        return $code;
320
-    }
321
-
322
-    private function getFilters(ForeignKeyConstraint $fk)
323
-    {
324
-        $sqlParts = [];
325
-        $counter = 0;
326
-        $parameters = [];
327
-
328
-        $pkColumns = $this->table->getPrimaryKeyColumns();
329
-
330
-        foreach ($fk->getLocalColumns() as $columnName) {
331
-            $paramName = 'tdbmparam'.$counter;
332
-            $sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName;
333
-
334
-            $pkColumn = $pkColumns[$counter];
335
-            $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true));
336
-            ++$counter;
337
-        }
338
-        $sql = "'".implode(' AND ', $sqlParts)."'";
339
-        $parametersCode = '[ '.implode(', ', $parameters).' ]';
340
-
341
-        return [$sql, $parametersCode];
342
-    }
343
-
344
-    /**
345
-     * Generate code section about pivot tables.
346
-     *
347
-     * @return string
348
-     */
349
-    public function generatePivotTableCode()
350
-    {
351
-        $finalDescs = $this->getPivotTableDescriptors();
352
-
353
-        $code = '';
354
-
355
-        foreach ($finalDescs as $desc) {
356
-            $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']);
357
-        }
358
-
359
-        return $code;
360
-    }
361
-
362
-    private function getPivotTableDescriptors()
363
-    {
364
-        $descs = [];
365
-        foreach ($this->schemaAnalyzer->detectJunctionTables() as $table) {
366
-            // There are exactly 2 FKs since this is a pivot table.
367
-            $fks = array_values($table->getForeignKeys());
368
-
369
-            if ($fks[0]->getForeignTableName() === $this->table->getName()) {
370
-                $localFK = $fks[0];
371
-                $remoteFK = $fks[1];
372
-            } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
373
-                $localFK = $fks[1];
374
-                $remoteFK = $fks[0];
375
-            } else {
376
-                continue;
377
-            }
378
-
379
-            $descs[$remoteFK->getForeignTableName()][] = [
380
-                'table' => $table,
381
-                'localFK' => $localFK,
382
-                'remoteFK' => $remoteFK,
383
-            ];
384
-        }
385
-
386
-        $finalDescs = [];
387
-        foreach ($descs as $descArray) {
388
-            if (count($descArray) > 1) {
389
-                foreach ($descArray as $desc) {
390
-                    $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
391
-                    $finalDescs[] = $desc;
392
-                }
393
-            } else {
394
-                $desc = $descArray[0];
395
-                $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName());
396
-                $finalDescs[] = $desc;
397
-            }
398
-        }
399
-
400
-        return $finalDescs;
401
-    }
402
-
403
-    public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK)
404
-    {
405
-        $singularName = TDBMDaoGenerator::toSingular($name);
406
-        $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
407
-        $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
408
-
409
-        $str = '    /**
305
+			list($sql, $parametersCode) = $this->getFilters($fk);
306
+
307
+			$beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
308
+			$code .= sprintf($getterCode,
309
+				$beanClass,
310
+				implode(', ', $fk->getColumns()),
311
+				$beanClass,
312
+				$methodName,
313
+				var_export($fk->getLocalTableName(), true),
314
+				$sql,
315
+				$parametersCode
316
+			);
317
+		}
318
+
319
+		return $code;
320
+	}
321
+
322
+	private function getFilters(ForeignKeyConstraint $fk)
323
+	{
324
+		$sqlParts = [];
325
+		$counter = 0;
326
+		$parameters = [];
327
+
328
+		$pkColumns = $this->table->getPrimaryKeyColumns();
329
+
330
+		foreach ($fk->getLocalColumns() as $columnName) {
331
+			$paramName = 'tdbmparam'.$counter;
332
+			$sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName;
333
+
334
+			$pkColumn = $pkColumns[$counter];
335
+			$parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true));
336
+			++$counter;
337
+		}
338
+		$sql = "'".implode(' AND ', $sqlParts)."'";
339
+		$parametersCode = '[ '.implode(', ', $parameters).' ]';
340
+
341
+		return [$sql, $parametersCode];
342
+	}
343
+
344
+	/**
345
+	 * Generate code section about pivot tables.
346
+	 *
347
+	 * @return string
348
+	 */
349
+	public function generatePivotTableCode()
350
+	{
351
+		$finalDescs = $this->getPivotTableDescriptors();
352
+
353
+		$code = '';
354
+
355
+		foreach ($finalDescs as $desc) {
356
+			$code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']);
357
+		}
358
+
359
+		return $code;
360
+	}
361
+
362
+	private function getPivotTableDescriptors()
363
+	{
364
+		$descs = [];
365
+		foreach ($this->schemaAnalyzer->detectJunctionTables() as $table) {
366
+			// There are exactly 2 FKs since this is a pivot table.
367
+			$fks = array_values($table->getForeignKeys());
368
+
369
+			if ($fks[0]->getForeignTableName() === $this->table->getName()) {
370
+				$localFK = $fks[0];
371
+				$remoteFK = $fks[1];
372
+			} elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
373
+				$localFK = $fks[1];
374
+				$remoteFK = $fks[0];
375
+			} else {
376
+				continue;
377
+			}
378
+
379
+			$descs[$remoteFK->getForeignTableName()][] = [
380
+				'table' => $table,
381
+				'localFK' => $localFK,
382
+				'remoteFK' => $remoteFK,
383
+			];
384
+		}
385
+
386
+		$finalDescs = [];
387
+		foreach ($descs as $descArray) {
388
+			if (count($descArray) > 1) {
389
+				foreach ($descArray as $desc) {
390
+					$desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
391
+					$finalDescs[] = $desc;
392
+				}
393
+			} else {
394
+				$desc = $descArray[0];
395
+				$desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName());
396
+				$finalDescs[] = $desc;
397
+			}
398
+		}
399
+
400
+		return $finalDescs;
401
+	}
402
+
403
+	public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK)
404
+	{
405
+		$singularName = TDBMDaoGenerator::toSingular($name);
406
+		$remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
407
+		$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
408
+
409
+		$str = '    /**
410 410
      * Returns the list of %s associated to this bean via the %s pivot table.
411 411
      *
412 412
      * @return %s[]
@@ -416,9 +416,9 @@  discard block
 block discarded – undo
416 416
     }
417 417
 ';
418 418
 
419
-        $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true));
419
+		$getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true));
420 420
 
421
-        $str = '    /**
421
+		$str = '    /**
422 422
      * Adds a relationship with %s associated to this bean via the %s pivot table.
423 423
      *
424 424
      * @param %s %s
@@ -428,9 +428,9 @@  discard block
 block discarded – undo
428 428
     }
429 429
 ';
430 430
 
431
-        $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
431
+		$adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
432 432
 
433
-        $str = '    /**
433
+		$str = '    /**
434 434
      * Deletes the relationship with %s associated to this bean via the %s pivot table.
435 435
      *
436 436
      * @param %s %s
@@ -440,9 +440,9 @@  discard block
 block discarded – undo
440 440
     }
441 441
 ';
442 442
 
443
-        $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
443
+		$removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
444 444
 
445
-        $str = '    /**
445
+		$str = '    /**
446 446
      * Returns whether this bean is associated with %s via the %s pivot table.
447 447
      *
448 448
      * @param %s %s
@@ -453,24 +453,24 @@  discard block
 block discarded – undo
453 453
     }
454 454
 ';
455 455
 
456
-        $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
456
+		$hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
457 457
 
458
-        $code = $getterCode.$adderCode.$removerCode.$hasCode;
458
+		$code = $getterCode.$adderCode.$removerCode.$hasCode;
459 459
 
460
-        return $code;
461
-    }
460
+		return $code;
461
+	}
462 462
 
463
-    public function generateJsonSerialize()
464
-    {
465
-        $tableName = $this->table->getName();
466
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
467
-        if ($parentFk !== null) {
468
-            $initializer = '$array = parent::jsonSerialize();';
469
-        } else {
470
-            $initializer = '$array = [];';
471
-        }
463
+	public function generateJsonSerialize()
464
+	{
465
+		$tableName = $this->table->getName();
466
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
467
+		if ($parentFk !== null) {
468
+			$initializer = '$array = parent::jsonSerialize();';
469
+		} else {
470
+			$initializer = '$array = [];';
471
+		}
472 472
 
473
-        $str = '
473
+		$str = '
474 474
     /**
475 475
      * Serializes the object for JSON encoding
476 476
      *
@@ -486,54 +486,54 @@  discard block
 block discarded – undo
486 486
     }
487 487
 ';
488 488
 
489
-        $propertiesCode = '';
490
-        foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
491
-            $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
492
-        }
489
+		$propertiesCode = '';
490
+		foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
491
+			$propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
492
+		}
493 493
 
494
-        // Many to many relationships:
494
+		// Many to many relationships:
495 495
 
496
-        $descs = $this->getPivotTableDescriptors();
496
+		$descs = $this->getPivotTableDescriptors();
497 497
 
498
-        $many2manyCode = '';
498
+		$many2manyCode = '';
499 499
 
500
-        foreach ($descs as $desc) {
501
-            $remoteFK = $desc['remoteFK'];
502
-            $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
503
-            $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
500
+		foreach ($descs as $desc) {
501
+			$remoteFK = $desc['remoteFK'];
502
+			$remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
503
+			$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
504 504
 
505
-            $many2manyCode .= '        if (!$stopRecursion) {
505
+			$many2manyCode .= '        if (!$stopRecursion) {
506 506
             $array[\''.lcfirst($desc['name']).'\'] = array_map(function('.$remoteBeanName.' '.$variableName.') {
507 507
                 return '.$variableName.'->jsonSerialize(true);
508 508
             }, $this->get'.$desc['name'].'());
509 509
         }
510 510
         ';
511
-        }
512
-
513
-        return sprintf($str, $initializer, $propertiesCode, $many2manyCode);
514
-    }
515
-
516
-    /**
517
-     * Writes the PHP bean file with all getters and setters from the table passed in parameter.
518
-     *
519
-     * @param string $beannamespace The namespace of the bean
520
-     */
521
-    public function generatePhpCode($beannamespace)
522
-    {
523
-        $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($this->table->getName());
524
-        $className = TDBMDaoGenerator::getBeanNameFromTableName($this->table->getName());
525
-        $tableName = $this->table->getName();
526
-
527
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
528
-        if ($parentFk !== null) {
529
-            $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
530
-            $use = '';
531
-        } else {
532
-            $extends = 'AbstractTDBMObject';
533
-            $use = "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n\n";
534
-        }
535
-
536
-        $str = "<?php
511
+		}
512
+
513
+		return sprintf($str, $initializer, $propertiesCode, $many2manyCode);
514
+	}
515
+
516
+	/**
517
+	 * Writes the PHP bean file with all getters and setters from the table passed in parameter.
518
+	 *
519
+	 * @param string $beannamespace The namespace of the bean
520
+	 */
521
+	public function generatePhpCode($beannamespace)
522
+	{
523
+		$baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($this->table->getName());
524
+		$className = TDBMDaoGenerator::getBeanNameFromTableName($this->table->getName());
525
+		$tableName = $this->table->getName();
526
+
527
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
528
+		if ($parentFk !== null) {
529
+			$extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
530
+			$use = '';
531
+		} else {
532
+			$extends = 'AbstractTDBMObject';
533
+			$use = "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n\n";
534
+		}
535
+
536
+		$str = "<?php
537 537
 namespace {$beannamespace};
538 538
 
539 539
 use Mouf\\Database\\TDBM\\ResultIterator;
@@ -551,122 +551,122 @@  discard block
 block discarded – undo
551 551
 {
552 552
 ";
553 553
 
554
-        $str .= $this->generateBeanConstructor();
554
+		$str .= $this->generateBeanConstructor();
555 555
 
556
-        foreach ($this->getExposedProperties() as $property) {
557
-            $str .= $property->getGetterSetterCode();
558
-        }
556
+		foreach ($this->getExposedProperties() as $property) {
557
+			$str .= $property->getGetterSetterCode();
558
+		}
559 559
 
560
-        $str .= $this->generateDirectForeignKeysCode();
561
-        $str .= $this->generatePivotTableCode();
562
-        $str .= $this->generateJsonSerialize();
560
+		$str .= $this->generateDirectForeignKeysCode();
561
+		$str .= $this->generatePivotTableCode();
562
+		$str .= $this->generateJsonSerialize();
563 563
 
564
-        $str .= '}
564
+		$str .= '}
565 565
 ';
566 566
 
567
-        return $str;
568
-    }
569
-
570
-    /**
571
-     * @param string $beanNamespace
572
-     * @param string $beanClassName
573
-     *
574
-     * @return array first element: list of used beans, second item: PHP code as a string
575
-     */
576
-    public function generateFindByDaoCode($beanNamespace, $beanClassName)
577
-    {
578
-        $code = '';
579
-        $usedBeans = [];
580
-        foreach ($this->table->getIndexes() as $index) {
581
-            if (!$index->isPrimary()) {
582
-                list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName);
583
-                $code .= $codeForIndex;
584
-                $usedBeans = array_merge($usedBeans, $usedBeansForIndex);
585
-            }
586
-        }
587
-
588
-        return [$usedBeans, $code];
589
-    }
590
-
591
-    /**
592
-     * @param Index  $index
593
-     * @param string $beanNamespace
594
-     * @param string $beanClassName
595
-     *
596
-     * @return array first element: list of used beans, second item: PHP code as a string
597
-     */
598
-    private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName)
599
-    {
600
-        $columns = $index->getColumns();
601
-        $usedBeans = [];
602
-
603
-        /*
567
+		return $str;
568
+	}
569
+
570
+	/**
571
+	 * @param string $beanNamespace
572
+	 * @param string $beanClassName
573
+	 *
574
+	 * @return array first element: list of used beans, second item: PHP code as a string
575
+	 */
576
+	public function generateFindByDaoCode($beanNamespace, $beanClassName)
577
+	{
578
+		$code = '';
579
+		$usedBeans = [];
580
+		foreach ($this->table->getIndexes() as $index) {
581
+			if (!$index->isPrimary()) {
582
+				list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName);
583
+				$code .= $codeForIndex;
584
+				$usedBeans = array_merge($usedBeans, $usedBeansForIndex);
585
+			}
586
+		}
587
+
588
+		return [$usedBeans, $code];
589
+	}
590
+
591
+	/**
592
+	 * @param Index  $index
593
+	 * @param string $beanNamespace
594
+	 * @param string $beanClassName
595
+	 *
596
+	 * @return array first element: list of used beans, second item: PHP code as a string
597
+	 */
598
+	private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName)
599
+	{
600
+		$columns = $index->getColumns();
601
+		$usedBeans = [];
602
+
603
+		/*
604 604
          * The list of elements building this index (expressed as columns or foreign keys)
605 605
          * @var AbstractBeanPropertyDescriptor[]
606 606
          */
607
-        $elements = [];
608
-
609
-        foreach ($columns as $column) {
610
-            $fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column));
611
-            if ($fk !== null) {
612
-                if (!in_array($fk, $elements)) {
613
-                    $elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer);
614
-                }
615
-            } else {
616
-                $elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column));
617
-            }
618
-        }
619
-
620
-        // If the index is actually only a foreign key, let's bypass it entirely.
621
-        if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) {
622
-            return [[], ''];
623
-        }
624
-
625
-        $methodNameComponent = [];
626
-        $functionParameters = [];
627
-        $first = true;
628
-        foreach ($elements as $element) {
629
-            $methodNameComponent[] = $element->getUpperCamelCaseName();
630
-            $functionParameter = $element->getClassName();
631
-            if ($functionParameter) {
632
-                $usedBeans[] = $beanNamespace.'\\'.$functionParameter;
633
-                $functionParameter .= ' ';
634
-            }
635
-            $functionParameter .= $element->getVariableName();
636
-            if ($first) {
637
-                $first = false;
638
-            } else {
639
-                $functionParameter .= ' = null';
640
-            }
641
-            $functionParameters[] = $functionParameter;
642
-        }
643
-        if ($index->isUnique()) {
644
-            $methodName = 'findOneBy'.implode('And', $methodNameComponent);
645
-            $calledMethod = 'findOne';
646
-        } else {
647
-            $methodName = 'findBy'.implode('And', $methodNameComponent);
648
-            $calledMethod = 'find';
649
-        }
650
-        $functionParametersString = implode(', ', $functionParameters);
651
-
652
-        $count = 0;
653
-
654
-        $params = [];
655
-        $filterArrayCode = '';
656
-        $commentArguments = [];
657
-        foreach ($elements as $element) {
658
-            $params[] = $element->getParamAnnotation();
659
-            if ($element instanceof ScalarBeanPropertyDescriptor) {
660
-                $filterArrayCode .= '            '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n";
661
-            } else {
662
-                ++$count;
663
-                $filterArrayCode .= '            '.$count.' => '.$element->getVariableName().",\n";
664
-            }
665
-            $commentArguments[] = substr($element->getVariableName(), 1);
666
-        }
667
-        $paramsString = implode("\n", $params);
668
-
669
-        $code = "
607
+		$elements = [];
608
+
609
+		foreach ($columns as $column) {
610
+			$fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column));
611
+			if ($fk !== null) {
612
+				if (!in_array($fk, $elements)) {
613
+					$elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer);
614
+				}
615
+			} else {
616
+				$elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column));
617
+			}
618
+		}
619
+
620
+		// If the index is actually only a foreign key, let's bypass it entirely.
621
+		if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) {
622
+			return [[], ''];
623
+		}
624
+
625
+		$methodNameComponent = [];
626
+		$functionParameters = [];
627
+		$first = true;
628
+		foreach ($elements as $element) {
629
+			$methodNameComponent[] = $element->getUpperCamelCaseName();
630
+			$functionParameter = $element->getClassName();
631
+			if ($functionParameter) {
632
+				$usedBeans[] = $beanNamespace.'\\'.$functionParameter;
633
+				$functionParameter .= ' ';
634
+			}
635
+			$functionParameter .= $element->getVariableName();
636
+			if ($first) {
637
+				$first = false;
638
+			} else {
639
+				$functionParameter .= ' = null';
640
+			}
641
+			$functionParameters[] = $functionParameter;
642
+		}
643
+		if ($index->isUnique()) {
644
+			$methodName = 'findOneBy'.implode('And', $methodNameComponent);
645
+			$calledMethod = 'findOne';
646
+		} else {
647
+			$methodName = 'findBy'.implode('And', $methodNameComponent);
648
+			$calledMethod = 'find';
649
+		}
650
+		$functionParametersString = implode(', ', $functionParameters);
651
+
652
+		$count = 0;
653
+
654
+		$params = [];
655
+		$filterArrayCode = '';
656
+		$commentArguments = [];
657
+		foreach ($elements as $element) {
658
+			$params[] = $element->getParamAnnotation();
659
+			if ($element instanceof ScalarBeanPropertyDescriptor) {
660
+				$filterArrayCode .= '            '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n";
661
+			} else {
662
+				++$count;
663
+				$filterArrayCode .= '            '.$count.' => '.$element->getVariableName().",\n";
664
+			}
665
+			$commentArguments[] = substr($element->getVariableName(), 1);
666
+		}
667
+		$paramsString = implode("\n", $params);
668
+
669
+		$code = "
670 670
     /**
671 671
      * Get a list of $beanClassName filtered by ".implode(', ', $commentArguments).".
672 672
      *
@@ -684,6 +684,6 @@  discard block
 block discarded – undo
684 684
     }
685 685
 ";
686 686
 
687
-        return [$usedBeans, $code];
688
-    }
687
+		return [$usedBeans, $code];
688
+	}
689 689
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/Utils/ObjectBeanPropertyDescriptor.php 2 patches
Indentation   +140 added lines, -140 removed lines patch added patch discarded remove patch
@@ -12,134 +12,134 @@  discard block
 block discarded – undo
12 12
  */
13 13
 class ObjectBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor
14 14
 {
15
-    /**
16
-     * @var ForeignKeyConstraint
17
-     */
18
-    private $foreignKey;
19
-
20
-    /**
21
-     * @var SchemaAnalyzer
22
-     */
23
-    private $schemaAnalyzer;
24
-
25
-    public function __construct(Table $table, ForeignKeyConstraint $foreignKey, SchemaAnalyzer $schemaAnalyzer)
26
-    {
27
-        parent::__construct($table);
28
-        $this->foreignKey = $foreignKey;
29
-        $this->schemaAnalyzer = $schemaAnalyzer;
30
-    }
31
-
32
-    /**
33
-     * Returns the foreignkey the column is part of, if any. null otherwise.
34
-     *
35
-     * @return ForeignKeyConstraint|null
36
-     */
37
-    public function getForeignKey()
38
-    {
39
-        return $this->foreignKey;
40
-    }
41
-
42
-    /**
43
-     * Returns the name of the class linked to this property or null if this is not a foreign key.
44
-     *
45
-     * @return null|string
46
-     */
47
-    public function getClassName()
48
-    {
49
-        return TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName());
50
-    }
51
-
52
-    /**
53
-     * Returns the param annotation for this property (useful for constructor).
54
-     *
55
-     * @return string
56
-     */
57
-    public function getParamAnnotation()
58
-    {
59
-        $str = '     * @param %s %s';
60
-
61
-        return sprintf($str, $this->getClassName(), $this->getVariableName());
62
-    }
63
-
64
-    public function getUpperCamelCaseName()
65
-    {
66
-        // First, are there many column or only one?
67
-        // If one column, we name the setter after it. Otherwise, we name the setter after the table name
68
-        if (count($this->foreignKey->getLocalColumns()) > 1) {
69
-            $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName()));
70
-            if ($this->alternativeName) {
71
-                $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns());
72
-
73
-                $name .= 'By'.implode('And', $camelizedColumns);
74
-            }
75
-        } else {
76
-            $column = $this->foreignKey->getLocalColumns()[0];
77
-            // Let's remove any _id or id_.
78
-            if (strpos(strtolower($column), 'id_') === 0) {
79
-                $column = substr($column, 3);
80
-            }
81
-            if (strrpos(strtolower($column), '_id') === strlen($column) - 3) {
82
-                $column = substr($column, 0, strlen($column) - 3);
83
-            }
84
-            $name = TDBMDaoGenerator::toCamelCase($column);
85
-            if ($this->alternativeName) {
86
-                $name .= 'Object';
87
-            }
88
-        }
89
-
90
-        return $name;
91
-    }
92
-
93
-    /**
94
-     * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
95
-     *
96
-     * @return bool
97
-     */
98
-    public function isCompulsory()
99
-    {
100
-        // Are all columns nullable?
101
-        $localColumnNames = $this->foreignKey->getLocalColumns();
102
-
103
-        foreach ($localColumnNames as $name) {
104
-            $column = $this->table->getColumn($name);
105
-            if ($column->getNotnull()) {
106
-                return true;
107
-            }
108
-        }
109
-
110
-        return false;
111
-    }
112
-
113
-    /**
114
-     * Returns true if the property is the primary key.
115
-     *
116
-     * @return bool
117
-     */
118
-    public function isPrimaryKey()
119
-    {
120
-        $fkColumns = $this->foreignKey->getLocalColumns();
121
-        sort($fkColumns);
122
-
123
-        $pkColumns = $this->table->getPrimaryKeyColumns();
124
-        sort($pkColumns);
125
-
126
-        return $fkColumns == $pkColumns;
127
-    }
128
-
129
-    /**
130
-     * Returns the PHP code for getters and setters.
131
-     *
132
-     * @return string
133
-     */
134
-    public function getGetterSetterCode()
135
-    {
136
-        $tableName = $this->table->getName();
137
-        $getterName = $this->getGetterName();
138
-        $setterName = $this->getSetterName();
139
-
140
-        $referencedBeanName = TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName());
141
-
142
-        $str = '    /**
15
+	/**
16
+	 * @var ForeignKeyConstraint
17
+	 */
18
+	private $foreignKey;
19
+
20
+	/**
21
+	 * @var SchemaAnalyzer
22
+	 */
23
+	private $schemaAnalyzer;
24
+
25
+	public function __construct(Table $table, ForeignKeyConstraint $foreignKey, SchemaAnalyzer $schemaAnalyzer)
26
+	{
27
+		parent::__construct($table);
28
+		$this->foreignKey = $foreignKey;
29
+		$this->schemaAnalyzer = $schemaAnalyzer;
30
+	}
31
+
32
+	/**
33
+	 * Returns the foreignkey the column is part of, if any. null otherwise.
34
+	 *
35
+	 * @return ForeignKeyConstraint|null
36
+	 */
37
+	public function getForeignKey()
38
+	{
39
+		return $this->foreignKey;
40
+	}
41
+
42
+	/**
43
+	 * Returns the name of the class linked to this property or null if this is not a foreign key.
44
+	 *
45
+	 * @return null|string
46
+	 */
47
+	public function getClassName()
48
+	{
49
+		return TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName());
50
+	}
51
+
52
+	/**
53
+	 * Returns the param annotation for this property (useful for constructor).
54
+	 *
55
+	 * @return string
56
+	 */
57
+	public function getParamAnnotation()
58
+	{
59
+		$str = '     * @param %s %s';
60
+
61
+		return sprintf($str, $this->getClassName(), $this->getVariableName());
62
+	}
63
+
64
+	public function getUpperCamelCaseName()
65
+	{
66
+		// First, are there many column or only one?
67
+		// If one column, we name the setter after it. Otherwise, we name the setter after the table name
68
+		if (count($this->foreignKey->getLocalColumns()) > 1) {
69
+			$name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName()));
70
+			if ($this->alternativeName) {
71
+				$camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns());
72
+
73
+				$name .= 'By'.implode('And', $camelizedColumns);
74
+			}
75
+		} else {
76
+			$column = $this->foreignKey->getLocalColumns()[0];
77
+			// Let's remove any _id or id_.
78
+			if (strpos(strtolower($column), 'id_') === 0) {
79
+				$column = substr($column, 3);
80
+			}
81
+			if (strrpos(strtolower($column), '_id') === strlen($column) - 3) {
82
+				$column = substr($column, 0, strlen($column) - 3);
83
+			}
84
+			$name = TDBMDaoGenerator::toCamelCase($column);
85
+			if ($this->alternativeName) {
86
+				$name .= 'Object';
87
+			}
88
+		}
89
+
90
+		return $name;
91
+	}
92
+
93
+	/**
94
+	 * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
95
+	 *
96
+	 * @return bool
97
+	 */
98
+	public function isCompulsory()
99
+	{
100
+		// Are all columns nullable?
101
+		$localColumnNames = $this->foreignKey->getLocalColumns();
102
+
103
+		foreach ($localColumnNames as $name) {
104
+			$column = $this->table->getColumn($name);
105
+			if ($column->getNotnull()) {
106
+				return true;
107
+			}
108
+		}
109
+
110
+		return false;
111
+	}
112
+
113
+	/**
114
+	 * Returns true if the property is the primary key.
115
+	 *
116
+	 * @return bool
117
+	 */
118
+	public function isPrimaryKey()
119
+	{
120
+		$fkColumns = $this->foreignKey->getLocalColumns();
121
+		sort($fkColumns);
122
+
123
+		$pkColumns = $this->table->getPrimaryKeyColumns();
124
+		sort($pkColumns);
125
+
126
+		return $fkColumns == $pkColumns;
127
+	}
128
+
129
+	/**
130
+	 * Returns the PHP code for getters and setters.
131
+	 *
132
+	 * @return string
133
+	 */
134
+	public function getGetterSetterCode()
135
+	{
136
+		$tableName = $this->table->getName();
137
+		$getterName = $this->getGetterName();
138
+		$setterName = $this->getSetterName();
139
+
140
+		$referencedBeanName = TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName());
141
+
142
+		$str = '    /**
143 143
      * Returns the '.$referencedBeanName.' object bound to this object via the '.implode(' and ', $this->foreignKey->getLocalColumns()).' column.
144 144
      *
145 145
      * @return '.$referencedBeanName.'
@@ -159,19 +159,19 @@  discard block
 block discarded – undo
159 159
 
160 160
 ';
161 161
 
162
-        return $str;
163
-    }
164
-
165
-    /**
166
-     * Returns the part of code useful when doing json serialization.
167
-     *
168
-     * @return string
169
-     */
170
-    public function getJsonSerializeCode()
171
-    {
172
-        return '        if (!$stopRecursion) {
162
+		return $str;
163
+	}
164
+
165
+	/**
166
+	 * Returns the part of code useful when doing json serialization.
167
+	 *
168
+	 * @return string
169
+	 */
170
+	public function getJsonSerializeCode()
171
+	{
172
+		return '        if (!$stopRecursion) {
173 173
             $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName().'()->jsonSerialize(true);
174 174
         }
175 175
 ';
176
-    }
176
+	}
177 177
 }
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -65,7 +65,7 @@  discard block
 block discarded – undo
65 65
     {
66 66
         // First, are there many column or only one?
67 67
         // If one column, we name the setter after it. Otherwise, we name the setter after the table name
68
-        if (count($this->foreignKey->getLocalColumns()) > 1) {
68
+        if (count($this->foreignKey->getLocalColumns())>1) {
69 69
             $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName()));
70 70
             if ($this->alternativeName) {
71 71
                 $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns());
@@ -78,8 +78,8 @@  discard block
 block discarded – undo
78 78
             if (strpos(strtolower($column), 'id_') === 0) {
79 79
                 $column = substr($column, 3);
80 80
             }
81
-            if (strrpos(strtolower($column), '_id') === strlen($column) - 3) {
82
-                $column = substr($column, 0, strlen($column) - 3);
81
+            if (strrpos(strtolower($column), '_id') === strlen($column)-3) {
82
+                $column = substr($column, 0, strlen($column)-3);
83 83
             }
84 84
             $name = TDBMDaoGenerator::toCamelCase($column);
85 85
             if ($this->alternativeName) {
Please login to merge, or discard this patch.