Passed
Push — fix_composer_logger_issue ( 617c3c )
by David
13:39 queued 06:48
created
src/Mouf/Database/TDBM/QueryFactory/FindObjectsQueryFactory.php 1 patch
Indentation   +38 added lines, -38 removed lines patch added patch discarded remove patch
@@ -11,44 +11,44 @@
 block discarded – undo
11 11
  */
12 12
 class FindObjectsQueryFactory extends AbstractQueryFactory
13 13
 {
14
-    private $mainTable;
15
-    private $additionalTablesFetch;
16
-    private $filterString;
17
-
18
-    public function __construct(string $mainTable, array $additionalTablesFetch, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer)
19
-    {
20
-        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
21
-        $this->mainTable = $mainTable;
22
-        $this->additionalTablesFetch = $additionalTablesFetch;
23
-        $this->filterString = $filterString;
24
-    }
25
-
26
-    protected function compute()
27
-    {
28
-        list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, $this->additionalTablesFetch, $this->orderBy);
29
-
30
-        $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$this->mainTable.')';
31
-
32
-        $pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
33
-        $pkColumnNames = array_map(function ($pkColumn) {
34
-            return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
35
-        }, $pkColumnNames);
36
-
37
-        $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM MAGICJOIN('.$this->mainTable.')';
38
-
39
-        if (!empty($this->filterString)) {
40
-            $sql .= ' WHERE '.$this->filterString;
41
-            $countSql .= ' WHERE '.$this->filterString;
42
-        }
43
-
44
-        if (!empty($orderString)) {
45
-            $sql .= ' ORDER BY '.$orderString;
46
-        }
47
-
48
-        $this->magicSql = $sql;
49
-        $this->magicSqlCount = $countSql;
50
-        $this->columnDescList = $columnDescList;
51
-    }
14
+	private $mainTable;
15
+	private $additionalTablesFetch;
16
+	private $filterString;
17
+
18
+	public function __construct(string $mainTable, array $additionalTablesFetch, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer)
19
+	{
20
+		parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
21
+		$this->mainTable = $mainTable;
22
+		$this->additionalTablesFetch = $additionalTablesFetch;
23
+		$this->filterString = $filterString;
24
+	}
25
+
26
+	protected function compute()
27
+	{
28
+		list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, $this->additionalTablesFetch, $this->orderBy);
29
+
30
+		$sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$this->mainTable.')';
31
+
32
+		$pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
33
+		$pkColumnNames = array_map(function ($pkColumn) {
34
+			return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
35
+		}, $pkColumnNames);
36
+
37
+		$countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM MAGICJOIN('.$this->mainTable.')';
38
+
39
+		if (!empty($this->filterString)) {
40
+			$sql .= ' WHERE '.$this->filterString;
41
+			$countSql .= ' WHERE '.$this->filterString;
42
+		}
43
+
44
+		if (!empty($orderString)) {
45
+			$sql .= ' ORDER BY '.$orderString;
46
+		}
47
+
48
+		$this->magicSql = $sql;
49
+		$this->magicSqlCount = $countSql;
50
+		$this->columnDescList = $columnDescList;
51
+	}
52 52
 
53 53
 
54 54
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/QueryFactory/QueryFactory.php 1 patch
Indentation   +18 added lines, -18 removed lines patch added patch discarded remove patch
@@ -9,25 +9,25 @@
 block discarded – undo
9 9
  */
10 10
 interface QueryFactory
11 11
 {
12
-    /**
13
-     * Sets the ORDER BY directive executed in SQL.
14
-     *
15
-     * For instance:
16
-     *
17
-     *  $queryFactory->sort('label ASC, status DESC');
18
-     *
19
-     * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
20
-     * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
21
-     *
22
-     *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
23
-     *
24
-     * @param string|UncheckedOrderBy|null $orderBy
25
-     */
26
-    public function sort($orderBy);
12
+	/**
13
+	 * Sets the ORDER BY directive executed in SQL.
14
+	 *
15
+	 * For instance:
16
+	 *
17
+	 *  $queryFactory->sort('label ASC, status DESC');
18
+	 *
19
+	 * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
20
+	 * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
21
+	 *
22
+	 *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
23
+	 *
24
+	 * @param string|UncheckedOrderBy|null $orderBy
25
+	 */
26
+	public function sort($orderBy);
27 27
 
28
-    public function getMagicSql() : string;
28
+	public function getMagicSql() : string;
29 29
 
30
-    public function getMagicSqlCount() : string;
30
+	public function getMagicSqlCount() : string;
31 31
 
32
-    public function getColumnDescriptors() : array;
32
+	public function getColumnDescriptors() : array;
33 33
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/ResultIterator.php 1 patch
Indentation   +281 added lines, -281 removed lines patch added patch discarded remove patch
@@ -32,285 +32,285 @@
 block discarded – undo
32 32
  */
33 33
 class ResultIterator implements Result, \ArrayAccess, \JsonSerializable
34 34
 {
35
-    /**
36
-     * @var Statement
37
-     */
38
-    protected $statement;
39
-
40
-    private $objectStorage;
41
-    private $className;
42
-
43
-    private $tdbmService;
44
-    private $parameters;
45
-    private $magicQuery;
46
-
47
-    /**
48
-     * @var QueryFactory
49
-     */
50
-    private $queryFactory;
51
-
52
-    /**
53
-     * @var InnerResultIterator
54
-     */
55
-    private $innerResultIterator;
56
-
57
-    private $databasePlatform;
58
-
59
-    private $totalCount;
60
-
61
-    private $mode;
62
-
63
-    private $logger;
64
-
65
-    public function __construct(QueryFactory $queryFactory, array $parameters, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode, LoggerInterface $logger)
66
-    {
67
-        if ($mode !== null && $mode !== TDBMService::MODE_CURSOR && $mode !== TDBMService::MODE_ARRAY) {
68
-            throw new TDBMException("Unknown fetch mode: '".$mode."'");
69
-        }
70
-
71
-        $this->queryFactory = $queryFactory;
72
-        $this->objectStorage = $objectStorage;
73
-        $this->className = $className;
74
-        $this->tdbmService = $tdbmService;
75
-        $this->parameters = $parameters;
76
-        $this->magicQuery = $magicQuery;
77
-        $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
78
-        $this->mode = $mode;
79
-        $this->logger = $logger;
80
-    }
81
-
82
-    protected function executeCountQuery()
83
-    {
84
-        $sql = $this->magicQuery->build($this->queryFactory->getMagicSqlCount(), $this->parameters);
85
-        $this->logger->debug('Running count query: '.$sql);
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->queryFactory->getMagicSql(), $this->parameters, null, null, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger);
140
-            } else {
141
-                $this->innerResultIterator = new InnerResultArray($this->queryFactory->getMagicSql(), $this->parameters, null, null, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger);
142
-            }
143
-        }
144
-
145
-        return $this->innerResultIterator;
146
-    }
147
-
148
-    /**
149
-     * @param int $offset
150
-     * @param int $limit
151
-     *
152
-     * @return PageIterator
153
-     */
154
-    public function take($offset, $limit)
155
-    {
156
-        return new PageIterator($this, $this->queryFactory->getMagicSql(), $this->parameters, $limit, $offset, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->mode, $this->logger);
157
-    }
158
-
159
-    /**
160
-     * Whether a offset exists.
161
-     *
162
-     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
163
-     *
164
-     * @param mixed $offset <p>
165
-     *                      An offset to check for.
166
-     *                      </p>
167
-     *
168
-     * @return bool true on success or false on failure.
169
-     *              </p>
170
-     *              <p>
171
-     *              The return value will be casted to boolean if non-boolean was returned
172
-     *
173
-     * @since 5.0.0
174
-     */
175
-    public function offsetExists($offset)
176
-    {
177
-        return $this->getIterator()->offsetExists($offset);
178
-    }
179
-
180
-    /**
181
-     * Offset to retrieve.
182
-     *
183
-     * @link http://php.net/manual/en/arrayaccess.offsetget.php
184
-     *
185
-     * @param mixed $offset <p>
186
-     *                      The offset to retrieve.
187
-     *                      </p>
188
-     *
189
-     * @return mixed Can return all value types
190
-     *
191
-     * @since 5.0.0
192
-     */
193
-    public function offsetGet($offset)
194
-    {
195
-        return $this->getIterator()->offsetGet($offset);
196
-    }
197
-
198
-    /**
199
-     * Offset to set.
200
-     *
201
-     * @link http://php.net/manual/en/arrayaccess.offsetset.php
202
-     *
203
-     * @param mixed $offset <p>
204
-     *                      The offset to assign the value to.
205
-     *                      </p>
206
-     * @param mixed $value  <p>
207
-     *                      The value to set.
208
-     *                      </p>
209
-     *
210
-     * @since 5.0.0
211
-     */
212
-    public function offsetSet($offset, $value)
213
-    {
214
-        return $this->getIterator()->offsetSet($offset, $value);
215
-    }
216
-
217
-    /**
218
-     * Offset to unset.
219
-     *
220
-     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
221
-     *
222
-     * @param mixed $offset <p>
223
-     *                      The offset to unset.
224
-     *                      </p>
225
-     *
226
-     * @since 5.0.0
227
-     */
228
-    public function offsetUnset($offset)
229
-    {
230
-        return $this->getIterator()->offsetUnset($offset);
231
-    }
232
-
233
-    /**
234
-     * Specify data which should be serialized to JSON.
235
-     *
236
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
237
-     *
238
-     * @param bool $stopRecursion Parameter used internally by TDBM to
239
-     *                            stop embedded objects from embedding
240
-     *                            other objects
241
-     *
242
-     * @return mixed data which can be serialized by <b>json_encode</b>,
243
-     *               which is a value of any type other than a resource
244
-     *
245
-     * @since 5.4.0
246
-     */
247
-    public function jsonSerialize($stopRecursion = false)
248
-    {
249
-        return array_map(function (AbstractTDBMObject $item) use ($stopRecursion) {
250
-            return $item->jsonSerialize($stopRecursion);
251
-        }, $this->toArray());
252
-    }
253
-
254
-    /**
255
-     * Returns only one value (the first) of the result set.
256
-     * Returns null if no value exists.
257
-     *
258
-     * @return mixed|null
259
-     */
260
-    public function first()
261
-    {
262
-        $page = $this->take(0, 1);
263
-        foreach ($page as $bean) {
264
-            return $bean;
265
-        }
266
-
267
-        return;
268
-    }
269
-
270
-    /**
271
-     * Sets the ORDER BY directive executed in SQL and returns a NEW ResultIterator.
272
-     *
273
-     * For instance:
274
-     *
275
-     *  $resultSet = $resultSet->withOrder('label ASC, status DESC');
276
-     *
277
-     * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
278
-     * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
279
-     *
280
-     *  $resultSet->withOrder(new UncheckedOrderBy('RAND()'))
281
-     *
282
-     * @param string|UncheckedOrderBy|null $orderBy
283
-     *
284
-     * @return ResultIterator
285
-     */
286
-    public function withOrder($orderBy) : ResultIterator
287
-    {
288
-        $clone = clone $this;
289
-        $clone->queryFactory = clone $this->queryFactory;
290
-        $clone->queryFactory->sort($orderBy);
291
-        $clone->innerResultIterator = null;
292
-
293
-        return $clone;
294
-    }
295
-
296
-    /**
297
-     * Sets new parameters for the SQL query and returns a NEW ResultIterator.
298
-     *
299
-     * For instance:
300
-     *
301
-     *  $resultSet = $resultSet->withParameters('label ASC, status DESC');
302
-     *
303
-     * @param string|UncheckedOrderBy|null $orderBy
304
-     *
305
-     * @return ResultIterator
306
-     */
307
-    public function withParameters(array $parameters) : ResultIterator
308
-    {
309
-        $clone = clone $this;
310
-        $clone->parameters = $parameters;
311
-        $clone->innerResultIterator = null;
312
-        $clone->totalCount = null;
313
-
314
-        return $clone;
315
-    }
35
+	/**
36
+	 * @var Statement
37
+	 */
38
+	protected $statement;
39
+
40
+	private $objectStorage;
41
+	private $className;
42
+
43
+	private $tdbmService;
44
+	private $parameters;
45
+	private $magicQuery;
46
+
47
+	/**
48
+	 * @var QueryFactory
49
+	 */
50
+	private $queryFactory;
51
+
52
+	/**
53
+	 * @var InnerResultIterator
54
+	 */
55
+	private $innerResultIterator;
56
+
57
+	private $databasePlatform;
58
+
59
+	private $totalCount;
60
+
61
+	private $mode;
62
+
63
+	private $logger;
64
+
65
+	public function __construct(QueryFactory $queryFactory, array $parameters, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode, LoggerInterface $logger)
66
+	{
67
+		if ($mode !== null && $mode !== TDBMService::MODE_CURSOR && $mode !== TDBMService::MODE_ARRAY) {
68
+			throw new TDBMException("Unknown fetch mode: '".$mode."'");
69
+		}
70
+
71
+		$this->queryFactory = $queryFactory;
72
+		$this->objectStorage = $objectStorage;
73
+		$this->className = $className;
74
+		$this->tdbmService = $tdbmService;
75
+		$this->parameters = $parameters;
76
+		$this->magicQuery = $magicQuery;
77
+		$this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
78
+		$this->mode = $mode;
79
+		$this->logger = $logger;
80
+	}
81
+
82
+	protected function executeCountQuery()
83
+	{
84
+		$sql = $this->magicQuery->build($this->queryFactory->getMagicSqlCount(), $this->parameters);
85
+		$this->logger->debug('Running count query: '.$sql);
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->queryFactory->getMagicSql(), $this->parameters, null, null, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger);
140
+			} else {
141
+				$this->innerResultIterator = new InnerResultArray($this->queryFactory->getMagicSql(), $this->parameters, null, null, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger);
142
+			}
143
+		}
144
+
145
+		return $this->innerResultIterator;
146
+	}
147
+
148
+	/**
149
+	 * @param int $offset
150
+	 * @param int $limit
151
+	 *
152
+	 * @return PageIterator
153
+	 */
154
+	public function take($offset, $limit)
155
+	{
156
+		return new PageIterator($this, $this->queryFactory->getMagicSql(), $this->parameters, $limit, $offset, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->mode, $this->logger);
157
+	}
158
+
159
+	/**
160
+	 * Whether a offset exists.
161
+	 *
162
+	 * @link http://php.net/manual/en/arrayaccess.offsetexists.php
163
+	 *
164
+	 * @param mixed $offset <p>
165
+	 *                      An offset to check for.
166
+	 *                      </p>
167
+	 *
168
+	 * @return bool true on success or false on failure.
169
+	 *              </p>
170
+	 *              <p>
171
+	 *              The return value will be casted to boolean if non-boolean was returned
172
+	 *
173
+	 * @since 5.0.0
174
+	 */
175
+	public function offsetExists($offset)
176
+	{
177
+		return $this->getIterator()->offsetExists($offset);
178
+	}
179
+
180
+	/**
181
+	 * Offset to retrieve.
182
+	 *
183
+	 * @link http://php.net/manual/en/arrayaccess.offsetget.php
184
+	 *
185
+	 * @param mixed $offset <p>
186
+	 *                      The offset to retrieve.
187
+	 *                      </p>
188
+	 *
189
+	 * @return mixed Can return all value types
190
+	 *
191
+	 * @since 5.0.0
192
+	 */
193
+	public function offsetGet($offset)
194
+	{
195
+		return $this->getIterator()->offsetGet($offset);
196
+	}
197
+
198
+	/**
199
+	 * Offset to set.
200
+	 *
201
+	 * @link http://php.net/manual/en/arrayaccess.offsetset.php
202
+	 *
203
+	 * @param mixed $offset <p>
204
+	 *                      The offset to assign the value to.
205
+	 *                      </p>
206
+	 * @param mixed $value  <p>
207
+	 *                      The value to set.
208
+	 *                      </p>
209
+	 *
210
+	 * @since 5.0.0
211
+	 */
212
+	public function offsetSet($offset, $value)
213
+	{
214
+		return $this->getIterator()->offsetSet($offset, $value);
215
+	}
216
+
217
+	/**
218
+	 * Offset to unset.
219
+	 *
220
+	 * @link http://php.net/manual/en/arrayaccess.offsetunset.php
221
+	 *
222
+	 * @param mixed $offset <p>
223
+	 *                      The offset to unset.
224
+	 *                      </p>
225
+	 *
226
+	 * @since 5.0.0
227
+	 */
228
+	public function offsetUnset($offset)
229
+	{
230
+		return $this->getIterator()->offsetUnset($offset);
231
+	}
232
+
233
+	/**
234
+	 * Specify data which should be serialized to JSON.
235
+	 *
236
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
237
+	 *
238
+	 * @param bool $stopRecursion Parameter used internally by TDBM to
239
+	 *                            stop embedded objects from embedding
240
+	 *                            other objects
241
+	 *
242
+	 * @return mixed data which can be serialized by <b>json_encode</b>,
243
+	 *               which is a value of any type other than a resource
244
+	 *
245
+	 * @since 5.4.0
246
+	 */
247
+	public function jsonSerialize($stopRecursion = false)
248
+	{
249
+		return array_map(function (AbstractTDBMObject $item) use ($stopRecursion) {
250
+			return $item->jsonSerialize($stopRecursion);
251
+		}, $this->toArray());
252
+	}
253
+
254
+	/**
255
+	 * Returns only one value (the first) of the result set.
256
+	 * Returns null if no value exists.
257
+	 *
258
+	 * @return mixed|null
259
+	 */
260
+	public function first()
261
+	{
262
+		$page = $this->take(0, 1);
263
+		foreach ($page as $bean) {
264
+			return $bean;
265
+		}
266
+
267
+		return;
268
+	}
269
+
270
+	/**
271
+	 * Sets the ORDER BY directive executed in SQL and returns a NEW ResultIterator.
272
+	 *
273
+	 * For instance:
274
+	 *
275
+	 *  $resultSet = $resultSet->withOrder('label ASC, status DESC');
276
+	 *
277
+	 * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
278
+	 * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
279
+	 *
280
+	 *  $resultSet->withOrder(new UncheckedOrderBy('RAND()'))
281
+	 *
282
+	 * @param string|UncheckedOrderBy|null $orderBy
283
+	 *
284
+	 * @return ResultIterator
285
+	 */
286
+	public function withOrder($orderBy) : ResultIterator
287
+	{
288
+		$clone = clone $this;
289
+		$clone->queryFactory = clone $this->queryFactory;
290
+		$clone->queryFactory->sort($orderBy);
291
+		$clone->innerResultIterator = null;
292
+
293
+		return $clone;
294
+	}
295
+
296
+	/**
297
+	 * Sets new parameters for the SQL query and returns a NEW ResultIterator.
298
+	 *
299
+	 * For instance:
300
+	 *
301
+	 *  $resultSet = $resultSet->withParameters('label ASC, status DESC');
302
+	 *
303
+	 * @param string|UncheckedOrderBy|null $orderBy
304
+	 *
305
+	 * @return ResultIterator
306
+	 */
307
+	public function withParameters(array $parameters) : ResultIterator
308
+	{
309
+		$clone = clone $this;
310
+		$clone->parameters = $parameters;
311
+		$clone->innerResultIterator = null;
312
+		$clone->totalCount = null;
313
+
314
+		return $clone;
315
+	}
316 316
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/Utils/ScalarBeanPropertyDescriptor.php 1 patch
Indentation   +167 added lines, -167 removed lines patch added patch discarded remove patch
@@ -11,125 +11,125 @@  discard block
 block discarded – undo
11 11
  */
12 12
 class ScalarBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor
13 13
 {
14
-    /**
15
-     * @var Column
16
-     */
17
-    private $column;
18
-
19
-    public function __construct(Table $table, Column $column)
20
-    {
21
-        parent::__construct($table);
22
-        $this->table = $table;
23
-        $this->column = $column;
24
-    }
25
-
26
-    /**
27
-     * Returns the foreign-key the column is part of, if any. null otherwise.
28
-     *
29
-     * @return ForeignKeyConstraint|null
30
-     */
31
-    public function getForeignKey()
32
-    {
33
-        return false;
34
-    }
35
-
36
-    /**
37
-     * Returns the param annotation for this property (useful for constructor).
38
-     *
39
-     * @return string
40
-     */
41
-    public function getParamAnnotation()
42
-    {
43
-        $className = $this->getClassName();
44
-        $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType());
45
-
46
-        $str = '     * @param %s %s';
47
-
48
-        return sprintf($str, $paramType, $this->getVariableName());
49
-    }
50
-
51
-    public function getUpperCamelCaseName()
52
-    {
53
-        return TDBMDaoGenerator::toCamelCase($this->column->getName());
54
-    }
55
-
56
-    /**
57
-     * Returns the name of the class linked to this property or null if this is not a foreign key.
58
-     *
59
-     * @return null|string
60
-     */
61
-    public function getClassName()
62
-    {
63
-        return;
64
-    }
65
-
66
-    /**
67
-     * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
68
-     *
69
-     * @return bool
70
-     */
71
-    public function isCompulsory()
72
-    {
73
-        return $this->column->getNotnull() && !$this->column->getAutoincrement() && $this->column->getDefault() === null;
74
-    }
75
-
76
-    /**
77
-     * Returns true if the property has a default value.
78
-     *
79
-     * @return bool
80
-     */
81
-    public function hasDefault()
82
-    {
83
-        return $this->column->getDefault() !== null;
84
-    }
85
-
86
-    /**
87
-     * Returns the code that assigns a value to its default value.
88
-     *
89
-     * @return string
90
-     */
91
-    public function assignToDefaultCode()
92
-    {
93
-        $str = '        $this->%s(%s);';
94
-
95
-        $default = $this->column->getDefault();
96
-
97
-        if (strtoupper($default) === 'CURRENT_TIMESTAMP') {
98
-            $defaultCode = 'new \DateTimeImmutable()';
99
-        } else {
100
-            $defaultCode = var_export($this->column->getDefault(), true);
101
-        }
102
-
103
-        return sprintf($str, $this->getSetterName(), $defaultCode);
104
-    }
105
-
106
-    /**
107
-     * Returns true if the property is the primary key.
108
-     *
109
-     * @return bool
110
-     */
111
-    public function isPrimaryKey()
112
-    {
113
-        return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns());
114
-    }
115
-
116
-    /**
117
-     * Returns the PHP code for getters and setters.
118
-     *
119
-     * @return string
120
-     */
121
-    public function getGetterSetterCode()
122
-    {
123
-        $type = $this->column->getType();
124
-        $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);
125
-
126
-        $columnGetterName = $this->getGetterName();
127
-        $columnSetterName = $this->getSetterName();
128
-
129
-        // A column type can be forced if it is not nullable and not auto-incrmentable (for auto-increment columns, we can get "null" as long as the bean is not saved).
130
-        $canForceGetterReturnType = $this->column->getNotnull() && !$this->column->getAutoincrement();
131
-
132
-        $getterAndSetterCode = '    /**
14
+	/**
15
+	 * @var Column
16
+	 */
17
+	private $column;
18
+
19
+	public function __construct(Table $table, Column $column)
20
+	{
21
+		parent::__construct($table);
22
+		$this->table = $table;
23
+		$this->column = $column;
24
+	}
25
+
26
+	/**
27
+	 * Returns the foreign-key the column is part of, if any. null otherwise.
28
+	 *
29
+	 * @return ForeignKeyConstraint|null
30
+	 */
31
+	public function getForeignKey()
32
+	{
33
+		return false;
34
+	}
35
+
36
+	/**
37
+	 * Returns the param annotation for this property (useful for constructor).
38
+	 *
39
+	 * @return string
40
+	 */
41
+	public function getParamAnnotation()
42
+	{
43
+		$className = $this->getClassName();
44
+		$paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType());
45
+
46
+		$str = '     * @param %s %s';
47
+
48
+		return sprintf($str, $paramType, $this->getVariableName());
49
+	}
50
+
51
+	public function getUpperCamelCaseName()
52
+	{
53
+		return TDBMDaoGenerator::toCamelCase($this->column->getName());
54
+	}
55
+
56
+	/**
57
+	 * Returns the name of the class linked to this property or null if this is not a foreign key.
58
+	 *
59
+	 * @return null|string
60
+	 */
61
+	public function getClassName()
62
+	{
63
+		return;
64
+	}
65
+
66
+	/**
67
+	 * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
68
+	 *
69
+	 * @return bool
70
+	 */
71
+	public function isCompulsory()
72
+	{
73
+		return $this->column->getNotnull() && !$this->column->getAutoincrement() && $this->column->getDefault() === null;
74
+	}
75
+
76
+	/**
77
+	 * Returns true if the property has a default value.
78
+	 *
79
+	 * @return bool
80
+	 */
81
+	public function hasDefault()
82
+	{
83
+		return $this->column->getDefault() !== null;
84
+	}
85
+
86
+	/**
87
+	 * Returns the code that assigns a value to its default value.
88
+	 *
89
+	 * @return string
90
+	 */
91
+	public function assignToDefaultCode()
92
+	{
93
+		$str = '        $this->%s(%s);';
94
+
95
+		$default = $this->column->getDefault();
96
+
97
+		if (strtoupper($default) === 'CURRENT_TIMESTAMP') {
98
+			$defaultCode = 'new \DateTimeImmutable()';
99
+		} else {
100
+			$defaultCode = var_export($this->column->getDefault(), true);
101
+		}
102
+
103
+		return sprintf($str, $this->getSetterName(), $defaultCode);
104
+	}
105
+
106
+	/**
107
+	 * Returns true if the property is the primary key.
108
+	 *
109
+	 * @return bool
110
+	 */
111
+	public function isPrimaryKey()
112
+	{
113
+		return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns());
114
+	}
115
+
116
+	/**
117
+	 * Returns the PHP code for getters and setters.
118
+	 *
119
+	 * @return string
120
+	 */
121
+	public function getGetterSetterCode()
122
+	{
123
+		$type = $this->column->getType();
124
+		$normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);
125
+
126
+		$columnGetterName = $this->getGetterName();
127
+		$columnSetterName = $this->getSetterName();
128
+
129
+		// A column type can be forced if it is not nullable and not auto-incrmentable (for auto-increment columns, we can get "null" as long as the bean is not saved).
130
+		$canForceGetterReturnType = $this->column->getNotnull() && !$this->column->getAutoincrement();
131
+
132
+		$getterAndSetterCode = '    /**
133 133
      * The getter for the "%s" column.
134 134
      *
135 135
      * @return %s
@@ -151,52 +151,52 @@  discard block
 block discarded – undo
151 151
 
152 152
 ';
153 153
 
154
-        return sprintf($getterAndSetterCode,
155
-            // Getter
156
-            $this->column->getName(),
157
-            $normalizedType.($canForceGetterReturnType ? '' : '|null'),
158
-            $columnGetterName,
159
-            ($canForceGetterReturnType ? ' : '.$normalizedType : ''),
160
-            var_export($this->column->getName(), true),
161
-            var_export($this->table->getName(), true),
162
-            // Setter
163
-            $this->column->getName(),
164
-            $normalizedType,
165
-            $this->column->getName(),
166
-            $columnSetterName,
167
-            $normalizedType,
168
-            //$castTo,
169
-            $this->column->getName().($this->column->getNotnull() ? '' : ' = null'),
170
-            var_export($this->column->getName(), true),
171
-            $this->column->getName(),
172
-            var_export($this->table->getName(), true)
173
-        );
174
-    }
175
-
176
-    /**
177
-     * Returns the part of code useful when doing json serialization.
178
-     *
179
-     * @return string
180
-     */
181
-    public function getJsonSerializeCode()
182
-    {
183
-        $type = $this->column->getType();
184
-        $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);
185
-
186
-        if ($normalizedType == '\\DateTimeInterface') {
187
-            return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = ($this->'.$this->getGetterName().'() === null) ? null : $this->'.$this->getGetterName()."()->format('c');\n";
188
-        } else {
189
-            return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n";
190
-        }
191
-    }
192
-
193
-    /**
194
-     * Returns the column name.
195
-     *
196
-     * @return string
197
-     */
198
-    public function getColumnName()
199
-    {
200
-        return $this->column->getName();
201
-    }
154
+		return sprintf($getterAndSetterCode,
155
+			// Getter
156
+			$this->column->getName(),
157
+			$normalizedType.($canForceGetterReturnType ? '' : '|null'),
158
+			$columnGetterName,
159
+			($canForceGetterReturnType ? ' : '.$normalizedType : ''),
160
+			var_export($this->column->getName(), true),
161
+			var_export($this->table->getName(), true),
162
+			// Setter
163
+			$this->column->getName(),
164
+			$normalizedType,
165
+			$this->column->getName(),
166
+			$columnSetterName,
167
+			$normalizedType,
168
+			//$castTo,
169
+			$this->column->getName().($this->column->getNotnull() ? '' : ' = null'),
170
+			var_export($this->column->getName(), true),
171
+			$this->column->getName(),
172
+			var_export($this->table->getName(), true)
173
+		);
174
+	}
175
+
176
+	/**
177
+	 * Returns the part of code useful when doing json serialization.
178
+	 *
179
+	 * @return string
180
+	 */
181
+	public function getJsonSerializeCode()
182
+	{
183
+		$type = $this->column->getType();
184
+		$normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);
185
+
186
+		if ($normalizedType == '\\DateTimeInterface') {
187
+			return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = ($this->'.$this->getGetterName().'() === null) ? null : $this->'.$this->getGetterName()."()->format('c');\n";
188
+		} else {
189
+			return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n";
190
+		}
191
+	}
192
+
193
+	/**
194
+	 * Returns the column name.
195
+	 *
196
+	 * @return string
197
+	 */
198
+	public function getColumnName()
199
+	{
200
+		return $this->column->getName();
201
+	}
202 202
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/AbstractTDBMObject.php 1 patch
Indentation   +606 added lines, -606 removed lines patch added patch discarded remove patch
@@ -31,615 +31,615 @@
 block discarded – undo
31 31
  */
32 32
 abstract class AbstractTDBMObject implements JsonSerializable
33 33
 {
34
-    /**
35
-     * The service this object is bound to.
36
-     *
37
-     * @var TDBMService
38
-     */
39
-    protected $tdbmService;
40
-
41
-    /**
42
-     * An array of DbRow, indexed by table name.
43
-     *
44
-     * @var DbRow[]
45
-     */
46
-    protected $dbRows = array();
47
-
48
-    /**
49
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
50
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
51
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
52
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
53
-     *
54
-     * @var string
55
-     */
56
-    private $status;
57
-
58
-    /**
59
-     * Array storing beans related via many to many relationships (pivot tables).
60
-     *
61
-     * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage
62
-     */
63
-    private $relationships = [];
64
-
65
-    /**
66
-     * @var bool[] Key: pivot table name, value: whether a query was performed to load the data
67
-     */
68
-    private $loadedRelationships = [];
69
-
70
-    /**
71
-     * Array storing beans related via many to one relationships (this bean is pointed by external beans).
72
-     *
73
-     * @var AlterableResultIterator[] Key: [external_table]___[external_column], value: SplObjectStorage
74
-     */
75
-    private $manyToOneRelationships = [];
76
-
77
-    /**
78
-     * Used with $primaryKeys when we want to retrieve an existing object
79
-     * and $primaryKeys=[] if we want a new object.
80
-     *
81
-     * @param string      $tableName
82
-     * @param array       $primaryKeys
83
-     * @param TDBMService $tdbmService
84
-     *
85
-     * @throws TDBMException
86
-     * @throws TDBMInvalidOperationException
87
-     */
88
-    public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null)
89
-    {
90
-        // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
91
-        if (!empty($tableName)) {
92
-            $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
93
-        }
94
-
95
-        if ($tdbmService === null) {
96
-            $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED);
97
-        } else {
98
-            $this->_attach($tdbmService);
99
-            if (!empty($primaryKeys)) {
100
-                $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
101
-            } else {
102
-                $this->_setStatus(TDBMObjectStateEnum::STATE_NEW);
103
-            }
104
-        }
105
-    }
106
-
107
-    /**
108
-     * Alternative constructor called when data is fetched from database via a SELECT.
109
-     *
110
-     * @param array       $beanData    array<table, array<column, value>>
111
-     * @param TDBMService $tdbmService
112
-     */
113
-    public function _constructFromData(array $beanData, TDBMService $tdbmService)
114
-    {
115
-        $this->tdbmService = $tdbmService;
116
-
117
-        foreach ($beanData as $table => $columns) {
118
-            $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns);
119
-        }
120
-
121
-        $this->status = TDBMObjectStateEnum::STATE_LOADED;
122
-    }
123
-
124
-    /**
125
-     * Alternative constructor called when bean is lazily loaded.
126
-     *
127
-     * @param string      $tableName
128
-     * @param array       $primaryKeys
129
-     * @param TDBMService $tdbmService
130
-     */
131
-    public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService)
132
-    {
133
-        $this->tdbmService = $tdbmService;
134
-
135
-        $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
136
-
137
-        $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
138
-    }
139
-
140
-    public function _attach(TDBMService $tdbmService)
141
-    {
142
-        if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
143
-            throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
144
-        }
145
-        $this->tdbmService = $tdbmService;
146
-
147
-        // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level)
148
-        $tableNames = $this->getUsedTables();
149
-
150
-        $newDbRows = [];
151
-
152
-        foreach ($tableNames as $table) {
153
-            if (!isset($this->dbRows[$table])) {
154
-                $this->registerTable($table);
155
-            }
156
-            $newDbRows[$table] = $this->dbRows[$table];
157
-        }
158
-        $this->dbRows = $newDbRows;
159
-
160
-        $this->status = TDBMObjectStateEnum::STATE_NEW;
161
-        foreach ($this->dbRows as $dbRow) {
162
-            $dbRow->_attach($tdbmService);
163
-        }
164
-    }
165
-
166
-    /**
167
-     * Sets the state of the TDBM Object
168
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
169
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
170
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
171
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
172
-     *
173
-     * @param string $state
174
-     */
175
-    public function _setStatus($state)
176
-    {
177
-        $this->status = $state;
178
-
179
-        // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
180
-        foreach ($this->dbRows as $dbRow) {
181
-            $dbRow->_setStatus($state);
182
-        }
183
-
184
-        if ($state === TDBMObjectStateEnum::STATE_DELETED) {
185
-            $this->onDelete();
186
-        }
187
-    }
188
-
189
-    /**
190
-     * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null"
191
-     * or throws an error.
192
-     *
193
-     * @param string $tableName
194
-     *
195
-     * @return string
196
-     */
197
-    private function checkTableName($tableName = null)
198
-    {
199
-        if ($tableName === null) {
200
-            if (count($this->dbRows) > 1) {
201
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
202
-            } elseif (count($this->dbRows) === 1) {
203
-                $tableName = array_keys($this->dbRows)[0];
204
-            }
205
-        }
206
-
207
-        if (!isset($this->dbRows[$tableName])) {
208
-            if (count($this->dbRows === 0)) {
209
-                throw new TDBMException('Object is not yet bound to any table.');
210
-            } else {
211
-                throw new TDBMException('Unknown table "'.$tableName.'"" in object.');
212
-            }
213
-        }
214
-
215
-        return $tableName;
216
-    }
217
-
218
-    protected function get($var, $tableName = null)
219
-    {
220
-        $tableName = $this->checkTableName($tableName);
221
-
222
-        return $this->dbRows[$tableName]->get($var);
223
-    }
224
-
225
-    protected function set($var, $value, $tableName = null)
226
-    {
227
-        if ($tableName === null) {
228
-            if (count($this->dbRows) > 1) {
229
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
230
-            } elseif (count($this->dbRows) === 1) {
231
-                $tableName = array_keys($this->dbRows)[0];
232
-            } else {
233
-                throw new TDBMException('Please specify a table for this object.');
234
-            }
235
-        }
236
-
237
-        if (!isset($this->dbRows[$tableName])) {
238
-            $this->registerTable($tableName);
239
-        }
240
-
241
-        $this->dbRows[$tableName]->set($var, $value);
242
-        if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
243
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
244
-        }
245
-    }
246
-
247
-    /**
248
-     * @param string             $foreignKeyName
249
-     * @param AbstractTDBMObject $bean
250
-     */
251
-    protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null)
252
-    {
253
-        if ($tableName === null) {
254
-            if (count($this->dbRows) > 1) {
255
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
256
-            } elseif (count($this->dbRows) === 1) {
257
-                $tableName = array_keys($this->dbRows)[0];
258
-            } else {
259
-                throw new TDBMException('Please specify a table for this object.');
260
-            }
261
-        }
262
-
263
-        if (!isset($this->dbRows[$tableName])) {
264
-            $this->registerTable($tableName);
265
-        }
266
-
267
-        $oldLinkedBean = $this->dbRows[$tableName]->getRef($foreignKeyName);
268
-        if ($oldLinkedBean !== null) {
269
-            $oldLinkedBean->removeManyToOneRelationship($tableName, $foreignKeyName, $this);
270
-        }
271
-
272
-        $this->dbRows[$tableName]->setRef($foreignKeyName, $bean);
273
-        if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
274
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
275
-        }
276
-
277
-        if ($bean !== null) {
278
-            $bean->setManyToOneRelationship($tableName, $foreignKeyName, $this);
279
-        }
280
-    }
281
-
282
-    /**
283
-     * @param string $foreignKeyName A unique name for this reference
284
-     *
285
-     * @return AbstractTDBMObject|null
286
-     */
287
-    protected function getRef($foreignKeyName, $tableName = null)
288
-    {
289
-        $tableName = $this->checkTableName($tableName);
290
-
291
-        return $this->dbRows[$tableName]->getRef($foreignKeyName);
292
-    }
293
-
294
-    /**
295
-     * Adds a many to many relationship to this bean.
296
-     *
297
-     * @param string             $pivotTableName
298
-     * @param AbstractTDBMObject $remoteBean
299
-     */
300
-    protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
301
-    {
302
-        $this->setRelationship($pivotTableName, $remoteBean, 'new');
303
-    }
304
-
305
-    /**
306
-     * Returns true if there is a relationship to this bean.
307
-     *
308
-     * @param string             $pivotTableName
309
-     * @param AbstractTDBMObject $remoteBean
310
-     *
311
-     * @return bool
312
-     */
313
-    protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
314
-    {
315
-        $storage = $this->retrieveRelationshipsStorage($pivotTableName);
316
-
317
-        if ($storage->contains($remoteBean)) {
318
-            if ($storage[$remoteBean]['status'] !== 'delete') {
319
-                return true;
320
-            }
321
-        }
322
-
323
-        return false;
324
-    }
325
-
326
-    /**
327
-     * Internal TDBM method. Removes a many to many relationship from this bean.
328
-     *
329
-     * @param string             $pivotTableName
330
-     * @param AbstractTDBMObject $remoteBean
331
-     */
332
-    public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
333
-    {
334
-        if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') {
335
-            unset($this->relationships[$pivotTableName][$remoteBean]);
336
-            unset($remoteBean->relationships[$pivotTableName][$this]);
337
-        } else {
338
-            $this->setRelationship($pivotTableName, $remoteBean, 'delete');
339
-        }
340
-    }
341
-
342
-    /**
343
-     * Sets many to many relationships for this bean.
344
-     * Adds new relationships and removes unused ones.
345
-     *
346
-     * @param $pivotTableName
347
-     * @param array $remoteBeans
348
-     */
349
-    protected function setRelationships($pivotTableName, array $remoteBeans)
350
-    {
351
-        $storage = $this->retrieveRelationshipsStorage($pivotTableName);
352
-
353
-        foreach ($storage as $oldRemoteBean) {
354
-            if (!in_array($oldRemoteBean, $remoteBeans, true)) {
355
-                // $oldRemoteBean must be removed
356
-                $this->_removeRelationship($pivotTableName, $oldRemoteBean);
357
-            }
358
-        }
359
-
360
-        foreach ($remoteBeans as $remoteBean) {
361
-            if (!$storage->contains($remoteBean) || $storage[$remoteBean]['status'] === 'delete') {
362
-                // $remoteBean must be added
363
-                $this->addRelationship($pivotTableName, $remoteBean);
364
-            }
365
-        }
366
-    }
367
-
368
-    /**
369
-     * Returns the list of objects linked to this bean via $pivotTableName.
370
-     *
371
-     * @param $pivotTableName
372
-     *
373
-     * @return \SplObjectStorage
374
-     */
375
-    private function retrieveRelationshipsStorage($pivotTableName)
376
-    {
377
-        $storage = $this->getRelationshipStorage($pivotTableName);
378
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName])) {
379
-            return $storage;
380
-        }
381
-
382
-        $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this);
383
-        $this->loadedRelationships[$pivotTableName] = true;
384
-
385
-        foreach ($beans as $bean) {
386
-            if (isset($storage[$bean])) {
387
-                $oldStatus = $storage[$bean]['status'];
388
-                if ($oldStatus === 'delete') {
389
-                    // Keep deleted things deleted
390
-                    continue;
391
-                }
392
-            }
393
-            $this->setRelationship($pivotTableName, $bean, 'loaded');
394
-        }
395
-
396
-        return $storage;
397
-    }
398
-
399
-    /**
400
-     * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
401
-     *
402
-     * @param $pivotTableName
403
-     *
404
-     * @return AbstractTDBMObject[]
405
-     */
406
-    public function _getRelationships($pivotTableName)
407
-    {
408
-        return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
409
-    }
410
-
411
-    private function relationshipStorageToArray(\SplObjectStorage $storage)
412
-    {
413
-        $beans = [];
414
-        foreach ($storage as $bean) {
415
-            $statusArr = $storage[$bean];
416
-            if ($statusArr['status'] !== 'delete') {
417
-                $beans[] = $bean;
418
-            }
419
-        }
420
-
421
-        return $beans;
422
-    }
423
-
424
-    /**
425
-     * Declares a relationship between.
426
-     *
427
-     * @param string             $pivotTableName
428
-     * @param AbstractTDBMObject $remoteBean
429
-     * @param string             $status
430
-     */
431
-    private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status)
432
-    {
433
-        $storage = $this->getRelationshipStorage($pivotTableName);
434
-        $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
435
-        if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
436
-            $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
437
-        }
438
-
439
-        $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
440
-        $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
441
-    }
442
-
443
-    /**
444
-     * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
445
-     *
446
-     * @param string $pivotTableName
447
-     *
448
-     * @return \SplObjectStorage
449
-     */
450
-    private function getRelationshipStorage(string $pivotTableName) : \SplObjectStorage
451
-    {
452
-        return $this->relationships[$pivotTableName] ?? $this->relationships[$pivotTableName] = new \SplObjectStorage();
453
-    }
454
-
455
-    /**
456
-     * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
457
-     *
458
-     * @param string $tableName
459
-     * @param string $foreignKeyName
460
-     *
461
-     * @return AlterableResultIterator
462
-     */
463
-    private function getManyToOneAlterableResultIterator(string $tableName, string $foreignKeyName) : AlterableResultIterator
464
-    {
465
-        $key = $tableName.'___'.$foreignKeyName;
466
-
467
-        return $this->manyToOneRelationships[$key] ?? $this->manyToOneRelationships[$key] = new AlterableResultIterator();
468
-    }
469
-
470
-    /**
471
-     * Declares a relationship between this bean and the bean pointing to it.
472
-     *
473
-     * @param string             $tableName
474
-     * @param string             $foreignKeyName
475
-     * @param AbstractTDBMObject $remoteBean
476
-     */
477
-    private function setManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean)
478
-    {
479
-        $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
480
-        $alterableResultIterator->add($remoteBean);
481
-    }
482
-
483
-    /**
484
-     * Declares a relationship between this bean and the bean pointing to it.
485
-     *
486
-     * @param string             $tableName
487
-     * @param string             $foreignKeyName
488
-     * @param AbstractTDBMObject $remoteBean
489
-     */
490
-    private function removeManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean)
491
-    {
492
-        $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
493
-        $alterableResultIterator->remove($remoteBean);
494
-    }
495
-
496
-    /**
497
-     * Returns the list of objects linked to this bean via a given foreign key.
498
-     *
499
-     * @param string $tableName
500
-     * @param string $foreignKeyName
501
-     * @param string $searchTableName
502
-     * @param array  $searchFilter
503
-     * @param string $orderString     The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column). WARNING : This parameter is not kept when there is an additionnal or removal object !
504
-     *
505
-     * @return AlterableResultIterator
506
-     */
507
-    protected function retrieveManyToOneRelationshipsStorage(string $tableName, string $foreignKeyName, string $searchTableName, array $searchFilter, $orderString = null) : AlterableResultIterator
508
-    {
509
-        $key = $tableName.'___'.$foreignKeyName;
510
-        $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
511
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->manyToOneRelationships[$key]) && $this->manyToOneRelationships[$key]->getUnderlyingResultIterator() !== null)) {
512
-            return $alterableResultIterator;
513
-        }
514
-
515
-        $unalteredResultIterator = $this->tdbmService->findObjects($searchTableName, $searchFilter, [], $orderString);
516
-
517
-        $alterableResultIterator->setResultIterator($unalteredResultIterator->getIterator());
518
-
519
-        return $alterableResultIterator;
520
-    }
521
-
522
-    /**
523
-     * Reverts any changes made to the object and resumes it to its DB state.
524
-     * This can only be called on objects that come from database and that have not been deleted.
525
-     * Otherwise, this will throw an exception.
526
-     *
527
-     * @throws TDBMException
528
-     */
529
-    public function discardChanges()
530
-    {
531
-        if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) {
532
-            throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved.");
533
-        }
534
-
535
-        if ($this->status === TDBMObjectStateEnum::STATE_DELETED) {
536
-            throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.');
537
-        }
538
-
539
-        $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
540
-    }
541
-
542
-    /**
543
-     * Method used internally by TDBM. You should not use it directly.
544
-     * This method returns the status of the TDBMObject.
545
-     * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
546
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
547
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
548
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
549
-     *
550
-     * @return string
551
-     */
552
-    public function _getStatus()
553
-    {
554
-        return $this->status;
555
-    }
556
-
557
-    /**
558
-     * Override the native php clone function for TDBMObjects.
559
-     */
560
-    public function __clone()
561
-    {
562
-        // Let's clone the many to many relationships
563
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) {
564
-            $pivotTableList = array_keys($this->relationships);
565
-        } else {
566
-            $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this);
567
-        }
568
-
569
-        foreach ($pivotTableList as $pivotTable) {
570
-            $storage = $this->retrieveRelationshipsStorage($pivotTable);
571
-
572
-            // Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!!
573
-            /*foreach ($storage as $remoteBean) {
34
+	/**
35
+	 * The service this object is bound to.
36
+	 *
37
+	 * @var TDBMService
38
+	 */
39
+	protected $tdbmService;
40
+
41
+	/**
42
+	 * An array of DbRow, indexed by table name.
43
+	 *
44
+	 * @var DbRow[]
45
+	 */
46
+	protected $dbRows = array();
47
+
48
+	/**
49
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
50
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
51
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
52
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
53
+	 *
54
+	 * @var string
55
+	 */
56
+	private $status;
57
+
58
+	/**
59
+	 * Array storing beans related via many to many relationships (pivot tables).
60
+	 *
61
+	 * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage
62
+	 */
63
+	private $relationships = [];
64
+
65
+	/**
66
+	 * @var bool[] Key: pivot table name, value: whether a query was performed to load the data
67
+	 */
68
+	private $loadedRelationships = [];
69
+
70
+	/**
71
+	 * Array storing beans related via many to one relationships (this bean is pointed by external beans).
72
+	 *
73
+	 * @var AlterableResultIterator[] Key: [external_table]___[external_column], value: SplObjectStorage
74
+	 */
75
+	private $manyToOneRelationships = [];
76
+
77
+	/**
78
+	 * Used with $primaryKeys when we want to retrieve an existing object
79
+	 * and $primaryKeys=[] if we want a new object.
80
+	 *
81
+	 * @param string      $tableName
82
+	 * @param array       $primaryKeys
83
+	 * @param TDBMService $tdbmService
84
+	 *
85
+	 * @throws TDBMException
86
+	 * @throws TDBMInvalidOperationException
87
+	 */
88
+	public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null)
89
+	{
90
+		// FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
91
+		if (!empty($tableName)) {
92
+			$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
93
+		}
94
+
95
+		if ($tdbmService === null) {
96
+			$this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED);
97
+		} else {
98
+			$this->_attach($tdbmService);
99
+			if (!empty($primaryKeys)) {
100
+				$this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
101
+			} else {
102
+				$this->_setStatus(TDBMObjectStateEnum::STATE_NEW);
103
+			}
104
+		}
105
+	}
106
+
107
+	/**
108
+	 * Alternative constructor called when data is fetched from database via a SELECT.
109
+	 *
110
+	 * @param array       $beanData    array<table, array<column, value>>
111
+	 * @param TDBMService $tdbmService
112
+	 */
113
+	public function _constructFromData(array $beanData, TDBMService $tdbmService)
114
+	{
115
+		$this->tdbmService = $tdbmService;
116
+
117
+		foreach ($beanData as $table => $columns) {
118
+			$this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns);
119
+		}
120
+
121
+		$this->status = TDBMObjectStateEnum::STATE_LOADED;
122
+	}
123
+
124
+	/**
125
+	 * Alternative constructor called when bean is lazily loaded.
126
+	 *
127
+	 * @param string      $tableName
128
+	 * @param array       $primaryKeys
129
+	 * @param TDBMService $tdbmService
130
+	 */
131
+	public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService)
132
+	{
133
+		$this->tdbmService = $tdbmService;
134
+
135
+		$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
136
+
137
+		$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
138
+	}
139
+
140
+	public function _attach(TDBMService $tdbmService)
141
+	{
142
+		if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
143
+			throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
144
+		}
145
+		$this->tdbmService = $tdbmService;
146
+
147
+		// If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level)
148
+		$tableNames = $this->getUsedTables();
149
+
150
+		$newDbRows = [];
151
+
152
+		foreach ($tableNames as $table) {
153
+			if (!isset($this->dbRows[$table])) {
154
+				$this->registerTable($table);
155
+			}
156
+			$newDbRows[$table] = $this->dbRows[$table];
157
+		}
158
+		$this->dbRows = $newDbRows;
159
+
160
+		$this->status = TDBMObjectStateEnum::STATE_NEW;
161
+		foreach ($this->dbRows as $dbRow) {
162
+			$dbRow->_attach($tdbmService);
163
+		}
164
+	}
165
+
166
+	/**
167
+	 * Sets the state of the TDBM Object
168
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
169
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
170
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
171
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
172
+	 *
173
+	 * @param string $state
174
+	 */
175
+	public function _setStatus($state)
176
+	{
177
+		$this->status = $state;
178
+
179
+		// TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
180
+		foreach ($this->dbRows as $dbRow) {
181
+			$dbRow->_setStatus($state);
182
+		}
183
+
184
+		if ($state === TDBMObjectStateEnum::STATE_DELETED) {
185
+			$this->onDelete();
186
+		}
187
+	}
188
+
189
+	/**
190
+	 * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null"
191
+	 * or throws an error.
192
+	 *
193
+	 * @param string $tableName
194
+	 *
195
+	 * @return string
196
+	 */
197
+	private function checkTableName($tableName = null)
198
+	{
199
+		if ($tableName === null) {
200
+			if (count($this->dbRows) > 1) {
201
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
202
+			} elseif (count($this->dbRows) === 1) {
203
+				$tableName = array_keys($this->dbRows)[0];
204
+			}
205
+		}
206
+
207
+		if (!isset($this->dbRows[$tableName])) {
208
+			if (count($this->dbRows === 0)) {
209
+				throw new TDBMException('Object is not yet bound to any table.');
210
+			} else {
211
+				throw new TDBMException('Unknown table "'.$tableName.'"" in object.');
212
+			}
213
+		}
214
+
215
+		return $tableName;
216
+	}
217
+
218
+	protected function get($var, $tableName = null)
219
+	{
220
+		$tableName = $this->checkTableName($tableName);
221
+
222
+		return $this->dbRows[$tableName]->get($var);
223
+	}
224
+
225
+	protected function set($var, $value, $tableName = null)
226
+	{
227
+		if ($tableName === null) {
228
+			if (count($this->dbRows) > 1) {
229
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
230
+			} elseif (count($this->dbRows) === 1) {
231
+				$tableName = array_keys($this->dbRows)[0];
232
+			} else {
233
+				throw new TDBMException('Please specify a table for this object.');
234
+			}
235
+		}
236
+
237
+		if (!isset($this->dbRows[$tableName])) {
238
+			$this->registerTable($tableName);
239
+		}
240
+
241
+		$this->dbRows[$tableName]->set($var, $value);
242
+		if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
243
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
244
+		}
245
+	}
246
+
247
+	/**
248
+	 * @param string             $foreignKeyName
249
+	 * @param AbstractTDBMObject $bean
250
+	 */
251
+	protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null)
252
+	{
253
+		if ($tableName === null) {
254
+			if (count($this->dbRows) > 1) {
255
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
256
+			} elseif (count($this->dbRows) === 1) {
257
+				$tableName = array_keys($this->dbRows)[0];
258
+			} else {
259
+				throw new TDBMException('Please specify a table for this object.');
260
+			}
261
+		}
262
+
263
+		if (!isset($this->dbRows[$tableName])) {
264
+			$this->registerTable($tableName);
265
+		}
266
+
267
+		$oldLinkedBean = $this->dbRows[$tableName]->getRef($foreignKeyName);
268
+		if ($oldLinkedBean !== null) {
269
+			$oldLinkedBean->removeManyToOneRelationship($tableName, $foreignKeyName, $this);
270
+		}
271
+
272
+		$this->dbRows[$tableName]->setRef($foreignKeyName, $bean);
273
+		if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
274
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
275
+		}
276
+
277
+		if ($bean !== null) {
278
+			$bean->setManyToOneRelationship($tableName, $foreignKeyName, $this);
279
+		}
280
+	}
281
+
282
+	/**
283
+	 * @param string $foreignKeyName A unique name for this reference
284
+	 *
285
+	 * @return AbstractTDBMObject|null
286
+	 */
287
+	protected function getRef($foreignKeyName, $tableName = null)
288
+	{
289
+		$tableName = $this->checkTableName($tableName);
290
+
291
+		return $this->dbRows[$tableName]->getRef($foreignKeyName);
292
+	}
293
+
294
+	/**
295
+	 * Adds a many to many relationship to this bean.
296
+	 *
297
+	 * @param string             $pivotTableName
298
+	 * @param AbstractTDBMObject $remoteBean
299
+	 */
300
+	protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
301
+	{
302
+		$this->setRelationship($pivotTableName, $remoteBean, 'new');
303
+	}
304
+
305
+	/**
306
+	 * Returns true if there is a relationship to this bean.
307
+	 *
308
+	 * @param string             $pivotTableName
309
+	 * @param AbstractTDBMObject $remoteBean
310
+	 *
311
+	 * @return bool
312
+	 */
313
+	protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
314
+	{
315
+		$storage = $this->retrieveRelationshipsStorage($pivotTableName);
316
+
317
+		if ($storage->contains($remoteBean)) {
318
+			if ($storage[$remoteBean]['status'] !== 'delete') {
319
+				return true;
320
+			}
321
+		}
322
+
323
+		return false;
324
+	}
325
+
326
+	/**
327
+	 * Internal TDBM method. Removes a many to many relationship from this bean.
328
+	 *
329
+	 * @param string             $pivotTableName
330
+	 * @param AbstractTDBMObject $remoteBean
331
+	 */
332
+	public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
333
+	{
334
+		if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') {
335
+			unset($this->relationships[$pivotTableName][$remoteBean]);
336
+			unset($remoteBean->relationships[$pivotTableName][$this]);
337
+		} else {
338
+			$this->setRelationship($pivotTableName, $remoteBean, 'delete');
339
+		}
340
+	}
341
+
342
+	/**
343
+	 * Sets many to many relationships for this bean.
344
+	 * Adds new relationships and removes unused ones.
345
+	 *
346
+	 * @param $pivotTableName
347
+	 * @param array $remoteBeans
348
+	 */
349
+	protected function setRelationships($pivotTableName, array $remoteBeans)
350
+	{
351
+		$storage = $this->retrieveRelationshipsStorage($pivotTableName);
352
+
353
+		foreach ($storage as $oldRemoteBean) {
354
+			if (!in_array($oldRemoteBean, $remoteBeans, true)) {
355
+				// $oldRemoteBean must be removed
356
+				$this->_removeRelationship($pivotTableName, $oldRemoteBean);
357
+			}
358
+		}
359
+
360
+		foreach ($remoteBeans as $remoteBean) {
361
+			if (!$storage->contains($remoteBean) || $storage[$remoteBean]['status'] === 'delete') {
362
+				// $remoteBean must be added
363
+				$this->addRelationship($pivotTableName, $remoteBean);
364
+			}
365
+		}
366
+	}
367
+
368
+	/**
369
+	 * Returns the list of objects linked to this bean via $pivotTableName.
370
+	 *
371
+	 * @param $pivotTableName
372
+	 *
373
+	 * @return \SplObjectStorage
374
+	 */
375
+	private function retrieveRelationshipsStorage($pivotTableName)
376
+	{
377
+		$storage = $this->getRelationshipStorage($pivotTableName);
378
+		if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName])) {
379
+			return $storage;
380
+		}
381
+
382
+		$beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this);
383
+		$this->loadedRelationships[$pivotTableName] = true;
384
+
385
+		foreach ($beans as $bean) {
386
+			if (isset($storage[$bean])) {
387
+				$oldStatus = $storage[$bean]['status'];
388
+				if ($oldStatus === 'delete') {
389
+					// Keep deleted things deleted
390
+					continue;
391
+				}
392
+			}
393
+			$this->setRelationship($pivotTableName, $bean, 'loaded');
394
+		}
395
+
396
+		return $storage;
397
+	}
398
+
399
+	/**
400
+	 * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
401
+	 *
402
+	 * @param $pivotTableName
403
+	 *
404
+	 * @return AbstractTDBMObject[]
405
+	 */
406
+	public function _getRelationships($pivotTableName)
407
+	{
408
+		return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
409
+	}
410
+
411
+	private function relationshipStorageToArray(\SplObjectStorage $storage)
412
+	{
413
+		$beans = [];
414
+		foreach ($storage as $bean) {
415
+			$statusArr = $storage[$bean];
416
+			if ($statusArr['status'] !== 'delete') {
417
+				$beans[] = $bean;
418
+			}
419
+		}
420
+
421
+		return $beans;
422
+	}
423
+
424
+	/**
425
+	 * Declares a relationship between.
426
+	 *
427
+	 * @param string             $pivotTableName
428
+	 * @param AbstractTDBMObject $remoteBean
429
+	 * @param string             $status
430
+	 */
431
+	private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status)
432
+	{
433
+		$storage = $this->getRelationshipStorage($pivotTableName);
434
+		$storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
435
+		if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
436
+			$this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
437
+		}
438
+
439
+		$remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
440
+		$remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
441
+	}
442
+
443
+	/**
444
+	 * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
445
+	 *
446
+	 * @param string $pivotTableName
447
+	 *
448
+	 * @return \SplObjectStorage
449
+	 */
450
+	private function getRelationshipStorage(string $pivotTableName) : \SplObjectStorage
451
+	{
452
+		return $this->relationships[$pivotTableName] ?? $this->relationships[$pivotTableName] = new \SplObjectStorage();
453
+	}
454
+
455
+	/**
456
+	 * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
457
+	 *
458
+	 * @param string $tableName
459
+	 * @param string $foreignKeyName
460
+	 *
461
+	 * @return AlterableResultIterator
462
+	 */
463
+	private function getManyToOneAlterableResultIterator(string $tableName, string $foreignKeyName) : AlterableResultIterator
464
+	{
465
+		$key = $tableName.'___'.$foreignKeyName;
466
+
467
+		return $this->manyToOneRelationships[$key] ?? $this->manyToOneRelationships[$key] = new AlterableResultIterator();
468
+	}
469
+
470
+	/**
471
+	 * Declares a relationship between this bean and the bean pointing to it.
472
+	 *
473
+	 * @param string             $tableName
474
+	 * @param string             $foreignKeyName
475
+	 * @param AbstractTDBMObject $remoteBean
476
+	 */
477
+	private function setManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean)
478
+	{
479
+		$alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
480
+		$alterableResultIterator->add($remoteBean);
481
+	}
482
+
483
+	/**
484
+	 * Declares a relationship between this bean and the bean pointing to it.
485
+	 *
486
+	 * @param string             $tableName
487
+	 * @param string             $foreignKeyName
488
+	 * @param AbstractTDBMObject $remoteBean
489
+	 */
490
+	private function removeManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean)
491
+	{
492
+		$alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
493
+		$alterableResultIterator->remove($remoteBean);
494
+	}
495
+
496
+	/**
497
+	 * Returns the list of objects linked to this bean via a given foreign key.
498
+	 *
499
+	 * @param string $tableName
500
+	 * @param string $foreignKeyName
501
+	 * @param string $searchTableName
502
+	 * @param array  $searchFilter
503
+	 * @param string $orderString     The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column). WARNING : This parameter is not kept when there is an additionnal or removal object !
504
+	 *
505
+	 * @return AlterableResultIterator
506
+	 */
507
+	protected function retrieveManyToOneRelationshipsStorage(string $tableName, string $foreignKeyName, string $searchTableName, array $searchFilter, $orderString = null) : AlterableResultIterator
508
+	{
509
+		$key = $tableName.'___'.$foreignKeyName;
510
+		$alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
511
+		if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->manyToOneRelationships[$key]) && $this->manyToOneRelationships[$key]->getUnderlyingResultIterator() !== null)) {
512
+			return $alterableResultIterator;
513
+		}
514
+
515
+		$unalteredResultIterator = $this->tdbmService->findObjects($searchTableName, $searchFilter, [], $orderString);
516
+
517
+		$alterableResultIterator->setResultIterator($unalteredResultIterator->getIterator());
518
+
519
+		return $alterableResultIterator;
520
+	}
521
+
522
+	/**
523
+	 * Reverts any changes made to the object and resumes it to its DB state.
524
+	 * This can only be called on objects that come from database and that have not been deleted.
525
+	 * Otherwise, this will throw an exception.
526
+	 *
527
+	 * @throws TDBMException
528
+	 */
529
+	public function discardChanges()
530
+	{
531
+		if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) {
532
+			throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved.");
533
+		}
534
+
535
+		if ($this->status === TDBMObjectStateEnum::STATE_DELETED) {
536
+			throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.');
537
+		}
538
+
539
+		$this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
540
+	}
541
+
542
+	/**
543
+	 * Method used internally by TDBM. You should not use it directly.
544
+	 * This method returns the status of the TDBMObject.
545
+	 * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
546
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
547
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
548
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
549
+	 *
550
+	 * @return string
551
+	 */
552
+	public function _getStatus()
553
+	{
554
+		return $this->status;
555
+	}
556
+
557
+	/**
558
+	 * Override the native php clone function for TDBMObjects.
559
+	 */
560
+	public function __clone()
561
+	{
562
+		// Let's clone the many to many relationships
563
+		if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) {
564
+			$pivotTableList = array_keys($this->relationships);
565
+		} else {
566
+			$pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this);
567
+		}
568
+
569
+		foreach ($pivotTableList as $pivotTable) {
570
+			$storage = $this->retrieveRelationshipsStorage($pivotTable);
571
+
572
+			// Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!!
573
+			/*foreach ($storage as $remoteBean) {
574 574
                 $metadata = $storage[$remoteBean];
575 575
 
576 576
                 $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable);
577 577
                 $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]);
578 578
             }*/
579
-        }
580
-
581
-        // Let's clone each row
582
-        foreach ($this->dbRows as $key => &$dbRow) {
583
-            $dbRow = clone $dbRow;
584
-            $dbRow->setTDBMObject($this);
585
-        }
586
-
587
-        $this->manyToOneRelationships = [];
588
-
589
-        // Let's set the status to new (to enter the save function)
590
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
591
-    }
592
-
593
-    /**
594
-     * Returns raw database rows.
595
-     *
596
-     * @return DbRow[] Key: table name, Value: DbRow object
597
-     */
598
-    public function _getDbRows()
599
-    {
600
-        return $this->dbRows;
601
-    }
602
-
603
-    private function registerTable($tableName)
604
-    {
605
-        $dbRow = new DbRow($this, $tableName);
606
-
607
-        if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
608
-            // Let's get the primary key for the new table
609
-            $anotherDbRow = array_values($this->dbRows)[0];
610
-            /* @var $anotherDbRow DbRow */
611
-            $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys());
612
-            $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys);
613
-            $dbRow->_setPrimaryKeys($primaryKeys);
614
-        }
615
-
616
-        $dbRow->_setStatus($this->status);
617
-
618
-        $this->dbRows[$tableName] = $dbRow;
619
-        // TODO: look at status (if not new)=> get primary key from tdbmservice
620
-    }
621
-
622
-    /**
623
-     * Internal function: return the list of relationships.
624
-     *
625
-     * @return \SplObjectStorage[]
626
-     */
627
-    public function _getCachedRelationships()
628
-    {
629
-        return $this->relationships;
630
-    }
631
-
632
-    /**
633
-     * Returns an array of used tables by this bean (from parent to child relationship).
634
-     *
635
-     * @return string[]
636
-     */
637
-    abstract protected function getUsedTables();
638
-
639
-    /**
640
-     * Method called when the bean is removed from database.
641
-     */
642
-    protected function onDelete()
643
-    {
644
-    }
579
+		}
580
+
581
+		// Let's clone each row
582
+		foreach ($this->dbRows as $key => &$dbRow) {
583
+			$dbRow = clone $dbRow;
584
+			$dbRow->setTDBMObject($this);
585
+		}
586
+
587
+		$this->manyToOneRelationships = [];
588
+
589
+		// Let's set the status to new (to enter the save function)
590
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
591
+	}
592
+
593
+	/**
594
+	 * Returns raw database rows.
595
+	 *
596
+	 * @return DbRow[] Key: table name, Value: DbRow object
597
+	 */
598
+	public function _getDbRows()
599
+	{
600
+		return $this->dbRows;
601
+	}
602
+
603
+	private function registerTable($tableName)
604
+	{
605
+		$dbRow = new DbRow($this, $tableName);
606
+
607
+		if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
608
+			// Let's get the primary key for the new table
609
+			$anotherDbRow = array_values($this->dbRows)[0];
610
+			/* @var $anotherDbRow DbRow */
611
+			$indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys());
612
+			$primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys);
613
+			$dbRow->_setPrimaryKeys($primaryKeys);
614
+		}
615
+
616
+		$dbRow->_setStatus($this->status);
617
+
618
+		$this->dbRows[$tableName] = $dbRow;
619
+		// TODO: look at status (if not new)=> get primary key from tdbmservice
620
+	}
621
+
622
+	/**
623
+	 * Internal function: return the list of relationships.
624
+	 *
625
+	 * @return \SplObjectStorage[]
626
+	 */
627
+	public function _getCachedRelationships()
628
+	{
629
+		return $this->relationships;
630
+	}
631
+
632
+	/**
633
+	 * Returns an array of used tables by this bean (from parent to child relationship).
634
+	 *
635
+	 * @return string[]
636
+	 */
637
+	abstract protected function getUsedTables();
638
+
639
+	/**
640
+	 * Method called when the bean is removed from database.
641
+	 */
642
+	protected function onDelete()
643
+	{
644
+	}
645 645
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/Utils/BeanDescriptor.php 1 patch
Indentation   +635 added lines, -635 removed lines patch added patch discarded remove patch
@@ -17,228 +17,228 @@  discard block
 block discarded – undo
17 17
  */
18 18
 class BeanDescriptor
19 19
 {
20
-    /**
21
-     * @var Table
22
-     */
23
-    private $table;
24
-
25
-    /**
26
-     * @var SchemaAnalyzer
27
-     */
28
-    private $schemaAnalyzer;
29
-
30
-    /**
31
-     * @var Schema
32
-     */
33
-    private $schema;
34
-
35
-    /**
36
-     * @var AbstractBeanPropertyDescriptor[]
37
-     */
38
-    private $beanPropertyDescriptors = [];
39
-
40
-    /**
41
-     * @var TDBMSchemaAnalyzer
42
-     */
43
-    private $tdbmSchemaAnalyzer;
44
-
45
-    public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
46
-    {
47
-        $this->table = $table;
48
-        $this->schemaAnalyzer = $schemaAnalyzer;
49
-        $this->schema = $schema;
50
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
51
-        $this->initBeanPropertyDescriptors();
52
-    }
53
-
54
-    private function initBeanPropertyDescriptors()
55
-    {
56
-        $this->beanPropertyDescriptors = $this->getProperties($this->table);
57
-    }
58
-
59
-    /**
60
-     * Returns the foreign-key the column is part of, if any. null otherwise.
61
-     *
62
-     * @param Table  $table
63
-     * @param Column $column
64
-     *
65
-     * @return ForeignKeyConstraint|null
66
-     */
67
-    private function isPartOfForeignKey(Table $table, Column $column)
68
-    {
69
-        $localColumnName = $column->getName();
70
-        foreach ($table->getForeignKeys() as $foreignKey) {
71
-            foreach ($foreignKey->getColumns() as $columnName) {
72
-                if ($columnName === $localColumnName) {
73
-                    return $foreignKey;
74
-                }
75
-            }
76
-        }
77
-
78
-        return;
79
-    }
80
-
81
-    /**
82
-     * @return AbstractBeanPropertyDescriptor[]
83
-     */
84
-    public function getBeanPropertyDescriptors()
85
-    {
86
-        return $this->beanPropertyDescriptors;
87
-    }
88
-
89
-    /**
90
-     * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent.
91
-     *
92
-     * @return AbstractBeanPropertyDescriptor[]
93
-     */
94
-    public function getConstructorProperties()
95
-    {
96
-        $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
97
-            return $property->isCompulsory();
98
-        });
99
-
100
-        return $constructorProperties;
101
-    }
102
-
103
-    /**
104
-     * Returns the list of columns that have default values for a given table.
105
-     *
106
-     * @return AbstractBeanPropertyDescriptor[]
107
-     */
108
-    public function getPropertiesWithDefault()
109
-    {
110
-        $properties = $this->getPropertiesForTable($this->table);
111
-        $defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) {
112
-            return $property->hasDefault();
113
-        });
114
-
115
-        return $defaultProperties;
116
-    }
117
-
118
-    /**
119
-     * Returns the list of properties exposed as getters and setters in this class.
120
-     *
121
-     * @return AbstractBeanPropertyDescriptor[]
122
-     */
123
-    public function getExposedProperties()
124
-    {
125
-        $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
126
-            return $property->getTable()->getName() == $this->table->getName();
127
-        });
128
-
129
-        return $exposedProperties;
130
-    }
131
-
132
-    /**
133
-     * Returns the list of properties for this table (including parent tables).
134
-     *
135
-     * @param Table $table
136
-     *
137
-     * @return AbstractBeanPropertyDescriptor[]
138
-     */
139
-    private function getProperties(Table $table)
140
-    {
141
-        $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
142
-        if ($parentRelationship) {
143
-            $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());
144
-            $properties = $this->getProperties($parentTable);
145
-            // we merge properties by overriding property names.
146
-            $localProperties = $this->getPropertiesForTable($table);
147
-            foreach ($localProperties as $name => $property) {
148
-                // We do not override properties if this is a primary key!
149
-                if ($property->isPrimaryKey()) {
150
-                    continue;
151
-                }
152
-                $properties[$name] = $property;
153
-            }
154
-        } else {
155
-            $properties = $this->getPropertiesForTable($table);
156
-        }
157
-
158
-        return $properties;
159
-    }
160
-
161
-    /**
162
-     * Returns the list of properties for this table (ignoring parent tables).
163
-     *
164
-     * @param Table $table
165
-     *
166
-     * @return AbstractBeanPropertyDescriptor[]
167
-     */
168
-    private function getPropertiesForTable(Table $table)
169
-    {
170
-        $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
171
-        if ($parentRelationship) {
172
-            $ignoreColumns = $parentRelationship->getLocalColumns();
173
-        } else {
174
-            $ignoreColumns = [];
175
-        }
176
-
177
-        $beanPropertyDescriptors = [];
178
-
179
-        foreach ($table->getColumns() as $column) {
180
-            if (array_search($column->getName(), $ignoreColumns) !== false) {
181
-                continue;
182
-            }
183
-
184
-            $fk = $this->isPartOfForeignKey($table, $column);
185
-            if ($fk !== null) {
186
-                // Check that previously added descriptors are not added on same FK (can happen with multi key FK).
187
-                foreach ($beanPropertyDescriptors as $beanDescriptor) {
188
-                    if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) {
189
-                        continue 2;
190
-                    }
191
-                }
192
-                // Check that this property is not an inheritance relationship
193
-                $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
194
-                if ($parentRelationship === $fk) {
195
-                    continue;
196
-                }
197
-
198
-                $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer);
199
-            } else {
200
-                $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column);
201
-            }
202
-        }
203
-
204
-        // Now, let's get the name of all properties and let's check there is no duplicate.
205
-        /** @var $names AbstractBeanPropertyDescriptor[] */
206
-        $names = [];
207
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
208
-            $name = $beanDescriptor->getUpperCamelCaseName();
209
-            if (isset($names[$name])) {
210
-                $names[$name]->useAlternativeName();
211
-                $beanDescriptor->useAlternativeName();
212
-            } else {
213
-                $names[$name] = $beanDescriptor;
214
-            }
215
-        }
216
-
217
-        // Final check (throw exceptions if problem arises)
218
-        $names = [];
219
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
220
-            $name = $beanDescriptor->getUpperCamelCaseName();
221
-            if (isset($names[$name])) {
222
-                throw new TDBMException('Unsolvable name conflict while generating method name');
223
-            } else {
224
-                $names[$name] = $beanDescriptor;
225
-            }
226
-        }
227
-
228
-        // Last step, let's rebuild the list with a map:
229
-        $beanPropertyDescriptorsMap = [];
230
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
231
-            $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor;
232
-        }
233
-
234
-        return $beanPropertyDescriptorsMap;
235
-    }
236
-
237
-    public function generateBeanConstructor()
238
-    {
239
-        $constructorProperties = $this->getConstructorProperties();
240
-
241
-        $constructorCode = '    /**
20
+	/**
21
+	 * @var Table
22
+	 */
23
+	private $table;
24
+
25
+	/**
26
+	 * @var SchemaAnalyzer
27
+	 */
28
+	private $schemaAnalyzer;
29
+
30
+	/**
31
+	 * @var Schema
32
+	 */
33
+	private $schema;
34
+
35
+	/**
36
+	 * @var AbstractBeanPropertyDescriptor[]
37
+	 */
38
+	private $beanPropertyDescriptors = [];
39
+
40
+	/**
41
+	 * @var TDBMSchemaAnalyzer
42
+	 */
43
+	private $tdbmSchemaAnalyzer;
44
+
45
+	public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
46
+	{
47
+		$this->table = $table;
48
+		$this->schemaAnalyzer = $schemaAnalyzer;
49
+		$this->schema = $schema;
50
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
51
+		$this->initBeanPropertyDescriptors();
52
+	}
53
+
54
+	private function initBeanPropertyDescriptors()
55
+	{
56
+		$this->beanPropertyDescriptors = $this->getProperties($this->table);
57
+	}
58
+
59
+	/**
60
+	 * Returns the foreign-key the column is part of, if any. null otherwise.
61
+	 *
62
+	 * @param Table  $table
63
+	 * @param Column $column
64
+	 *
65
+	 * @return ForeignKeyConstraint|null
66
+	 */
67
+	private function isPartOfForeignKey(Table $table, Column $column)
68
+	{
69
+		$localColumnName = $column->getName();
70
+		foreach ($table->getForeignKeys() as $foreignKey) {
71
+			foreach ($foreignKey->getColumns() as $columnName) {
72
+				if ($columnName === $localColumnName) {
73
+					return $foreignKey;
74
+				}
75
+			}
76
+		}
77
+
78
+		return;
79
+	}
80
+
81
+	/**
82
+	 * @return AbstractBeanPropertyDescriptor[]
83
+	 */
84
+	public function getBeanPropertyDescriptors()
85
+	{
86
+		return $this->beanPropertyDescriptors;
87
+	}
88
+
89
+	/**
90
+	 * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent.
91
+	 *
92
+	 * @return AbstractBeanPropertyDescriptor[]
93
+	 */
94
+	public function getConstructorProperties()
95
+	{
96
+		$constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
97
+			return $property->isCompulsory();
98
+		});
99
+
100
+		return $constructorProperties;
101
+	}
102
+
103
+	/**
104
+	 * Returns the list of columns that have default values for a given table.
105
+	 *
106
+	 * @return AbstractBeanPropertyDescriptor[]
107
+	 */
108
+	public function getPropertiesWithDefault()
109
+	{
110
+		$properties = $this->getPropertiesForTable($this->table);
111
+		$defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) {
112
+			return $property->hasDefault();
113
+		});
114
+
115
+		return $defaultProperties;
116
+	}
117
+
118
+	/**
119
+	 * Returns the list of properties exposed as getters and setters in this class.
120
+	 *
121
+	 * @return AbstractBeanPropertyDescriptor[]
122
+	 */
123
+	public function getExposedProperties()
124
+	{
125
+		$exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
126
+			return $property->getTable()->getName() == $this->table->getName();
127
+		});
128
+
129
+		return $exposedProperties;
130
+	}
131
+
132
+	/**
133
+	 * Returns the list of properties for this table (including parent tables).
134
+	 *
135
+	 * @param Table $table
136
+	 *
137
+	 * @return AbstractBeanPropertyDescriptor[]
138
+	 */
139
+	private function getProperties(Table $table)
140
+	{
141
+		$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
142
+		if ($parentRelationship) {
143
+			$parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());
144
+			$properties = $this->getProperties($parentTable);
145
+			// we merge properties by overriding property names.
146
+			$localProperties = $this->getPropertiesForTable($table);
147
+			foreach ($localProperties as $name => $property) {
148
+				// We do not override properties if this is a primary key!
149
+				if ($property->isPrimaryKey()) {
150
+					continue;
151
+				}
152
+				$properties[$name] = $property;
153
+			}
154
+		} else {
155
+			$properties = $this->getPropertiesForTable($table);
156
+		}
157
+
158
+		return $properties;
159
+	}
160
+
161
+	/**
162
+	 * Returns the list of properties for this table (ignoring parent tables).
163
+	 *
164
+	 * @param Table $table
165
+	 *
166
+	 * @return AbstractBeanPropertyDescriptor[]
167
+	 */
168
+	private function getPropertiesForTable(Table $table)
169
+	{
170
+		$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
171
+		if ($parentRelationship) {
172
+			$ignoreColumns = $parentRelationship->getLocalColumns();
173
+		} else {
174
+			$ignoreColumns = [];
175
+		}
176
+
177
+		$beanPropertyDescriptors = [];
178
+
179
+		foreach ($table->getColumns() as $column) {
180
+			if (array_search($column->getName(), $ignoreColumns) !== false) {
181
+				continue;
182
+			}
183
+
184
+			$fk = $this->isPartOfForeignKey($table, $column);
185
+			if ($fk !== null) {
186
+				// Check that previously added descriptors are not added on same FK (can happen with multi key FK).
187
+				foreach ($beanPropertyDescriptors as $beanDescriptor) {
188
+					if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) {
189
+						continue 2;
190
+					}
191
+				}
192
+				// Check that this property is not an inheritance relationship
193
+				$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
194
+				if ($parentRelationship === $fk) {
195
+					continue;
196
+				}
197
+
198
+				$beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer);
199
+			} else {
200
+				$beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column);
201
+			}
202
+		}
203
+
204
+		// Now, let's get the name of all properties and let's check there is no duplicate.
205
+		/** @var $names AbstractBeanPropertyDescriptor[] */
206
+		$names = [];
207
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
208
+			$name = $beanDescriptor->getUpperCamelCaseName();
209
+			if (isset($names[$name])) {
210
+				$names[$name]->useAlternativeName();
211
+				$beanDescriptor->useAlternativeName();
212
+			} else {
213
+				$names[$name] = $beanDescriptor;
214
+			}
215
+		}
216
+
217
+		// Final check (throw exceptions if problem arises)
218
+		$names = [];
219
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
220
+			$name = $beanDescriptor->getUpperCamelCaseName();
221
+			if (isset($names[$name])) {
222
+				throw new TDBMException('Unsolvable name conflict while generating method name');
223
+			} else {
224
+				$names[$name] = $beanDescriptor;
225
+			}
226
+		}
227
+
228
+		// Last step, let's rebuild the list with a map:
229
+		$beanPropertyDescriptorsMap = [];
230
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
231
+			$beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor;
232
+		}
233
+
234
+		return $beanPropertyDescriptorsMap;
235
+	}
236
+
237
+	public function generateBeanConstructor()
238
+	{
239
+		$constructorProperties = $this->getConstructorProperties();
240
+
241
+		$constructorCode = '    /**
242 242
      * The constructor takes all compulsory arguments.
243 243
      *
244 244
 %s
@@ -249,69 +249,69 @@  discard block
 block discarded – undo
249 249
     }
250 250
     ';
251 251
 
252
-        $paramAnnotations = [];
253
-        $arguments = [];
254
-        $assigns = [];
255
-        $parentConstructorArguments = [];
256
-
257
-        foreach ($constructorProperties as $property) {
258
-            $className = $property->getClassName();
259
-            if ($className) {
260
-                $arguments[] = $className.' '.$property->getVariableName();
261
-            } else {
262
-                $arguments[] = $property->getVariableName();
263
-            }
264
-            $paramAnnotations[] = $property->getParamAnnotation();
265
-            if ($property->getTable()->getName() === $this->table->getName()) {
266
-                $assigns[] = $property->getConstructorAssignCode();
267
-            } else {
268
-                $parentConstructorArguments[] = $property->getVariableName();
269
-            }
270
-        }
271
-
272
-        $parentConstructorCode = sprintf("        parent::__construct(%s);\n", implode(', ', $parentConstructorArguments));
273
-
274
-        foreach ($this->getPropertiesWithDefault() as $property) {
275
-            $assigns[] = $property->assignToDefaultCode();
276
-        }
277
-
278
-        return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns));
279
-    }
280
-
281
-    public function generateDirectForeignKeysCode()
282
-    {
283
-        $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
284
-
285
-        $fksByTable = [];
286
-
287
-        foreach ($fks as $fk) {
288
-            $fksByTable[$fk->getLocalTableName()][] = $fk;
289
-        }
290
-
291
-        /* @var $fksByMethodName ForeignKeyConstraint[] */
292
-        $fksByMethodName = [];
293
-
294
-        foreach ($fksByTable as $tableName => $fksForTable) {
295
-            if (count($fksForTable) > 1) {
296
-                foreach ($fksForTable as $fk) {
297
-                    $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
298
-
299
-                    $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns());
300
-
301
-                    $methodName .= implode('And', $camelizedColumns);
302
-
303
-                    $fksByMethodName[$methodName] = $fk;
304
-                }
305
-            } else {
306
-                $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName());
307
-                $fksByMethodName[$methodName] = $fksForTable[0];
308
-            }
309
-        }
310
-
311
-        $code = '';
312
-
313
-        foreach ($fksByMethodName as $methodName => $fk) {
314
-            $getterCode = '    /**
252
+		$paramAnnotations = [];
253
+		$arguments = [];
254
+		$assigns = [];
255
+		$parentConstructorArguments = [];
256
+
257
+		foreach ($constructorProperties as $property) {
258
+			$className = $property->getClassName();
259
+			if ($className) {
260
+				$arguments[] = $className.' '.$property->getVariableName();
261
+			} else {
262
+				$arguments[] = $property->getVariableName();
263
+			}
264
+			$paramAnnotations[] = $property->getParamAnnotation();
265
+			if ($property->getTable()->getName() === $this->table->getName()) {
266
+				$assigns[] = $property->getConstructorAssignCode();
267
+			} else {
268
+				$parentConstructorArguments[] = $property->getVariableName();
269
+			}
270
+		}
271
+
272
+		$parentConstructorCode = sprintf("        parent::__construct(%s);\n", implode(', ', $parentConstructorArguments));
273
+
274
+		foreach ($this->getPropertiesWithDefault() as $property) {
275
+			$assigns[] = $property->assignToDefaultCode();
276
+		}
277
+
278
+		return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns));
279
+	}
280
+
281
+	public function generateDirectForeignKeysCode()
282
+	{
283
+		$fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
284
+
285
+		$fksByTable = [];
286
+
287
+		foreach ($fks as $fk) {
288
+			$fksByTable[$fk->getLocalTableName()][] = $fk;
289
+		}
290
+
291
+		/* @var $fksByMethodName ForeignKeyConstraint[] */
292
+		$fksByMethodName = [];
293
+
294
+		foreach ($fksByTable as $tableName => $fksForTable) {
295
+			if (count($fksForTable) > 1) {
296
+				foreach ($fksForTable as $fk) {
297
+					$methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
298
+
299
+					$camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns());
300
+
301
+					$methodName .= implode('And', $camelizedColumns);
302
+
303
+					$fksByMethodName[$methodName] = $fk;
304
+				}
305
+			} else {
306
+				$methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName());
307
+				$fksByMethodName[$methodName] = $fksForTable[0];
308
+			}
309
+		}
310
+
311
+		$code = '';
312
+
313
+		foreach ($fksByMethodName as $methodName => $fk) {
314
+			$getterCode = '    /**
315 315
      * Returns the list of %s pointing to this bean via the %s column.
316 316
      *
317 317
      * @return %s[]|AlterableResultIterator
@@ -323,107 +323,107 @@  discard block
 block discarded – undo
323 323
 
324 324
 ';
325 325
 
326
-            $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
327
-            $code .= sprintf($getterCode,
328
-                $beanClass,
329
-                implode(', ', $fk->getColumns()),
330
-                $beanClass,
331
-                $methodName,
332
-                var_export($fk->getLocalTableName(), true),
333
-                var_export($fk->getName(), true),
334
-                var_export($fk->getLocalTableName(), true),
335
-                $this->getFilters($fk)
336
-            );
337
-        }
338
-
339
-        return $code;
340
-    }
341
-
342
-    private function getFilters(ForeignKeyConstraint $fk) : string
343
-    {
344
-        $counter = 0;
345
-        $parameters = [];
346
-
347
-        $pkColumns = $this->table->getPrimaryKeyColumns();
348
-
349
-        foreach ($fk->getLocalColumns() as $columnName) {
350
-            $pkColumn = $pkColumns[$counter];
351
-            $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($fk->getLocalTableName().'.'.$columnName, true), var_export($pkColumn, true), var_export($this->table->getName(), true));
352
-            ++$counter;
353
-        }
354
-        $parametersCode = '['.implode(', ', $parameters).']';
355
-
356
-        return $parametersCode;
357
-    }
358
-
359
-    /**
360
-     * Generate code section about pivot tables.
361
-     *
362
-     * @return string
363
-     */
364
-    public function generatePivotTableCode()
365
-    {
366
-        $finalDescs = $this->getPivotTableDescriptors();
367
-
368
-        $code = '';
369
-
370
-        foreach ($finalDescs as $desc) {
371
-            $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']);
372
-        }
373
-
374
-        return $code;
375
-    }
376
-
377
-    private function getPivotTableDescriptors()
378
-    {
379
-        $descs = [];
380
-        foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) {
381
-            // There are exactly 2 FKs since this is a pivot table.
382
-            $fks = array_values($table->getForeignKeys());
383
-
384
-            if ($fks[0]->getForeignTableName() === $this->table->getName()) {
385
-                $localFK = $fks[0];
386
-                $remoteFK = $fks[1];
387
-            } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
388
-                $localFK = $fks[1];
389
-                $remoteFK = $fks[0];
390
-            } else {
391
-                continue;
392
-            }
393
-
394
-            $descs[$remoteFK->getForeignTableName()][] = [
395
-                'table' => $table,
396
-                'localFK' => $localFK,
397
-                'remoteFK' => $remoteFK,
398
-            ];
399
-        }
400
-
401
-        $finalDescs = [];
402
-        foreach ($descs as $descArray) {
403
-            if (count($descArray) > 1) {
404
-                foreach ($descArray as $desc) {
405
-                    $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
406
-                    $finalDescs[] = $desc;
407
-                }
408
-            } else {
409
-                $desc = $descArray[0];
410
-                $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName());
411
-                $finalDescs[] = $desc;
412
-            }
413
-        }
414
-
415
-        return $finalDescs;
416
-    }
417
-
418
-    public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK)
419
-    {
420
-        $singularName = TDBMDaoGenerator::toSingular($name);
421
-        $pluralName = $name;
422
-        $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
423
-        $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
424
-        $pluralVariableName = $variableName.'s';
425
-
426
-        $str = '    /**
326
+			$beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
327
+			$code .= sprintf($getterCode,
328
+				$beanClass,
329
+				implode(', ', $fk->getColumns()),
330
+				$beanClass,
331
+				$methodName,
332
+				var_export($fk->getLocalTableName(), true),
333
+				var_export($fk->getName(), true),
334
+				var_export($fk->getLocalTableName(), true),
335
+				$this->getFilters($fk)
336
+			);
337
+		}
338
+
339
+		return $code;
340
+	}
341
+
342
+	private function getFilters(ForeignKeyConstraint $fk) : string
343
+	{
344
+		$counter = 0;
345
+		$parameters = [];
346
+
347
+		$pkColumns = $this->table->getPrimaryKeyColumns();
348
+
349
+		foreach ($fk->getLocalColumns() as $columnName) {
350
+			$pkColumn = $pkColumns[$counter];
351
+			$parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($fk->getLocalTableName().'.'.$columnName, true), var_export($pkColumn, true), var_export($this->table->getName(), true));
352
+			++$counter;
353
+		}
354
+		$parametersCode = '['.implode(', ', $parameters).']';
355
+
356
+		return $parametersCode;
357
+	}
358
+
359
+	/**
360
+	 * Generate code section about pivot tables.
361
+	 *
362
+	 * @return string
363
+	 */
364
+	public function generatePivotTableCode()
365
+	{
366
+		$finalDescs = $this->getPivotTableDescriptors();
367
+
368
+		$code = '';
369
+
370
+		foreach ($finalDescs as $desc) {
371
+			$code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']);
372
+		}
373
+
374
+		return $code;
375
+	}
376
+
377
+	private function getPivotTableDescriptors()
378
+	{
379
+		$descs = [];
380
+		foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) {
381
+			// There are exactly 2 FKs since this is a pivot table.
382
+			$fks = array_values($table->getForeignKeys());
383
+
384
+			if ($fks[0]->getForeignTableName() === $this->table->getName()) {
385
+				$localFK = $fks[0];
386
+				$remoteFK = $fks[1];
387
+			} elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
388
+				$localFK = $fks[1];
389
+				$remoteFK = $fks[0];
390
+			} else {
391
+				continue;
392
+			}
393
+
394
+			$descs[$remoteFK->getForeignTableName()][] = [
395
+				'table' => $table,
396
+				'localFK' => $localFK,
397
+				'remoteFK' => $remoteFK,
398
+			];
399
+		}
400
+
401
+		$finalDescs = [];
402
+		foreach ($descs as $descArray) {
403
+			if (count($descArray) > 1) {
404
+				foreach ($descArray as $desc) {
405
+					$desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
406
+					$finalDescs[] = $desc;
407
+				}
408
+			} else {
409
+				$desc = $descArray[0];
410
+				$desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName());
411
+				$finalDescs[] = $desc;
412
+			}
413
+		}
414
+
415
+		return $finalDescs;
416
+	}
417
+
418
+	public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK)
419
+	{
420
+		$singularName = TDBMDaoGenerator::toSingular($name);
421
+		$pluralName = $name;
422
+		$remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
423
+		$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
424
+		$pluralVariableName = $variableName.'s';
425
+
426
+		$str = '    /**
427 427
      * Returns the list of %s associated to this bean via the %s pivot table.
428 428
      *
429 429
      * @return %s[]
@@ -434,9 +434,9 @@  discard block
 block discarded – undo
434 434
     }
435 435
 ';
436 436
 
437
-        $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true));
437
+		$getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true));
438 438
 
439
-        $str = '    /**
439
+		$str = '    /**
440 440
      * Adds a relationship with %s associated to this bean via the %s pivot table.
441 441
      *
442 442
      * @param %s %s
@@ -447,9 +447,9 @@  discard block
 block discarded – undo
447 447
     }
448 448
 ';
449 449
 
450
-        $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
450
+		$adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
451 451
 
452
-        $str = '    /**
452
+		$str = '    /**
453 453
      * Deletes the relationship with %s associated to this bean via the %s pivot table.
454 454
      *
455 455
      * @param %s %s
@@ -460,9 +460,9 @@  discard block
 block discarded – undo
460 460
     }
461 461
 ';
462 462
 
463
-        $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
463
+		$removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
464 464
 
465
-        $str = '    /**
465
+		$str = '    /**
466 466
      * Returns whether this bean is associated with %s via the %s pivot table.
467 467
      *
468 468
      * @param %s %s
@@ -474,9 +474,9 @@  discard block
 block discarded – undo
474 474
     }
475 475
 ';
476 476
 
477
-        $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
477
+		$hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
478 478
 
479
-        $str = '    /**
479
+		$str = '    /**
480 480
      * Sets all relationships with %s associated to this bean via the %s pivot table.
481 481
      * Exiting relationships will be removed and replaced by the provided relationships.
482 482
      *
@@ -488,24 +488,24 @@  discard block
 block discarded – undo
488 488
     }
489 489
 ';
490 490
 
491
-        $setterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $pluralVariableName, $pluralName, $pluralVariableName, var_export($remoteFK->getLocalTableName(), true), $pluralVariableName);
491
+		$setterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $pluralVariableName, $pluralName, $pluralVariableName, var_export($remoteFK->getLocalTableName(), true), $pluralVariableName);
492 492
 
493
-        $code = $getterCode.$adderCode.$removerCode.$hasCode.$setterCode;
493
+		$code = $getterCode.$adderCode.$removerCode.$hasCode.$setterCode;
494 494
 
495
-        return $code;
496
-    }
495
+		return $code;
496
+	}
497 497
 
498
-    public function generateJsonSerialize()
499
-    {
500
-        $tableName = $this->table->getName();
501
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
502
-        if ($parentFk !== null) {
503
-            $initializer = '$array = parent::jsonSerialize($stopRecursion);';
504
-        } else {
505
-            $initializer = '$array = [];';
506
-        }
498
+	public function generateJsonSerialize()
499
+	{
500
+		$tableName = $this->table->getName();
501
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
502
+		if ($parentFk !== null) {
503
+			$initializer = '$array = parent::jsonSerialize($stopRecursion);';
504
+		} else {
505
+			$initializer = '$array = [];';
506
+		}
507 507
 
508
-        $str = '
508
+		$str = '
509 509
     /**
510 510
      * Serializes the object for JSON encoding.
511 511
      *
@@ -521,97 +521,97 @@  discard block
 block discarded – undo
521 521
     }
522 522
 ';
523 523
 
524
-        $propertiesCode = '';
525
-        foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
526
-            $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
527
-        }
524
+		$propertiesCode = '';
525
+		foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
526
+			$propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
527
+		}
528 528
 
529
-        // Many to many relationships:
529
+		// Many to many relationships:
530 530
 
531
-        $descs = $this->getPivotTableDescriptors();
531
+		$descs = $this->getPivotTableDescriptors();
532 532
 
533
-        $many2manyCode = '';
533
+		$many2manyCode = '';
534 534
 
535
-        foreach ($descs as $desc) {
536
-            $remoteFK = $desc['remoteFK'];
537
-            $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
538
-            $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
535
+		foreach ($descs as $desc) {
536
+			$remoteFK = $desc['remoteFK'];
537
+			$remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
538
+			$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
539 539
 
540
-            $many2manyCode .= '        if (!$stopRecursion) {
540
+			$many2manyCode .= '        if (!$stopRecursion) {
541 541
             $array[\''.lcfirst($desc['name']).'\'] = array_map(function ('.$remoteBeanName.' '.$variableName.') {
542 542
                 return '.$variableName.'->jsonSerialize(true);
543 543
             }, $this->get'.$desc['name'].'());
544 544
         }
545 545
 ';
546
-        }
547
-
548
-        return sprintf($str, $initializer, $propertiesCode, $many2manyCode);
549
-    }
550
-
551
-    /**
552
-     * Returns as an array the class we need to extend from and the list of use statements.
553
-     *
554
-     * @return array
555
-     */
556
-    private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null)
557
-    {
558
-        $classes = [];
559
-        if ($parentFk !== null) {
560
-            $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
561
-            $classes[] = $extends;
562
-        }
563
-
564
-        foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) {
565
-            $className = $beanPropertyDescriptor->getClassName();
566
-            if (null !== $className) {
567
-                $classes[] = $beanPropertyDescriptor->getClassName();
568
-            }
569
-        }
570
-
571
-        foreach ($this->getPivotTableDescriptors() as $descriptor) {
572
-            /* @var $fk ForeignKeyConstraint */
573
-            $fk = $descriptor['remoteFK'];
574
-            $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName());
575
-        }
576
-
577
-        // Many-to-one relationships
578
-        $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
579
-        foreach ($fks as $fk) {
580
-            $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
581
-        }
582
-
583
-        $classes = array_unique($classes);
584
-
585
-        return $classes;
586
-    }
587
-
588
-    /**
589
-     * Writes the PHP bean file with all getters and setters from the table passed in parameter.
590
-     *
591
-     * @param string $beannamespace The namespace of the bean
592
-     */
593
-    public function generatePhpCode($beannamespace)
594
-    {
595
-        $tableName = $this->table->getName();
596
-        $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName);
597
-        $className = TDBMDaoGenerator::getBeanNameFromTableName($tableName);
598
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
599
-
600
-        $classes = $this->generateExtendsAndUseStatements($parentFk);
601
-
602
-        $uses = array_map(function ($className) use ($beannamespace) {
603
-            return 'use '.$beannamespace.'\\'.$className.";\n";
604
-        }, $classes);
605
-        $use = implode('', $uses);
606
-
607
-        if ($parentFk !== null) {
608
-            $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
609
-        } else {
610
-            $extends = 'AbstractTDBMObject';
611
-            $use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n";
612
-        }
613
-
614
-        $str = "<?php
546
+		}
547
+
548
+		return sprintf($str, $initializer, $propertiesCode, $many2manyCode);
549
+	}
550
+
551
+	/**
552
+	 * Returns as an array the class we need to extend from and the list of use statements.
553
+	 *
554
+	 * @return array
555
+	 */
556
+	private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null)
557
+	{
558
+		$classes = [];
559
+		if ($parentFk !== null) {
560
+			$extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
561
+			$classes[] = $extends;
562
+		}
563
+
564
+		foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) {
565
+			$className = $beanPropertyDescriptor->getClassName();
566
+			if (null !== $className) {
567
+				$classes[] = $beanPropertyDescriptor->getClassName();
568
+			}
569
+		}
570
+
571
+		foreach ($this->getPivotTableDescriptors() as $descriptor) {
572
+			/* @var $fk ForeignKeyConstraint */
573
+			$fk = $descriptor['remoteFK'];
574
+			$classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName());
575
+		}
576
+
577
+		// Many-to-one relationships
578
+		$fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
579
+		foreach ($fks as $fk) {
580
+			$classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
581
+		}
582
+
583
+		$classes = array_unique($classes);
584
+
585
+		return $classes;
586
+	}
587
+
588
+	/**
589
+	 * Writes the PHP bean file with all getters and setters from the table passed in parameter.
590
+	 *
591
+	 * @param string $beannamespace The namespace of the bean
592
+	 */
593
+	public function generatePhpCode($beannamespace)
594
+	{
595
+		$tableName = $this->table->getName();
596
+		$baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName);
597
+		$className = TDBMDaoGenerator::getBeanNameFromTableName($tableName);
598
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
599
+
600
+		$classes = $this->generateExtendsAndUseStatements($parentFk);
601
+
602
+		$uses = array_map(function ($className) use ($beannamespace) {
603
+			return 'use '.$beannamespace.'\\'.$className.";\n";
604
+		}, $classes);
605
+		$use = implode('', $uses);
606
+
607
+		if ($parentFk !== null) {
608
+			$extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
609
+		} else {
610
+			$extends = 'AbstractTDBMObject';
611
+			$use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n";
612
+		}
613
+
614
+		$str = "<?php
615 615
 namespace {$beannamespace}\\Generated;
616 616
 
617 617
 use Mouf\\Database\\TDBM\\ResultIterator;
@@ -631,128 +631,128 @@  discard block
 block discarded – undo
631 631
 {
632 632
 ";
633 633
 
634
-        $str .= $this->generateBeanConstructor();
634
+		$str .= $this->generateBeanConstructor();
635 635
 
636
-        foreach ($this->getExposedProperties() as $property) {
637
-            $str .= $property->getGetterSetterCode();
638
-        }
636
+		foreach ($this->getExposedProperties() as $property) {
637
+			$str .= $property->getGetterSetterCode();
638
+		}
639 639
 
640
-        $str .= $this->generateDirectForeignKeysCode();
641
-        $str .= $this->generatePivotTableCode();
642
-        $str .= $this->generateJsonSerialize();
640
+		$str .= $this->generateDirectForeignKeysCode();
641
+		$str .= $this->generatePivotTableCode();
642
+		$str .= $this->generateJsonSerialize();
643 643
 
644
-        $str .= $this->generateGetUsedTablesCode();
644
+		$str .= $this->generateGetUsedTablesCode();
645 645
 
646
-        $str .= $this->generateOnDeleteCode();
646
+		$str .= $this->generateOnDeleteCode();
647 647
 
648
-        $str .= '}
648
+		$str .= '}
649 649
 ';
650 650
 
651
-        return $str;
652
-    }
653
-
654
-    /**
655
-     * @param string $beanNamespace
656
-     * @param string $beanClassName
657
-     *
658
-     * @return array first element: list of used beans, second item: PHP code as a string
659
-     */
660
-    public function generateFindByDaoCode($beanNamespace, $beanClassName)
661
-    {
662
-        $code = '';
663
-        $usedBeans = [];
664
-        foreach ($this->table->getIndexes() as $index) {
665
-            if (!$index->isPrimary()) {
666
-                list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName);
667
-                $code .= $codeForIndex;
668
-                $usedBeans = array_merge($usedBeans, $usedBeansForIndex);
669
-            }
670
-        }
671
-
672
-        return [$usedBeans, $code];
673
-    }
674
-
675
-    /**
676
-     * @param Index  $index
677
-     * @param string $beanNamespace
678
-     * @param string $beanClassName
679
-     *
680
-     * @return array first element: list of used beans, second item: PHP code as a string
681
-     */
682
-    private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName)
683
-    {
684
-        $columns = $index->getColumns();
685
-        $usedBeans = [];
686
-
687
-        /*
651
+		return $str;
652
+	}
653
+
654
+	/**
655
+	 * @param string $beanNamespace
656
+	 * @param string $beanClassName
657
+	 *
658
+	 * @return array first element: list of used beans, second item: PHP code as a string
659
+	 */
660
+	public function generateFindByDaoCode($beanNamespace, $beanClassName)
661
+	{
662
+		$code = '';
663
+		$usedBeans = [];
664
+		foreach ($this->table->getIndexes() as $index) {
665
+			if (!$index->isPrimary()) {
666
+				list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName);
667
+				$code .= $codeForIndex;
668
+				$usedBeans = array_merge($usedBeans, $usedBeansForIndex);
669
+			}
670
+		}
671
+
672
+		return [$usedBeans, $code];
673
+	}
674
+
675
+	/**
676
+	 * @param Index  $index
677
+	 * @param string $beanNamespace
678
+	 * @param string $beanClassName
679
+	 *
680
+	 * @return array first element: list of used beans, second item: PHP code as a string
681
+	 */
682
+	private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName)
683
+	{
684
+		$columns = $index->getColumns();
685
+		$usedBeans = [];
686
+
687
+		/*
688 688
          * The list of elements building this index (expressed as columns or foreign keys)
689 689
          * @var AbstractBeanPropertyDescriptor[]
690 690
          */
691
-        $elements = [];
692
-
693
-        foreach ($columns as $column) {
694
-            $fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column));
695
-            if ($fk !== null) {
696
-                if (!in_array($fk, $elements)) {
697
-                    $elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer);
698
-                }
699
-            } else {
700
-                $elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column));
701
-            }
702
-        }
703
-
704
-        // If the index is actually only a foreign key, let's bypass it entirely.
705
-        if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) {
706
-            return [[], ''];
707
-        }
708
-
709
-        $methodNameComponent = [];
710
-        $functionParameters = [];
711
-        $first = true;
712
-        foreach ($elements as $element) {
713
-            $methodNameComponent[] = $element->getUpperCamelCaseName();
714
-            $functionParameter = $element->getClassName();
715
-            if ($functionParameter) {
716
-                $usedBeans[] = $beanNamespace.'\\'.$functionParameter;
717
-                $functionParameter .= ' ';
718
-            }
719
-            $functionParameter .= $element->getVariableName();
720
-            if ($first) {
721
-                $first = false;
722
-            } else {
723
-                $functionParameter .= ' = null';
724
-            }
725
-            $functionParameters[] = $functionParameter;
726
-        }
727
-        if ($index->isUnique()) {
728
-            $methodName = 'findOneBy'.implode('And', $methodNameComponent);
729
-            $calledMethod = 'findOne';
730
-            $returnType = "{$beanClassName}";
731
-        } else {
732
-            $methodName = 'findBy'.implode('And', $methodNameComponent);
733
-            $returnType = "{$beanClassName}[]|ResultIterator|ResultArray";
734
-            $calledMethod = 'find';
735
-        }
736
-        $functionParametersString = implode(', ', $functionParameters);
737
-
738
-        $count = 0;
739
-
740
-        $params = [];
741
-        $filterArrayCode = '';
742
-        $commentArguments = [];
743
-        foreach ($elements as $element) {
744
-            $params[] = $element->getParamAnnotation();
745
-            if ($element instanceof ScalarBeanPropertyDescriptor) {
746
-                $filterArrayCode .= '            '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n";
747
-            } else {
748
-                ++$count;
749
-                $filterArrayCode .= '            '.$count.' => '.$element->getVariableName().",\n";
750
-            }
751
-            $commentArguments[] = substr($element->getVariableName(), 1);
752
-        }
753
-        $paramsString = implode("\n", $params);
754
-
755
-        $code = "
691
+		$elements = [];
692
+
693
+		foreach ($columns as $column) {
694
+			$fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column));
695
+			if ($fk !== null) {
696
+				if (!in_array($fk, $elements)) {
697
+					$elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer);
698
+				}
699
+			} else {
700
+				$elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column));
701
+			}
702
+		}
703
+
704
+		// If the index is actually only a foreign key, let's bypass it entirely.
705
+		if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) {
706
+			return [[], ''];
707
+		}
708
+
709
+		$methodNameComponent = [];
710
+		$functionParameters = [];
711
+		$first = true;
712
+		foreach ($elements as $element) {
713
+			$methodNameComponent[] = $element->getUpperCamelCaseName();
714
+			$functionParameter = $element->getClassName();
715
+			if ($functionParameter) {
716
+				$usedBeans[] = $beanNamespace.'\\'.$functionParameter;
717
+				$functionParameter .= ' ';
718
+			}
719
+			$functionParameter .= $element->getVariableName();
720
+			if ($first) {
721
+				$first = false;
722
+			} else {
723
+				$functionParameter .= ' = null';
724
+			}
725
+			$functionParameters[] = $functionParameter;
726
+		}
727
+		if ($index->isUnique()) {
728
+			$methodName = 'findOneBy'.implode('And', $methodNameComponent);
729
+			$calledMethod = 'findOne';
730
+			$returnType = "{$beanClassName}";
731
+		} else {
732
+			$methodName = 'findBy'.implode('And', $methodNameComponent);
733
+			$returnType = "{$beanClassName}[]|ResultIterator|ResultArray";
734
+			$calledMethod = 'find';
735
+		}
736
+		$functionParametersString = implode(', ', $functionParameters);
737
+
738
+		$count = 0;
739
+
740
+		$params = [];
741
+		$filterArrayCode = '';
742
+		$commentArguments = [];
743
+		foreach ($elements as $element) {
744
+			$params[] = $element->getParamAnnotation();
745
+			if ($element instanceof ScalarBeanPropertyDescriptor) {
746
+				$filterArrayCode .= '            '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n";
747
+			} else {
748
+				++$count;
749
+				$filterArrayCode .= '            '.$count.' => '.$element->getVariableName().",\n";
750
+			}
751
+			$commentArguments[] = substr($element->getVariableName(), 1);
752
+		}
753
+		$paramsString = implode("\n", $params);
754
+
755
+		$code = "
756 756
     /**
757 757
      * Get a list of $beanClassName filtered by ".implode(', ', $commentArguments).".
758 758
      *
@@ -770,27 +770,27 @@  discard block
 block discarded – undo
770 770
     }
771 771
 ";
772 772
 
773
-        return [$usedBeans, $code];
774
-    }
775
-
776
-    /**
777
-     * Generates the code for the getUsedTable protected method.
778
-     *
779
-     * @return string
780
-     */
781
-    private function generateGetUsedTablesCode()
782
-    {
783
-        $hasParentRelationship = $this->schemaAnalyzer->getParentRelationship($this->table->getName()) !== null;
784
-        if ($hasParentRelationship) {
785
-            $code = sprintf('        $tables = parent::getUsedTables();
773
+		return [$usedBeans, $code];
774
+	}
775
+
776
+	/**
777
+	 * Generates the code for the getUsedTable protected method.
778
+	 *
779
+	 * @return string
780
+	 */
781
+	private function generateGetUsedTablesCode()
782
+	{
783
+		$hasParentRelationship = $this->schemaAnalyzer->getParentRelationship($this->table->getName()) !== null;
784
+		if ($hasParentRelationship) {
785
+			$code = sprintf('        $tables = parent::getUsedTables();
786 786
         $tables[] = %s;
787 787
         
788 788
         return $tables;', var_export($this->table->getName(), true));
789
-        } else {
790
-            $code = sprintf('        return [ %s ];', var_export($this->table->getName(), true));
791
-        }
789
+		} else {
790
+			$code = sprintf('        return [ %s ];', var_export($this->table->getName(), true));
791
+		}
792 792
 
793
-        return sprintf('
793
+		return sprintf('
794 794
     /**
795 795
      * Returns an array of used tables by this bean (from parent to child relationship).
796 796
      *
@@ -801,20 +801,20 @@  discard block
 block discarded – undo
801 801
 %s    
802 802
     }
803 803
 ', $code);
804
-    }
805
-
806
-    private function generateOnDeleteCode()
807
-    {
808
-        $code = '';
809
-        $relationships = $this->getPropertiesForTable($this->table);
810
-        foreach ($relationships as $relationship) {
811
-            if ($relationship instanceof ObjectBeanPropertyDescriptor) {
812
-                $code .= sprintf('        $this->setRef('.var_export($relationship->getForeignKey()->getName(), true).', null, '.var_export($this->table->getName(), true).");\n");
813
-            }
814
-        }
815
-
816
-        if ($code) {
817
-            return sprintf('
804
+	}
805
+
806
+	private function generateOnDeleteCode()
807
+	{
808
+		$code = '';
809
+		$relationships = $this->getPropertiesForTable($this->table);
810
+		foreach ($relationships as $relationship) {
811
+			if ($relationship instanceof ObjectBeanPropertyDescriptor) {
812
+				$code .= sprintf('        $this->setRef('.var_export($relationship->getForeignKey()->getName(), true).', null, '.var_export($this->table->getName(), true).");\n");
813
+			}
814
+		}
815
+
816
+		if ($code) {
817
+			return sprintf('
818 818
     /**
819 819
      * Method called when the bean is removed from database.
820 820
      *
@@ -825,8 +825,8 @@  discard block
 block discarded – undo
825 825
 %s
826 826
     }
827 827
 ', $code);
828
-        }
828
+		}
829 829
 
830
-        return '';
831
-    }
830
+		return '';
831
+	}
832 832
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/QueryFactory/AbstractQueryFactory.php 1 patch
Indentation   +210 added lines, -210 removed lines patch added patch discarded remove patch
@@ -10,214 +10,214 @@
 block discarded – undo
10 10
 
11 11
 abstract class AbstractQueryFactory implements QueryFactory
12 12
 {
13
-    /**
14
-     * @var TDBMService
15
-     */
16
-    protected $tdbmService;
17
-
18
-    /**
19
-     * @var Schema
20
-     */
21
-    protected $schema;
22
-
23
-    /**
24
-     * @var OrderByAnalyzer
25
-     */
26
-    protected $orderByAnalyzer;
27
-
28
-    /**
29
-     * @var string|UncheckedOrderBy|null
30
-     */
31
-    protected $orderBy;
32
-
33
-    protected $magicSql;
34
-    protected $magicSqlCount;
35
-    protected $columnDescList;
36
-
37
-    /**
38
-     * @param TDBMService $tdbmService
39
-     */
40
-    public function __construct(TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, $orderBy)
41
-    {
42
-        $this->tdbmService = $tdbmService;
43
-        $this->schema = $schema;
44
-        $this->orderByAnalyzer = $orderByAnalyzer;
45
-        $this->orderBy = $orderBy;
46
-    }
47
-
48
-    /**
49
-     * Returns the column list that must be fetched for the SQL request.
50
-     *
51
-     * Note: MySQL dictates that ORDER BYed columns should appear in the SELECT clause.
52
-     *
53
-     * @param string                       $mainTable
54
-     * @param array                        $additionalTablesFetch
55
-     * @param string|UncheckedOrderBy|null $orderBy
56
-     *
57
-     * @return array
58
-     *
59
-     * @throws \Doctrine\DBAL\Schema\SchemaException
60
-     */
61
-    protected function getColumnsList(string $mainTable, array $additionalTablesFetch = array(), $orderBy = null)
62
-    {
63
-        // From the table name and the additional tables we want to fetch, let's build a list of all tables
64
-        // that must be part of the select columns.
65
-
66
-        $connection = $this->tdbmService->getConnection();
67
-
68
-        $tableGroups = [];
69
-        $allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($mainTable);
70
-        $tableGroupName = $this->getTableGroupName($allFetchedTables);
71
-        foreach ($allFetchedTables as $table) {
72
-            $tableGroups[$table] = $tableGroupName;
73
-        }
74
-
75
-        $columnsList = [];
76
-        $columnDescList = [];
77
-        $sortColumn = 0;
78
-        $reconstructedOrderBy = null;
79
-
80
-        if (is_string($orderBy)) {
81
-            $orderBy = trim($orderBy);
82
-            if ($orderBy === '') {
83
-                $orderBy = null;
84
-            }
85
-        }
86
-
87
-        // Now, let's deal with "order by columns"
88
-        if ($orderBy !== null) {
89
-            if ($orderBy instanceof UncheckedOrderBy) {
90
-                $securedOrderBy = false;
91
-                $orderBy = $orderBy->getOrderBy();
92
-                $reconstructedOrderBy = $orderBy;
93
-            } else {
94
-                $securedOrderBy = true;
95
-                $reconstructedOrderBys = [];
96
-            }
97
-            $orderByColumns = $this->orderByAnalyzer->analyzeOrderBy($orderBy);
98
-
99
-            // If we sort by a column, there is a high chance we will fetch the bean containing this column.
100
-            // Hence, we should add the table to the $additionalTablesFetch
101
-            foreach ($orderByColumns as $orderByColumn) {
102
-                if ($orderByColumn['type'] === 'colref') {
103
-                    if ($orderByColumn['table'] !== null) {
104
-                        $additionalTablesFetch[] = $orderByColumn['table'];
105
-                    }
106
-                    if ($securedOrderBy) {
107
-                        $reconstructedOrderBys[] = ($orderByColumn['table'] !== null ? $connection->quoteIdentifier($orderByColumn['table']).'.' : '').$connection->quoteIdentifier($orderByColumn['column']).' '.$orderByColumn['direction'];
108
-                    }
109
-                } elseif ($orderByColumn['type'] === 'expr') {
110
-                    $sortColumnName = 'sort_column_'.$sortColumn;
111
-                    $columnsList[] = $orderByColumn['expr'].' as '.$sortColumnName;
112
-                    $columnDescList[] = [
113
-                        'tableGroup' => null,
114
-                    ];
115
-                    ++$sortColumn;
116
-
117
-                    if ($securedOrderBy) {
118
-                        throw new TDBMInvalidArgumentException('Invalid ORDER BY column: "'.$orderByColumn['expr'].'". If you want to use expression in your ORDER BY clause, you must wrap them in a UncheckedOrderBy object. For instance: new UncheckedOrderBy("col1 + col2 DESC")');
119
-                    }
120
-                }
121
-            }
122
-
123
-            if ($reconstructedOrderBy === null) {
124
-                $reconstructedOrderBy = implode(', ', $reconstructedOrderBys);
125
-            }
126
-        }
127
-
128
-        foreach ($additionalTablesFetch as $additionalTable) {
129
-            $relatedTables = $this->tdbmService->_getRelatedTablesByInheritance($additionalTable);
130
-            $tableGroupName = $this->getTableGroupName($relatedTables);
131
-            foreach ($relatedTables as $table) {
132
-                $tableGroups[$table] = $tableGroupName;
133
-            }
134
-            $allFetchedTables = array_merge($allFetchedTables, $relatedTables);
135
-        }
136
-
137
-        // Let's remove any duplicate
138
-        $allFetchedTables = array_flip(array_flip($allFetchedTables));
139
-
140
-        // Now, let's build the column list
141
-        foreach ($allFetchedTables as $table) {
142
-            foreach ($this->schema->getTable($table)->getColumns() as $column) {
143
-                $columnName = $column->getName();
144
-                $columnDescList[] = [
145
-                    'as' => $table.'____'.$columnName,
146
-                    'table' => $table,
147
-                    'column' => $columnName,
148
-                    'type' => $column->getType(),
149
-                    'tableGroup' => $tableGroups[$table],
150
-                ];
151
-                $columnsList[] = $connection->quoteIdentifier($table).'.'.$connection->quoteIdentifier($columnName).' as '.
152
-                    $connection->quoteIdentifier($table.'____'.$columnName);
153
-            }
154
-        }
155
-
156
-        return [$columnDescList, $columnsList, $reconstructedOrderBy];
157
-    }
158
-
159
-    abstract protected function compute();
160
-
161
-    /**
162
-     * Returns an identifier for the group of tables passed in parameter.
163
-     *
164
-     * @param string[] $relatedTables
165
-     *
166
-     * @return string
167
-     */
168
-    protected function getTableGroupName(array $relatedTables)
169
-    {
170
-        sort($relatedTables);
171
-
172
-        return implode('_``_', $relatedTables);
173
-    }
174
-
175
-    public function getMagicSql() : string
176
-    {
177
-        if ($this->magicSql === null) {
178
-            $this->compute();
179
-        }
180
-
181
-        return $this->magicSql;
182
-    }
183
-
184
-    public function getMagicSqlCount() : string
185
-    {
186
-        if ($this->magicSqlCount === null) {
187
-            $this->compute();
188
-        }
189
-
190
-        return $this->magicSqlCount;
191
-    }
192
-
193
-    public function getColumnDescriptors() : array
194
-    {
195
-        if ($this->columnDescList === null) {
196
-            $this->compute();
197
-        }
198
-
199
-        return $this->columnDescList;
200
-    }
201
-
202
-    /**
203
-     * Sets the ORDER BY directive executed in SQL.
204
-     *
205
-     * For instance:
206
-     *
207
-     *  $queryFactory->sort('label ASC, status DESC');
208
-     *
209
-     * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
210
-     * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
211
-     *
212
-     *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
213
-     *
214
-     * @param string|UncheckedOrderBy|null $orderBy
215
-     */
216
-    public function sort($orderBy)
217
-    {
218
-        $this->orderBy = $orderBy;
219
-        $this->magicSql = null;
220
-        $this->magicSqlCount = null;
221
-        $this->columnDescList = null;
222
-    }
13
+	/**
14
+	 * @var TDBMService
15
+	 */
16
+	protected $tdbmService;
17
+
18
+	/**
19
+	 * @var Schema
20
+	 */
21
+	protected $schema;
22
+
23
+	/**
24
+	 * @var OrderByAnalyzer
25
+	 */
26
+	protected $orderByAnalyzer;
27
+
28
+	/**
29
+	 * @var string|UncheckedOrderBy|null
30
+	 */
31
+	protected $orderBy;
32
+
33
+	protected $magicSql;
34
+	protected $magicSqlCount;
35
+	protected $columnDescList;
36
+
37
+	/**
38
+	 * @param TDBMService $tdbmService
39
+	 */
40
+	public function __construct(TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, $orderBy)
41
+	{
42
+		$this->tdbmService = $tdbmService;
43
+		$this->schema = $schema;
44
+		$this->orderByAnalyzer = $orderByAnalyzer;
45
+		$this->orderBy = $orderBy;
46
+	}
47
+
48
+	/**
49
+	 * Returns the column list that must be fetched for the SQL request.
50
+	 *
51
+	 * Note: MySQL dictates that ORDER BYed columns should appear in the SELECT clause.
52
+	 *
53
+	 * @param string                       $mainTable
54
+	 * @param array                        $additionalTablesFetch
55
+	 * @param string|UncheckedOrderBy|null $orderBy
56
+	 *
57
+	 * @return array
58
+	 *
59
+	 * @throws \Doctrine\DBAL\Schema\SchemaException
60
+	 */
61
+	protected function getColumnsList(string $mainTable, array $additionalTablesFetch = array(), $orderBy = null)
62
+	{
63
+		// From the table name and the additional tables we want to fetch, let's build a list of all tables
64
+		// that must be part of the select columns.
65
+
66
+		$connection = $this->tdbmService->getConnection();
67
+
68
+		$tableGroups = [];
69
+		$allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($mainTable);
70
+		$tableGroupName = $this->getTableGroupName($allFetchedTables);
71
+		foreach ($allFetchedTables as $table) {
72
+			$tableGroups[$table] = $tableGroupName;
73
+		}
74
+
75
+		$columnsList = [];
76
+		$columnDescList = [];
77
+		$sortColumn = 0;
78
+		$reconstructedOrderBy = null;
79
+
80
+		if (is_string($orderBy)) {
81
+			$orderBy = trim($orderBy);
82
+			if ($orderBy === '') {
83
+				$orderBy = null;
84
+			}
85
+		}
86
+
87
+		// Now, let's deal with "order by columns"
88
+		if ($orderBy !== null) {
89
+			if ($orderBy instanceof UncheckedOrderBy) {
90
+				$securedOrderBy = false;
91
+				$orderBy = $orderBy->getOrderBy();
92
+				$reconstructedOrderBy = $orderBy;
93
+			} else {
94
+				$securedOrderBy = true;
95
+				$reconstructedOrderBys = [];
96
+			}
97
+			$orderByColumns = $this->orderByAnalyzer->analyzeOrderBy($orderBy);
98
+
99
+			// If we sort by a column, there is a high chance we will fetch the bean containing this column.
100
+			// Hence, we should add the table to the $additionalTablesFetch
101
+			foreach ($orderByColumns as $orderByColumn) {
102
+				if ($orderByColumn['type'] === 'colref') {
103
+					if ($orderByColumn['table'] !== null) {
104
+						$additionalTablesFetch[] = $orderByColumn['table'];
105
+					}
106
+					if ($securedOrderBy) {
107
+						$reconstructedOrderBys[] = ($orderByColumn['table'] !== null ? $connection->quoteIdentifier($orderByColumn['table']).'.' : '').$connection->quoteIdentifier($orderByColumn['column']).' '.$orderByColumn['direction'];
108
+					}
109
+				} elseif ($orderByColumn['type'] === 'expr') {
110
+					$sortColumnName = 'sort_column_'.$sortColumn;
111
+					$columnsList[] = $orderByColumn['expr'].' as '.$sortColumnName;
112
+					$columnDescList[] = [
113
+						'tableGroup' => null,
114
+					];
115
+					++$sortColumn;
116
+
117
+					if ($securedOrderBy) {
118
+						throw new TDBMInvalidArgumentException('Invalid ORDER BY column: "'.$orderByColumn['expr'].'". If you want to use expression in your ORDER BY clause, you must wrap them in a UncheckedOrderBy object. For instance: new UncheckedOrderBy("col1 + col2 DESC")');
119
+					}
120
+				}
121
+			}
122
+
123
+			if ($reconstructedOrderBy === null) {
124
+				$reconstructedOrderBy = implode(', ', $reconstructedOrderBys);
125
+			}
126
+		}
127
+
128
+		foreach ($additionalTablesFetch as $additionalTable) {
129
+			$relatedTables = $this->tdbmService->_getRelatedTablesByInheritance($additionalTable);
130
+			$tableGroupName = $this->getTableGroupName($relatedTables);
131
+			foreach ($relatedTables as $table) {
132
+				$tableGroups[$table] = $tableGroupName;
133
+			}
134
+			$allFetchedTables = array_merge($allFetchedTables, $relatedTables);
135
+		}
136
+
137
+		// Let's remove any duplicate
138
+		$allFetchedTables = array_flip(array_flip($allFetchedTables));
139
+
140
+		// Now, let's build the column list
141
+		foreach ($allFetchedTables as $table) {
142
+			foreach ($this->schema->getTable($table)->getColumns() as $column) {
143
+				$columnName = $column->getName();
144
+				$columnDescList[] = [
145
+					'as' => $table.'____'.$columnName,
146
+					'table' => $table,
147
+					'column' => $columnName,
148
+					'type' => $column->getType(),
149
+					'tableGroup' => $tableGroups[$table],
150
+				];
151
+				$columnsList[] = $connection->quoteIdentifier($table).'.'.$connection->quoteIdentifier($columnName).' as '.
152
+					$connection->quoteIdentifier($table.'____'.$columnName);
153
+			}
154
+		}
155
+
156
+		return [$columnDescList, $columnsList, $reconstructedOrderBy];
157
+	}
158
+
159
+	abstract protected function compute();
160
+
161
+	/**
162
+	 * Returns an identifier for the group of tables passed in parameter.
163
+	 *
164
+	 * @param string[] $relatedTables
165
+	 *
166
+	 * @return string
167
+	 */
168
+	protected function getTableGroupName(array $relatedTables)
169
+	{
170
+		sort($relatedTables);
171
+
172
+		return implode('_``_', $relatedTables);
173
+	}
174
+
175
+	public function getMagicSql() : string
176
+	{
177
+		if ($this->magicSql === null) {
178
+			$this->compute();
179
+		}
180
+
181
+		return $this->magicSql;
182
+	}
183
+
184
+	public function getMagicSqlCount() : string
185
+	{
186
+		if ($this->magicSqlCount === null) {
187
+			$this->compute();
188
+		}
189
+
190
+		return $this->magicSqlCount;
191
+	}
192
+
193
+	public function getColumnDescriptors() : array
194
+	{
195
+		if ($this->columnDescList === null) {
196
+			$this->compute();
197
+		}
198
+
199
+		return $this->columnDescList;
200
+	}
201
+
202
+	/**
203
+	 * Sets the ORDER BY directive executed in SQL.
204
+	 *
205
+	 * For instance:
206
+	 *
207
+	 *  $queryFactory->sort('label ASC, status DESC');
208
+	 *
209
+	 * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
210
+	 * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
211
+	 *
212
+	 *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
213
+	 *
214
+	 * @param string|UncheckedOrderBy|null $orderBy
215
+	 */
216
+	public function sort($orderBy)
217
+	{
218
+		$this->orderBy = $orderBy;
219
+		$this->magicSql = null;
220
+		$this->magicSqlCount = null;
221
+		$this->columnDescList = null;
222
+	}
223 223
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/QueryFactory/FindObjectsFromSqlQueryFactory.php 1 patch
Indentation   +187 added lines, -187 removed lines patch added patch discarded remove patch
@@ -15,191 +15,191 @@
 block discarded – undo
15 15
  */
16 16
 class FindObjectsFromSqlQueryFactory extends AbstractQueryFactory
17 17
 {
18
-    private $mainTable;
19
-    private $from;
20
-    private $filterString;
21
-    private $cache;
22
-    private $cachePrefix;
23
-
24
-    public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
25
-    {
26
-        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
27
-        $this->mainTable = $mainTable;
28
-        $this->from = $from;
29
-        $this->filterString = $filterString;
30
-        $this->schemaAnalyzer = $schemaAnalyzer;
31
-        $this->cache = $cache;
32
-        $this->cachePrefix = $cachePrefix;
33
-    }
34
-
35
-    protected function compute()
36
-    {
37
-        $connection = $this->tdbmService->getConnection();
38
-
39
-        $columnsList = null;
40
-
41
-        $allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($this->mainTable);
42
-
43
-        $columnDescList = [];
44
-
45
-        $tableGroupName = $this->getTableGroupName($allFetchedTables);
46
-
47
-        foreach ($this->schema->getTable($this->mainTable)->getColumns() as $column) {
48
-            $columnName = $column->getName();
49
-            $columnDescList[] = [
50
-                'as' => $columnName,
51
-                'table' => $this->mainTable,
52
-                'column' => $columnName,
53
-                'type' => $column->getType(),
54
-                'tableGroup' => $tableGroupName,
55
-            ];
56
-        }
57
-
58
-        $sql = 'SELECT DISTINCT '.implode(', ', array_map(function ($columnDesc) {
59
-            return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($columnDesc['column']);
60
-        }, $columnDescList)).' FROM '.$this->from;
61
-
62
-        if (count($allFetchedTables) > 1) {
63
-            list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
64
-        } elseif ($this->orderBy) {
65
-            list(, , $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
66
-        }
67
-
68
-        // Let's compute the COUNT.
69
-        $pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
70
-        $pkColumnNames = array_map(function ($pkColumn) {
71
-            return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
72
-        }, $pkColumnNames);
73
-
74
-        $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;
75
-
76
-        if (!empty($this->filterString)) {
77
-            $sql .= ' WHERE '.$this->filterString;
78
-            $countSql .= ' WHERE '.$this->filterString;
79
-        }
80
-
81
-        if (!empty($orderString)) {
82
-            $sql .= ' ORDER BY '.$orderString;
83
-        }
84
-
85
-        if (stripos($countSql, 'GROUP BY') !== false) {
86
-            throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
87
-        }
88
-
89
-        if ($columnsList !== null) {
90
-            $joinSql = '';
91
-            $parentFks = $this->getParentRelationshipForeignKeys($this->mainTable);
92
-            foreach ($parentFks as $fk) {
93
-                $joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
94
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
95
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
96
-                    $connection->quoteIdentifier($fk->getLocalColumns()[0]),
97
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
98
-                    $connection->quoteIdentifier($fk->getForeignColumns()[0])
99
-                );
100
-            }
101
-
102
-            $childrenFks = $this->getChildrenRelationshipForeignKeys($this->mainTable);
103
-            foreach ($childrenFks as $fk) {
104
-                $joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
105
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
106
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
107
-                    $connection->quoteIdentifier($fk->getForeignColumns()[0]),
108
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
109
-                    $connection->quoteIdentifier($fk->getLocalColumns()[0])
110
-                );
111
-            }
112
-
113
-            $sql = 'SELECT '.implode(', ', $columnsList).' FROM ('.$sql.') AS '.$this->mainTable.' '.$joinSql;
114
-            if (!empty($orderString)) {
115
-                $sql .= ' ORDER BY '.$orderString;
116
-            }
117
-        }
118
-
119
-        $this->magicSql = $sql;
120
-        $this->magicSqlCount = $countSql;
121
-        $this->columnDescList = $columnDescList;
122
-    }
123
-
124
-    /**
125
-     * @param string $tableName
126
-     *
127
-     * @return ForeignKeyConstraint[]
128
-     */
129
-    private function getParentRelationshipForeignKeys($tableName)
130
-    {
131
-        return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
132
-            return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
133
-        });
134
-    }
135
-
136
-    /**
137
-     * @param string $tableName
138
-     *
139
-     * @return ForeignKeyConstraint[]
140
-     */
141
-    private function getParentRelationshipForeignKeysWithoutCache($tableName)
142
-    {
143
-        $parentFks = [];
144
-        $currentTable = $tableName;
145
-        while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {
146
-            $currentTable = $currentFk->getForeignTableName();
147
-            $parentFks[] = $currentFk;
148
-        }
149
-
150
-        return $parentFks;
151
-    }
152
-
153
-    /**
154
-     * @param string $tableName
155
-     *
156
-     * @return ForeignKeyConstraint[]
157
-     */
158
-    private function getChildrenRelationshipForeignKeys(string $tableName) : array
159
-    {
160
-        return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
161
-            return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
162
-        });
163
-    }
164
-
165
-    /**
166
-     * @param string $tableName
167
-     *
168
-     * @return ForeignKeyConstraint[]
169
-     */
170
-    private function getChildrenRelationshipForeignKeysWithoutCache(string $tableName) : array
171
-    {
172
-        $children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
173
-
174
-        if (!empty($children)) {
175
-            $fksTables = array_map(function (ForeignKeyConstraint $fk) {
176
-                return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
177
-            }, $children);
178
-
179
-            $fks = array_merge($children, call_user_func_array('array_merge', $fksTables));
180
-
181
-            return $fks;
182
-        } else {
183
-            return [];
184
-        }
185
-    }
186
-
187
-    /**
188
-     * Returns an item from cache or computes it using $closure and puts it in cache.
189
-     *
190
-     * @param string   $key
191
-     * @param callable $closure
192
-     *
193
-     * @return mixed
194
-     */
195
-    protected function fromCache(string $key, callable $closure)
196
-    {
197
-        $item = $this->cache->fetch($key);
198
-        if ($item === false) {
199
-            $item = $closure();
200
-            $this->cache->save($key, $item);
201
-        }
202
-
203
-        return $item;
204
-    }
18
+	private $mainTable;
19
+	private $from;
20
+	private $filterString;
21
+	private $cache;
22
+	private $cachePrefix;
23
+
24
+	public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
25
+	{
26
+		parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
27
+		$this->mainTable = $mainTable;
28
+		$this->from = $from;
29
+		$this->filterString = $filterString;
30
+		$this->schemaAnalyzer = $schemaAnalyzer;
31
+		$this->cache = $cache;
32
+		$this->cachePrefix = $cachePrefix;
33
+	}
34
+
35
+	protected function compute()
36
+	{
37
+		$connection = $this->tdbmService->getConnection();
38
+
39
+		$columnsList = null;
40
+
41
+		$allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($this->mainTable);
42
+
43
+		$columnDescList = [];
44
+
45
+		$tableGroupName = $this->getTableGroupName($allFetchedTables);
46
+
47
+		foreach ($this->schema->getTable($this->mainTable)->getColumns() as $column) {
48
+			$columnName = $column->getName();
49
+			$columnDescList[] = [
50
+				'as' => $columnName,
51
+				'table' => $this->mainTable,
52
+				'column' => $columnName,
53
+				'type' => $column->getType(),
54
+				'tableGroup' => $tableGroupName,
55
+			];
56
+		}
57
+
58
+		$sql = 'SELECT DISTINCT '.implode(', ', array_map(function ($columnDesc) {
59
+			return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($columnDesc['column']);
60
+		}, $columnDescList)).' FROM '.$this->from;
61
+
62
+		if (count($allFetchedTables) > 1) {
63
+			list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
64
+		} elseif ($this->orderBy) {
65
+			list(, , $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
66
+		}
67
+
68
+		// Let's compute the COUNT.
69
+		$pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
70
+		$pkColumnNames = array_map(function ($pkColumn) {
71
+			return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
72
+		}, $pkColumnNames);
73
+
74
+		$countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;
75
+
76
+		if (!empty($this->filterString)) {
77
+			$sql .= ' WHERE '.$this->filterString;
78
+			$countSql .= ' WHERE '.$this->filterString;
79
+		}
80
+
81
+		if (!empty($orderString)) {
82
+			$sql .= ' ORDER BY '.$orderString;
83
+		}
84
+
85
+		if (stripos($countSql, 'GROUP BY') !== false) {
86
+			throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
87
+		}
88
+
89
+		if ($columnsList !== null) {
90
+			$joinSql = '';
91
+			$parentFks = $this->getParentRelationshipForeignKeys($this->mainTable);
92
+			foreach ($parentFks as $fk) {
93
+				$joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
94
+					$connection->quoteIdentifier($fk->getForeignTableName()),
95
+					$connection->quoteIdentifier($fk->getLocalTableName()),
96
+					$connection->quoteIdentifier($fk->getLocalColumns()[0]),
97
+					$connection->quoteIdentifier($fk->getForeignTableName()),
98
+					$connection->quoteIdentifier($fk->getForeignColumns()[0])
99
+				);
100
+			}
101
+
102
+			$childrenFks = $this->getChildrenRelationshipForeignKeys($this->mainTable);
103
+			foreach ($childrenFks as $fk) {
104
+				$joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
105
+					$connection->quoteIdentifier($fk->getLocalTableName()),
106
+					$connection->quoteIdentifier($fk->getForeignTableName()),
107
+					$connection->quoteIdentifier($fk->getForeignColumns()[0]),
108
+					$connection->quoteIdentifier($fk->getLocalTableName()),
109
+					$connection->quoteIdentifier($fk->getLocalColumns()[0])
110
+				);
111
+			}
112
+
113
+			$sql = 'SELECT '.implode(', ', $columnsList).' FROM ('.$sql.') AS '.$this->mainTable.' '.$joinSql;
114
+			if (!empty($orderString)) {
115
+				$sql .= ' ORDER BY '.$orderString;
116
+			}
117
+		}
118
+
119
+		$this->magicSql = $sql;
120
+		$this->magicSqlCount = $countSql;
121
+		$this->columnDescList = $columnDescList;
122
+	}
123
+
124
+	/**
125
+	 * @param string $tableName
126
+	 *
127
+	 * @return ForeignKeyConstraint[]
128
+	 */
129
+	private function getParentRelationshipForeignKeys($tableName)
130
+	{
131
+		return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
132
+			return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
133
+		});
134
+	}
135
+
136
+	/**
137
+	 * @param string $tableName
138
+	 *
139
+	 * @return ForeignKeyConstraint[]
140
+	 */
141
+	private function getParentRelationshipForeignKeysWithoutCache($tableName)
142
+	{
143
+		$parentFks = [];
144
+		$currentTable = $tableName;
145
+		while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {
146
+			$currentTable = $currentFk->getForeignTableName();
147
+			$parentFks[] = $currentFk;
148
+		}
149
+
150
+		return $parentFks;
151
+	}
152
+
153
+	/**
154
+	 * @param string $tableName
155
+	 *
156
+	 * @return ForeignKeyConstraint[]
157
+	 */
158
+	private function getChildrenRelationshipForeignKeys(string $tableName) : array
159
+	{
160
+		return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
161
+			return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
162
+		});
163
+	}
164
+
165
+	/**
166
+	 * @param string $tableName
167
+	 *
168
+	 * @return ForeignKeyConstraint[]
169
+	 */
170
+	private function getChildrenRelationshipForeignKeysWithoutCache(string $tableName) : array
171
+	{
172
+		$children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
173
+
174
+		if (!empty($children)) {
175
+			$fksTables = array_map(function (ForeignKeyConstraint $fk) {
176
+				return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
177
+			}, $children);
178
+
179
+			$fks = array_merge($children, call_user_func_array('array_merge', $fksTables));
180
+
181
+			return $fks;
182
+		} else {
183
+			return [];
184
+		}
185
+	}
186
+
187
+	/**
188
+	 * Returns an item from cache or computes it using $closure and puts it in cache.
189
+	 *
190
+	 * @param string   $key
191
+	 * @param callable $closure
192
+	 *
193
+	 * @return mixed
194
+	 */
195
+	protected function fromCache(string $key, callable $closure)
196
+	{
197
+		$item = $this->cache->fetch($key);
198
+		if ($item === false) {
199
+			$item = $closure();
200
+			$this->cache->save($key, $item);
201
+		}
202
+
203
+		return $item;
204
+	}
205 205
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/TDBMService.php 1 patch
Indentation   +1391 added lines, -1391 removed lines patch added patch discarded remove patch
@@ -47,236 +47,236 @@  discard block
 block discarded – undo
47 47
  */
48 48
 class TDBMService
49 49
 {
50
-    const MODE_CURSOR = 1;
51
-    const MODE_ARRAY = 2;
52
-
53
-    /**
54
-     * The database connection.
55
-     *
56
-     * @var Connection
57
-     */
58
-    private $connection;
59
-
60
-    /**
61
-     * @var SchemaAnalyzer
62
-     */
63
-    private $schemaAnalyzer;
64
-
65
-    /**
66
-     * @var MagicQuery
67
-     */
68
-    private $magicQuery;
69
-
70
-    /**
71
-     * @var TDBMSchemaAnalyzer
72
-     */
73
-    private $tdbmSchemaAnalyzer;
74
-
75
-    /**
76
-     * @var string
77
-     */
78
-    private $cachePrefix;
79
-
80
-    /**
81
-     * Cache of table of primary keys.
82
-     * Primary keys are stored by tables, as an array of column.
83
-     * For instance $primary_key['my_table'][0] will return the first column of the primary key of table 'my_table'.
84
-     *
85
-     * @var string[]
86
-     */
87
-    private $primaryKeysColumns;
88
-
89
-    /**
90
-     * Service storing objects in memory.
91
-     * Access is done by table name and then by primary key.
92
-     * If the primary key is split on several columns, access is done by an array of columns, serialized.
93
-     *
94
-     * @var StandardObjectStorage|WeakrefObjectStorage
95
-     */
96
-    private $objectStorage;
97
-
98
-    /**
99
-     * The fetch mode of the result sets returned by `getObjects`.
100
-     * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY or TDBMObjectArray::MODE_COMPATIBLE_ARRAY.
101
-     *
102
-     * In 'MODE_ARRAY' mode (default), the result is an array. Use this mode by default (unless the list returned is very big).
103
-     * 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,
104
-     * and it cannot be accessed via key. Use this mode for large datasets processed by batch.
105
-     * In 'MODE_COMPATIBLE_ARRAY' mode, the result is an old TDBMObjectArray (used up to TDBM 3.2).
106
-     * You can access the array by key, or using foreach, several times.
107
-     *
108
-     * @var int
109
-     */
110
-    private $mode = self::MODE_ARRAY;
111
-
112
-    /**
113
-     * Table of new objects not yet inserted in database or objects modified that must be saved.
114
-     *
115
-     * @var \SplObjectStorage of DbRow objects
116
-     */
117
-    private $toSaveObjects;
118
-
119
-    /**
120
-     * A cache service to be used.
121
-     *
122
-     * @var Cache|null
123
-     */
124
-    private $cache;
125
-
126
-    /**
127
-     * Map associating a table name to a fully qualified Bean class name.
128
-     *
129
-     * @var array
130
-     */
131
-    private $tableToBeanMap = [];
132
-
133
-    /**
134
-     * @var \ReflectionClass[]
135
-     */
136
-    private $reflectionClassCache = array();
137
-
138
-    /**
139
-     * @var LoggerInterface
140
-     */
141
-    private $rootLogger;
142
-
143
-    /**
144
-     * @var LevelFilter|NullLogger
145
-     */
146
-    private $logger;
147
-
148
-    /**
149
-     * @var OrderByAnalyzer
150
-     */
151
-    private $orderByAnalyzer;
152
-
153
-    /**
154
-     * @param Connection     $connection     The DBAL DB connection to use
155
-     * @param Cache|null     $cache          A cache service to be used
156
-     * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
157
-     *                                       Will be automatically created if not passed
158
-     */
159
-    public function __construct(Connection $connection, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null, LoggerInterface $logger = null)
160
-    {
161
-        if (extension_loaded('weakref')) {
162
-            $this->objectStorage = new WeakrefObjectStorage();
163
-        } else {
164
-            $this->objectStorage = new StandardObjectStorage();
165
-        }
166
-        $this->connection = $connection;
167
-        if ($cache !== null) {
168
-            $this->cache = $cache;
169
-        } else {
170
-            $this->cache = new VoidCache();
171
-        }
172
-        if ($schemaAnalyzer) {
173
-            $this->schemaAnalyzer = $schemaAnalyzer;
174
-        } else {
175
-            $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
176
-        }
177
-
178
-        $this->magicQuery = new MagicQuery($this->connection, $this->cache, $this->schemaAnalyzer);
179
-
180
-        $this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, $this->cache, $this->schemaAnalyzer);
181
-        $this->cachePrefix = $this->tdbmSchemaAnalyzer->getCachePrefix();
182
-
183
-        $this->toSaveObjects = new \SplObjectStorage();
184
-        if ($logger === null) {
185
-            $this->logger = new NullLogger();
186
-            $this->rootLogger = new NullLogger();
187
-        } else {
188
-            $this->rootLogger = $logger;
189
-            $this->setLogLevel(LogLevel::WARNING);
190
-        }
191
-        $this->orderByAnalyzer = new OrderByAnalyzer($this->cache, $this->cachePrefix);
192
-    }
193
-
194
-    /**
195
-     * Returns the object used to connect to the database.
196
-     *
197
-     * @return Connection
198
-     */
199
-    public function getConnection()
200
-    {
201
-        return $this->connection;
202
-    }
203
-
204
-    /**
205
-     * Creates a unique cache key for the current connection.
206
-     *
207
-     * @return string
208
-     */
209
-    private function getConnectionUniqueId()
210
-    {
211
-        return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
212
-    }
213
-
214
-    /**
215
-     * Sets the default fetch mode of the result sets returned by `findObjects`.
216
-     * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY.
217
-     *
218
-     * 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).
219
-     * 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
220
-     * several times. In cursor mode, you cannot access the result set by key. Use this mode for large datasets processed by batch.
221
-     *
222
-     * @param int $mode
223
-     *
224
-     * @return $this
225
-     *
226
-     * @throws TDBMException
227
-     */
228
-    public function setFetchMode($mode)
229
-    {
230
-        if ($mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
231
-            throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
232
-        }
233
-        $this->mode = $mode;
234
-
235
-        return $this;
236
-    }
237
-
238
-    /**
239
-     * Returns a TDBMObject associated from table "$table_name".
240
-     * If the $filters parameter is an int/string, the object returned will be the object whose primary key = $filters.
241
-     * $filters can also be a set of TDBM_Filters (see the findObjects method for more details).
242
-     *
243
-     * For instance, if there is a table 'users', with a primary key on column 'user_id' and a column 'user_name', then
244
-     * 			$user = $tdbmService->getObject('users',1);
245
-     * 			echo $user->name;
246
-     * will return the name of the user whose user_id is one.
247
-     *
248
-     * 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.
249
-     * For instance:
250
-     * 			$group = $tdbmService->getObject('groups',array(1,2));
251
-     *
252
-     * Note that TDBMObject performs caching for you. If you get twice the same object, the reference of the object you will get
253
-     * will be the same.
254
-     *
255
-     * For instance:
256
-     * 			$user1 = $tdbmService->getObject('users',1);
257
-     * 			$user2 = $tdbmService->getObject('users',1);
258
-     * 			$user1->name = 'John Doe';
259
-     * 			echo $user2->name;
260
-     * will return 'John Doe'.
261
-     *
262
-     * You can use filters instead of passing the primary key. For instance:
263
-     * 			$user = $tdbmService->getObject('users',new EqualFilter('users', 'login', 'jdoe'));
264
-     * This will return the user whose login is 'jdoe'.
265
-     * Please note that if 2 users have the jdoe login in database, the method will throw a TDBM_DuplicateRowException.
266
-     *
267
-     * Also, you can specify the return class for the object (provided the return class extends TDBMObject).
268
-     * For instance:
269
-     *  	$user = $tdbmService->getObject('users',1,'User');
270
-     * will return an object from the "User" class. The "User" class must extend the "TDBMObject" class.
271
-     * Please be sure not to override any method or any property unless you perfectly know what you are doing!
272
-     *
273
-     * @param string $table_name   The name of the table we retrieve an object from
274
-     * @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)
275
-     * @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
276
-     * @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
277
-     *
278
-     * @return TDBMObject
279
-     */
50
+	const MODE_CURSOR = 1;
51
+	const MODE_ARRAY = 2;
52
+
53
+	/**
54
+	 * The database connection.
55
+	 *
56
+	 * @var Connection
57
+	 */
58
+	private $connection;
59
+
60
+	/**
61
+	 * @var SchemaAnalyzer
62
+	 */
63
+	private $schemaAnalyzer;
64
+
65
+	/**
66
+	 * @var MagicQuery
67
+	 */
68
+	private $magicQuery;
69
+
70
+	/**
71
+	 * @var TDBMSchemaAnalyzer
72
+	 */
73
+	private $tdbmSchemaAnalyzer;
74
+
75
+	/**
76
+	 * @var string
77
+	 */
78
+	private $cachePrefix;
79
+
80
+	/**
81
+	 * Cache of table of primary keys.
82
+	 * Primary keys are stored by tables, as an array of column.
83
+	 * For instance $primary_key['my_table'][0] will return the first column of the primary key of table 'my_table'.
84
+	 *
85
+	 * @var string[]
86
+	 */
87
+	private $primaryKeysColumns;
88
+
89
+	/**
90
+	 * Service storing objects in memory.
91
+	 * Access is done by table name and then by primary key.
92
+	 * If the primary key is split on several columns, access is done by an array of columns, serialized.
93
+	 *
94
+	 * @var StandardObjectStorage|WeakrefObjectStorage
95
+	 */
96
+	private $objectStorage;
97
+
98
+	/**
99
+	 * The fetch mode of the result sets returned by `getObjects`.
100
+	 * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY or TDBMObjectArray::MODE_COMPATIBLE_ARRAY.
101
+	 *
102
+	 * In 'MODE_ARRAY' mode (default), the result is an array. Use this mode by default (unless the list returned is very big).
103
+	 * 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,
104
+	 * and it cannot be accessed via key. Use this mode for large datasets processed by batch.
105
+	 * In 'MODE_COMPATIBLE_ARRAY' mode, the result is an old TDBMObjectArray (used up to TDBM 3.2).
106
+	 * You can access the array by key, or using foreach, several times.
107
+	 *
108
+	 * @var int
109
+	 */
110
+	private $mode = self::MODE_ARRAY;
111
+
112
+	/**
113
+	 * Table of new objects not yet inserted in database or objects modified that must be saved.
114
+	 *
115
+	 * @var \SplObjectStorage of DbRow objects
116
+	 */
117
+	private $toSaveObjects;
118
+
119
+	/**
120
+	 * A cache service to be used.
121
+	 *
122
+	 * @var Cache|null
123
+	 */
124
+	private $cache;
125
+
126
+	/**
127
+	 * Map associating a table name to a fully qualified Bean class name.
128
+	 *
129
+	 * @var array
130
+	 */
131
+	private $tableToBeanMap = [];
132
+
133
+	/**
134
+	 * @var \ReflectionClass[]
135
+	 */
136
+	private $reflectionClassCache = array();
137
+
138
+	/**
139
+	 * @var LoggerInterface
140
+	 */
141
+	private $rootLogger;
142
+
143
+	/**
144
+	 * @var LevelFilter|NullLogger
145
+	 */
146
+	private $logger;
147
+
148
+	/**
149
+	 * @var OrderByAnalyzer
150
+	 */
151
+	private $orderByAnalyzer;
152
+
153
+	/**
154
+	 * @param Connection     $connection     The DBAL DB connection to use
155
+	 * @param Cache|null     $cache          A cache service to be used
156
+	 * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
157
+	 *                                       Will be automatically created if not passed
158
+	 */
159
+	public function __construct(Connection $connection, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null, LoggerInterface $logger = null)
160
+	{
161
+		if (extension_loaded('weakref')) {
162
+			$this->objectStorage = new WeakrefObjectStorage();
163
+		} else {
164
+			$this->objectStorage = new StandardObjectStorage();
165
+		}
166
+		$this->connection = $connection;
167
+		if ($cache !== null) {
168
+			$this->cache = $cache;
169
+		} else {
170
+			$this->cache = new VoidCache();
171
+		}
172
+		if ($schemaAnalyzer) {
173
+			$this->schemaAnalyzer = $schemaAnalyzer;
174
+		} else {
175
+			$this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
176
+		}
177
+
178
+		$this->magicQuery = new MagicQuery($this->connection, $this->cache, $this->schemaAnalyzer);
179
+
180
+		$this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, $this->cache, $this->schemaAnalyzer);
181
+		$this->cachePrefix = $this->tdbmSchemaAnalyzer->getCachePrefix();
182
+
183
+		$this->toSaveObjects = new \SplObjectStorage();
184
+		if ($logger === null) {
185
+			$this->logger = new NullLogger();
186
+			$this->rootLogger = new NullLogger();
187
+		} else {
188
+			$this->rootLogger = $logger;
189
+			$this->setLogLevel(LogLevel::WARNING);
190
+		}
191
+		$this->orderByAnalyzer = new OrderByAnalyzer($this->cache, $this->cachePrefix);
192
+	}
193
+
194
+	/**
195
+	 * Returns the object used to connect to the database.
196
+	 *
197
+	 * @return Connection
198
+	 */
199
+	public function getConnection()
200
+	{
201
+		return $this->connection;
202
+	}
203
+
204
+	/**
205
+	 * Creates a unique cache key for the current connection.
206
+	 *
207
+	 * @return string
208
+	 */
209
+	private function getConnectionUniqueId()
210
+	{
211
+		return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
212
+	}
213
+
214
+	/**
215
+	 * Sets the default fetch mode of the result sets returned by `findObjects`.
216
+	 * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY.
217
+	 *
218
+	 * 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).
219
+	 * 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
220
+	 * several times. In cursor mode, you cannot access the result set by key. Use this mode for large datasets processed by batch.
221
+	 *
222
+	 * @param int $mode
223
+	 *
224
+	 * @return $this
225
+	 *
226
+	 * @throws TDBMException
227
+	 */
228
+	public function setFetchMode($mode)
229
+	{
230
+		if ($mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
231
+			throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
232
+		}
233
+		$this->mode = $mode;
234
+
235
+		return $this;
236
+	}
237
+
238
+	/**
239
+	 * Returns a TDBMObject associated from table "$table_name".
240
+	 * If the $filters parameter is an int/string, the object returned will be the object whose primary key = $filters.
241
+	 * $filters can also be a set of TDBM_Filters (see the findObjects method for more details).
242
+	 *
243
+	 * For instance, if there is a table 'users', with a primary key on column 'user_id' and a column 'user_name', then
244
+	 * 			$user = $tdbmService->getObject('users',1);
245
+	 * 			echo $user->name;
246
+	 * will return the name of the user whose user_id is one.
247
+	 *
248
+	 * 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.
249
+	 * For instance:
250
+	 * 			$group = $tdbmService->getObject('groups',array(1,2));
251
+	 *
252
+	 * Note that TDBMObject performs caching for you. If you get twice the same object, the reference of the object you will get
253
+	 * will be the same.
254
+	 *
255
+	 * For instance:
256
+	 * 			$user1 = $tdbmService->getObject('users',1);
257
+	 * 			$user2 = $tdbmService->getObject('users',1);
258
+	 * 			$user1->name = 'John Doe';
259
+	 * 			echo $user2->name;
260
+	 * will return 'John Doe'.
261
+	 *
262
+	 * You can use filters instead of passing the primary key. For instance:
263
+	 * 			$user = $tdbmService->getObject('users',new EqualFilter('users', 'login', 'jdoe'));
264
+	 * This will return the user whose login is 'jdoe'.
265
+	 * Please note that if 2 users have the jdoe login in database, the method will throw a TDBM_DuplicateRowException.
266
+	 *
267
+	 * Also, you can specify the return class for the object (provided the return class extends TDBMObject).
268
+	 * For instance:
269
+	 *  	$user = $tdbmService->getObject('users',1,'User');
270
+	 * will return an object from the "User" class. The "User" class must extend the "TDBMObject" class.
271
+	 * Please be sure not to override any method or any property unless you perfectly know what you are doing!
272
+	 *
273
+	 * @param string $table_name   The name of the table we retrieve an object from
274
+	 * @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)
275
+	 * @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
276
+	 * @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
277
+	 *
278
+	 * @return TDBMObject
279
+	 */
280 280
 /*	public function getObject($table_name, $filters, $className = null, $lazy_loading = false) {
281 281
 
282 282
         if (is_array($filters) || $filters instanceof FilterInterface) {
@@ -362,199 +362,199 @@  discard block
 block discarded – undo
362 362
         return $obj;
363 363
     }*/
364 364
 
365
-    /**
366
-     * Removes the given object from database.
367
-     * This cannot be called on an object that is not attached to this TDBMService
368
-     * (will throw a TDBMInvalidOperationException).
369
-     *
370
-     * @param AbstractTDBMObject $object the object to delete
371
-     *
372
-     * @throws TDBMException
373
-     * @throws TDBMInvalidOperationException
374
-     */
375
-    public function delete(AbstractTDBMObject $object)
376
-    {
377
-        switch ($object->_getStatus()) {
378
-            case TDBMObjectStateEnum::STATE_DELETED:
379
-                // Nothing to do, object already deleted.
380
-                return;
381
-            case TDBMObjectStateEnum::STATE_DETACHED:
382
-                throw new TDBMInvalidOperationException('Cannot delete a detached object');
383
-            case TDBMObjectStateEnum::STATE_NEW:
384
-                $this->deleteManyToManyRelationships($object);
385
-                foreach ($object->_getDbRows() as $dbRow) {
386
-                    $this->removeFromToSaveObjectList($dbRow);
387
-                }
388
-                break;
389
-            case TDBMObjectStateEnum::STATE_DIRTY:
390
-                foreach ($object->_getDbRows() as $dbRow) {
391
-                    $this->removeFromToSaveObjectList($dbRow);
392
-                }
393
-                // And continue deleting...
394
-            case TDBMObjectStateEnum::STATE_NOT_LOADED:
395
-            case TDBMObjectStateEnum::STATE_LOADED:
396
-                $this->deleteManyToManyRelationships($object);
397
-                // Let's delete db rows, in reverse order.
398
-                foreach (array_reverse($object->_getDbRows()) as $dbRow) {
399
-                    $tableName = $dbRow->_getDbTableName();
400
-                    $primaryKeys = $dbRow->_getPrimaryKeys();
401
-                    $this->connection->delete($tableName, $primaryKeys);
402
-                    $this->objectStorage->remove($dbRow->_getDbTableName(), $this->getObjectHash($primaryKeys));
403
-                }
404
-                break;
405
-            // @codeCoverageIgnoreStart
406
-            default:
407
-                throw new TDBMInvalidOperationException('Unexpected status for bean');
408
-            // @codeCoverageIgnoreEnd
409
-        }
410
-
411
-        $object->_setStatus(TDBMObjectStateEnum::STATE_DELETED);
412
-    }
413
-
414
-    /**
415
-     * Removes all many to many relationships for this object.
416
-     *
417
-     * @param AbstractTDBMObject $object
418
-     */
419
-    private function deleteManyToManyRelationships(AbstractTDBMObject $object)
420
-    {
421
-        foreach ($object->_getDbRows() as $tableName => $dbRow) {
422
-            $pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
423
-            foreach ($pivotTables as $pivotTable) {
424
-                $remoteBeans = $object->_getRelationships($pivotTable);
425
-                foreach ($remoteBeans as $remoteBean) {
426
-                    $object->_removeRelationship($pivotTable, $remoteBean);
427
-                }
428
-            }
429
-        }
430
-        $this->persistManyToManyRelationships($object);
431
-    }
432
-
433
-    /**
434
-     * This function removes the given object from the database. It will also remove all objects relied to the one given
435
-     * by parameter before all.
436
-     *
437
-     * Notice: if the object has a multiple primary key, the function will not work.
438
-     *
439
-     * @param AbstractTDBMObject $objToDelete
440
-     */
441
-    public function deleteCascade(AbstractTDBMObject $objToDelete)
442
-    {
443
-        $this->deleteAllConstraintWithThisObject($objToDelete);
444
-        $this->delete($objToDelete);
445
-    }
446
-
447
-    /**
448
-     * This function is used only in TDBMService (private function)
449
-     * It will call deleteCascade function foreach object relied with a foreign key to the object given by parameter.
450
-     *
451
-     * @param AbstractTDBMObject $obj
452
-     */
453
-    private function deleteAllConstraintWithThisObject(AbstractTDBMObject $obj)
454
-    {
455
-        $dbRows = $obj->_getDbRows();
456
-        foreach ($dbRows as $dbRow) {
457
-            $tableName = $dbRow->_getDbTableName();
458
-            $pks = array_values($dbRow->_getPrimaryKeys());
459
-            if (!empty($pks)) {
460
-                $incomingFks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($tableName);
461
-
462
-                foreach ($incomingFks as $incomingFk) {
463
-                    $filter = array_combine($incomingFk->getLocalColumns(), $pks);
464
-
465
-                    $results = $this->findObjects($incomingFk->getLocalTableName(), $filter);
466
-
467
-                    foreach ($results as $bean) {
468
-                        $this->deleteCascade($bean);
469
-                    }
470
-                }
471
-            }
472
-        }
473
-    }
474
-
475
-    /**
476
-     * This function performs a save() of all the objects that have been modified.
477
-     */
478
-    public function completeSave()
479
-    {
480
-        foreach ($this->toSaveObjects as $dbRow) {
481
-            $this->save($dbRow->getTDBMObject());
482
-        }
483
-    }
484
-
485
-    /**
486
-     * Takes in input a filter_bag (which can be about anything from a string to an array of TDBMObjects... see above from documentation),
487
-     * and gives back a proper Filter object.
488
-     *
489
-     * @param mixed $filter_bag
490
-     * @param int   $counter
491
-     *
492
-     * @return array First item: filter string, second item: parameters
493
-     *
494
-     * @throws TDBMException
495
-     */
496
-    public function buildFilterFromFilterBag($filter_bag, $counter = 1)
497
-    {
498
-        if ($filter_bag === null) {
499
-            return ['', []];
500
-        } elseif (is_string($filter_bag)) {
501
-            return [$filter_bag, []];
502
-        } elseif (is_array($filter_bag)) {
503
-            $sqlParts = [];
504
-            $parameters = [];
505
-            foreach ($filter_bag as $column => $value) {
506
-                if (is_int($column)) {
507
-                    list($subSqlPart, $subParameters) = $this->buildFilterFromFilterBag($value, $counter);
508
-                    $sqlParts[] = $subSqlPart;
509
-                    $parameters += $subParameters;
510
-                } else {
511
-                    $paramName = 'tdbmparam'.$counter;
512
-                    if (is_array($value)) {
513
-                        $sqlParts[] = $this->connection->quoteIdentifier($column).' IN :'.$paramName;
514
-                    } else {
515
-                        $sqlParts[] = $this->connection->quoteIdentifier($column).' = :'.$paramName;
516
-                    }
517
-                    $parameters[$paramName] = $value;
518
-                    ++$counter;
519
-                }
520
-            }
521
-
522
-            return [implode(' AND ', $sqlParts), $parameters];
523
-        } elseif ($filter_bag instanceof AbstractTDBMObject) {
524
-            $sqlParts = [];
525
-            $parameters = [];
526
-            $dbRows = $filter_bag->_getDbRows();
527
-            $dbRow = reset($dbRows);
528
-            $primaryKeys = $dbRow->_getPrimaryKeys();
529
-
530
-            foreach ($primaryKeys as $column => $value) {
531
-                $paramName = 'tdbmparam'.$counter;
532
-                $sqlParts[] = $this->connection->quoteIdentifier($dbRow->_getDbTableName()).'.'.$this->connection->quoteIdentifier($column).' = :'.$paramName;
533
-                $parameters[$paramName] = $value;
534
-                ++$counter;
535
-            }
536
-
537
-            return [implode(' AND ', $sqlParts), $parameters];
538
-        } elseif ($filter_bag instanceof \Iterator) {
539
-            return $this->buildFilterFromFilterBag(iterator_to_array($filter_bag), $counter);
540
-        } else {
541
-            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.');
542
-        }
543
-    }
544
-
545
-    /**
546
-     * @param string $table
547
-     *
548
-     * @return string[]
549
-     */
550
-    public function getPrimaryKeyColumns($table)
551
-    {
552
-        if (!isset($this->primaryKeysColumns[$table])) {
553
-            $this->primaryKeysColumns[$table] = $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getPrimaryKeyColumns();
554
-
555
-            // TODO TDBM4: See if we need to improve error reporting if table name does not exist.
556
-
557
-            /*$arr = array();
365
+	/**
366
+	 * Removes the given object from database.
367
+	 * This cannot be called on an object that is not attached to this TDBMService
368
+	 * (will throw a TDBMInvalidOperationException).
369
+	 *
370
+	 * @param AbstractTDBMObject $object the object to delete
371
+	 *
372
+	 * @throws TDBMException
373
+	 * @throws TDBMInvalidOperationException
374
+	 */
375
+	public function delete(AbstractTDBMObject $object)
376
+	{
377
+		switch ($object->_getStatus()) {
378
+			case TDBMObjectStateEnum::STATE_DELETED:
379
+				// Nothing to do, object already deleted.
380
+				return;
381
+			case TDBMObjectStateEnum::STATE_DETACHED:
382
+				throw new TDBMInvalidOperationException('Cannot delete a detached object');
383
+			case TDBMObjectStateEnum::STATE_NEW:
384
+				$this->deleteManyToManyRelationships($object);
385
+				foreach ($object->_getDbRows() as $dbRow) {
386
+					$this->removeFromToSaveObjectList($dbRow);
387
+				}
388
+				break;
389
+			case TDBMObjectStateEnum::STATE_DIRTY:
390
+				foreach ($object->_getDbRows() as $dbRow) {
391
+					$this->removeFromToSaveObjectList($dbRow);
392
+				}
393
+				// And continue deleting...
394
+			case TDBMObjectStateEnum::STATE_NOT_LOADED:
395
+			case TDBMObjectStateEnum::STATE_LOADED:
396
+				$this->deleteManyToManyRelationships($object);
397
+				// Let's delete db rows, in reverse order.
398
+				foreach (array_reverse($object->_getDbRows()) as $dbRow) {
399
+					$tableName = $dbRow->_getDbTableName();
400
+					$primaryKeys = $dbRow->_getPrimaryKeys();
401
+					$this->connection->delete($tableName, $primaryKeys);
402
+					$this->objectStorage->remove($dbRow->_getDbTableName(), $this->getObjectHash($primaryKeys));
403
+				}
404
+				break;
405
+			// @codeCoverageIgnoreStart
406
+			default:
407
+				throw new TDBMInvalidOperationException('Unexpected status for bean');
408
+			// @codeCoverageIgnoreEnd
409
+		}
410
+
411
+		$object->_setStatus(TDBMObjectStateEnum::STATE_DELETED);
412
+	}
413
+
414
+	/**
415
+	 * Removes all many to many relationships for this object.
416
+	 *
417
+	 * @param AbstractTDBMObject $object
418
+	 */
419
+	private function deleteManyToManyRelationships(AbstractTDBMObject $object)
420
+	{
421
+		foreach ($object->_getDbRows() as $tableName => $dbRow) {
422
+			$pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
423
+			foreach ($pivotTables as $pivotTable) {
424
+				$remoteBeans = $object->_getRelationships($pivotTable);
425
+				foreach ($remoteBeans as $remoteBean) {
426
+					$object->_removeRelationship($pivotTable, $remoteBean);
427
+				}
428
+			}
429
+		}
430
+		$this->persistManyToManyRelationships($object);
431
+	}
432
+
433
+	/**
434
+	 * This function removes the given object from the database. It will also remove all objects relied to the one given
435
+	 * by parameter before all.
436
+	 *
437
+	 * Notice: if the object has a multiple primary key, the function will not work.
438
+	 *
439
+	 * @param AbstractTDBMObject $objToDelete
440
+	 */
441
+	public function deleteCascade(AbstractTDBMObject $objToDelete)
442
+	{
443
+		$this->deleteAllConstraintWithThisObject($objToDelete);
444
+		$this->delete($objToDelete);
445
+	}
446
+
447
+	/**
448
+	 * This function is used only in TDBMService (private function)
449
+	 * It will call deleteCascade function foreach object relied with a foreign key to the object given by parameter.
450
+	 *
451
+	 * @param AbstractTDBMObject $obj
452
+	 */
453
+	private function deleteAllConstraintWithThisObject(AbstractTDBMObject $obj)
454
+	{
455
+		$dbRows = $obj->_getDbRows();
456
+		foreach ($dbRows as $dbRow) {
457
+			$tableName = $dbRow->_getDbTableName();
458
+			$pks = array_values($dbRow->_getPrimaryKeys());
459
+			if (!empty($pks)) {
460
+				$incomingFks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($tableName);
461
+
462
+				foreach ($incomingFks as $incomingFk) {
463
+					$filter = array_combine($incomingFk->getLocalColumns(), $pks);
464
+
465
+					$results = $this->findObjects($incomingFk->getLocalTableName(), $filter);
466
+
467
+					foreach ($results as $bean) {
468
+						$this->deleteCascade($bean);
469
+					}
470
+				}
471
+			}
472
+		}
473
+	}
474
+
475
+	/**
476
+	 * This function performs a save() of all the objects that have been modified.
477
+	 */
478
+	public function completeSave()
479
+	{
480
+		foreach ($this->toSaveObjects as $dbRow) {
481
+			$this->save($dbRow->getTDBMObject());
482
+		}
483
+	}
484
+
485
+	/**
486
+	 * Takes in input a filter_bag (which can be about anything from a string to an array of TDBMObjects... see above from documentation),
487
+	 * and gives back a proper Filter object.
488
+	 *
489
+	 * @param mixed $filter_bag
490
+	 * @param int   $counter
491
+	 *
492
+	 * @return array First item: filter string, second item: parameters
493
+	 *
494
+	 * @throws TDBMException
495
+	 */
496
+	public function buildFilterFromFilterBag($filter_bag, $counter = 1)
497
+	{
498
+		if ($filter_bag === null) {
499
+			return ['', []];
500
+		} elseif (is_string($filter_bag)) {
501
+			return [$filter_bag, []];
502
+		} elseif (is_array($filter_bag)) {
503
+			$sqlParts = [];
504
+			$parameters = [];
505
+			foreach ($filter_bag as $column => $value) {
506
+				if (is_int($column)) {
507
+					list($subSqlPart, $subParameters) = $this->buildFilterFromFilterBag($value, $counter);
508
+					$sqlParts[] = $subSqlPart;
509
+					$parameters += $subParameters;
510
+				} else {
511
+					$paramName = 'tdbmparam'.$counter;
512
+					if (is_array($value)) {
513
+						$sqlParts[] = $this->connection->quoteIdentifier($column).' IN :'.$paramName;
514
+					} else {
515
+						$sqlParts[] = $this->connection->quoteIdentifier($column).' = :'.$paramName;
516
+					}
517
+					$parameters[$paramName] = $value;
518
+					++$counter;
519
+				}
520
+			}
521
+
522
+			return [implode(' AND ', $sqlParts), $parameters];
523
+		} elseif ($filter_bag instanceof AbstractTDBMObject) {
524
+			$sqlParts = [];
525
+			$parameters = [];
526
+			$dbRows = $filter_bag->_getDbRows();
527
+			$dbRow = reset($dbRows);
528
+			$primaryKeys = $dbRow->_getPrimaryKeys();
529
+
530
+			foreach ($primaryKeys as $column => $value) {
531
+				$paramName = 'tdbmparam'.$counter;
532
+				$sqlParts[] = $this->connection->quoteIdentifier($dbRow->_getDbTableName()).'.'.$this->connection->quoteIdentifier($column).' = :'.$paramName;
533
+				$parameters[$paramName] = $value;
534
+				++$counter;
535
+			}
536
+
537
+			return [implode(' AND ', $sqlParts), $parameters];
538
+		} elseif ($filter_bag instanceof \Iterator) {
539
+			return $this->buildFilterFromFilterBag(iterator_to_array($filter_bag), $counter);
540
+		} else {
541
+			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.');
542
+		}
543
+	}
544
+
545
+	/**
546
+	 * @param string $table
547
+	 *
548
+	 * @return string[]
549
+	 */
550
+	public function getPrimaryKeyColumns($table)
551
+	{
552
+		if (!isset($this->primaryKeysColumns[$table])) {
553
+			$this->primaryKeysColumns[$table] = $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getPrimaryKeyColumns();
554
+
555
+			// TODO TDBM4: See if we need to improve error reporting if table name does not exist.
556
+
557
+			/*$arr = array();
558 558
             foreach ($this->connection->getPrimaryKey($table) as $col) {
559 559
                 $arr[] = $col->name;
560 560
             }
@@ -575,158 +575,158 @@  discard block
 block discarded – undo
575 575
                     throw new TDBMException($str);
576 576
                 }
577 577
             }*/
578
-        }
579
-
580
-        return $this->primaryKeysColumns[$table];
581
-    }
582
-
583
-    /**
584
-     * This is an internal function, you should not use it in your application.
585
-     * This is used internally by TDBM to add an object to the object cache.
586
-     *
587
-     * @param DbRow $dbRow
588
-     */
589
-    public function _addToCache(DbRow $dbRow)
590
-    {
591
-        $primaryKey = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
592
-        $hash = $this->getObjectHash($primaryKey);
593
-        $this->objectStorage->set($dbRow->_getDbTableName(), $hash, $dbRow);
594
-    }
595
-
596
-    /**
597
-     * This is an internal function, you should not use it in your application.
598
-     * This is used internally by TDBM to remove the object from the list of objects that have been
599
-     * created/updated but not saved yet.
600
-     *
601
-     * @param DbRow $myObject
602
-     */
603
-    private function removeFromToSaveObjectList(DbRow $myObject)
604
-    {
605
-        unset($this->toSaveObjects[$myObject]);
606
-    }
607
-
608
-    /**
609
-     * This is an internal function, you should not use it in your application.
610
-     * This is used internally by TDBM to add an object to the list of objects that have been
611
-     * created/updated but not saved yet.
612
-     *
613
-     * @param AbstractTDBMObject $myObject
614
-     */
615
-    public function _addToToSaveObjectList(DbRow $myObject)
616
-    {
617
-        $this->toSaveObjects[$myObject] = true;
618
-    }
619
-
620
-    /**
621
-     * Generates all the daos and beans.
622
-     *
623
-     * @param string $daoFactoryClassName The classe name of the DAO factory
624
-     * @param string $daonamespace        The namespace for the DAOs, without trailing \
625
-     * @param string $beannamespace       The Namespace for the beans, without trailing \
626
-     * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone
627
-     * @param string $composerFile        If it's set, location of custom Composer file. Relative to project root
628
-     *
629
-     * @return \string[] the list of tables
630
-     */
631
-    public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $composerFile = null)
632
-    {
633
-        // Purge cache before generating anything.
634
-        $this->cache->deleteAll();
635
-
636
-        $tdbmDaoGenerator = new TDBMDaoGenerator($this->schemaAnalyzer, $this->tdbmSchemaAnalyzer->getSchema(), $this->tdbmSchemaAnalyzer);
637
-        if (null !== $composerFile) {
638
-            $tdbmDaoGenerator->setComposerFile(__DIR__.'/../../../../../../../'.$composerFile);
639
-        }
640
-
641
-        return $tdbmDaoGenerator->generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc);
642
-    }
643
-
644
-    /**
645
-     * @param array<string, string> $tableToBeanMap
646
-     */
647
-    public function setTableToBeanMap(array $tableToBeanMap)
648
-    {
649
-        $this->tableToBeanMap = $tableToBeanMap;
650
-    }
651
-
652
-    /**
653
-     * Returns the fully qualified class name of the bean associated with table $tableName.
654
-     *
655
-     *
656
-     * @param string $tableName
657
-     *
658
-     * @return string
659
-     */
660
-    public function getBeanClassName(string $tableName) : string
661
-    {
662
-        if (isset($this->tableToBeanMap[$tableName])) {
663
-            return $this->tableToBeanMap[$tableName];
664
-        } else {
665
-            throw new TDBMInvalidArgumentException(sprintf('Could not find a map between table "%s" and any bean. Does table "%s" exists?', $tableName, $tableName));
666
-        }
667
-    }
668
-
669
-    /**
670
-     * Saves $object by INSERTing or UPDAT(E)ing it in the database.
671
-     *
672
-     * @param AbstractTDBMObject $object
673
-     *
674
-     * @throws TDBMException
675
-     */
676
-    public function save(AbstractTDBMObject $object)
677
-    {
678
-        $status = $object->_getStatus();
679
-
680
-        if ($status === null) {
681
-            throw new TDBMException(sprintf('Your bean for class %s has no status. It is likely that you overloaded the __construct method and forgot to call parent::__construct.', get_class($object)));
682
-        }
683
-
684
-        // Let's attach this object if it is in detached state.
685
-        if ($status === TDBMObjectStateEnum::STATE_DETACHED) {
686
-            $object->_attach($this);
687
-            $status = $object->_getStatus();
688
-        }
689
-
690
-        if ($status === TDBMObjectStateEnum::STATE_NEW) {
691
-            $dbRows = $object->_getDbRows();
692
-
693
-            $unindexedPrimaryKeys = array();
694
-
695
-            foreach ($dbRows as $dbRow) {
696
-                $tableName = $dbRow->_getDbTableName();
697
-
698
-                $schema = $this->tdbmSchemaAnalyzer->getSchema();
699
-                $tableDescriptor = $schema->getTable($tableName);
700
-
701
-                $primaryKeyColumns = $this->getPrimaryKeyColumns($tableName);
702
-
703
-                if (empty($unindexedPrimaryKeys)) {
704
-                    $primaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
705
-                } else {
706
-                    // First insert, the children must have the same primary key as the parent.
707
-                    $primaryKeys = $this->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $unindexedPrimaryKeys);
708
-                    $dbRow->_setPrimaryKeys($primaryKeys);
709
-                }
710
-
711
-                $references = $dbRow->_getReferences();
712
-
713
-                // Let's save all references in NEW or DETACHED state (we need their primary key)
714
-                foreach ($references as $fkName => $reference) {
715
-                    if ($reference !== null) {
716
-                        $refStatus = $reference->_getStatus();
717
-                        if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
718
-                            $this->save($reference);
719
-                        }
720
-                    }
721
-                }
722
-
723
-                $dbRowData = $dbRow->_getDbRow();
724
-
725
-                // Let's see if the columns for primary key have been set before inserting.
726
-                // We assume that if one of the value of the PK has been set, the PK is set.
727
-                $isPkSet = !empty($primaryKeys);
728
-
729
-                /*if (!$isPkSet) {
578
+		}
579
+
580
+		return $this->primaryKeysColumns[$table];
581
+	}
582
+
583
+	/**
584
+	 * This is an internal function, you should not use it in your application.
585
+	 * This is used internally by TDBM to add an object to the object cache.
586
+	 *
587
+	 * @param DbRow $dbRow
588
+	 */
589
+	public function _addToCache(DbRow $dbRow)
590
+	{
591
+		$primaryKey = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
592
+		$hash = $this->getObjectHash($primaryKey);
593
+		$this->objectStorage->set($dbRow->_getDbTableName(), $hash, $dbRow);
594
+	}
595
+
596
+	/**
597
+	 * This is an internal function, you should not use it in your application.
598
+	 * This is used internally by TDBM to remove the object from the list of objects that have been
599
+	 * created/updated but not saved yet.
600
+	 *
601
+	 * @param DbRow $myObject
602
+	 */
603
+	private function removeFromToSaveObjectList(DbRow $myObject)
604
+	{
605
+		unset($this->toSaveObjects[$myObject]);
606
+	}
607
+
608
+	/**
609
+	 * This is an internal function, you should not use it in your application.
610
+	 * This is used internally by TDBM to add an object to the list of objects that have been
611
+	 * created/updated but not saved yet.
612
+	 *
613
+	 * @param AbstractTDBMObject $myObject
614
+	 */
615
+	public function _addToToSaveObjectList(DbRow $myObject)
616
+	{
617
+		$this->toSaveObjects[$myObject] = true;
618
+	}
619
+
620
+	/**
621
+	 * Generates all the daos and beans.
622
+	 *
623
+	 * @param string $daoFactoryClassName The classe name of the DAO factory
624
+	 * @param string $daonamespace        The namespace for the DAOs, without trailing \
625
+	 * @param string $beannamespace       The Namespace for the beans, without trailing \
626
+	 * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone
627
+	 * @param string $composerFile        If it's set, location of custom Composer file. Relative to project root
628
+	 *
629
+	 * @return \string[] the list of tables
630
+	 */
631
+	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $composerFile = null)
632
+	{
633
+		// Purge cache before generating anything.
634
+		$this->cache->deleteAll();
635
+
636
+		$tdbmDaoGenerator = new TDBMDaoGenerator($this->schemaAnalyzer, $this->tdbmSchemaAnalyzer->getSchema(), $this->tdbmSchemaAnalyzer);
637
+		if (null !== $composerFile) {
638
+			$tdbmDaoGenerator->setComposerFile(__DIR__.'/../../../../../../../'.$composerFile);
639
+		}
640
+
641
+		return $tdbmDaoGenerator->generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc);
642
+	}
643
+
644
+	/**
645
+	 * @param array<string, string> $tableToBeanMap
646
+	 */
647
+	public function setTableToBeanMap(array $tableToBeanMap)
648
+	{
649
+		$this->tableToBeanMap = $tableToBeanMap;
650
+	}
651
+
652
+	/**
653
+	 * Returns the fully qualified class name of the bean associated with table $tableName.
654
+	 *
655
+	 *
656
+	 * @param string $tableName
657
+	 *
658
+	 * @return string
659
+	 */
660
+	public function getBeanClassName(string $tableName) : string
661
+	{
662
+		if (isset($this->tableToBeanMap[$tableName])) {
663
+			return $this->tableToBeanMap[$tableName];
664
+		} else {
665
+			throw new TDBMInvalidArgumentException(sprintf('Could not find a map between table "%s" and any bean. Does table "%s" exists?', $tableName, $tableName));
666
+		}
667
+	}
668
+
669
+	/**
670
+	 * Saves $object by INSERTing or UPDAT(E)ing it in the database.
671
+	 *
672
+	 * @param AbstractTDBMObject $object
673
+	 *
674
+	 * @throws TDBMException
675
+	 */
676
+	public function save(AbstractTDBMObject $object)
677
+	{
678
+		$status = $object->_getStatus();
679
+
680
+		if ($status === null) {
681
+			throw new TDBMException(sprintf('Your bean for class %s has no status. It is likely that you overloaded the __construct method and forgot to call parent::__construct.', get_class($object)));
682
+		}
683
+
684
+		// Let's attach this object if it is in detached state.
685
+		if ($status === TDBMObjectStateEnum::STATE_DETACHED) {
686
+			$object->_attach($this);
687
+			$status = $object->_getStatus();
688
+		}
689
+
690
+		if ($status === TDBMObjectStateEnum::STATE_NEW) {
691
+			$dbRows = $object->_getDbRows();
692
+
693
+			$unindexedPrimaryKeys = array();
694
+
695
+			foreach ($dbRows as $dbRow) {
696
+				$tableName = $dbRow->_getDbTableName();
697
+
698
+				$schema = $this->tdbmSchemaAnalyzer->getSchema();
699
+				$tableDescriptor = $schema->getTable($tableName);
700
+
701
+				$primaryKeyColumns = $this->getPrimaryKeyColumns($tableName);
702
+
703
+				if (empty($unindexedPrimaryKeys)) {
704
+					$primaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
705
+				} else {
706
+					// First insert, the children must have the same primary key as the parent.
707
+					$primaryKeys = $this->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $unindexedPrimaryKeys);
708
+					$dbRow->_setPrimaryKeys($primaryKeys);
709
+				}
710
+
711
+				$references = $dbRow->_getReferences();
712
+
713
+				// Let's save all references in NEW or DETACHED state (we need their primary key)
714
+				foreach ($references as $fkName => $reference) {
715
+					if ($reference !== null) {
716
+						$refStatus = $reference->_getStatus();
717
+						if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
718
+							$this->save($reference);
719
+						}
720
+					}
721
+				}
722
+
723
+				$dbRowData = $dbRow->_getDbRow();
724
+
725
+				// Let's see if the columns for primary key have been set before inserting.
726
+				// We assume that if one of the value of the PK has been set, the PK is set.
727
+				$isPkSet = !empty($primaryKeys);
728
+
729
+				/*if (!$isPkSet) {
730 730
                     // if there is no autoincrement and no pk set, let's go in error.
731 731
                     $isAutoIncrement = true;
732 732
 
@@ -744,27 +744,27 @@  discard block
 block discarded – undo
744 744
 
745 745
                 }*/
746 746
 
747
-                $types = [];
748
-                $escapedDbRowData = [];
747
+				$types = [];
748
+				$escapedDbRowData = [];
749 749
 
750
-                foreach ($dbRowData as $columnName => $value) {
751
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
752
-                    $types[] = $columnDescriptor->getType();
753
-                    $escapedDbRowData[$this->connection->quoteIdentifier($columnName)] = $value;
754
-                }
750
+				foreach ($dbRowData as $columnName => $value) {
751
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
752
+					$types[] = $columnDescriptor->getType();
753
+					$escapedDbRowData[$this->connection->quoteIdentifier($columnName)] = $value;
754
+				}
755 755
 
756
-                $this->connection->insert($tableName, $escapedDbRowData, $types);
756
+				$this->connection->insert($tableName, $escapedDbRowData, $types);
757 757
 
758
-                if (!$isPkSet && count($primaryKeyColumns) == 1) {
759
-                    $id = $this->connection->lastInsertId();
760
-                    $primaryKeys[$primaryKeyColumns[0]] = $id;
761
-                }
758
+				if (!$isPkSet && count($primaryKeyColumns) == 1) {
759
+					$id = $this->connection->lastInsertId();
760
+					$primaryKeys[$primaryKeyColumns[0]] = $id;
761
+				}
762 762
 
763
-                // TODO: change this to some private magic accessor in future
764
-                $dbRow->_setPrimaryKeys($primaryKeys);
765
-                $unindexedPrimaryKeys = array_values($primaryKeys);
763
+				// TODO: change this to some private magic accessor in future
764
+				$dbRow->_setPrimaryKeys($primaryKeys);
765
+				$unindexedPrimaryKeys = array_values($primaryKeys);
766 766
 
767
-                /*
767
+				/*
768 768
                  * When attached, on "save", we check if the column updated is part of a primary key
769 769
                  * If this is part of a primary key, we call the _update_id method that updates the id in the list of known objects.
770 770
                  * This method should first verify that the id is not already used (and is not auto-incremented)
@@ -774,7 +774,7 @@  discard block
 block discarded – undo
774 774
                  *
775 775
                  */
776 776
 
777
-                /*try {
777
+				/*try {
778 778
                     $this->db_connection->exec($sql);
779 779
                 } catch (TDBMException $e) {
780 780
                     $this->db_onerror = true;
@@ -793,405 +793,405 @@  discard block
 block discarded – undo
793 793
                     }
794 794
                 }*/
795 795
 
796
-                // Let's remove this object from the $new_objects static table.
797
-                $this->removeFromToSaveObjectList($dbRow);
798
-
799
-                // TODO: change this behaviour to something more sensible performance-wise
800
-                // Maybe a setting to trigger this globally?
801
-                //$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
802
-                //$this->db_modified_state = false;
803
-                //$dbRow = array();
804
-
805
-                // Let's add this object to the list of objects in cache.
806
-                $this->_addToCache($dbRow);
807
-            }
808
-
809
-            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
810
-        } elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
811
-            $dbRows = $object->_getDbRows();
812
-
813
-            foreach ($dbRows as $dbRow) {
814
-                $references = $dbRow->_getReferences();
815
-
816
-                // Let's save all references in NEW state (we need their primary key)
817
-                foreach ($references as $fkName => $reference) {
818
-                    if ($reference !== null && $reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
819
-                        $this->save($reference);
820
-                    }
821
-                }
822
-
823
-                // Let's first get the primary keys
824
-                $tableName = $dbRow->_getDbTableName();
825
-                $dbRowData = $dbRow->_getDbRow();
826
-
827
-                $schema = $this->tdbmSchemaAnalyzer->getSchema();
828
-                $tableDescriptor = $schema->getTable($tableName);
829
-
830
-                $primaryKeys = $dbRow->_getPrimaryKeys();
831
-
832
-                $types = [];
833
-                $escapedDbRowData = [];
834
-                $escapedPrimaryKeys = [];
835
-
836
-                foreach ($dbRowData as $columnName => $value) {
837
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
838
-                    $types[] = $columnDescriptor->getType();
839
-                    $escapedDbRowData[$this->connection->quoteIdentifier($columnName)] = $value;
840
-                }
841
-                foreach ($primaryKeys as $columnName => $value) {
842
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
843
-                    $types[] = $columnDescriptor->getType();
844
-                    $escapedPrimaryKeys[$this->connection->quoteIdentifier($columnName)] = $value;
845
-                }
846
-
847
-                $this->connection->update($tableName, $escapedDbRowData, $escapedPrimaryKeys, $types);
848
-
849
-                // Let's check if the primary key has been updated...
850
-                $needsUpdatePk = false;
851
-                foreach ($primaryKeys as $column => $value) {
852
-                    if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
853
-                        $needsUpdatePk = true;
854
-                        break;
855
-                    }
856
-                }
857
-                if ($needsUpdatePk) {
858
-                    $this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
859
-                    $newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
860
-                    $dbRow->_setPrimaryKeys($newPrimaryKeys);
861
-                    $this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
862
-                }
863
-
864
-                // Let's remove this object from the list of objects to save.
865
-                $this->removeFromToSaveObjectList($dbRow);
866
-            }
867
-
868
-            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
869
-        } elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
870
-            throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
871
-        }
872
-
873
-        // Finally, let's save all the many to many relationships to this bean.
874
-        $this->persistManyToManyRelationships($object);
875
-    }
876
-
877
-    private function persistManyToManyRelationships(AbstractTDBMObject $object)
878
-    {
879
-        foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
880
-            $tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
881
-            list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
882
-
883
-            $toRemoveFromStorage = [];
884
-
885
-            foreach ($storage as $remoteBean) {
886
-                /* @var $remoteBean AbstractTDBMObject */
887
-                $statusArr = $storage[$remoteBean];
888
-                $status = $statusArr['status'];
889
-                $reverse = $statusArr['reverse'];
890
-                if ($reverse) {
891
-                    continue;
892
-                }
893
-
894
-                if ($status === 'new') {
895
-                    $remoteBeanStatus = $remoteBean->_getStatus();
896
-                    if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
897
-                        // Let's save remote bean if needed.
898
-                        $this->save($remoteBean);
899
-                    }
900
-
901
-                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
902
-
903
-                    $types = [];
904
-                    $escapedFilters = [];
905
-
906
-                    foreach ($filters as $columnName => $value) {
907
-                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
908
-                        $types[] = $columnDescriptor->getType();
909
-                        $escapedFilters[$this->connection->quoteIdentifier($columnName)] = $value;
910
-                    }
911
-
912
-                    $this->connection->insert($pivotTableName, $escapedFilters, $types);
913
-
914
-                    // Finally, let's mark relationships as saved.
915
-                    $statusArr['status'] = 'loaded';
916
-                    $storage[$remoteBean] = $statusArr;
917
-                    $remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
918
-                    $remoteStatusArr = $remoteStorage[$object];
919
-                    $remoteStatusArr['status'] = 'loaded';
920
-                    $remoteStorage[$object] = $remoteStatusArr;
921
-                } elseif ($status === 'delete') {
922
-                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
923
-
924
-                    $types = [];
925
-
926
-                    foreach ($filters as $columnName => $value) {
927
-                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
928
-                        $types[] = $columnDescriptor->getType();
929
-                    }
930
-
931
-                    $this->connection->delete($pivotTableName, $filters, $types);
932
-
933
-                    // Finally, let's remove relationships completely from bean.
934
-                    $toRemoveFromStorage[] = $remoteBean;
935
-
936
-                    $remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
937
-                }
938
-            }
939
-
940
-            // Note: due to https://bugs.php.net/bug.php?id=65629, we cannot delete an element inside a foreach loop on a SplStorageObject.
941
-            // Therefore, we cache elements in the $toRemoveFromStorage to remove them at a later stage.
942
-            foreach ($toRemoveFromStorage as $remoteBean) {
943
-                $storage->detach($remoteBean);
944
-            }
945
-        }
946
-    }
947
-
948
-    private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
949
-    {
950
-        $localBeanPk = $this->getPrimaryKeyValues($localBean);
951
-        $remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
952
-        $localColumns = $localFk->getLocalColumns();
953
-        $remoteColumns = $remoteFk->getLocalColumns();
954
-
955
-        $localFilters = array_combine($localColumns, $localBeanPk);
956
-        $remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
957
-
958
-        return array_merge($localFilters, $remoteFilters);
959
-    }
960
-
961
-    /**
962
-     * Returns the "values" of the primary key.
963
-     * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
964
-     *
965
-     * @param AbstractTDBMObject $bean
966
-     *
967
-     * @return array numerically indexed array of values
968
-     */
969
-    private function getPrimaryKeyValues(AbstractTDBMObject $bean)
970
-    {
971
-        $dbRows = $bean->_getDbRows();
972
-        $dbRow = reset($dbRows);
973
-
974
-        return array_values($dbRow->_getPrimaryKeys());
975
-    }
976
-
977
-    /**
978
-     * Returns a unique hash used to store the object based on its primary key.
979
-     * If the array contains only one value, then the value is returned.
980
-     * Otherwise, a hash representing the array is returned.
981
-     *
982
-     * @param array $primaryKeys An array of columns => values forming the primary key
983
-     *
984
-     * @return string
985
-     */
986
-    public function getObjectHash(array $primaryKeys)
987
-    {
988
-        if (count($primaryKeys) === 1) {
989
-            return reset($primaryKeys);
990
-        } else {
991
-            ksort($primaryKeys);
992
-
993
-            return md5(json_encode($primaryKeys));
994
-        }
995
-    }
996
-
997
-    /**
998
-     * Returns an array of primary keys from the object.
999
-     * The primary keys are extracted from the object columns and not from the primary keys stored in the
1000
-     * $primaryKeys variable of the object.
1001
-     *
1002
-     * @param DbRow $dbRow
1003
-     *
1004
-     * @return array Returns an array of column => value
1005
-     */
1006
-    public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
1007
-    {
1008
-        $table = $dbRow->_getDbTableName();
1009
-        $dbRowData = $dbRow->_getDbRow();
1010
-
1011
-        return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
1012
-    }
1013
-
1014
-    /**
1015
-     * Returns an array of primary keys for the given row.
1016
-     * The primary keys are extracted from the object columns.
1017
-     *
1018
-     * @param $table
1019
-     * @param array $columns
1020
-     *
1021
-     * @return array
1022
-     */
1023
-    public function _getPrimaryKeysFromObjectData($table, array $columns)
1024
-    {
1025
-        $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1026
-        $values = array();
1027
-        foreach ($primaryKeyColumns as $column) {
1028
-            if (isset($columns[$column])) {
1029
-                $values[$column] = $columns[$column];
1030
-            }
1031
-        }
1032
-
1033
-        return $values;
1034
-    }
1035
-
1036
-    /**
1037
-     * Attaches $object to this TDBMService.
1038
-     * The $object must be in DETACHED state and will pass in NEW state.
1039
-     *
1040
-     * @param AbstractTDBMObject $object
1041
-     *
1042
-     * @throws TDBMInvalidOperationException
1043
-     */
1044
-    public function attach(AbstractTDBMObject $object)
1045
-    {
1046
-        $object->_attach($this);
1047
-    }
1048
-
1049
-    /**
1050
-     * Returns an associative array (column => value) for the primary keys from the table name and an
1051
-     * indexed array of primary key values.
1052
-     *
1053
-     * @param string $tableName
1054
-     * @param array  $indexedPrimaryKeys
1055
-     */
1056
-    public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
1057
-    {
1058
-        $primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
1059
-
1060
-        if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
1061
-            throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
796
+				// Let's remove this object from the $new_objects static table.
797
+				$this->removeFromToSaveObjectList($dbRow);
798
+
799
+				// TODO: change this behaviour to something more sensible performance-wise
800
+				// Maybe a setting to trigger this globally?
801
+				//$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
802
+				//$this->db_modified_state = false;
803
+				//$dbRow = array();
804
+
805
+				// Let's add this object to the list of objects in cache.
806
+				$this->_addToCache($dbRow);
807
+			}
808
+
809
+			$object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
810
+		} elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
811
+			$dbRows = $object->_getDbRows();
812
+
813
+			foreach ($dbRows as $dbRow) {
814
+				$references = $dbRow->_getReferences();
815
+
816
+				// Let's save all references in NEW state (we need their primary key)
817
+				foreach ($references as $fkName => $reference) {
818
+					if ($reference !== null && $reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
819
+						$this->save($reference);
820
+					}
821
+				}
822
+
823
+				// Let's first get the primary keys
824
+				$tableName = $dbRow->_getDbTableName();
825
+				$dbRowData = $dbRow->_getDbRow();
826
+
827
+				$schema = $this->tdbmSchemaAnalyzer->getSchema();
828
+				$tableDescriptor = $schema->getTable($tableName);
829
+
830
+				$primaryKeys = $dbRow->_getPrimaryKeys();
831
+
832
+				$types = [];
833
+				$escapedDbRowData = [];
834
+				$escapedPrimaryKeys = [];
835
+
836
+				foreach ($dbRowData as $columnName => $value) {
837
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
838
+					$types[] = $columnDescriptor->getType();
839
+					$escapedDbRowData[$this->connection->quoteIdentifier($columnName)] = $value;
840
+				}
841
+				foreach ($primaryKeys as $columnName => $value) {
842
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
843
+					$types[] = $columnDescriptor->getType();
844
+					$escapedPrimaryKeys[$this->connection->quoteIdentifier($columnName)] = $value;
845
+				}
846
+
847
+				$this->connection->update($tableName, $escapedDbRowData, $escapedPrimaryKeys, $types);
848
+
849
+				// Let's check if the primary key has been updated...
850
+				$needsUpdatePk = false;
851
+				foreach ($primaryKeys as $column => $value) {
852
+					if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
853
+						$needsUpdatePk = true;
854
+						break;
855
+					}
856
+				}
857
+				if ($needsUpdatePk) {
858
+					$this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
859
+					$newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
860
+					$dbRow->_setPrimaryKeys($newPrimaryKeys);
861
+					$this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
862
+				}
863
+
864
+				// Let's remove this object from the list of objects to save.
865
+				$this->removeFromToSaveObjectList($dbRow);
866
+			}
867
+
868
+			$object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
869
+		} elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
870
+			throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
871
+		}
872
+
873
+		// Finally, let's save all the many to many relationships to this bean.
874
+		$this->persistManyToManyRelationships($object);
875
+	}
876
+
877
+	private function persistManyToManyRelationships(AbstractTDBMObject $object)
878
+	{
879
+		foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
880
+			$tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
881
+			list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
882
+
883
+			$toRemoveFromStorage = [];
884
+
885
+			foreach ($storage as $remoteBean) {
886
+				/* @var $remoteBean AbstractTDBMObject */
887
+				$statusArr = $storage[$remoteBean];
888
+				$status = $statusArr['status'];
889
+				$reverse = $statusArr['reverse'];
890
+				if ($reverse) {
891
+					continue;
892
+				}
893
+
894
+				if ($status === 'new') {
895
+					$remoteBeanStatus = $remoteBean->_getStatus();
896
+					if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
897
+						// Let's save remote bean if needed.
898
+						$this->save($remoteBean);
899
+					}
900
+
901
+					$filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
902
+
903
+					$types = [];
904
+					$escapedFilters = [];
905
+
906
+					foreach ($filters as $columnName => $value) {
907
+						$columnDescriptor = $tableDescriptor->getColumn($columnName);
908
+						$types[] = $columnDescriptor->getType();
909
+						$escapedFilters[$this->connection->quoteIdentifier($columnName)] = $value;
910
+					}
911
+
912
+					$this->connection->insert($pivotTableName, $escapedFilters, $types);
913
+
914
+					// Finally, let's mark relationships as saved.
915
+					$statusArr['status'] = 'loaded';
916
+					$storage[$remoteBean] = $statusArr;
917
+					$remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
918
+					$remoteStatusArr = $remoteStorage[$object];
919
+					$remoteStatusArr['status'] = 'loaded';
920
+					$remoteStorage[$object] = $remoteStatusArr;
921
+				} elseif ($status === 'delete') {
922
+					$filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
923
+
924
+					$types = [];
925
+
926
+					foreach ($filters as $columnName => $value) {
927
+						$columnDescriptor = $tableDescriptor->getColumn($columnName);
928
+						$types[] = $columnDescriptor->getType();
929
+					}
930
+
931
+					$this->connection->delete($pivotTableName, $filters, $types);
932
+
933
+					// Finally, let's remove relationships completely from bean.
934
+					$toRemoveFromStorage[] = $remoteBean;
935
+
936
+					$remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
937
+				}
938
+			}
939
+
940
+			// Note: due to https://bugs.php.net/bug.php?id=65629, we cannot delete an element inside a foreach loop on a SplStorageObject.
941
+			// Therefore, we cache elements in the $toRemoveFromStorage to remove them at a later stage.
942
+			foreach ($toRemoveFromStorage as $remoteBean) {
943
+				$storage->detach($remoteBean);
944
+			}
945
+		}
946
+	}
947
+
948
+	private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
949
+	{
950
+		$localBeanPk = $this->getPrimaryKeyValues($localBean);
951
+		$remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
952
+		$localColumns = $localFk->getLocalColumns();
953
+		$remoteColumns = $remoteFk->getLocalColumns();
954
+
955
+		$localFilters = array_combine($localColumns, $localBeanPk);
956
+		$remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
957
+
958
+		return array_merge($localFilters, $remoteFilters);
959
+	}
960
+
961
+	/**
962
+	 * Returns the "values" of the primary key.
963
+	 * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
964
+	 *
965
+	 * @param AbstractTDBMObject $bean
966
+	 *
967
+	 * @return array numerically indexed array of values
968
+	 */
969
+	private function getPrimaryKeyValues(AbstractTDBMObject $bean)
970
+	{
971
+		$dbRows = $bean->_getDbRows();
972
+		$dbRow = reset($dbRows);
973
+
974
+		return array_values($dbRow->_getPrimaryKeys());
975
+	}
976
+
977
+	/**
978
+	 * Returns a unique hash used to store the object based on its primary key.
979
+	 * If the array contains only one value, then the value is returned.
980
+	 * Otherwise, a hash representing the array is returned.
981
+	 *
982
+	 * @param array $primaryKeys An array of columns => values forming the primary key
983
+	 *
984
+	 * @return string
985
+	 */
986
+	public function getObjectHash(array $primaryKeys)
987
+	{
988
+		if (count($primaryKeys) === 1) {
989
+			return reset($primaryKeys);
990
+		} else {
991
+			ksort($primaryKeys);
992
+
993
+			return md5(json_encode($primaryKeys));
994
+		}
995
+	}
996
+
997
+	/**
998
+	 * Returns an array of primary keys from the object.
999
+	 * The primary keys are extracted from the object columns and not from the primary keys stored in the
1000
+	 * $primaryKeys variable of the object.
1001
+	 *
1002
+	 * @param DbRow $dbRow
1003
+	 *
1004
+	 * @return array Returns an array of column => value
1005
+	 */
1006
+	public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
1007
+	{
1008
+		$table = $dbRow->_getDbTableName();
1009
+		$dbRowData = $dbRow->_getDbRow();
1010
+
1011
+		return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
1012
+	}
1013
+
1014
+	/**
1015
+	 * Returns an array of primary keys for the given row.
1016
+	 * The primary keys are extracted from the object columns.
1017
+	 *
1018
+	 * @param $table
1019
+	 * @param array $columns
1020
+	 *
1021
+	 * @return array
1022
+	 */
1023
+	public function _getPrimaryKeysFromObjectData($table, array $columns)
1024
+	{
1025
+		$primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1026
+		$values = array();
1027
+		foreach ($primaryKeyColumns as $column) {
1028
+			if (isset($columns[$column])) {
1029
+				$values[$column] = $columns[$column];
1030
+			}
1031
+		}
1032
+
1033
+		return $values;
1034
+	}
1035
+
1036
+	/**
1037
+	 * Attaches $object to this TDBMService.
1038
+	 * The $object must be in DETACHED state and will pass in NEW state.
1039
+	 *
1040
+	 * @param AbstractTDBMObject $object
1041
+	 *
1042
+	 * @throws TDBMInvalidOperationException
1043
+	 */
1044
+	public function attach(AbstractTDBMObject $object)
1045
+	{
1046
+		$object->_attach($this);
1047
+	}
1048
+
1049
+	/**
1050
+	 * Returns an associative array (column => value) for the primary keys from the table name and an
1051
+	 * indexed array of primary key values.
1052
+	 *
1053
+	 * @param string $tableName
1054
+	 * @param array  $indexedPrimaryKeys
1055
+	 */
1056
+	public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
1057
+	{
1058
+		$primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
1059
+
1060
+		if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
1061
+			throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
1062 1062
 			got %s instead.', count($primaryKeyColumns), $tableName, count($indexedPrimaryKeys)));
1063
-        }
1064
-
1065
-        return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1066
-    }
1067
-
1068
-    /**
1069
-     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1070
-     * Tables must be in a single line of inheritance. The method will find missing tables.
1071
-     *
1072
-     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1073
-     * we must be able to find all other tables.
1074
-     *
1075
-     * @param string[] $tables
1076
-     *
1077
-     * @return string[]
1078
-     */
1079
-    public function _getLinkBetweenInheritedTables(array $tables)
1080
-    {
1081
-        sort($tables);
1082
-
1083
-        return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1084
-            function () use ($tables) {
1085
-                return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1086
-            });
1087
-    }
1088
-
1089
-    /**
1090
-     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1091
-     * Tables must be in a single line of inheritance. The method will find missing tables.
1092
-     *
1093
-     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1094
-     * we must be able to find all other tables.
1095
-     *
1096
-     * @param string[] $tables
1097
-     *
1098
-     * @return string[]
1099
-     */
1100
-    private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1101
-    {
1102
-        $schemaAnalyzer = $this->schemaAnalyzer;
1103
-
1104
-        foreach ($tables as $currentTable) {
1105
-            $allParents = [$currentTable];
1106
-            while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1107
-                $currentTable = $currentFk->getForeignTableName();
1108
-                $allParents[] = $currentTable;
1109
-            }
1110
-
1111
-            // Now, does the $allParents contain all the tables we want?
1112
-            $notFoundTables = array_diff($tables, $allParents);
1113
-            if (empty($notFoundTables)) {
1114
-                // We have a winner!
1115
-                return $allParents;
1116
-            }
1117
-        }
1118
-
1119
-        throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1120
-    }
1121
-
1122
-    /**
1123
-     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1124
-     *
1125
-     * @param string $table
1126
-     *
1127
-     * @return string[]
1128
-     */
1129
-    public function _getRelatedTablesByInheritance($table)
1130
-    {
1131
-        return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1132
-            return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1133
-        });
1134
-    }
1135
-
1136
-    /**
1137
-     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1138
-     *
1139
-     * @param string $table
1140
-     *
1141
-     * @return string[]
1142
-     */
1143
-    private function _getRelatedTablesByInheritanceWithoutCache($table)
1144
-    {
1145
-        $schemaAnalyzer = $this->schemaAnalyzer;
1146
-
1147
-        // Let's scan the parent tables
1148
-        $currentTable = $table;
1149
-
1150
-        $parentTables = [];
1151
-
1152
-        // Get parent relationship
1153
-        while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1154
-            $currentTable = $currentFk->getForeignTableName();
1155
-            $parentTables[] = $currentTable;
1156
-        }
1157
-
1158
-        // Let's recurse in children
1159
-        $childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1160
-
1161
-        return array_merge(array_reverse($parentTables), $childrenTables);
1162
-    }
1163
-
1164
-    /**
1165
-     * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1166
-     *
1167
-     * @param string $table
1168
-     *
1169
-     * @return string[]
1170
-     */
1171
-    private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1172
-    {
1173
-        $tables = [$table];
1174
-        $keys = $schemaAnalyzer->getChildrenRelationships($table);
1175
-
1176
-        foreach ($keys as $key) {
1177
-            $tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1178
-        }
1179
-
1180
-        return $tables;
1181
-    }
1182
-
1183
-    /**
1184
-     * Casts a foreign key into SQL, assuming table name is used with no alias.
1185
-     * The returned value does contain only one table. For instance:.
1186
-     *
1187
-     * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1188
-     *
1189
-     * @param ForeignKeyConstraint $fk
1190
-     * @param bool                 $leftTableIsLocal
1191
-     *
1192
-     * @return string
1193
-     */
1194
-    /*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
1063
+		}
1064
+
1065
+		return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1066
+	}
1067
+
1068
+	/**
1069
+	 * Return the list of tables (from child to parent) joining the tables passed in parameter.
1070
+	 * Tables must be in a single line of inheritance. The method will find missing tables.
1071
+	 *
1072
+	 * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1073
+	 * we must be able to find all other tables.
1074
+	 *
1075
+	 * @param string[] $tables
1076
+	 *
1077
+	 * @return string[]
1078
+	 */
1079
+	public function _getLinkBetweenInheritedTables(array $tables)
1080
+	{
1081
+		sort($tables);
1082
+
1083
+		return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1084
+			function () use ($tables) {
1085
+				return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1086
+			});
1087
+	}
1088
+
1089
+	/**
1090
+	 * Return the list of tables (from child to parent) joining the tables passed in parameter.
1091
+	 * Tables must be in a single line of inheritance. The method will find missing tables.
1092
+	 *
1093
+	 * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1094
+	 * we must be able to find all other tables.
1095
+	 *
1096
+	 * @param string[] $tables
1097
+	 *
1098
+	 * @return string[]
1099
+	 */
1100
+	private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1101
+	{
1102
+		$schemaAnalyzer = $this->schemaAnalyzer;
1103
+
1104
+		foreach ($tables as $currentTable) {
1105
+			$allParents = [$currentTable];
1106
+			while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1107
+				$currentTable = $currentFk->getForeignTableName();
1108
+				$allParents[] = $currentTable;
1109
+			}
1110
+
1111
+			// Now, does the $allParents contain all the tables we want?
1112
+			$notFoundTables = array_diff($tables, $allParents);
1113
+			if (empty($notFoundTables)) {
1114
+				// We have a winner!
1115
+				return $allParents;
1116
+			}
1117
+		}
1118
+
1119
+		throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1120
+	}
1121
+
1122
+	/**
1123
+	 * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1124
+	 *
1125
+	 * @param string $table
1126
+	 *
1127
+	 * @return string[]
1128
+	 */
1129
+	public function _getRelatedTablesByInheritance($table)
1130
+	{
1131
+		return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1132
+			return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1133
+		});
1134
+	}
1135
+
1136
+	/**
1137
+	 * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1138
+	 *
1139
+	 * @param string $table
1140
+	 *
1141
+	 * @return string[]
1142
+	 */
1143
+	private function _getRelatedTablesByInheritanceWithoutCache($table)
1144
+	{
1145
+		$schemaAnalyzer = $this->schemaAnalyzer;
1146
+
1147
+		// Let's scan the parent tables
1148
+		$currentTable = $table;
1149
+
1150
+		$parentTables = [];
1151
+
1152
+		// Get parent relationship
1153
+		while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1154
+			$currentTable = $currentFk->getForeignTableName();
1155
+			$parentTables[] = $currentTable;
1156
+		}
1157
+
1158
+		// Let's recurse in children
1159
+		$childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1160
+
1161
+		return array_merge(array_reverse($parentTables), $childrenTables);
1162
+	}
1163
+
1164
+	/**
1165
+	 * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1166
+	 *
1167
+	 * @param string $table
1168
+	 *
1169
+	 * @return string[]
1170
+	 */
1171
+	private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1172
+	{
1173
+		$tables = [$table];
1174
+		$keys = $schemaAnalyzer->getChildrenRelationships($table);
1175
+
1176
+		foreach ($keys as $key) {
1177
+			$tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1178
+		}
1179
+
1180
+		return $tables;
1181
+	}
1182
+
1183
+	/**
1184
+	 * Casts a foreign key into SQL, assuming table name is used with no alias.
1185
+	 * The returned value does contain only one table. For instance:.
1186
+	 *
1187
+	 * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1188
+	 *
1189
+	 * @param ForeignKeyConstraint $fk
1190
+	 * @param bool                 $leftTableIsLocal
1191
+	 *
1192
+	 * @return string
1193
+	 */
1194
+	/*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
1195 1195
         $onClauses = [];
1196 1196
         $foreignTableName = $this->connection->quoteIdentifier($fk->getForeignTableName());
1197 1197
         $foreignColumns = $fk->getForeignColumns();
@@ -1217,405 +1217,405 @@  discard block
 block discarded – undo
1217 1217
         }
1218 1218
     }*/
1219 1219
 
1220
-    /**
1221
-     * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1222
-     *
1223
-     * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1224
-     * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1225
-     *
1226
-     * The findObjects method takes in parameter:
1227
-     * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1228
-     * 			`$mainTable` parameter should be the name of an existing table in database.
1229
-     *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1230
-     *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1231
-     *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1232
-     *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1233
-     *          Instead, please consider passing parameters (see documentation for more details).
1234
-     *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1235
-     *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1236
-     *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1237
-     *
1238
-     * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1239
-     * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1240
-     *
1241
-     * Finally, if filter_bag is null, the whole table is returned.
1242
-     *
1243
-     * @param string                       $mainTable             The name of the table queried
1244
-     * @param string|array|null            $filter                The SQL filters to apply to the query (the WHERE part). Columns from tables different from $mainTable must be prefixed by the table name (in the form: table.column)
1245
-     * @param array                        $parameters
1246
-     * @param string|UncheckedOrderBy|null $orderString           The ORDER BY part of the query. Columns from tables different from $mainTable must be prefixed by the table name (in the form: table.column)
1247
-     * @param array                        $additionalTablesFetch
1248
-     * @param int                          $mode
1249
-     * @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
1250
-     *
1251
-     * @return ResultIterator An object representing an array of results
1252
-     *
1253
-     * @throws TDBMException
1254
-     */
1255
-    public function findObjects(string $mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, string $className = null)
1256
-    {
1257
-        // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1258
-        if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1259
-            throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1260
-        }
1261
-
1262
-        $mode = $mode ?: $this->mode;
1263
-
1264
-        list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1265
-
1266
-        $parameters = array_merge($parameters, $additionalParameters);
1267
-
1268
-        $queryFactory = new FindObjectsQueryFactory($mainTable, $additionalTablesFetch, $filterString, $orderString, $this, $this->tdbmSchemaAnalyzer->getSchema(), $this->orderByAnalyzer);
1269
-
1270
-        return new ResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
1271
-    }
1272
-
1273
-    /**
1274
-     * @param string                       $mainTable   The name of the table queried
1275
-     * @param string                       $from        The from sql statement
1276
-     * @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)
1277
-     * @param array                        $parameters
1278
-     * @param string|UncheckedOrderBy|null $orderString The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
1279
-     * @param int                          $mode
1280
-     * @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
1281
-     *
1282
-     * @return ResultIterator An object representing an array of results
1283
-     *
1284
-     * @throws TDBMException
1285
-     */
1286
-    public function findObjectsFromSql(string $mainTable, string $from, $filter = null, array $parameters = array(), $orderString = null, $mode = null, string $className = null)
1287
-    {
1288
-        // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1289
-        if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1290
-            throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1291
-        }
1292
-
1293
-        $mode = $mode ?: $this->mode;
1294
-
1295
-        list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1296
-
1297
-        $parameters = array_merge($parameters, $additionalParameters);
1298
-
1299
-        $queryFactory = new FindObjectsFromSqlQueryFactory($mainTable, $from, $filterString, $orderString, $this, $this->tdbmSchemaAnalyzer->getSchema(), $this->orderByAnalyzer, $this->schemaAnalyzer, $this->cache, $this->cachePrefix);
1300
-
1301
-        return new ResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
1302
-    }
1303
-
1304
-    /**
1305
-     * @param $table
1306
-     * @param array  $primaryKeys
1307
-     * @param array  $additionalTablesFetch
1308
-     * @param bool   $lazy                  Whether to perform lazy loading on this object or not
1309
-     * @param string $className
1310
-     *
1311
-     * @return AbstractTDBMObject
1312
-     *
1313
-     * @throws TDBMException
1314
-     */
1315
-    public function findObjectByPk(string $table, array $primaryKeys, array $additionalTablesFetch = array(), bool $lazy = false, string $className = null)
1316
-    {
1317
-        $primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1318
-        $hash = $this->getObjectHash($primaryKeys);
1319
-
1320
-        if ($this->objectStorage->has($table, $hash)) {
1321
-            $dbRow = $this->objectStorage->get($table, $hash);
1322
-            $bean = $dbRow->getTDBMObject();
1323
-            if ($className !== null && !is_a($bean, $className)) {
1324
-                throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1325
-            }
1326
-
1327
-            return $bean;
1328
-        }
1329
-
1330
-        // Are we performing lazy fetching?
1331
-        if ($lazy === true) {
1332
-            // Can we perform lazy fetching?
1333
-            $tables = $this->_getRelatedTablesByInheritance($table);
1334
-            // Only allowed if no inheritance.
1335
-            if (count($tables) === 1) {
1336
-                if ($className === null) {
1337
-                    $className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1338
-                }
1339
-
1340
-                // Let's construct the bean
1341
-                if (!isset($this->reflectionClassCache[$className])) {
1342
-                    $this->reflectionClassCache[$className] = new \ReflectionClass($className);
1343
-                }
1344
-                // Let's bypass the constructor when creating the bean!
1345
-                $bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1346
-                /* @var $bean AbstractTDBMObject */
1347
-                $bean->_constructLazy($table, $primaryKeys, $this);
1348
-
1349
-                return $bean;
1350
-            }
1351
-        }
1352
-
1353
-        // Did not find the object in cache? Let's query it!
1354
-        return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1355
-    }
1356
-
1357
-    /**
1358
-     * Returns a unique bean (or null) according to the filters passed in parameter.
1359
-     *
1360
-     * @param string            $mainTable             The name of the table queried
1361
-     * @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)
1362
-     * @param array             $parameters
1363
-     * @param array             $additionalTablesFetch
1364
-     * @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
1365
-     *
1366
-     * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters
1367
-     *
1368
-     * @throws TDBMException
1369
-     */
1370
-    public function findObject(string $mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), string $className = null)
1371
-    {
1372
-        $objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1373
-        $page = $objects->take(0, 2);
1374
-        $count = $page->count();
1375
-        if ($count > 1) {
1376
-            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.");
1377
-        } elseif ($count === 0) {
1378
-            return;
1379
-        }
1380
-
1381
-        return $page[0];
1382
-    }
1383
-
1384
-    /**
1385
-     * Returns a unique bean (or null) according to the filters passed in parameter.
1386
-     *
1387
-     * @param string            $mainTable  The name of the table queried
1388
-     * @param string            $from       The from sql statement
1389
-     * @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)
1390
-     * @param array             $parameters
1391
-     * @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
1392
-     *
1393
-     * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters
1394
-     *
1395
-     * @throws TDBMException
1396
-     */
1397
-    public function findObjectFromSql($mainTable, $from, $filter = null, array $parameters = array(), $className = null)
1398
-    {
1399
-        $objects = $this->findObjectsFromSql($mainTable, $from, $filter, $parameters, null, self::MODE_ARRAY, $className);
1400
-        $page = $objects->take(0, 2);
1401
-        $count = $page->count();
1402
-        if ($count > 1) {
1403
-            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.");
1404
-        } elseif ($count === 0) {
1405
-            return;
1406
-        }
1407
-
1408
-        return $page[0];
1409
-    }
1410
-
1411
-    /**
1412
-     * Returns a unique bean according to the filters passed in parameter.
1413
-     * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1414
-     *
1415
-     * @param string            $mainTable             The name of the table queried
1416
-     * @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)
1417
-     * @param array             $parameters
1418
-     * @param array             $additionalTablesFetch
1419
-     * @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
1420
-     *
1421
-     * @return AbstractTDBMObject The object we want
1422
-     *
1423
-     * @throws TDBMException
1424
-     */
1425
-    public function findObjectOrFail(string $mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), string $className = null)
1426
-    {
1427
-        $bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1428
-        if ($bean === null) {
1429
-            throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1430
-        }
1431
-
1432
-        return $bean;
1433
-    }
1434
-
1435
-    /**
1436
-     * @param array $beanData An array of data: array<table, array<column, value>>
1437
-     *
1438
-     * @return array an array with first item = class name, second item = table name and third item = list of tables needed
1439
-     */
1440
-    public function _getClassNameFromBeanData(array $beanData)
1441
-    {
1442
-        if (count($beanData) === 1) {
1443
-            $tableName = array_keys($beanData)[0];
1444
-            $allTables = [$tableName];
1445
-        } else {
1446
-            $tables = [];
1447
-            foreach ($beanData as $table => $row) {
1448
-                $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1449
-                $pkSet = false;
1450
-                foreach ($primaryKeyColumns as $columnName) {
1451
-                    if ($row[$columnName] !== null) {
1452
-                        $pkSet = true;
1453
-                        break;
1454
-                    }
1455
-                }
1456
-                if ($pkSet) {
1457
-                    $tables[] = $table;
1458
-                }
1459
-            }
1460
-
1461
-            // $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1462
-            $allTables = $this->_getLinkBetweenInheritedTables($tables);
1463
-            $tableName = $allTables[0];
1464
-        }
1465
-
1466
-        // Only one table in this bean. Life is sweat, let's look at its type:
1467
-        if (isset($this->tableToBeanMap[$tableName])) {
1468
-            return [$this->tableToBeanMap[$tableName], $tableName, $allTables];
1469
-        } else {
1470
-            return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName, $allTables];
1471
-        }
1472
-    }
1473
-
1474
-    /**
1475
-     * Returns an item from cache or computes it using $closure and puts it in cache.
1476
-     *
1477
-     * @param string   $key
1478
-     * @param callable $closure
1479
-     *
1480
-     * @return mixed
1481
-     */
1482
-    private function fromCache(string $key, callable $closure)
1483
-    {
1484
-        $item = $this->cache->fetch($key);
1485
-        if ($item === false) {
1486
-            $item = $closure();
1487
-            $this->cache->save($key, $item);
1488
-        }
1489
-
1490
-        return $item;
1491
-    }
1492
-
1493
-    /**
1494
-     * Returns the foreign key object.
1495
-     *
1496
-     * @param string $table
1497
-     * @param string $fkName
1498
-     *
1499
-     * @return ForeignKeyConstraint
1500
-     */
1501
-    public function _getForeignKeyByName(string $table, string $fkName)
1502
-    {
1503
-        return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1504
-    }
1505
-
1506
-    /**
1507
-     * @param $pivotTableName
1508
-     * @param AbstractTDBMObject $bean
1509
-     *
1510
-     * @return AbstractTDBMObject[]
1511
-     */
1512
-    public function _getRelatedBeans(string $pivotTableName, AbstractTDBMObject $bean)
1513
-    {
1514
-        list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1515
-        /* @var $localFk ForeignKeyConstraint */
1516
-        /* @var $remoteFk ForeignKeyConstraint */
1517
-        $remoteTable = $remoteFk->getForeignTableName();
1518
-
1519
-        $primaryKeys = $this->getPrimaryKeyValues($bean);
1520
-        $columnNames = array_map(function ($name) use ($pivotTableName) {
1521
-            return $pivotTableName.'.'.$name;
1522
-        }, $localFk->getLocalColumns());
1523
-
1524
-        $filter = array_combine($columnNames, $primaryKeys);
1525
-
1526
-        return $this->findObjects($remoteTable, $filter);
1527
-    }
1528
-
1529
-    /**
1530
-     * @param $pivotTableName
1531
-     * @param AbstractTDBMObject $bean The LOCAL bean
1532
-     *
1533
-     * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean
1534
-     *
1535
-     * @throws TDBMException
1536
-     */
1537
-    private function getPivotTableForeignKeys(string $pivotTableName, AbstractTDBMObject $bean)
1538
-    {
1539
-        $fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1540
-        $table1 = $fks[0]->getForeignTableName();
1541
-        $table2 = $fks[1]->getForeignTableName();
1542
-
1543
-        $beanTables = array_map(function (DbRow $dbRow) {
1544
-            return $dbRow->_getDbTableName();
1545
-        }, $bean->_getDbRows());
1546
-
1547
-        if (in_array($table1, $beanTables)) {
1548
-            return [$fks[0], $fks[1]];
1549
-        } elseif (in_array($table2, $beanTables)) {
1550
-            return [$fks[1], $fks[0]];
1551
-        } else {
1552
-            throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1553
-        }
1554
-    }
1555
-
1556
-    /**
1557
-     * Returns a list of pivot tables linked to $bean.
1558
-     *
1559
-     * @param AbstractTDBMObject $bean
1560
-     *
1561
-     * @return string[]
1562
-     */
1563
-    public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1564
-    {
1565
-        $junctionTables = [];
1566
-        $allJunctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
1567
-        foreach ($bean->_getDbRows() as $dbRow) {
1568
-            foreach ($allJunctionTables as $table) {
1569
-                // There are exactly 2 FKs since this is a pivot table.
1570
-                $fks = array_values($table->getForeignKeys());
1571
-
1572
-                if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1573
-                    $junctionTables[] = $table->getName();
1574
-                }
1575
-            }
1576
-        }
1577
-
1578
-        return $junctionTables;
1579
-    }
1580
-
1581
-    /**
1582
-     * Array of types for tables.
1583
-     * Key: table name
1584
-     * Value: array of types indexed by column.
1585
-     *
1586
-     * @var array[]
1587
-     */
1588
-    private $typesForTable = [];
1589
-
1590
-    /**
1591
-     * @internal
1592
-     *
1593
-     * @param string $tableName
1594
-     *
1595
-     * @return Type[]
1596
-     */
1597
-    public function _getColumnTypesForTable(string $tableName)
1598
-    {
1599
-        if (!isset($typesForTable[$tableName])) {
1600
-            $columns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getColumns();
1601
-            $typesForTable[$tableName] = array_map(function (Column $column) {
1602
-                return $column->getType();
1603
-            }, $columns);
1604
-        }
1605
-
1606
-        return $typesForTable[$tableName];
1607
-    }
1608
-
1609
-    /**
1610
-     * Sets the minimum log level.
1611
-     * $level must be one of Psr\Log\LogLevel::xxx.
1612
-     *
1613
-     * Defaults to LogLevel::WARNING
1614
-     *
1615
-     * @param string $level
1616
-     */
1617
-    public function setLogLevel(string $level)
1618
-    {
1619
-        $this->logger = new LevelFilter($this->rootLogger, $level);
1620
-    }
1220
+	/**
1221
+	 * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1222
+	 *
1223
+	 * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1224
+	 * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1225
+	 *
1226
+	 * The findObjects method takes in parameter:
1227
+	 * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1228
+	 * 			`$mainTable` parameter should be the name of an existing table in database.
1229
+	 *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1230
+	 *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1231
+	 *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1232
+	 *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1233
+	 *          Instead, please consider passing parameters (see documentation for more details).
1234
+	 *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1235
+	 *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1236
+	 *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1237
+	 *
1238
+	 * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1239
+	 * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1240
+	 *
1241
+	 * Finally, if filter_bag is null, the whole table is returned.
1242
+	 *
1243
+	 * @param string                       $mainTable             The name of the table queried
1244
+	 * @param string|array|null            $filter                The SQL filters to apply to the query (the WHERE part). Columns from tables different from $mainTable must be prefixed by the table name (in the form: table.column)
1245
+	 * @param array                        $parameters
1246
+	 * @param string|UncheckedOrderBy|null $orderString           The ORDER BY part of the query. Columns from tables different from $mainTable must be prefixed by the table name (in the form: table.column)
1247
+	 * @param array                        $additionalTablesFetch
1248
+	 * @param int                          $mode
1249
+	 * @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
1250
+	 *
1251
+	 * @return ResultIterator An object representing an array of results
1252
+	 *
1253
+	 * @throws TDBMException
1254
+	 */
1255
+	public function findObjects(string $mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, string $className = null)
1256
+	{
1257
+		// $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1258
+		if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1259
+			throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1260
+		}
1261
+
1262
+		$mode = $mode ?: $this->mode;
1263
+
1264
+		list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1265
+
1266
+		$parameters = array_merge($parameters, $additionalParameters);
1267
+
1268
+		$queryFactory = new FindObjectsQueryFactory($mainTable, $additionalTablesFetch, $filterString, $orderString, $this, $this->tdbmSchemaAnalyzer->getSchema(), $this->orderByAnalyzer);
1269
+
1270
+		return new ResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
1271
+	}
1272
+
1273
+	/**
1274
+	 * @param string                       $mainTable   The name of the table queried
1275
+	 * @param string                       $from        The from sql statement
1276
+	 * @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)
1277
+	 * @param array                        $parameters
1278
+	 * @param string|UncheckedOrderBy|null $orderString The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
1279
+	 * @param int                          $mode
1280
+	 * @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
1281
+	 *
1282
+	 * @return ResultIterator An object representing an array of results
1283
+	 *
1284
+	 * @throws TDBMException
1285
+	 */
1286
+	public function findObjectsFromSql(string $mainTable, string $from, $filter = null, array $parameters = array(), $orderString = null, $mode = null, string $className = null)
1287
+	{
1288
+		// $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1289
+		if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1290
+			throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1291
+		}
1292
+
1293
+		$mode = $mode ?: $this->mode;
1294
+
1295
+		list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1296
+
1297
+		$parameters = array_merge($parameters, $additionalParameters);
1298
+
1299
+		$queryFactory = new FindObjectsFromSqlQueryFactory($mainTable, $from, $filterString, $orderString, $this, $this->tdbmSchemaAnalyzer->getSchema(), $this->orderByAnalyzer, $this->schemaAnalyzer, $this->cache, $this->cachePrefix);
1300
+
1301
+		return new ResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
1302
+	}
1303
+
1304
+	/**
1305
+	 * @param $table
1306
+	 * @param array  $primaryKeys
1307
+	 * @param array  $additionalTablesFetch
1308
+	 * @param bool   $lazy                  Whether to perform lazy loading on this object or not
1309
+	 * @param string $className
1310
+	 *
1311
+	 * @return AbstractTDBMObject
1312
+	 *
1313
+	 * @throws TDBMException
1314
+	 */
1315
+	public function findObjectByPk(string $table, array $primaryKeys, array $additionalTablesFetch = array(), bool $lazy = false, string $className = null)
1316
+	{
1317
+		$primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1318
+		$hash = $this->getObjectHash($primaryKeys);
1319
+
1320
+		if ($this->objectStorage->has($table, $hash)) {
1321
+			$dbRow = $this->objectStorage->get($table, $hash);
1322
+			$bean = $dbRow->getTDBMObject();
1323
+			if ($className !== null && !is_a($bean, $className)) {
1324
+				throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1325
+			}
1326
+
1327
+			return $bean;
1328
+		}
1329
+
1330
+		// Are we performing lazy fetching?
1331
+		if ($lazy === true) {
1332
+			// Can we perform lazy fetching?
1333
+			$tables = $this->_getRelatedTablesByInheritance($table);
1334
+			// Only allowed if no inheritance.
1335
+			if (count($tables) === 1) {
1336
+				if ($className === null) {
1337
+					$className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1338
+				}
1339
+
1340
+				// Let's construct the bean
1341
+				if (!isset($this->reflectionClassCache[$className])) {
1342
+					$this->reflectionClassCache[$className] = new \ReflectionClass($className);
1343
+				}
1344
+				// Let's bypass the constructor when creating the bean!
1345
+				$bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1346
+				/* @var $bean AbstractTDBMObject */
1347
+				$bean->_constructLazy($table, $primaryKeys, $this);
1348
+
1349
+				return $bean;
1350
+			}
1351
+		}
1352
+
1353
+		// Did not find the object in cache? Let's query it!
1354
+		return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1355
+	}
1356
+
1357
+	/**
1358
+	 * Returns a unique bean (or null) according to the filters passed in parameter.
1359
+	 *
1360
+	 * @param string            $mainTable             The name of the table queried
1361
+	 * @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)
1362
+	 * @param array             $parameters
1363
+	 * @param array             $additionalTablesFetch
1364
+	 * @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
1365
+	 *
1366
+	 * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters
1367
+	 *
1368
+	 * @throws TDBMException
1369
+	 */
1370
+	public function findObject(string $mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), string $className = null)
1371
+	{
1372
+		$objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1373
+		$page = $objects->take(0, 2);
1374
+		$count = $page->count();
1375
+		if ($count > 1) {
1376
+			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.");
1377
+		} elseif ($count === 0) {
1378
+			return;
1379
+		}
1380
+
1381
+		return $page[0];
1382
+	}
1383
+
1384
+	/**
1385
+	 * Returns a unique bean (or null) according to the filters passed in parameter.
1386
+	 *
1387
+	 * @param string            $mainTable  The name of the table queried
1388
+	 * @param string            $from       The from sql statement
1389
+	 * @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)
1390
+	 * @param array             $parameters
1391
+	 * @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
1392
+	 *
1393
+	 * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters
1394
+	 *
1395
+	 * @throws TDBMException
1396
+	 */
1397
+	public function findObjectFromSql($mainTable, $from, $filter = null, array $parameters = array(), $className = null)
1398
+	{
1399
+		$objects = $this->findObjectsFromSql($mainTable, $from, $filter, $parameters, null, self::MODE_ARRAY, $className);
1400
+		$page = $objects->take(0, 2);
1401
+		$count = $page->count();
1402
+		if ($count > 1) {
1403
+			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.");
1404
+		} elseif ($count === 0) {
1405
+			return;
1406
+		}
1407
+
1408
+		return $page[0];
1409
+	}
1410
+
1411
+	/**
1412
+	 * Returns a unique bean according to the filters passed in parameter.
1413
+	 * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1414
+	 *
1415
+	 * @param string            $mainTable             The name of the table queried
1416
+	 * @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)
1417
+	 * @param array             $parameters
1418
+	 * @param array             $additionalTablesFetch
1419
+	 * @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
1420
+	 *
1421
+	 * @return AbstractTDBMObject The object we want
1422
+	 *
1423
+	 * @throws TDBMException
1424
+	 */
1425
+	public function findObjectOrFail(string $mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), string $className = null)
1426
+	{
1427
+		$bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1428
+		if ($bean === null) {
1429
+			throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1430
+		}
1431
+
1432
+		return $bean;
1433
+	}
1434
+
1435
+	/**
1436
+	 * @param array $beanData An array of data: array<table, array<column, value>>
1437
+	 *
1438
+	 * @return array an array with first item = class name, second item = table name and third item = list of tables needed
1439
+	 */
1440
+	public function _getClassNameFromBeanData(array $beanData)
1441
+	{
1442
+		if (count($beanData) === 1) {
1443
+			$tableName = array_keys($beanData)[0];
1444
+			$allTables = [$tableName];
1445
+		} else {
1446
+			$tables = [];
1447
+			foreach ($beanData as $table => $row) {
1448
+				$primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1449
+				$pkSet = false;
1450
+				foreach ($primaryKeyColumns as $columnName) {
1451
+					if ($row[$columnName] !== null) {
1452
+						$pkSet = true;
1453
+						break;
1454
+					}
1455
+				}
1456
+				if ($pkSet) {
1457
+					$tables[] = $table;
1458
+				}
1459
+			}
1460
+
1461
+			// $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1462
+			$allTables = $this->_getLinkBetweenInheritedTables($tables);
1463
+			$tableName = $allTables[0];
1464
+		}
1465
+
1466
+		// Only one table in this bean. Life is sweat, let's look at its type:
1467
+		if (isset($this->tableToBeanMap[$tableName])) {
1468
+			return [$this->tableToBeanMap[$tableName], $tableName, $allTables];
1469
+		} else {
1470
+			return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName, $allTables];
1471
+		}
1472
+	}
1473
+
1474
+	/**
1475
+	 * Returns an item from cache or computes it using $closure and puts it in cache.
1476
+	 *
1477
+	 * @param string   $key
1478
+	 * @param callable $closure
1479
+	 *
1480
+	 * @return mixed
1481
+	 */
1482
+	private function fromCache(string $key, callable $closure)
1483
+	{
1484
+		$item = $this->cache->fetch($key);
1485
+		if ($item === false) {
1486
+			$item = $closure();
1487
+			$this->cache->save($key, $item);
1488
+		}
1489
+
1490
+		return $item;
1491
+	}
1492
+
1493
+	/**
1494
+	 * Returns the foreign key object.
1495
+	 *
1496
+	 * @param string $table
1497
+	 * @param string $fkName
1498
+	 *
1499
+	 * @return ForeignKeyConstraint
1500
+	 */
1501
+	public function _getForeignKeyByName(string $table, string $fkName)
1502
+	{
1503
+		return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1504
+	}
1505
+
1506
+	/**
1507
+	 * @param $pivotTableName
1508
+	 * @param AbstractTDBMObject $bean
1509
+	 *
1510
+	 * @return AbstractTDBMObject[]
1511
+	 */
1512
+	public function _getRelatedBeans(string $pivotTableName, AbstractTDBMObject $bean)
1513
+	{
1514
+		list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1515
+		/* @var $localFk ForeignKeyConstraint */
1516
+		/* @var $remoteFk ForeignKeyConstraint */
1517
+		$remoteTable = $remoteFk->getForeignTableName();
1518
+
1519
+		$primaryKeys = $this->getPrimaryKeyValues($bean);
1520
+		$columnNames = array_map(function ($name) use ($pivotTableName) {
1521
+			return $pivotTableName.'.'.$name;
1522
+		}, $localFk->getLocalColumns());
1523
+
1524
+		$filter = array_combine($columnNames, $primaryKeys);
1525
+
1526
+		return $this->findObjects($remoteTable, $filter);
1527
+	}
1528
+
1529
+	/**
1530
+	 * @param $pivotTableName
1531
+	 * @param AbstractTDBMObject $bean The LOCAL bean
1532
+	 *
1533
+	 * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean
1534
+	 *
1535
+	 * @throws TDBMException
1536
+	 */
1537
+	private function getPivotTableForeignKeys(string $pivotTableName, AbstractTDBMObject $bean)
1538
+	{
1539
+		$fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1540
+		$table1 = $fks[0]->getForeignTableName();
1541
+		$table2 = $fks[1]->getForeignTableName();
1542
+
1543
+		$beanTables = array_map(function (DbRow $dbRow) {
1544
+			return $dbRow->_getDbTableName();
1545
+		}, $bean->_getDbRows());
1546
+
1547
+		if (in_array($table1, $beanTables)) {
1548
+			return [$fks[0], $fks[1]];
1549
+		} elseif (in_array($table2, $beanTables)) {
1550
+			return [$fks[1], $fks[0]];
1551
+		} else {
1552
+			throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1553
+		}
1554
+	}
1555
+
1556
+	/**
1557
+	 * Returns a list of pivot tables linked to $bean.
1558
+	 *
1559
+	 * @param AbstractTDBMObject $bean
1560
+	 *
1561
+	 * @return string[]
1562
+	 */
1563
+	public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1564
+	{
1565
+		$junctionTables = [];
1566
+		$allJunctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
1567
+		foreach ($bean->_getDbRows() as $dbRow) {
1568
+			foreach ($allJunctionTables as $table) {
1569
+				// There are exactly 2 FKs since this is a pivot table.
1570
+				$fks = array_values($table->getForeignKeys());
1571
+
1572
+				if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1573
+					$junctionTables[] = $table->getName();
1574
+				}
1575
+			}
1576
+		}
1577
+
1578
+		return $junctionTables;
1579
+	}
1580
+
1581
+	/**
1582
+	 * Array of types for tables.
1583
+	 * Key: table name
1584
+	 * Value: array of types indexed by column.
1585
+	 *
1586
+	 * @var array[]
1587
+	 */
1588
+	private $typesForTable = [];
1589
+
1590
+	/**
1591
+	 * @internal
1592
+	 *
1593
+	 * @param string $tableName
1594
+	 *
1595
+	 * @return Type[]
1596
+	 */
1597
+	public function _getColumnTypesForTable(string $tableName)
1598
+	{
1599
+		if (!isset($typesForTable[$tableName])) {
1600
+			$columns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getColumns();
1601
+			$typesForTable[$tableName] = array_map(function (Column $column) {
1602
+				return $column->getType();
1603
+			}, $columns);
1604
+		}
1605
+
1606
+		return $typesForTable[$tableName];
1607
+	}
1608
+
1609
+	/**
1610
+	 * Sets the minimum log level.
1611
+	 * $level must be one of Psr\Log\LogLevel::xxx.
1612
+	 *
1613
+	 * Defaults to LogLevel::WARNING
1614
+	 *
1615
+	 * @param string $level
1616
+	 */
1617
+	public function setLogLevel(string $level)
1618
+	{
1619
+		$this->logger = new LevelFilter($this->rootLogger, $level);
1620
+	}
1621 1621
 }
Please login to merge, or discard this patch.