@@ -11,125 +11,125 @@ discard block |
||
11 | 11 | */ |
12 | 12 | class ScalarBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor |
13 | 13 | { |
14 | - /** |
|
15 | - * @var Column |
|
16 | - */ |
|
17 | - private $column; |
|
18 | - |
|
19 | - public function __construct(Table $table, Column $column) |
|
20 | - { |
|
21 | - parent::__construct($table); |
|
22 | - $this->table = $table; |
|
23 | - $this->column = $column; |
|
24 | - } |
|
25 | - |
|
26 | - /** |
|
27 | - * Returns the foreign-key the column is part of, if any. null otherwise. |
|
28 | - * |
|
29 | - * @return ForeignKeyConstraint|null |
|
30 | - */ |
|
31 | - public function getForeignKey() |
|
32 | - { |
|
33 | - return false; |
|
34 | - } |
|
35 | - |
|
36 | - /** |
|
37 | - * Returns the param annotation for this property (useful for constructor). |
|
38 | - * |
|
39 | - * @return string |
|
40 | - */ |
|
41 | - public function getParamAnnotation() |
|
42 | - { |
|
43 | - $className = $this->getClassName(); |
|
44 | - $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType()); |
|
45 | - |
|
46 | - $str = ' * @param %s %s'; |
|
47 | - |
|
48 | - return sprintf($str, $paramType, $this->getVariableName()); |
|
49 | - } |
|
50 | - |
|
51 | - public function getUpperCamelCaseName() |
|
52 | - { |
|
53 | - return TDBMDaoGenerator::toCamelCase($this->column->getName()); |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
58 | - * |
|
59 | - * @return null|string |
|
60 | - */ |
|
61 | - public function getClassName() |
|
62 | - { |
|
63 | - return; |
|
64 | - } |
|
65 | - |
|
66 | - /** |
|
67 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
68 | - * |
|
69 | - * @return bool |
|
70 | - */ |
|
71 | - public function isCompulsory() |
|
72 | - { |
|
73 | - return $this->column->getNotnull() && !$this->column->getAutoincrement() && $this->column->getDefault() === null; |
|
74 | - } |
|
75 | - |
|
76 | - /** |
|
77 | - * Returns true if the property has a default value. |
|
78 | - * |
|
79 | - * @return bool |
|
80 | - */ |
|
81 | - public function hasDefault() |
|
82 | - { |
|
83 | - return $this->column->getDefault() !== null; |
|
84 | - } |
|
85 | - |
|
86 | - /** |
|
87 | - * Returns the code that assigns a value to its default value. |
|
88 | - * |
|
89 | - * @return string |
|
90 | - */ |
|
91 | - public function assignToDefaultCode() |
|
92 | - { |
|
93 | - $str = ' $this->%s(%s);'; |
|
94 | - |
|
95 | - $default = $this->column->getDefault(); |
|
96 | - |
|
97 | - if (strtoupper($default) === 'CURRENT_TIMESTAMP') { |
|
98 | - $defaultCode = 'new \DateTimeImmutable()'; |
|
99 | - } else { |
|
100 | - $defaultCode = var_export($this->column->getDefault(), true); |
|
101 | - } |
|
102 | - |
|
103 | - return sprintf($str, $this->getSetterName(), $defaultCode); |
|
104 | - } |
|
105 | - |
|
106 | - /** |
|
107 | - * Returns true if the property is the primary key. |
|
108 | - * |
|
109 | - * @return bool |
|
110 | - */ |
|
111 | - public function isPrimaryKey() |
|
112 | - { |
|
113 | - return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * Returns the PHP code for getters and setters. |
|
118 | - * |
|
119 | - * @return string |
|
120 | - */ |
|
121 | - public function getGetterSetterCode() |
|
122 | - { |
|
123 | - $type = $this->column->getType(); |
|
124 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
125 | - |
|
126 | - $columnGetterName = $this->getGetterName(); |
|
127 | - $columnSetterName = $this->getSetterName(); |
|
128 | - |
|
129 | - // A column type can be forced if it is not nullable and not auto-incrmentable (for auto-increment columns, we can get "null" as long as the bean is not saved). |
|
130 | - $canForceGetterReturnType = $this->column->getNotnull() && !$this->column->getAutoincrement(); |
|
131 | - |
|
132 | - $getterAndSetterCode = ' /** |
|
14 | + /** |
|
15 | + * @var Column |
|
16 | + */ |
|
17 | + private $column; |
|
18 | + |
|
19 | + public function __construct(Table $table, Column $column) |
|
20 | + { |
|
21 | + parent::__construct($table); |
|
22 | + $this->table = $table; |
|
23 | + $this->column = $column; |
|
24 | + } |
|
25 | + |
|
26 | + /** |
|
27 | + * Returns the foreign-key the column is part of, if any. null otherwise. |
|
28 | + * |
|
29 | + * @return ForeignKeyConstraint|null |
|
30 | + */ |
|
31 | + public function getForeignKey() |
|
32 | + { |
|
33 | + return false; |
|
34 | + } |
|
35 | + |
|
36 | + /** |
|
37 | + * Returns the param annotation for this property (useful for constructor). |
|
38 | + * |
|
39 | + * @return string |
|
40 | + */ |
|
41 | + public function getParamAnnotation() |
|
42 | + { |
|
43 | + $className = $this->getClassName(); |
|
44 | + $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType()); |
|
45 | + |
|
46 | + $str = ' * @param %s %s'; |
|
47 | + |
|
48 | + return sprintf($str, $paramType, $this->getVariableName()); |
|
49 | + } |
|
50 | + |
|
51 | + public function getUpperCamelCaseName() |
|
52 | + { |
|
53 | + return TDBMDaoGenerator::toCamelCase($this->column->getName()); |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
58 | + * |
|
59 | + * @return null|string |
|
60 | + */ |
|
61 | + public function getClassName() |
|
62 | + { |
|
63 | + return; |
|
64 | + } |
|
65 | + |
|
66 | + /** |
|
67 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
68 | + * |
|
69 | + * @return bool |
|
70 | + */ |
|
71 | + public function isCompulsory() |
|
72 | + { |
|
73 | + return $this->column->getNotnull() && !$this->column->getAutoincrement() && $this->column->getDefault() === null; |
|
74 | + } |
|
75 | + |
|
76 | + /** |
|
77 | + * Returns true if the property has a default value. |
|
78 | + * |
|
79 | + * @return bool |
|
80 | + */ |
|
81 | + public function hasDefault() |
|
82 | + { |
|
83 | + return $this->column->getDefault() !== null; |
|
84 | + } |
|
85 | + |
|
86 | + /** |
|
87 | + * Returns the code that assigns a value to its default value. |
|
88 | + * |
|
89 | + * @return string |
|
90 | + */ |
|
91 | + public function assignToDefaultCode() |
|
92 | + { |
|
93 | + $str = ' $this->%s(%s);'; |
|
94 | + |
|
95 | + $default = $this->column->getDefault(); |
|
96 | + |
|
97 | + if (strtoupper($default) === 'CURRENT_TIMESTAMP') { |
|
98 | + $defaultCode = 'new \DateTimeImmutable()'; |
|
99 | + } else { |
|
100 | + $defaultCode = var_export($this->column->getDefault(), true); |
|
101 | + } |
|
102 | + |
|
103 | + return sprintf($str, $this->getSetterName(), $defaultCode); |
|
104 | + } |
|
105 | + |
|
106 | + /** |
|
107 | + * Returns true if the property is the primary key. |
|
108 | + * |
|
109 | + * @return bool |
|
110 | + */ |
|
111 | + public function isPrimaryKey() |
|
112 | + { |
|
113 | + return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * Returns the PHP code for getters and setters. |
|
118 | + * |
|
119 | + * @return string |
|
120 | + */ |
|
121 | + public function getGetterSetterCode() |
|
122 | + { |
|
123 | + $type = $this->column->getType(); |
|
124 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
125 | + |
|
126 | + $columnGetterName = $this->getGetterName(); |
|
127 | + $columnSetterName = $this->getSetterName(); |
|
128 | + |
|
129 | + // A column type can be forced if it is not nullable and not auto-incrmentable (for auto-increment columns, we can get "null" as long as the bean is not saved). |
|
130 | + $canForceGetterReturnType = $this->column->getNotnull() && !$this->column->getAutoincrement(); |
|
131 | + |
|
132 | + $getterAndSetterCode = ' /** |
|
133 | 133 | * The getter for the "%s" column. |
134 | 134 | * |
135 | 135 | * @return %s |
@@ -151,52 +151,52 @@ discard block |
||
151 | 151 | |
152 | 152 | '; |
153 | 153 | |
154 | - return sprintf($getterAndSetterCode, |
|
155 | - // Getter |
|
156 | - $this->column->getName(), |
|
157 | - $normalizedType.($canForceGetterReturnType ? '' : '|null'), |
|
158 | - $columnGetterName, |
|
159 | - ($canForceGetterReturnType ? ' : '.$normalizedType : ''), |
|
160 | - var_export($this->column->getName(), true), |
|
161 | - var_export($this->table->getName(), true), |
|
162 | - // Setter |
|
163 | - $this->column->getName(), |
|
164 | - $normalizedType, |
|
165 | - $this->column->getName(), |
|
166 | - $columnSetterName, |
|
167 | - $normalizedType, |
|
168 | - //$castTo, |
|
169 | - $this->column->getName().($this->column->getNotnull() ? '' : ' = null'), |
|
170 | - var_export($this->column->getName(), true), |
|
171 | - $this->column->getName(), |
|
172 | - var_export($this->table->getName(), true) |
|
173 | - ); |
|
174 | - } |
|
175 | - |
|
176 | - /** |
|
177 | - * Returns the part of code useful when doing json serialization. |
|
178 | - * |
|
179 | - * @return string |
|
180 | - */ |
|
181 | - public function getJsonSerializeCode() |
|
182 | - { |
|
183 | - $type = $this->column->getType(); |
|
184 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
185 | - |
|
186 | - if ($normalizedType == '\\DateTimeInterface') { |
|
187 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = ($this->'.$this->getGetterName().'() === null)?null:$this->'.$this->getGetterName()."()->format('c');\n"; |
|
188 | - } else { |
|
189 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
190 | - } |
|
191 | - } |
|
192 | - |
|
193 | - /** |
|
194 | - * Returns the column name. |
|
195 | - * |
|
196 | - * @return string |
|
197 | - */ |
|
198 | - public function getColumnName() |
|
199 | - { |
|
200 | - return $this->column->getName(); |
|
201 | - } |
|
154 | + return sprintf($getterAndSetterCode, |
|
155 | + // Getter |
|
156 | + $this->column->getName(), |
|
157 | + $normalizedType.($canForceGetterReturnType ? '' : '|null'), |
|
158 | + $columnGetterName, |
|
159 | + ($canForceGetterReturnType ? ' : '.$normalizedType : ''), |
|
160 | + var_export($this->column->getName(), true), |
|
161 | + var_export($this->table->getName(), true), |
|
162 | + // Setter |
|
163 | + $this->column->getName(), |
|
164 | + $normalizedType, |
|
165 | + $this->column->getName(), |
|
166 | + $columnSetterName, |
|
167 | + $normalizedType, |
|
168 | + //$castTo, |
|
169 | + $this->column->getName().($this->column->getNotnull() ? '' : ' = null'), |
|
170 | + var_export($this->column->getName(), true), |
|
171 | + $this->column->getName(), |
|
172 | + var_export($this->table->getName(), true) |
|
173 | + ); |
|
174 | + } |
|
175 | + |
|
176 | + /** |
|
177 | + * Returns the part of code useful when doing json serialization. |
|
178 | + * |
|
179 | + * @return string |
|
180 | + */ |
|
181 | + public function getJsonSerializeCode() |
|
182 | + { |
|
183 | + $type = $this->column->getType(); |
|
184 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
185 | + |
|
186 | + if ($normalizedType == '\\DateTimeInterface') { |
|
187 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = ($this->'.$this->getGetterName().'() === null)?null:$this->'.$this->getGetterName()."()->format('c');\n"; |
|
188 | + } else { |
|
189 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
190 | + } |
|
191 | + } |
|
192 | + |
|
193 | + /** |
|
194 | + * Returns the column name. |
|
195 | + * |
|
196 | + * @return string |
|
197 | + */ |
|
198 | + public function getColumnName() |
|
199 | + { |
|
200 | + return $this->column->getName(); |
|
201 | + } |
|
202 | 202 | } |
@@ -27,170 +27,170 @@ discard block |
||
27 | 27 | */ |
28 | 28 | class DbRow |
29 | 29 | { |
30 | - /** |
|
31 | - * The service this object is bound to. |
|
32 | - * |
|
33 | - * @var TDBMService |
|
34 | - */ |
|
35 | - protected $tdbmService; |
|
36 | - |
|
37 | - /** |
|
38 | - * The object containing this db row. |
|
39 | - * |
|
40 | - * @var AbstractTDBMObject |
|
41 | - */ |
|
42 | - private $object; |
|
43 | - |
|
44 | - /** |
|
45 | - * The name of the table the object if issued from. |
|
46 | - * |
|
47 | - * @var string |
|
48 | - */ |
|
49 | - private $dbTableName; |
|
50 | - |
|
51 | - /** |
|
52 | - * The array of columns returned from database. |
|
53 | - * |
|
54 | - * @var array |
|
55 | - */ |
|
56 | - private $dbRow = array(); |
|
57 | - |
|
58 | - /** |
|
59 | - * @var AbstractTDBMObject[] |
|
60 | - */ |
|
61 | - private $references = array(); |
|
62 | - |
|
63 | - /** |
|
64 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
65 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
66 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
67 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
68 | - * |
|
69 | - * @var string |
|
70 | - */ |
|
71 | - private $status; |
|
72 | - |
|
73 | - /** |
|
74 | - * The values of the primary key. |
|
75 | - * This is set when the object is in "loaded" state. |
|
76 | - * |
|
77 | - * @var array An array of column => value |
|
78 | - */ |
|
79 | - private $primaryKeys; |
|
80 | - |
|
81 | - /** |
|
82 | - * You should never call the constructor directly. Instead, you should use the |
|
83 | - * TDBMService class that will create TDBMObjects for you. |
|
84 | - * |
|
85 | - * Used with id!=false when we want to retrieve an existing object |
|
86 | - * and id==false if we want a new object |
|
87 | - * |
|
88 | - * @param AbstractTDBMObject $object The object containing this db row |
|
89 | - * @param string $table_name |
|
90 | - * @param array $primaryKeys |
|
91 | - * @param TDBMService $tdbmService |
|
92 | - * |
|
93 | - * @throws TDBMException |
|
94 | - * @throws TDBMInvalidOperationException |
|
95 | - */ |
|
96 | - public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array()) |
|
97 | - { |
|
98 | - $this->object = $object; |
|
99 | - $this->dbTableName = $table_name; |
|
100 | - |
|
101 | - $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
102 | - |
|
103 | - if ($tdbmService === null) { |
|
104 | - if (!empty($primaryKeys)) { |
|
105 | - throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.'); |
|
106 | - } |
|
107 | - } else { |
|
108 | - $this->tdbmService = $tdbmService; |
|
109 | - |
|
110 | - if (!empty($primaryKeys)) { |
|
111 | - $this->_setPrimaryKeys($primaryKeys); |
|
112 | - if (!empty($dbRow)) { |
|
113 | - $this->dbRow = $dbRow; |
|
114 | - $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
115 | - } else { |
|
116 | - $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
117 | - } |
|
118 | - $tdbmService->_addToCache($this); |
|
119 | - } else { |
|
120 | - $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
121 | - $this->tdbmService->_addToToSaveObjectList($this); |
|
122 | - } |
|
123 | - } |
|
124 | - } |
|
125 | - |
|
126 | - public function _attach(TDBMService $tdbmService) |
|
127 | - { |
|
128 | - if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
129 | - throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
130 | - } |
|
131 | - $this->tdbmService = $tdbmService; |
|
132 | - $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
133 | - $this->tdbmService->_addToToSaveObjectList($this); |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Sets the state of the TDBM Object |
|
138 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
139 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
140 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
141 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
142 | - * |
|
143 | - * @param string $state |
|
144 | - */ |
|
145 | - public function _setStatus($state) |
|
146 | - { |
|
147 | - $this->status = $state; |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * This is an internal method. You should not call this method yourself. The TDBM library will do it for you. |
|
152 | - * If the object is in state 'not loaded', this method performs a query in database to load the object. |
|
153 | - * |
|
154 | - * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified |
|
155 | - * cannot be found). |
|
156 | - */ |
|
157 | - public function _dbLoadIfNotLoaded() |
|
158 | - { |
|
159 | - if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) { |
|
160 | - $connection = $this->tdbmService->getConnection(); |
|
161 | - |
|
162 | - /// buildFilterFromFilterBag($filter_bag) |
|
163 | - list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys); |
|
164 | - |
|
165 | - $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where; |
|
166 | - $result = $connection->executeQuery($sql, $parameters); |
|
167 | - |
|
168 | - if ($result->rowCount() === 0) { |
|
169 | - throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\"."); |
|
170 | - } |
|
171 | - |
|
172 | - $row = $result->fetch(\PDO::FETCH_ASSOC); |
|
173 | - |
|
174 | - $this->dbRow = []; |
|
175 | - $types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName); |
|
176 | - |
|
177 | - foreach ($row as $key => $value) { |
|
178 | - $this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform()); |
|
179 | - } |
|
180 | - |
|
181 | - $result->closeCursor(); |
|
182 | - |
|
183 | - $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
184 | - } |
|
185 | - } |
|
186 | - |
|
187 | - public function get($var) |
|
188 | - { |
|
189 | - $this->_dbLoadIfNotLoaded(); |
|
190 | - |
|
191 | - // Let's first check if the key exist. |
|
192 | - if (!isset($this->dbRow[$var])) { |
|
193 | - /* |
|
30 | + /** |
|
31 | + * The service this object is bound to. |
|
32 | + * |
|
33 | + * @var TDBMService |
|
34 | + */ |
|
35 | + protected $tdbmService; |
|
36 | + |
|
37 | + /** |
|
38 | + * The object containing this db row. |
|
39 | + * |
|
40 | + * @var AbstractTDBMObject |
|
41 | + */ |
|
42 | + private $object; |
|
43 | + |
|
44 | + /** |
|
45 | + * The name of the table the object if issued from. |
|
46 | + * |
|
47 | + * @var string |
|
48 | + */ |
|
49 | + private $dbTableName; |
|
50 | + |
|
51 | + /** |
|
52 | + * The array of columns returned from database. |
|
53 | + * |
|
54 | + * @var array |
|
55 | + */ |
|
56 | + private $dbRow = array(); |
|
57 | + |
|
58 | + /** |
|
59 | + * @var AbstractTDBMObject[] |
|
60 | + */ |
|
61 | + private $references = array(); |
|
62 | + |
|
63 | + /** |
|
64 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
65 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
66 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
67 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
68 | + * |
|
69 | + * @var string |
|
70 | + */ |
|
71 | + private $status; |
|
72 | + |
|
73 | + /** |
|
74 | + * The values of the primary key. |
|
75 | + * This is set when the object is in "loaded" state. |
|
76 | + * |
|
77 | + * @var array An array of column => value |
|
78 | + */ |
|
79 | + private $primaryKeys; |
|
80 | + |
|
81 | + /** |
|
82 | + * You should never call the constructor directly. Instead, you should use the |
|
83 | + * TDBMService class that will create TDBMObjects for you. |
|
84 | + * |
|
85 | + * Used with id!=false when we want to retrieve an existing object |
|
86 | + * and id==false if we want a new object |
|
87 | + * |
|
88 | + * @param AbstractTDBMObject $object The object containing this db row |
|
89 | + * @param string $table_name |
|
90 | + * @param array $primaryKeys |
|
91 | + * @param TDBMService $tdbmService |
|
92 | + * |
|
93 | + * @throws TDBMException |
|
94 | + * @throws TDBMInvalidOperationException |
|
95 | + */ |
|
96 | + public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array()) |
|
97 | + { |
|
98 | + $this->object = $object; |
|
99 | + $this->dbTableName = $table_name; |
|
100 | + |
|
101 | + $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
102 | + |
|
103 | + if ($tdbmService === null) { |
|
104 | + if (!empty($primaryKeys)) { |
|
105 | + throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.'); |
|
106 | + } |
|
107 | + } else { |
|
108 | + $this->tdbmService = $tdbmService; |
|
109 | + |
|
110 | + if (!empty($primaryKeys)) { |
|
111 | + $this->_setPrimaryKeys($primaryKeys); |
|
112 | + if (!empty($dbRow)) { |
|
113 | + $this->dbRow = $dbRow; |
|
114 | + $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
115 | + } else { |
|
116 | + $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
117 | + } |
|
118 | + $tdbmService->_addToCache($this); |
|
119 | + } else { |
|
120 | + $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
121 | + $this->tdbmService->_addToToSaveObjectList($this); |
|
122 | + } |
|
123 | + } |
|
124 | + } |
|
125 | + |
|
126 | + public function _attach(TDBMService $tdbmService) |
|
127 | + { |
|
128 | + if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
129 | + throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
130 | + } |
|
131 | + $this->tdbmService = $tdbmService; |
|
132 | + $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
133 | + $this->tdbmService->_addToToSaveObjectList($this); |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Sets the state of the TDBM Object |
|
138 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
139 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
140 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
141 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
142 | + * |
|
143 | + * @param string $state |
|
144 | + */ |
|
145 | + public function _setStatus($state) |
|
146 | + { |
|
147 | + $this->status = $state; |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * This is an internal method. You should not call this method yourself. The TDBM library will do it for you. |
|
152 | + * If the object is in state 'not loaded', this method performs a query in database to load the object. |
|
153 | + * |
|
154 | + * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified |
|
155 | + * cannot be found). |
|
156 | + */ |
|
157 | + public function _dbLoadIfNotLoaded() |
|
158 | + { |
|
159 | + if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) { |
|
160 | + $connection = $this->tdbmService->getConnection(); |
|
161 | + |
|
162 | + /// buildFilterFromFilterBag($filter_bag) |
|
163 | + list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys); |
|
164 | + |
|
165 | + $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where; |
|
166 | + $result = $connection->executeQuery($sql, $parameters); |
|
167 | + |
|
168 | + if ($result->rowCount() === 0) { |
|
169 | + throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\"."); |
|
170 | + } |
|
171 | + |
|
172 | + $row = $result->fetch(\PDO::FETCH_ASSOC); |
|
173 | + |
|
174 | + $this->dbRow = []; |
|
175 | + $types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName); |
|
176 | + |
|
177 | + foreach ($row as $key => $value) { |
|
178 | + $this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform()); |
|
179 | + } |
|
180 | + |
|
181 | + $result->closeCursor(); |
|
182 | + |
|
183 | + $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
184 | + } |
|
185 | + } |
|
186 | + |
|
187 | + public function get($var) |
|
188 | + { |
|
189 | + $this->_dbLoadIfNotLoaded(); |
|
190 | + |
|
191 | + // Let's first check if the key exist. |
|
192 | + if (!isset($this->dbRow[$var])) { |
|
193 | + /* |
|
194 | 194 | // Unable to find column.... this is an error if the object has been retrieved from database. |
195 | 195 | // If it's a new object, well, that may not be an error after all! |
196 | 196 | // Let's check if the column does exist in the table |
@@ -210,39 +210,39 @@ discard block |
||
210 | 210 | $str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'"; |
211 | 211 | |
212 | 212 | throw new TDBMException($str);*/ |
213 | - return; |
|
214 | - } |
|
215 | - |
|
216 | - $value = $this->dbRow[$var]; |
|
217 | - if ($value instanceof \DateTime) { |
|
218 | - if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only |
|
219 | - return \DateTimeImmutable::createFromMutable($value); |
|
220 | - } else { |
|
221 | - return new \DateTimeImmutable($value->format('c')); |
|
222 | - } |
|
223 | - } |
|
224 | - |
|
225 | - return $this->dbRow[$var]; |
|
226 | - } |
|
227 | - |
|
228 | - /** |
|
229 | - * Returns true if a column is set, false otherwise. |
|
230 | - * |
|
231 | - * @param string $var |
|
232 | - * |
|
233 | - * @return bool |
|
234 | - */ |
|
235 | - /*public function has($var) { |
|
213 | + return; |
|
214 | + } |
|
215 | + |
|
216 | + $value = $this->dbRow[$var]; |
|
217 | + if ($value instanceof \DateTime) { |
|
218 | + if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only |
|
219 | + return \DateTimeImmutable::createFromMutable($value); |
|
220 | + } else { |
|
221 | + return new \DateTimeImmutable($value->format('c')); |
|
222 | + } |
|
223 | + } |
|
224 | + |
|
225 | + return $this->dbRow[$var]; |
|
226 | + } |
|
227 | + |
|
228 | + /** |
|
229 | + * Returns true if a column is set, false otherwise. |
|
230 | + * |
|
231 | + * @param string $var |
|
232 | + * |
|
233 | + * @return bool |
|
234 | + */ |
|
235 | + /*public function has($var) { |
|
236 | 236 | $this->_dbLoadIfNotLoaded(); |
237 | 237 | |
238 | 238 | return isset($this->dbRow[$var]); |
239 | 239 | }*/ |
240 | 240 | |
241 | - public function set($var, $value) |
|
242 | - { |
|
243 | - $this->_dbLoadIfNotLoaded(); |
|
241 | + public function set($var, $value) |
|
242 | + { |
|
243 | + $this->_dbLoadIfNotLoaded(); |
|
244 | 244 | |
245 | - /* |
|
245 | + /* |
|
246 | 246 | // Ok, let's start by checking the column type |
247 | 247 | $type = $this->db_connection->getColumnType($this->dbTableName, $var); |
248 | 248 | |
@@ -252,193 +252,193 @@ discard block |
||
252 | 252 | } |
253 | 253 | */ |
254 | 254 | |
255 | - /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var])) |
|
255 | + /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var])) |
|
256 | 256 | throw new TDBMException("Error! Changing primary key value is forbidden.");*/ |
257 | - $this->dbRow[$var] = $value; |
|
258 | - if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
259 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
260 | - $this->tdbmService->_addToToSaveObjectList($this); |
|
261 | - } |
|
262 | - } |
|
263 | - |
|
264 | - /** |
|
265 | - * @param string $foreignKeyName |
|
266 | - * @param AbstractTDBMObject $bean |
|
267 | - */ |
|
268 | - public function setRef($foreignKeyName, AbstractTDBMObject $bean = null) |
|
269 | - { |
|
270 | - $this->references[$foreignKeyName] = $bean; |
|
271 | - |
|
272 | - if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
273 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
274 | - $this->tdbmService->_addToToSaveObjectList($this); |
|
275 | - } |
|
276 | - } |
|
277 | - |
|
278 | - /** |
|
279 | - * @param string $foreignKeyName A unique name for this reference |
|
280 | - * |
|
281 | - * @return AbstractTDBMObject|null |
|
282 | - */ |
|
283 | - public function getRef($foreignKeyName) |
|
284 | - { |
|
285 | - if (array_key_exists($foreignKeyName, $this->references)) { |
|
286 | - return $this->references[$foreignKeyName]; |
|
287 | - } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->tdbmService === null) { |
|
288 | - // If the object is new and has no property, then it has to be empty. |
|
289 | - return; |
|
290 | - } else { |
|
291 | - $this->_dbLoadIfNotLoaded(); |
|
292 | - |
|
293 | - // Let's match the name of the columns to the primary key values |
|
294 | - $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName); |
|
295 | - |
|
296 | - $values = []; |
|
297 | - foreach ($fk->getLocalColumns() as $column) { |
|
298 | - if (!isset($this->dbRow[$column])) { |
|
299 | - return; |
|
300 | - } |
|
301 | - $values[] = $this->dbRow[$column]; |
|
302 | - } |
|
303 | - |
|
304 | - $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values); |
|
305 | - |
|
306 | - return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true); |
|
307 | - } |
|
308 | - } |
|
309 | - |
|
310 | - /** |
|
311 | - * Returns the name of the table this object comes from. |
|
312 | - * |
|
313 | - * @return string |
|
314 | - */ |
|
315 | - public function _getDbTableName() |
|
316 | - { |
|
317 | - return $this->dbTableName; |
|
318 | - } |
|
319 | - |
|
320 | - /** |
|
321 | - * Method used internally by TDBM. You should not use it directly. |
|
322 | - * This method returns the status of the TDBMObject. |
|
323 | - * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
324 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
325 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
326 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
327 | - * |
|
328 | - * @return string |
|
329 | - */ |
|
330 | - public function _getStatus() |
|
331 | - { |
|
332 | - return $this->status; |
|
333 | - } |
|
334 | - |
|
335 | - /** |
|
336 | - * Override the native php clone function for TDBMObjects. |
|
337 | - */ |
|
338 | - public function __clone() |
|
339 | - { |
|
340 | - // Let's load the row (before we lose the ID!) |
|
341 | - $this->_dbLoadIfNotLoaded(); |
|
342 | - |
|
343 | - //Let's set the status to detached |
|
344 | - $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
345 | - |
|
346 | - $this->primaryKeys = []; |
|
347 | - |
|
348 | - //Now unset the PK from the row |
|
349 | - if ($this->tdbmService) { |
|
350 | - $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName); |
|
351 | - foreach ($pk_array as $pk) { |
|
352 | - $this->dbRow[$pk] = null; |
|
353 | - } |
|
354 | - } |
|
355 | - } |
|
356 | - |
|
357 | - /** |
|
358 | - * Returns raw database row. |
|
359 | - * |
|
360 | - * @return array |
|
361 | - */ |
|
362 | - public function _getDbRow() |
|
363 | - { |
|
364 | - // Let's merge $dbRow and $references |
|
365 | - $dbRow = $this->dbRow; |
|
366 | - |
|
367 | - foreach ($this->references as $foreignKeyName => $reference) { |
|
368 | - // Let's match the name of the columns to the primary key values |
|
369 | - $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName); |
|
370 | - $localColumns = $fk->getLocalColumns(); |
|
371 | - |
|
372 | - if ($reference !== null) { |
|
373 | - $refDbRows = $reference->_getDbRows(); |
|
374 | - $firstRefDbRow = reset($refDbRows); |
|
375 | - $pkValues = array_values($firstRefDbRow->_getPrimaryKeys()); |
|
376 | - for ($i = 0, $count = count($localColumns); $i < $count; ++$i) { |
|
377 | - $dbRow[$localColumns[$i]] = $pkValues[$i]; |
|
378 | - } |
|
379 | - } else { |
|
380 | - for ($i = 0, $count = count($localColumns); $i < $count; ++$i) { |
|
381 | - $dbRow[$localColumns[$i]] = null; |
|
382 | - } |
|
383 | - } |
|
384 | - } |
|
385 | - |
|
386 | - return $dbRow; |
|
387 | - } |
|
388 | - |
|
389 | - /** |
|
390 | - * Returns references array. |
|
391 | - * |
|
392 | - * @return AbstractTDBMObject[] |
|
393 | - */ |
|
394 | - public function _getReferences() |
|
395 | - { |
|
396 | - return $this->references; |
|
397 | - } |
|
398 | - |
|
399 | - /** |
|
400 | - * Returns the values of the primary key. |
|
401 | - * This is set when the object is in "loaded" state. |
|
402 | - * |
|
403 | - * @return array |
|
404 | - */ |
|
405 | - public function _getPrimaryKeys() |
|
406 | - { |
|
407 | - return $this->primaryKeys; |
|
408 | - } |
|
409 | - |
|
410 | - /** |
|
411 | - * Sets the values of the primary key. |
|
412 | - * This is set when the object is in "loaded" state. |
|
413 | - * |
|
414 | - * @param array $primaryKeys |
|
415 | - */ |
|
416 | - public function _setPrimaryKeys(array $primaryKeys) |
|
417 | - { |
|
418 | - $this->primaryKeys = $primaryKeys; |
|
419 | - foreach ($this->primaryKeys as $column => $value) { |
|
420 | - $this->dbRow[$column] = $value; |
|
421 | - } |
|
422 | - } |
|
423 | - |
|
424 | - /** |
|
425 | - * Returns the TDBMObject this bean is associated to. |
|
426 | - * |
|
427 | - * @return AbstractTDBMObject |
|
428 | - */ |
|
429 | - public function getTDBMObject() |
|
430 | - { |
|
431 | - return $this->object; |
|
432 | - } |
|
433 | - |
|
434 | - /** |
|
435 | - * Sets the TDBMObject this bean is associated to. |
|
436 | - * Only used when cloning. |
|
437 | - * |
|
438 | - * @param AbstractTDBMObject $object |
|
439 | - */ |
|
440 | - public function setTDBMObject(AbstractTDBMObject $object) |
|
441 | - { |
|
442 | - $this->object = $object; |
|
443 | - } |
|
257 | + $this->dbRow[$var] = $value; |
|
258 | + if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
259 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
260 | + $this->tdbmService->_addToToSaveObjectList($this); |
|
261 | + } |
|
262 | + } |
|
263 | + |
|
264 | + /** |
|
265 | + * @param string $foreignKeyName |
|
266 | + * @param AbstractTDBMObject $bean |
|
267 | + */ |
|
268 | + public function setRef($foreignKeyName, AbstractTDBMObject $bean = null) |
|
269 | + { |
|
270 | + $this->references[$foreignKeyName] = $bean; |
|
271 | + |
|
272 | + if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
273 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
274 | + $this->tdbmService->_addToToSaveObjectList($this); |
|
275 | + } |
|
276 | + } |
|
277 | + |
|
278 | + /** |
|
279 | + * @param string $foreignKeyName A unique name for this reference |
|
280 | + * |
|
281 | + * @return AbstractTDBMObject|null |
|
282 | + */ |
|
283 | + public function getRef($foreignKeyName) |
|
284 | + { |
|
285 | + if (array_key_exists($foreignKeyName, $this->references)) { |
|
286 | + return $this->references[$foreignKeyName]; |
|
287 | + } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->tdbmService === null) { |
|
288 | + // If the object is new and has no property, then it has to be empty. |
|
289 | + return; |
|
290 | + } else { |
|
291 | + $this->_dbLoadIfNotLoaded(); |
|
292 | + |
|
293 | + // Let's match the name of the columns to the primary key values |
|
294 | + $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName); |
|
295 | + |
|
296 | + $values = []; |
|
297 | + foreach ($fk->getLocalColumns() as $column) { |
|
298 | + if (!isset($this->dbRow[$column])) { |
|
299 | + return; |
|
300 | + } |
|
301 | + $values[] = $this->dbRow[$column]; |
|
302 | + } |
|
303 | + |
|
304 | + $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values); |
|
305 | + |
|
306 | + return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true); |
|
307 | + } |
|
308 | + } |
|
309 | + |
|
310 | + /** |
|
311 | + * Returns the name of the table this object comes from. |
|
312 | + * |
|
313 | + * @return string |
|
314 | + */ |
|
315 | + public function _getDbTableName() |
|
316 | + { |
|
317 | + return $this->dbTableName; |
|
318 | + } |
|
319 | + |
|
320 | + /** |
|
321 | + * Method used internally by TDBM. You should not use it directly. |
|
322 | + * This method returns the status of the TDBMObject. |
|
323 | + * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
324 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
325 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
326 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
327 | + * |
|
328 | + * @return string |
|
329 | + */ |
|
330 | + public function _getStatus() |
|
331 | + { |
|
332 | + return $this->status; |
|
333 | + } |
|
334 | + |
|
335 | + /** |
|
336 | + * Override the native php clone function for TDBMObjects. |
|
337 | + */ |
|
338 | + public function __clone() |
|
339 | + { |
|
340 | + // Let's load the row (before we lose the ID!) |
|
341 | + $this->_dbLoadIfNotLoaded(); |
|
342 | + |
|
343 | + //Let's set the status to detached |
|
344 | + $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
345 | + |
|
346 | + $this->primaryKeys = []; |
|
347 | + |
|
348 | + //Now unset the PK from the row |
|
349 | + if ($this->tdbmService) { |
|
350 | + $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName); |
|
351 | + foreach ($pk_array as $pk) { |
|
352 | + $this->dbRow[$pk] = null; |
|
353 | + } |
|
354 | + } |
|
355 | + } |
|
356 | + |
|
357 | + /** |
|
358 | + * Returns raw database row. |
|
359 | + * |
|
360 | + * @return array |
|
361 | + */ |
|
362 | + public function _getDbRow() |
|
363 | + { |
|
364 | + // Let's merge $dbRow and $references |
|
365 | + $dbRow = $this->dbRow; |
|
366 | + |
|
367 | + foreach ($this->references as $foreignKeyName => $reference) { |
|
368 | + // Let's match the name of the columns to the primary key values |
|
369 | + $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName); |
|
370 | + $localColumns = $fk->getLocalColumns(); |
|
371 | + |
|
372 | + if ($reference !== null) { |
|
373 | + $refDbRows = $reference->_getDbRows(); |
|
374 | + $firstRefDbRow = reset($refDbRows); |
|
375 | + $pkValues = array_values($firstRefDbRow->_getPrimaryKeys()); |
|
376 | + for ($i = 0, $count = count($localColumns); $i < $count; ++$i) { |
|
377 | + $dbRow[$localColumns[$i]] = $pkValues[$i]; |
|
378 | + } |
|
379 | + } else { |
|
380 | + for ($i = 0, $count = count($localColumns); $i < $count; ++$i) { |
|
381 | + $dbRow[$localColumns[$i]] = null; |
|
382 | + } |
|
383 | + } |
|
384 | + } |
|
385 | + |
|
386 | + return $dbRow; |
|
387 | + } |
|
388 | + |
|
389 | + /** |
|
390 | + * Returns references array. |
|
391 | + * |
|
392 | + * @return AbstractTDBMObject[] |
|
393 | + */ |
|
394 | + public function _getReferences() |
|
395 | + { |
|
396 | + return $this->references; |
|
397 | + } |
|
398 | + |
|
399 | + /** |
|
400 | + * Returns the values of the primary key. |
|
401 | + * This is set when the object is in "loaded" state. |
|
402 | + * |
|
403 | + * @return array |
|
404 | + */ |
|
405 | + public function _getPrimaryKeys() |
|
406 | + { |
|
407 | + return $this->primaryKeys; |
|
408 | + } |
|
409 | + |
|
410 | + /** |
|
411 | + * Sets the values of the primary key. |
|
412 | + * This is set when the object is in "loaded" state. |
|
413 | + * |
|
414 | + * @param array $primaryKeys |
|
415 | + */ |
|
416 | + public function _setPrimaryKeys(array $primaryKeys) |
|
417 | + { |
|
418 | + $this->primaryKeys = $primaryKeys; |
|
419 | + foreach ($this->primaryKeys as $column => $value) { |
|
420 | + $this->dbRow[$column] = $value; |
|
421 | + } |
|
422 | + } |
|
423 | + |
|
424 | + /** |
|
425 | + * Returns the TDBMObject this bean is associated to. |
|
426 | + * |
|
427 | + * @return AbstractTDBMObject |
|
428 | + */ |
|
429 | + public function getTDBMObject() |
|
430 | + { |
|
431 | + return $this->object; |
|
432 | + } |
|
433 | + |
|
434 | + /** |
|
435 | + * Sets the TDBMObject this bean is associated to. |
|
436 | + * Only used when cloning. |
|
437 | + * |
|
438 | + * @param AbstractTDBMObject $object |
|
439 | + */ |
|
440 | + public function setTDBMObject(AbstractTDBMObject $object) |
|
441 | + { |
|
442 | + $this->object = $object; |
|
443 | + } |
|
444 | 444 | } |
@@ -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 | } |
@@ -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 | } |
@@ -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 | } |
@@ -31,243 +31,243 @@ |
||
31 | 31 | */ |
32 | 32 | class ResultIterator implements Result, \ArrayAccess, \JsonSerializable |
33 | 33 | { |
34 | - /** |
|
35 | - * @var Statement |
|
36 | - */ |
|
37 | - protected $statement; |
|
38 | - |
|
39 | - protected $fetchStarted = false; |
|
40 | - private $objectStorage; |
|
41 | - private $className; |
|
42 | - |
|
43 | - private $tdbmService; |
|
44 | - private $magicSql; |
|
45 | - private $magicSqlCount; |
|
46 | - private $parameters; |
|
47 | - private $columnDescriptors; |
|
48 | - private $magicQuery; |
|
49 | - |
|
50 | - /** |
|
51 | - * @var InnerResultIterator |
|
52 | - */ |
|
53 | - private $innerResultIterator; |
|
54 | - |
|
55 | - /** |
|
56 | - * The key of the current retrieved object. |
|
57 | - * |
|
58 | - * @var int |
|
59 | - */ |
|
60 | - protected $key = -1; |
|
61 | - |
|
62 | - protected $current = null; |
|
63 | - |
|
64 | - private $databasePlatform; |
|
65 | - |
|
66 | - private $totalCount; |
|
67 | - |
|
68 | - private $mode; |
|
69 | - |
|
70 | - private $logger; |
|
71 | - |
|
72 | - public function __construct($magicSql, $magicSqlCount, array $parameters, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode, LoggerInterface $logger) |
|
73 | - { |
|
74 | - $this->magicSql = $magicSql; |
|
75 | - $this->magicSqlCount = $magicSqlCount; |
|
76 | - $this->objectStorage = $objectStorage; |
|
77 | - $this->className = $className; |
|
78 | - $this->tdbmService = $tdbmService; |
|
79 | - $this->parameters = $parameters; |
|
80 | - $this->columnDescriptors = $columnDescriptors; |
|
81 | - $this->magicQuery = $magicQuery; |
|
82 | - $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
83 | - $this->mode = $mode; |
|
84 | - $this->logger = $logger; |
|
85 | - } |
|
86 | - |
|
87 | - protected function executeCountQuery() |
|
88 | - { |
|
89 | - $sql = $this->magicQuery->build($this->magicSqlCount, $this->parameters); |
|
90 | - $this->logger->debug('Running count query: '.$sql); |
|
91 | - $this->totalCount = $this->tdbmService->getConnection()->fetchColumn($sql, $this->parameters); |
|
92 | - } |
|
93 | - |
|
94 | - /** |
|
95 | - * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings). |
|
96 | - * |
|
97 | - * @return int |
|
98 | - */ |
|
99 | - public function count() |
|
100 | - { |
|
101 | - if ($this->totalCount === null) { |
|
102 | - $this->executeCountQuery(); |
|
103 | - } |
|
104 | - |
|
105 | - return $this->totalCount; |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * Casts the result set to a PHP array. |
|
110 | - * |
|
111 | - * @return array |
|
112 | - */ |
|
113 | - public function toArray() |
|
114 | - { |
|
115 | - return iterator_to_array($this->getIterator()); |
|
116 | - } |
|
117 | - |
|
118 | - /** |
|
119 | - * Returns a new iterator mapping any call using the $callable function. |
|
120 | - * |
|
121 | - * @param callable $callable |
|
122 | - * |
|
123 | - * @return MapIterator |
|
124 | - */ |
|
125 | - public function map(callable $callable) |
|
126 | - { |
|
127 | - return new MapIterator($this->getIterator(), $callable); |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * Retrieve an external iterator. |
|
132 | - * |
|
133 | - * @link http://php.net/manual/en/iteratoraggregate.getiterator.php |
|
134 | - * |
|
135 | - * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or |
|
136 | - * <b>Traversable</b> |
|
137 | - * |
|
138 | - * @since 5.0.0 |
|
139 | - */ |
|
140 | - public function getIterator() |
|
141 | - { |
|
142 | - if ($this->innerResultIterator === null) { |
|
143 | - if ($this->mode === TDBMService::MODE_CURSOR) { |
|
144 | - $this->innerResultIterator = new InnerResultIterator($this->magicSql, $this->parameters, null, null, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger); |
|
145 | - } else { |
|
146 | - $this->innerResultIterator = new InnerResultArray($this->magicSql, $this->parameters, null, null, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger); |
|
147 | - } |
|
148 | - } |
|
149 | - |
|
150 | - return $this->innerResultIterator; |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * @param int $offset |
|
155 | - * |
|
156 | - * @return PageIterator |
|
157 | - */ |
|
158 | - public function take($offset, $limit) |
|
159 | - { |
|
160 | - return new PageIterator($this, $this->magicSql, $this->parameters, $limit, $offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->mode, $this->logger); |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Whether a offset exists. |
|
165 | - * |
|
166 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
167 | - * |
|
168 | - * @param mixed $offset <p> |
|
169 | - * An offset to check for. |
|
170 | - * </p> |
|
171 | - * |
|
172 | - * @return bool true on success or false on failure. |
|
173 | - * </p> |
|
174 | - * <p> |
|
175 | - * The return value will be casted to boolean if non-boolean was returned |
|
176 | - * |
|
177 | - * @since 5.0.0 |
|
178 | - */ |
|
179 | - public function offsetExists($offset) |
|
180 | - { |
|
181 | - return $this->getIterator()->offsetExists($offset); |
|
182 | - } |
|
183 | - |
|
184 | - /** |
|
185 | - * Offset to retrieve. |
|
186 | - * |
|
187 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
188 | - * |
|
189 | - * @param mixed $offset <p> |
|
190 | - * The offset to retrieve. |
|
191 | - * </p> |
|
192 | - * |
|
193 | - * @return mixed Can return all value types |
|
194 | - * |
|
195 | - * @since 5.0.0 |
|
196 | - */ |
|
197 | - public function offsetGet($offset) |
|
198 | - { |
|
199 | - return $this->getIterator()->offsetGet($offset); |
|
200 | - } |
|
201 | - |
|
202 | - /** |
|
203 | - * Offset to set. |
|
204 | - * |
|
205 | - * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
206 | - * |
|
207 | - * @param mixed $offset <p> |
|
208 | - * The offset to assign the value to. |
|
209 | - * </p> |
|
210 | - * @param mixed $value <p> |
|
211 | - * The value to set. |
|
212 | - * </p> |
|
213 | - * |
|
214 | - * @since 5.0.0 |
|
215 | - */ |
|
216 | - public function offsetSet($offset, $value) |
|
217 | - { |
|
218 | - return $this->getIterator()->offsetSet($offset, $value); |
|
219 | - } |
|
220 | - |
|
221 | - /** |
|
222 | - * Offset to unset. |
|
223 | - * |
|
224 | - * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
225 | - * |
|
226 | - * @param mixed $offset <p> |
|
227 | - * The offset to unset. |
|
228 | - * </p> |
|
229 | - * |
|
230 | - * @since 5.0.0 |
|
231 | - */ |
|
232 | - public function offsetUnset($offset) |
|
233 | - { |
|
234 | - return $this->getIterator()->offsetUnset($offset); |
|
235 | - } |
|
236 | - |
|
237 | - /** |
|
238 | - * Specify data which should be serialized to JSON. |
|
239 | - * |
|
240 | - * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
241 | - * |
|
242 | - * @param bool $stopRecursion Parameter used internally by TDBM to |
|
243 | - * stop embedded objects from embedding |
|
244 | - * other objects |
|
245 | - * |
|
246 | - * @return mixed data which can be serialized by <b>json_encode</b>, |
|
247 | - * which is a value of any type other than a resource |
|
248 | - * |
|
249 | - * @since 5.4.0 |
|
250 | - */ |
|
251 | - public function jsonSerialize($stopRecursion = false) |
|
252 | - { |
|
253 | - return array_map(function (AbstractTDBMObject $item) use ($stopRecursion) { |
|
254 | - return $item->jsonSerialize($stopRecursion); |
|
255 | - }, $this->toArray()); |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * Returns only one value (the first) of the result set. |
|
260 | - * Returns null if no value exists. |
|
261 | - * |
|
262 | - * @return mixed|null |
|
263 | - */ |
|
264 | - public function first() |
|
265 | - { |
|
266 | - $page = $this->take(0, 1); |
|
267 | - foreach ($page as $bean) { |
|
268 | - return $bean; |
|
269 | - } |
|
270 | - |
|
271 | - return; |
|
272 | - } |
|
34 | + /** |
|
35 | + * @var Statement |
|
36 | + */ |
|
37 | + protected $statement; |
|
38 | + |
|
39 | + protected $fetchStarted = false; |
|
40 | + private $objectStorage; |
|
41 | + private $className; |
|
42 | + |
|
43 | + private $tdbmService; |
|
44 | + private $magicSql; |
|
45 | + private $magicSqlCount; |
|
46 | + private $parameters; |
|
47 | + private $columnDescriptors; |
|
48 | + private $magicQuery; |
|
49 | + |
|
50 | + /** |
|
51 | + * @var InnerResultIterator |
|
52 | + */ |
|
53 | + private $innerResultIterator; |
|
54 | + |
|
55 | + /** |
|
56 | + * The key of the current retrieved object. |
|
57 | + * |
|
58 | + * @var int |
|
59 | + */ |
|
60 | + protected $key = -1; |
|
61 | + |
|
62 | + protected $current = null; |
|
63 | + |
|
64 | + private $databasePlatform; |
|
65 | + |
|
66 | + private $totalCount; |
|
67 | + |
|
68 | + private $mode; |
|
69 | + |
|
70 | + private $logger; |
|
71 | + |
|
72 | + public function __construct($magicSql, $magicSqlCount, array $parameters, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode, LoggerInterface $logger) |
|
73 | + { |
|
74 | + $this->magicSql = $magicSql; |
|
75 | + $this->magicSqlCount = $magicSqlCount; |
|
76 | + $this->objectStorage = $objectStorage; |
|
77 | + $this->className = $className; |
|
78 | + $this->tdbmService = $tdbmService; |
|
79 | + $this->parameters = $parameters; |
|
80 | + $this->columnDescriptors = $columnDescriptors; |
|
81 | + $this->magicQuery = $magicQuery; |
|
82 | + $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
83 | + $this->mode = $mode; |
|
84 | + $this->logger = $logger; |
|
85 | + } |
|
86 | + |
|
87 | + protected function executeCountQuery() |
|
88 | + { |
|
89 | + $sql = $this->magicQuery->build($this->magicSqlCount, $this->parameters); |
|
90 | + $this->logger->debug('Running count query: '.$sql); |
|
91 | + $this->totalCount = $this->tdbmService->getConnection()->fetchColumn($sql, $this->parameters); |
|
92 | + } |
|
93 | + |
|
94 | + /** |
|
95 | + * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings). |
|
96 | + * |
|
97 | + * @return int |
|
98 | + */ |
|
99 | + public function count() |
|
100 | + { |
|
101 | + if ($this->totalCount === null) { |
|
102 | + $this->executeCountQuery(); |
|
103 | + } |
|
104 | + |
|
105 | + return $this->totalCount; |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * Casts the result set to a PHP array. |
|
110 | + * |
|
111 | + * @return array |
|
112 | + */ |
|
113 | + public function toArray() |
|
114 | + { |
|
115 | + return iterator_to_array($this->getIterator()); |
|
116 | + } |
|
117 | + |
|
118 | + /** |
|
119 | + * Returns a new iterator mapping any call using the $callable function. |
|
120 | + * |
|
121 | + * @param callable $callable |
|
122 | + * |
|
123 | + * @return MapIterator |
|
124 | + */ |
|
125 | + public function map(callable $callable) |
|
126 | + { |
|
127 | + return new MapIterator($this->getIterator(), $callable); |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * Retrieve an external iterator. |
|
132 | + * |
|
133 | + * @link http://php.net/manual/en/iteratoraggregate.getiterator.php |
|
134 | + * |
|
135 | + * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or |
|
136 | + * <b>Traversable</b> |
|
137 | + * |
|
138 | + * @since 5.0.0 |
|
139 | + */ |
|
140 | + public function getIterator() |
|
141 | + { |
|
142 | + if ($this->innerResultIterator === null) { |
|
143 | + if ($this->mode === TDBMService::MODE_CURSOR) { |
|
144 | + $this->innerResultIterator = new InnerResultIterator($this->magicSql, $this->parameters, null, null, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger); |
|
145 | + } else { |
|
146 | + $this->innerResultIterator = new InnerResultArray($this->magicSql, $this->parameters, null, null, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger); |
|
147 | + } |
|
148 | + } |
|
149 | + |
|
150 | + return $this->innerResultIterator; |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * @param int $offset |
|
155 | + * |
|
156 | + * @return PageIterator |
|
157 | + */ |
|
158 | + public function take($offset, $limit) |
|
159 | + { |
|
160 | + return new PageIterator($this, $this->magicSql, $this->parameters, $limit, $offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->mode, $this->logger); |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Whether a offset exists. |
|
165 | + * |
|
166 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
167 | + * |
|
168 | + * @param mixed $offset <p> |
|
169 | + * An offset to check for. |
|
170 | + * </p> |
|
171 | + * |
|
172 | + * @return bool true on success or false on failure. |
|
173 | + * </p> |
|
174 | + * <p> |
|
175 | + * The return value will be casted to boolean if non-boolean was returned |
|
176 | + * |
|
177 | + * @since 5.0.0 |
|
178 | + */ |
|
179 | + public function offsetExists($offset) |
|
180 | + { |
|
181 | + return $this->getIterator()->offsetExists($offset); |
|
182 | + } |
|
183 | + |
|
184 | + /** |
|
185 | + * Offset to retrieve. |
|
186 | + * |
|
187 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
188 | + * |
|
189 | + * @param mixed $offset <p> |
|
190 | + * The offset to retrieve. |
|
191 | + * </p> |
|
192 | + * |
|
193 | + * @return mixed Can return all value types |
|
194 | + * |
|
195 | + * @since 5.0.0 |
|
196 | + */ |
|
197 | + public function offsetGet($offset) |
|
198 | + { |
|
199 | + return $this->getIterator()->offsetGet($offset); |
|
200 | + } |
|
201 | + |
|
202 | + /** |
|
203 | + * Offset to set. |
|
204 | + * |
|
205 | + * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
206 | + * |
|
207 | + * @param mixed $offset <p> |
|
208 | + * The offset to assign the value to. |
|
209 | + * </p> |
|
210 | + * @param mixed $value <p> |
|
211 | + * The value to set. |
|
212 | + * </p> |
|
213 | + * |
|
214 | + * @since 5.0.0 |
|
215 | + */ |
|
216 | + public function offsetSet($offset, $value) |
|
217 | + { |
|
218 | + return $this->getIterator()->offsetSet($offset, $value); |
|
219 | + } |
|
220 | + |
|
221 | + /** |
|
222 | + * Offset to unset. |
|
223 | + * |
|
224 | + * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
225 | + * |
|
226 | + * @param mixed $offset <p> |
|
227 | + * The offset to unset. |
|
228 | + * </p> |
|
229 | + * |
|
230 | + * @since 5.0.0 |
|
231 | + */ |
|
232 | + public function offsetUnset($offset) |
|
233 | + { |
|
234 | + return $this->getIterator()->offsetUnset($offset); |
|
235 | + } |
|
236 | + |
|
237 | + /** |
|
238 | + * Specify data which should be serialized to JSON. |
|
239 | + * |
|
240 | + * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
241 | + * |
|
242 | + * @param bool $stopRecursion Parameter used internally by TDBM to |
|
243 | + * stop embedded objects from embedding |
|
244 | + * other objects |
|
245 | + * |
|
246 | + * @return mixed data which can be serialized by <b>json_encode</b>, |
|
247 | + * which is a value of any type other than a resource |
|
248 | + * |
|
249 | + * @since 5.4.0 |
|
250 | + */ |
|
251 | + public function jsonSerialize($stopRecursion = false) |
|
252 | + { |
|
253 | + return array_map(function (AbstractTDBMObject $item) use ($stopRecursion) { |
|
254 | + return $item->jsonSerialize($stopRecursion); |
|
255 | + }, $this->toArray()); |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * Returns only one value (the first) of the result set. |
|
260 | + * Returns null if no value exists. |
|
261 | + * |
|
262 | + * @return mixed|null |
|
263 | + */ |
|
264 | + public function first() |
|
265 | + { |
|
266 | + $page = $this->take(0, 1); |
|
267 | + foreach ($page as $bean) { |
|
268 | + return $bean; |
|
269 | + } |
|
270 | + |
|
271 | + return; |
|
272 | + } |
|
273 | 273 | } |
@@ -27,100 +27,100 @@ |
||
27 | 27 | */ |
28 | 28 | class InnerResultArray extends InnerResultIterator |
29 | 29 | { |
30 | - /** |
|
31 | - * The list of results already fetched. |
|
32 | - * |
|
33 | - * @var AbstractTDBMObject[] |
|
34 | - */ |
|
35 | - private $results = []; |
|
30 | + /** |
|
31 | + * The list of results already fetched. |
|
32 | + * |
|
33 | + * @var AbstractTDBMObject[] |
|
34 | + */ |
|
35 | + private $results = []; |
|
36 | 36 | |
37 | - /** |
|
38 | - * Whether a offset exists. |
|
39 | - * |
|
40 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
41 | - * |
|
42 | - * @param mixed $offset <p> |
|
43 | - * An offset to check for. |
|
44 | - * </p> |
|
45 | - * |
|
46 | - * @return bool true on success or false on failure. |
|
47 | - * </p> |
|
48 | - * <p> |
|
49 | - * The return value will be casted to boolean if non-boolean was returned |
|
50 | - * |
|
51 | - * @since 5.0.0 |
|
52 | - */ |
|
53 | - public function offsetExists($offset) |
|
54 | - { |
|
55 | - try { |
|
56 | - $this->toIndex($offset); |
|
57 | - } catch (TDBMInvalidOffsetException $e) { |
|
58 | - return false; |
|
59 | - } |
|
37 | + /** |
|
38 | + * Whether a offset exists. |
|
39 | + * |
|
40 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
41 | + * |
|
42 | + * @param mixed $offset <p> |
|
43 | + * An offset to check for. |
|
44 | + * </p> |
|
45 | + * |
|
46 | + * @return bool true on success or false on failure. |
|
47 | + * </p> |
|
48 | + * <p> |
|
49 | + * The return value will be casted to boolean if non-boolean was returned |
|
50 | + * |
|
51 | + * @since 5.0.0 |
|
52 | + */ |
|
53 | + public function offsetExists($offset) |
|
54 | + { |
|
55 | + try { |
|
56 | + $this->toIndex($offset); |
|
57 | + } catch (TDBMInvalidOffsetException $e) { |
|
58 | + return false; |
|
59 | + } |
|
60 | 60 | |
61 | - return true; |
|
62 | - } |
|
61 | + return true; |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * Offset to retrieve. |
|
66 | - * |
|
67 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
68 | - * |
|
69 | - * @param mixed $offset <p> |
|
70 | - * The offset to retrieve. |
|
71 | - * </p> |
|
72 | - * |
|
73 | - * @return mixed Can return all value types |
|
74 | - * |
|
75 | - * @since 5.0.0 |
|
76 | - */ |
|
77 | - public function offsetGet($offset) |
|
78 | - { |
|
79 | - $this->toIndex($offset); |
|
64 | + /** |
|
65 | + * Offset to retrieve. |
|
66 | + * |
|
67 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
68 | + * |
|
69 | + * @param mixed $offset <p> |
|
70 | + * The offset to retrieve. |
|
71 | + * </p> |
|
72 | + * |
|
73 | + * @return mixed Can return all value types |
|
74 | + * |
|
75 | + * @since 5.0.0 |
|
76 | + */ |
|
77 | + public function offsetGet($offset) |
|
78 | + { |
|
79 | + $this->toIndex($offset); |
|
80 | 80 | |
81 | - return $this->results[$offset]; |
|
82 | - } |
|
81 | + return $this->results[$offset]; |
|
82 | + } |
|
83 | 83 | |
84 | - private function toIndex($offset) |
|
85 | - { |
|
86 | - if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) { |
|
87 | - throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.'); |
|
88 | - } |
|
89 | - if ($this->statement === null) { |
|
90 | - $this->executeQuery(); |
|
91 | - } |
|
92 | - while (!isset($this->results[$offset])) { |
|
93 | - $this->next(); |
|
94 | - if ($this->current === null) { |
|
95 | - throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.'); |
|
96 | - } |
|
97 | - } |
|
98 | - } |
|
84 | + private function toIndex($offset) |
|
85 | + { |
|
86 | + if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) { |
|
87 | + throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.'); |
|
88 | + } |
|
89 | + if ($this->statement === null) { |
|
90 | + $this->executeQuery(); |
|
91 | + } |
|
92 | + while (!isset($this->results[$offset])) { |
|
93 | + $this->next(); |
|
94 | + if ($this->current === null) { |
|
95 | + throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.'); |
|
96 | + } |
|
97 | + } |
|
98 | + } |
|
99 | 99 | |
100 | - public function next() |
|
101 | - { |
|
102 | - // Let's overload the next() method to store the result. |
|
103 | - if (isset($this->results[$this->key + 1])) { |
|
104 | - ++$this->key; |
|
105 | - $this->current = $this->results[$this->key]; |
|
106 | - } else { |
|
107 | - parent::next(); |
|
108 | - if ($this->current !== null) { |
|
109 | - $this->results[$this->key] = $this->current; |
|
110 | - } |
|
111 | - } |
|
112 | - } |
|
100 | + public function next() |
|
101 | + { |
|
102 | + // Let's overload the next() method to store the result. |
|
103 | + if (isset($this->results[$this->key + 1])) { |
|
104 | + ++$this->key; |
|
105 | + $this->current = $this->results[$this->key]; |
|
106 | + } else { |
|
107 | + parent::next(); |
|
108 | + if ($this->current !== null) { |
|
109 | + $this->results[$this->key] = $this->current; |
|
110 | + } |
|
111 | + } |
|
112 | + } |
|
113 | 113 | |
114 | - /** |
|
115 | - * Overloads the rewind implementation. |
|
116 | - * Do not reexecute the query. |
|
117 | - */ |
|
118 | - public function rewind() |
|
119 | - { |
|
120 | - if (!$this->fetchStarted) { |
|
121 | - $this->executeQuery(); |
|
122 | - } |
|
123 | - $this->key = -1; |
|
124 | - $this->next(); |
|
125 | - } |
|
114 | + /** |
|
115 | + * Overloads the rewind implementation. |
|
116 | + * Do not reexecute the query. |
|
117 | + */ |
|
118 | + public function rewind() |
|
119 | + { |
|
120 | + if (!$this->fetchStarted) { |
|
121 | + $this->executeQuery(); |
|
122 | + } |
|
123 | + $this->key = -1; |
|
124 | + $this->next(); |
|
125 | + } |
|
126 | 126 | } |
@@ -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 | } |
@@ -17,228 +17,228 @@ discard block |
||
17 | 17 | */ |
18 | 18 | class BeanDescriptor |
19 | 19 | { |
20 | - /** |
|
21 | - * @var Table |
|
22 | - */ |
|
23 | - private $table; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var SchemaAnalyzer |
|
27 | - */ |
|
28 | - private $schemaAnalyzer; |
|
29 | - |
|
30 | - /** |
|
31 | - * @var Schema |
|
32 | - */ |
|
33 | - private $schema; |
|
34 | - |
|
35 | - /** |
|
36 | - * @var AbstractBeanPropertyDescriptor[] |
|
37 | - */ |
|
38 | - private $beanPropertyDescriptors = []; |
|
39 | - |
|
40 | - /** |
|
41 | - * @var TDBMSchemaAnalyzer |
|
42 | - */ |
|
43 | - private $tdbmSchemaAnalyzer; |
|
44 | - |
|
45 | - public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
46 | - { |
|
47 | - $this->table = $table; |
|
48 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
49 | - $this->schema = $schema; |
|
50 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
51 | - $this->initBeanPropertyDescriptors(); |
|
52 | - } |
|
53 | - |
|
54 | - private function initBeanPropertyDescriptors() |
|
55 | - { |
|
56 | - $this->beanPropertyDescriptors = $this->getProperties($this->table); |
|
57 | - } |
|
58 | - |
|
59 | - /** |
|
60 | - * Returns the foreign-key the column is part of, if any. null otherwise. |
|
61 | - * |
|
62 | - * @param Table $table |
|
63 | - * @param Column $column |
|
64 | - * |
|
65 | - * @return ForeignKeyConstraint|null |
|
66 | - */ |
|
67 | - private function isPartOfForeignKey(Table $table, Column $column) |
|
68 | - { |
|
69 | - $localColumnName = $column->getName(); |
|
70 | - foreach ($table->getForeignKeys() as $foreignKey) { |
|
71 | - foreach ($foreignKey->getColumns() as $columnName) { |
|
72 | - if ($columnName === $localColumnName) { |
|
73 | - return $foreignKey; |
|
74 | - } |
|
75 | - } |
|
76 | - } |
|
77 | - |
|
78 | - return; |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * @return AbstractBeanPropertyDescriptor[] |
|
83 | - */ |
|
84 | - public function getBeanPropertyDescriptors() |
|
85 | - { |
|
86 | - return $this->beanPropertyDescriptors; |
|
87 | - } |
|
88 | - |
|
89 | - /** |
|
90 | - * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent. |
|
91 | - * |
|
92 | - * @return AbstractBeanPropertyDescriptor[] |
|
93 | - */ |
|
94 | - public function getConstructorProperties() |
|
95 | - { |
|
96 | - $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
97 | - return $property->isCompulsory(); |
|
98 | - }); |
|
99 | - |
|
100 | - return $constructorProperties; |
|
101 | - } |
|
102 | - |
|
103 | - /** |
|
104 | - * Returns the list of columns that have default values for a given table. |
|
105 | - * |
|
106 | - * @return AbstractBeanPropertyDescriptor[] |
|
107 | - */ |
|
108 | - public function getPropertiesWithDefault() |
|
109 | - { |
|
110 | - $properties = $this->getPropertiesForTable($this->table); |
|
111 | - $defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) { |
|
112 | - return $property->hasDefault(); |
|
113 | - }); |
|
114 | - |
|
115 | - return $defaultProperties; |
|
116 | - } |
|
117 | - |
|
118 | - /** |
|
119 | - * Returns the list of properties exposed as getters and setters in this class. |
|
120 | - * |
|
121 | - * @return AbstractBeanPropertyDescriptor[] |
|
122 | - */ |
|
123 | - public function getExposedProperties() |
|
124 | - { |
|
125 | - $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
126 | - return $property->getTable()->getName() == $this->table->getName(); |
|
127 | - }); |
|
128 | - |
|
129 | - return $exposedProperties; |
|
130 | - } |
|
131 | - |
|
132 | - /** |
|
133 | - * Returns the list of properties for this table (including parent tables). |
|
134 | - * |
|
135 | - * @param Table $table |
|
136 | - * |
|
137 | - * @return AbstractBeanPropertyDescriptor[] |
|
138 | - */ |
|
139 | - private function getProperties(Table $table) |
|
140 | - { |
|
141 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
142 | - if ($parentRelationship) { |
|
143 | - $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName()); |
|
144 | - $properties = $this->getProperties($parentTable); |
|
145 | - // we merge properties by overriding property names. |
|
146 | - $localProperties = $this->getPropertiesForTable($table); |
|
147 | - foreach ($localProperties as $name => $property) { |
|
148 | - // We do not override properties if this is a primary key! |
|
149 | - if ($property->isPrimaryKey()) { |
|
150 | - continue; |
|
151 | - } |
|
152 | - $properties[$name] = $property; |
|
153 | - } |
|
154 | - } else { |
|
155 | - $properties = $this->getPropertiesForTable($table); |
|
156 | - } |
|
157 | - |
|
158 | - return $properties; |
|
159 | - } |
|
160 | - |
|
161 | - /** |
|
162 | - * Returns the list of properties for this table (ignoring parent tables). |
|
163 | - * |
|
164 | - * @param Table $table |
|
165 | - * |
|
166 | - * @return AbstractBeanPropertyDescriptor[] |
|
167 | - */ |
|
168 | - private function getPropertiesForTable(Table $table) |
|
169 | - { |
|
170 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
171 | - if ($parentRelationship) { |
|
172 | - $ignoreColumns = $parentRelationship->getLocalColumns(); |
|
173 | - } else { |
|
174 | - $ignoreColumns = []; |
|
175 | - } |
|
176 | - |
|
177 | - $beanPropertyDescriptors = []; |
|
178 | - |
|
179 | - foreach ($table->getColumns() as $column) { |
|
180 | - if (array_search($column->getName(), $ignoreColumns) !== false) { |
|
181 | - continue; |
|
182 | - } |
|
183 | - |
|
184 | - $fk = $this->isPartOfForeignKey($table, $column); |
|
185 | - if ($fk !== null) { |
|
186 | - // Check that previously added descriptors are not added on same FK (can happen with multi key FK). |
|
187 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
188 | - if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) { |
|
189 | - continue 2; |
|
190 | - } |
|
191 | - } |
|
192 | - // Check that this property is not an inheritance relationship |
|
193 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
194 | - if ($parentRelationship === $fk) { |
|
195 | - continue; |
|
196 | - } |
|
197 | - |
|
198 | - $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer); |
|
199 | - } else { |
|
200 | - $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column); |
|
201 | - } |
|
202 | - } |
|
203 | - |
|
204 | - // Now, let's get the name of all properties and let's check there is no duplicate. |
|
205 | - /** @var $names AbstractBeanPropertyDescriptor[] */ |
|
206 | - $names = []; |
|
207 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
208 | - $name = $beanDescriptor->getUpperCamelCaseName(); |
|
209 | - if (isset($names[$name])) { |
|
210 | - $names[$name]->useAlternativeName(); |
|
211 | - $beanDescriptor->useAlternativeName(); |
|
212 | - } else { |
|
213 | - $names[$name] = $beanDescriptor; |
|
214 | - } |
|
215 | - } |
|
216 | - |
|
217 | - // Final check (throw exceptions if problem arises) |
|
218 | - $names = []; |
|
219 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
220 | - $name = $beanDescriptor->getUpperCamelCaseName(); |
|
221 | - if (isset($names[$name])) { |
|
222 | - throw new TDBMException('Unsolvable name conflict while generating method name'); |
|
223 | - } else { |
|
224 | - $names[$name] = $beanDescriptor; |
|
225 | - } |
|
226 | - } |
|
227 | - |
|
228 | - // Last step, let's rebuild the list with a map: |
|
229 | - $beanPropertyDescriptorsMap = []; |
|
230 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
231 | - $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor; |
|
232 | - } |
|
233 | - |
|
234 | - return $beanPropertyDescriptorsMap; |
|
235 | - } |
|
236 | - |
|
237 | - public function generateBeanConstructor() |
|
238 | - { |
|
239 | - $constructorProperties = $this->getConstructorProperties(); |
|
240 | - |
|
241 | - $constructorCode = ' /** |
|
20 | + /** |
|
21 | + * @var Table |
|
22 | + */ |
|
23 | + private $table; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var SchemaAnalyzer |
|
27 | + */ |
|
28 | + private $schemaAnalyzer; |
|
29 | + |
|
30 | + /** |
|
31 | + * @var Schema |
|
32 | + */ |
|
33 | + private $schema; |
|
34 | + |
|
35 | + /** |
|
36 | + * @var AbstractBeanPropertyDescriptor[] |
|
37 | + */ |
|
38 | + private $beanPropertyDescriptors = []; |
|
39 | + |
|
40 | + /** |
|
41 | + * @var TDBMSchemaAnalyzer |
|
42 | + */ |
|
43 | + private $tdbmSchemaAnalyzer; |
|
44 | + |
|
45 | + public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
46 | + { |
|
47 | + $this->table = $table; |
|
48 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
49 | + $this->schema = $schema; |
|
50 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
51 | + $this->initBeanPropertyDescriptors(); |
|
52 | + } |
|
53 | + |
|
54 | + private function initBeanPropertyDescriptors() |
|
55 | + { |
|
56 | + $this->beanPropertyDescriptors = $this->getProperties($this->table); |
|
57 | + } |
|
58 | + |
|
59 | + /** |
|
60 | + * Returns the foreign-key the column is part of, if any. null otherwise. |
|
61 | + * |
|
62 | + * @param Table $table |
|
63 | + * @param Column $column |
|
64 | + * |
|
65 | + * @return ForeignKeyConstraint|null |
|
66 | + */ |
|
67 | + private function isPartOfForeignKey(Table $table, Column $column) |
|
68 | + { |
|
69 | + $localColumnName = $column->getName(); |
|
70 | + foreach ($table->getForeignKeys() as $foreignKey) { |
|
71 | + foreach ($foreignKey->getColumns() as $columnName) { |
|
72 | + if ($columnName === $localColumnName) { |
|
73 | + return $foreignKey; |
|
74 | + } |
|
75 | + } |
|
76 | + } |
|
77 | + |
|
78 | + return; |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * @return AbstractBeanPropertyDescriptor[] |
|
83 | + */ |
|
84 | + public function getBeanPropertyDescriptors() |
|
85 | + { |
|
86 | + return $this->beanPropertyDescriptors; |
|
87 | + } |
|
88 | + |
|
89 | + /** |
|
90 | + * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent. |
|
91 | + * |
|
92 | + * @return AbstractBeanPropertyDescriptor[] |
|
93 | + */ |
|
94 | + public function getConstructorProperties() |
|
95 | + { |
|
96 | + $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
97 | + return $property->isCompulsory(); |
|
98 | + }); |
|
99 | + |
|
100 | + return $constructorProperties; |
|
101 | + } |
|
102 | + |
|
103 | + /** |
|
104 | + * Returns the list of columns that have default values for a given table. |
|
105 | + * |
|
106 | + * @return AbstractBeanPropertyDescriptor[] |
|
107 | + */ |
|
108 | + public function getPropertiesWithDefault() |
|
109 | + { |
|
110 | + $properties = $this->getPropertiesForTable($this->table); |
|
111 | + $defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) { |
|
112 | + return $property->hasDefault(); |
|
113 | + }); |
|
114 | + |
|
115 | + return $defaultProperties; |
|
116 | + } |
|
117 | + |
|
118 | + /** |
|
119 | + * Returns the list of properties exposed as getters and setters in this class. |
|
120 | + * |
|
121 | + * @return AbstractBeanPropertyDescriptor[] |
|
122 | + */ |
|
123 | + public function getExposedProperties() |
|
124 | + { |
|
125 | + $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
126 | + return $property->getTable()->getName() == $this->table->getName(); |
|
127 | + }); |
|
128 | + |
|
129 | + return $exposedProperties; |
|
130 | + } |
|
131 | + |
|
132 | + /** |
|
133 | + * Returns the list of properties for this table (including parent tables). |
|
134 | + * |
|
135 | + * @param Table $table |
|
136 | + * |
|
137 | + * @return AbstractBeanPropertyDescriptor[] |
|
138 | + */ |
|
139 | + private function getProperties(Table $table) |
|
140 | + { |
|
141 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
142 | + if ($parentRelationship) { |
|
143 | + $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName()); |
|
144 | + $properties = $this->getProperties($parentTable); |
|
145 | + // we merge properties by overriding property names. |
|
146 | + $localProperties = $this->getPropertiesForTable($table); |
|
147 | + foreach ($localProperties as $name => $property) { |
|
148 | + // We do not override properties if this is a primary key! |
|
149 | + if ($property->isPrimaryKey()) { |
|
150 | + continue; |
|
151 | + } |
|
152 | + $properties[$name] = $property; |
|
153 | + } |
|
154 | + } else { |
|
155 | + $properties = $this->getPropertiesForTable($table); |
|
156 | + } |
|
157 | + |
|
158 | + return $properties; |
|
159 | + } |
|
160 | + |
|
161 | + /** |
|
162 | + * Returns the list of properties for this table (ignoring parent tables). |
|
163 | + * |
|
164 | + * @param Table $table |
|
165 | + * |
|
166 | + * @return AbstractBeanPropertyDescriptor[] |
|
167 | + */ |
|
168 | + private function getPropertiesForTable(Table $table) |
|
169 | + { |
|
170 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
171 | + if ($parentRelationship) { |
|
172 | + $ignoreColumns = $parentRelationship->getLocalColumns(); |
|
173 | + } else { |
|
174 | + $ignoreColumns = []; |
|
175 | + } |
|
176 | + |
|
177 | + $beanPropertyDescriptors = []; |
|
178 | + |
|
179 | + foreach ($table->getColumns() as $column) { |
|
180 | + if (array_search($column->getName(), $ignoreColumns) !== false) { |
|
181 | + continue; |
|
182 | + } |
|
183 | + |
|
184 | + $fk = $this->isPartOfForeignKey($table, $column); |
|
185 | + if ($fk !== null) { |
|
186 | + // Check that previously added descriptors are not added on same FK (can happen with multi key FK). |
|
187 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
188 | + if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) { |
|
189 | + continue 2; |
|
190 | + } |
|
191 | + } |
|
192 | + // Check that this property is not an inheritance relationship |
|
193 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
194 | + if ($parentRelationship === $fk) { |
|
195 | + continue; |
|
196 | + } |
|
197 | + |
|
198 | + $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer); |
|
199 | + } else { |
|
200 | + $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column); |
|
201 | + } |
|
202 | + } |
|
203 | + |
|
204 | + // Now, let's get the name of all properties and let's check there is no duplicate. |
|
205 | + /** @var $names AbstractBeanPropertyDescriptor[] */ |
|
206 | + $names = []; |
|
207 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
208 | + $name = $beanDescriptor->getUpperCamelCaseName(); |
|
209 | + if (isset($names[$name])) { |
|
210 | + $names[$name]->useAlternativeName(); |
|
211 | + $beanDescriptor->useAlternativeName(); |
|
212 | + } else { |
|
213 | + $names[$name] = $beanDescriptor; |
|
214 | + } |
|
215 | + } |
|
216 | + |
|
217 | + // Final check (throw exceptions if problem arises) |
|
218 | + $names = []; |
|
219 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
220 | + $name = $beanDescriptor->getUpperCamelCaseName(); |
|
221 | + if (isset($names[$name])) { |
|
222 | + throw new TDBMException('Unsolvable name conflict while generating method name'); |
|
223 | + } else { |
|
224 | + $names[$name] = $beanDescriptor; |
|
225 | + } |
|
226 | + } |
|
227 | + |
|
228 | + // Last step, let's rebuild the list with a map: |
|
229 | + $beanPropertyDescriptorsMap = []; |
|
230 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
231 | + $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor; |
|
232 | + } |
|
233 | + |
|
234 | + return $beanPropertyDescriptorsMap; |
|
235 | + } |
|
236 | + |
|
237 | + public function generateBeanConstructor() |
|
238 | + { |
|
239 | + $constructorProperties = $this->getConstructorProperties(); |
|
240 | + |
|
241 | + $constructorCode = ' /** |
|
242 | 242 | * The constructor takes all compulsory arguments. |
243 | 243 | * |
244 | 244 | %s |
@@ -248,70 +248,70 @@ discard block |
||
248 | 248 | %s } |
249 | 249 | '; |
250 | 250 | |
251 | - $paramAnnotations = []; |
|
252 | - $arguments = []; |
|
253 | - $assigns = []; |
|
254 | - $parentConstructorArguments = []; |
|
255 | - |
|
256 | - foreach ($constructorProperties as $property) { |
|
257 | - $className = $property->getClassName(); |
|
258 | - if ($className) { |
|
259 | - $arguments[] = $className.' '.$property->getVariableName(); |
|
260 | - } else { |
|
261 | - $arguments[] = $property->getVariableName(); |
|
262 | - } |
|
263 | - $paramAnnotations[] = $property->getParamAnnotation(); |
|
264 | - if ($property->getTable()->getName() === $this->table->getName()) { |
|
265 | - $assigns[] = $property->getConstructorAssignCode(); |
|
266 | - } else { |
|
267 | - $parentConstructorArguments[] = $property->getVariableName(); |
|
268 | - } |
|
269 | - } |
|
270 | - |
|
271 | - $parentConstructorCode = sprintf(" parent::__construct(%s);\n", implode(', ', $parentConstructorArguments)); |
|
272 | - |
|
273 | - $defaultAssigns = []; |
|
274 | - foreach ($this->getPropertiesWithDefault() as $property) { |
|
275 | - $defaultAssigns[] = $property->assignToDefaultCode(); |
|
276 | - } |
|
277 | - |
|
278 | - return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns), implode("\n", $defaultAssigns)); |
|
279 | - } |
|
280 | - |
|
281 | - public function generateDirectForeignKeysCode() |
|
282 | - { |
|
283 | - $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
284 | - |
|
285 | - $fksByTable = []; |
|
286 | - |
|
287 | - foreach ($fks as $fk) { |
|
288 | - $fksByTable[$fk->getLocalTableName()][] = $fk; |
|
289 | - } |
|
290 | - |
|
291 | - /* @var $fksByMethodName ForeignKeyConstraint[] */ |
|
292 | - $fksByMethodName = []; |
|
293 | - |
|
294 | - foreach ($fksByTable as $tableName => $fksForTable) { |
|
295 | - if (count($fksForTable) > 1) { |
|
296 | - foreach ($fksForTable as $fk) { |
|
297 | - $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By'; |
|
298 | - |
|
299 | - $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns()); |
|
300 | - |
|
301 | - $methodName .= implode('And', $camelizedColumns); |
|
302 | - |
|
303 | - $fksByMethodName[$methodName] = $fk; |
|
304 | - } |
|
305 | - } else { |
|
306 | - $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName()); |
|
307 | - $fksByMethodName[$methodName] = $fksForTable[0]; |
|
308 | - } |
|
309 | - } |
|
310 | - |
|
311 | - $code = ''; |
|
312 | - |
|
313 | - foreach ($fksByMethodName as $methodName => $fk) { |
|
314 | - $getterCode = ' /** |
|
251 | + $paramAnnotations = []; |
|
252 | + $arguments = []; |
|
253 | + $assigns = []; |
|
254 | + $parentConstructorArguments = []; |
|
255 | + |
|
256 | + foreach ($constructorProperties as $property) { |
|
257 | + $className = $property->getClassName(); |
|
258 | + if ($className) { |
|
259 | + $arguments[] = $className.' '.$property->getVariableName(); |
|
260 | + } else { |
|
261 | + $arguments[] = $property->getVariableName(); |
|
262 | + } |
|
263 | + $paramAnnotations[] = $property->getParamAnnotation(); |
|
264 | + if ($property->getTable()->getName() === $this->table->getName()) { |
|
265 | + $assigns[] = $property->getConstructorAssignCode(); |
|
266 | + } else { |
|
267 | + $parentConstructorArguments[] = $property->getVariableName(); |
|
268 | + } |
|
269 | + } |
|
270 | + |
|
271 | + $parentConstructorCode = sprintf(" parent::__construct(%s);\n", implode(', ', $parentConstructorArguments)); |
|
272 | + |
|
273 | + $defaultAssigns = []; |
|
274 | + foreach ($this->getPropertiesWithDefault() as $property) { |
|
275 | + $defaultAssigns[] = $property->assignToDefaultCode(); |
|
276 | + } |
|
277 | + |
|
278 | + return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns), implode("\n", $defaultAssigns)); |
|
279 | + } |
|
280 | + |
|
281 | + public function generateDirectForeignKeysCode() |
|
282 | + { |
|
283 | + $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
284 | + |
|
285 | + $fksByTable = []; |
|
286 | + |
|
287 | + foreach ($fks as $fk) { |
|
288 | + $fksByTable[$fk->getLocalTableName()][] = $fk; |
|
289 | + } |
|
290 | + |
|
291 | + /* @var $fksByMethodName ForeignKeyConstraint[] */ |
|
292 | + $fksByMethodName = []; |
|
293 | + |
|
294 | + foreach ($fksByTable as $tableName => $fksForTable) { |
|
295 | + if (count($fksForTable) > 1) { |
|
296 | + foreach ($fksForTable as $fk) { |
|
297 | + $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By'; |
|
298 | + |
|
299 | + $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns()); |
|
300 | + |
|
301 | + $methodName .= implode('And', $camelizedColumns); |
|
302 | + |
|
303 | + $fksByMethodName[$methodName] = $fk; |
|
304 | + } |
|
305 | + } else { |
|
306 | + $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName()); |
|
307 | + $fksByMethodName[$methodName] = $fksForTable[0]; |
|
308 | + } |
|
309 | + } |
|
310 | + |
|
311 | + $code = ''; |
|
312 | + |
|
313 | + foreach ($fksByMethodName as $methodName => $fk) { |
|
314 | + $getterCode = ' /** |
|
315 | 315 | * Returns the list of %s pointing to this bean via the %s column. |
316 | 316 | * |
317 | 317 | * @return %s[]|AlterableResultIterator |
@@ -323,107 +323,107 @@ discard block |
||
323 | 323 | |
324 | 324 | '; |
325 | 325 | |
326 | - $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
327 | - $code .= sprintf($getterCode, |
|
328 | - $beanClass, |
|
329 | - implode(', ', $fk->getColumns()), |
|
330 | - $beanClass, |
|
331 | - $methodName, |
|
332 | - var_export($fk->getLocalTableName(), true), |
|
333 | - var_export($fk->getName(), true), |
|
334 | - var_export($fk->getLocalTableName(), true), |
|
335 | - $this->getFilters($fk) |
|
336 | - ); |
|
337 | - } |
|
338 | - |
|
339 | - return $code; |
|
340 | - } |
|
341 | - |
|
342 | - private function getFilters(ForeignKeyConstraint $fk) : string |
|
343 | - { |
|
344 | - $counter = 0; |
|
345 | - $parameters = []; |
|
346 | - |
|
347 | - $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
348 | - |
|
349 | - foreach ($fk->getLocalColumns() as $columnName) { |
|
350 | - $pkColumn = $pkColumns[$counter]; |
|
351 | - $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($fk->getLocalTableName().'.'.$columnName, true), var_export($pkColumn, true), var_export($this->table->getName(), true)); |
|
352 | - ++$counter; |
|
353 | - } |
|
354 | - $parametersCode = '[ '.implode(', ', $parameters).' ]'; |
|
355 | - |
|
356 | - return $parametersCode; |
|
357 | - } |
|
358 | - |
|
359 | - /** |
|
360 | - * Generate code section about pivot tables. |
|
361 | - * |
|
362 | - * @return string |
|
363 | - */ |
|
364 | - public function generatePivotTableCode() |
|
365 | - { |
|
366 | - $finalDescs = $this->getPivotTableDescriptors(); |
|
367 | - |
|
368 | - $code = ''; |
|
369 | - |
|
370 | - foreach ($finalDescs as $desc) { |
|
371 | - $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']); |
|
372 | - } |
|
373 | - |
|
374 | - return $code; |
|
375 | - } |
|
376 | - |
|
377 | - private function getPivotTableDescriptors() |
|
378 | - { |
|
379 | - $descs = []; |
|
380 | - foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) { |
|
381 | - // There are exactly 2 FKs since this is a pivot table. |
|
382 | - $fks = array_values($table->getForeignKeys()); |
|
383 | - |
|
384 | - if ($fks[0]->getForeignTableName() === $this->table->getName()) { |
|
385 | - $localFK = $fks[0]; |
|
386 | - $remoteFK = $fks[1]; |
|
387 | - } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) { |
|
388 | - $localFK = $fks[1]; |
|
389 | - $remoteFK = $fks[0]; |
|
390 | - } else { |
|
391 | - continue; |
|
392 | - } |
|
393 | - |
|
394 | - $descs[$remoteFK->getForeignTableName()][] = [ |
|
395 | - 'table' => $table, |
|
396 | - 'localFK' => $localFK, |
|
397 | - 'remoteFK' => $remoteFK, |
|
398 | - ]; |
|
399 | - } |
|
400 | - |
|
401 | - $finalDescs = []; |
|
402 | - foreach ($descs as $descArray) { |
|
403 | - if (count($descArray) > 1) { |
|
404 | - foreach ($descArray as $desc) { |
|
405 | - $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName()); |
|
406 | - $finalDescs[] = $desc; |
|
407 | - } |
|
408 | - } else { |
|
409 | - $desc = $descArray[0]; |
|
410 | - $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()); |
|
411 | - $finalDescs[] = $desc; |
|
412 | - } |
|
413 | - } |
|
414 | - |
|
415 | - return $finalDescs; |
|
416 | - } |
|
417 | - |
|
418 | - public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK) |
|
419 | - { |
|
420 | - $singularName = TDBMDaoGenerator::toSingular($name); |
|
421 | - $pluralName = $name; |
|
422 | - $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
423 | - $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
424 | - $pluralVariableName = $variableName.'s'; |
|
425 | - |
|
426 | - $str = ' /** |
|
326 | + $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
327 | + $code .= sprintf($getterCode, |
|
328 | + $beanClass, |
|
329 | + implode(', ', $fk->getColumns()), |
|
330 | + $beanClass, |
|
331 | + $methodName, |
|
332 | + var_export($fk->getLocalTableName(), true), |
|
333 | + var_export($fk->getName(), true), |
|
334 | + var_export($fk->getLocalTableName(), true), |
|
335 | + $this->getFilters($fk) |
|
336 | + ); |
|
337 | + } |
|
338 | + |
|
339 | + return $code; |
|
340 | + } |
|
341 | + |
|
342 | + private function getFilters(ForeignKeyConstraint $fk) : string |
|
343 | + { |
|
344 | + $counter = 0; |
|
345 | + $parameters = []; |
|
346 | + |
|
347 | + $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
348 | + |
|
349 | + foreach ($fk->getLocalColumns() as $columnName) { |
|
350 | + $pkColumn = $pkColumns[$counter]; |
|
351 | + $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($fk->getLocalTableName().'.'.$columnName, true), var_export($pkColumn, true), var_export($this->table->getName(), true)); |
|
352 | + ++$counter; |
|
353 | + } |
|
354 | + $parametersCode = '[ '.implode(', ', $parameters).' ]'; |
|
355 | + |
|
356 | + return $parametersCode; |
|
357 | + } |
|
358 | + |
|
359 | + /** |
|
360 | + * Generate code section about pivot tables. |
|
361 | + * |
|
362 | + * @return string |
|
363 | + */ |
|
364 | + public function generatePivotTableCode() |
|
365 | + { |
|
366 | + $finalDescs = $this->getPivotTableDescriptors(); |
|
367 | + |
|
368 | + $code = ''; |
|
369 | + |
|
370 | + foreach ($finalDescs as $desc) { |
|
371 | + $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']); |
|
372 | + } |
|
373 | + |
|
374 | + return $code; |
|
375 | + } |
|
376 | + |
|
377 | + private function getPivotTableDescriptors() |
|
378 | + { |
|
379 | + $descs = []; |
|
380 | + foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) { |
|
381 | + // There are exactly 2 FKs since this is a pivot table. |
|
382 | + $fks = array_values($table->getForeignKeys()); |
|
383 | + |
|
384 | + if ($fks[0]->getForeignTableName() === $this->table->getName()) { |
|
385 | + $localFK = $fks[0]; |
|
386 | + $remoteFK = $fks[1]; |
|
387 | + } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) { |
|
388 | + $localFK = $fks[1]; |
|
389 | + $remoteFK = $fks[0]; |
|
390 | + } else { |
|
391 | + continue; |
|
392 | + } |
|
393 | + |
|
394 | + $descs[$remoteFK->getForeignTableName()][] = [ |
|
395 | + 'table' => $table, |
|
396 | + 'localFK' => $localFK, |
|
397 | + 'remoteFK' => $remoteFK, |
|
398 | + ]; |
|
399 | + } |
|
400 | + |
|
401 | + $finalDescs = []; |
|
402 | + foreach ($descs as $descArray) { |
|
403 | + if (count($descArray) > 1) { |
|
404 | + foreach ($descArray as $desc) { |
|
405 | + $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName()); |
|
406 | + $finalDescs[] = $desc; |
|
407 | + } |
|
408 | + } else { |
|
409 | + $desc = $descArray[0]; |
|
410 | + $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()); |
|
411 | + $finalDescs[] = $desc; |
|
412 | + } |
|
413 | + } |
|
414 | + |
|
415 | + return $finalDescs; |
|
416 | + } |
|
417 | + |
|
418 | + public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK) |
|
419 | + { |
|
420 | + $singularName = TDBMDaoGenerator::toSingular($name); |
|
421 | + $pluralName = $name; |
|
422 | + $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
423 | + $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
424 | + $pluralVariableName = $variableName.'s'; |
|
425 | + |
|
426 | + $str = ' /** |
|
427 | 427 | * Returns the list of %s associated to this bean via the %s pivot table. |
428 | 428 | * |
429 | 429 | * @return %s[] |
@@ -433,9 +433,9 @@ discard block |
||
433 | 433 | } |
434 | 434 | '; |
435 | 435 | |
436 | - $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true)); |
|
436 | + $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true)); |
|
437 | 437 | |
438 | - $str = ' /** |
|
438 | + $str = ' /** |
|
439 | 439 | * Adds a relationship with %s associated to this bean via the %s pivot table. |
440 | 440 | * |
441 | 441 | * @param %s %s |
@@ -445,9 +445,9 @@ discard block |
||
445 | 445 | } |
446 | 446 | '; |
447 | 447 | |
448 | - $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
448 | + $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
449 | 449 | |
450 | - $str = ' /** |
|
450 | + $str = ' /** |
|
451 | 451 | * Deletes the relationship with %s associated to this bean via the %s pivot table. |
452 | 452 | * |
453 | 453 | * @param %s %s |
@@ -457,9 +457,9 @@ discard block |
||
457 | 457 | } |
458 | 458 | '; |
459 | 459 | |
460 | - $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
460 | + $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
461 | 461 | |
462 | - $str = ' /** |
|
462 | + $str = ' /** |
|
463 | 463 | * Returns whether this bean is associated with %s via the %s pivot table. |
464 | 464 | * |
465 | 465 | * @param %s %s |
@@ -470,9 +470,9 @@ discard block |
||
470 | 470 | } |
471 | 471 | '; |
472 | 472 | |
473 | - $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
473 | + $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
474 | 474 | |
475 | - $str = ' /** |
|
475 | + $str = ' /** |
|
476 | 476 | * Sets all relationships with %s associated to this bean via the %s pivot table. |
477 | 477 | * Exiting relationships will be removed and replaced by the provided relationships. |
478 | 478 | * |
@@ -483,24 +483,24 @@ discard block |
||
483 | 483 | } |
484 | 484 | '; |
485 | 485 | |
486 | - $setterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $pluralVariableName, $pluralName, $pluralVariableName, var_export($remoteFK->getLocalTableName(), true), $pluralVariableName); |
|
486 | + $setterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $pluralVariableName, $pluralName, $pluralVariableName, var_export($remoteFK->getLocalTableName(), true), $pluralVariableName); |
|
487 | 487 | |
488 | - $code = $getterCode.$adderCode.$removerCode.$hasCode.$setterCode; |
|
488 | + $code = $getterCode.$adderCode.$removerCode.$hasCode.$setterCode; |
|
489 | 489 | |
490 | - return $code; |
|
491 | - } |
|
490 | + return $code; |
|
491 | + } |
|
492 | 492 | |
493 | - public function generateJsonSerialize() |
|
494 | - { |
|
495 | - $tableName = $this->table->getName(); |
|
496 | - $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
497 | - if ($parentFk !== null) { |
|
498 | - $initializer = '$array = parent::jsonSerialize($stopRecursion);'; |
|
499 | - } else { |
|
500 | - $initializer = '$array = [];'; |
|
501 | - } |
|
493 | + public function generateJsonSerialize() |
|
494 | + { |
|
495 | + $tableName = $this->table->getName(); |
|
496 | + $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
497 | + if ($parentFk !== null) { |
|
498 | + $initializer = '$array = parent::jsonSerialize($stopRecursion);'; |
|
499 | + } else { |
|
500 | + $initializer = '$array = [];'; |
|
501 | + } |
|
502 | 502 | |
503 | - $str = ' |
|
503 | + $str = ' |
|
504 | 504 | /** |
505 | 505 | * Serializes the object for JSON encoding |
506 | 506 | * |
@@ -516,97 +516,97 @@ discard block |
||
516 | 516 | } |
517 | 517 | '; |
518 | 518 | |
519 | - $propertiesCode = ''; |
|
520 | - foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) { |
|
521 | - $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode(); |
|
522 | - } |
|
519 | + $propertiesCode = ''; |
|
520 | + foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) { |
|
521 | + $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode(); |
|
522 | + } |
|
523 | 523 | |
524 | - // Many to many relationships: |
|
524 | + // Many to many relationships: |
|
525 | 525 | |
526 | - $descs = $this->getPivotTableDescriptors(); |
|
526 | + $descs = $this->getPivotTableDescriptors(); |
|
527 | 527 | |
528 | - $many2manyCode = ''; |
|
528 | + $many2manyCode = ''; |
|
529 | 529 | |
530 | - foreach ($descs as $desc) { |
|
531 | - $remoteFK = $desc['remoteFK']; |
|
532 | - $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
533 | - $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
530 | + foreach ($descs as $desc) { |
|
531 | + $remoteFK = $desc['remoteFK']; |
|
532 | + $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
533 | + $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
534 | 534 | |
535 | - $many2manyCode .= ' if (!$stopRecursion) { |
|
535 | + $many2manyCode .= ' if (!$stopRecursion) { |
|
536 | 536 | $array[\''.lcfirst($desc['name']).'\'] = array_map(function('.$remoteBeanName.' '.$variableName.') { |
537 | 537 | return '.$variableName.'->jsonSerialize(true); |
538 | 538 | }, $this->get'.$desc['name'].'()); |
539 | 539 | } |
540 | 540 | '; |
541 | - } |
|
542 | - |
|
543 | - return sprintf($str, $initializer, $propertiesCode, $many2manyCode); |
|
544 | - } |
|
545 | - |
|
546 | - /** |
|
547 | - * Returns as an array the class we need to extend from and the list of use statements. |
|
548 | - * |
|
549 | - * @return array |
|
550 | - */ |
|
551 | - private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null) |
|
552 | - { |
|
553 | - $classes = []; |
|
554 | - if ($parentFk !== null) { |
|
555 | - $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
556 | - $classes[] = $extends; |
|
557 | - } |
|
558 | - |
|
559 | - foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) { |
|
560 | - $className = $beanPropertyDescriptor->getClassName(); |
|
561 | - if (null !== $className) { |
|
562 | - $classes[] = $beanPropertyDescriptor->getClassName(); |
|
563 | - } |
|
564 | - } |
|
565 | - |
|
566 | - foreach ($this->getPivotTableDescriptors() as $descriptor) { |
|
567 | - /* @var $fk ForeignKeyConstraint */ |
|
568 | - $fk = $descriptor['remoteFK']; |
|
569 | - $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName()); |
|
570 | - } |
|
571 | - |
|
572 | - // Many-to-one relationships |
|
573 | - $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
574 | - foreach ($fks as $fk) { |
|
575 | - $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
576 | - } |
|
577 | - |
|
578 | - $classes = array_unique($classes); |
|
579 | - |
|
580 | - return $classes; |
|
581 | - } |
|
582 | - |
|
583 | - /** |
|
584 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
585 | - * |
|
586 | - * @param string $beannamespace The namespace of the bean |
|
587 | - */ |
|
588 | - public function generatePhpCode($beannamespace) |
|
589 | - { |
|
590 | - $tableName = $this->table->getName(); |
|
591 | - $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName); |
|
592 | - $className = TDBMDaoGenerator::getBeanNameFromTableName($tableName); |
|
593 | - $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
594 | - |
|
595 | - $classes = $this->generateExtendsAndUseStatements($parentFk); |
|
596 | - |
|
597 | - $uses = array_map(function ($className) use ($beannamespace) { |
|
598 | - return 'use '.$beannamespace.'\\'.$className.";\n"; |
|
599 | - }, $classes); |
|
600 | - $use = implode('', $uses); |
|
601 | - |
|
602 | - if ($parentFk !== null) { |
|
603 | - $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
604 | - } else { |
|
605 | - $extends = 'AbstractTDBMObject'; |
|
606 | - $use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n"; |
|
607 | - } |
|
608 | - |
|
609 | - $str = "<?php |
|
541 | + } |
|
542 | + |
|
543 | + return sprintf($str, $initializer, $propertiesCode, $many2manyCode); |
|
544 | + } |
|
545 | + |
|
546 | + /** |
|
547 | + * Returns as an array the class we need to extend from and the list of use statements. |
|
548 | + * |
|
549 | + * @return array |
|
550 | + */ |
|
551 | + private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null) |
|
552 | + { |
|
553 | + $classes = []; |
|
554 | + if ($parentFk !== null) { |
|
555 | + $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
556 | + $classes[] = $extends; |
|
557 | + } |
|
558 | + |
|
559 | + foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) { |
|
560 | + $className = $beanPropertyDescriptor->getClassName(); |
|
561 | + if (null !== $className) { |
|
562 | + $classes[] = $beanPropertyDescriptor->getClassName(); |
|
563 | + } |
|
564 | + } |
|
565 | + |
|
566 | + foreach ($this->getPivotTableDescriptors() as $descriptor) { |
|
567 | + /* @var $fk ForeignKeyConstraint */ |
|
568 | + $fk = $descriptor['remoteFK']; |
|
569 | + $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName()); |
|
570 | + } |
|
571 | + |
|
572 | + // Many-to-one relationships |
|
573 | + $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
574 | + foreach ($fks as $fk) { |
|
575 | + $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
576 | + } |
|
577 | + |
|
578 | + $classes = array_unique($classes); |
|
579 | + |
|
580 | + return $classes; |
|
581 | + } |
|
582 | + |
|
583 | + /** |
|
584 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
585 | + * |
|
586 | + * @param string $beannamespace The namespace of the bean |
|
587 | + */ |
|
588 | + public function generatePhpCode($beannamespace) |
|
589 | + { |
|
590 | + $tableName = $this->table->getName(); |
|
591 | + $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName); |
|
592 | + $className = TDBMDaoGenerator::getBeanNameFromTableName($tableName); |
|
593 | + $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
594 | + |
|
595 | + $classes = $this->generateExtendsAndUseStatements($parentFk); |
|
596 | + |
|
597 | + $uses = array_map(function ($className) use ($beannamespace) { |
|
598 | + return 'use '.$beannamespace.'\\'.$className.";\n"; |
|
599 | + }, $classes); |
|
600 | + $use = implode('', $uses); |
|
601 | + |
|
602 | + if ($parentFk !== null) { |
|
603 | + $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
604 | + } else { |
|
605 | + $extends = 'AbstractTDBMObject'; |
|
606 | + $use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n"; |
|
607 | + } |
|
608 | + |
|
609 | + $str = "<?php |
|
610 | 610 | namespace {$beannamespace}\\Generated; |
611 | 611 | |
612 | 612 | use Mouf\\Database\\TDBM\\ResultIterator; |
@@ -626,126 +626,126 @@ discard block |
||
626 | 626 | { |
627 | 627 | "; |
628 | 628 | |
629 | - $str .= $this->generateBeanConstructor(); |
|
629 | + $str .= $this->generateBeanConstructor(); |
|
630 | 630 | |
631 | - foreach ($this->getExposedProperties() as $property) { |
|
632 | - $str .= $property->getGetterSetterCode(); |
|
633 | - } |
|
631 | + foreach ($this->getExposedProperties() as $property) { |
|
632 | + $str .= $property->getGetterSetterCode(); |
|
633 | + } |
|
634 | 634 | |
635 | - $str .= $this->generateDirectForeignKeysCode(); |
|
636 | - $str .= $this->generatePivotTableCode(); |
|
637 | - $str .= $this->generateJsonSerialize(); |
|
635 | + $str .= $this->generateDirectForeignKeysCode(); |
|
636 | + $str .= $this->generatePivotTableCode(); |
|
637 | + $str .= $this->generateJsonSerialize(); |
|
638 | 638 | |
639 | - $str .= $this->generateGetUsedTablesCode(); |
|
639 | + $str .= $this->generateGetUsedTablesCode(); |
|
640 | 640 | |
641 | - $str .= '} |
|
641 | + $str .= '} |
|
642 | 642 | '; |
643 | 643 | |
644 | - return $str; |
|
645 | - } |
|
646 | - |
|
647 | - /** |
|
648 | - * @param string $beanNamespace |
|
649 | - * @param string $beanClassName |
|
650 | - * |
|
651 | - * @return array first element: list of used beans, second item: PHP code as a string |
|
652 | - */ |
|
653 | - public function generateFindByDaoCode($beanNamespace, $beanClassName) |
|
654 | - { |
|
655 | - $code = ''; |
|
656 | - $usedBeans = []; |
|
657 | - foreach ($this->table->getIndexes() as $index) { |
|
658 | - if (!$index->isPrimary()) { |
|
659 | - list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName); |
|
660 | - $code .= $codeForIndex; |
|
661 | - $usedBeans = array_merge($usedBeans, $usedBeansForIndex); |
|
662 | - } |
|
663 | - } |
|
664 | - |
|
665 | - return [$usedBeans, $code]; |
|
666 | - } |
|
667 | - |
|
668 | - /** |
|
669 | - * @param Index $index |
|
670 | - * @param string $beanNamespace |
|
671 | - * @param string $beanClassName |
|
672 | - * |
|
673 | - * @return array first element: list of used beans, second item: PHP code as a string |
|
674 | - */ |
|
675 | - private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName) |
|
676 | - { |
|
677 | - $columns = $index->getColumns(); |
|
678 | - $usedBeans = []; |
|
679 | - |
|
680 | - /* |
|
644 | + return $str; |
|
645 | + } |
|
646 | + |
|
647 | + /** |
|
648 | + * @param string $beanNamespace |
|
649 | + * @param string $beanClassName |
|
650 | + * |
|
651 | + * @return array first element: list of used beans, second item: PHP code as a string |
|
652 | + */ |
|
653 | + public function generateFindByDaoCode($beanNamespace, $beanClassName) |
|
654 | + { |
|
655 | + $code = ''; |
|
656 | + $usedBeans = []; |
|
657 | + foreach ($this->table->getIndexes() as $index) { |
|
658 | + if (!$index->isPrimary()) { |
|
659 | + list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName); |
|
660 | + $code .= $codeForIndex; |
|
661 | + $usedBeans = array_merge($usedBeans, $usedBeansForIndex); |
|
662 | + } |
|
663 | + } |
|
664 | + |
|
665 | + return [$usedBeans, $code]; |
|
666 | + } |
|
667 | + |
|
668 | + /** |
|
669 | + * @param Index $index |
|
670 | + * @param string $beanNamespace |
|
671 | + * @param string $beanClassName |
|
672 | + * |
|
673 | + * @return array first element: list of used beans, second item: PHP code as a string |
|
674 | + */ |
|
675 | + private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName) |
|
676 | + { |
|
677 | + $columns = $index->getColumns(); |
|
678 | + $usedBeans = []; |
|
679 | + |
|
680 | + /* |
|
681 | 681 | * The list of elements building this index (expressed as columns or foreign keys) |
682 | 682 | * @var AbstractBeanPropertyDescriptor[] |
683 | 683 | */ |
684 | - $elements = []; |
|
685 | - |
|
686 | - foreach ($columns as $column) { |
|
687 | - $fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column)); |
|
688 | - if ($fk !== null) { |
|
689 | - if (!in_array($fk, $elements)) { |
|
690 | - $elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer); |
|
691 | - } |
|
692 | - } else { |
|
693 | - $elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column)); |
|
694 | - } |
|
695 | - } |
|
696 | - |
|
697 | - // If the index is actually only a foreign key, let's bypass it entirely. |
|
698 | - if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) { |
|
699 | - return [[], '']; |
|
700 | - } |
|
701 | - |
|
702 | - $methodNameComponent = []; |
|
703 | - $functionParameters = []; |
|
704 | - $first = true; |
|
705 | - foreach ($elements as $element) { |
|
706 | - $methodNameComponent[] = $element->getUpperCamelCaseName(); |
|
707 | - $functionParameter = $element->getClassName(); |
|
708 | - if ($functionParameter) { |
|
709 | - $usedBeans[] = $beanNamespace.'\\'.$functionParameter; |
|
710 | - $functionParameter .= ' '; |
|
711 | - } |
|
712 | - $functionParameter .= $element->getVariableName(); |
|
713 | - if ($first) { |
|
714 | - $first = false; |
|
715 | - } else { |
|
716 | - $functionParameter .= ' = null'; |
|
717 | - } |
|
718 | - $functionParameters[] = $functionParameter; |
|
719 | - } |
|
720 | - if ($index->isUnique()) { |
|
721 | - $methodName = 'findOneBy'.implode('And', $methodNameComponent); |
|
722 | - $calledMethod = 'findOne'; |
|
723 | - $returnType = "{$beanClassName}"; |
|
724 | - } else { |
|
725 | - $methodName = 'findBy'.implode('And', $methodNameComponent); |
|
726 | - $returnType = "{$beanClassName}[]|ResultIterator|ResultArray"; |
|
727 | - $calledMethod = 'find'; |
|
728 | - } |
|
729 | - $functionParametersString = implode(', ', $functionParameters); |
|
730 | - |
|
731 | - $count = 0; |
|
732 | - |
|
733 | - $params = []; |
|
734 | - $filterArrayCode = ''; |
|
735 | - $commentArguments = []; |
|
736 | - foreach ($elements as $element) { |
|
737 | - $params[] = $element->getParamAnnotation(); |
|
738 | - if ($element instanceof ScalarBeanPropertyDescriptor) { |
|
739 | - $filterArrayCode .= ' '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n"; |
|
740 | - } else { |
|
741 | - ++$count; |
|
742 | - $filterArrayCode .= ' '.$count.' => '.$element->getVariableName().",\n"; |
|
743 | - } |
|
744 | - $commentArguments[] = substr($element->getVariableName(), 1); |
|
745 | - } |
|
746 | - $paramsString = implode("\n", $params); |
|
747 | - |
|
748 | - $code = " |
|
684 | + $elements = []; |
|
685 | + |
|
686 | + foreach ($columns as $column) { |
|
687 | + $fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column)); |
|
688 | + if ($fk !== null) { |
|
689 | + if (!in_array($fk, $elements)) { |
|
690 | + $elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer); |
|
691 | + } |
|
692 | + } else { |
|
693 | + $elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column)); |
|
694 | + } |
|
695 | + } |
|
696 | + |
|
697 | + // If the index is actually only a foreign key, let's bypass it entirely. |
|
698 | + if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) { |
|
699 | + return [[], '']; |
|
700 | + } |
|
701 | + |
|
702 | + $methodNameComponent = []; |
|
703 | + $functionParameters = []; |
|
704 | + $first = true; |
|
705 | + foreach ($elements as $element) { |
|
706 | + $methodNameComponent[] = $element->getUpperCamelCaseName(); |
|
707 | + $functionParameter = $element->getClassName(); |
|
708 | + if ($functionParameter) { |
|
709 | + $usedBeans[] = $beanNamespace.'\\'.$functionParameter; |
|
710 | + $functionParameter .= ' '; |
|
711 | + } |
|
712 | + $functionParameter .= $element->getVariableName(); |
|
713 | + if ($first) { |
|
714 | + $first = false; |
|
715 | + } else { |
|
716 | + $functionParameter .= ' = null'; |
|
717 | + } |
|
718 | + $functionParameters[] = $functionParameter; |
|
719 | + } |
|
720 | + if ($index->isUnique()) { |
|
721 | + $methodName = 'findOneBy'.implode('And', $methodNameComponent); |
|
722 | + $calledMethod = 'findOne'; |
|
723 | + $returnType = "{$beanClassName}"; |
|
724 | + } else { |
|
725 | + $methodName = 'findBy'.implode('And', $methodNameComponent); |
|
726 | + $returnType = "{$beanClassName}[]|ResultIterator|ResultArray"; |
|
727 | + $calledMethod = 'find'; |
|
728 | + } |
|
729 | + $functionParametersString = implode(', ', $functionParameters); |
|
730 | + |
|
731 | + $count = 0; |
|
732 | + |
|
733 | + $params = []; |
|
734 | + $filterArrayCode = ''; |
|
735 | + $commentArguments = []; |
|
736 | + foreach ($elements as $element) { |
|
737 | + $params[] = $element->getParamAnnotation(); |
|
738 | + if ($element instanceof ScalarBeanPropertyDescriptor) { |
|
739 | + $filterArrayCode .= ' '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n"; |
|
740 | + } else { |
|
741 | + ++$count; |
|
742 | + $filterArrayCode .= ' '.$count.' => '.$element->getVariableName().",\n"; |
|
743 | + } |
|
744 | + $commentArguments[] = substr($element->getVariableName(), 1); |
|
745 | + } |
|
746 | + $paramsString = implode("\n", $params); |
|
747 | + |
|
748 | + $code = " |
|
749 | 749 | /** |
750 | 750 | * Get a list of $beanClassName filtered by ".implode(', ', $commentArguments).". |
751 | 751 | * |
@@ -763,27 +763,27 @@ discard block |
||
763 | 763 | } |
764 | 764 | "; |
765 | 765 | |
766 | - return [$usedBeans, $code]; |
|
767 | - } |
|
768 | - |
|
769 | - /** |
|
770 | - * Generates the code for the getUsedTable protected method. |
|
771 | - * |
|
772 | - * @return string |
|
773 | - */ |
|
774 | - private function generateGetUsedTablesCode() |
|
775 | - { |
|
776 | - $hasParentRelationship = $this->schemaAnalyzer->getParentRelationship($this->table->getName()) !== null; |
|
777 | - if ($hasParentRelationship) { |
|
778 | - $code = sprintf(' $tables = parent::getUsedTables(); |
|
766 | + return [$usedBeans, $code]; |
|
767 | + } |
|
768 | + |
|
769 | + /** |
|
770 | + * Generates the code for the getUsedTable protected method. |
|
771 | + * |
|
772 | + * @return string |
|
773 | + */ |
|
774 | + private function generateGetUsedTablesCode() |
|
775 | + { |
|
776 | + $hasParentRelationship = $this->schemaAnalyzer->getParentRelationship($this->table->getName()) !== null; |
|
777 | + if ($hasParentRelationship) { |
|
778 | + $code = sprintf(' $tables = parent::getUsedTables(); |
|
779 | 779 | $tables[] = %s; |
780 | 780 | |
781 | 781 | return $tables;', var_export($this->table->getName(), true)); |
782 | - } else { |
|
783 | - $code = sprintf(' return [ %s ];', var_export($this->table->getName(), true)); |
|
784 | - } |
|
782 | + } else { |
|
783 | + $code = sprintf(' return [ %s ];', var_export($this->table->getName(), true)); |
|
784 | + } |
|
785 | 785 | |
786 | - return sprintf(' |
|
786 | + return sprintf(' |
|
787 | 787 | /** |
788 | 788 | * Returns an array of used tables by this bean (from parent to child relationship). |
789 | 789 | * |
@@ -794,5 +794,5 @@ discard block |
||
794 | 794 | %s |
795 | 795 | } |
796 | 796 | ', $code); |
797 | - } |
|
797 | + } |
|
798 | 798 | } |