@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | /** |
69 | 69 | * Adds an additional object to the result set (if not already available). |
70 | 70 | * |
71 | - * @param $object |
|
71 | + * @param AbstractTDBMObject $object |
|
72 | 72 | */ |
73 | 73 | public function add($object) |
74 | 74 | { |
@@ -85,7 +85,7 @@ discard block |
||
85 | 85 | /** |
86 | 86 | * Removes an object from the result set. |
87 | 87 | * |
88 | - * @param $object |
|
88 | + * @param AbstractTDBMObject $object |
|
89 | 89 | */ |
90 | 90 | public function remove($object) |
91 | 91 | { |
@@ -205,6 +205,7 @@ discard block |
||
205 | 205 | |
206 | 206 | /** |
207 | 207 | * @param int $offset |
208 | + * @param integer $limit |
|
208 | 209 | * |
209 | 210 | * @return \Porpaginas\Page |
210 | 211 | */ |
@@ -227,7 +228,7 @@ discard block |
||
227 | 228 | /** |
228 | 229 | * Return an iterator over all results of the paginatable. |
229 | 230 | * |
230 | - * @return Iterator |
|
231 | + * @return \Iterator |
|
231 | 232 | */ |
232 | 233 | public function getIterator() |
233 | 234 | { |
@@ -14,274 +14,274 @@ |
||
14 | 14 | */ |
15 | 15 | class AlterableResultIterator implements Result, \ArrayAccess, \JsonSerializable |
16 | 16 | { |
17 | - /** |
|
18 | - * @var \Iterator|null |
|
19 | - */ |
|
20 | - private $resultIterator; |
|
17 | + /** |
|
18 | + * @var \Iterator|null |
|
19 | + */ |
|
20 | + private $resultIterator; |
|
21 | 21 | |
22 | - /** |
|
23 | - * Key: the object to alter in the result set. |
|
24 | - * Value: "add" => the object will be added to the resultset (if it is not found in it) |
|
25 | - * "delete" => the object will be removed from the resultset (if found). |
|
26 | - * |
|
27 | - * @var \SplObjectStorage |
|
28 | - */ |
|
29 | - private $alterations; |
|
22 | + /** |
|
23 | + * Key: the object to alter in the result set. |
|
24 | + * Value: "add" => the object will be added to the resultset (if it is not found in it) |
|
25 | + * "delete" => the object will be removed from the resultset (if found). |
|
26 | + * |
|
27 | + * @var \SplObjectStorage |
|
28 | + */ |
|
29 | + private $alterations; |
|
30 | 30 | |
31 | - /** |
|
32 | - * The result array from the result set. |
|
33 | - * |
|
34 | - * @var array|null |
|
35 | - */ |
|
36 | - private $resultArray; |
|
31 | + /** |
|
32 | + * The result array from the result set. |
|
33 | + * |
|
34 | + * @var array|null |
|
35 | + */ |
|
36 | + private $resultArray; |
|
37 | 37 | |
38 | - /** |
|
39 | - * @param \Iterator|null $resultIterator |
|
40 | - */ |
|
41 | - public function __construct(\Iterator $resultIterator = null) |
|
42 | - { |
|
43 | - $this->resultIterator = $resultIterator; |
|
44 | - $this->alterations = new \SplObjectStorage(); |
|
45 | - } |
|
38 | + /** |
|
39 | + * @param \Iterator|null $resultIterator |
|
40 | + */ |
|
41 | + public function __construct(\Iterator $resultIterator = null) |
|
42 | + { |
|
43 | + $this->resultIterator = $resultIterator; |
|
44 | + $this->alterations = new \SplObjectStorage(); |
|
45 | + } |
|
46 | 46 | |
47 | - /** |
|
48 | - * Sets a new iterator as the base iterator to be altered. |
|
49 | - * |
|
50 | - * @param \Iterator $resultIterator |
|
51 | - */ |
|
52 | - public function setResultIterator(\Iterator $resultIterator) |
|
53 | - { |
|
54 | - $this->resultIterator = $resultIterator; |
|
55 | - $this->resultArray = null; |
|
56 | - } |
|
47 | + /** |
|
48 | + * Sets a new iterator as the base iterator to be altered. |
|
49 | + * |
|
50 | + * @param \Iterator $resultIterator |
|
51 | + */ |
|
52 | + public function setResultIterator(\Iterator $resultIterator) |
|
53 | + { |
|
54 | + $this->resultIterator = $resultIterator; |
|
55 | + $this->resultArray = null; |
|
56 | + } |
|
57 | 57 | |
58 | - /** |
|
59 | - * Returns the non altered result iterator (or null if none exist). |
|
60 | - * |
|
61 | - * @return \Iterator|null |
|
62 | - */ |
|
63 | - public function getUnderlyingResultIterator() |
|
64 | - { |
|
65 | - return $this->resultIterator; |
|
66 | - } |
|
58 | + /** |
|
59 | + * Returns the non altered result iterator (or null if none exist). |
|
60 | + * |
|
61 | + * @return \Iterator|null |
|
62 | + */ |
|
63 | + public function getUnderlyingResultIterator() |
|
64 | + { |
|
65 | + return $this->resultIterator; |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * Adds an additional object to the result set (if not already available). |
|
70 | - * |
|
71 | - * @param $object |
|
72 | - */ |
|
73 | - public function add($object) |
|
74 | - { |
|
75 | - $this->alterations->attach($object, 'add'); |
|
68 | + /** |
|
69 | + * Adds an additional object to the result set (if not already available). |
|
70 | + * |
|
71 | + * @param $object |
|
72 | + */ |
|
73 | + public function add($object) |
|
74 | + { |
|
75 | + $this->alterations->attach($object, 'add'); |
|
76 | 76 | |
77 | - if ($this->resultArray !== null) { |
|
78 | - $foundKey = array_search($object, $this->resultArray, true); |
|
79 | - if ($foundKey === false) { |
|
80 | - $this->resultArray[] = $object; |
|
81 | - } |
|
82 | - } |
|
83 | - } |
|
77 | + if ($this->resultArray !== null) { |
|
78 | + $foundKey = array_search($object, $this->resultArray, true); |
|
79 | + if ($foundKey === false) { |
|
80 | + $this->resultArray[] = $object; |
|
81 | + } |
|
82 | + } |
|
83 | + } |
|
84 | 84 | |
85 | - /** |
|
86 | - * Removes an object from the result set. |
|
87 | - * |
|
88 | - * @param $object |
|
89 | - */ |
|
90 | - public function remove($object) |
|
91 | - { |
|
92 | - $this->alterations->attach($object, 'delete'); |
|
85 | + /** |
|
86 | + * Removes an object from the result set. |
|
87 | + * |
|
88 | + * @param $object |
|
89 | + */ |
|
90 | + public function remove($object) |
|
91 | + { |
|
92 | + $this->alterations->attach($object, 'delete'); |
|
93 | 93 | |
94 | - if ($this->resultArray !== null) { |
|
95 | - $foundKey = array_search($object, $this->resultArray, true); |
|
96 | - if ($foundKey !== false) { |
|
97 | - unset($this->resultArray[$foundKey]); |
|
98 | - } |
|
99 | - } |
|
100 | - } |
|
94 | + if ($this->resultArray !== null) { |
|
95 | + $foundKey = array_search($object, $this->resultArray, true); |
|
96 | + if ($foundKey !== false) { |
|
97 | + unset($this->resultArray[$foundKey]); |
|
98 | + } |
|
99 | + } |
|
100 | + } |
|
101 | 101 | |
102 | - /** |
|
103 | - * Casts the result set to a PHP array. |
|
104 | - * |
|
105 | - * @return array |
|
106 | - */ |
|
107 | - public function toArray() |
|
108 | - { |
|
109 | - if ($this->resultArray === null) { |
|
110 | - if ($this->resultIterator !== null) { |
|
111 | - $this->resultArray = iterator_to_array($this->resultIterator); |
|
112 | - } else { |
|
113 | - $this->resultArray = []; |
|
114 | - } |
|
102 | + /** |
|
103 | + * Casts the result set to a PHP array. |
|
104 | + * |
|
105 | + * @return array |
|
106 | + */ |
|
107 | + public function toArray() |
|
108 | + { |
|
109 | + if ($this->resultArray === null) { |
|
110 | + if ($this->resultIterator !== null) { |
|
111 | + $this->resultArray = iterator_to_array($this->resultIterator); |
|
112 | + } else { |
|
113 | + $this->resultArray = []; |
|
114 | + } |
|
115 | 115 | |
116 | - foreach ($this->alterations as $obj) { |
|
117 | - $action = $this->alterations->getInfo(); // return, if exists, associated with cur. obj. data; else NULL |
|
116 | + foreach ($this->alterations as $obj) { |
|
117 | + $action = $this->alterations->getInfo(); // return, if exists, associated with cur. obj. data; else NULL |
|
118 | 118 | |
119 | - $foundKey = array_search($obj, $this->resultArray, true); |
|
119 | + $foundKey = array_search($obj, $this->resultArray, true); |
|
120 | 120 | |
121 | - if ($action === 'add' && $foundKey === false) { |
|
122 | - $this->resultArray[] = $obj; |
|
123 | - } elseif ($action === 'delete' && $foundKey !== false) { |
|
124 | - unset($this->resultArray[$foundKey]); |
|
125 | - } |
|
126 | - } |
|
127 | - } |
|
121 | + if ($action === 'add' && $foundKey === false) { |
|
122 | + $this->resultArray[] = $obj; |
|
123 | + } elseif ($action === 'delete' && $foundKey !== false) { |
|
124 | + unset($this->resultArray[$foundKey]); |
|
125 | + } |
|
126 | + } |
|
127 | + } |
|
128 | 128 | |
129 | - return array_values($this->resultArray); |
|
130 | - } |
|
129 | + return array_values($this->resultArray); |
|
130 | + } |
|
131 | 131 | |
132 | - /** |
|
133 | - * Whether a offset exists. |
|
134 | - * |
|
135 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
136 | - * |
|
137 | - * @param mixed $offset <p> |
|
138 | - * An offset to check for. |
|
139 | - * </p> |
|
140 | - * |
|
141 | - * @return bool true on success or false on failure. |
|
142 | - * </p> |
|
143 | - * <p> |
|
144 | - * The return value will be casted to boolean if non-boolean was returned |
|
145 | - * |
|
146 | - * @since 5.0.0 |
|
147 | - */ |
|
148 | - public function offsetExists($offset) |
|
149 | - { |
|
150 | - return isset($this->toArray()[$offset]); |
|
151 | - } |
|
132 | + /** |
|
133 | + * Whether a offset exists. |
|
134 | + * |
|
135 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
136 | + * |
|
137 | + * @param mixed $offset <p> |
|
138 | + * An offset to check for. |
|
139 | + * </p> |
|
140 | + * |
|
141 | + * @return bool true on success or false on failure. |
|
142 | + * </p> |
|
143 | + * <p> |
|
144 | + * The return value will be casted to boolean if non-boolean was returned |
|
145 | + * |
|
146 | + * @since 5.0.0 |
|
147 | + */ |
|
148 | + public function offsetExists($offset) |
|
149 | + { |
|
150 | + return isset($this->toArray()[$offset]); |
|
151 | + } |
|
152 | 152 | |
153 | - /** |
|
154 | - * Offset to retrieve. |
|
155 | - * |
|
156 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
157 | - * |
|
158 | - * @param mixed $offset <p> |
|
159 | - * The offset to retrieve. |
|
160 | - * </p> |
|
161 | - * |
|
162 | - * @return mixed Can return all value types |
|
163 | - * |
|
164 | - * @since 5.0.0 |
|
165 | - */ |
|
166 | - public function offsetGet($offset) |
|
167 | - { |
|
168 | - return $this->toArray()[$offset]; |
|
169 | - } |
|
153 | + /** |
|
154 | + * Offset to retrieve. |
|
155 | + * |
|
156 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
157 | + * |
|
158 | + * @param mixed $offset <p> |
|
159 | + * The offset to retrieve. |
|
160 | + * </p> |
|
161 | + * |
|
162 | + * @return mixed Can return all value types |
|
163 | + * |
|
164 | + * @since 5.0.0 |
|
165 | + */ |
|
166 | + public function offsetGet($offset) |
|
167 | + { |
|
168 | + return $this->toArray()[$offset]; |
|
169 | + } |
|
170 | 170 | |
171 | - /** |
|
172 | - * Offset to set. |
|
173 | - * |
|
174 | - * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
175 | - * |
|
176 | - * @param mixed $offset <p> |
|
177 | - * The offset to assign the value to. |
|
178 | - * </p> |
|
179 | - * @param mixed $value <p> |
|
180 | - * The value to set. |
|
181 | - * </p> |
|
182 | - * |
|
183 | - * @since 5.0.0 |
|
184 | - */ |
|
185 | - public function offsetSet($offset, $value) |
|
186 | - { |
|
187 | - throw new TDBMInvalidOperationException('You can set values in a TDBM result set, even in an alterable one. Use the add method instead.'); |
|
188 | - } |
|
171 | + /** |
|
172 | + * Offset to set. |
|
173 | + * |
|
174 | + * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
175 | + * |
|
176 | + * @param mixed $offset <p> |
|
177 | + * The offset to assign the value to. |
|
178 | + * </p> |
|
179 | + * @param mixed $value <p> |
|
180 | + * The value to set. |
|
181 | + * </p> |
|
182 | + * |
|
183 | + * @since 5.0.0 |
|
184 | + */ |
|
185 | + public function offsetSet($offset, $value) |
|
186 | + { |
|
187 | + throw new TDBMInvalidOperationException('You can set values in a TDBM result set, even in an alterable one. Use the add method instead.'); |
|
188 | + } |
|
189 | 189 | |
190 | - /** |
|
191 | - * Offset to unset. |
|
192 | - * |
|
193 | - * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
194 | - * |
|
195 | - * @param mixed $offset <p> |
|
196 | - * The offset to unset. |
|
197 | - * </p> |
|
198 | - * |
|
199 | - * @since 5.0.0 |
|
200 | - */ |
|
201 | - public function offsetUnset($offset) |
|
202 | - { |
|
203 | - throw new TDBMInvalidOperationException('You can unset values in a TDBM result set, even in an alterable one. Use the delete method instead.'); |
|
204 | - } |
|
190 | + /** |
|
191 | + * Offset to unset. |
|
192 | + * |
|
193 | + * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
194 | + * |
|
195 | + * @param mixed $offset <p> |
|
196 | + * The offset to unset. |
|
197 | + * </p> |
|
198 | + * |
|
199 | + * @since 5.0.0 |
|
200 | + */ |
|
201 | + public function offsetUnset($offset) |
|
202 | + { |
|
203 | + throw new TDBMInvalidOperationException('You can unset values in a TDBM result set, even in an alterable one. Use the delete method instead.'); |
|
204 | + } |
|
205 | 205 | |
206 | - /** |
|
207 | - * @param int $offset |
|
208 | - * |
|
209 | - * @return \Porpaginas\Page |
|
210 | - */ |
|
211 | - public function take($offset, $limit) |
|
212 | - { |
|
213 | - // TODO: replace this with a class implementing the map method. |
|
214 | - return new ArrayPage(array_slice($this->toArray(), $offset, $limit), $offset, $limit, count($this->toArray())); |
|
215 | - } |
|
206 | + /** |
|
207 | + * @param int $offset |
|
208 | + * |
|
209 | + * @return \Porpaginas\Page |
|
210 | + */ |
|
211 | + public function take($offset, $limit) |
|
212 | + { |
|
213 | + // TODO: replace this with a class implementing the map method. |
|
214 | + return new ArrayPage(array_slice($this->toArray(), $offset, $limit), $offset, $limit, count($this->toArray())); |
|
215 | + } |
|
216 | 216 | |
217 | - /** |
|
218 | - * Return the number of all results in the paginatable. |
|
219 | - * |
|
220 | - * @return int |
|
221 | - */ |
|
222 | - public function count() |
|
223 | - { |
|
224 | - return count($this->toArray()); |
|
225 | - } |
|
217 | + /** |
|
218 | + * Return the number of all results in the paginatable. |
|
219 | + * |
|
220 | + * @return int |
|
221 | + */ |
|
222 | + public function count() |
|
223 | + { |
|
224 | + return count($this->toArray()); |
|
225 | + } |
|
226 | 226 | |
227 | - /** |
|
228 | - * Return an iterator over all results of the paginatable. |
|
229 | - * |
|
230 | - * @return Iterator |
|
231 | - */ |
|
232 | - public function getIterator() |
|
233 | - { |
|
234 | - if ($this->alterations->count() === 0) { |
|
235 | - if ($this->resultIterator !== null) { |
|
236 | - return $this->resultIterator; |
|
237 | - } else { |
|
238 | - return new \ArrayIterator([]); |
|
239 | - } |
|
240 | - } else { |
|
241 | - return new \ArrayIterator($this->toArray()); |
|
242 | - } |
|
243 | - } |
|
227 | + /** |
|
228 | + * Return an iterator over all results of the paginatable. |
|
229 | + * |
|
230 | + * @return Iterator |
|
231 | + */ |
|
232 | + public function getIterator() |
|
233 | + { |
|
234 | + if ($this->alterations->count() === 0) { |
|
235 | + if ($this->resultIterator !== null) { |
|
236 | + return $this->resultIterator; |
|
237 | + } else { |
|
238 | + return new \ArrayIterator([]); |
|
239 | + } |
|
240 | + } else { |
|
241 | + return new \ArrayIterator($this->toArray()); |
|
242 | + } |
|
243 | + } |
|
244 | 244 | |
245 | - /** |
|
246 | - * Specify data which should be serialized to JSON. |
|
247 | - * |
|
248 | - * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
249 | - * |
|
250 | - * @return mixed data which can be serialized by <b>json_encode</b>, |
|
251 | - * which is a value of any type other than a resource |
|
252 | - * |
|
253 | - * @since 5.4.0 |
|
254 | - */ |
|
255 | - public function jsonSerialize() |
|
256 | - { |
|
257 | - return $this->toArray(); |
|
258 | - } |
|
245 | + /** |
|
246 | + * Specify data which should be serialized to JSON. |
|
247 | + * |
|
248 | + * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
249 | + * |
|
250 | + * @return mixed data which can be serialized by <b>json_encode</b>, |
|
251 | + * which is a value of any type other than a resource |
|
252 | + * |
|
253 | + * @since 5.4.0 |
|
254 | + */ |
|
255 | + public function jsonSerialize() |
|
256 | + { |
|
257 | + return $this->toArray(); |
|
258 | + } |
|
259 | 259 | |
260 | - /** |
|
261 | - * Returns only one value (the first) of the result set. |
|
262 | - * Returns null if no value exists. |
|
263 | - * |
|
264 | - * @return mixed|null |
|
265 | - */ |
|
266 | - public function first() |
|
267 | - { |
|
268 | - $page = $this->take(0, 1); |
|
269 | - foreach ($page as $bean) { |
|
270 | - return $bean; |
|
271 | - } |
|
260 | + /** |
|
261 | + * Returns only one value (the first) of the result set. |
|
262 | + * Returns null if no value exists. |
|
263 | + * |
|
264 | + * @return mixed|null |
|
265 | + */ |
|
266 | + public function first() |
|
267 | + { |
|
268 | + $page = $this->take(0, 1); |
|
269 | + foreach ($page as $bean) { |
|
270 | + return $bean; |
|
271 | + } |
|
272 | 272 | |
273 | - return; |
|
274 | - } |
|
273 | + return; |
|
274 | + } |
|
275 | 275 | |
276 | - /** |
|
277 | - * Returns a new iterator mapping any call using the $callable function. |
|
278 | - * |
|
279 | - * @param callable $callable |
|
280 | - * |
|
281 | - * @return MapIterator |
|
282 | - */ |
|
283 | - public function map(callable $callable) |
|
284 | - { |
|
285 | - return new MapIterator($this->getIterator(), $callable); |
|
286 | - } |
|
276 | + /** |
|
277 | + * Returns a new iterator mapping any call using the $callable function. |
|
278 | + * |
|
279 | + * @param callable $callable |
|
280 | + * |
|
281 | + * @return MapIterator |
|
282 | + */ |
|
283 | + public function map(callable $callable) |
|
284 | + { |
|
285 | + return new MapIterator($this->getIterator(), $callable); |
|
286 | + } |
|
287 | 287 | } |
@@ -83,11 +83,11 @@ discard block |
||
83 | 83 | |
84 | 84 | // Remove all beans and daos from junction tables |
85 | 85 | $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
86 | - $junctionTableNames = array_map(function (Table $table) { |
|
86 | + $junctionTableNames = array_map(function(Table $table) { |
|
87 | 87 | return $table->getName(); |
88 | 88 | }, $junctionTables); |
89 | 89 | |
90 | - $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
90 | + $tableList = array_filter($tableList, function(Table $table) use ($junctionTableNames) { |
|
91 | 91 | return !in_array($table->getName(), $junctionTableNames); |
92 | 92 | }); |
93 | 93 | |
@@ -100,7 +100,7 @@ discard block |
||
100 | 100 | // Ok, let's return the list of all tables. |
101 | 101 | // These will be used by the calling script to create Mouf instances. |
102 | 102 | |
103 | - return array_map(function (Table $table) { |
|
103 | + return array_map(function(Table $table) { |
|
104 | 104 | return $table->getName(); |
105 | 105 | }, $tableList); |
106 | 106 | } |
@@ -294,7 +294,7 @@ discard block |
||
294 | 294 | $usedBeans[] = $beanClassName; |
295 | 295 | // Let's suppress duplicates in used beans (if any) |
296 | 296 | $usedBeans = array_flip(array_flip($usedBeans)); |
297 | - $useStatements = array_map(function ($usedBean) { |
|
297 | + $useStatements = array_map(function($usedBean) { |
|
298 | 298 | return "use $usedBean;\n"; |
299 | 299 | }, $usedBeans); |
300 | 300 | |
@@ -644,7 +644,7 @@ discard block |
||
644 | 644 | $pos = strpos($str, ' '); |
645 | 645 | } |
646 | 646 | $before = substr($str, 0, $pos); |
647 | - $after = substr($str, $pos + 1); |
|
647 | + $after = substr($str, $pos+1); |
|
648 | 648 | $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
649 | 649 | } |
650 | 650 |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | /** |
157 | 157 | * Returns the name of the base bean class from the table name. |
158 | 158 | * |
159 | - * @param $tableName |
|
159 | + * @param string $tableName |
|
160 | 160 | * |
161 | 161 | * @return string |
162 | 162 | */ |
@@ -168,7 +168,7 @@ discard block |
||
168 | 168 | /** |
169 | 169 | * Returns the name of the base DAO class from the table name. |
170 | 170 | * |
171 | - * @param $tableName |
|
171 | + * @param string $tableName |
|
172 | 172 | * |
173 | 173 | * @return string |
174 | 174 | */ |
@@ -186,6 +186,7 @@ discard block |
||
186 | 186 | * @param Table $table The table |
187 | 187 | * @param string $beannamespace The namespace of the bean |
188 | 188 | * @param ClassNameMapper $classNameMapper |
189 | + * @param boolean $storeInUtc |
|
189 | 190 | * |
190 | 191 | * @throws TDBMException |
191 | 192 | */ |
@@ -548,6 +549,8 @@ discard block |
||
548 | 549 | * Generates the factory bean. |
549 | 550 | * |
550 | 551 | * @param Table[] $tableList |
552 | + * @param string $daoFactoryClassName |
|
553 | + * @param string $daoNamespace |
|
551 | 554 | */ |
552 | 555 | private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
553 | 556 | { |
@@ -656,7 +659,7 @@ discard block |
||
656 | 659 | * Tries to put string to the singular form (if it is plural). |
657 | 660 | * We assume the table names are in english. |
658 | 661 | * |
659 | - * @param $str string |
|
662 | + * @param string $str string |
|
660 | 663 | * |
661 | 664 | * @return string |
662 | 665 | */ |
@@ -3,7 +3,6 @@ |
||
3 | 3 | namespace Mouf\Database\TDBM\Utils; |
4 | 4 | |
5 | 5 | use Doctrine\Common\Inflector\Inflector; |
6 | -use Doctrine\DBAL\Schema\Column; |
|
7 | 6 | use Doctrine\DBAL\Schema\Schema; |
8 | 7 | use Doctrine\DBAL\Schema\Table; |
9 | 8 | use Doctrine\DBAL\Types\Type; |
@@ -17,202 +17,202 @@ discard block |
||
17 | 17 | */ |
18 | 18 | class TDBMDaoGenerator |
19 | 19 | { |
20 | - /** |
|
21 | - * @var SchemaAnalyzer |
|
22 | - */ |
|
23 | - private $schemaAnalyzer; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var Schema |
|
27 | - */ |
|
28 | - private $schema; |
|
29 | - |
|
30 | - /** |
|
31 | - * The root directory of the project. |
|
32 | - * |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - private $rootPath; |
|
36 | - |
|
37 | - /** |
|
38 | - * Name of composer file. |
|
39 | - * |
|
40 | - * @var string |
|
41 | - */ |
|
42 | - private $composerFile; |
|
43 | - |
|
44 | - /** |
|
45 | - * @var TDBMSchemaAnalyzer |
|
46 | - */ |
|
47 | - private $tdbmSchemaAnalyzer; |
|
48 | - |
|
49 | - /** |
|
50 | - * Constructor. |
|
51 | - * |
|
52 | - * @param SchemaAnalyzer $schemaAnalyzer |
|
53 | - * @param Schema $schema |
|
54 | - * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer |
|
55 | - */ |
|
56 | - public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
57 | - { |
|
58 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
59 | - $this->schema = $schema; |
|
60 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
61 | - $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
62 | - $this->composerFile = 'composer.json'; |
|
63 | - } |
|
64 | - |
|
65 | - /** |
|
66 | - * Generates all the daos and beans. |
|
67 | - * |
|
68 | - * @param string $daoFactoryClassName The classe name of the DAO factory |
|
69 | - * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
70 | - * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
71 | - * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone |
|
72 | - * |
|
73 | - * @return \string[] the list of tables |
|
74 | - * |
|
75 | - * @throws TDBMException |
|
76 | - */ |
|
77 | - public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
78 | - { |
|
79 | - $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile); |
|
80 | - // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
81 | - |
|
82 | - $tableList = $this->schema->getTables(); |
|
83 | - |
|
84 | - // Remove all beans and daos from junction tables |
|
85 | - $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
|
86 | - $junctionTableNames = array_map(function (Table $table) { |
|
87 | - return $table->getName(); |
|
88 | - }, $junctionTables); |
|
89 | - |
|
90 | - $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
91 | - return !in_array($table->getName(), $junctionTableNames); |
|
92 | - }); |
|
93 | - |
|
94 | - foreach ($tableList as $table) { |
|
95 | - $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
96 | - } |
|
97 | - |
|
98 | - $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
99 | - |
|
100 | - // Ok, let's return the list of all tables. |
|
101 | - // These will be used by the calling script to create Mouf instances. |
|
102 | - |
|
103 | - return array_map(function (Table $table) { |
|
104 | - return $table->getName(); |
|
105 | - }, $tableList); |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * Generates in one method call the daos and the beans for one table. |
|
110 | - * |
|
111 | - * @param Table $table |
|
112 | - * @param string $daonamespace |
|
113 | - * @param string $beannamespace |
|
114 | - * @param ClassNameMapper $classNameMapper |
|
115 | - * @param bool $storeInUtc |
|
116 | - * |
|
117 | - * @throws TDBMException |
|
118 | - */ |
|
119 | - public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
120 | - { |
|
121 | - $tableName = $table->getName(); |
|
122 | - $daoName = $this->getDaoNameFromTableName($tableName); |
|
123 | - $beanName = $this->getBeanNameFromTableName($tableName); |
|
124 | - $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
125 | - $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
126 | - |
|
127 | - $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
128 | - $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
129 | - $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
130 | - } |
|
131 | - |
|
132 | - /** |
|
133 | - * Returns the name of the bean class from the table name. |
|
134 | - * |
|
135 | - * @param $tableName |
|
136 | - * |
|
137 | - * @return string |
|
138 | - */ |
|
139 | - public static function getBeanNameFromTableName($tableName) |
|
140 | - { |
|
141 | - return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
142 | - } |
|
143 | - |
|
144 | - /** |
|
145 | - * Returns the name of the DAO class from the table name. |
|
146 | - * |
|
147 | - * @param $tableName |
|
148 | - * |
|
149 | - * @return string |
|
150 | - */ |
|
151 | - public static function getDaoNameFromTableName($tableName) |
|
152 | - { |
|
153 | - return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * Returns the name of the base bean class from the table name. |
|
158 | - * |
|
159 | - * @param $tableName |
|
160 | - * |
|
161 | - * @return string |
|
162 | - */ |
|
163 | - public static function getBaseBeanNameFromTableName($tableName) |
|
164 | - { |
|
165 | - return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
166 | - } |
|
167 | - |
|
168 | - /** |
|
169 | - * Returns the name of the base DAO class from the table name. |
|
170 | - * |
|
171 | - * @param $tableName |
|
172 | - * |
|
173 | - * @return string |
|
174 | - */ |
|
175 | - public static function getBaseDaoNameFromTableName($tableName) |
|
176 | - { |
|
177 | - return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
178 | - } |
|
179 | - |
|
180 | - /** |
|
181 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
182 | - * |
|
183 | - * @param BeanDescriptor $beanDescriptor |
|
184 | - * @param string $className The name of the class |
|
185 | - * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
186 | - * @param Table $table The table |
|
187 | - * @param string $beannamespace The namespace of the bean |
|
188 | - * @param ClassNameMapper $classNameMapper |
|
189 | - * |
|
190 | - * @throws TDBMException |
|
191 | - */ |
|
192 | - public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
193 | - { |
|
194 | - $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
195 | - |
|
196 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName); |
|
197 | - if (empty($possibleBaseFileNames)) { |
|
198 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
199 | - } |
|
200 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
201 | - |
|
202 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
203 | - file_put_contents($possibleBaseFileName, $str); |
|
204 | - @chmod($possibleBaseFileName, 0664); |
|
205 | - |
|
206 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
207 | - if (empty($possibleFileNames)) { |
|
208 | - // @codeCoverageIgnoreStart |
|
209 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
210 | - // @codeCoverageIgnoreEnd |
|
211 | - } |
|
212 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
213 | - if (!file_exists($possibleFileName)) { |
|
214 | - $tableName = $table->getName(); |
|
215 | - $str = "<?php |
|
20 | + /** |
|
21 | + * @var SchemaAnalyzer |
|
22 | + */ |
|
23 | + private $schemaAnalyzer; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var Schema |
|
27 | + */ |
|
28 | + private $schema; |
|
29 | + |
|
30 | + /** |
|
31 | + * The root directory of the project. |
|
32 | + * |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + private $rootPath; |
|
36 | + |
|
37 | + /** |
|
38 | + * Name of composer file. |
|
39 | + * |
|
40 | + * @var string |
|
41 | + */ |
|
42 | + private $composerFile; |
|
43 | + |
|
44 | + /** |
|
45 | + * @var TDBMSchemaAnalyzer |
|
46 | + */ |
|
47 | + private $tdbmSchemaAnalyzer; |
|
48 | + |
|
49 | + /** |
|
50 | + * Constructor. |
|
51 | + * |
|
52 | + * @param SchemaAnalyzer $schemaAnalyzer |
|
53 | + * @param Schema $schema |
|
54 | + * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer |
|
55 | + */ |
|
56 | + public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
57 | + { |
|
58 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
59 | + $this->schema = $schema; |
|
60 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
61 | + $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
62 | + $this->composerFile = 'composer.json'; |
|
63 | + } |
|
64 | + |
|
65 | + /** |
|
66 | + * Generates all the daos and beans. |
|
67 | + * |
|
68 | + * @param string $daoFactoryClassName The classe name of the DAO factory |
|
69 | + * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
70 | + * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
71 | + * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone |
|
72 | + * |
|
73 | + * @return \string[] the list of tables |
|
74 | + * |
|
75 | + * @throws TDBMException |
|
76 | + */ |
|
77 | + public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
78 | + { |
|
79 | + $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile); |
|
80 | + // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
81 | + |
|
82 | + $tableList = $this->schema->getTables(); |
|
83 | + |
|
84 | + // Remove all beans and daos from junction tables |
|
85 | + $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
|
86 | + $junctionTableNames = array_map(function (Table $table) { |
|
87 | + return $table->getName(); |
|
88 | + }, $junctionTables); |
|
89 | + |
|
90 | + $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
91 | + return !in_array($table->getName(), $junctionTableNames); |
|
92 | + }); |
|
93 | + |
|
94 | + foreach ($tableList as $table) { |
|
95 | + $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
96 | + } |
|
97 | + |
|
98 | + $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
99 | + |
|
100 | + // Ok, let's return the list of all tables. |
|
101 | + // These will be used by the calling script to create Mouf instances. |
|
102 | + |
|
103 | + return array_map(function (Table $table) { |
|
104 | + return $table->getName(); |
|
105 | + }, $tableList); |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * Generates in one method call the daos and the beans for one table. |
|
110 | + * |
|
111 | + * @param Table $table |
|
112 | + * @param string $daonamespace |
|
113 | + * @param string $beannamespace |
|
114 | + * @param ClassNameMapper $classNameMapper |
|
115 | + * @param bool $storeInUtc |
|
116 | + * |
|
117 | + * @throws TDBMException |
|
118 | + */ |
|
119 | + public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
120 | + { |
|
121 | + $tableName = $table->getName(); |
|
122 | + $daoName = $this->getDaoNameFromTableName($tableName); |
|
123 | + $beanName = $this->getBeanNameFromTableName($tableName); |
|
124 | + $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
125 | + $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
126 | + |
|
127 | + $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
128 | + $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
129 | + $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
130 | + } |
|
131 | + |
|
132 | + /** |
|
133 | + * Returns the name of the bean class from the table name. |
|
134 | + * |
|
135 | + * @param $tableName |
|
136 | + * |
|
137 | + * @return string |
|
138 | + */ |
|
139 | + public static function getBeanNameFromTableName($tableName) |
|
140 | + { |
|
141 | + return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * Returns the name of the DAO class from the table name. |
|
146 | + * |
|
147 | + * @param $tableName |
|
148 | + * |
|
149 | + * @return string |
|
150 | + */ |
|
151 | + public static function getDaoNameFromTableName($tableName) |
|
152 | + { |
|
153 | + return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * Returns the name of the base bean class from the table name. |
|
158 | + * |
|
159 | + * @param $tableName |
|
160 | + * |
|
161 | + * @return string |
|
162 | + */ |
|
163 | + public static function getBaseBeanNameFromTableName($tableName) |
|
164 | + { |
|
165 | + return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
166 | + } |
|
167 | + |
|
168 | + /** |
|
169 | + * Returns the name of the base DAO class from the table name. |
|
170 | + * |
|
171 | + * @param $tableName |
|
172 | + * |
|
173 | + * @return string |
|
174 | + */ |
|
175 | + public static function getBaseDaoNameFromTableName($tableName) |
|
176 | + { |
|
177 | + return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
178 | + } |
|
179 | + |
|
180 | + /** |
|
181 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
182 | + * |
|
183 | + * @param BeanDescriptor $beanDescriptor |
|
184 | + * @param string $className The name of the class |
|
185 | + * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
186 | + * @param Table $table The table |
|
187 | + * @param string $beannamespace The namespace of the bean |
|
188 | + * @param ClassNameMapper $classNameMapper |
|
189 | + * |
|
190 | + * @throws TDBMException |
|
191 | + */ |
|
192 | + public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
193 | + { |
|
194 | + $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
195 | + |
|
196 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName); |
|
197 | + if (empty($possibleBaseFileNames)) { |
|
198 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
199 | + } |
|
200 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
201 | + |
|
202 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
203 | + file_put_contents($possibleBaseFileName, $str); |
|
204 | + @chmod($possibleBaseFileName, 0664); |
|
205 | + |
|
206 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
207 | + if (empty($possibleFileNames)) { |
|
208 | + // @codeCoverageIgnoreStart |
|
209 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
210 | + // @codeCoverageIgnoreEnd |
|
211 | + } |
|
212 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
213 | + if (!file_exists($possibleFileName)) { |
|
214 | + $tableName = $table->getName(); |
|
215 | + $str = "<?php |
|
216 | 216 | /* |
217 | 217 | * This file has been automatically generated by TDBM. |
218 | 218 | * You can edit this file as it will not be overwritten. |
@@ -229,76 +229,76 @@ discard block |
||
229 | 229 | { |
230 | 230 | } |
231 | 231 | "; |
232 | - $this->ensureDirectoryExist($possibleFileName); |
|
233 | - file_put_contents($possibleFileName, $str); |
|
234 | - @chmod($possibleFileName, 0664); |
|
235 | - } |
|
236 | - } |
|
237 | - |
|
238 | - /** |
|
239 | - * Tries to find a @defaultSort annotation in one of the columns. |
|
240 | - * |
|
241 | - * @param Table $table |
|
242 | - * |
|
243 | - * @return array First item: column name, Second item: column order (asc/desc) |
|
244 | - */ |
|
245 | - private function getDefaultSortColumnFromAnnotation(Table $table) |
|
246 | - { |
|
247 | - $defaultSort = null; |
|
248 | - $defaultSortDirection = null; |
|
249 | - foreach ($table->getColumns() as $column) { |
|
250 | - $comments = $column->getComment(); |
|
251 | - $matches = []; |
|
252 | - if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
253 | - $defaultSort = $column->getName(); |
|
254 | - if (count($matches) === 3) { |
|
255 | - $defaultSortDirection = $matches[2]; |
|
256 | - } else { |
|
257 | - $defaultSortDirection = 'ASC'; |
|
258 | - } |
|
259 | - } |
|
260 | - } |
|
261 | - |
|
262 | - return [$defaultSort, $defaultSortDirection]; |
|
263 | - } |
|
264 | - |
|
265 | - /** |
|
266 | - * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
267 | - * |
|
268 | - * @param BeanDescriptor $beanDescriptor |
|
269 | - * @param string $className The name of the class |
|
270 | - * @param string $baseClassName |
|
271 | - * @param string $beanClassName |
|
272 | - * @param Table $table |
|
273 | - * @param string $daonamespace |
|
274 | - * @param string $beannamespace |
|
275 | - * @param ClassNameMapper $classNameMapper |
|
276 | - * |
|
277 | - * @throws TDBMException |
|
278 | - */ |
|
279 | - public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
280 | - { |
|
281 | - $tableName = $table->getName(); |
|
282 | - $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
283 | - |
|
284 | - list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table); |
|
285 | - |
|
286 | - // FIXME: lowercase tables with _ in the name should work! |
|
287 | - $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
288 | - |
|
289 | - $beanClassWithoutNameSpace = $beanClassName; |
|
290 | - $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
291 | - |
|
292 | - list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace); |
|
293 | - |
|
294 | - $usedBeans[] = $beanClassName; |
|
295 | - // Let's suppress duplicates in used beans (if any) |
|
296 | - $usedBeans = array_flip(array_flip($usedBeans)); |
|
297 | - $useStatements = array_map(function ($usedBean) { |
|
298 | - return "use $usedBean;\n"; |
|
299 | - }, $usedBeans); |
|
300 | - |
|
301 | - $str = "<?php |
|
232 | + $this->ensureDirectoryExist($possibleFileName); |
|
233 | + file_put_contents($possibleFileName, $str); |
|
234 | + @chmod($possibleFileName, 0664); |
|
235 | + } |
|
236 | + } |
|
237 | + |
|
238 | + /** |
|
239 | + * Tries to find a @defaultSort annotation in one of the columns. |
|
240 | + * |
|
241 | + * @param Table $table |
|
242 | + * |
|
243 | + * @return array First item: column name, Second item: column order (asc/desc) |
|
244 | + */ |
|
245 | + private function getDefaultSortColumnFromAnnotation(Table $table) |
|
246 | + { |
|
247 | + $defaultSort = null; |
|
248 | + $defaultSortDirection = null; |
|
249 | + foreach ($table->getColumns() as $column) { |
|
250 | + $comments = $column->getComment(); |
|
251 | + $matches = []; |
|
252 | + if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
253 | + $defaultSort = $column->getName(); |
|
254 | + if (count($matches) === 3) { |
|
255 | + $defaultSortDirection = $matches[2]; |
|
256 | + } else { |
|
257 | + $defaultSortDirection = 'ASC'; |
|
258 | + } |
|
259 | + } |
|
260 | + } |
|
261 | + |
|
262 | + return [$defaultSort, $defaultSortDirection]; |
|
263 | + } |
|
264 | + |
|
265 | + /** |
|
266 | + * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
267 | + * |
|
268 | + * @param BeanDescriptor $beanDescriptor |
|
269 | + * @param string $className The name of the class |
|
270 | + * @param string $baseClassName |
|
271 | + * @param string $beanClassName |
|
272 | + * @param Table $table |
|
273 | + * @param string $daonamespace |
|
274 | + * @param string $beannamespace |
|
275 | + * @param ClassNameMapper $classNameMapper |
|
276 | + * |
|
277 | + * @throws TDBMException |
|
278 | + */ |
|
279 | + public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
280 | + { |
|
281 | + $tableName = $table->getName(); |
|
282 | + $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
283 | + |
|
284 | + list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table); |
|
285 | + |
|
286 | + // FIXME: lowercase tables with _ in the name should work! |
|
287 | + $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
288 | + |
|
289 | + $beanClassWithoutNameSpace = $beanClassName; |
|
290 | + $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
291 | + |
|
292 | + list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace); |
|
293 | + |
|
294 | + $usedBeans[] = $beanClassName; |
|
295 | + // Let's suppress duplicates in used beans (if any) |
|
296 | + $usedBeans = array_flip(array_flip($usedBeans)); |
|
297 | + $useStatements = array_map(function ($usedBean) { |
|
298 | + return "use $usedBean;\n"; |
|
299 | + }, $usedBeans); |
|
300 | + |
|
301 | + $str = "<?php |
|
302 | 302 | |
303 | 303 | /* |
304 | 304 | * This file has been automatically generated by TDBM. |
@@ -374,10 +374,10 @@ discard block |
||
374 | 374 | } |
375 | 375 | "; |
376 | 376 | |
377 | - if (count($primaryKeyColumns) === 1) { |
|
378 | - $primaryKeyColumn = $primaryKeyColumns[0]; |
|
379 | - $primaryKeyPhpType = self::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType()); |
|
380 | - $str .= " |
|
377 | + if (count($primaryKeyColumns) === 1) { |
|
378 | + $primaryKeyColumn = $primaryKeyColumns[0]; |
|
379 | + $primaryKeyPhpType = self::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType()); |
|
380 | + $str .= " |
|
381 | 381 | /** |
382 | 382 | * Get $beanClassWithoutNameSpace specified by its ID (its primary key) |
383 | 383 | * If the primary key does not exist, an exception is thrown. |
@@ -392,8 +392,8 @@ discard block |
||
392 | 392 | return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading); |
393 | 393 | } |
394 | 394 | "; |
395 | - } |
|
396 | - $str .= " |
|
395 | + } |
|
396 | + $str .= " |
|
397 | 397 | /** |
398 | 398 | * Deletes the $beanClassWithoutNameSpace passed in parameter. |
399 | 399 | * |
@@ -492,33 +492,33 @@ discard block |
||
492 | 492 | } |
493 | 493 | "; |
494 | 494 | |
495 | - $str .= $findByDaoCode; |
|
496 | - $str .= '} |
|
495 | + $str .= $findByDaoCode; |
|
496 | + $str .= '} |
|
497 | 497 | '; |
498 | 498 | |
499 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName); |
|
500 | - if (empty($possibleBaseFileNames)) { |
|
501 | - // @codeCoverageIgnoreStart |
|
502 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
503 | - // @codeCoverageIgnoreEnd |
|
504 | - } |
|
505 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
506 | - |
|
507 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
508 | - file_put_contents($possibleBaseFileName, $str); |
|
509 | - @chmod($possibleBaseFileName, 0664); |
|
510 | - |
|
511 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
512 | - if (empty($possibleFileNames)) { |
|
513 | - // @codeCoverageIgnoreStart |
|
514 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
515 | - // @codeCoverageIgnoreEnd |
|
516 | - } |
|
517 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
518 | - |
|
519 | - // Now, let's generate the "editable" class |
|
520 | - if (!file_exists($possibleFileName)) { |
|
521 | - $str = "<?php |
|
499 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName); |
|
500 | + if (empty($possibleBaseFileNames)) { |
|
501 | + // @codeCoverageIgnoreStart |
|
502 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
503 | + // @codeCoverageIgnoreEnd |
|
504 | + } |
|
505 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
506 | + |
|
507 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
508 | + file_put_contents($possibleBaseFileName, $str); |
|
509 | + @chmod($possibleBaseFileName, 0664); |
|
510 | + |
|
511 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
512 | + if (empty($possibleFileNames)) { |
|
513 | + // @codeCoverageIgnoreStart |
|
514 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
515 | + // @codeCoverageIgnoreEnd |
|
516 | + } |
|
517 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
518 | + |
|
519 | + // Now, let's generate the "editable" class |
|
520 | + if (!file_exists($possibleFileName)) { |
|
521 | + $str = "<?php |
|
522 | 522 | |
523 | 523 | /* |
524 | 524 | * This file has been automatically generated by TDBM. |
@@ -536,22 +536,22 @@ discard block |
||
536 | 536 | { |
537 | 537 | } |
538 | 538 | "; |
539 | - $this->ensureDirectoryExist($possibleFileName); |
|
540 | - file_put_contents($possibleFileName, $str); |
|
541 | - @chmod($possibleFileName, 0664); |
|
542 | - } |
|
543 | - } |
|
544 | - |
|
545 | - /** |
|
546 | - * Generates the factory bean. |
|
547 | - * |
|
548 | - * @param Table[] $tableList |
|
549 | - */ |
|
550 | - private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
551 | - { |
|
552 | - // For each table, let's write a property. |
|
553 | - |
|
554 | - $str = "<?php |
|
539 | + $this->ensureDirectoryExist($possibleFileName); |
|
540 | + file_put_contents($possibleFileName, $str); |
|
541 | + @chmod($possibleFileName, 0664); |
|
542 | + } |
|
543 | + } |
|
544 | + |
|
545 | + /** |
|
546 | + * Generates the factory bean. |
|
547 | + * |
|
548 | + * @param Table[] $tableList |
|
549 | + */ |
|
550 | + private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
551 | + { |
|
552 | + // For each table, let's write a property. |
|
553 | + |
|
554 | + $str = "<?php |
|
555 | 555 | |
556 | 556 | /* |
557 | 557 | * This file has been automatically generated by TDBM. |
@@ -561,13 +561,13 @@ discard block |
||
561 | 561 | namespace {$daoNamespace}\\Generated; |
562 | 562 | |
563 | 563 | "; |
564 | - foreach ($tableList as $table) { |
|
565 | - $tableName = $table->getName(); |
|
566 | - $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
567 | - $str .= "use {$daoNamespace}\\".$daoClassName.";\n"; |
|
568 | - } |
|
564 | + foreach ($tableList as $table) { |
|
565 | + $tableName = $table->getName(); |
|
566 | + $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
567 | + $str .= "use {$daoNamespace}\\".$daoClassName.";\n"; |
|
568 | + } |
|
569 | 569 | |
570 | - $str .= " |
|
570 | + $str .= " |
|
571 | 571 | /** |
572 | 572 | * The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM. |
573 | 573 | * |
@@ -576,12 +576,12 @@ discard block |
||
576 | 576 | { |
577 | 577 | "; |
578 | 578 | |
579 | - foreach ($tableList as $table) { |
|
580 | - $tableName = $table->getName(); |
|
581 | - $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
582 | - $daoInstanceName = self::toVariableName($daoClassName); |
|
579 | + foreach ($tableList as $table) { |
|
580 | + $tableName = $table->getName(); |
|
581 | + $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
582 | + $daoInstanceName = self::toVariableName($daoClassName); |
|
583 | 583 | |
584 | - $str .= ' /** |
|
584 | + $str .= ' /** |
|
585 | 585 | * @var '.$daoClassName.' |
586 | 586 | */ |
587 | 587 | private $'.$daoInstanceName.'; |
@@ -605,158 +605,158 @@ discard block |
||
605 | 605 | { |
606 | 606 | $this->'.$daoInstanceName.' = $'.$daoInstanceName.'; |
607 | 607 | }'; |
608 | - } |
|
608 | + } |
|
609 | 609 | |
610 | - $str .= ' |
|
610 | + $str .= ' |
|
611 | 611 | } |
612 | 612 | '; |
613 | 613 | |
614 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName); |
|
615 | - if (empty($possibleFileNames)) { |
|
616 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
617 | - } |
|
618 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
619 | - |
|
620 | - $this->ensureDirectoryExist($possibleFileName); |
|
621 | - file_put_contents($possibleFileName, $str); |
|
622 | - @chmod($possibleFileName, 0664); |
|
623 | - } |
|
624 | - |
|
625 | - /** |
|
626 | - * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
627 | - * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
628 | - * |
|
629 | - * @param $str string |
|
630 | - * |
|
631 | - * @return string |
|
632 | - */ |
|
633 | - public static function toCamelCase($str) |
|
634 | - { |
|
635 | - $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
636 | - while (true) { |
|
637 | - if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
638 | - break; |
|
639 | - } |
|
640 | - |
|
641 | - $pos = strpos($str, '_'); |
|
642 | - if ($pos === false) { |
|
643 | - $pos = strpos($str, ' '); |
|
644 | - } |
|
645 | - $before = substr($str, 0, $pos); |
|
646 | - $after = substr($str, $pos + 1); |
|
647 | - $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
648 | - } |
|
649 | - |
|
650 | - return $str; |
|
651 | - } |
|
652 | - |
|
653 | - /** |
|
654 | - * Tries to put string to the singular form (if it is plural). |
|
655 | - * We assume the table names are in english. |
|
656 | - * |
|
657 | - * @param $str string |
|
658 | - * |
|
659 | - * @return string |
|
660 | - */ |
|
661 | - public static function toSingular($str) |
|
662 | - { |
|
663 | - return Inflector::singularize($str); |
|
664 | - } |
|
665 | - |
|
666 | - /** |
|
667 | - * Put the first letter of the string in lower case. |
|
668 | - * Very useful to transform a class name into a variable name. |
|
669 | - * |
|
670 | - * @param $str string |
|
671 | - * |
|
672 | - * @return string |
|
673 | - */ |
|
674 | - public static function toVariableName($str) |
|
675 | - { |
|
676 | - return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
677 | - } |
|
678 | - |
|
679 | - /** |
|
680 | - * Ensures the file passed in parameter can be written in its directory. |
|
681 | - * |
|
682 | - * @param string $fileName |
|
683 | - * |
|
684 | - * @throws TDBMException |
|
685 | - */ |
|
686 | - private function ensureDirectoryExist($fileName) |
|
687 | - { |
|
688 | - $dirName = dirname($fileName); |
|
689 | - if (!file_exists($dirName)) { |
|
690 | - $old = umask(0); |
|
691 | - $result = mkdir($dirName, 0775, true); |
|
692 | - umask($old); |
|
693 | - if ($result === false) { |
|
694 | - throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
695 | - } |
|
696 | - } |
|
697 | - } |
|
698 | - |
|
699 | - /** |
|
700 | - * Absolute path to composer json file. |
|
701 | - * |
|
702 | - * @param string $composerFile |
|
703 | - */ |
|
704 | - public function setComposerFile($composerFile) |
|
705 | - { |
|
706 | - $this->rootPath = dirname($composerFile).'/'; |
|
707 | - $this->composerFile = basename($composerFile); |
|
708 | - } |
|
709 | - |
|
710 | - /** |
|
711 | - * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
712 | - * |
|
713 | - * @param Type $type The DBAL type |
|
714 | - * |
|
715 | - * @return string The PHP type |
|
716 | - */ |
|
717 | - public static function dbalTypeToPhpType(Type $type) |
|
718 | - { |
|
719 | - $map = [ |
|
720 | - Type::TARRAY => 'array', |
|
721 | - Type::SIMPLE_ARRAY => 'array', |
|
722 | - Type::JSON_ARRAY => 'array', |
|
723 | - Type::BIGINT => 'string', |
|
724 | - Type::BOOLEAN => 'bool', |
|
725 | - Type::DATETIME => '\DateTimeInterface', |
|
726 | - Type::DATETIMETZ => '\DateTimeInterface', |
|
727 | - Type::DATE => '\DateTimeInterface', |
|
728 | - Type::TIME => '\DateTimeInterface', |
|
729 | - Type::DECIMAL => 'float', |
|
730 | - Type::INTEGER => 'int', |
|
731 | - Type::OBJECT => 'string', |
|
732 | - Type::SMALLINT => 'int', |
|
733 | - Type::STRING => 'string', |
|
734 | - Type::TEXT => 'string', |
|
735 | - Type::BINARY => 'string', |
|
736 | - Type::BLOB => 'string', |
|
737 | - Type::FLOAT => 'float', |
|
738 | - Type::GUID => 'string', |
|
739 | - ]; |
|
740 | - |
|
741 | - return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
742 | - } |
|
743 | - |
|
744 | - /** |
|
745 | - * @param string $beanNamespace |
|
746 | - * |
|
747 | - * @return \string[] Returns a map mapping table name to beans name |
|
748 | - */ |
|
749 | - public function buildTableToBeanMap($beanNamespace) |
|
750 | - { |
|
751 | - $tableToBeanMap = []; |
|
752 | - |
|
753 | - $tables = $this->schema->getTables(); |
|
754 | - |
|
755 | - foreach ($tables as $table) { |
|
756 | - $tableName = $table->getName(); |
|
757 | - $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
758 | - } |
|
759 | - |
|
760 | - return $tableToBeanMap; |
|
761 | - } |
|
614 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName); |
|
615 | + if (empty($possibleFileNames)) { |
|
616 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
617 | + } |
|
618 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
619 | + |
|
620 | + $this->ensureDirectoryExist($possibleFileName); |
|
621 | + file_put_contents($possibleFileName, $str); |
|
622 | + @chmod($possibleFileName, 0664); |
|
623 | + } |
|
624 | + |
|
625 | + /** |
|
626 | + * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
627 | + * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
628 | + * |
|
629 | + * @param $str string |
|
630 | + * |
|
631 | + * @return string |
|
632 | + */ |
|
633 | + public static function toCamelCase($str) |
|
634 | + { |
|
635 | + $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
636 | + while (true) { |
|
637 | + if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
638 | + break; |
|
639 | + } |
|
640 | + |
|
641 | + $pos = strpos($str, '_'); |
|
642 | + if ($pos === false) { |
|
643 | + $pos = strpos($str, ' '); |
|
644 | + } |
|
645 | + $before = substr($str, 0, $pos); |
|
646 | + $after = substr($str, $pos + 1); |
|
647 | + $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
648 | + } |
|
649 | + |
|
650 | + return $str; |
|
651 | + } |
|
652 | + |
|
653 | + /** |
|
654 | + * Tries to put string to the singular form (if it is plural). |
|
655 | + * We assume the table names are in english. |
|
656 | + * |
|
657 | + * @param $str string |
|
658 | + * |
|
659 | + * @return string |
|
660 | + */ |
|
661 | + public static function toSingular($str) |
|
662 | + { |
|
663 | + return Inflector::singularize($str); |
|
664 | + } |
|
665 | + |
|
666 | + /** |
|
667 | + * Put the first letter of the string in lower case. |
|
668 | + * Very useful to transform a class name into a variable name. |
|
669 | + * |
|
670 | + * @param $str string |
|
671 | + * |
|
672 | + * @return string |
|
673 | + */ |
|
674 | + public static function toVariableName($str) |
|
675 | + { |
|
676 | + return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
677 | + } |
|
678 | + |
|
679 | + /** |
|
680 | + * Ensures the file passed in parameter can be written in its directory. |
|
681 | + * |
|
682 | + * @param string $fileName |
|
683 | + * |
|
684 | + * @throws TDBMException |
|
685 | + */ |
|
686 | + private function ensureDirectoryExist($fileName) |
|
687 | + { |
|
688 | + $dirName = dirname($fileName); |
|
689 | + if (!file_exists($dirName)) { |
|
690 | + $old = umask(0); |
|
691 | + $result = mkdir($dirName, 0775, true); |
|
692 | + umask($old); |
|
693 | + if ($result === false) { |
|
694 | + throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
695 | + } |
|
696 | + } |
|
697 | + } |
|
698 | + |
|
699 | + /** |
|
700 | + * Absolute path to composer json file. |
|
701 | + * |
|
702 | + * @param string $composerFile |
|
703 | + */ |
|
704 | + public function setComposerFile($composerFile) |
|
705 | + { |
|
706 | + $this->rootPath = dirname($composerFile).'/'; |
|
707 | + $this->composerFile = basename($composerFile); |
|
708 | + } |
|
709 | + |
|
710 | + /** |
|
711 | + * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
712 | + * |
|
713 | + * @param Type $type The DBAL type |
|
714 | + * |
|
715 | + * @return string The PHP type |
|
716 | + */ |
|
717 | + public static function dbalTypeToPhpType(Type $type) |
|
718 | + { |
|
719 | + $map = [ |
|
720 | + Type::TARRAY => 'array', |
|
721 | + Type::SIMPLE_ARRAY => 'array', |
|
722 | + Type::JSON_ARRAY => 'array', |
|
723 | + Type::BIGINT => 'string', |
|
724 | + Type::BOOLEAN => 'bool', |
|
725 | + Type::DATETIME => '\DateTimeInterface', |
|
726 | + Type::DATETIMETZ => '\DateTimeInterface', |
|
727 | + Type::DATE => '\DateTimeInterface', |
|
728 | + Type::TIME => '\DateTimeInterface', |
|
729 | + Type::DECIMAL => 'float', |
|
730 | + Type::INTEGER => 'int', |
|
731 | + Type::OBJECT => 'string', |
|
732 | + Type::SMALLINT => 'int', |
|
733 | + Type::STRING => 'string', |
|
734 | + Type::TEXT => 'string', |
|
735 | + Type::BINARY => 'string', |
|
736 | + Type::BLOB => 'string', |
|
737 | + Type::FLOAT => 'float', |
|
738 | + Type::GUID => 'string', |
|
739 | + ]; |
|
740 | + |
|
741 | + return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
742 | + } |
|
743 | + |
|
744 | + /** |
|
745 | + * @param string $beanNamespace |
|
746 | + * |
|
747 | + * @return \string[] Returns a map mapping table name to beans name |
|
748 | + */ |
|
749 | + public function buildTableToBeanMap($beanNamespace) |
|
750 | + { |
|
751 | + $tableToBeanMap = []; |
|
752 | + |
|
753 | + $tables = $this->schema->getTables(); |
|
754 | + |
|
755 | + foreach ($tables as $table) { |
|
756 | + $tableName = $table->getName(); |
|
757 | + $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
758 | + } |
|
759 | + |
|
760 | + return $tableToBeanMap; |
|
761 | + } |
|
762 | 762 | } |
@@ -11,91 +11,91 @@ |
||
11 | 11 | */ |
12 | 12 | class MapIterator implements Iterator, \JsonSerializable |
13 | 13 | { |
14 | - /** |
|
15 | - * @var Iterator |
|
16 | - */ |
|
17 | - protected $iterator; |
|
18 | - |
|
19 | - /** |
|
20 | - * @var callable Modifies the current item in iterator |
|
21 | - */ |
|
22 | - protected $callable; |
|
23 | - |
|
24 | - /** |
|
25 | - * @param $iterator Iterator|array |
|
26 | - * @param $callable callable This can have two parameters |
|
27 | - * |
|
28 | - * @throws TDBMException |
|
29 | - */ |
|
30 | - public function __construct($iterator, callable $callable) |
|
31 | - { |
|
32 | - if (is_array($iterator)) { |
|
33 | - $this->iterator = new \ArrayIterator($iterator); |
|
34 | - } elseif (!($iterator instanceof Iterator)) { |
|
35 | - throw new TDBMException('$iterator parameter must be an instance of Iterator'); |
|
36 | - } else { |
|
37 | - $this->iterator = $iterator; |
|
38 | - } |
|
39 | - |
|
40 | - if ($callable instanceof \Closure) { |
|
41 | - // make sure there's one argument |
|
42 | - $reflection = new \ReflectionObject($callable); |
|
43 | - if ($reflection->hasMethod('__invoke')) { |
|
44 | - $method = $reflection->getMethod('__invoke'); |
|
45 | - if ($method->getNumberOfParameters() !== 1) { |
|
46 | - throw new TDBMException('$callable must accept one and only one parameter.'); |
|
47 | - } |
|
48 | - } |
|
49 | - } |
|
50 | - |
|
51 | - $this->callable = $callable; |
|
52 | - } |
|
53 | - |
|
54 | - /** |
|
55 | - * Alters the current item with $this->callable and returns a new item. |
|
56 | - * Be careful with your types as we can't do static type checking here! |
|
57 | - * |
|
58 | - * @return mixed |
|
59 | - */ |
|
60 | - public function current() |
|
61 | - { |
|
62 | - $callable = $this->callable; |
|
63 | - |
|
64 | - return $callable($this->iterator->current()); |
|
65 | - } |
|
66 | - |
|
67 | - public function next() |
|
68 | - { |
|
69 | - $this->iterator->next(); |
|
70 | - } |
|
71 | - |
|
72 | - public function key() |
|
73 | - { |
|
74 | - return $this->iterator->key(); |
|
75 | - } |
|
76 | - |
|
77 | - public function valid() |
|
78 | - { |
|
79 | - return $this->iterator->valid(); |
|
80 | - } |
|
81 | - |
|
82 | - public function rewind() |
|
83 | - { |
|
84 | - $this->iterator->rewind(); |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * Casts the iterator to a PHP array. |
|
89 | - * |
|
90 | - * @return array |
|
91 | - */ |
|
92 | - public function toArray() |
|
93 | - { |
|
94 | - return iterator_to_array($this); |
|
95 | - } |
|
96 | - |
|
97 | - public function jsonSerialize() |
|
98 | - { |
|
99 | - return $this->toArray(); |
|
100 | - } |
|
14 | + /** |
|
15 | + * @var Iterator |
|
16 | + */ |
|
17 | + protected $iterator; |
|
18 | + |
|
19 | + /** |
|
20 | + * @var callable Modifies the current item in iterator |
|
21 | + */ |
|
22 | + protected $callable; |
|
23 | + |
|
24 | + /** |
|
25 | + * @param $iterator Iterator|array |
|
26 | + * @param $callable callable This can have two parameters |
|
27 | + * |
|
28 | + * @throws TDBMException |
|
29 | + */ |
|
30 | + public function __construct($iterator, callable $callable) |
|
31 | + { |
|
32 | + if (is_array($iterator)) { |
|
33 | + $this->iterator = new \ArrayIterator($iterator); |
|
34 | + } elseif (!($iterator instanceof Iterator)) { |
|
35 | + throw new TDBMException('$iterator parameter must be an instance of Iterator'); |
|
36 | + } else { |
|
37 | + $this->iterator = $iterator; |
|
38 | + } |
|
39 | + |
|
40 | + if ($callable instanceof \Closure) { |
|
41 | + // make sure there's one argument |
|
42 | + $reflection = new \ReflectionObject($callable); |
|
43 | + if ($reflection->hasMethod('__invoke')) { |
|
44 | + $method = $reflection->getMethod('__invoke'); |
|
45 | + if ($method->getNumberOfParameters() !== 1) { |
|
46 | + throw new TDBMException('$callable must accept one and only one parameter.'); |
|
47 | + } |
|
48 | + } |
|
49 | + } |
|
50 | + |
|
51 | + $this->callable = $callable; |
|
52 | + } |
|
53 | + |
|
54 | + /** |
|
55 | + * Alters the current item with $this->callable and returns a new item. |
|
56 | + * Be careful with your types as we can't do static type checking here! |
|
57 | + * |
|
58 | + * @return mixed |
|
59 | + */ |
|
60 | + public function current() |
|
61 | + { |
|
62 | + $callable = $this->callable; |
|
63 | + |
|
64 | + return $callable($this->iterator->current()); |
|
65 | + } |
|
66 | + |
|
67 | + public function next() |
|
68 | + { |
|
69 | + $this->iterator->next(); |
|
70 | + } |
|
71 | + |
|
72 | + public function key() |
|
73 | + { |
|
74 | + return $this->iterator->key(); |
|
75 | + } |
|
76 | + |
|
77 | + public function valid() |
|
78 | + { |
|
79 | + return $this->iterator->valid(); |
|
80 | + } |
|
81 | + |
|
82 | + public function rewind() |
|
83 | + { |
|
84 | + $this->iterator->rewind(); |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * Casts the iterator to a PHP array. |
|
89 | + * |
|
90 | + * @return array |
|
91 | + */ |
|
92 | + public function toArray() |
|
93 | + { |
|
94 | + return iterator_to_array($this); |
|
95 | + } |
|
96 | + |
|
97 | + public function jsonSerialize() |
|
98 | + { |
|
99 | + return $this->toArray(); |
|
100 | + } |
|
101 | 101 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types=1); |
|
3 | +declare(strict_types = 1); |
|
4 | 4 | |
5 | 5 | namespace Mouf\Database\TDBM; |
6 | 6 |
@@ -14,138 +14,138 @@ |
||
14 | 14 | */ |
15 | 15 | class TDBMSchemaAnalyzer |
16 | 16 | { |
17 | - private $connection; |
|
18 | - |
|
19 | - /** |
|
20 | - * @var Schema |
|
21 | - */ |
|
22 | - private $schema; |
|
23 | - |
|
24 | - /** |
|
25 | - * @var string |
|
26 | - */ |
|
27 | - private $cachePrefix; |
|
28 | - |
|
29 | - /** |
|
30 | - * @var Cache |
|
31 | - */ |
|
32 | - private $cache; |
|
33 | - |
|
34 | - /** |
|
35 | - * @var SchemaAnalyzer |
|
36 | - */ |
|
37 | - private $schemaAnalyzer; |
|
38 | - |
|
39 | - /** |
|
40 | - * @param Connection $connection The DBAL DB connection to use |
|
41 | - * @param Cache $cache A cache service to be used |
|
42 | - * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths... |
|
43 | - * Will be automatically created if not passed |
|
44 | - */ |
|
45 | - public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer) |
|
46 | - { |
|
47 | - $this->connection = $connection; |
|
48 | - $this->cache = $cache; |
|
49 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
50 | - } |
|
51 | - |
|
52 | - /** |
|
53 | - * Returns a unique ID for the current connection. Useful for namespacing cache entries in the current connection. |
|
54 | - * |
|
55 | - * @return string |
|
56 | - */ |
|
57 | - public function getCachePrefix() |
|
58 | - { |
|
59 | - if ($this->cachePrefix === null) { |
|
60 | - $this->cachePrefix = hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName()); |
|
61 | - } |
|
62 | - |
|
63 | - return $this->cachePrefix; |
|
64 | - } |
|
65 | - |
|
66 | - /** |
|
67 | - * Returns the (cached) schema. |
|
68 | - * |
|
69 | - * @return Schema |
|
70 | - */ |
|
71 | - public function getSchema() |
|
72 | - { |
|
73 | - if ($this->schema === null) { |
|
74 | - $cacheKey = $this->getCachePrefix().'_schema'; |
|
75 | - if ($this->cache->contains($cacheKey)) { |
|
76 | - $this->schema = $this->cache->fetch($cacheKey); |
|
77 | - } else { |
|
78 | - $this->schema = $this->connection->getSchemaManager()->createSchema(); |
|
79 | - $this->cache->save($cacheKey, $this->schema); |
|
80 | - } |
|
81 | - } |
|
82 | - |
|
83 | - return $this->schema; |
|
84 | - } |
|
85 | - |
|
86 | - /** |
|
87 | - * Returns the list of pivot tables linked to table $tableName. |
|
88 | - * |
|
89 | - * @param string $tableName |
|
90 | - * |
|
91 | - * @return array|string[] |
|
92 | - */ |
|
93 | - public function getPivotTableLinkedToTable($tableName) |
|
94 | - { |
|
95 | - $cacheKey = $this->getCachePrefix().'_pivottables_link_'.$tableName; |
|
96 | - if ($this->cache->contains($cacheKey)) { |
|
97 | - return $this->cache->fetch($cacheKey); |
|
98 | - } |
|
99 | - |
|
100 | - $pivotTables = []; |
|
101 | - |
|
102 | - $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
|
103 | - foreach ($junctionTables as $table) { |
|
104 | - $fks = $table->getForeignKeys(); |
|
105 | - foreach ($fks as $fk) { |
|
106 | - if ($fk->getForeignTableName() == $tableName) { |
|
107 | - $pivotTables[] = $table->getName(); |
|
108 | - break; |
|
109 | - } |
|
110 | - } |
|
111 | - } |
|
112 | - |
|
113 | - $this->cache->save($cacheKey, $pivotTables); |
|
114 | - |
|
115 | - return $pivotTables; |
|
116 | - } |
|
117 | - |
|
118 | - /** |
|
119 | - * Returns the list of foreign keys pointing to the table represented by this bean, excluding foreign keys |
|
120 | - * from junction tables and from inheritance. |
|
121 | - * |
|
122 | - * @return ForeignKeyConstraint[] |
|
123 | - */ |
|
124 | - public function getIncomingForeignKeys($tableName) |
|
125 | - { |
|
126 | - $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
|
127 | - $junctionTableNames = array_map(function (Table $table) { |
|
128 | - return $table->getName(); |
|
129 | - }, $junctionTables); |
|
130 | - $childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName); |
|
131 | - |
|
132 | - $fks = []; |
|
133 | - foreach ($this->getSchema()->getTables() as $table) { |
|
134 | - foreach ($table->getForeignKeys() as $fk) { |
|
135 | - if ($fk->getForeignTableName() === $tableName) { |
|
136 | - if (in_array($fk->getLocalTableName(), $junctionTableNames)) { |
|
137 | - continue; |
|
138 | - } |
|
139 | - foreach ($childrenRelationships as $childFk) { |
|
140 | - if ($fk->getLocalTableName() === $childFk->getLocalTableName() && $fk->getLocalColumns() === $childFk->getLocalColumns()) { |
|
141 | - continue 2; |
|
142 | - } |
|
143 | - } |
|
144 | - $fks[] = $fk; |
|
145 | - } |
|
146 | - } |
|
147 | - } |
|
148 | - |
|
149 | - return $fks; |
|
150 | - } |
|
17 | + private $connection; |
|
18 | + |
|
19 | + /** |
|
20 | + * @var Schema |
|
21 | + */ |
|
22 | + private $schema; |
|
23 | + |
|
24 | + /** |
|
25 | + * @var string |
|
26 | + */ |
|
27 | + private $cachePrefix; |
|
28 | + |
|
29 | + /** |
|
30 | + * @var Cache |
|
31 | + */ |
|
32 | + private $cache; |
|
33 | + |
|
34 | + /** |
|
35 | + * @var SchemaAnalyzer |
|
36 | + */ |
|
37 | + private $schemaAnalyzer; |
|
38 | + |
|
39 | + /** |
|
40 | + * @param Connection $connection The DBAL DB connection to use |
|
41 | + * @param Cache $cache A cache service to be used |
|
42 | + * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths... |
|
43 | + * Will be automatically created if not passed |
|
44 | + */ |
|
45 | + public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer) |
|
46 | + { |
|
47 | + $this->connection = $connection; |
|
48 | + $this->cache = $cache; |
|
49 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
50 | + } |
|
51 | + |
|
52 | + /** |
|
53 | + * Returns a unique ID for the current connection. Useful for namespacing cache entries in the current connection. |
|
54 | + * |
|
55 | + * @return string |
|
56 | + */ |
|
57 | + public function getCachePrefix() |
|
58 | + { |
|
59 | + if ($this->cachePrefix === null) { |
|
60 | + $this->cachePrefix = hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName()); |
|
61 | + } |
|
62 | + |
|
63 | + return $this->cachePrefix; |
|
64 | + } |
|
65 | + |
|
66 | + /** |
|
67 | + * Returns the (cached) schema. |
|
68 | + * |
|
69 | + * @return Schema |
|
70 | + */ |
|
71 | + public function getSchema() |
|
72 | + { |
|
73 | + if ($this->schema === null) { |
|
74 | + $cacheKey = $this->getCachePrefix().'_schema'; |
|
75 | + if ($this->cache->contains($cacheKey)) { |
|
76 | + $this->schema = $this->cache->fetch($cacheKey); |
|
77 | + } else { |
|
78 | + $this->schema = $this->connection->getSchemaManager()->createSchema(); |
|
79 | + $this->cache->save($cacheKey, $this->schema); |
|
80 | + } |
|
81 | + } |
|
82 | + |
|
83 | + return $this->schema; |
|
84 | + } |
|
85 | + |
|
86 | + /** |
|
87 | + * Returns the list of pivot tables linked to table $tableName. |
|
88 | + * |
|
89 | + * @param string $tableName |
|
90 | + * |
|
91 | + * @return array|string[] |
|
92 | + */ |
|
93 | + public function getPivotTableLinkedToTable($tableName) |
|
94 | + { |
|
95 | + $cacheKey = $this->getCachePrefix().'_pivottables_link_'.$tableName; |
|
96 | + if ($this->cache->contains($cacheKey)) { |
|
97 | + return $this->cache->fetch($cacheKey); |
|
98 | + } |
|
99 | + |
|
100 | + $pivotTables = []; |
|
101 | + |
|
102 | + $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
|
103 | + foreach ($junctionTables as $table) { |
|
104 | + $fks = $table->getForeignKeys(); |
|
105 | + foreach ($fks as $fk) { |
|
106 | + if ($fk->getForeignTableName() == $tableName) { |
|
107 | + $pivotTables[] = $table->getName(); |
|
108 | + break; |
|
109 | + } |
|
110 | + } |
|
111 | + } |
|
112 | + |
|
113 | + $this->cache->save($cacheKey, $pivotTables); |
|
114 | + |
|
115 | + return $pivotTables; |
|
116 | + } |
|
117 | + |
|
118 | + /** |
|
119 | + * Returns the list of foreign keys pointing to the table represented by this bean, excluding foreign keys |
|
120 | + * from junction tables and from inheritance. |
|
121 | + * |
|
122 | + * @return ForeignKeyConstraint[] |
|
123 | + */ |
|
124 | + public function getIncomingForeignKeys($tableName) |
|
125 | + { |
|
126 | + $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
|
127 | + $junctionTableNames = array_map(function (Table $table) { |
|
128 | + return $table->getName(); |
|
129 | + }, $junctionTables); |
|
130 | + $childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName); |
|
131 | + |
|
132 | + $fks = []; |
|
133 | + foreach ($this->getSchema()->getTables() as $table) { |
|
134 | + foreach ($table->getForeignKeys() as $fk) { |
|
135 | + if ($fk->getForeignTableName() === $tableName) { |
|
136 | + if (in_array($fk->getLocalTableName(), $junctionTableNames)) { |
|
137 | + continue; |
|
138 | + } |
|
139 | + foreach ($childrenRelationships as $childFk) { |
|
140 | + if ($fk->getLocalTableName() === $childFk->getLocalTableName() && $fk->getLocalColumns() === $childFk->getLocalColumns()) { |
|
141 | + continue 2; |
|
142 | + } |
|
143 | + } |
|
144 | + $fks[] = $fk; |
|
145 | + } |
|
146 | + } |
|
147 | + } |
|
148 | + |
|
149 | + return $fks; |
|
150 | + } |
|
151 | 151 | } |
@@ -124,7 +124,7 @@ |
||
124 | 124 | public function getIncomingForeignKeys($tableName) |
125 | 125 | { |
126 | 126 | $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
127 | - $junctionTableNames = array_map(function (Table $table) { |
|
127 | + $junctionTableNames = array_map(function(Table $table) { |
|
128 | 128 | return $table->getName(); |
129 | 129 | }, $junctionTables); |
130 | 130 | $childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName); |
@@ -33,42 +33,42 @@ |
||
33 | 33 | */ |
34 | 34 | class TDBMObject extends AbstractTDBMObject |
35 | 35 | { |
36 | - public function getProperty($var, $tableName = null) |
|
37 | - { |
|
38 | - return $this->get($var, $tableName); |
|
39 | - } |
|
36 | + public function getProperty($var, $tableName = null) |
|
37 | + { |
|
38 | + return $this->get($var, $tableName); |
|
39 | + } |
|
40 | 40 | |
41 | - public function setProperty($var, $value, $tableName = null) |
|
42 | - { |
|
43 | - $this->set($var, $value, $tableName); |
|
44 | - } |
|
41 | + public function setProperty($var, $value, $tableName = null) |
|
42 | + { |
|
43 | + $this->set($var, $value, $tableName); |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * Specify data which should be serialized to JSON. |
|
48 | - * |
|
49 | - * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
50 | - * |
|
51 | - * @return mixed data which can be serialized by <b>json_encode</b>, |
|
52 | - * which is a value of any type other than a resource |
|
53 | - * |
|
54 | - * @since 5.4.0 |
|
55 | - */ |
|
56 | - public function jsonSerialize() |
|
57 | - { |
|
58 | - throw new TDBMException('Json serialization is only implemented for generated beans.'); |
|
59 | - } |
|
46 | + /** |
|
47 | + * Specify data which should be serialized to JSON. |
|
48 | + * |
|
49 | + * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
50 | + * |
|
51 | + * @return mixed data which can be serialized by <b>json_encode</b>, |
|
52 | + * which is a value of any type other than a resource |
|
53 | + * |
|
54 | + * @since 5.4.0 |
|
55 | + */ |
|
56 | + public function jsonSerialize() |
|
57 | + { |
|
58 | + throw new TDBMException('Json serialization is only implemented for generated beans.'); |
|
59 | + } |
|
60 | 60 | |
61 | - /** |
|
62 | - * Returns an array of used tables by this bean (from parent to child relationship). |
|
63 | - * |
|
64 | - * @return string[] |
|
65 | - */ |
|
66 | - protected function getUsedTables() |
|
67 | - { |
|
68 | - $tableNames = array_keys($this->dbRows); |
|
69 | - $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames); |
|
70 | - $tableNames = array_reverse($tableNames); |
|
61 | + /** |
|
62 | + * Returns an array of used tables by this bean (from parent to child relationship). |
|
63 | + * |
|
64 | + * @return string[] |
|
65 | + */ |
|
66 | + protected function getUsedTables() |
|
67 | + { |
|
68 | + $tableNames = array_keys($this->dbRows); |
|
69 | + $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames); |
|
70 | + $tableNames = array_reverse($tableNames); |
|
71 | 71 | |
72 | - return $tableNames; |
|
73 | - } |
|
72 | + return $tableNames; |
|
73 | + } |
|
74 | 74 | } |
@@ -29,267 +29,267 @@ |
||
29 | 29 | */ |
30 | 30 | class InnerResultIterator implements \Iterator, \Countable, \ArrayAccess |
31 | 31 | { |
32 | - /** |
|
33 | - * @var Statement |
|
34 | - */ |
|
35 | - protected $statement; |
|
36 | - |
|
37 | - protected $fetchStarted = false; |
|
38 | - private $objectStorage; |
|
39 | - private $className; |
|
40 | - |
|
41 | - private $tdbmService; |
|
42 | - private $magicSql; |
|
43 | - private $parameters; |
|
44 | - private $limit; |
|
45 | - private $offset; |
|
46 | - private $columnDescriptors; |
|
47 | - private $magicQuery; |
|
48 | - |
|
49 | - /** |
|
50 | - * The key of the current retrieved object. |
|
51 | - * |
|
52 | - * @var int |
|
53 | - */ |
|
54 | - protected $key = -1; |
|
55 | - |
|
56 | - protected $current = null; |
|
57 | - |
|
58 | - private $databasePlatform; |
|
59 | - |
|
60 | - /** |
|
61 | - * @var LoggerInterface |
|
62 | - */ |
|
63 | - private $logger; |
|
64 | - |
|
65 | - public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, LoggerInterface $logger) |
|
66 | - { |
|
67 | - $this->magicSql = $magicSql; |
|
68 | - $this->objectStorage = $objectStorage; |
|
69 | - $this->className = $className; |
|
70 | - $this->tdbmService = $tdbmService; |
|
71 | - $this->parameters = $parameters; |
|
72 | - $this->limit = $limit; |
|
73 | - $this->offset = $offset; |
|
74 | - $this->columnDescriptors = $columnDescriptors; |
|
75 | - $this->magicQuery = $magicQuery; |
|
76 | - $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
77 | - $this->logger = $logger; |
|
78 | - } |
|
79 | - |
|
80 | - protected function executeQuery() |
|
81 | - { |
|
82 | - $sql = $this->magicQuery->build($this->magicSql, $this->parameters); |
|
83 | - $sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset); |
|
84 | - |
|
85 | - $this->logger->debug('Running SQL request: '.$sql); |
|
86 | - |
|
87 | - $this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters); |
|
88 | - |
|
89 | - $this->fetchStarted = true; |
|
90 | - } |
|
91 | - |
|
92 | - /** |
|
93 | - * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings). |
|
94 | - * |
|
95 | - * @return int |
|
96 | - */ |
|
97 | - public function count() |
|
98 | - { |
|
99 | - if (!$this->fetchStarted) { |
|
100 | - $this->executeQuery(); |
|
101 | - } |
|
102 | - |
|
103 | - return $this->statement->rowCount(); |
|
104 | - } |
|
105 | - |
|
106 | - /** |
|
107 | - * Fetches record at current cursor. |
|
108 | - * |
|
109 | - * @return AbstractTDBMObject|null |
|
110 | - */ |
|
111 | - public function current() |
|
112 | - { |
|
113 | - return $this->current; |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * Returns the current result's key. |
|
118 | - * |
|
119 | - * @return int |
|
120 | - */ |
|
121 | - public function key() |
|
122 | - { |
|
123 | - return $this->key; |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * Advances the cursor to the next result. |
|
128 | - * Casts the database result into one (or several) beans. |
|
129 | - */ |
|
130 | - public function next() |
|
131 | - { |
|
132 | - $row = $this->statement->fetch(\PDO::FETCH_NUM); |
|
133 | - if ($row) { |
|
134 | - |
|
135 | - // array<tablegroup, array<table, array<column, value>>> |
|
136 | - $beansData = []; |
|
137 | - foreach ($row as $i => $value) { |
|
138 | - $columnDescriptor = $this->columnDescriptors[$i]; |
|
139 | - |
|
140 | - if ($columnDescriptor['tableGroup'] === null) { |
|
141 | - // A column can have no tableGroup (if it comes from an ORDER BY expression) |
|
142 | - continue; |
|
143 | - } |
|
144 | - |
|
145 | - // Let's cast the value according to its type |
|
146 | - $value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform); |
|
147 | - |
|
148 | - $beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value; |
|
149 | - } |
|
150 | - |
|
151 | - $reflectionClassCache = []; |
|
152 | - $firstBean = true; |
|
153 | - foreach ($beansData as $beanData) { |
|
154 | - |
|
155 | - // Let's find the bean class name associated to the bean. |
|
156 | - |
|
157 | - list($actualClassName, $mainBeanTableName, $tablesUsed) = $this->tdbmService->_getClassNameFromBeanData($beanData); |
|
158 | - |
|
159 | - if ($this->className !== null) { |
|
160 | - $actualClassName = $this->className; |
|
161 | - } |
|
162 | - |
|
163 | - // Let's filter out the beanData that is not used (because it belongs to a part of the hierarchy that is not fetched: |
|
164 | - foreach ($beanData as $tableName => $descriptors) { |
|
165 | - if (!in_array($tableName, $tablesUsed)) { |
|
166 | - unset($beanData[$tableName]); |
|
167 | - } |
|
168 | - } |
|
169 | - |
|
170 | - // Must we create the bean? Let's see in the cache if we have a mapping DbRow? |
|
171 | - // Let's get the first object mapping a row: |
|
172 | - // We do this loop only for the first table |
|
173 | - |
|
174 | - $primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]); |
|
175 | - $hash = $this->tdbmService->getObjectHash($primaryKeys); |
|
176 | - |
|
177 | - if ($this->objectStorage->has($mainBeanTableName, $hash)) { |
|
178 | - $dbRow = $this->objectStorage->get($mainBeanTableName, $hash); |
|
179 | - $bean = $dbRow->getTDBMObject(); |
|
180 | - } else { |
|
181 | - // Let's construct the bean |
|
182 | - if (!isset($reflectionClassCache[$actualClassName])) { |
|
183 | - $reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName); |
|
184 | - } |
|
185 | - // Let's bypass the constructor when creating the bean! |
|
186 | - $bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor(); |
|
187 | - $bean->_constructFromData($beanData, $this->tdbmService); |
|
188 | - } |
|
189 | - |
|
190 | - // The first bean is the one containing the main table. |
|
191 | - if ($firstBean) { |
|
192 | - $firstBean = false; |
|
193 | - $this->current = $bean; |
|
194 | - } |
|
195 | - } |
|
196 | - |
|
197 | - ++$this->key; |
|
198 | - } else { |
|
199 | - $this->current = null; |
|
200 | - } |
|
201 | - } |
|
202 | - |
|
203 | - /** |
|
204 | - * Moves the cursor to the beginning of the result set. |
|
205 | - */ |
|
206 | - public function rewind() |
|
207 | - { |
|
208 | - $this->executeQuery(); |
|
209 | - $this->key = -1; |
|
210 | - $this->next(); |
|
211 | - } |
|
212 | - /** |
|
213 | - * Checks if the cursor is reading a valid result. |
|
214 | - * |
|
215 | - * @return bool |
|
216 | - */ |
|
217 | - public function valid() |
|
218 | - { |
|
219 | - return $this->current !== null; |
|
220 | - } |
|
221 | - |
|
222 | - /** |
|
223 | - * Whether a offset exists. |
|
224 | - * |
|
225 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
226 | - * |
|
227 | - * @param mixed $offset <p> |
|
228 | - * An offset to check for. |
|
229 | - * </p> |
|
230 | - * |
|
231 | - * @return bool true on success or false on failure. |
|
232 | - * </p> |
|
233 | - * <p> |
|
234 | - * The return value will be casted to boolean if non-boolean was returned |
|
235 | - * |
|
236 | - * @since 5.0.0 |
|
237 | - */ |
|
238 | - public function offsetExists($offset) |
|
239 | - { |
|
240 | - throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.'); |
|
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * Offset to retrieve. |
|
245 | - * |
|
246 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
247 | - * |
|
248 | - * @param mixed $offset <p> |
|
249 | - * The offset to retrieve. |
|
250 | - * </p> |
|
251 | - * |
|
252 | - * @return mixed Can return all value types |
|
253 | - * |
|
254 | - * @since 5.0.0 |
|
255 | - */ |
|
256 | - public function offsetGet($offset) |
|
257 | - { |
|
258 | - throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.'); |
|
259 | - } |
|
260 | - |
|
261 | - /** |
|
262 | - * Offset to set. |
|
263 | - * |
|
264 | - * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
265 | - * |
|
266 | - * @param mixed $offset <p> |
|
267 | - * The offset to assign the value to. |
|
268 | - * </p> |
|
269 | - * @param mixed $value <p> |
|
270 | - * The value to set. |
|
271 | - * </p> |
|
272 | - * |
|
273 | - * @since 5.0.0 |
|
274 | - */ |
|
275 | - public function offsetSet($offset, $value) |
|
276 | - { |
|
277 | - throw new TDBMInvalidOperationException('You can set values in a TDBM result set.'); |
|
278 | - } |
|
279 | - |
|
280 | - /** |
|
281 | - * Offset to unset. |
|
282 | - * |
|
283 | - * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
284 | - * |
|
285 | - * @param mixed $offset <p> |
|
286 | - * The offset to unset. |
|
287 | - * </p> |
|
288 | - * |
|
289 | - * @since 5.0.0 |
|
290 | - */ |
|
291 | - public function offsetUnset($offset) |
|
292 | - { |
|
293 | - throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.'); |
|
294 | - } |
|
32 | + /** |
|
33 | + * @var Statement |
|
34 | + */ |
|
35 | + protected $statement; |
|
36 | + |
|
37 | + protected $fetchStarted = false; |
|
38 | + private $objectStorage; |
|
39 | + private $className; |
|
40 | + |
|
41 | + private $tdbmService; |
|
42 | + private $magicSql; |
|
43 | + private $parameters; |
|
44 | + private $limit; |
|
45 | + private $offset; |
|
46 | + private $columnDescriptors; |
|
47 | + private $magicQuery; |
|
48 | + |
|
49 | + /** |
|
50 | + * The key of the current retrieved object. |
|
51 | + * |
|
52 | + * @var int |
|
53 | + */ |
|
54 | + protected $key = -1; |
|
55 | + |
|
56 | + protected $current = null; |
|
57 | + |
|
58 | + private $databasePlatform; |
|
59 | + |
|
60 | + /** |
|
61 | + * @var LoggerInterface |
|
62 | + */ |
|
63 | + private $logger; |
|
64 | + |
|
65 | + public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, LoggerInterface $logger) |
|
66 | + { |
|
67 | + $this->magicSql = $magicSql; |
|
68 | + $this->objectStorage = $objectStorage; |
|
69 | + $this->className = $className; |
|
70 | + $this->tdbmService = $tdbmService; |
|
71 | + $this->parameters = $parameters; |
|
72 | + $this->limit = $limit; |
|
73 | + $this->offset = $offset; |
|
74 | + $this->columnDescriptors = $columnDescriptors; |
|
75 | + $this->magicQuery = $magicQuery; |
|
76 | + $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
77 | + $this->logger = $logger; |
|
78 | + } |
|
79 | + |
|
80 | + protected function executeQuery() |
|
81 | + { |
|
82 | + $sql = $this->magicQuery->build($this->magicSql, $this->parameters); |
|
83 | + $sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset); |
|
84 | + |
|
85 | + $this->logger->debug('Running SQL request: '.$sql); |
|
86 | + |
|
87 | + $this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters); |
|
88 | + |
|
89 | + $this->fetchStarted = true; |
|
90 | + } |
|
91 | + |
|
92 | + /** |
|
93 | + * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings). |
|
94 | + * |
|
95 | + * @return int |
|
96 | + */ |
|
97 | + public function count() |
|
98 | + { |
|
99 | + if (!$this->fetchStarted) { |
|
100 | + $this->executeQuery(); |
|
101 | + } |
|
102 | + |
|
103 | + return $this->statement->rowCount(); |
|
104 | + } |
|
105 | + |
|
106 | + /** |
|
107 | + * Fetches record at current cursor. |
|
108 | + * |
|
109 | + * @return AbstractTDBMObject|null |
|
110 | + */ |
|
111 | + public function current() |
|
112 | + { |
|
113 | + return $this->current; |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * Returns the current result's key. |
|
118 | + * |
|
119 | + * @return int |
|
120 | + */ |
|
121 | + public function key() |
|
122 | + { |
|
123 | + return $this->key; |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * Advances the cursor to the next result. |
|
128 | + * Casts the database result into one (or several) beans. |
|
129 | + */ |
|
130 | + public function next() |
|
131 | + { |
|
132 | + $row = $this->statement->fetch(\PDO::FETCH_NUM); |
|
133 | + if ($row) { |
|
134 | + |
|
135 | + // array<tablegroup, array<table, array<column, value>>> |
|
136 | + $beansData = []; |
|
137 | + foreach ($row as $i => $value) { |
|
138 | + $columnDescriptor = $this->columnDescriptors[$i]; |
|
139 | + |
|
140 | + if ($columnDescriptor['tableGroup'] === null) { |
|
141 | + // A column can have no tableGroup (if it comes from an ORDER BY expression) |
|
142 | + continue; |
|
143 | + } |
|
144 | + |
|
145 | + // Let's cast the value according to its type |
|
146 | + $value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform); |
|
147 | + |
|
148 | + $beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value; |
|
149 | + } |
|
150 | + |
|
151 | + $reflectionClassCache = []; |
|
152 | + $firstBean = true; |
|
153 | + foreach ($beansData as $beanData) { |
|
154 | + |
|
155 | + // Let's find the bean class name associated to the bean. |
|
156 | + |
|
157 | + list($actualClassName, $mainBeanTableName, $tablesUsed) = $this->tdbmService->_getClassNameFromBeanData($beanData); |
|
158 | + |
|
159 | + if ($this->className !== null) { |
|
160 | + $actualClassName = $this->className; |
|
161 | + } |
|
162 | + |
|
163 | + // Let's filter out the beanData that is not used (because it belongs to a part of the hierarchy that is not fetched: |
|
164 | + foreach ($beanData as $tableName => $descriptors) { |
|
165 | + if (!in_array($tableName, $tablesUsed)) { |
|
166 | + unset($beanData[$tableName]); |
|
167 | + } |
|
168 | + } |
|
169 | + |
|
170 | + // Must we create the bean? Let's see in the cache if we have a mapping DbRow? |
|
171 | + // Let's get the first object mapping a row: |
|
172 | + // We do this loop only for the first table |
|
173 | + |
|
174 | + $primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]); |
|
175 | + $hash = $this->tdbmService->getObjectHash($primaryKeys); |
|
176 | + |
|
177 | + if ($this->objectStorage->has($mainBeanTableName, $hash)) { |
|
178 | + $dbRow = $this->objectStorage->get($mainBeanTableName, $hash); |
|
179 | + $bean = $dbRow->getTDBMObject(); |
|
180 | + } else { |
|
181 | + // Let's construct the bean |
|
182 | + if (!isset($reflectionClassCache[$actualClassName])) { |
|
183 | + $reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName); |
|
184 | + } |
|
185 | + // Let's bypass the constructor when creating the bean! |
|
186 | + $bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor(); |
|
187 | + $bean->_constructFromData($beanData, $this->tdbmService); |
|
188 | + } |
|
189 | + |
|
190 | + // The first bean is the one containing the main table. |
|
191 | + if ($firstBean) { |
|
192 | + $firstBean = false; |
|
193 | + $this->current = $bean; |
|
194 | + } |
|
195 | + } |
|
196 | + |
|
197 | + ++$this->key; |
|
198 | + } else { |
|
199 | + $this->current = null; |
|
200 | + } |
|
201 | + } |
|
202 | + |
|
203 | + /** |
|
204 | + * Moves the cursor to the beginning of the result set. |
|
205 | + */ |
|
206 | + public function rewind() |
|
207 | + { |
|
208 | + $this->executeQuery(); |
|
209 | + $this->key = -1; |
|
210 | + $this->next(); |
|
211 | + } |
|
212 | + /** |
|
213 | + * Checks if the cursor is reading a valid result. |
|
214 | + * |
|
215 | + * @return bool |
|
216 | + */ |
|
217 | + public function valid() |
|
218 | + { |
|
219 | + return $this->current !== null; |
|
220 | + } |
|
221 | + |
|
222 | + /** |
|
223 | + * Whether a offset exists. |
|
224 | + * |
|
225 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
226 | + * |
|
227 | + * @param mixed $offset <p> |
|
228 | + * An offset to check for. |
|
229 | + * </p> |
|
230 | + * |
|
231 | + * @return bool true on success or false on failure. |
|
232 | + * </p> |
|
233 | + * <p> |
|
234 | + * The return value will be casted to boolean if non-boolean was returned |
|
235 | + * |
|
236 | + * @since 5.0.0 |
|
237 | + */ |
|
238 | + public function offsetExists($offset) |
|
239 | + { |
|
240 | + throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.'); |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * Offset to retrieve. |
|
245 | + * |
|
246 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
247 | + * |
|
248 | + * @param mixed $offset <p> |
|
249 | + * The offset to retrieve. |
|
250 | + * </p> |
|
251 | + * |
|
252 | + * @return mixed Can return all value types |
|
253 | + * |
|
254 | + * @since 5.0.0 |
|
255 | + */ |
|
256 | + public function offsetGet($offset) |
|
257 | + { |
|
258 | + throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.'); |
|
259 | + } |
|
260 | + |
|
261 | + /** |
|
262 | + * Offset to set. |
|
263 | + * |
|
264 | + * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
265 | + * |
|
266 | + * @param mixed $offset <p> |
|
267 | + * The offset to assign the value to. |
|
268 | + * </p> |
|
269 | + * @param mixed $value <p> |
|
270 | + * The value to set. |
|
271 | + * </p> |
|
272 | + * |
|
273 | + * @since 5.0.0 |
|
274 | + */ |
|
275 | + public function offsetSet($offset, $value) |
|
276 | + { |
|
277 | + throw new TDBMInvalidOperationException('You can set values in a TDBM result set.'); |
|
278 | + } |
|
279 | + |
|
280 | + /** |
|
281 | + * Offset to unset. |
|
282 | + * |
|
283 | + * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
284 | + * |
|
285 | + * @param mixed $offset <p> |
|
286 | + * The offset to unset. |
|
287 | + * </p> |
|
288 | + * |
|
289 | + * @since 5.0.0 |
|
290 | + */ |
|
291 | + public function offsetUnset($offset) |
|
292 | + { |
|
293 | + throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.'); |
|
294 | + } |
|
295 | 295 | } |
@@ -12,122 +12,122 @@ |
||
12 | 12 | */ |
13 | 13 | class OrderByAnalyzer |
14 | 14 | { |
15 | - /** |
|
16 | - * The content of the cache variable. |
|
17 | - * |
|
18 | - * @var Cache |
|
19 | - */ |
|
20 | - private $cache; |
|
21 | - |
|
22 | - /** |
|
23 | - * @var string |
|
24 | - */ |
|
25 | - private $cachePrefix; |
|
26 | - |
|
27 | - /** |
|
28 | - * OrderByAnalyzer constructor. |
|
29 | - * |
|
30 | - * @param Cache $cache |
|
31 | - * @param string|null $cachePrefix |
|
32 | - */ |
|
33 | - public function __construct(Cache $cache, $cachePrefix = null) |
|
34 | - { |
|
35 | - $this->cache = $cache; |
|
36 | - $this->cachePrefix = $cachePrefix; |
|
37 | - } |
|
38 | - |
|
39 | - /** |
|
40 | - * Returns an array for each sorted "column" in the form:. |
|
41 | - * |
|
42 | - * [ |
|
43 | - * [ |
|
44 | - * 'type' => 'colref', |
|
45 | - * 'table' => null, |
|
46 | - * 'column' => 'a', |
|
47 | - * 'direction' => 'ASC' |
|
48 | - * ], |
|
49 | - * [ |
|
50 | - * 'type' => 'expr', |
|
51 | - * 'expr' => 'RAND()', |
|
52 | - * 'direction' => 'DESC' |
|
53 | - * ] |
|
54 | - * ] |
|
55 | - * |
|
56 | - * @param string $orderBy |
|
57 | - * |
|
58 | - * @return array |
|
59 | - */ |
|
60 | - public function analyzeOrderBy(string $orderBy) : array |
|
61 | - { |
|
62 | - $key = $this->cachePrefix.'_order_by_analysis_'.$orderBy; |
|
63 | - $results = $this->cache->fetch($key); |
|
64 | - if ($results !== false) { |
|
65 | - return $results; |
|
66 | - } |
|
67 | - $results = $this->analyzeOrderByNoCache($orderBy); |
|
68 | - $this->cache->save($key, $results); |
|
69 | - |
|
70 | - return $results; |
|
71 | - } |
|
72 | - |
|
73 | - private function analyzeOrderByNoCache(string $orderBy) : array |
|
74 | - { |
|
75 | - $sqlParser = new PHPSQLParser(); |
|
76 | - $sql = 'SELECT 1 FROM a ORDER BY '.$orderBy; |
|
77 | - $parsed = $sqlParser->parse($sql, true); |
|
78 | - |
|
79 | - $results = []; |
|
80 | - |
|
81 | - for ($i = 0, $count = count($parsed['ORDER']); $i < $count; ++$i) { |
|
82 | - $orderItem = $parsed['ORDER'][$i]; |
|
83 | - if ($orderItem['expr_type'] === 'colref') { |
|
84 | - $parts = $orderItem['no_quotes']['parts']; |
|
85 | - $columnName = array_pop($parts); |
|
86 | - if (!empty($parts)) { |
|
87 | - $tableName = array_pop($parts); |
|
88 | - } else { |
|
89 | - $tableName = null; |
|
90 | - } |
|
91 | - |
|
92 | - $results[] = [ |
|
93 | - 'type' => 'colref', |
|
94 | - 'table' => $tableName, |
|
95 | - 'column' => $columnName, |
|
96 | - 'direction' => $orderItem['direction'], |
|
97 | - ]; |
|
98 | - } else { |
|
99 | - $position = $orderItem['position']; |
|
100 | - if ($i + 1 < $count) { |
|
101 | - $nextPosition = $parsed['ORDER'][$i + 1]['position']; |
|
102 | - $str = substr($sql, $position, $nextPosition - $position); |
|
103 | - } else { |
|
104 | - $str = substr($sql, $position); |
|
105 | - } |
|
106 | - |
|
107 | - $str = trim($str, " \t\r\n,"); |
|
108 | - |
|
109 | - $results[] = [ |
|
110 | - 'type' => 'expr', |
|
111 | - 'expr' => $this->trimDirection($str), |
|
112 | - 'direction' => $orderItem['direction'], |
|
113 | - ]; |
|
114 | - } |
|
115 | - } |
|
116 | - |
|
117 | - return $results; |
|
118 | - } |
|
119 | - |
|
120 | - /** |
|
121 | - * Trims the ASC/DESC direction at the end of the string. |
|
122 | - * |
|
123 | - * @param string $sql |
|
124 | - * |
|
125 | - * @return string |
|
126 | - */ |
|
127 | - private function trimDirection(string $sql) : string |
|
128 | - { |
|
129 | - preg_match('/^(.*)(\s+(DESC|ASC|))*$/Ui', $sql, $matches); |
|
130 | - |
|
131 | - return $matches[1]; |
|
132 | - } |
|
15 | + /** |
|
16 | + * The content of the cache variable. |
|
17 | + * |
|
18 | + * @var Cache |
|
19 | + */ |
|
20 | + private $cache; |
|
21 | + |
|
22 | + /** |
|
23 | + * @var string |
|
24 | + */ |
|
25 | + private $cachePrefix; |
|
26 | + |
|
27 | + /** |
|
28 | + * OrderByAnalyzer constructor. |
|
29 | + * |
|
30 | + * @param Cache $cache |
|
31 | + * @param string|null $cachePrefix |
|
32 | + */ |
|
33 | + public function __construct(Cache $cache, $cachePrefix = null) |
|
34 | + { |
|
35 | + $this->cache = $cache; |
|
36 | + $this->cachePrefix = $cachePrefix; |
|
37 | + } |
|
38 | + |
|
39 | + /** |
|
40 | + * Returns an array for each sorted "column" in the form:. |
|
41 | + * |
|
42 | + * [ |
|
43 | + * [ |
|
44 | + * 'type' => 'colref', |
|
45 | + * 'table' => null, |
|
46 | + * 'column' => 'a', |
|
47 | + * 'direction' => 'ASC' |
|
48 | + * ], |
|
49 | + * [ |
|
50 | + * 'type' => 'expr', |
|
51 | + * 'expr' => 'RAND()', |
|
52 | + * 'direction' => 'DESC' |
|
53 | + * ] |
|
54 | + * ] |
|
55 | + * |
|
56 | + * @param string $orderBy |
|
57 | + * |
|
58 | + * @return array |
|
59 | + */ |
|
60 | + public function analyzeOrderBy(string $orderBy) : array |
|
61 | + { |
|
62 | + $key = $this->cachePrefix.'_order_by_analysis_'.$orderBy; |
|
63 | + $results = $this->cache->fetch($key); |
|
64 | + if ($results !== false) { |
|
65 | + return $results; |
|
66 | + } |
|
67 | + $results = $this->analyzeOrderByNoCache($orderBy); |
|
68 | + $this->cache->save($key, $results); |
|
69 | + |
|
70 | + return $results; |
|
71 | + } |
|
72 | + |
|
73 | + private function analyzeOrderByNoCache(string $orderBy) : array |
|
74 | + { |
|
75 | + $sqlParser = new PHPSQLParser(); |
|
76 | + $sql = 'SELECT 1 FROM a ORDER BY '.$orderBy; |
|
77 | + $parsed = $sqlParser->parse($sql, true); |
|
78 | + |
|
79 | + $results = []; |
|
80 | + |
|
81 | + for ($i = 0, $count = count($parsed['ORDER']); $i < $count; ++$i) { |
|
82 | + $orderItem = $parsed['ORDER'][$i]; |
|
83 | + if ($orderItem['expr_type'] === 'colref') { |
|
84 | + $parts = $orderItem['no_quotes']['parts']; |
|
85 | + $columnName = array_pop($parts); |
|
86 | + if (!empty($parts)) { |
|
87 | + $tableName = array_pop($parts); |
|
88 | + } else { |
|
89 | + $tableName = null; |
|
90 | + } |
|
91 | + |
|
92 | + $results[] = [ |
|
93 | + 'type' => 'colref', |
|
94 | + 'table' => $tableName, |
|
95 | + 'column' => $columnName, |
|
96 | + 'direction' => $orderItem['direction'], |
|
97 | + ]; |
|
98 | + } else { |
|
99 | + $position = $orderItem['position']; |
|
100 | + if ($i + 1 < $count) { |
|
101 | + $nextPosition = $parsed['ORDER'][$i + 1]['position']; |
|
102 | + $str = substr($sql, $position, $nextPosition - $position); |
|
103 | + } else { |
|
104 | + $str = substr($sql, $position); |
|
105 | + } |
|
106 | + |
|
107 | + $str = trim($str, " \t\r\n,"); |
|
108 | + |
|
109 | + $results[] = [ |
|
110 | + 'type' => 'expr', |
|
111 | + 'expr' => $this->trimDirection($str), |
|
112 | + 'direction' => $orderItem['direction'], |
|
113 | + ]; |
|
114 | + } |
|
115 | + } |
|
116 | + |
|
117 | + return $results; |
|
118 | + } |
|
119 | + |
|
120 | + /** |
|
121 | + * Trims the ASC/DESC direction at the end of the string. |
|
122 | + * |
|
123 | + * @param string $sql |
|
124 | + * |
|
125 | + * @return string |
|
126 | + */ |
|
127 | + private function trimDirection(string $sql) : string |
|
128 | + { |
|
129 | + preg_match('/^(.*)(\s+(DESC|ASC|))*$/Ui', $sql, $matches); |
|
130 | + |
|
131 | + return $matches[1]; |
|
132 | + } |
|
133 | 133 | } |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | |
79 | 79 | $results = []; |
80 | 80 | |
81 | - for ($i = 0, $count = count($parsed['ORDER']); $i < $count; ++$i) { |
|
81 | + for ($i = 0, $count = count($parsed['ORDER']); $i<$count; ++$i) { |
|
82 | 82 | $orderItem = $parsed['ORDER'][$i]; |
83 | 83 | if ($orderItem['expr_type'] === 'colref') { |
84 | 84 | $parts = $orderItem['no_quotes']['parts']; |
@@ -97,9 +97,9 @@ discard block |
||
97 | 97 | ]; |
98 | 98 | } else { |
99 | 99 | $position = $orderItem['position']; |
100 | - if ($i + 1 < $count) { |
|
101 | - $nextPosition = $parsed['ORDER'][$i + 1]['position']; |
|
102 | - $str = substr($sql, $position, $nextPosition - $position); |
|
100 | + if ($i+1<$count) { |
|
101 | + $nextPosition = $parsed['ORDER'][$i+1]['position']; |
|
102 | + $str = substr($sql, $position, $nextPosition-$position); |
|
103 | 103 | } else { |
104 | 104 | $str = substr($sql, $position); |
105 | 105 | } |
@@ -20,24 +20,24 @@ |
||
20 | 20 | */ |
21 | 21 | class UncheckedOrderBy |
22 | 22 | { |
23 | - /** |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - private $orderBy; |
|
23 | + /** |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + private $orderBy; |
|
27 | 27 | |
28 | - /** |
|
29 | - * @param $orderBy |
|
30 | - */ |
|
31 | - public function __construct(string $orderBy) |
|
32 | - { |
|
33 | - $this->orderBy = $orderBy; |
|
34 | - } |
|
28 | + /** |
|
29 | + * @param $orderBy |
|
30 | + */ |
|
31 | + public function __construct(string $orderBy) |
|
32 | + { |
|
33 | + $this->orderBy = $orderBy; |
|
34 | + } |
|
35 | 35 | |
36 | - /** |
|
37 | - * @return string |
|
38 | - */ |
|
39 | - public function getOrderBy() : string |
|
40 | - { |
|
41 | - return $this->orderBy; |
|
42 | - } |
|
36 | + /** |
|
37 | + * @return string |
|
38 | + */ |
|
39 | + public function getOrderBy() : string |
|
40 | + { |
|
41 | + return $this->orderBy; |
|
42 | + } |
|
43 | 43 | } |
@@ -39,7 +39,7 @@ |
||
39 | 39 | $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$this->mainTable.')'; |
40 | 40 | |
41 | 41 | $pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns(); |
42 | - $pkColumnNames = array_map(function ($pkColumn) { |
|
42 | + $pkColumnNames = array_map(function($pkColumn) { |
|
43 | 43 | return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn); |
44 | 44 | }, $pkColumnNames); |
45 | 45 |
@@ -11,44 +11,44 @@ |
||
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 | } |