@@ -30,78 +30,78 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | class StandardObjectStorage |
| 32 | 32 | { |
| 33 | - /** |
|
| 34 | - * An array of fetched object, accessible via table name and primary key. |
|
| 35 | - * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
| 36 | - * |
|
| 37 | - * @var array<string, array<string, TDBMObject>> |
|
| 38 | - */ |
|
| 39 | - private $objects = array(); |
|
| 33 | + /** |
|
| 34 | + * An array of fetched object, accessible via table name and primary key. |
|
| 35 | + * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
| 36 | + * |
|
| 37 | + * @var array<string, array<string, TDBMObject>> |
|
| 38 | + */ |
|
| 39 | + private $objects = array(); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Sets an object in the storage. |
|
| 43 | - * |
|
| 44 | - * @param string $tableName |
|
| 45 | - * @param string $id |
|
| 46 | - * @param TDBMObject $dbRow |
|
| 47 | - */ |
|
| 48 | - public function set($tableName, $id, DbRow $dbRow) |
|
| 49 | - { |
|
| 50 | - $this->objects[$tableName][$id] = $dbRow; |
|
| 51 | - } |
|
| 41 | + /** |
|
| 42 | + * Sets an object in the storage. |
|
| 43 | + * |
|
| 44 | + * @param string $tableName |
|
| 45 | + * @param string $id |
|
| 46 | + * @param TDBMObject $dbRow |
|
| 47 | + */ |
|
| 48 | + public function set($tableName, $id, DbRow $dbRow) |
|
| 49 | + { |
|
| 50 | + $this->objects[$tableName][$id] = $dbRow; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Checks if an object is in the storage. |
|
| 55 | - * |
|
| 56 | - * @param string $tableName |
|
| 57 | - * @param string $id |
|
| 58 | - * |
|
| 59 | - * @return bool |
|
| 60 | - */ |
|
| 61 | - public function has($tableName, $id) |
|
| 62 | - { |
|
| 63 | - return isset($this->objects[$tableName][$id]); |
|
| 64 | - } |
|
| 53 | + /** |
|
| 54 | + * Checks if an object is in the storage. |
|
| 55 | + * |
|
| 56 | + * @param string $tableName |
|
| 57 | + * @param string $id |
|
| 58 | + * |
|
| 59 | + * @return bool |
|
| 60 | + */ |
|
| 61 | + public function has($tableName, $id) |
|
| 62 | + { |
|
| 63 | + return isset($this->objects[$tableName][$id]); |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Returns an object from the storage (or null if no object is set). |
|
| 68 | - * |
|
| 69 | - * @param string $tableName |
|
| 70 | - * @param string $id |
|
| 71 | - * |
|
| 72 | - * @return DbRow |
|
| 73 | - */ |
|
| 74 | - public function get($tableName, $id) |
|
| 75 | - { |
|
| 76 | - if (isset($this->objects[$tableName][$id])) { |
|
| 77 | - return $this->objects[$tableName][$id]; |
|
| 78 | - } else { |
|
| 79 | - return; |
|
| 80 | - } |
|
| 81 | - } |
|
| 66 | + /** |
|
| 67 | + * Returns an object from the storage (or null if no object is set). |
|
| 68 | + * |
|
| 69 | + * @param string $tableName |
|
| 70 | + * @param string $id |
|
| 71 | + * |
|
| 72 | + * @return DbRow |
|
| 73 | + */ |
|
| 74 | + public function get($tableName, $id) |
|
| 75 | + { |
|
| 76 | + if (isset($this->objects[$tableName][$id])) { |
|
| 77 | + return $this->objects[$tableName][$id]; |
|
| 78 | + } else { |
|
| 79 | + return; |
|
| 80 | + } |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Removes an object from the storage. |
|
| 85 | - * |
|
| 86 | - * @param string $tableName |
|
| 87 | - * @param string $id |
|
| 88 | - */ |
|
| 89 | - public function remove($tableName, $id) |
|
| 90 | - { |
|
| 91 | - unset($this->objects[$tableName][$id]); |
|
| 92 | - } |
|
| 83 | + /** |
|
| 84 | + * Removes an object from the storage. |
|
| 85 | + * |
|
| 86 | + * @param string $tableName |
|
| 87 | + * @param string $id |
|
| 88 | + */ |
|
| 89 | + public function remove($tableName, $id) |
|
| 90 | + { |
|
| 91 | + unset($this->objects[$tableName][$id]); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Applies the callback to all objects. |
|
| 96 | - * |
|
| 97 | - * @param callable $callback |
|
| 98 | - */ |
|
| 99 | - public function apply(callable $callback) |
|
| 100 | - { |
|
| 101 | - foreach ($this->objects as $tableName => $table) { |
|
| 102 | - foreach ($table as $id => $obj) { |
|
| 103 | - $callback($obj, $tableName, $id); |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - } |
|
| 94 | + /** |
|
| 95 | + * Applies the callback to all objects. |
|
| 96 | + * |
|
| 97 | + * @param callable $callback |
|
| 98 | + */ |
|
| 99 | + public function apply(callable $callback) |
|
| 100 | + { |
|
| 101 | + foreach ($this->objects as $tableName => $table) { |
|
| 102 | + foreach ($table as $id => $obj) { |
|
| 103 | + $callback($obj, $tableName, $id); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + } |
|
| 107 | 107 | } |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | */ |
| 113 | 113 | public function getCurrentPage() |
| 114 | 114 | { |
| 115 | - return floor($this->offset / $this->limit) + 1; |
|
| 115 | + return floor($this->offset/$this->limit)+1; |
|
| 116 | 116 | } |
| 117 | 117 | |
| 118 | 118 | /** |
@@ -251,7 +251,7 @@ discard block |
||
| 251 | 251 | */ |
| 252 | 252 | public function jsonSerialize() |
| 253 | 253 | { |
| 254 | - return array_map(function (AbstractTDBMObject $item) { |
|
| 254 | + return array_map(function(AbstractTDBMObject $item) { |
|
| 255 | 255 | return $item->jsonSerialize(); |
| 256 | 256 | }, $this->toArray()); |
| 257 | 257 | } |
@@ -29,232 +29,232 @@ |
||
| 29 | 29 | */ |
| 30 | 30 | class PageIterator implements Page, \ArrayAccess, \JsonSerializable |
| 31 | 31 | { |
| 32 | - /** |
|
| 33 | - * @var Statement |
|
| 34 | - */ |
|
| 35 | - protected $statement; |
|
| 32 | + /** |
|
| 33 | + * @var Statement |
|
| 34 | + */ |
|
| 35 | + protected $statement; |
|
| 36 | 36 | |
| 37 | - protected $fetchStarted = false; |
|
| 38 | - private $objectStorage; |
|
| 39 | - private $className; |
|
| 37 | + protected $fetchStarted = false; |
|
| 38 | + private $objectStorage; |
|
| 39 | + private $className; |
|
| 40 | 40 | |
| 41 | - private $parentResult; |
|
| 42 | - private $tdbmService; |
|
| 43 | - private $magicSql; |
|
| 44 | - private $parameters; |
|
| 45 | - private $limit; |
|
| 46 | - private $offset; |
|
| 47 | - private $columnDescriptors; |
|
| 48 | - private $magicQuery; |
|
| 41 | + private $parentResult; |
|
| 42 | + private $tdbmService; |
|
| 43 | + private $magicSql; |
|
| 44 | + private $parameters; |
|
| 45 | + private $limit; |
|
| 46 | + private $offset; |
|
| 47 | + private $columnDescriptors; |
|
| 48 | + private $magicQuery; |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * The key of the current retrieved object. |
|
| 52 | - * |
|
| 53 | - * @var int |
|
| 54 | - */ |
|
| 55 | - protected $key = -1; |
|
| 50 | + /** |
|
| 51 | + * The key of the current retrieved object. |
|
| 52 | + * |
|
| 53 | + * @var int |
|
| 54 | + */ |
|
| 55 | + protected $key = -1; |
|
| 56 | 56 | |
| 57 | - protected $current = null; |
|
| 57 | + protected $current = null; |
|
| 58 | 58 | |
| 59 | - private $databasePlatform; |
|
| 59 | + private $databasePlatform; |
|
| 60 | 60 | |
| 61 | - private $innerResultIterator; |
|
| 61 | + private $innerResultIterator; |
|
| 62 | 62 | |
| 63 | - private $mode; |
|
| 63 | + private $mode; |
|
| 64 | 64 | |
| 65 | - public function __construct(ResultIterator $parentResult, $magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode) |
|
| 66 | - { |
|
| 67 | - $this->parentResult = $parentResult; |
|
| 68 | - $this->magicSql = $magicSql; |
|
| 69 | - $this->objectStorage = $objectStorage; |
|
| 70 | - $this->className = $className; |
|
| 71 | - $this->tdbmService = $tdbmService; |
|
| 72 | - $this->parameters = $parameters; |
|
| 73 | - $this->limit = $limit; |
|
| 74 | - $this->offset = $offset; |
|
| 75 | - $this->columnDescriptors = $columnDescriptors; |
|
| 76 | - $this->magicQuery = $magicQuery; |
|
| 77 | - $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
| 78 | - $this->mode = $mode; |
|
| 79 | - } |
|
| 65 | + public function __construct(ResultIterator $parentResult, $magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode) |
|
| 66 | + { |
|
| 67 | + $this->parentResult = $parentResult; |
|
| 68 | + $this->magicSql = $magicSql; |
|
| 69 | + $this->objectStorage = $objectStorage; |
|
| 70 | + $this->className = $className; |
|
| 71 | + $this->tdbmService = $tdbmService; |
|
| 72 | + $this->parameters = $parameters; |
|
| 73 | + $this->limit = $limit; |
|
| 74 | + $this->offset = $offset; |
|
| 75 | + $this->columnDescriptors = $columnDescriptors; |
|
| 76 | + $this->magicQuery = $magicQuery; |
|
| 77 | + $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
| 78 | + $this->mode = $mode; |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * Retrieve an external iterator. |
|
| 83 | - * |
|
| 84 | - * @link http://php.net/manual/en/iteratoraggregate.getiterator.php |
|
| 85 | - * |
|
| 86 | - * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or |
|
| 87 | - * <b>Traversable</b> |
|
| 88 | - * |
|
| 89 | - * @since 5.0.0 |
|
| 90 | - */ |
|
| 91 | - public function getIterator() |
|
| 92 | - { |
|
| 93 | - if ($this->innerResultIterator === null) { |
|
| 94 | - if ($this->mode === TDBMService::MODE_CURSOR) { |
|
| 95 | - $this->innerResultIterator = new InnerResultIterator($this->magicSql, $this->parameters, $this->limit, $this->offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery); |
|
| 96 | - } else { |
|
| 97 | - $this->innerResultIterator = new InnerResultArray($this->magicSql, $this->parameters, $this->limit, $this->offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery); |
|
| 98 | - } |
|
| 99 | - } |
|
| 81 | + /** |
|
| 82 | + * Retrieve an external iterator. |
|
| 83 | + * |
|
| 84 | + * @link http://php.net/manual/en/iteratoraggregate.getiterator.php |
|
| 85 | + * |
|
| 86 | + * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or |
|
| 87 | + * <b>Traversable</b> |
|
| 88 | + * |
|
| 89 | + * @since 5.0.0 |
|
| 90 | + */ |
|
| 91 | + public function getIterator() |
|
| 92 | + { |
|
| 93 | + if ($this->innerResultIterator === null) { |
|
| 94 | + if ($this->mode === TDBMService::MODE_CURSOR) { |
|
| 95 | + $this->innerResultIterator = new InnerResultIterator($this->magicSql, $this->parameters, $this->limit, $this->offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery); |
|
| 96 | + } else { |
|
| 97 | + $this->innerResultIterator = new InnerResultArray($this->magicSql, $this->parameters, $this->limit, $this->offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery); |
|
| 98 | + } |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | - return $this->innerResultIterator; |
|
| 102 | - } |
|
| 101 | + return $this->innerResultIterator; |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | - /** |
|
| 105 | - * @return int |
|
| 106 | - */ |
|
| 107 | - public function getCurrentOffset() |
|
| 108 | - { |
|
| 109 | - return $this->offset; |
|
| 110 | - } |
|
| 104 | + /** |
|
| 105 | + * @return int |
|
| 106 | + */ |
|
| 107 | + public function getCurrentOffset() |
|
| 108 | + { |
|
| 109 | + return $this->offset; |
|
| 110 | + } |
|
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * @return int |
|
| 114 | - */ |
|
| 115 | - public function getCurrentPage() |
|
| 116 | - { |
|
| 117 | - return floor($this->offset / $this->limit) + 1; |
|
| 118 | - } |
|
| 112 | + /** |
|
| 113 | + * @return int |
|
| 114 | + */ |
|
| 115 | + public function getCurrentPage() |
|
| 116 | + { |
|
| 117 | + return floor($this->offset / $this->limit) + 1; |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * @return int |
|
| 122 | - */ |
|
| 123 | - public function getCurrentLimit() |
|
| 124 | - { |
|
| 125 | - return $this->limit; |
|
| 126 | - } |
|
| 120 | + /** |
|
| 121 | + * @return int |
|
| 122 | + */ |
|
| 123 | + public function getCurrentLimit() |
|
| 124 | + { |
|
| 125 | + return $this->limit; |
|
| 126 | + } |
|
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Return the number of results on the current page of the {@link Result}. |
|
| 130 | - * |
|
| 131 | - * @return int |
|
| 132 | - */ |
|
| 133 | - public function count() |
|
| 134 | - { |
|
| 135 | - return $this->getIterator()->count(); |
|
| 136 | - } |
|
| 128 | + /** |
|
| 129 | + * Return the number of results on the current page of the {@link Result}. |
|
| 130 | + * |
|
| 131 | + * @return int |
|
| 132 | + */ |
|
| 133 | + public function count() |
|
| 134 | + { |
|
| 135 | + return $this->getIterator()->count(); |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | - /** |
|
| 139 | - * Return the number of ALL results in the paginatable of {@link Result}. |
|
| 140 | - * |
|
| 141 | - * @return int |
|
| 142 | - */ |
|
| 143 | - public function totalCount() |
|
| 144 | - { |
|
| 145 | - return $this->parentResult->count(); |
|
| 146 | - } |
|
| 138 | + /** |
|
| 139 | + * Return the number of ALL results in the paginatable of {@link Result}. |
|
| 140 | + * |
|
| 141 | + * @return int |
|
| 142 | + */ |
|
| 143 | + public function totalCount() |
|
| 144 | + { |
|
| 145 | + return $this->parentResult->count(); |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Casts the result set to a PHP array. |
|
| 150 | - * |
|
| 151 | - * @return array |
|
| 152 | - */ |
|
| 153 | - public function toArray() |
|
| 154 | - { |
|
| 155 | - return iterator_to_array($this->getIterator()); |
|
| 156 | - } |
|
| 148 | + /** |
|
| 149 | + * Casts the result set to a PHP array. |
|
| 150 | + * |
|
| 151 | + * @return array |
|
| 152 | + */ |
|
| 153 | + public function toArray() |
|
| 154 | + { |
|
| 155 | + return iterator_to_array($this->getIterator()); |
|
| 156 | + } |
|
| 157 | 157 | |
| 158 | - /** |
|
| 159 | - * Returns a new iterator mapping any call using the $callable function. |
|
| 160 | - * |
|
| 161 | - * @param callable $callable |
|
| 162 | - * |
|
| 163 | - * @return MapIterator |
|
| 164 | - */ |
|
| 165 | - public function map(callable $callable) |
|
| 166 | - { |
|
| 167 | - return new MapIterator($this->getIterator(), $callable); |
|
| 168 | - } |
|
| 158 | + /** |
|
| 159 | + * Returns a new iterator mapping any call using the $callable function. |
|
| 160 | + * |
|
| 161 | + * @param callable $callable |
|
| 162 | + * |
|
| 163 | + * @return MapIterator |
|
| 164 | + */ |
|
| 165 | + public function map(callable $callable) |
|
| 166 | + { |
|
| 167 | + return new MapIterator($this->getIterator(), $callable); |
|
| 168 | + } |
|
| 169 | 169 | |
| 170 | - /** |
|
| 171 | - * Whether a offset exists. |
|
| 172 | - * |
|
| 173 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
| 174 | - * |
|
| 175 | - * @param mixed $offset <p> |
|
| 176 | - * An offset to check for. |
|
| 177 | - * </p> |
|
| 178 | - * |
|
| 179 | - * @return bool true on success or false on failure. |
|
| 180 | - * </p> |
|
| 181 | - * <p> |
|
| 182 | - * The return value will be casted to boolean if non-boolean was returned. |
|
| 183 | - * |
|
| 184 | - * @since 5.0.0 |
|
| 185 | - */ |
|
| 186 | - public function offsetExists($offset) |
|
| 187 | - { |
|
| 188 | - return $this->getIterator()->offsetExists($offset); |
|
| 189 | - } |
|
| 170 | + /** |
|
| 171 | + * Whether a offset exists. |
|
| 172 | + * |
|
| 173 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
| 174 | + * |
|
| 175 | + * @param mixed $offset <p> |
|
| 176 | + * An offset to check for. |
|
| 177 | + * </p> |
|
| 178 | + * |
|
| 179 | + * @return bool true on success or false on failure. |
|
| 180 | + * </p> |
|
| 181 | + * <p> |
|
| 182 | + * The return value will be casted to boolean if non-boolean was returned. |
|
| 183 | + * |
|
| 184 | + * @since 5.0.0 |
|
| 185 | + */ |
|
| 186 | + public function offsetExists($offset) |
|
| 187 | + { |
|
| 188 | + return $this->getIterator()->offsetExists($offset); |
|
| 189 | + } |
|
| 190 | 190 | |
| 191 | - /** |
|
| 192 | - * Offset to retrieve. |
|
| 193 | - * |
|
| 194 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
| 195 | - * |
|
| 196 | - * @param mixed $offset <p> |
|
| 197 | - * The offset to retrieve. |
|
| 198 | - * </p> |
|
| 199 | - * |
|
| 200 | - * @return mixed Can return all value types. |
|
| 201 | - * |
|
| 202 | - * @since 5.0.0 |
|
| 203 | - */ |
|
| 204 | - public function offsetGet($offset) |
|
| 205 | - { |
|
| 206 | - return $this->getIterator()->offsetGet($offset); |
|
| 207 | - } |
|
| 191 | + /** |
|
| 192 | + * Offset to retrieve. |
|
| 193 | + * |
|
| 194 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
| 195 | + * |
|
| 196 | + * @param mixed $offset <p> |
|
| 197 | + * The offset to retrieve. |
|
| 198 | + * </p> |
|
| 199 | + * |
|
| 200 | + * @return mixed Can return all value types. |
|
| 201 | + * |
|
| 202 | + * @since 5.0.0 |
|
| 203 | + */ |
|
| 204 | + public function offsetGet($offset) |
|
| 205 | + { |
|
| 206 | + return $this->getIterator()->offsetGet($offset); |
|
| 207 | + } |
|
| 208 | 208 | |
| 209 | - /** |
|
| 210 | - * Offset to set. |
|
| 211 | - * |
|
| 212 | - * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
| 213 | - * |
|
| 214 | - * @param mixed $offset <p> |
|
| 215 | - * The offset to assign the value to. |
|
| 216 | - * </p> |
|
| 217 | - * @param mixed $value <p> |
|
| 218 | - * The value to set. |
|
| 219 | - * </p> |
|
| 220 | - * |
|
| 221 | - * @since 5.0.0 |
|
| 222 | - */ |
|
| 223 | - public function offsetSet($offset, $value) |
|
| 224 | - { |
|
| 225 | - return $this->getIterator()->offsetSet($offset, $value); |
|
| 226 | - } |
|
| 209 | + /** |
|
| 210 | + * Offset to set. |
|
| 211 | + * |
|
| 212 | + * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
| 213 | + * |
|
| 214 | + * @param mixed $offset <p> |
|
| 215 | + * The offset to assign the value to. |
|
| 216 | + * </p> |
|
| 217 | + * @param mixed $value <p> |
|
| 218 | + * The value to set. |
|
| 219 | + * </p> |
|
| 220 | + * |
|
| 221 | + * @since 5.0.0 |
|
| 222 | + */ |
|
| 223 | + public function offsetSet($offset, $value) |
|
| 224 | + { |
|
| 225 | + return $this->getIterator()->offsetSet($offset, $value); |
|
| 226 | + } |
|
| 227 | 227 | |
| 228 | - /** |
|
| 229 | - * Offset to unset. |
|
| 230 | - * |
|
| 231 | - * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
| 232 | - * |
|
| 233 | - * @param mixed $offset <p> |
|
| 234 | - * The offset to unset. |
|
| 235 | - * </p> |
|
| 236 | - * |
|
| 237 | - * @since 5.0.0 |
|
| 238 | - */ |
|
| 239 | - public function offsetUnset($offset) |
|
| 240 | - { |
|
| 241 | - return $this->getIterator()->offsetUnset($offset); |
|
| 242 | - } |
|
| 228 | + /** |
|
| 229 | + * Offset to unset. |
|
| 230 | + * |
|
| 231 | + * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
| 232 | + * |
|
| 233 | + * @param mixed $offset <p> |
|
| 234 | + * The offset to unset. |
|
| 235 | + * </p> |
|
| 236 | + * |
|
| 237 | + * @since 5.0.0 |
|
| 238 | + */ |
|
| 239 | + public function offsetUnset($offset) |
|
| 240 | + { |
|
| 241 | + return $this->getIterator()->offsetUnset($offset); |
|
| 242 | + } |
|
| 243 | 243 | |
| 244 | - /** |
|
| 245 | - * Specify data which should be serialized to JSON. |
|
| 246 | - * |
|
| 247 | - * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
| 248 | - * |
|
| 249 | - * @return mixed data which can be serialized by <b>json_encode</b>, |
|
| 250 | - * which is a value of any type other than a resource. |
|
| 251 | - * |
|
| 252 | - * @since 5.4.0 |
|
| 253 | - */ |
|
| 254 | - public function jsonSerialize() |
|
| 255 | - { |
|
| 256 | - return array_map(function (AbstractTDBMObject $item) { |
|
| 257 | - return $item->jsonSerialize(); |
|
| 258 | - }, $this->toArray()); |
|
| 259 | - } |
|
| 244 | + /** |
|
| 245 | + * Specify data which should be serialized to JSON. |
|
| 246 | + * |
|
| 247 | + * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
| 248 | + * |
|
| 249 | + * @return mixed data which can be serialized by <b>json_encode</b>, |
|
| 250 | + * which is a value of any type other than a resource. |
|
| 251 | + * |
|
| 252 | + * @since 5.4.0 |
|
| 253 | + */ |
|
| 254 | + public function jsonSerialize() |
|
| 255 | + { |
|
| 256 | + return array_map(function (AbstractTDBMObject $item) { |
|
| 257 | + return $item->jsonSerialize(); |
|
| 258 | + }, $this->toArray()); |
|
| 259 | + } |
|
| 260 | 260 | } |
@@ -8,7 +8,7 @@ |
||
| 8 | 8 | <input type="hidden" id="selfedit" name="selfedit" value="<?php echo plainstring_to_htmlprotected($this->selfedit) ?>" /> |
| 9 | 9 | |
| 10 | 10 | <?php if (!$this->autoloadDetected) { |
| 11 | - ?> |
|
| 11 | + ?> |
|
| 12 | 12 | <div class="alert">Warning! TDBM could not detect the autoload section of your composer.json file. |
| 13 | 13 | Unless you are developing your own autoload system, you should configure <strong>composer.json</strong> to <a href="http://getcomposer.org/doc/01-basic-usage.md#autoloading" target="_blank">define a source directory and a root namespace using PSR-0</a>.</div> |
| 14 | 14 | <?php |
@@ -28,246 +28,246 @@ |
||
| 28 | 28 | */ |
| 29 | 29 | class InnerResultIterator implements \Iterator, \Countable, \ArrayAccess |
| 30 | 30 | { |
| 31 | - /** |
|
| 32 | - * @var Statement |
|
| 33 | - */ |
|
| 34 | - protected $statement; |
|
| 35 | - |
|
| 36 | - protected $fetchStarted = false; |
|
| 37 | - private $objectStorage; |
|
| 38 | - private $className; |
|
| 39 | - |
|
| 40 | - private $tdbmService; |
|
| 41 | - private $magicSql; |
|
| 42 | - private $parameters; |
|
| 43 | - private $limit; |
|
| 44 | - private $offset; |
|
| 45 | - private $columnDescriptors; |
|
| 46 | - private $magicQuery; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * The key of the current retrieved object. |
|
| 50 | - * |
|
| 51 | - * @var int |
|
| 52 | - */ |
|
| 53 | - protected $key = -1; |
|
| 54 | - |
|
| 55 | - protected $current = null; |
|
| 56 | - |
|
| 57 | - private $databasePlatform; |
|
| 58 | - |
|
| 59 | - public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery) |
|
| 60 | - { |
|
| 61 | - $this->magicSql = $magicSql; |
|
| 62 | - $this->objectStorage = $objectStorage; |
|
| 63 | - $this->className = $className; |
|
| 64 | - $this->tdbmService = $tdbmService; |
|
| 65 | - $this->parameters = $parameters; |
|
| 66 | - $this->limit = $limit; |
|
| 67 | - $this->offset = $offset; |
|
| 68 | - $this->columnDescriptors = $columnDescriptors; |
|
| 69 | - $this->magicQuery = $magicQuery; |
|
| 70 | - $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - protected function executeQuery() |
|
| 74 | - { |
|
| 75 | - $sql = $this->magicQuery->build($this->magicSql, $this->parameters); |
|
| 76 | - $sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset); |
|
| 77 | - |
|
| 78 | - $this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters); |
|
| 79 | - |
|
| 80 | - $this->fetchStarted = true; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings). |
|
| 85 | - * |
|
| 86 | - * @return int |
|
| 87 | - */ |
|
| 88 | - public function count() |
|
| 89 | - { |
|
| 90 | - if (!$this->fetchStarted) { |
|
| 91 | - $this->executeQuery(); |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - return $this->statement->rowCount(); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - /** |
|
| 98 | - * Fetches record at current cursor. |
|
| 99 | - * |
|
| 100 | - * @return AbstractTDBMObject|null |
|
| 101 | - */ |
|
| 102 | - public function current() |
|
| 103 | - { |
|
| 104 | - return $this->current; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Returns the current result's key. |
|
| 109 | - * |
|
| 110 | - * @return int |
|
| 111 | - */ |
|
| 112 | - public function key() |
|
| 113 | - { |
|
| 114 | - return $this->key; |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * Advances the cursor to the next result. |
|
| 119 | - * Casts the database result into one (or several) beans. |
|
| 120 | - */ |
|
| 121 | - public function next() |
|
| 122 | - { |
|
| 123 | - $row = $this->statement->fetch(\PDO::FETCH_NUM); |
|
| 124 | - if ($row) { |
|
| 125 | - |
|
| 126 | - // array<tablegroup, array<table, array<column, value>>> |
|
| 127 | - $beansData = []; |
|
| 128 | - foreach ($row as $i => $value) { |
|
| 129 | - $columnDescriptor = $this->columnDescriptors[$i]; |
|
| 130 | - // Let's cast the value according to its type |
|
| 131 | - $value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform); |
|
| 132 | - |
|
| 133 | - $beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value; |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - $reflectionClassCache = []; |
|
| 137 | - $firstBean = true; |
|
| 138 | - foreach ($beansData as $beanData) { |
|
| 139 | - |
|
| 140 | - // Let's find the bean class name associated to the bean. |
|
| 141 | - |
|
| 142 | - list($actualClassName, $mainBeanTableName) = $this->tdbmService->_getClassNameFromBeanData($beanData); |
|
| 143 | - |
|
| 144 | - if ($this->className !== null) { |
|
| 145 | - $actualClassName = $this->className; |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - // Must we create the bean? Let's see in the cache if we have a mapping DbRow? |
|
| 149 | - // Let's get the first object mapping a row: |
|
| 150 | - // We do this loop only for the first table |
|
| 151 | - |
|
| 152 | - $primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]); |
|
| 153 | - $hash = $this->tdbmService->getObjectHash($primaryKeys); |
|
| 154 | - |
|
| 155 | - if ($this->objectStorage->has($mainBeanTableName, $hash)) { |
|
| 156 | - $dbRow = $this->objectStorage->get($mainBeanTableName, $hash); |
|
| 157 | - $bean = $dbRow->getTDBMObject(); |
|
| 158 | - } else { |
|
| 159 | - // Let's construct the bean |
|
| 160 | - if (!isset($reflectionClassCache[$actualClassName])) { |
|
| 161 | - $reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName); |
|
| 162 | - } |
|
| 163 | - // Let's bypass the constructor when creating the bean! |
|
| 164 | - $bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor(); |
|
| 165 | - $bean->_constructFromData($beanData, $this->tdbmService); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - // The first bean is the one containing the main table. |
|
| 169 | - if ($firstBean) { |
|
| 170 | - $firstBean = false; |
|
| 171 | - $this->current = $bean; |
|
| 172 | - } |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - ++$this->key; |
|
| 176 | - } else { |
|
| 177 | - $this->current = null; |
|
| 178 | - } |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Moves the cursor to the beginning of the result set. |
|
| 183 | - */ |
|
| 184 | - public function rewind() |
|
| 185 | - { |
|
| 186 | - $this->executeQuery(); |
|
| 187 | - $this->key = -1; |
|
| 188 | - $this->next(); |
|
| 189 | - } |
|
| 190 | - /** |
|
| 191 | - * Checks if the cursor is reading a valid result. |
|
| 192 | - * |
|
| 193 | - * @return bool |
|
| 194 | - */ |
|
| 195 | - public function valid() |
|
| 196 | - { |
|
| 197 | - return $this->current !== null; |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - /** |
|
| 201 | - * Whether a offset exists. |
|
| 202 | - * |
|
| 203 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
| 204 | - * |
|
| 205 | - * @param mixed $offset <p> |
|
| 206 | - * An offset to check for. |
|
| 207 | - * </p> |
|
| 208 | - * |
|
| 209 | - * @return bool true on success or false on failure. |
|
| 210 | - * </p> |
|
| 211 | - * <p> |
|
| 212 | - * The return value will be casted to boolean if non-boolean was returned. |
|
| 213 | - * |
|
| 214 | - * @since 5.0.0 |
|
| 215 | - */ |
|
| 216 | - public function offsetExists($offset) |
|
| 217 | - { |
|
| 218 | - throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.'); |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * Offset to retrieve. |
|
| 223 | - * |
|
| 224 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
| 225 | - * |
|
| 226 | - * @param mixed $offset <p> |
|
| 227 | - * The offset to retrieve. |
|
| 228 | - * </p> |
|
| 229 | - * |
|
| 230 | - * @return mixed Can return all value types. |
|
| 231 | - * |
|
| 232 | - * @since 5.0.0 |
|
| 233 | - */ |
|
| 234 | - public function offsetGet($offset) |
|
| 235 | - { |
|
| 236 | - throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.'); |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - /** |
|
| 240 | - * Offset to set. |
|
| 241 | - * |
|
| 242 | - * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
| 243 | - * |
|
| 244 | - * @param mixed $offset <p> |
|
| 245 | - * The offset to assign the value to. |
|
| 246 | - * </p> |
|
| 247 | - * @param mixed $value <p> |
|
| 248 | - * The value to set. |
|
| 249 | - * </p> |
|
| 250 | - * |
|
| 251 | - * @since 5.0.0 |
|
| 252 | - */ |
|
| 253 | - public function offsetSet($offset, $value) |
|
| 254 | - { |
|
| 255 | - throw new TDBMInvalidOperationException('You can set values in a TDBM result set.'); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * Offset to unset. |
|
| 260 | - * |
|
| 261 | - * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
| 262 | - * |
|
| 263 | - * @param mixed $offset <p> |
|
| 264 | - * The offset to unset. |
|
| 265 | - * </p> |
|
| 266 | - * |
|
| 267 | - * @since 5.0.0 |
|
| 268 | - */ |
|
| 269 | - public function offsetUnset($offset) |
|
| 270 | - { |
|
| 271 | - throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.'); |
|
| 272 | - } |
|
| 31 | + /** |
|
| 32 | + * @var Statement |
|
| 33 | + */ |
|
| 34 | + protected $statement; |
|
| 35 | + |
|
| 36 | + protected $fetchStarted = false; |
|
| 37 | + private $objectStorage; |
|
| 38 | + private $className; |
|
| 39 | + |
|
| 40 | + private $tdbmService; |
|
| 41 | + private $magicSql; |
|
| 42 | + private $parameters; |
|
| 43 | + private $limit; |
|
| 44 | + private $offset; |
|
| 45 | + private $columnDescriptors; |
|
| 46 | + private $magicQuery; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * The key of the current retrieved object. |
|
| 50 | + * |
|
| 51 | + * @var int |
|
| 52 | + */ |
|
| 53 | + protected $key = -1; |
|
| 54 | + |
|
| 55 | + protected $current = null; |
|
| 56 | + |
|
| 57 | + private $databasePlatform; |
|
| 58 | + |
|
| 59 | + public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery) |
|
| 60 | + { |
|
| 61 | + $this->magicSql = $magicSql; |
|
| 62 | + $this->objectStorage = $objectStorage; |
|
| 63 | + $this->className = $className; |
|
| 64 | + $this->tdbmService = $tdbmService; |
|
| 65 | + $this->parameters = $parameters; |
|
| 66 | + $this->limit = $limit; |
|
| 67 | + $this->offset = $offset; |
|
| 68 | + $this->columnDescriptors = $columnDescriptors; |
|
| 69 | + $this->magicQuery = $magicQuery; |
|
| 70 | + $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + protected function executeQuery() |
|
| 74 | + { |
|
| 75 | + $sql = $this->magicQuery->build($this->magicSql, $this->parameters); |
|
| 76 | + $sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset); |
|
| 77 | + |
|
| 78 | + $this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters); |
|
| 79 | + |
|
| 80 | + $this->fetchStarted = true; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings). |
|
| 85 | + * |
|
| 86 | + * @return int |
|
| 87 | + */ |
|
| 88 | + public function count() |
|
| 89 | + { |
|
| 90 | + if (!$this->fetchStarted) { |
|
| 91 | + $this->executeQuery(); |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + return $this->statement->rowCount(); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + /** |
|
| 98 | + * Fetches record at current cursor. |
|
| 99 | + * |
|
| 100 | + * @return AbstractTDBMObject|null |
|
| 101 | + */ |
|
| 102 | + public function current() |
|
| 103 | + { |
|
| 104 | + return $this->current; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Returns the current result's key. |
|
| 109 | + * |
|
| 110 | + * @return int |
|
| 111 | + */ |
|
| 112 | + public function key() |
|
| 113 | + { |
|
| 114 | + return $this->key; |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * Advances the cursor to the next result. |
|
| 119 | + * Casts the database result into one (or several) beans. |
|
| 120 | + */ |
|
| 121 | + public function next() |
|
| 122 | + { |
|
| 123 | + $row = $this->statement->fetch(\PDO::FETCH_NUM); |
|
| 124 | + if ($row) { |
|
| 125 | + |
|
| 126 | + // array<tablegroup, array<table, array<column, value>>> |
|
| 127 | + $beansData = []; |
|
| 128 | + foreach ($row as $i => $value) { |
|
| 129 | + $columnDescriptor = $this->columnDescriptors[$i]; |
|
| 130 | + // Let's cast the value according to its type |
|
| 131 | + $value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform); |
|
| 132 | + |
|
| 133 | + $beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value; |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + $reflectionClassCache = []; |
|
| 137 | + $firstBean = true; |
|
| 138 | + foreach ($beansData as $beanData) { |
|
| 139 | + |
|
| 140 | + // Let's find the bean class name associated to the bean. |
|
| 141 | + |
|
| 142 | + list($actualClassName, $mainBeanTableName) = $this->tdbmService->_getClassNameFromBeanData($beanData); |
|
| 143 | + |
|
| 144 | + if ($this->className !== null) { |
|
| 145 | + $actualClassName = $this->className; |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + // Must we create the bean? Let's see in the cache if we have a mapping DbRow? |
|
| 149 | + // Let's get the first object mapping a row: |
|
| 150 | + // We do this loop only for the first table |
|
| 151 | + |
|
| 152 | + $primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]); |
|
| 153 | + $hash = $this->tdbmService->getObjectHash($primaryKeys); |
|
| 154 | + |
|
| 155 | + if ($this->objectStorage->has($mainBeanTableName, $hash)) { |
|
| 156 | + $dbRow = $this->objectStorage->get($mainBeanTableName, $hash); |
|
| 157 | + $bean = $dbRow->getTDBMObject(); |
|
| 158 | + } else { |
|
| 159 | + // Let's construct the bean |
|
| 160 | + if (!isset($reflectionClassCache[$actualClassName])) { |
|
| 161 | + $reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName); |
|
| 162 | + } |
|
| 163 | + // Let's bypass the constructor when creating the bean! |
|
| 164 | + $bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor(); |
|
| 165 | + $bean->_constructFromData($beanData, $this->tdbmService); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + // The first bean is the one containing the main table. |
|
| 169 | + if ($firstBean) { |
|
| 170 | + $firstBean = false; |
|
| 171 | + $this->current = $bean; |
|
| 172 | + } |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + ++$this->key; |
|
| 176 | + } else { |
|
| 177 | + $this->current = null; |
|
| 178 | + } |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Moves the cursor to the beginning of the result set. |
|
| 183 | + */ |
|
| 184 | + public function rewind() |
|
| 185 | + { |
|
| 186 | + $this->executeQuery(); |
|
| 187 | + $this->key = -1; |
|
| 188 | + $this->next(); |
|
| 189 | + } |
|
| 190 | + /** |
|
| 191 | + * Checks if the cursor is reading a valid result. |
|
| 192 | + * |
|
| 193 | + * @return bool |
|
| 194 | + */ |
|
| 195 | + public function valid() |
|
| 196 | + { |
|
| 197 | + return $this->current !== null; |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + /** |
|
| 201 | + * Whether a offset exists. |
|
| 202 | + * |
|
| 203 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
| 204 | + * |
|
| 205 | + * @param mixed $offset <p> |
|
| 206 | + * An offset to check for. |
|
| 207 | + * </p> |
|
| 208 | + * |
|
| 209 | + * @return bool true on success or false on failure. |
|
| 210 | + * </p> |
|
| 211 | + * <p> |
|
| 212 | + * The return value will be casted to boolean if non-boolean was returned. |
|
| 213 | + * |
|
| 214 | + * @since 5.0.0 |
|
| 215 | + */ |
|
| 216 | + public function offsetExists($offset) |
|
| 217 | + { |
|
| 218 | + throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.'); |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * Offset to retrieve. |
|
| 223 | + * |
|
| 224 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
| 225 | + * |
|
| 226 | + * @param mixed $offset <p> |
|
| 227 | + * The offset to retrieve. |
|
| 228 | + * </p> |
|
| 229 | + * |
|
| 230 | + * @return mixed Can return all value types. |
|
| 231 | + * |
|
| 232 | + * @since 5.0.0 |
|
| 233 | + */ |
|
| 234 | + public function offsetGet($offset) |
|
| 235 | + { |
|
| 236 | + throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.'); |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + /** |
|
| 240 | + * Offset to set. |
|
| 241 | + * |
|
| 242 | + * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
| 243 | + * |
|
| 244 | + * @param mixed $offset <p> |
|
| 245 | + * The offset to assign the value to. |
|
| 246 | + * </p> |
|
| 247 | + * @param mixed $value <p> |
|
| 248 | + * The value to set. |
|
| 249 | + * </p> |
|
| 250 | + * |
|
| 251 | + * @since 5.0.0 |
|
| 252 | + */ |
|
| 253 | + public function offsetSet($offset, $value) |
|
| 254 | + { |
|
| 255 | + throw new TDBMInvalidOperationException('You can set values in a TDBM result set.'); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * Offset to unset. |
|
| 260 | + * |
|
| 261 | + * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
| 262 | + * |
|
| 263 | + * @param mixed $offset <p> |
|
| 264 | + * The offset to unset. |
|
| 265 | + * </p> |
|
| 266 | + * |
|
| 267 | + * @since 5.0.0 |
|
| 268 | + */ |
|
| 269 | + public function offsetUnset($offset) |
|
| 270 | + { |
|
| 271 | + throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.'); |
|
| 272 | + } |
|
| 273 | 273 | } |
@@ -33,28 +33,28 @@ |
||
| 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 | - } |
|
| 40 | - |
|
| 41 | - public function setProperty($var, $value, $tableName = null) |
|
| 42 | - { |
|
| 43 | - $this->set($var, $value, $tableName); |
|
| 44 | - } |
|
| 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 | - } |
|
| 36 | + public function getProperty($var, $tableName = null) |
|
| 37 | + { |
|
| 38 | + return $this->get($var, $tableName); |
|
| 39 | + } |
|
| 40 | + |
|
| 41 | + public function setProperty($var, $value, $tableName = null) |
|
| 42 | + { |
|
| 43 | + $this->set($var, $value, $tableName); |
|
| 44 | + } |
|
| 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 | + } |
|
| 60 | 60 | } |
@@ -186,7 +186,7 @@ discard block |
||
| 186 | 186 | */ |
| 187 | 187 | private function checkTableName($tableName = null) { |
| 188 | 188 | if ($tableName === null) { |
| 189 | - if (count($this->dbRows) > 1) { |
|
| 189 | + if (count($this->dbRows)>1) { |
|
| 190 | 190 | throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
| 191 | 191 | } elseif (count($this->dbRows) === 1) { |
| 192 | 192 | $tableName = array_keys($this->dbRows)[0]; |
@@ -213,7 +213,7 @@ discard block |
||
| 213 | 213 | protected function set($var, $value, $tableName = null) |
| 214 | 214 | { |
| 215 | 215 | if ($tableName === null) { |
| 216 | - if (count($this->dbRows) > 1) { |
|
| 216 | + if (count($this->dbRows)>1) { |
|
| 217 | 217 | throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
| 218 | 218 | } elseif (count($this->dbRows) === 1) { |
| 219 | 219 | $tableName = array_keys($this->dbRows)[0]; |
@@ -239,7 +239,7 @@ discard block |
||
| 239 | 239 | protected function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null) |
| 240 | 240 | { |
| 241 | 241 | if ($tableName === null) { |
| 242 | - if (count($this->dbRows) > 1) { |
|
| 242 | + if (count($this->dbRows)>1) { |
|
| 243 | 243 | throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
| 244 | 244 | } elseif (count($this->dbRows) === 1) { |
| 245 | 245 | $tableName = array_keys($this->dbRows)[0]; |
@@ -31,495 +31,495 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | abstract class AbstractTDBMObject implements JsonSerializable |
| 33 | 33 | { |
| 34 | - /** |
|
| 35 | - * The service this object is bound to. |
|
| 36 | - * |
|
| 37 | - * @var TDBMService |
|
| 38 | - */ |
|
| 39 | - protected $tdbmService; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * An array of DbRow, indexed by table name. |
|
| 43 | - * |
|
| 44 | - * @var DbRow[] |
|
| 45 | - */ |
|
| 46 | - protected $dbRows = array(); |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 50 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 51 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 52 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 53 | - * |
|
| 54 | - * @var string |
|
| 55 | - */ |
|
| 56 | - private $status; |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * Array storing beans related via many to many relationships (pivot tables). |
|
| 60 | - * |
|
| 61 | - * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage |
|
| 62 | - */ |
|
| 63 | - private $relationships = []; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * @var bool[] Key: pivot table name, value: whether a query was performed to load the data. |
|
| 67 | - */ |
|
| 68 | - private $loadedRelationships = []; |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * Used with $primaryKeys when we want to retrieve an existing object |
|
| 72 | - * and $primaryKeys=[] if we want a new object. |
|
| 73 | - * |
|
| 74 | - * @param string $tableName |
|
| 75 | - * @param array $primaryKeys |
|
| 76 | - * @param TDBMService $tdbmService |
|
| 77 | - * |
|
| 78 | - * @throws TDBMException |
|
| 79 | - * @throws TDBMInvalidOperationException |
|
| 80 | - */ |
|
| 81 | - public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) |
|
| 82 | - { |
|
| 83 | - // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation... |
|
| 84 | - if (!empty($tableName)) { |
|
| 85 | - $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - if ($tdbmService === null) { |
|
| 89 | - $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED); |
|
| 90 | - } else { |
|
| 91 | - $this->_attach($tdbmService); |
|
| 92 | - if (!empty($primaryKeys)) { |
|
| 93 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
| 94 | - } else { |
|
| 95 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NEW); |
|
| 96 | - } |
|
| 97 | - } |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * Alternative constructor called when data is fetched from database via a SELECT. |
|
| 102 | - * |
|
| 103 | - * @param array $beanData array<table, array<column, value>> |
|
| 104 | - * @param TDBMService $tdbmService |
|
| 105 | - */ |
|
| 106 | - public function _constructFromData(array $beanData, TDBMService $tdbmService) |
|
| 107 | - { |
|
| 108 | - $this->tdbmService = $tdbmService; |
|
| 109 | - |
|
| 110 | - foreach ($beanData as $table => $columns) { |
|
| 111 | - $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns); |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * Alternative constructor called when bean is lazily loaded. |
|
| 119 | - * |
|
| 120 | - * @param string $tableName |
|
| 121 | - * @param array $primaryKeys |
|
| 122 | - * @param TDBMService $tdbmService |
|
| 123 | - */ |
|
| 124 | - public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService) |
|
| 125 | - { |
|
| 126 | - $this->tdbmService = $tdbmService; |
|
| 127 | - |
|
| 128 | - $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
| 129 | - |
|
| 130 | - $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - public function _attach(TDBMService $tdbmService) |
|
| 134 | - { |
|
| 135 | - if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 136 | - throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
| 137 | - } |
|
| 138 | - $this->tdbmService = $tdbmService; |
|
| 139 | - |
|
| 140 | - // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level) |
|
| 141 | - $tableNames = array_keys($this->dbRows); |
|
| 142 | - $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames); |
|
| 143 | - $tableNames = array_reverse($tableNames); |
|
| 144 | - |
|
| 145 | - $newDbRows = []; |
|
| 146 | - |
|
| 147 | - foreach ($tableNames as $table) { |
|
| 148 | - if (!isset($this->dbRows[$table])) { |
|
| 149 | - $this->registerTable($table); |
|
| 150 | - } |
|
| 151 | - $newDbRows[$table] = $this->dbRows[$table]; |
|
| 152 | - } |
|
| 153 | - $this->dbRows = $newDbRows; |
|
| 154 | - |
|
| 155 | - $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
| 156 | - foreach ($this->dbRows as $dbRow) { |
|
| 157 | - $dbRow->_attach($tdbmService); |
|
| 158 | - } |
|
| 159 | - } |
|
| 160 | - |
|
| 161 | - /** |
|
| 162 | - * Sets the state of the TDBM Object |
|
| 163 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 164 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 165 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 166 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 167 | - * |
|
| 168 | - * @param string $state |
|
| 169 | - */ |
|
| 170 | - public function _setStatus($state) |
|
| 171 | - { |
|
| 172 | - $this->status = $state; |
|
| 173 | - |
|
| 174 | - // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself. |
|
| 175 | - foreach ($this->dbRows as $dbRow) { |
|
| 176 | - $dbRow->_setStatus($state); |
|
| 177 | - } |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null" |
|
| 182 | - * or throws an error. |
|
| 183 | - * |
|
| 184 | - * @param string $tableName |
|
| 185 | - * |
|
| 186 | - * @return string |
|
| 187 | - */ |
|
| 188 | - private function checkTableName($tableName = null) |
|
| 189 | - { |
|
| 190 | - if ($tableName === null) { |
|
| 191 | - if (count($this->dbRows) > 1) { |
|
| 192 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 193 | - } elseif (count($this->dbRows) === 1) { |
|
| 194 | - $tableName = array_keys($this->dbRows)[0]; |
|
| 195 | - } |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - if (!isset($this->dbRows[$tableName])) { |
|
| 199 | - if (count($this->dbRows[$tableName] === 0)) { |
|
| 200 | - throw new TDBMException('Object is not yet bound to any table.'); |
|
| 201 | - } else { |
|
| 202 | - throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
| 203 | - } |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - return $tableName; |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - protected function get($var, $tableName = null) |
|
| 210 | - { |
|
| 211 | - $tableName = $this->checkTableName($tableName); |
|
| 212 | - |
|
| 213 | - return $this->dbRows[$tableName]->get($var); |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - protected function set($var, $value, $tableName = null) |
|
| 217 | - { |
|
| 218 | - if ($tableName === null) { |
|
| 219 | - if (count($this->dbRows) > 1) { |
|
| 220 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 221 | - } elseif (count($this->dbRows) === 1) { |
|
| 222 | - $tableName = array_keys($this->dbRows)[0]; |
|
| 223 | - } else { |
|
| 224 | - throw new TDBMException('Please specify a table for this object.'); |
|
| 225 | - } |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - if (!isset($this->dbRows[$tableName])) { |
|
| 229 | - $this->registerTable($tableName); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - $this->dbRows[$tableName]->set($var, $value); |
|
| 233 | - if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
| 234 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
| 235 | - } |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * @param string $foreignKeyName |
|
| 240 | - * @param AbstractTDBMObject $bean |
|
| 241 | - */ |
|
| 242 | - protected function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null) |
|
| 243 | - { |
|
| 244 | - if ($tableName === null) { |
|
| 245 | - if (count($this->dbRows) > 1) { |
|
| 246 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 247 | - } elseif (count($this->dbRows) === 1) { |
|
| 248 | - $tableName = array_keys($this->dbRows)[0]; |
|
| 249 | - } else { |
|
| 250 | - throw new TDBMException('Please specify a table for this object.'); |
|
| 251 | - } |
|
| 252 | - } |
|
| 253 | - |
|
| 254 | - if (!isset($this->dbRows[$tableName])) { |
|
| 255 | - $this->registerTable($tableName); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - $this->dbRows[$tableName]->setRef($foreignKeyName, $bean); |
|
| 259 | - if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
| 260 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
| 261 | - } |
|
| 262 | - } |
|
| 263 | - |
|
| 264 | - /** |
|
| 265 | - * @param string $foreignKeyName A unique name for this reference |
|
| 266 | - * |
|
| 267 | - * @return AbstractTDBMObject|null |
|
| 268 | - */ |
|
| 269 | - protected function getRef($foreignKeyName, $tableName = null) |
|
| 270 | - { |
|
| 271 | - $tableName = $this->checkTableName($tableName); |
|
| 272 | - |
|
| 273 | - return $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - /** |
|
| 277 | - * Adds a many to many relationship to this bean. |
|
| 278 | - * |
|
| 279 | - * @param string $pivotTableName |
|
| 280 | - * @param AbstractTDBMObject $remoteBean |
|
| 281 | - */ |
|
| 282 | - protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 283 | - { |
|
| 284 | - $this->setRelationship($pivotTableName, $remoteBean, 'new'); |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - /** |
|
| 288 | - * Returns true if there is a relationship to this bean. |
|
| 289 | - * |
|
| 290 | - * @param string $pivotTableName |
|
| 291 | - * @param AbstractTDBMObject $remoteBean |
|
| 292 | - * |
|
| 293 | - * @return bool |
|
| 294 | - */ |
|
| 295 | - protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 296 | - { |
|
| 297 | - $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
| 298 | - |
|
| 299 | - if ($storage->contains($remoteBean)) { |
|
| 300 | - if ($storage[$remoteBean]['status'] !== 'delete') { |
|
| 301 | - return true; |
|
| 302 | - } |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - return false; |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * Internal TDBM method. Removes a many to many relationship from this bean. |
|
| 310 | - * |
|
| 311 | - * @param string $pivotTableName |
|
| 312 | - * @param AbstractTDBMObject $remoteBean |
|
| 313 | - */ |
|
| 314 | - public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 315 | - { |
|
| 316 | - if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') { |
|
| 317 | - unset($this->relationships[$pivotTableName][$remoteBean]); |
|
| 318 | - unset($remoteBean->relationships[$pivotTableName][$this]); |
|
| 319 | - } else { |
|
| 320 | - $this->setRelationship($pivotTableName, $remoteBean, 'delete'); |
|
| 321 | - } |
|
| 322 | - } |
|
| 323 | - |
|
| 324 | - /** |
|
| 325 | - * Returns the list of objects linked to this bean via $pivotTableName. |
|
| 326 | - * |
|
| 327 | - * @param $pivotTableName |
|
| 328 | - * |
|
| 329 | - * @return \SplObjectStorage |
|
| 330 | - */ |
|
| 331 | - private function retrieveRelationshipsStorage($pivotTableName) |
|
| 332 | - { |
|
| 333 | - $storage = $this->getRelationshipStorage($pivotTableName); |
|
| 334 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) { |
|
| 335 | - return $storage; |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this); |
|
| 339 | - $this->loadedRelationships[$pivotTableName] = true; |
|
| 340 | - |
|
| 341 | - foreach ($beans as $bean) { |
|
| 342 | - if (isset($storage[$bean])) { |
|
| 343 | - $oldStatus = $storage[$bean]['status']; |
|
| 344 | - if ($oldStatus === 'delete') { |
|
| 345 | - // Keep deleted things deleted |
|
| 346 | - continue; |
|
| 347 | - } |
|
| 348 | - } |
|
| 349 | - $this->setRelationship($pivotTableName, $bean, 'loaded'); |
|
| 350 | - } |
|
| 351 | - |
|
| 352 | - return $storage; |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - /** |
|
| 356 | - * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName. |
|
| 357 | - * |
|
| 358 | - * @param $pivotTableName |
|
| 359 | - * |
|
| 360 | - * @return AbstractTDBMObject[] |
|
| 361 | - */ |
|
| 362 | - public function _getRelationships($pivotTableName) |
|
| 363 | - { |
|
| 364 | - return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName)); |
|
| 365 | - } |
|
| 366 | - |
|
| 367 | - private function relationshipStorageToArray(\SplObjectStorage $storage) |
|
| 368 | - { |
|
| 369 | - $beans = []; |
|
| 370 | - foreach ($storage as $bean) { |
|
| 371 | - $statusArr = $storage[$bean]; |
|
| 372 | - if ($statusArr['status'] !== 'delete') { |
|
| 373 | - $beans[] = $bean; |
|
| 374 | - } |
|
| 375 | - } |
|
| 376 | - |
|
| 377 | - return $beans; |
|
| 378 | - } |
|
| 379 | - |
|
| 380 | - /** |
|
| 381 | - * Declares a relationship between. |
|
| 382 | - * |
|
| 383 | - * @param string $pivotTableName |
|
| 384 | - * @param AbstractTDBMObject $remoteBean |
|
| 385 | - * @param string $status |
|
| 386 | - */ |
|
| 387 | - private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) |
|
| 388 | - { |
|
| 389 | - $storage = $this->getRelationshipStorage($pivotTableName); |
|
| 390 | - $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]); |
|
| 391 | - if ($this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
| 392 | - $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY); |
|
| 393 | - } |
|
| 394 | - |
|
| 395 | - $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName); |
|
| 396 | - $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]); |
|
| 397 | - } |
|
| 398 | - |
|
| 399 | - /** |
|
| 400 | - * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
| 401 | - * |
|
| 402 | - * @param $pivotTableName |
|
| 403 | - * |
|
| 404 | - * @return \SplObjectStorage |
|
| 405 | - */ |
|
| 406 | - private function getRelationshipStorage($pivotTableName) |
|
| 407 | - { |
|
| 408 | - if (isset($this->relationships[$pivotTableName])) { |
|
| 409 | - $storage = $this->relationships[$pivotTableName]; |
|
| 410 | - } else { |
|
| 411 | - $storage = new \SplObjectStorage(); |
|
| 412 | - $this->relationships[$pivotTableName] = $storage; |
|
| 413 | - } |
|
| 414 | - |
|
| 415 | - return $storage; |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - /** |
|
| 419 | - * Reverts any changes made to the object and resumes it to its DB state. |
|
| 420 | - * This can only be called on objects that come from database and that have not been deleted. |
|
| 421 | - * Otherwise, this will throw an exception. |
|
| 422 | - * |
|
| 423 | - * @throws TDBMException |
|
| 424 | - */ |
|
| 425 | - public function discardChanges() |
|
| 426 | - { |
|
| 427 | - if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 428 | - throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved."); |
|
| 429 | - } |
|
| 430 | - |
|
| 431 | - if ($this->status === TDBMObjectStateEnum::STATE_DELETED) { |
|
| 432 | - throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.'); |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
| 436 | - } |
|
| 437 | - |
|
| 438 | - /** |
|
| 439 | - * Method used internally by TDBM. You should not use it directly. |
|
| 440 | - * This method returns the status of the TDBMObject. |
|
| 441 | - * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 442 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 443 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 444 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 445 | - * |
|
| 446 | - * @return string |
|
| 447 | - */ |
|
| 448 | - public function _getStatus() |
|
| 449 | - { |
|
| 450 | - return $this->status; |
|
| 451 | - } |
|
| 452 | - |
|
| 453 | - /** |
|
| 454 | - * Override the native php clone function for TDBMObjects. |
|
| 455 | - */ |
|
| 456 | - public function __clone() |
|
| 457 | - { |
|
| 458 | - // Let's clone the many to many relationships |
|
| 459 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 460 | - $pivotTableList = array_keys($this->relationships); |
|
| 461 | - } else { |
|
| 462 | - $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this); |
|
| 463 | - } |
|
| 464 | - |
|
| 465 | - foreach ($pivotTableList as $pivotTable) { |
|
| 466 | - $storage = $this->retrieveRelationshipsStorage($pivotTable); |
|
| 467 | - |
|
| 468 | - // Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!! |
|
| 469 | - /*foreach ($storage as $remoteBean) { |
|
| 34 | + /** |
|
| 35 | + * The service this object is bound to. |
|
| 36 | + * |
|
| 37 | + * @var TDBMService |
|
| 38 | + */ |
|
| 39 | + protected $tdbmService; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * An array of DbRow, indexed by table name. |
|
| 43 | + * |
|
| 44 | + * @var DbRow[] |
|
| 45 | + */ |
|
| 46 | + protected $dbRows = array(); |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 50 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 51 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 52 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 53 | + * |
|
| 54 | + * @var string |
|
| 55 | + */ |
|
| 56 | + private $status; |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * Array storing beans related via many to many relationships (pivot tables). |
|
| 60 | + * |
|
| 61 | + * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage |
|
| 62 | + */ |
|
| 63 | + private $relationships = []; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * @var bool[] Key: pivot table name, value: whether a query was performed to load the data. |
|
| 67 | + */ |
|
| 68 | + private $loadedRelationships = []; |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * Used with $primaryKeys when we want to retrieve an existing object |
|
| 72 | + * and $primaryKeys=[] if we want a new object. |
|
| 73 | + * |
|
| 74 | + * @param string $tableName |
|
| 75 | + * @param array $primaryKeys |
|
| 76 | + * @param TDBMService $tdbmService |
|
| 77 | + * |
|
| 78 | + * @throws TDBMException |
|
| 79 | + * @throws TDBMInvalidOperationException |
|
| 80 | + */ |
|
| 81 | + public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) |
|
| 82 | + { |
|
| 83 | + // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation... |
|
| 84 | + if (!empty($tableName)) { |
|
| 85 | + $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + if ($tdbmService === null) { |
|
| 89 | + $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED); |
|
| 90 | + } else { |
|
| 91 | + $this->_attach($tdbmService); |
|
| 92 | + if (!empty($primaryKeys)) { |
|
| 93 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
| 94 | + } else { |
|
| 95 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NEW); |
|
| 96 | + } |
|
| 97 | + } |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * Alternative constructor called when data is fetched from database via a SELECT. |
|
| 102 | + * |
|
| 103 | + * @param array $beanData array<table, array<column, value>> |
|
| 104 | + * @param TDBMService $tdbmService |
|
| 105 | + */ |
|
| 106 | + public function _constructFromData(array $beanData, TDBMService $tdbmService) |
|
| 107 | + { |
|
| 108 | + $this->tdbmService = $tdbmService; |
|
| 109 | + |
|
| 110 | + foreach ($beanData as $table => $columns) { |
|
| 111 | + $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns); |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * Alternative constructor called when bean is lazily loaded. |
|
| 119 | + * |
|
| 120 | + * @param string $tableName |
|
| 121 | + * @param array $primaryKeys |
|
| 122 | + * @param TDBMService $tdbmService |
|
| 123 | + */ |
|
| 124 | + public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService) |
|
| 125 | + { |
|
| 126 | + $this->tdbmService = $tdbmService; |
|
| 127 | + |
|
| 128 | + $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
| 129 | + |
|
| 130 | + $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + public function _attach(TDBMService $tdbmService) |
|
| 134 | + { |
|
| 135 | + if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 136 | + throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
| 137 | + } |
|
| 138 | + $this->tdbmService = $tdbmService; |
|
| 139 | + |
|
| 140 | + // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level) |
|
| 141 | + $tableNames = array_keys($this->dbRows); |
|
| 142 | + $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames); |
|
| 143 | + $tableNames = array_reverse($tableNames); |
|
| 144 | + |
|
| 145 | + $newDbRows = []; |
|
| 146 | + |
|
| 147 | + foreach ($tableNames as $table) { |
|
| 148 | + if (!isset($this->dbRows[$table])) { |
|
| 149 | + $this->registerTable($table); |
|
| 150 | + } |
|
| 151 | + $newDbRows[$table] = $this->dbRows[$table]; |
|
| 152 | + } |
|
| 153 | + $this->dbRows = $newDbRows; |
|
| 154 | + |
|
| 155 | + $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
| 156 | + foreach ($this->dbRows as $dbRow) { |
|
| 157 | + $dbRow->_attach($tdbmService); |
|
| 158 | + } |
|
| 159 | + } |
|
| 160 | + |
|
| 161 | + /** |
|
| 162 | + * Sets the state of the TDBM Object |
|
| 163 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 164 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 165 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 166 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 167 | + * |
|
| 168 | + * @param string $state |
|
| 169 | + */ |
|
| 170 | + public function _setStatus($state) |
|
| 171 | + { |
|
| 172 | + $this->status = $state; |
|
| 173 | + |
|
| 174 | + // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself. |
|
| 175 | + foreach ($this->dbRows as $dbRow) { |
|
| 176 | + $dbRow->_setStatus($state); |
|
| 177 | + } |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null" |
|
| 182 | + * or throws an error. |
|
| 183 | + * |
|
| 184 | + * @param string $tableName |
|
| 185 | + * |
|
| 186 | + * @return string |
|
| 187 | + */ |
|
| 188 | + private function checkTableName($tableName = null) |
|
| 189 | + { |
|
| 190 | + if ($tableName === null) { |
|
| 191 | + if (count($this->dbRows) > 1) { |
|
| 192 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 193 | + } elseif (count($this->dbRows) === 1) { |
|
| 194 | + $tableName = array_keys($this->dbRows)[0]; |
|
| 195 | + } |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + if (!isset($this->dbRows[$tableName])) { |
|
| 199 | + if (count($this->dbRows[$tableName] === 0)) { |
|
| 200 | + throw new TDBMException('Object is not yet bound to any table.'); |
|
| 201 | + } else { |
|
| 202 | + throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
| 203 | + } |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + return $tableName; |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + protected function get($var, $tableName = null) |
|
| 210 | + { |
|
| 211 | + $tableName = $this->checkTableName($tableName); |
|
| 212 | + |
|
| 213 | + return $this->dbRows[$tableName]->get($var); |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + protected function set($var, $value, $tableName = null) |
|
| 217 | + { |
|
| 218 | + if ($tableName === null) { |
|
| 219 | + if (count($this->dbRows) > 1) { |
|
| 220 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 221 | + } elseif (count($this->dbRows) === 1) { |
|
| 222 | + $tableName = array_keys($this->dbRows)[0]; |
|
| 223 | + } else { |
|
| 224 | + throw new TDBMException('Please specify a table for this object.'); |
|
| 225 | + } |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + if (!isset($this->dbRows[$tableName])) { |
|
| 229 | + $this->registerTable($tableName); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + $this->dbRows[$tableName]->set($var, $value); |
|
| 233 | + if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
| 234 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
| 235 | + } |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * @param string $foreignKeyName |
|
| 240 | + * @param AbstractTDBMObject $bean |
|
| 241 | + */ |
|
| 242 | + protected function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null) |
|
| 243 | + { |
|
| 244 | + if ($tableName === null) { |
|
| 245 | + if (count($this->dbRows) > 1) { |
|
| 246 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 247 | + } elseif (count($this->dbRows) === 1) { |
|
| 248 | + $tableName = array_keys($this->dbRows)[0]; |
|
| 249 | + } else { |
|
| 250 | + throw new TDBMException('Please specify a table for this object.'); |
|
| 251 | + } |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + if (!isset($this->dbRows[$tableName])) { |
|
| 255 | + $this->registerTable($tableName); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + $this->dbRows[$tableName]->setRef($foreignKeyName, $bean); |
|
| 259 | + if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
| 260 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
| 261 | + } |
|
| 262 | + } |
|
| 263 | + |
|
| 264 | + /** |
|
| 265 | + * @param string $foreignKeyName A unique name for this reference |
|
| 266 | + * |
|
| 267 | + * @return AbstractTDBMObject|null |
|
| 268 | + */ |
|
| 269 | + protected function getRef($foreignKeyName, $tableName = null) |
|
| 270 | + { |
|
| 271 | + $tableName = $this->checkTableName($tableName); |
|
| 272 | + |
|
| 273 | + return $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + /** |
|
| 277 | + * Adds a many to many relationship to this bean. |
|
| 278 | + * |
|
| 279 | + * @param string $pivotTableName |
|
| 280 | + * @param AbstractTDBMObject $remoteBean |
|
| 281 | + */ |
|
| 282 | + protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 283 | + { |
|
| 284 | + $this->setRelationship($pivotTableName, $remoteBean, 'new'); |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + /** |
|
| 288 | + * Returns true if there is a relationship to this bean. |
|
| 289 | + * |
|
| 290 | + * @param string $pivotTableName |
|
| 291 | + * @param AbstractTDBMObject $remoteBean |
|
| 292 | + * |
|
| 293 | + * @return bool |
|
| 294 | + */ |
|
| 295 | + protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 296 | + { |
|
| 297 | + $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
| 298 | + |
|
| 299 | + if ($storage->contains($remoteBean)) { |
|
| 300 | + if ($storage[$remoteBean]['status'] !== 'delete') { |
|
| 301 | + return true; |
|
| 302 | + } |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + return false; |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * Internal TDBM method. Removes a many to many relationship from this bean. |
|
| 310 | + * |
|
| 311 | + * @param string $pivotTableName |
|
| 312 | + * @param AbstractTDBMObject $remoteBean |
|
| 313 | + */ |
|
| 314 | + public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 315 | + { |
|
| 316 | + if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') { |
|
| 317 | + unset($this->relationships[$pivotTableName][$remoteBean]); |
|
| 318 | + unset($remoteBean->relationships[$pivotTableName][$this]); |
|
| 319 | + } else { |
|
| 320 | + $this->setRelationship($pivotTableName, $remoteBean, 'delete'); |
|
| 321 | + } |
|
| 322 | + } |
|
| 323 | + |
|
| 324 | + /** |
|
| 325 | + * Returns the list of objects linked to this bean via $pivotTableName. |
|
| 326 | + * |
|
| 327 | + * @param $pivotTableName |
|
| 328 | + * |
|
| 329 | + * @return \SplObjectStorage |
|
| 330 | + */ |
|
| 331 | + private function retrieveRelationshipsStorage($pivotTableName) |
|
| 332 | + { |
|
| 333 | + $storage = $this->getRelationshipStorage($pivotTableName); |
|
| 334 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) { |
|
| 335 | + return $storage; |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this); |
|
| 339 | + $this->loadedRelationships[$pivotTableName] = true; |
|
| 340 | + |
|
| 341 | + foreach ($beans as $bean) { |
|
| 342 | + if (isset($storage[$bean])) { |
|
| 343 | + $oldStatus = $storage[$bean]['status']; |
|
| 344 | + if ($oldStatus === 'delete') { |
|
| 345 | + // Keep deleted things deleted |
|
| 346 | + continue; |
|
| 347 | + } |
|
| 348 | + } |
|
| 349 | + $this->setRelationship($pivotTableName, $bean, 'loaded'); |
|
| 350 | + } |
|
| 351 | + |
|
| 352 | + return $storage; |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + /** |
|
| 356 | + * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName. |
|
| 357 | + * |
|
| 358 | + * @param $pivotTableName |
|
| 359 | + * |
|
| 360 | + * @return AbstractTDBMObject[] |
|
| 361 | + */ |
|
| 362 | + public function _getRelationships($pivotTableName) |
|
| 363 | + { |
|
| 364 | + return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName)); |
|
| 365 | + } |
|
| 366 | + |
|
| 367 | + private function relationshipStorageToArray(\SplObjectStorage $storage) |
|
| 368 | + { |
|
| 369 | + $beans = []; |
|
| 370 | + foreach ($storage as $bean) { |
|
| 371 | + $statusArr = $storage[$bean]; |
|
| 372 | + if ($statusArr['status'] !== 'delete') { |
|
| 373 | + $beans[] = $bean; |
|
| 374 | + } |
|
| 375 | + } |
|
| 376 | + |
|
| 377 | + return $beans; |
|
| 378 | + } |
|
| 379 | + |
|
| 380 | + /** |
|
| 381 | + * Declares a relationship between. |
|
| 382 | + * |
|
| 383 | + * @param string $pivotTableName |
|
| 384 | + * @param AbstractTDBMObject $remoteBean |
|
| 385 | + * @param string $status |
|
| 386 | + */ |
|
| 387 | + private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) |
|
| 388 | + { |
|
| 389 | + $storage = $this->getRelationshipStorage($pivotTableName); |
|
| 390 | + $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]); |
|
| 391 | + if ($this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
| 392 | + $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY); |
|
| 393 | + } |
|
| 394 | + |
|
| 395 | + $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName); |
|
| 396 | + $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]); |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + /** |
|
| 400 | + * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
| 401 | + * |
|
| 402 | + * @param $pivotTableName |
|
| 403 | + * |
|
| 404 | + * @return \SplObjectStorage |
|
| 405 | + */ |
|
| 406 | + private function getRelationshipStorage($pivotTableName) |
|
| 407 | + { |
|
| 408 | + if (isset($this->relationships[$pivotTableName])) { |
|
| 409 | + $storage = $this->relationships[$pivotTableName]; |
|
| 410 | + } else { |
|
| 411 | + $storage = new \SplObjectStorage(); |
|
| 412 | + $this->relationships[$pivotTableName] = $storage; |
|
| 413 | + } |
|
| 414 | + |
|
| 415 | + return $storage; |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + /** |
|
| 419 | + * Reverts any changes made to the object and resumes it to its DB state. |
|
| 420 | + * This can only be called on objects that come from database and that have not been deleted. |
|
| 421 | + * Otherwise, this will throw an exception. |
|
| 422 | + * |
|
| 423 | + * @throws TDBMException |
|
| 424 | + */ |
|
| 425 | + public function discardChanges() |
|
| 426 | + { |
|
| 427 | + if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 428 | + throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved."); |
|
| 429 | + } |
|
| 430 | + |
|
| 431 | + if ($this->status === TDBMObjectStateEnum::STATE_DELETED) { |
|
| 432 | + throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.'); |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
| 436 | + } |
|
| 437 | + |
|
| 438 | + /** |
|
| 439 | + * Method used internally by TDBM. You should not use it directly. |
|
| 440 | + * This method returns the status of the TDBMObject. |
|
| 441 | + * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 442 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 443 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 444 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 445 | + * |
|
| 446 | + * @return string |
|
| 447 | + */ |
|
| 448 | + public function _getStatus() |
|
| 449 | + { |
|
| 450 | + return $this->status; |
|
| 451 | + } |
|
| 452 | + |
|
| 453 | + /** |
|
| 454 | + * Override the native php clone function for TDBMObjects. |
|
| 455 | + */ |
|
| 456 | + public function __clone() |
|
| 457 | + { |
|
| 458 | + // Let's clone the many to many relationships |
|
| 459 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 460 | + $pivotTableList = array_keys($this->relationships); |
|
| 461 | + } else { |
|
| 462 | + $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this); |
|
| 463 | + } |
|
| 464 | + |
|
| 465 | + foreach ($pivotTableList as $pivotTable) { |
|
| 466 | + $storage = $this->retrieveRelationshipsStorage($pivotTable); |
|
| 467 | + |
|
| 468 | + // Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!! |
|
| 469 | + /*foreach ($storage as $remoteBean) { |
|
| 470 | 470 | $metadata = $storage[$remoteBean]; |
| 471 | 471 | |
| 472 | 472 | $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable); |
| 473 | 473 | $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]); |
| 474 | 474 | }*/ |
| 475 | - } |
|
| 476 | - |
|
| 477 | - // Let's clone each row |
|
| 478 | - foreach ($this->dbRows as $key => &$dbRow) { |
|
| 479 | - $dbRow = clone $dbRow; |
|
| 480 | - $dbRow->setTDBMObject($this); |
|
| 481 | - } |
|
| 482 | - |
|
| 483 | - // Let's set the status to new (to enter the save function) |
|
| 484 | - $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
| 485 | - } |
|
| 486 | - |
|
| 487 | - /** |
|
| 488 | - * Returns raw database rows. |
|
| 489 | - * |
|
| 490 | - * @return DbRow[] Key: table name, Value: DbRow object |
|
| 491 | - */ |
|
| 492 | - public function _getDbRows() |
|
| 493 | - { |
|
| 494 | - return $this->dbRows; |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - private function registerTable($tableName) |
|
| 498 | - { |
|
| 499 | - $dbRow = new DbRow($this, $tableName); |
|
| 500 | - |
|
| 501 | - if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) { |
|
| 502 | - // Let's get the primary key for the new table |
|
| 503 | - $anotherDbRow = array_values($this->dbRows)[0]; |
|
| 504 | - /* @var $anotherDbRow DbRow */ |
|
| 505 | - $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys()); |
|
| 506 | - $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys); |
|
| 507 | - $dbRow->_setPrimaryKeys($primaryKeys); |
|
| 508 | - } |
|
| 509 | - |
|
| 510 | - $dbRow->_setStatus($this->status); |
|
| 511 | - |
|
| 512 | - $this->dbRows[$tableName] = $dbRow; |
|
| 513 | - // TODO: look at status (if not new)=> get primary key from tdbmservice |
|
| 514 | - } |
|
| 515 | - |
|
| 516 | - /** |
|
| 517 | - * Internal function: return the list of relationships. |
|
| 518 | - * |
|
| 519 | - * @return \SplObjectStorage[] |
|
| 520 | - */ |
|
| 521 | - public function _getCachedRelationships() |
|
| 522 | - { |
|
| 523 | - return $this->relationships; |
|
| 524 | - } |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + // Let's clone each row |
|
| 478 | + foreach ($this->dbRows as $key => &$dbRow) { |
|
| 479 | + $dbRow = clone $dbRow; |
|
| 480 | + $dbRow->setTDBMObject($this); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + // Let's set the status to new (to enter the save function) |
|
| 484 | + $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
| 485 | + } |
|
| 486 | + |
|
| 487 | + /** |
|
| 488 | + * Returns raw database rows. |
|
| 489 | + * |
|
| 490 | + * @return DbRow[] Key: table name, Value: DbRow object |
|
| 491 | + */ |
|
| 492 | + public function _getDbRows() |
|
| 493 | + { |
|
| 494 | + return $this->dbRows; |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + private function registerTable($tableName) |
|
| 498 | + { |
|
| 499 | + $dbRow = new DbRow($this, $tableName); |
|
| 500 | + |
|
| 501 | + if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) { |
|
| 502 | + // Let's get the primary key for the new table |
|
| 503 | + $anotherDbRow = array_values($this->dbRows)[0]; |
|
| 504 | + /* @var $anotherDbRow DbRow */ |
|
| 505 | + $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys()); |
|
| 506 | + $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys); |
|
| 507 | + $dbRow->_setPrimaryKeys($primaryKeys); |
|
| 508 | + } |
|
| 509 | + |
|
| 510 | + $dbRow->_setStatus($this->status); |
|
| 511 | + |
|
| 512 | + $this->dbRows[$tableName] = $dbRow; |
|
| 513 | + // TODO: look at status (if not new)=> get primary key from tdbmservice |
|
| 514 | + } |
|
| 515 | + |
|
| 516 | + /** |
|
| 517 | + * Internal function: return the list of relationships. |
|
| 518 | + * |
|
| 519 | + * @return \SplObjectStorage[] |
|
| 520 | + */ |
|
| 521 | + public function _getCachedRelationships() |
|
| 522 | + { |
|
| 523 | + return $this->relationships; |
|
| 524 | + } |
|
| 525 | 525 | } |
@@ -11,98 +11,98 @@ 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(); |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Returns true if the property is the primary key. |
|
| 78 | - * |
|
| 79 | - * @return bool |
|
| 80 | - */ |
|
| 81 | - public function isPrimaryKey() |
|
| 82 | - { |
|
| 83 | - return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * Returns the PHP code for getters and setters. |
|
| 88 | - * |
|
| 89 | - * @return string |
|
| 90 | - */ |
|
| 91 | - public function getGetterSetterCode() |
|
| 92 | - { |
|
| 93 | - $type = $this->column->getType(); |
|
| 94 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
| 95 | - |
|
| 96 | - $columnGetterName = $this->getGetterName(); |
|
| 97 | - $columnSetterName = $this->getSetterName(); |
|
| 98 | - |
|
| 99 | - if ($normalizedType == '\\DateTimeInterface') { |
|
| 100 | - $castTo = '\\DateTimeInterface '; |
|
| 101 | - } else { |
|
| 102 | - $castTo = ''; |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - $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(); |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Returns true if the property is the primary key. |
|
| 78 | + * |
|
| 79 | + * @return bool |
|
| 80 | + */ |
|
| 81 | + public function isPrimaryKey() |
|
| 82 | + { |
|
| 83 | + return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * Returns the PHP code for getters and setters. |
|
| 88 | + * |
|
| 89 | + * @return string |
|
| 90 | + */ |
|
| 91 | + public function getGetterSetterCode() |
|
| 92 | + { |
|
| 93 | + $type = $this->column->getType(); |
|
| 94 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
| 95 | + |
|
| 96 | + $columnGetterName = $this->getGetterName(); |
|
| 97 | + $columnSetterName = $this->getSetterName(); |
|
| 98 | + |
|
| 99 | + if ($normalizedType == '\\DateTimeInterface') { |
|
| 100 | + $castTo = '\\DateTimeInterface '; |
|
| 101 | + } else { |
|
| 102 | + $castTo = ''; |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + $getterAndSetterCode = ' /** |
|
| 106 | 106 | * The getter for the "%s" column. |
| 107 | 107 | * |
| 108 | 108 | * @return %s |
@@ -122,50 +122,50 @@ discard block |
||
| 122 | 122 | |
| 123 | 123 | '; |
| 124 | 124 | |
| 125 | - return sprintf($getterAndSetterCode, |
|
| 126 | - // Getter |
|
| 127 | - $this->column->getName(), |
|
| 128 | - $normalizedType, |
|
| 129 | - $columnGetterName, |
|
| 130 | - var_export($this->column->getName(), true), |
|
| 131 | - var_export($this->table->getName(), true), |
|
| 132 | - // Setter |
|
| 133 | - $this->column->getName(), |
|
| 134 | - $normalizedType, |
|
| 135 | - $this->column->getName(), |
|
| 136 | - $columnSetterName, |
|
| 137 | - $castTo, |
|
| 138 | - $this->column->getName(), |
|
| 139 | - var_export($this->column->getName(), true), |
|
| 140 | - $this->column->getName(), |
|
| 141 | - var_export($this->table->getName(), true) |
|
| 142 | - ); |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Returns the part of code useful when doing json serialization. |
|
| 147 | - * |
|
| 148 | - * @return string |
|
| 149 | - */ |
|
| 150 | - public function getJsonSerializeCode() |
|
| 151 | - { |
|
| 152 | - $type = $this->column->getType(); |
|
| 153 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
| 154 | - |
|
| 155 | - if ($normalizedType == '\\DateTimeInterface') { |
|
| 156 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."()->format('c');\n"; |
|
| 157 | - } else { |
|
| 158 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
| 159 | - } |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * Returns the column name. |
|
| 164 | - * |
|
| 165 | - * @return string |
|
| 166 | - */ |
|
| 167 | - public function getColumnName() |
|
| 168 | - { |
|
| 169 | - return $this->column->getName(); |
|
| 170 | - } |
|
| 125 | + return sprintf($getterAndSetterCode, |
|
| 126 | + // Getter |
|
| 127 | + $this->column->getName(), |
|
| 128 | + $normalizedType, |
|
| 129 | + $columnGetterName, |
|
| 130 | + var_export($this->column->getName(), true), |
|
| 131 | + var_export($this->table->getName(), true), |
|
| 132 | + // Setter |
|
| 133 | + $this->column->getName(), |
|
| 134 | + $normalizedType, |
|
| 135 | + $this->column->getName(), |
|
| 136 | + $columnSetterName, |
|
| 137 | + $castTo, |
|
| 138 | + $this->column->getName(), |
|
| 139 | + var_export($this->column->getName(), true), |
|
| 140 | + $this->column->getName(), |
|
| 141 | + var_export($this->table->getName(), true) |
|
| 142 | + ); |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Returns the part of code useful when doing json serialization. |
|
| 147 | + * |
|
| 148 | + * @return string |
|
| 149 | + */ |
|
| 150 | + public function getJsonSerializeCode() |
|
| 151 | + { |
|
| 152 | + $type = $this->column->getType(); |
|
| 153 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
| 154 | + |
|
| 155 | + if ($normalizedType == '\\DateTimeInterface') { |
|
| 156 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."()->format('c');\n"; |
|
| 157 | + } else { |
|
| 158 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
| 159 | + } |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * Returns the column name. |
|
| 164 | + * |
|
| 165 | + * @return string |
|
| 166 | + */ |
|
| 167 | + public function getColumnName() |
|
| 168 | + { |
|
| 169 | + return $this->column->getName(); |
|
| 170 | + } |
|
| 171 | 171 | } |
@@ -77,11 +77,11 @@ discard block |
||
| 77 | 77 | |
| 78 | 78 | // Remove all beans and daos from junction tables |
| 79 | 79 | $junctionTables = $this->schemaAnalyzer->detectJunctionTables(); |
| 80 | - $junctionTableNames = array_map(function (Table $table) { |
|
| 80 | + $junctionTableNames = array_map(function(Table $table) { |
|
| 81 | 81 | return $table->getName(); |
| 82 | 82 | }, $junctionTables); |
| 83 | 83 | |
| 84 | - $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
| 84 | + $tableList = array_filter($tableList, function(Table $table) use ($junctionTableNames) { |
|
| 85 | 85 | return !in_array($table->getName(), $junctionTableNames); |
| 86 | 86 | }); |
| 87 | 87 | |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | // Ok, let's return the list of all tables. |
| 95 | 95 | // These will be used by the calling script to create Mouf instances. |
| 96 | 96 | |
| 97 | - return array_map(function (Table $table) { return $table->getName(); }, $tableList); |
|
| 97 | + return array_map(function(Table $table) { return $table->getName(); }, $tableList); |
|
| 98 | 98 | } |
| 99 | 99 | |
| 100 | 100 | /** |
@@ -287,7 +287,7 @@ discard block |
||
| 287 | 287 | $usedBeans[] = $beanClassName; |
| 288 | 288 | // Let's suppress duplicates in used beans (if any) |
| 289 | 289 | $usedBeans = array_flip(array_flip($usedBeans)); |
| 290 | - $useStatements = array_map(function ($usedBean) { |
|
| 290 | + $useStatements = array_map(function($usedBean) { |
|
| 291 | 291 | return "use $usedBean;\n"; |
| 292 | 292 | }, $usedBeans); |
| 293 | 293 | |
@@ -587,7 +587,7 @@ discard block |
||
| 587 | 587 | $pos = strpos($str, ' '); |
| 588 | 588 | } |
| 589 | 589 | $before = substr($str, 0, $pos); |
| 590 | - $after = substr($str, $pos + 1); |
|
| 590 | + $after = substr($str, $pos+1); |
|
| 591 | 591 | $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
| 592 | 592 | } |
| 593 | 593 | |
@@ -17,200 +17,200 @@ discard block |
||
| 17 | 17 | */ |
| 18 | 18 | class TDBMDaoGenerator |
| 19 | 19 | { |
| 20 | - /** |
|
| 21 | - * @var SchemaAnalyzer |
|
| 22 | - */ |
|
| 23 | - private $schemaAnalyzer; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * @var Schema |
|
| 27 | - */ |
|
| 28 | - private $schema; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * The root directory of the project. |
|
| 32 | - * |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 35 | - private $rootPath; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * Name of composer file. |
|
| 39 | - * |
|
| 40 | - * @var string |
|
| 41 | - */ |
|
| 42 | - private $composerFile; |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * @var TDBMSchemaAnalyzer |
|
| 46 | - */ |
|
| 47 | - private $tdbmSchemaAnalyzer; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Constructor. |
|
| 51 | - * |
|
| 52 | - * @param SchemaAnalyzer $schemaAnalyzer |
|
| 53 | - * @param Schema $schema |
|
| 54 | - * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer |
|
| 55 | - */ |
|
| 56 | - public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
| 57 | - { |
|
| 58 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
| 59 | - $this->schema = $schema; |
|
| 60 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
| 61 | - $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
| 62 | - $this->composerFile = 'composer.json'; |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Generates all the daos and beans. |
|
| 67 | - * |
|
| 68 | - * @param string $daoFactoryClassName The classe name of the DAO factory |
|
| 69 | - * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
| 70 | - * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
| 71 | - * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone. |
|
| 72 | - * |
|
| 73 | - * @return \string[] the list of tables |
|
| 74 | - * |
|
| 75 | - * @throws TDBMException |
|
| 76 | - */ |
|
| 77 | - public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
| 78 | - { |
|
| 79 | - $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile); |
|
| 80 | - // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
| 81 | - |
|
| 82 | - $tableList = $this->schema->getTables(); |
|
| 83 | - |
|
| 84 | - // Remove all beans and daos from junction tables |
|
| 85 | - $junctionTables = $this->schemaAnalyzer->detectJunctionTables(); |
|
| 86 | - $junctionTableNames = array_map(function (Table $table) { |
|
| 87 | - return $table->getName(); |
|
| 88 | - }, $junctionTables); |
|
| 89 | - |
|
| 90 | - $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
| 91 | - return !in_array($table->getName(), $junctionTableNames); |
|
| 92 | - }); |
|
| 93 | - |
|
| 94 | - foreach ($tableList as $table) { |
|
| 95 | - $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
| 99 | - |
|
| 100 | - // Ok, let's return the list of all tables. |
|
| 101 | - // These will be used by the calling script to create Mouf instances. |
|
| 102 | - |
|
| 103 | - return array_map(function (Table $table) { return $table->getName(); }, $tableList); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Generates in one method call the daos and the beans for one table. |
|
| 108 | - * |
|
| 109 | - * @param Table $table |
|
| 110 | - * @param string $daonamespace |
|
| 111 | - * @param string $beannamespace |
|
| 112 | - * @param ClassNameMapper $classNameMapper |
|
| 113 | - * @param bool $storeInUtc |
|
| 114 | - * |
|
| 115 | - * @throws TDBMException |
|
| 116 | - */ |
|
| 117 | - public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
| 118 | - { |
|
| 119 | - $tableName = $table->getName(); |
|
| 120 | - $daoName = $this->getDaoNameFromTableName($tableName); |
|
| 121 | - $beanName = $this->getBeanNameFromTableName($tableName); |
|
| 122 | - $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
| 123 | - $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
| 124 | - |
|
| 125 | - $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
| 126 | - $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
| 127 | - $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
| 128 | - } |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * Returns the name of the bean class from the table name. |
|
| 132 | - * |
|
| 133 | - * @param $tableName |
|
| 134 | - * |
|
| 135 | - * @return string |
|
| 136 | - */ |
|
| 137 | - public static function getBeanNameFromTableName($tableName) |
|
| 138 | - { |
|
| 139 | - return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - /** |
|
| 143 | - * Returns the name of the DAO class from the table name. |
|
| 144 | - * |
|
| 145 | - * @param $tableName |
|
| 146 | - * |
|
| 147 | - * @return string |
|
| 148 | - */ |
|
| 149 | - public static function getDaoNameFromTableName($tableName) |
|
| 150 | - { |
|
| 151 | - return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Returns the name of the base bean class from the table name. |
|
| 156 | - * |
|
| 157 | - * @param $tableName |
|
| 158 | - * |
|
| 159 | - * @return string |
|
| 160 | - */ |
|
| 161 | - public static function getBaseBeanNameFromTableName($tableName) |
|
| 162 | - { |
|
| 163 | - return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * Returns the name of the base DAO class from the table name. |
|
| 168 | - * |
|
| 169 | - * @param $tableName |
|
| 170 | - * |
|
| 171 | - * @return string |
|
| 172 | - */ |
|
| 173 | - public static function getBaseDaoNameFromTableName($tableName) |
|
| 174 | - { |
|
| 175 | - return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
| 180 | - * |
|
| 181 | - * @param BeanDescriptor $beanDescriptor |
|
| 182 | - * @param string $className The name of the class |
|
| 183 | - * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
| 184 | - * @param Table $table The table |
|
| 185 | - * @param string $beannamespace The namespace of the bean |
|
| 186 | - * @param ClassNameMapper $classNameMapper |
|
| 187 | - * |
|
| 188 | - * @throws TDBMException |
|
| 189 | - */ |
|
| 190 | - public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
| 191 | - { |
|
| 192 | - $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
| 193 | - |
|
| 194 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName); |
|
| 195 | - if (empty($possibleBaseFileNames)) { |
|
| 196 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
| 197 | - } |
|
| 198 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
| 199 | - |
|
| 200 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
| 201 | - file_put_contents($possibleBaseFileName, $str); |
|
| 202 | - @chmod($possibleBaseFileName, 0664); |
|
| 203 | - |
|
| 204 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
| 205 | - if (empty($possibleFileNames)) { |
|
| 206 | - // @codeCoverageIgnoreStart |
|
| 207 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
| 208 | - // @codeCoverageIgnoreEnd |
|
| 209 | - } |
|
| 210 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 211 | - if (!file_exists($possibleFileName)) { |
|
| 212 | - $tableName = $table->getName(); |
|
| 213 | - $str = "<?php |
|
| 20 | + /** |
|
| 21 | + * @var SchemaAnalyzer |
|
| 22 | + */ |
|
| 23 | + private $schemaAnalyzer; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * @var Schema |
|
| 27 | + */ |
|
| 28 | + private $schema; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * The root directory of the project. |
|
| 32 | + * |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | + private $rootPath; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * Name of composer file. |
|
| 39 | + * |
|
| 40 | + * @var string |
|
| 41 | + */ |
|
| 42 | + private $composerFile; |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * @var TDBMSchemaAnalyzer |
|
| 46 | + */ |
|
| 47 | + private $tdbmSchemaAnalyzer; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Constructor. |
|
| 51 | + * |
|
| 52 | + * @param SchemaAnalyzer $schemaAnalyzer |
|
| 53 | + * @param Schema $schema |
|
| 54 | + * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer |
|
| 55 | + */ |
|
| 56 | + public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
| 57 | + { |
|
| 58 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
| 59 | + $this->schema = $schema; |
|
| 60 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
| 61 | + $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
| 62 | + $this->composerFile = 'composer.json'; |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Generates all the daos and beans. |
|
| 67 | + * |
|
| 68 | + * @param string $daoFactoryClassName The classe name of the DAO factory |
|
| 69 | + * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
| 70 | + * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
| 71 | + * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone. |
|
| 72 | + * |
|
| 73 | + * @return \string[] the list of tables |
|
| 74 | + * |
|
| 75 | + * @throws TDBMException |
|
| 76 | + */ |
|
| 77 | + public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
| 78 | + { |
|
| 79 | + $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile); |
|
| 80 | + // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
| 81 | + |
|
| 82 | + $tableList = $this->schema->getTables(); |
|
| 83 | + |
|
| 84 | + // Remove all beans and daos from junction tables |
|
| 85 | + $junctionTables = $this->schemaAnalyzer->detectJunctionTables(); |
|
| 86 | + $junctionTableNames = array_map(function (Table $table) { |
|
| 87 | + return $table->getName(); |
|
| 88 | + }, $junctionTables); |
|
| 89 | + |
|
| 90 | + $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
| 91 | + return !in_array($table->getName(), $junctionTableNames); |
|
| 92 | + }); |
|
| 93 | + |
|
| 94 | + foreach ($tableList as $table) { |
|
| 95 | + $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
| 99 | + |
|
| 100 | + // Ok, let's return the list of all tables. |
|
| 101 | + // These will be used by the calling script to create Mouf instances. |
|
| 102 | + |
|
| 103 | + return array_map(function (Table $table) { return $table->getName(); }, $tableList); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Generates in one method call the daos and the beans for one table. |
|
| 108 | + * |
|
| 109 | + * @param Table $table |
|
| 110 | + * @param string $daonamespace |
|
| 111 | + * @param string $beannamespace |
|
| 112 | + * @param ClassNameMapper $classNameMapper |
|
| 113 | + * @param bool $storeInUtc |
|
| 114 | + * |
|
| 115 | + * @throws TDBMException |
|
| 116 | + */ |
|
| 117 | + public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
| 118 | + { |
|
| 119 | + $tableName = $table->getName(); |
|
| 120 | + $daoName = $this->getDaoNameFromTableName($tableName); |
|
| 121 | + $beanName = $this->getBeanNameFromTableName($tableName); |
|
| 122 | + $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
| 123 | + $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
| 124 | + |
|
| 125 | + $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
| 126 | + $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
| 127 | + $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
| 128 | + } |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * Returns the name of the bean class from the table name. |
|
| 132 | + * |
|
| 133 | + * @param $tableName |
|
| 134 | + * |
|
| 135 | + * @return string |
|
| 136 | + */ |
|
| 137 | + public static function getBeanNameFromTableName($tableName) |
|
| 138 | + { |
|
| 139 | + return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + /** |
|
| 143 | + * Returns the name of the DAO class from the table name. |
|
| 144 | + * |
|
| 145 | + * @param $tableName |
|
| 146 | + * |
|
| 147 | + * @return string |
|
| 148 | + */ |
|
| 149 | + public static function getDaoNameFromTableName($tableName) |
|
| 150 | + { |
|
| 151 | + return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Returns the name of the base bean class from the table name. |
|
| 156 | + * |
|
| 157 | + * @param $tableName |
|
| 158 | + * |
|
| 159 | + * @return string |
|
| 160 | + */ |
|
| 161 | + public static function getBaseBeanNameFromTableName($tableName) |
|
| 162 | + { |
|
| 163 | + return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * Returns the name of the base DAO class from the table name. |
|
| 168 | + * |
|
| 169 | + * @param $tableName |
|
| 170 | + * |
|
| 171 | + * @return string |
|
| 172 | + */ |
|
| 173 | + public static function getBaseDaoNameFromTableName($tableName) |
|
| 174 | + { |
|
| 175 | + return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
| 180 | + * |
|
| 181 | + * @param BeanDescriptor $beanDescriptor |
|
| 182 | + * @param string $className The name of the class |
|
| 183 | + * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
| 184 | + * @param Table $table The table |
|
| 185 | + * @param string $beannamespace The namespace of the bean |
|
| 186 | + * @param ClassNameMapper $classNameMapper |
|
| 187 | + * |
|
| 188 | + * @throws TDBMException |
|
| 189 | + */ |
|
| 190 | + public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
| 191 | + { |
|
| 192 | + $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
| 193 | + |
|
| 194 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName); |
|
| 195 | + if (empty($possibleBaseFileNames)) { |
|
| 196 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
| 197 | + } |
|
| 198 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
| 199 | + |
|
| 200 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
| 201 | + file_put_contents($possibleBaseFileName, $str); |
|
| 202 | + @chmod($possibleBaseFileName, 0664); |
|
| 203 | + |
|
| 204 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
| 205 | + if (empty($possibleFileNames)) { |
|
| 206 | + // @codeCoverageIgnoreStart |
|
| 207 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
| 208 | + // @codeCoverageIgnoreEnd |
|
| 209 | + } |
|
| 210 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 211 | + if (!file_exists($possibleFileName)) { |
|
| 212 | + $tableName = $table->getName(); |
|
| 213 | + $str = "<?php |
|
| 214 | 214 | /* |
| 215 | 215 | * This file has been automatically generated by TDBM. |
| 216 | 216 | * You can edit this file as it will not be overwritten. |
@@ -227,76 +227,76 @@ discard block |
||
| 227 | 227 | { |
| 228 | 228 | |
| 229 | 229 | }"; |
| 230 | - $this->ensureDirectoryExist($possibleFileName); |
|
| 231 | - file_put_contents($possibleFileName, $str); |
|
| 232 | - @chmod($possibleFileName, 0664); |
|
| 233 | - } |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - /** |
|
| 237 | - * Tries to find a @defaultSort annotation in one of the columns. |
|
| 238 | - * |
|
| 239 | - * @param Table $table |
|
| 240 | - * |
|
| 241 | - * @return array First item: column name, Second item: column order (asc/desc) |
|
| 242 | - */ |
|
| 243 | - private function getDefaultSortColumnFromAnnotation(Table $table) |
|
| 244 | - { |
|
| 245 | - $defaultSort = null; |
|
| 246 | - $defaultSortDirection = null; |
|
| 247 | - foreach ($table->getColumns() as $column) { |
|
| 248 | - $comments = $column->getComment(); |
|
| 249 | - $matches = []; |
|
| 250 | - if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
| 251 | - $defaultSort = $column->getName(); |
|
| 252 | - if (count($matches) === 3) { |
|
| 253 | - $defaultSortDirection = $matches[2]; |
|
| 254 | - } else { |
|
| 255 | - $defaultSortDirection = 'ASC'; |
|
| 256 | - } |
|
| 257 | - } |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - return [$defaultSort, $defaultSortDirection]; |
|
| 261 | - } |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
| 265 | - * |
|
| 266 | - * @param BeanDescriptor $beanDescriptor |
|
| 267 | - * @param string $className The name of the class |
|
| 268 | - * @param string $baseClassName |
|
| 269 | - * @param string $beanClassName |
|
| 270 | - * @param Table $table |
|
| 271 | - * @param string $daonamespace |
|
| 272 | - * @param string $beannamespace |
|
| 273 | - * @param ClassNameMapper $classNameMapper |
|
| 274 | - * |
|
| 275 | - * @throws TDBMException |
|
| 276 | - */ |
|
| 277 | - public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
| 278 | - { |
|
| 279 | - $tableName = $table->getName(); |
|
| 280 | - $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
| 281 | - |
|
| 282 | - list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table); |
|
| 283 | - |
|
| 284 | - // FIXME: lowercase tables with _ in the name should work! |
|
| 285 | - $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
| 286 | - |
|
| 287 | - $beanClassWithoutNameSpace = $beanClassName; |
|
| 288 | - $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
| 289 | - |
|
| 290 | - list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace); |
|
| 291 | - |
|
| 292 | - $usedBeans[] = $beanClassName; |
|
| 293 | - // Let's suppress duplicates in used beans (if any) |
|
| 294 | - $usedBeans = array_flip(array_flip($usedBeans)); |
|
| 295 | - $useStatements = array_map(function ($usedBean) { |
|
| 296 | - return "use $usedBean;\n"; |
|
| 297 | - }, $usedBeans); |
|
| 298 | - |
|
| 299 | - $str = "<?php |
|
| 230 | + $this->ensureDirectoryExist($possibleFileName); |
|
| 231 | + file_put_contents($possibleFileName, $str); |
|
| 232 | + @chmod($possibleFileName, 0664); |
|
| 233 | + } |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + /** |
|
| 237 | + * Tries to find a @defaultSort annotation in one of the columns. |
|
| 238 | + * |
|
| 239 | + * @param Table $table |
|
| 240 | + * |
|
| 241 | + * @return array First item: column name, Second item: column order (asc/desc) |
|
| 242 | + */ |
|
| 243 | + private function getDefaultSortColumnFromAnnotation(Table $table) |
|
| 244 | + { |
|
| 245 | + $defaultSort = null; |
|
| 246 | + $defaultSortDirection = null; |
|
| 247 | + foreach ($table->getColumns() as $column) { |
|
| 248 | + $comments = $column->getComment(); |
|
| 249 | + $matches = []; |
|
| 250 | + if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
| 251 | + $defaultSort = $column->getName(); |
|
| 252 | + if (count($matches) === 3) { |
|
| 253 | + $defaultSortDirection = $matches[2]; |
|
| 254 | + } else { |
|
| 255 | + $defaultSortDirection = 'ASC'; |
|
| 256 | + } |
|
| 257 | + } |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + return [$defaultSort, $defaultSortDirection]; |
|
| 261 | + } |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
| 265 | + * |
|
| 266 | + * @param BeanDescriptor $beanDescriptor |
|
| 267 | + * @param string $className The name of the class |
|
| 268 | + * @param string $baseClassName |
|
| 269 | + * @param string $beanClassName |
|
| 270 | + * @param Table $table |
|
| 271 | + * @param string $daonamespace |
|
| 272 | + * @param string $beannamespace |
|
| 273 | + * @param ClassNameMapper $classNameMapper |
|
| 274 | + * |
|
| 275 | + * @throws TDBMException |
|
| 276 | + */ |
|
| 277 | + public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
| 278 | + { |
|
| 279 | + $tableName = $table->getName(); |
|
| 280 | + $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
| 281 | + |
|
| 282 | + list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table); |
|
| 283 | + |
|
| 284 | + // FIXME: lowercase tables with _ in the name should work! |
|
| 285 | + $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
| 286 | + |
|
| 287 | + $beanClassWithoutNameSpace = $beanClassName; |
|
| 288 | + $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
| 289 | + |
|
| 290 | + list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace); |
|
| 291 | + |
|
| 292 | + $usedBeans[] = $beanClassName; |
|
| 293 | + // Let's suppress duplicates in used beans (if any) |
|
| 294 | + $usedBeans = array_flip(array_flip($usedBeans)); |
|
| 295 | + $useStatements = array_map(function ($usedBean) { |
|
| 296 | + return "use $usedBean;\n"; |
|
| 297 | + }, $usedBeans); |
|
| 298 | + |
|
| 299 | + $str = "<?php |
|
| 300 | 300 | |
| 301 | 301 | /* |
| 302 | 302 | * This file has been automatically generated by TDBM. |
@@ -373,9 +373,9 @@ discard block |
||
| 373 | 373 | } |
| 374 | 374 | "; |
| 375 | 375 | |
| 376 | - if (count($primaryKeyColumns) === 1) { |
|
| 377 | - $primaryKeyColumn = $primaryKeyColumns[0]; |
|
| 378 | - $str .= " |
|
| 376 | + if (count($primaryKeyColumns) === 1) { |
|
| 377 | + $primaryKeyColumn = $primaryKeyColumns[0]; |
|
| 378 | + $str .= " |
|
| 379 | 379 | /** |
| 380 | 380 | * Get $beanClassWithoutNameSpace specified by its ID (its primary key) |
| 381 | 381 | * If the primary key does not exist, an exception is thrown. |
@@ -390,8 +390,8 @@ discard block |
||
| 390 | 390 | return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading); |
| 391 | 391 | } |
| 392 | 392 | "; |
| 393 | - } |
|
| 394 | - $str .= " |
|
| 393 | + } |
|
| 394 | + $str .= " |
|
| 395 | 395 | /** |
| 396 | 396 | * Deletes the $beanClassWithoutNameSpace passed in parameter. |
| 397 | 397 | * |
@@ -449,33 +449,33 @@ discard block |
||
| 449 | 449 | } |
| 450 | 450 | "; |
| 451 | 451 | |
| 452 | - $str .= $findByDaoCode; |
|
| 453 | - $str .= '} |
|
| 452 | + $str .= $findByDaoCode; |
|
| 453 | + $str .= '} |
|
| 454 | 454 | '; |
| 455 | 455 | |
| 456 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName); |
|
| 457 | - if (empty($possibleBaseFileNames)) { |
|
| 458 | - // @codeCoverageIgnoreStart |
|
| 459 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
| 460 | - // @codeCoverageIgnoreEnd |
|
| 461 | - } |
|
| 462 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
| 463 | - |
|
| 464 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
| 465 | - file_put_contents($possibleBaseFileName, $str); |
|
| 466 | - @chmod($possibleBaseFileName, 0664); |
|
| 467 | - |
|
| 468 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
| 469 | - if (empty($possibleFileNames)) { |
|
| 470 | - // @codeCoverageIgnoreStart |
|
| 471 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
| 472 | - // @codeCoverageIgnoreEnd |
|
| 473 | - } |
|
| 474 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 475 | - |
|
| 476 | - // Now, let's generate the "editable" class |
|
| 477 | - if (!file_exists($possibleFileName)) { |
|
| 478 | - $str = "<?php |
|
| 456 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName); |
|
| 457 | + if (empty($possibleBaseFileNames)) { |
|
| 458 | + // @codeCoverageIgnoreStart |
|
| 459 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
| 460 | + // @codeCoverageIgnoreEnd |
|
| 461 | + } |
|
| 462 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
| 463 | + |
|
| 464 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
| 465 | + file_put_contents($possibleBaseFileName, $str); |
|
| 466 | + @chmod($possibleBaseFileName, 0664); |
|
| 467 | + |
|
| 468 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
| 469 | + if (empty($possibleFileNames)) { |
|
| 470 | + // @codeCoverageIgnoreStart |
|
| 471 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
| 472 | + // @codeCoverageIgnoreEnd |
|
| 473 | + } |
|
| 474 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 475 | + |
|
| 476 | + // Now, let's generate the "editable" class |
|
| 477 | + if (!file_exists($possibleFileName)) { |
|
| 478 | + $str = "<?php |
|
| 479 | 479 | |
| 480 | 480 | /* |
| 481 | 481 | * This file has been automatically generated by TDBM. |
@@ -494,22 +494,22 @@ discard block |
||
| 494 | 494 | |
| 495 | 495 | } |
| 496 | 496 | "; |
| 497 | - $this->ensureDirectoryExist($possibleFileName); |
|
| 498 | - file_put_contents($possibleFileName, $str); |
|
| 499 | - @chmod($possibleFileName, 0664); |
|
| 500 | - } |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - /** |
|
| 504 | - * Generates the factory bean. |
|
| 505 | - * |
|
| 506 | - * @param Table[] $tableList |
|
| 507 | - */ |
|
| 508 | - private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
| 509 | - { |
|
| 510 | - // For each table, let's write a property. |
|
| 511 | - |
|
| 512 | - $str = "<?php |
|
| 497 | + $this->ensureDirectoryExist($possibleFileName); |
|
| 498 | + file_put_contents($possibleFileName, $str); |
|
| 499 | + @chmod($possibleFileName, 0664); |
|
| 500 | + } |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + /** |
|
| 504 | + * Generates the factory bean. |
|
| 505 | + * |
|
| 506 | + * @param Table[] $tableList |
|
| 507 | + */ |
|
| 508 | + private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
| 509 | + { |
|
| 510 | + // For each table, let's write a property. |
|
| 511 | + |
|
| 512 | + $str = "<?php |
|
| 513 | 513 | |
| 514 | 514 | /* |
| 515 | 515 | * This file has been automatically generated by TDBM. |
@@ -518,13 +518,13 @@ discard block |
||
| 518 | 518 | |
| 519 | 519 | namespace {$daoNamespace}\\Generated; |
| 520 | 520 | "; |
| 521 | - foreach ($tableList as $table) { |
|
| 522 | - $tableName = $table->getName(); |
|
| 523 | - $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
| 524 | - $str .= "use {$daoNamespace}\\".$daoClassName.";\n"; |
|
| 525 | - } |
|
| 521 | + foreach ($tableList as $table) { |
|
| 522 | + $tableName = $table->getName(); |
|
| 523 | + $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
| 524 | + $str .= "use {$daoNamespace}\\".$daoClassName.";\n"; |
|
| 525 | + } |
|
| 526 | 526 | |
| 527 | - $str .= " |
|
| 527 | + $str .= " |
|
| 528 | 528 | /** |
| 529 | 529 | * The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM. |
| 530 | 530 | * |
@@ -533,12 +533,12 @@ discard block |
||
| 533 | 533 | { |
| 534 | 534 | "; |
| 535 | 535 | |
| 536 | - foreach ($tableList as $table) { |
|
| 537 | - $tableName = $table->getName(); |
|
| 538 | - $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
| 539 | - $daoInstanceName = self::toVariableName($daoClassName); |
|
| 536 | + foreach ($tableList as $table) { |
|
| 537 | + $tableName = $table->getName(); |
|
| 538 | + $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
| 539 | + $daoInstanceName = self::toVariableName($daoClassName); |
|
| 540 | 540 | |
| 541 | - $str .= ' /** |
|
| 541 | + $str .= ' /** |
|
| 542 | 542 | * @var '.$daoClassName.' |
| 543 | 543 | */ |
| 544 | 544 | private $'.$daoInstanceName.'; |
@@ -563,158 +563,158 @@ discard block |
||
| 563 | 563 | } |
| 564 | 564 | |
| 565 | 565 | '; |
| 566 | - } |
|
| 566 | + } |
|
| 567 | 567 | |
| 568 | - $str .= ' |
|
| 568 | + $str .= ' |
|
| 569 | 569 | } |
| 570 | 570 | '; |
| 571 | 571 | |
| 572 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName); |
|
| 573 | - if (empty($possibleFileNames)) { |
|
| 574 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
| 575 | - } |
|
| 576 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 577 | - |
|
| 578 | - $this->ensureDirectoryExist($possibleFileName); |
|
| 579 | - file_put_contents($possibleFileName, $str); |
|
| 580 | - @chmod($possibleFileName, 0664); |
|
| 581 | - } |
|
| 582 | - |
|
| 583 | - /** |
|
| 584 | - * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
| 585 | - * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
| 586 | - * |
|
| 587 | - * @param $str string |
|
| 588 | - * |
|
| 589 | - * @return string |
|
| 590 | - */ |
|
| 591 | - public static function toCamelCase($str) |
|
| 592 | - { |
|
| 593 | - $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
| 594 | - while (true) { |
|
| 595 | - if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
| 596 | - break; |
|
| 597 | - } |
|
| 598 | - |
|
| 599 | - $pos = strpos($str, '_'); |
|
| 600 | - if ($pos === false) { |
|
| 601 | - $pos = strpos($str, ' '); |
|
| 602 | - } |
|
| 603 | - $before = substr($str, 0, $pos); |
|
| 604 | - $after = substr($str, $pos + 1); |
|
| 605 | - $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
| 606 | - } |
|
| 607 | - |
|
| 608 | - return $str; |
|
| 609 | - } |
|
| 610 | - |
|
| 611 | - /** |
|
| 612 | - * Tries to put string to the singular form (if it is plural). |
|
| 613 | - * We assume the table names are in english. |
|
| 614 | - * |
|
| 615 | - * @param $str string |
|
| 616 | - * |
|
| 617 | - * @return string |
|
| 618 | - */ |
|
| 619 | - public static function toSingular($str) |
|
| 620 | - { |
|
| 621 | - return Inflector::singularize($str); |
|
| 622 | - } |
|
| 623 | - |
|
| 624 | - /** |
|
| 625 | - * Put the first letter of the string in lower case. |
|
| 626 | - * Very useful to transform a class name into a variable name. |
|
| 627 | - * |
|
| 628 | - * @param $str string |
|
| 629 | - * |
|
| 630 | - * @return string |
|
| 631 | - */ |
|
| 632 | - public static function toVariableName($str) |
|
| 633 | - { |
|
| 634 | - return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
| 635 | - } |
|
| 636 | - |
|
| 637 | - /** |
|
| 638 | - * Ensures the file passed in parameter can be written in its directory. |
|
| 639 | - * |
|
| 640 | - * @param string $fileName |
|
| 641 | - * |
|
| 642 | - * @throws TDBMException |
|
| 643 | - */ |
|
| 644 | - private function ensureDirectoryExist($fileName) |
|
| 645 | - { |
|
| 646 | - $dirName = dirname($fileName); |
|
| 647 | - if (!file_exists($dirName)) { |
|
| 648 | - $old = umask(0); |
|
| 649 | - $result = mkdir($dirName, 0775, true); |
|
| 650 | - umask($old); |
|
| 651 | - if ($result === false) { |
|
| 652 | - throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
| 653 | - } |
|
| 654 | - } |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * Absolute path to composer json file. |
|
| 659 | - * |
|
| 660 | - * @param string $composerFile |
|
| 661 | - */ |
|
| 662 | - public function setComposerFile($composerFile) |
|
| 663 | - { |
|
| 664 | - $this->rootPath = dirname($composerFile).'/'; |
|
| 665 | - $this->composerFile = basename($composerFile); |
|
| 666 | - } |
|
| 667 | - |
|
| 668 | - /** |
|
| 669 | - * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
| 670 | - * |
|
| 671 | - * @param Type $type The DBAL type |
|
| 672 | - * |
|
| 673 | - * @return string The PHP type |
|
| 674 | - */ |
|
| 675 | - public static function dbalTypeToPhpType(Type $type) |
|
| 676 | - { |
|
| 677 | - $map = [ |
|
| 678 | - Type::TARRAY => 'array', |
|
| 679 | - Type::SIMPLE_ARRAY => 'array', |
|
| 680 | - Type::JSON_ARRAY => 'array', |
|
| 681 | - Type::BIGINT => 'string', |
|
| 682 | - Type::BOOLEAN => 'bool', |
|
| 683 | - Type::DATETIME => '\DateTimeInterface', |
|
| 684 | - Type::DATETIMETZ => '\DateTimeInterface', |
|
| 685 | - Type::DATE => '\DateTimeInterface', |
|
| 686 | - Type::TIME => '\DateTimeInterface', |
|
| 687 | - Type::DECIMAL => 'float', |
|
| 688 | - Type::INTEGER => 'int', |
|
| 689 | - Type::OBJECT => 'string', |
|
| 690 | - Type::SMALLINT => 'int', |
|
| 691 | - Type::STRING => 'string', |
|
| 692 | - Type::TEXT => 'string', |
|
| 693 | - Type::BINARY => 'string', |
|
| 694 | - Type::BLOB => 'string', |
|
| 695 | - Type::FLOAT => 'float', |
|
| 696 | - Type::GUID => 'string', |
|
| 697 | - ]; |
|
| 698 | - |
|
| 699 | - return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
| 700 | - } |
|
| 701 | - |
|
| 702 | - /** |
|
| 703 | - * @param string $beanNamespace |
|
| 704 | - * |
|
| 705 | - * @return \string[] Returns a map mapping table name to beans name |
|
| 706 | - */ |
|
| 707 | - public function buildTableToBeanMap($beanNamespace) |
|
| 708 | - { |
|
| 709 | - $tableToBeanMap = []; |
|
| 710 | - |
|
| 711 | - $tables = $this->schema->getTables(); |
|
| 712 | - |
|
| 713 | - foreach ($tables as $table) { |
|
| 714 | - $tableName = $table->getName(); |
|
| 715 | - $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
| 716 | - } |
|
| 717 | - |
|
| 718 | - return $tableToBeanMap; |
|
| 719 | - } |
|
| 572 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName); |
|
| 573 | + if (empty($possibleFileNames)) { |
|
| 574 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
| 575 | + } |
|
| 576 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 577 | + |
|
| 578 | + $this->ensureDirectoryExist($possibleFileName); |
|
| 579 | + file_put_contents($possibleFileName, $str); |
|
| 580 | + @chmod($possibleFileName, 0664); |
|
| 581 | + } |
|
| 582 | + |
|
| 583 | + /** |
|
| 584 | + * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
| 585 | + * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
| 586 | + * |
|
| 587 | + * @param $str string |
|
| 588 | + * |
|
| 589 | + * @return string |
|
| 590 | + */ |
|
| 591 | + public static function toCamelCase($str) |
|
| 592 | + { |
|
| 593 | + $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
| 594 | + while (true) { |
|
| 595 | + if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
| 596 | + break; |
|
| 597 | + } |
|
| 598 | + |
|
| 599 | + $pos = strpos($str, '_'); |
|
| 600 | + if ($pos === false) { |
|
| 601 | + $pos = strpos($str, ' '); |
|
| 602 | + } |
|
| 603 | + $before = substr($str, 0, $pos); |
|
| 604 | + $after = substr($str, $pos + 1); |
|
| 605 | + $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
| 606 | + } |
|
| 607 | + |
|
| 608 | + return $str; |
|
| 609 | + } |
|
| 610 | + |
|
| 611 | + /** |
|
| 612 | + * Tries to put string to the singular form (if it is plural). |
|
| 613 | + * We assume the table names are in english. |
|
| 614 | + * |
|
| 615 | + * @param $str string |
|
| 616 | + * |
|
| 617 | + * @return string |
|
| 618 | + */ |
|
| 619 | + public static function toSingular($str) |
|
| 620 | + { |
|
| 621 | + return Inflector::singularize($str); |
|
| 622 | + } |
|
| 623 | + |
|
| 624 | + /** |
|
| 625 | + * Put the first letter of the string in lower case. |
|
| 626 | + * Very useful to transform a class name into a variable name. |
|
| 627 | + * |
|
| 628 | + * @param $str string |
|
| 629 | + * |
|
| 630 | + * @return string |
|
| 631 | + */ |
|
| 632 | + public static function toVariableName($str) |
|
| 633 | + { |
|
| 634 | + return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
| 635 | + } |
|
| 636 | + |
|
| 637 | + /** |
|
| 638 | + * Ensures the file passed in parameter can be written in its directory. |
|
| 639 | + * |
|
| 640 | + * @param string $fileName |
|
| 641 | + * |
|
| 642 | + * @throws TDBMException |
|
| 643 | + */ |
|
| 644 | + private function ensureDirectoryExist($fileName) |
|
| 645 | + { |
|
| 646 | + $dirName = dirname($fileName); |
|
| 647 | + if (!file_exists($dirName)) { |
|
| 648 | + $old = umask(0); |
|
| 649 | + $result = mkdir($dirName, 0775, true); |
|
| 650 | + umask($old); |
|
| 651 | + if ($result === false) { |
|
| 652 | + throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
| 653 | + } |
|
| 654 | + } |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * Absolute path to composer json file. |
|
| 659 | + * |
|
| 660 | + * @param string $composerFile |
|
| 661 | + */ |
|
| 662 | + public function setComposerFile($composerFile) |
|
| 663 | + { |
|
| 664 | + $this->rootPath = dirname($composerFile).'/'; |
|
| 665 | + $this->composerFile = basename($composerFile); |
|
| 666 | + } |
|
| 667 | + |
|
| 668 | + /** |
|
| 669 | + * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
| 670 | + * |
|
| 671 | + * @param Type $type The DBAL type |
|
| 672 | + * |
|
| 673 | + * @return string The PHP type |
|
| 674 | + */ |
|
| 675 | + public static function dbalTypeToPhpType(Type $type) |
|
| 676 | + { |
|
| 677 | + $map = [ |
|
| 678 | + Type::TARRAY => 'array', |
|
| 679 | + Type::SIMPLE_ARRAY => 'array', |
|
| 680 | + Type::JSON_ARRAY => 'array', |
|
| 681 | + Type::BIGINT => 'string', |
|
| 682 | + Type::BOOLEAN => 'bool', |
|
| 683 | + Type::DATETIME => '\DateTimeInterface', |
|
| 684 | + Type::DATETIMETZ => '\DateTimeInterface', |
|
| 685 | + Type::DATE => '\DateTimeInterface', |
|
| 686 | + Type::TIME => '\DateTimeInterface', |
|
| 687 | + Type::DECIMAL => 'float', |
|
| 688 | + Type::INTEGER => 'int', |
|
| 689 | + Type::OBJECT => 'string', |
|
| 690 | + Type::SMALLINT => 'int', |
|
| 691 | + Type::STRING => 'string', |
|
| 692 | + Type::TEXT => 'string', |
|
| 693 | + Type::BINARY => 'string', |
|
| 694 | + Type::BLOB => 'string', |
|
| 695 | + Type::FLOAT => 'float', |
|
| 696 | + Type::GUID => 'string', |
|
| 697 | + ]; |
|
| 698 | + |
|
| 699 | + return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
| 700 | + } |
|
| 701 | + |
|
| 702 | + /** |
|
| 703 | + * @param string $beanNamespace |
|
| 704 | + * |
|
| 705 | + * @return \string[] Returns a map mapping table name to beans name |
|
| 706 | + */ |
|
| 707 | + public function buildTableToBeanMap($beanNamespace) |
|
| 708 | + { |
|
| 709 | + $tableToBeanMap = []; |
|
| 710 | + |
|
| 711 | + $tables = $this->schema->getTables(); |
|
| 712 | + |
|
| 713 | + foreach ($tables as $table) { |
|
| 714 | + $tableName = $table->getName(); |
|
| 715 | + $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
| 716 | + } |
|
| 717 | + |
|
| 718 | + return $tableToBeanMap; |
|
| 719 | + } |
|
| 720 | 720 | } |
@@ -9,86 +9,86 @@ |
||
| 9 | 9 | */ |
| 10 | 10 | class MapIterator implements Iterator |
| 11 | 11 | { |
| 12 | - /** |
|
| 13 | - * @var Iterator |
|
| 14 | - */ |
|
| 15 | - protected $iterator; |
|
| 12 | + /** |
|
| 13 | + * @var Iterator |
|
| 14 | + */ |
|
| 15 | + protected $iterator; |
|
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @var callable Modifies the current item in iterator |
|
| 19 | - */ |
|
| 20 | - protected $callable; |
|
| 17 | + /** |
|
| 18 | + * @var callable Modifies the current item in iterator |
|
| 19 | + */ |
|
| 20 | + protected $callable; |
|
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @param $iterator Iterator|array |
|
| 24 | - * @param $callable callable This can have two parameters |
|
| 25 | - * |
|
| 26 | - * @throws TDBMException |
|
| 27 | - */ |
|
| 28 | - public function __construct($iterator, callable $callable) |
|
| 29 | - { |
|
| 30 | - if (is_array($iterator)) { |
|
| 31 | - $this->iterator = new \ArrayIterator($iterator); |
|
| 32 | - } elseif (!($iterator instanceof Iterator)) { |
|
| 33 | - throw new TDBMException('$iterator parameter must be an instance of Iterator'); |
|
| 34 | - } else { |
|
| 35 | - $this->iterator = $iterator; |
|
| 36 | - } |
|
| 22 | + /** |
|
| 23 | + * @param $iterator Iterator|array |
|
| 24 | + * @param $callable callable This can have two parameters |
|
| 25 | + * |
|
| 26 | + * @throws TDBMException |
|
| 27 | + */ |
|
| 28 | + public function __construct($iterator, callable $callable) |
|
| 29 | + { |
|
| 30 | + if (is_array($iterator)) { |
|
| 31 | + $this->iterator = new \ArrayIterator($iterator); |
|
| 32 | + } elseif (!($iterator instanceof Iterator)) { |
|
| 33 | + throw new TDBMException('$iterator parameter must be an instance of Iterator'); |
|
| 34 | + } else { |
|
| 35 | + $this->iterator = $iterator; |
|
| 36 | + } |
|
| 37 | 37 | |
| 38 | - if ($callable instanceof \Closure) { |
|
| 39 | - // make sure there's one argument |
|
| 40 | - $reflection = new \ReflectionObject($callable); |
|
| 41 | - if ($reflection->hasMethod('__invoke')) { |
|
| 42 | - $method = $reflection->getMethod('__invoke'); |
|
| 43 | - if ($method->getNumberOfParameters() !== 1) { |
|
| 44 | - throw new TDBMException('$callable must accept one and only one parameter.'); |
|
| 45 | - } |
|
| 46 | - } |
|
| 47 | - } |
|
| 38 | + if ($callable instanceof \Closure) { |
|
| 39 | + // make sure there's one argument |
|
| 40 | + $reflection = new \ReflectionObject($callable); |
|
| 41 | + if ($reflection->hasMethod('__invoke')) { |
|
| 42 | + $method = $reflection->getMethod('__invoke'); |
|
| 43 | + if ($method->getNumberOfParameters() !== 1) { |
|
| 44 | + throw new TDBMException('$callable must accept one and only one parameter.'); |
|
| 45 | + } |
|
| 46 | + } |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - $this->callable = $callable; |
|
| 50 | - } |
|
| 49 | + $this->callable = $callable; |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Alters the current item with $this->callable and returns a new item. |
|
| 54 | - * Be careful with your types as we can't do static type checking here! |
|
| 55 | - * |
|
| 56 | - * @return mixed |
|
| 57 | - */ |
|
| 58 | - public function current() |
|
| 59 | - { |
|
| 60 | - $callable = $this->callable; |
|
| 52 | + /** |
|
| 53 | + * Alters the current item with $this->callable and returns a new item. |
|
| 54 | + * Be careful with your types as we can't do static type checking here! |
|
| 55 | + * |
|
| 56 | + * @return mixed |
|
| 57 | + */ |
|
| 58 | + public function current() |
|
| 59 | + { |
|
| 60 | + $callable = $this->callable; |
|
| 61 | 61 | |
| 62 | - return $callable($this->iterator->current()); |
|
| 63 | - } |
|
| 62 | + return $callable($this->iterator->current()); |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - public function next() |
|
| 66 | - { |
|
| 67 | - $this->iterator->next(); |
|
| 68 | - } |
|
| 65 | + public function next() |
|
| 66 | + { |
|
| 67 | + $this->iterator->next(); |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - public function key() |
|
| 71 | - { |
|
| 72 | - return $this->iterator->key(); |
|
| 73 | - } |
|
| 70 | + public function key() |
|
| 71 | + { |
|
| 72 | + return $this->iterator->key(); |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - public function valid() |
|
| 76 | - { |
|
| 77 | - return $this->iterator->valid(); |
|
| 78 | - } |
|
| 75 | + public function valid() |
|
| 76 | + { |
|
| 77 | + return $this->iterator->valid(); |
|
| 78 | + } |
|
| 79 | 79 | |
| 80 | - public function rewind() |
|
| 81 | - { |
|
| 82 | - $this->iterator->rewind(); |
|
| 83 | - } |
|
| 80 | + public function rewind() |
|
| 81 | + { |
|
| 82 | + $this->iterator->rewind(); |
|
| 83 | + } |
|
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * Casts the iterator to a PHP array. |
|
| 87 | - * |
|
| 88 | - * @return array |
|
| 89 | - */ |
|
| 90 | - public function toArray() |
|
| 91 | - { |
|
| 92 | - return iterator_to_array($this); |
|
| 93 | - } |
|
| 85 | + /** |
|
| 86 | + * Casts the iterator to a PHP array. |
|
| 87 | + * |
|
| 88 | + * @return array |
|
| 89 | + */ |
|
| 90 | + public function toArray() |
|
| 91 | + { |
|
| 92 | + return iterator_to_array($this); |
|
| 93 | + } |
|
| 94 | 94 | } |