@@ -8,327 +8,327 @@ |
||
| 8 | 8 | |
| 9 | 9 | trait AutoApi |
| 10 | 10 | { |
| 11 | - /* ======================================================================= |
|
| 11 | + /* ======================================================================= |
|
| 12 | 12 | * ===================== Automatic API Support =========================== |
| 13 | 13 | * ======================================================================= */ |
| 14 | 14 | |
| 15 | - /** @var array A map of column name to functions that hook the insert function */ |
|
| 16 | - protected $registeredCreateHooks; |
|
| 15 | + /** @var array A map of column name to functions that hook the insert function */ |
|
| 16 | + protected $registeredCreateHooks; |
|
| 17 | 17 | |
| 18 | - /** @var array A map of column name to functions that hook the read function */ |
|
| 19 | - protected $registeredReadHooks; |
|
| 18 | + /** @var array A map of column name to functions that hook the read function */ |
|
| 19 | + protected $registeredReadHooks; |
|
| 20 | 20 | |
| 21 | - /** @var array A map of column name to functions that hook the update function */ |
|
| 22 | - protected $registeredUpdateHooks; |
|
| 21 | + /** @var array A map of column name to functions that hook the update function */ |
|
| 22 | + protected $registeredUpdateHooks; |
|
| 23 | 23 | |
| 24 | - /** @var array A map of column name to functions that hook the update function */ |
|
| 25 | - protected $registeredDeleteHooks; |
|
| 24 | + /** @var array A map of column name to functions that hook the update function */ |
|
| 25 | + protected $registeredDeleteHooks; |
|
| 26 | 26 | |
| 27 | - /** @var array A map of column name to functions that hook the search function */ |
|
| 28 | - protected $registeredSearchHooks; |
|
| 27 | + /** @var array A map of column name to functions that hook the search function */ |
|
| 28 | + protected $registeredSearchHooks; |
|
| 29 | 29 | |
| 30 | - /** @var array A list of table column definitions */ |
|
| 31 | - protected $tableDefinition; |
|
| 30 | + /** @var array A list of table column definitions */ |
|
| 31 | + protected $tableDefinition; |
|
| 32 | 32 | |
| 33 | - public function apiSearch($inputs, $fieldWhitelist) |
|
| 34 | - { |
|
| 35 | - // @TODO: How to handle this case? |
|
| 36 | - // => Default parameter names for searching? (limit, pagination, sort order etc) |
|
| 37 | - // Find default names for this and store in class |
|
| 38 | - // => Limited search parameters? (We don't want to be able to search on a password field for example) |
|
| 39 | - } |
|
| 33 | + public function apiSearch($inputs, $fieldWhitelist) |
|
| 34 | + { |
|
| 35 | + // @TODO: How to handle this case? |
|
| 36 | + // => Default parameter names for searching? (limit, pagination, sort order etc) |
|
| 37 | + // Find default names for this and store in class |
|
| 38 | + // => Limited search parameters? (We don't want to be able to search on a password field for example) |
|
| 39 | + } |
|
| 40 | 40 | |
| 41 | - public function toArray($fieldWhitelist) |
|
| 42 | - { |
|
| 43 | - $output = []; |
|
| 44 | - foreach ($this->tableDefinition as $colName => $definition) { |
|
| 45 | - if (in_array($colName, $fieldWhitelist)) { |
|
| 46 | - $output[$colName] = $definition['value']; |
|
| 47 | - } |
|
| 48 | - } |
|
| 41 | + public function toArray($fieldWhitelist) |
|
| 42 | + { |
|
| 43 | + $output = []; |
|
| 44 | + foreach ($this->tableDefinition as $colName => $definition) { |
|
| 45 | + if (in_array($colName, $fieldWhitelist)) { |
|
| 46 | + $output[$colName] = $definition['value']; |
|
| 47 | + } |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - return $output; |
|
| 51 | - } |
|
| 50 | + return $output; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - public function apiRead($id, $fieldWhitelist) |
|
| 54 | - { |
|
| 55 | - $this->read($id); |
|
| 56 | - return $this->toArray($fieldWhitelist); |
|
| 57 | - } |
|
| 53 | + public function apiRead($id, $fieldWhitelist) |
|
| 54 | + { |
|
| 55 | + $this->read($id); |
|
| 56 | + return $this->toArray($fieldWhitelist); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - /* ============================================================= |
|
| 59 | + /* ============================================================= |
|
| 60 | 60 | * ===================== Constraint validation ================= |
| 61 | 61 | * ============================================================= */ |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Copy all table variables between two instances |
|
| 65 | - */ |
|
| 66 | - private function syncInstances($to, $from) |
|
| 67 | - { |
|
| 68 | - foreach ($to->tableDefinition as $colName => $definition) { |
|
| 69 | - $definition['value'] = $from->tableDefinition[$colName]['value']; |
|
| 70 | - } |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - private function filterInputColumns($input, $whitelist) |
|
| 74 | - { |
|
| 75 | - $filteredInput = $input; |
|
| 76 | - foreach ($input as $colName => $value) { |
|
| 77 | - if (!in_array($colName, $whitelist)) { |
|
| 78 | - unset($filteredInput[$colName]); |
|
| 79 | - } |
|
| 80 | - } |
|
| 81 | - return $filteredInput; |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - private function validateExcessKeys($input) |
|
| 85 | - { |
|
| 86 | - $errors = []; |
|
| 87 | - foreach ($input as $colName => $value) { |
|
| 88 | - if (!array_key_exists($colName, $this->tableDefinition)) { |
|
| 89 | - $errors[$colName] = "Unknown input field"; |
|
| 90 | - continue; |
|
| 91 | - } |
|
| 92 | - } |
|
| 93 | - return $errors; |
|
| 94 | - } |
|
| 95 | - |
|
| 96 | - private function validateImmutableColumns($input) |
|
| 97 | - { |
|
| 98 | - $errors = []; |
|
| 99 | - foreach ($this->tableDefinition as $colName => $definition) { |
|
| 100 | - $property = $definition['properties'] ?? null; |
|
| 101 | - if (array_key_exists($colName, $input) |
|
| 102 | - && $property & ColumnProperty::IMMUTABLE) { |
|
| 103 | - $errors[$colName] = "Field cannot be changed"; |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - return $errors; |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - private function validateInputValues($input) |
|
| 110 | - { |
|
| 111 | - $errors = []; |
|
| 112 | - foreach ($this->tableDefinition as $colName => $definition) { |
|
| 113 | - // Validation check 1: If validate function is present |
|
| 114 | - if (array_key_exists($colName, $input) |
|
| 115 | - && is_callable($definition['validate'] ?? null)) { |
|
| 116 | - $inputValue = $input[$colName]; |
|
| 117 | - |
|
| 118 | - // If validation function fails |
|
| 119 | - [$status, $message] = $definition['validate']($inputValue); |
|
| 120 | - if (!$status) { |
|
| 121 | - $errors[$colName] = $message; |
|
| 122 | - } |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - // Validation check 2: If relation column, check whether entity exists |
|
| 126 | - $properties = $definition['properties'] ?? null; |
|
| 127 | - if (isset($definition['relation']) |
|
| 128 | - && ($properties & ColumnProperty::NOT_NULL)) { |
|
| 129 | - $instance = clone $definition['relation']; |
|
| 130 | - try { |
|
| 131 | - $instance->read($input[$colName] ?? null); |
|
| 132 | - } catch (ActiveRecordException $e) { |
|
| 133 | - $errors[$colName] = "Entity for this value doesn't exist"; |
|
| 134 | - } |
|
| 135 | - } |
|
| 136 | - } |
|
| 137 | - return $errors; |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * This function is only used for API Update calls (direct getter/setter functions are unconstrained) |
|
| 142 | - */ |
|
| 143 | - private function validateMissingKeys() |
|
| 144 | - { |
|
| 145 | - $errors = []; |
|
| 146 | - |
|
| 147 | - foreach ($this->tableDefinition as $colName => $colDefinition) { |
|
| 148 | - $default = $colDefinition['default'] ?? null; |
|
| 149 | - $properties = $colDefinition['properties'] ?? null; |
|
| 150 | - $value = $colDefinition['value']; |
|
| 151 | - |
|
| 152 | - // If nullable and default not set => null |
|
| 153 | - // If nullable and default null => default (null) |
|
| 154 | - // If nullable and default set => default (value) |
|
| 155 | - |
|
| 156 | - // if not nullable and default not set => error |
|
| 157 | - // if not nullable and default null => error |
|
| 158 | - // if not nullable and default st => default (value) |
|
| 159 | - // => if not nullable and default null and value not set => error message in this method |
|
| 160 | - if ($properties & ColumnProperty::NOT_NULL |
|
| 161 | - && $default === null |
|
| 162 | - && !($properties & ColumnProperty::AUTO_INCREMENT) |
|
| 163 | - // && !array_key_exists($colName, $input) |
|
| 164 | - && $value === null) { |
|
| 165 | - $errors[$colName] = sprintf("The required field \"%s\" is missing", $colName); |
|
| 166 | - } |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - return $errors; |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - /** |
|
| 173 | - * Copies the values for entries in the input with matching variable names in the record definition |
|
| 174 | - * @param Array $input The input data to be loaded into $this record |
|
| 175 | - */ |
|
| 176 | - private function loadData($input) |
|
| 177 | - { |
|
| 178 | - foreach ($this->tableDefinition as $colName => $definition) { |
|
| 179 | - if (array_key_exists($colName, $input)) { |
|
| 180 | - $definition['value'] = $input[$colName]; |
|
| 181 | - } |
|
| 182 | - } |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * @param Array $input Associative array of input values |
|
| 187 | - * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array |
|
| 188 | - * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative) |
|
| 189 | - * of the modified data. |
|
| 190 | - */ |
|
| 191 | - public function apiCreate($input, $fieldWhitelist) |
|
| 192 | - { |
|
| 193 | - // Clone $this to new instance (for restoring if validation goes wrong) |
|
| 194 | - $transaction = clone $this; |
|
| 195 | - $errors = []; |
|
| 196 | - |
|
| 197 | - // Filter out all non-whitelisted input values |
|
| 198 | - $input = $this->filterInputColumns($input, $fieldWhitelist); |
|
| 199 | - |
|
| 200 | - // Validate excess keys |
|
| 201 | - $errors += $transaction->validateExcessKeys($input); |
|
| 202 | - |
|
| 203 | - // Validate input values (using validation function) |
|
| 204 | - $errors += $transaction->validateInputValues($input); |
|
| 205 | - |
|
| 206 | - // "Copy" data into transaction |
|
| 207 | - $transaction->loadData($input); |
|
| 208 | - |
|
| 209 | - // Run create hooks |
|
| 210 | - foreach ($this->registeredCreateHooks as $colName => $fn) { |
|
| 211 | - $fn(); |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - // Validate missing keys |
|
| 215 | - $errors += $transaction->validateMissingKeys(); |
|
| 216 | - |
|
| 217 | - // If no errors, commit the pending data |
|
| 218 | - if (empty($errors)) { |
|
| 219 | - $this->syncInstances($this, $transaction); |
|
| 220 | - |
|
| 221 | - try { |
|
| 222 | - (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 223 | - ->insert($this->getActiveRecordColumns()) |
|
| 224 | - ->execute(); |
|
| 225 | - |
|
| 226 | - $this->setId(intval($this->getPdo()->lastInsertId())); |
|
| 227 | - } catch (\PDOException $e) { |
|
| 228 | - // @TODO: Potentially filter and store mysql messages (where possible) in error messages |
|
| 229 | - throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - return [null, $this->toArray($fieldWhitelist)]; |
|
| 233 | - } else { |
|
| 234 | - return [$errors, null]; |
|
| 235 | - } |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * @param Array $input Associative array of input values |
|
| 240 | - * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array |
|
| 241 | - * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative) |
|
| 242 | - * of the modified data. |
|
| 243 | - */ |
|
| 244 | - public function apiUpdate($input, $fieldWhitelist) |
|
| 245 | - { |
|
| 246 | - $transaction = clone $this; |
|
| 247 | - $errors = []; |
|
| 248 | - |
|
| 249 | - // Filter out all non-whitelisted input values |
|
| 250 | - $input = $this->filterInputColumns($input, $fieldWhitelist); |
|
| 251 | - |
|
| 252 | - // Check for excess keys |
|
| 253 | - $errors += $transaction->validateExcessKeys($input); |
|
| 254 | - |
|
| 255 | - // Check for immutable keys |
|
| 256 | - $errors += $transaction->validateImmutableColumns($input); |
|
| 257 | - |
|
| 258 | - // Validate input values (using validation function) |
|
| 259 | - $errors += $transaction->validateInputValues($input); |
|
| 260 | - |
|
| 261 | - // "Copy" data into transaction |
|
| 262 | - $transaction->loadData($input); |
|
| 263 | - |
|
| 264 | - // Run create hooks |
|
| 265 | - foreach ($this->registeredUpdateHooks as $colName => $fn) { |
|
| 266 | - $fn(); |
|
| 267 | - } |
|
| 268 | - |
|
| 269 | - // Validate missing keys |
|
| 270 | - $errors += $transaction->validateMissingKeys(); |
|
| 271 | - |
|
| 272 | - // Update database |
|
| 273 | - if (empty($errors)) { |
|
| 274 | - $this->syncInstances($this, $transaction); |
|
| 275 | - |
|
| 276 | - try { |
|
| 277 | - (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 278 | - ->update($this->getActiveRecordColumns()) |
|
| 279 | - ->where(Query::Equal('id', $this->getId())) |
|
| 280 | - ->execute(); |
|
| 281 | - } catch (\PDOException $e) { |
|
| 282 | - throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - return [null, $this->toArray($fieldWhitelist)]; |
|
| 286 | - } else { |
|
| 287 | - return [$errors, null]; |
|
| 288 | - } |
|
| 289 | - } |
|
| 290 | - |
|
| 291 | - /** |
|
| 292 | - * Returns this active record after reading the attributes from the entry with the given identifier. |
|
| 293 | - * |
|
| 294 | - * @param mixed $id |
|
| 295 | - * @return $this |
|
| 296 | - * @throws ActiveRecordException on failure. |
|
| 297 | - */ |
|
| 298 | - abstract public function read($id); |
|
| 299 | - |
|
| 300 | - /** |
|
| 301 | - * Returns the PDO. |
|
| 302 | - * |
|
| 303 | - * @return \PDO the PDO. |
|
| 304 | - */ |
|
| 305 | - abstract public function getPdo(); |
|
| 306 | - |
|
| 307 | - /** |
|
| 308 | - * Set the ID. |
|
| 309 | - * |
|
| 310 | - * @param int $id |
|
| 311 | - * @return $this |
|
| 312 | - */ |
|
| 313 | - abstract protected function setId($id); |
|
| 314 | - |
|
| 315 | - /** |
|
| 316 | - * Returns the ID. |
|
| 317 | - * |
|
| 318 | - * @return null|int The ID. |
|
| 319 | - */ |
|
| 320 | - abstract protected function getId(); |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * Returns the active record table. |
|
| 324 | - * |
|
| 325 | - * @return string the active record table name. |
|
| 326 | - */ |
|
| 327 | - abstract protected function getActiveRecordTable(); |
|
| 328 | - |
|
| 329 | - /** |
|
| 330 | - * Returns the name -> variable mapping for the table definition. |
|
| 331 | - * @return Array The mapping |
|
| 332 | - */ |
|
| 333 | - abstract protected function getActiveRecordColumns(); |
|
| 63 | + /** |
|
| 64 | + * Copy all table variables between two instances |
|
| 65 | + */ |
|
| 66 | + private function syncInstances($to, $from) |
|
| 67 | + { |
|
| 68 | + foreach ($to->tableDefinition as $colName => $definition) { |
|
| 69 | + $definition['value'] = $from->tableDefinition[$colName]['value']; |
|
| 70 | + } |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + private function filterInputColumns($input, $whitelist) |
|
| 74 | + { |
|
| 75 | + $filteredInput = $input; |
|
| 76 | + foreach ($input as $colName => $value) { |
|
| 77 | + if (!in_array($colName, $whitelist)) { |
|
| 78 | + unset($filteredInput[$colName]); |
|
| 79 | + } |
|
| 80 | + } |
|
| 81 | + return $filteredInput; |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + private function validateExcessKeys($input) |
|
| 85 | + { |
|
| 86 | + $errors = []; |
|
| 87 | + foreach ($input as $colName => $value) { |
|
| 88 | + if (!array_key_exists($colName, $this->tableDefinition)) { |
|
| 89 | + $errors[$colName] = "Unknown input field"; |
|
| 90 | + continue; |
|
| 91 | + } |
|
| 92 | + } |
|
| 93 | + return $errors; |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + private function validateImmutableColumns($input) |
|
| 97 | + { |
|
| 98 | + $errors = []; |
|
| 99 | + foreach ($this->tableDefinition as $colName => $definition) { |
|
| 100 | + $property = $definition['properties'] ?? null; |
|
| 101 | + if (array_key_exists($colName, $input) |
|
| 102 | + && $property & ColumnProperty::IMMUTABLE) { |
|
| 103 | + $errors[$colName] = "Field cannot be changed"; |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + return $errors; |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + private function validateInputValues($input) |
|
| 110 | + { |
|
| 111 | + $errors = []; |
|
| 112 | + foreach ($this->tableDefinition as $colName => $definition) { |
|
| 113 | + // Validation check 1: If validate function is present |
|
| 114 | + if (array_key_exists($colName, $input) |
|
| 115 | + && is_callable($definition['validate'] ?? null)) { |
|
| 116 | + $inputValue = $input[$colName]; |
|
| 117 | + |
|
| 118 | + // If validation function fails |
|
| 119 | + [$status, $message] = $definition['validate']($inputValue); |
|
| 120 | + if (!$status) { |
|
| 121 | + $errors[$colName] = $message; |
|
| 122 | + } |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + // Validation check 2: If relation column, check whether entity exists |
|
| 126 | + $properties = $definition['properties'] ?? null; |
|
| 127 | + if (isset($definition['relation']) |
|
| 128 | + && ($properties & ColumnProperty::NOT_NULL)) { |
|
| 129 | + $instance = clone $definition['relation']; |
|
| 130 | + try { |
|
| 131 | + $instance->read($input[$colName] ?? null); |
|
| 132 | + } catch (ActiveRecordException $e) { |
|
| 133 | + $errors[$colName] = "Entity for this value doesn't exist"; |
|
| 134 | + } |
|
| 135 | + } |
|
| 136 | + } |
|
| 137 | + return $errors; |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * This function is only used for API Update calls (direct getter/setter functions are unconstrained) |
|
| 142 | + */ |
|
| 143 | + private function validateMissingKeys() |
|
| 144 | + { |
|
| 145 | + $errors = []; |
|
| 146 | + |
|
| 147 | + foreach ($this->tableDefinition as $colName => $colDefinition) { |
|
| 148 | + $default = $colDefinition['default'] ?? null; |
|
| 149 | + $properties = $colDefinition['properties'] ?? null; |
|
| 150 | + $value = $colDefinition['value']; |
|
| 151 | + |
|
| 152 | + // If nullable and default not set => null |
|
| 153 | + // If nullable and default null => default (null) |
|
| 154 | + // If nullable and default set => default (value) |
|
| 155 | + |
|
| 156 | + // if not nullable and default not set => error |
|
| 157 | + // if not nullable and default null => error |
|
| 158 | + // if not nullable and default st => default (value) |
|
| 159 | + // => if not nullable and default null and value not set => error message in this method |
|
| 160 | + if ($properties & ColumnProperty::NOT_NULL |
|
| 161 | + && $default === null |
|
| 162 | + && !($properties & ColumnProperty::AUTO_INCREMENT) |
|
| 163 | + // && !array_key_exists($colName, $input) |
|
| 164 | + && $value === null) { |
|
| 165 | + $errors[$colName] = sprintf("The required field \"%s\" is missing", $colName); |
|
| 166 | + } |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + return $errors; |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * Copies the values for entries in the input with matching variable names in the record definition |
|
| 174 | + * @param Array $input The input data to be loaded into $this record |
|
| 175 | + */ |
|
| 176 | + private function loadData($input) |
|
| 177 | + { |
|
| 178 | + foreach ($this->tableDefinition as $colName => $definition) { |
|
| 179 | + if (array_key_exists($colName, $input)) { |
|
| 180 | + $definition['value'] = $input[$colName]; |
|
| 181 | + } |
|
| 182 | + } |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * @param Array $input Associative array of input values |
|
| 187 | + * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array |
|
| 188 | + * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative) |
|
| 189 | + * of the modified data. |
|
| 190 | + */ |
|
| 191 | + public function apiCreate($input, $fieldWhitelist) |
|
| 192 | + { |
|
| 193 | + // Clone $this to new instance (for restoring if validation goes wrong) |
|
| 194 | + $transaction = clone $this; |
|
| 195 | + $errors = []; |
|
| 196 | + |
|
| 197 | + // Filter out all non-whitelisted input values |
|
| 198 | + $input = $this->filterInputColumns($input, $fieldWhitelist); |
|
| 199 | + |
|
| 200 | + // Validate excess keys |
|
| 201 | + $errors += $transaction->validateExcessKeys($input); |
|
| 202 | + |
|
| 203 | + // Validate input values (using validation function) |
|
| 204 | + $errors += $transaction->validateInputValues($input); |
|
| 205 | + |
|
| 206 | + // "Copy" data into transaction |
|
| 207 | + $transaction->loadData($input); |
|
| 208 | + |
|
| 209 | + // Run create hooks |
|
| 210 | + foreach ($this->registeredCreateHooks as $colName => $fn) { |
|
| 211 | + $fn(); |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + // Validate missing keys |
|
| 215 | + $errors += $transaction->validateMissingKeys(); |
|
| 216 | + |
|
| 217 | + // If no errors, commit the pending data |
|
| 218 | + if (empty($errors)) { |
|
| 219 | + $this->syncInstances($this, $transaction); |
|
| 220 | + |
|
| 221 | + try { |
|
| 222 | + (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 223 | + ->insert($this->getActiveRecordColumns()) |
|
| 224 | + ->execute(); |
|
| 225 | + |
|
| 226 | + $this->setId(intval($this->getPdo()->lastInsertId())); |
|
| 227 | + } catch (\PDOException $e) { |
|
| 228 | + // @TODO: Potentially filter and store mysql messages (where possible) in error messages |
|
| 229 | + throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + return [null, $this->toArray($fieldWhitelist)]; |
|
| 233 | + } else { |
|
| 234 | + return [$errors, null]; |
|
| 235 | + } |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * @param Array $input Associative array of input values |
|
| 240 | + * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array |
|
| 241 | + * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative) |
|
| 242 | + * of the modified data. |
|
| 243 | + */ |
|
| 244 | + public function apiUpdate($input, $fieldWhitelist) |
|
| 245 | + { |
|
| 246 | + $transaction = clone $this; |
|
| 247 | + $errors = []; |
|
| 248 | + |
|
| 249 | + // Filter out all non-whitelisted input values |
|
| 250 | + $input = $this->filterInputColumns($input, $fieldWhitelist); |
|
| 251 | + |
|
| 252 | + // Check for excess keys |
|
| 253 | + $errors += $transaction->validateExcessKeys($input); |
|
| 254 | + |
|
| 255 | + // Check for immutable keys |
|
| 256 | + $errors += $transaction->validateImmutableColumns($input); |
|
| 257 | + |
|
| 258 | + // Validate input values (using validation function) |
|
| 259 | + $errors += $transaction->validateInputValues($input); |
|
| 260 | + |
|
| 261 | + // "Copy" data into transaction |
|
| 262 | + $transaction->loadData($input); |
|
| 263 | + |
|
| 264 | + // Run create hooks |
|
| 265 | + foreach ($this->registeredUpdateHooks as $colName => $fn) { |
|
| 266 | + $fn(); |
|
| 267 | + } |
|
| 268 | + |
|
| 269 | + // Validate missing keys |
|
| 270 | + $errors += $transaction->validateMissingKeys(); |
|
| 271 | + |
|
| 272 | + // Update database |
|
| 273 | + if (empty($errors)) { |
|
| 274 | + $this->syncInstances($this, $transaction); |
|
| 275 | + |
|
| 276 | + try { |
|
| 277 | + (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 278 | + ->update($this->getActiveRecordColumns()) |
|
| 279 | + ->where(Query::Equal('id', $this->getId())) |
|
| 280 | + ->execute(); |
|
| 281 | + } catch (\PDOException $e) { |
|
| 282 | + throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + return [null, $this->toArray($fieldWhitelist)]; |
|
| 286 | + } else { |
|
| 287 | + return [$errors, null]; |
|
| 288 | + } |
|
| 289 | + } |
|
| 290 | + |
|
| 291 | + /** |
|
| 292 | + * Returns this active record after reading the attributes from the entry with the given identifier. |
|
| 293 | + * |
|
| 294 | + * @param mixed $id |
|
| 295 | + * @return $this |
|
| 296 | + * @throws ActiveRecordException on failure. |
|
| 297 | + */ |
|
| 298 | + abstract public function read($id); |
|
| 299 | + |
|
| 300 | + /** |
|
| 301 | + * Returns the PDO. |
|
| 302 | + * |
|
| 303 | + * @return \PDO the PDO. |
|
| 304 | + */ |
|
| 305 | + abstract public function getPdo(); |
|
| 306 | + |
|
| 307 | + /** |
|
| 308 | + * Set the ID. |
|
| 309 | + * |
|
| 310 | + * @param int $id |
|
| 311 | + * @return $this |
|
| 312 | + */ |
|
| 313 | + abstract protected function setId($id); |
|
| 314 | + |
|
| 315 | + /** |
|
| 316 | + * Returns the ID. |
|
| 317 | + * |
|
| 318 | + * @return null|int The ID. |
|
| 319 | + */ |
|
| 320 | + abstract protected function getId(); |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * Returns the active record table. |
|
| 324 | + * |
|
| 325 | + * @return string the active record table name. |
|
| 326 | + */ |
|
| 327 | + abstract protected function getActiveRecordTable(); |
|
| 328 | + |
|
| 329 | + /** |
|
| 330 | + * Returns the name -> variable mapping for the table definition. |
|
| 331 | + * @return Array The mapping |
|
| 332 | + */ |
|
| 333 | + abstract protected function getActiveRecordColumns(); |
|
| 334 | 334 | } |
@@ -9,103 +9,103 @@ |
||
| 9 | 9 | |
| 10 | 10 | trait SoftDelete |
| 11 | 11 | { |
| 12 | - /** @var boolean the soft delete status for the entity this trait is embedded into. */ |
|
| 13 | - protected $softDelete; |
|
| 14 | - |
|
| 15 | - /** |
|
| 16 | - * this method is required to be called in the constructor for each class that uses this trait. |
|
| 17 | - * It adds the required fields to the table definition and registers hooks |
|
| 18 | - */ |
|
| 19 | - protected function initSoftDelete() |
|
| 20 | - { |
|
| 21 | - $this->softDelete = false; |
|
| 22 | - |
|
| 23 | - $this->extendTableDefinition(TRAIT_SOFT_DELETE_FIELD_KEY, [ |
|
| 24 | - 'value' => &$this->softDelete, |
|
| 25 | - 'validate' => null, |
|
| 26 | - 'default' => 0, |
|
| 27 | - 'type' => 'INT', |
|
| 28 | - 'length' => 1, |
|
| 29 | - 'properties' => ColumnProperty::NOT_NULL |
|
| 30 | - ]); |
|
| 31 | - |
|
| 32 | - $this->registerSearchHook(TRAIT_SOFT_DELETE_FIELD_KEY, 'softDeleteSearchHook'); |
|
| 33 | - } |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * The hook that gets called whenever a query is made |
|
| 37 | - */ |
|
| 38 | - protected function softDeleteSearchHook() |
|
| 39 | - { |
|
| 40 | - return Query::Equal(TRAIT_SOFT_DELETE_FIELD_KEY, 0); |
|
| 41 | - } |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * returns the name for the soft delete field in the database |
|
| 45 | - * @return string |
|
| 46 | - */ |
|
| 47 | - public function getSoftDeleteFieldName() |
|
| 48 | - { |
|
| 49 | - return TRAIT_SOFT_DELETE_FIELD_KEY; |
|
| 50 | - } |
|
| 12 | + /** @var boolean the soft delete status for the entity this trait is embedded into. */ |
|
| 13 | + protected $softDelete; |
|
| 14 | + |
|
| 15 | + /** |
|
| 16 | + * this method is required to be called in the constructor for each class that uses this trait. |
|
| 17 | + * It adds the required fields to the table definition and registers hooks |
|
| 18 | + */ |
|
| 19 | + protected function initSoftDelete() |
|
| 20 | + { |
|
| 21 | + $this->softDelete = false; |
|
| 22 | + |
|
| 23 | + $this->extendTableDefinition(TRAIT_SOFT_DELETE_FIELD_KEY, [ |
|
| 24 | + 'value' => &$this->softDelete, |
|
| 25 | + 'validate' => null, |
|
| 26 | + 'default' => 0, |
|
| 27 | + 'type' => 'INT', |
|
| 28 | + 'length' => 1, |
|
| 29 | + 'properties' => ColumnProperty::NOT_NULL |
|
| 30 | + ]); |
|
| 31 | + |
|
| 32 | + $this->registerSearchHook(TRAIT_SOFT_DELETE_FIELD_KEY, 'softDeleteSearchHook'); |
|
| 33 | + } |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * The hook that gets called whenever a query is made |
|
| 37 | + */ |
|
| 38 | + protected function softDeleteSearchHook() |
|
| 39 | + { |
|
| 40 | + return Query::Equal(TRAIT_SOFT_DELETE_FIELD_KEY, 0); |
|
| 41 | + } |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * returns the name for the soft delete field in the database |
|
| 45 | + * @return string |
|
| 46 | + */ |
|
| 47 | + public function getSoftDeleteFieldName() |
|
| 48 | + { |
|
| 49 | + return TRAIT_SOFT_DELETE_FIELD_KEY; |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Mark the current record as soft deleted |
|
| 54 | - * @return $this |
|
| 55 | - */ |
|
| 56 | - public function softDelete() |
|
| 57 | - { |
|
| 58 | - $this->softDelete = true; |
|
| 59 | - return $this; |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * Undo the current soft deletion status (mark it as non-soft deleted) |
|
| 64 | - * @return $this |
|
| 65 | - */ |
|
| 66 | - public function softRestore() |
|
| 67 | - { |
|
| 68 | - $this->softDelete = false; |
|
| 69 | - return $this; |
|
| 70 | - } |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * returns the current soft deletion status |
|
| 74 | - * @return $this |
|
| 75 | - */ |
|
| 76 | - public function getDeletionStatus() |
|
| 77 | - { |
|
| 78 | - return $this->softDelete; |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * @return void |
|
| 83 | - */ |
|
| 84 | - abstract protected function extendTableDefinition($columnName, $definition); |
|
| 52 | + /** |
|
| 53 | + * Mark the current record as soft deleted |
|
| 54 | + * @return $this |
|
| 55 | + */ |
|
| 56 | + public function softDelete() |
|
| 57 | + { |
|
| 58 | + $this->softDelete = true; |
|
| 59 | + return $this; |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * Undo the current soft deletion status (mark it as non-soft deleted) |
|
| 64 | + * @return $this |
|
| 65 | + */ |
|
| 66 | + public function softRestore() |
|
| 67 | + { |
|
| 68 | + $this->softDelete = false; |
|
| 69 | + return $this; |
|
| 70 | + } |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * returns the current soft deletion status |
|
| 74 | + * @return $this |
|
| 75 | + */ |
|
| 76 | + public function getDeletionStatus() |
|
| 77 | + { |
|
| 78 | + return $this->softDelete; |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * @return void |
|
| 83 | + */ |
|
| 84 | + abstract protected function extendTableDefinition($columnName, $definition); |
|
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * @return void |
|
| 88 | - */ |
|
| 89 | - abstract protected function registerSearchHook($columnName, $fn); |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * @return void |
|
| 93 | - */ |
|
| 94 | - abstract protected function registerDeleteHook($columnName, $fn); |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * @return void |
|
| 98 | - */ |
|
| 99 | - abstract protected function registerUpdateHook($columnName, $fn); |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * @return void |
|
| 103 | - */ |
|
| 104 | - abstract protected function registerReadHook($columnName, $fn); |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * @return void |
|
| 108 | - */ |
|
| 109 | - abstract protected function registerCreateHook($columnName, $fn); |
|
| 86 | + /** |
|
| 87 | + * @return void |
|
| 88 | + */ |
|
| 89 | + abstract protected function registerSearchHook($columnName, $fn); |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * @return void |
|
| 93 | + */ |
|
| 94 | + abstract protected function registerDeleteHook($columnName, $fn); |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * @return void |
|
| 98 | + */ |
|
| 99 | + abstract protected function registerUpdateHook($columnName, $fn); |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * @return void |
|
| 103 | + */ |
|
| 104 | + abstract protected function registerReadHook($columnName, $fn); |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * @return void |
|
| 108 | + */ |
|
| 109 | + abstract protected function registerCreateHook($columnName, $fn); |
|
| 110 | 110 | |
| 111 | 111 | } |
| 112 | 112 | \ No newline at end of file |
@@ -20,162 +20,162 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | class ActiveRecordQuery |
| 22 | 22 | { |
| 23 | - private $table; |
|
| 24 | - |
|
| 25 | - private $hooks; |
|
| 26 | - |
|
| 27 | - private $results; |
|
| 28 | - |
|
| 29 | - private $query; |
|
| 30 | - |
|
| 31 | - private $whereExpression = null; |
|
| 32 | - |
|
| 33 | - private $clauses = []; |
|
| 34 | - |
|
| 35 | - public function __construct(AbstractActiveRecord $instance, $table, Array $additionalWhereClauses) |
|
| 36 | - { |
|
| 37 | - $this->table = $table; |
|
| 38 | - $this->query = new Query($instance->getPdo(), $table); |
|
| 39 | - $this->type = $instance; |
|
| 40 | - $this->clauses = $additionalWhereClauses; |
|
| 41 | - } |
|
| 42 | - |
|
| 43 | - private function execute() |
|
| 44 | - { |
|
| 45 | - $clauses = $this->clauses; |
|
| 46 | - |
|
| 47 | - // Optionally add user concatenated where expression |
|
| 48 | - if ($this->whereExpression !== null) |
|
| 49 | - { |
|
| 50 | - $clauses[] = $this->whereExpression; |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - // Construct where clause |
|
| 54 | - if (count($clauses) == 1) |
|
| 55 | - { |
|
| 56 | - $this->query->where($clauses[0]); |
|
| 57 | - } else if (count($clauses) >= 2) |
|
| 58 | - { |
|
| 59 | - $rest = array_slice($clauses, 1); |
|
| 60 | - $this->query->where(Query::And($clauses[0], ...$rest)); |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - $this->query->select(); |
|
| 64 | - |
|
| 65 | - $this->results = $this->query->execute(); |
|
| 66 | - |
|
| 67 | - return $this; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - public function fetchAll() |
|
| 71 | - { |
|
| 72 | - try { |
|
| 73 | - // TODO: Should execute call be explicit? |
|
| 74 | - $this->execute(); |
|
| 75 | - |
|
| 76 | - $typedResults = []; |
|
| 77 | - |
|
| 78 | - $entries = $this->results->fetchAll(); |
|
| 79 | - if ($entries === false) { |
|
| 80 | - throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table)); |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - foreach ($entries as $entry) { |
|
| 84 | - $typedEntry = clone $this->type; |
|
| 85 | - $typedEntry->fill($entry); |
|
| 86 | - $typedResults[] = $typedEntry; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - return $typedResults; |
|
| 90 | - } catch (\PDOException $e) { |
|
| 91 | - throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 92 | - } |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - public function fetch() |
|
| 96 | - { |
|
| 97 | - try { |
|
| 98 | - $this->execute(); |
|
| 99 | - |
|
| 100 | - $typedResult = clone $this->type; |
|
| 101 | - |
|
| 102 | - $entry = $this->results->fetch(); |
|
| 103 | - if ($entry === false) { |
|
| 104 | - throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table)); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - $typedResult->fill($entry); |
|
| 108 | - |
|
| 109 | - return $typedResult; |
|
| 110 | - } catch (\PDOException $e) { |
|
| 111 | - throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 112 | - } |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * Set the where condition |
|
| 118 | - * |
|
| 119 | - * @param QueryExpression $expression the query expression |
|
| 120 | - * @return $this |
|
| 121 | - * @see https://en.wikipedia.org/wiki/SQL#Operators |
|
| 122 | - * @see https://en.wikipedia.org/wiki/Where_(SQL) |
|
| 123 | - */ |
|
| 124 | - public function where(QueryExpression $expression) |
|
| 125 | - { |
|
| 126 | - $this->whereExpression = $expression; |
|
| 127 | - return $this; |
|
| 128 | - } |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * Set an additional group by. |
|
| 132 | - * |
|
| 133 | - * @param string $column |
|
| 134 | - * @return $this |
|
| 135 | - * @see https://en.wikipedia.org/wiki/SQL#Queries |
|
| 136 | - */ |
|
| 137 | - public function groupBy($column) |
|
| 138 | - { |
|
| 139 | - $this->query->groupBy($column); |
|
| 140 | - return $this; |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * Set an additional order condition. |
|
| 145 | - * |
|
| 146 | - * @param string $column |
|
| 147 | - * @param string|null $order |
|
| 148 | - * @return $this |
|
| 149 | - * @see https://en.wikipedia.org/wiki/SQL#Queries |
|
| 150 | - * @see https://en.wikipedia.org/wiki/Order_by |
|
| 151 | - */ |
|
| 152 | - public function orderBy($column, $order = null) |
|
| 153 | - { |
|
| 154 | - $this->query->orderBy($column, $order); |
|
| 155 | - return $this; |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * Set the limit. |
|
| 160 | - * |
|
| 161 | - * @param mixed $limit |
|
| 162 | - * @return $this |
|
| 163 | - */ |
|
| 164 | - public function limit($limit) |
|
| 165 | - { |
|
| 166 | - $this->query->limit($limit); |
|
| 167 | - return $this; |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * Set the offset. |
|
| 172 | - * |
|
| 173 | - * @param mixed $offset |
|
| 174 | - * @return $this |
|
| 175 | - */ |
|
| 176 | - public function offset($offset) |
|
| 177 | - { |
|
| 178 | - $this->query->offset($offset); |
|
| 179 | - return $this; |
|
| 180 | - } |
|
| 23 | + private $table; |
|
| 24 | + |
|
| 25 | + private $hooks; |
|
| 26 | + |
|
| 27 | + private $results; |
|
| 28 | + |
|
| 29 | + private $query; |
|
| 30 | + |
|
| 31 | + private $whereExpression = null; |
|
| 32 | + |
|
| 33 | + private $clauses = []; |
|
| 34 | + |
|
| 35 | + public function __construct(AbstractActiveRecord $instance, $table, Array $additionalWhereClauses) |
|
| 36 | + { |
|
| 37 | + $this->table = $table; |
|
| 38 | + $this->query = new Query($instance->getPdo(), $table); |
|
| 39 | + $this->type = $instance; |
|
| 40 | + $this->clauses = $additionalWhereClauses; |
|
| 41 | + } |
|
| 42 | + |
|
| 43 | + private function execute() |
|
| 44 | + { |
|
| 45 | + $clauses = $this->clauses; |
|
| 46 | + |
|
| 47 | + // Optionally add user concatenated where expression |
|
| 48 | + if ($this->whereExpression !== null) |
|
| 49 | + { |
|
| 50 | + $clauses[] = $this->whereExpression; |
|
| 51 | + } |
|
| 52 | + |
|
| 53 | + // Construct where clause |
|
| 54 | + if (count($clauses) == 1) |
|
| 55 | + { |
|
| 56 | + $this->query->where($clauses[0]); |
|
| 57 | + } else if (count($clauses) >= 2) |
|
| 58 | + { |
|
| 59 | + $rest = array_slice($clauses, 1); |
|
| 60 | + $this->query->where(Query::And($clauses[0], ...$rest)); |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + $this->query->select(); |
|
| 64 | + |
|
| 65 | + $this->results = $this->query->execute(); |
|
| 66 | + |
|
| 67 | + return $this; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + public function fetchAll() |
|
| 71 | + { |
|
| 72 | + try { |
|
| 73 | + // TODO: Should execute call be explicit? |
|
| 74 | + $this->execute(); |
|
| 75 | + |
|
| 76 | + $typedResults = []; |
|
| 77 | + |
|
| 78 | + $entries = $this->results->fetchAll(); |
|
| 79 | + if ($entries === false) { |
|
| 80 | + throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table)); |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + foreach ($entries as $entry) { |
|
| 84 | + $typedEntry = clone $this->type; |
|
| 85 | + $typedEntry->fill($entry); |
|
| 86 | + $typedResults[] = $typedEntry; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + return $typedResults; |
|
| 90 | + } catch (\PDOException $e) { |
|
| 91 | + throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 92 | + } |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + public function fetch() |
|
| 96 | + { |
|
| 97 | + try { |
|
| 98 | + $this->execute(); |
|
| 99 | + |
|
| 100 | + $typedResult = clone $this->type; |
|
| 101 | + |
|
| 102 | + $entry = $this->results->fetch(); |
|
| 103 | + if ($entry === false) { |
|
| 104 | + throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table)); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + $typedResult->fill($entry); |
|
| 108 | + |
|
| 109 | + return $typedResult; |
|
| 110 | + } catch (\PDOException $e) { |
|
| 111 | + throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 112 | + } |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * Set the where condition |
|
| 118 | + * |
|
| 119 | + * @param QueryExpression $expression the query expression |
|
| 120 | + * @return $this |
|
| 121 | + * @see https://en.wikipedia.org/wiki/SQL#Operators |
|
| 122 | + * @see https://en.wikipedia.org/wiki/Where_(SQL) |
|
| 123 | + */ |
|
| 124 | + public function where(QueryExpression $expression) |
|
| 125 | + { |
|
| 126 | + $this->whereExpression = $expression; |
|
| 127 | + return $this; |
|
| 128 | + } |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * Set an additional group by. |
|
| 132 | + * |
|
| 133 | + * @param string $column |
|
| 134 | + * @return $this |
|
| 135 | + * @see https://en.wikipedia.org/wiki/SQL#Queries |
|
| 136 | + */ |
|
| 137 | + public function groupBy($column) |
|
| 138 | + { |
|
| 139 | + $this->query->groupBy($column); |
|
| 140 | + return $this; |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * Set an additional order condition. |
|
| 145 | + * |
|
| 146 | + * @param string $column |
|
| 147 | + * @param string|null $order |
|
| 148 | + * @return $this |
|
| 149 | + * @see https://en.wikipedia.org/wiki/SQL#Queries |
|
| 150 | + * @see https://en.wikipedia.org/wiki/Order_by |
|
| 151 | + */ |
|
| 152 | + public function orderBy($column, $order = null) |
|
| 153 | + { |
|
| 154 | + $this->query->orderBy($column, $order); |
|
| 155 | + return $this; |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * Set the limit. |
|
| 160 | + * |
|
| 161 | + * @param mixed $limit |
|
| 162 | + * @return $this |
|
| 163 | + */ |
|
| 164 | + public function limit($limit) |
|
| 165 | + { |
|
| 166 | + $this->query->limit($limit); |
|
| 167 | + return $this; |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * Set the offset. |
|
| 172 | + * |
|
| 173 | + * @param mixed $offset |
|
| 174 | + * @return $this |
|
| 175 | + */ |
|
| 176 | + public function offset($offset) |
|
| 177 | + { |
|
| 178 | + $this->query->offset($offset); |
|
| 179 | + return $this; |
|
| 180 | + } |
|
| 181 | 181 | } |
@@ -57,7 +57,7 @@ |
||
| 57 | 57 | } else if (count($clauses) >= 2) |
| 58 | 58 | { |
| 59 | 59 | $rest = array_slice($clauses, 1); |
| 60 | - $this->query->where(Query::And($clauses[0], ...$rest)); |
|
| 60 | + $this->query->where(Query:: And ($clauses[0], ...$rest)); |
|
| 61 | 61 | } |
| 62 | 62 | |
| 63 | 63 | $this->query->select(); |
@@ -18,70 +18,70 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | interface ActiveRecordInterface |
| 20 | 20 | { |
| 21 | - /** |
|
| 22 | - * Returns this active record after creating an entry with the records attributes. |
|
| 23 | - * |
|
| 24 | - * @return $this |
|
| 25 | - * @throws ActiveRecordException on failure. |
|
| 26 | - */ |
|
| 27 | - public function create(); |
|
| 21 | + /** |
|
| 22 | + * Returns this active record after creating an entry with the records attributes. |
|
| 23 | + * |
|
| 24 | + * @return $this |
|
| 25 | + * @throws ActiveRecordException on failure. |
|
| 26 | + */ |
|
| 27 | + public function create(); |
|
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Returns this active record after reading the attributes from the entry with the given identifier. |
|
| 31 | - * |
|
| 32 | - * @param mixed $id |
|
| 33 | - * @return $this |
|
| 34 | - * @throws ActiveRecordException on failure. |
|
| 35 | - */ |
|
| 36 | - public function read($id); |
|
| 29 | + /** |
|
| 30 | + * Returns this active record after reading the attributes from the entry with the given identifier. |
|
| 31 | + * |
|
| 32 | + * @param mixed $id |
|
| 33 | + * @return $this |
|
| 34 | + * @throws ActiveRecordException on failure. |
|
| 35 | + */ |
|
| 36 | + public function read($id); |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Returns this active record after updating the attributes to the corresponding entry. |
|
| 40 | - * |
|
| 41 | - * @return $this |
|
| 42 | - * @throws ActiveRecordException on failure. |
|
| 43 | - */ |
|
| 44 | - public function update(); |
|
| 38 | + /** |
|
| 39 | + * Returns this active record after updating the attributes to the corresponding entry. |
|
| 40 | + * |
|
| 41 | + * @return $this |
|
| 42 | + * @throws ActiveRecordException on failure. |
|
| 43 | + */ |
|
| 44 | + public function update(); |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * Returns this record after deleting the corresponding entry. |
|
| 48 | - * |
|
| 49 | - * @return $this |
|
| 50 | - * @throws ActiveRecordException on failure. |
|
| 51 | - */ |
|
| 52 | - public function delete(); |
|
| 46 | + /** |
|
| 47 | + * Returns this record after deleting the corresponding entry. |
|
| 48 | + * |
|
| 49 | + * @return $this |
|
| 50 | + * @throws ActiveRecordException on failure. |
|
| 51 | + */ |
|
| 52 | + public function delete(); |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Returns this record after synchronizing it with the corresponding entry. |
|
| 56 | - * A new entry is created if this active record does not have a corresponding entry. |
|
| 57 | - * |
|
| 58 | - * @return $this |
|
| 59 | - * @throws ActiveRecordException on failure. |
|
| 60 | - */ |
|
| 61 | - public function sync(); |
|
| 54 | + /** |
|
| 55 | + * Returns this record after synchronizing it with the corresponding entry. |
|
| 56 | + * A new entry is created if this active record does not have a corresponding entry. |
|
| 57 | + * |
|
| 58 | + * @return $this |
|
| 59 | + * @throws ActiveRecordException on failure. |
|
| 60 | + */ |
|
| 61 | + public function sync(); |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Returns true if this active record has a corresponding entry. |
|
| 65 | - * |
|
| 66 | - * @return bool true if this active record has a corresponding entry. |
|
| 67 | - */ |
|
| 68 | - public function exists(); |
|
| 63 | + /** |
|
| 64 | + * Returns true if this active record has a corresponding entry. |
|
| 65 | + * |
|
| 66 | + * @return bool true if this active record has a corresponding entry. |
|
| 67 | + */ |
|
| 68 | + public function exists(); |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Returns this record after filling it with the given attributes. |
|
| 72 | - * |
|
| 73 | - * @param array $attributes = [] |
|
| 74 | - * @return $this |
|
| 75 | - * @throws ActiveRecordException on failure. |
|
| 76 | - */ |
|
| 77 | - public function fill(array $attributes); |
|
| 70 | + /** |
|
| 71 | + * Returns this record after filling it with the given attributes. |
|
| 72 | + * |
|
| 73 | + * @param array $attributes = [] |
|
| 74 | + * @return $this |
|
| 75 | + * @throws ActiveRecordException on failure. |
|
| 76 | + */ |
|
| 77 | + public function fill(array $attributes); |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Returns the records with the given where, order by, limit and offset clauses. |
|
| 81 | - * |
|
| 82 | - * @param array $excludedTraits |
|
| 83 | - * @return ActiveRecordQuery the query representing the current search. |
|
| 84 | - * @throws ActiveRecordException on failure. |
|
| 85 | - */ |
|
| 86 | - public function search(Array $excludedTraits); |
|
| 79 | + /** |
|
| 80 | + * Returns the records with the given where, order by, limit and offset clauses. |
|
| 81 | + * |
|
| 82 | + * @param array $excludedTraits |
|
| 83 | + * @return ActiveRecordQuery the query representing the current search. |
|
| 84 | + * @throws ActiveRecordException on failure. |
|
| 85 | + */ |
|
| 86 | + public function search(Array $excludedTraits); |
|
| 87 | 87 | } |
@@ -18,603 +18,603 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | abstract class AbstractActiveRecord implements ActiveRecordInterface |
| 20 | 20 | { |
| 21 | - const COLUMN_NAME_ID = 'id'; |
|
| 22 | - const COLUMN_TYPE_ID = 'INT UNSIGNED'; |
|
| 23 | - |
|
| 24 | - /** @var \PDO The PDO object. */ |
|
| 25 | - protected $pdo; |
|
| 26 | - |
|
| 27 | - /** @var null|int The ID. */ |
|
| 28 | - private $id; |
|
| 29 | - |
|
| 30 | - /** @var array A map of column name to functions that hook the insert function */ |
|
| 31 | - protected $registeredCreateHooks; |
|
| 32 | - |
|
| 33 | - /** @var array A map of column name to functions that hook the read function */ |
|
| 34 | - protected $registeredReadHooks; |
|
| 35 | - |
|
| 36 | - /** @var array A map of column name to functions that hook the update function */ |
|
| 37 | - protected $registeredUpdateHooks; |
|
| 38 | - |
|
| 39 | - /** @var array A map of column name to functions that hook the update function */ |
|
| 40 | - protected $registeredDeleteHooks; |
|
| 41 | - |
|
| 42 | - /** @var array A map of column name to functions that hook the search function */ |
|
| 43 | - protected $registeredSearchHooks; |
|
| 44 | - |
|
| 45 | - /** @var array A list of table column definitions */ |
|
| 46 | - protected $tableDefinition; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * Construct an abstract active record with the given PDO. |
|
| 50 | - * |
|
| 51 | - * @param \PDO $pdo |
|
| 52 | - */ |
|
| 53 | - public function __construct(\PDO $pdo) |
|
| 54 | - { |
|
| 55 | - $pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC); |
|
| 56 | - $pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION); |
|
| 57 | - |
|
| 58 | - $this->setPdo($pdo); |
|
| 59 | - $this->tableDefinition = $this->getActiveRecordTableDefinition(); |
|
| 60 | - $this->registeredCreateHooks = []; |
|
| 61 | - $this->registeredReadHooks = []; |
|
| 62 | - $this->registeredUpdateHooks = []; |
|
| 63 | - $this->registeredDeleteHooks = []; |
|
| 64 | - $this->registeredSearchHooks = []; |
|
| 65 | - |
|
| 66 | - // Extend table definition with default ID field, throw exception if field already exists |
|
| 67 | - if (array_key_exists('id', $this->tableDefinition)) { |
|
| 68 | - $message = "Table definition in record contains a field with name \"id\""; |
|
| 69 | - $message .= ", which is a reserved name by ActiveRecord"; |
|
| 70 | - throw new ActiveRecordException($message, 0); |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - $this->tableDefinition[self::COLUMN_NAME_ID] = |
|
| 74 | - [ |
|
| 75 | - 'value' => &$this->id, |
|
| 76 | - 'validate' => null, |
|
| 77 | - 'type' => self::COLUMN_TYPE_ID, |
|
| 78 | - 'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE | ColumnProperty::AUTO_INCREMENT | ColumnProperty::PRIMARY_KEY |
|
| 79 | - ]; |
|
| 80 | - } |
|
| 81 | - |
|
| 82 | - private function checkHookConstraints($columnName, $hookMap) |
|
| 83 | - { |
|
| 84 | - // Check whether column exists |
|
| 85 | - if (!array_key_exists($columnName, $this->tableDefinition)) |
|
| 86 | - { |
|
| 87 | - throw new ActiveRecordException("Hook is trying to register on non-existing column \"$columnName\"", 0); |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - // Enforcing 1 hook per table column |
|
| 91 | - if (array_key_exists($columnName, $hookMap)) { |
|
| 92 | - $message = "Hook is trying to register on an already registered column \"$columnName\", "; |
|
| 93 | - $message .= "do you have conflicting traits?"; |
|
| 94 | - throw new ActiveRecordException($message, 0); |
|
| 95 | - } |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Register a new hook for a specific column that gets called before execution of the create() method |
|
| 100 | - * Only one hook per column can be registered at a time |
|
| 101 | - * @param string $columnName The name of the column that is registered. |
|
| 102 | - * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. |
|
| 103 | - */ |
|
| 104 | - public function registerCreateHook($columnName, $fn) |
|
| 105 | - { |
|
| 106 | - $this->checkHookConstraints($columnName, $this->registeredCreateHooks); |
|
| 107 | - |
|
| 108 | - if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 109 | - $this->registeredCreateHooks[$columnName] = [$this, $fn]; |
|
| 110 | - } else if (is_callable($fn)) { |
|
| 111 | - $this->registeredCreateHooks[$columnName] = $fn; |
|
| 112 | - } else { |
|
| 113 | - throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 114 | - } |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * Register a new hook for a specific column that gets called before execution of the read() method |
|
| 119 | - * Only one hook per column can be registered at a time |
|
| 120 | - * @param string $columnName The name of the column that is registered. |
|
| 121 | - * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. |
|
| 122 | - */ |
|
| 123 | - public function registerReadHook($columnName, $fn) |
|
| 124 | - { |
|
| 125 | - $this->checkHookConstraints($columnName, $this->registeredReadHooks); |
|
| 126 | - |
|
| 127 | - if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 128 | - $this->registeredReadHooks[$columnName] = [$this, $fn]; |
|
| 129 | - } else if (is_callable($fn)) { |
|
| 130 | - $this->registeredReadHooks[$columnName] = $fn; |
|
| 131 | - } else { |
|
| 132 | - throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 133 | - } |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Register a new hook for a specific column that gets called before execution of the update() method |
|
| 138 | - * Only one hook per column can be registered at a time |
|
| 139 | - * @param string $columnName The name of the column that is registered. |
|
| 140 | - * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. |
|
| 141 | - */ |
|
| 142 | - public function registerUpdateHook($columnName, $fn) |
|
| 143 | - { |
|
| 144 | - $this->checkHookConstraints($columnName, $this->registeredUpdateHooks); |
|
| 145 | - |
|
| 146 | - if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 147 | - $this->registeredUpdateHooks[$columnName] = [$this, $fn]; |
|
| 148 | - } else if (is_callable($fn)) { |
|
| 149 | - $this->registeredUpdateHooks[$columnName] = $fn; |
|
| 150 | - } else { |
|
| 151 | - throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 152 | - } |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * Register a new hook for a specific column that gets called before execution of the delete() method |
|
| 157 | - * Only one hook per column can be registered at a time |
|
| 158 | - * @param string $columnName The name of the column that is registered. |
|
| 159 | - * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. |
|
| 160 | - */ |
|
| 161 | - public function registerDeleteHook($columnName, $fn) |
|
| 162 | - { |
|
| 163 | - $this->checkHookConstraints($columnName, $this->registeredDeleteHooks); |
|
| 164 | - |
|
| 165 | - if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 166 | - $this->registeredDeleteHooks[$columnName] = [$this, $fn]; |
|
| 167 | - } else if (is_callable($fn)) { |
|
| 168 | - $this->registeredDeleteHooks[$columnName] = $fn; |
|
| 169 | - } else { |
|
| 170 | - throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 171 | - } |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - /** |
|
| 175 | - * Register a new hook for a specific column that gets called before execution of the search() method |
|
| 176 | - * Only one hook per column can be registered at a time |
|
| 177 | - * @param string $columnName The name of the column that is registered. |
|
| 178 | - * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. The callable is required to take one argument: an instance of miBadger\Query\Query; |
|
| 179 | - */ |
|
| 180 | - public function registerSearchHook($columnName, $fn) |
|
| 181 | - { |
|
| 182 | - $this->checkHookConstraints($columnName, $this->registeredSearchHooks); |
|
| 183 | - |
|
| 184 | - if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 185 | - $this->registeredSearchHooks[$columnName] = [$this, $fn]; |
|
| 186 | - } else if (is_callable($fn)) { |
|
| 187 | - $this->registeredSearchHooks[$columnName] = $fn; |
|
| 188 | - } else { |
|
| 189 | - throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 190 | - } |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - /** |
|
| 194 | - * Adds a new column definition to the table. |
|
| 195 | - * @param string $columnName The name of the column that is registered. |
|
| 196 | - * @param Array $definition The definition of that column. |
|
| 197 | - */ |
|
| 198 | - public function extendTableDefinition($columnName, $definition) |
|
| 199 | - { |
|
| 200 | - if ($this->tableDefinition === null) { |
|
| 201 | - throw new ActiveRecordException("tableDefinition is null, most likely due to parent class not having been initialized in constructor"); |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - // Enforcing table can only be extended with new columns |
|
| 205 | - if (array_key_exists($columnName, $this->tableDefinition)) { |
|
| 206 | - $message = "Table is being extended with a column that already exists, "; |
|
| 207 | - $message .= "\"$columnName\" conflicts with your table definition"; |
|
| 208 | - throw new ActiveRecordException($message, 0); |
|
| 209 | - } |
|
| 210 | - |
|
| 211 | - $this->tableDefinition[$columnName] = $definition; |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Returns the type string as it should appear in the mysql create table statement for the given column |
|
| 216 | - * @return string The type string |
|
| 217 | - */ |
|
| 218 | - private function getDatabaseTypeString($colName, $type, $length) |
|
| 219 | - { |
|
| 220 | - switch (strtoupper($type)) { |
|
| 221 | - case '': |
|
| 222 | - throw new ActiveRecordException(sprintf("Column %s has invalid type \"NULL\"", $colName)); |
|
| 21 | + const COLUMN_NAME_ID = 'id'; |
|
| 22 | + const COLUMN_TYPE_ID = 'INT UNSIGNED'; |
|
| 23 | + |
|
| 24 | + /** @var \PDO The PDO object. */ |
|
| 25 | + protected $pdo; |
|
| 26 | + |
|
| 27 | + /** @var null|int The ID. */ |
|
| 28 | + private $id; |
|
| 29 | + |
|
| 30 | + /** @var array A map of column name to functions that hook the insert function */ |
|
| 31 | + protected $registeredCreateHooks; |
|
| 32 | + |
|
| 33 | + /** @var array A map of column name to functions that hook the read function */ |
|
| 34 | + protected $registeredReadHooks; |
|
| 35 | + |
|
| 36 | + /** @var array A map of column name to functions that hook the update function */ |
|
| 37 | + protected $registeredUpdateHooks; |
|
| 38 | + |
|
| 39 | + /** @var array A map of column name to functions that hook the update function */ |
|
| 40 | + protected $registeredDeleteHooks; |
|
| 41 | + |
|
| 42 | + /** @var array A map of column name to functions that hook the search function */ |
|
| 43 | + protected $registeredSearchHooks; |
|
| 44 | + |
|
| 45 | + /** @var array A list of table column definitions */ |
|
| 46 | + protected $tableDefinition; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * Construct an abstract active record with the given PDO. |
|
| 50 | + * |
|
| 51 | + * @param \PDO $pdo |
|
| 52 | + */ |
|
| 53 | + public function __construct(\PDO $pdo) |
|
| 54 | + { |
|
| 55 | + $pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC); |
|
| 56 | + $pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION); |
|
| 57 | + |
|
| 58 | + $this->setPdo($pdo); |
|
| 59 | + $this->tableDefinition = $this->getActiveRecordTableDefinition(); |
|
| 60 | + $this->registeredCreateHooks = []; |
|
| 61 | + $this->registeredReadHooks = []; |
|
| 62 | + $this->registeredUpdateHooks = []; |
|
| 63 | + $this->registeredDeleteHooks = []; |
|
| 64 | + $this->registeredSearchHooks = []; |
|
| 65 | + |
|
| 66 | + // Extend table definition with default ID field, throw exception if field already exists |
|
| 67 | + if (array_key_exists('id', $this->tableDefinition)) { |
|
| 68 | + $message = "Table definition in record contains a field with name \"id\""; |
|
| 69 | + $message .= ", which is a reserved name by ActiveRecord"; |
|
| 70 | + throw new ActiveRecordException($message, 0); |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + $this->tableDefinition[self::COLUMN_NAME_ID] = |
|
| 74 | + [ |
|
| 75 | + 'value' => &$this->id, |
|
| 76 | + 'validate' => null, |
|
| 77 | + 'type' => self::COLUMN_TYPE_ID, |
|
| 78 | + 'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE | ColumnProperty::AUTO_INCREMENT | ColumnProperty::PRIMARY_KEY |
|
| 79 | + ]; |
|
| 80 | + } |
|
| 81 | + |
|
| 82 | + private function checkHookConstraints($columnName, $hookMap) |
|
| 83 | + { |
|
| 84 | + // Check whether column exists |
|
| 85 | + if (!array_key_exists($columnName, $this->tableDefinition)) |
|
| 86 | + { |
|
| 87 | + throw new ActiveRecordException("Hook is trying to register on non-existing column \"$columnName\"", 0); |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + // Enforcing 1 hook per table column |
|
| 91 | + if (array_key_exists($columnName, $hookMap)) { |
|
| 92 | + $message = "Hook is trying to register on an already registered column \"$columnName\", "; |
|
| 93 | + $message .= "do you have conflicting traits?"; |
|
| 94 | + throw new ActiveRecordException($message, 0); |
|
| 95 | + } |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Register a new hook for a specific column that gets called before execution of the create() method |
|
| 100 | + * Only one hook per column can be registered at a time |
|
| 101 | + * @param string $columnName The name of the column that is registered. |
|
| 102 | + * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. |
|
| 103 | + */ |
|
| 104 | + public function registerCreateHook($columnName, $fn) |
|
| 105 | + { |
|
| 106 | + $this->checkHookConstraints($columnName, $this->registeredCreateHooks); |
|
| 107 | + |
|
| 108 | + if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 109 | + $this->registeredCreateHooks[$columnName] = [$this, $fn]; |
|
| 110 | + } else if (is_callable($fn)) { |
|
| 111 | + $this->registeredCreateHooks[$columnName] = $fn; |
|
| 112 | + } else { |
|
| 113 | + throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 114 | + } |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * Register a new hook for a specific column that gets called before execution of the read() method |
|
| 119 | + * Only one hook per column can be registered at a time |
|
| 120 | + * @param string $columnName The name of the column that is registered. |
|
| 121 | + * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. |
|
| 122 | + */ |
|
| 123 | + public function registerReadHook($columnName, $fn) |
|
| 124 | + { |
|
| 125 | + $this->checkHookConstraints($columnName, $this->registeredReadHooks); |
|
| 126 | + |
|
| 127 | + if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 128 | + $this->registeredReadHooks[$columnName] = [$this, $fn]; |
|
| 129 | + } else if (is_callable($fn)) { |
|
| 130 | + $this->registeredReadHooks[$columnName] = $fn; |
|
| 131 | + } else { |
|
| 132 | + throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 133 | + } |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Register a new hook for a specific column that gets called before execution of the update() method |
|
| 138 | + * Only one hook per column can be registered at a time |
|
| 139 | + * @param string $columnName The name of the column that is registered. |
|
| 140 | + * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. |
|
| 141 | + */ |
|
| 142 | + public function registerUpdateHook($columnName, $fn) |
|
| 143 | + { |
|
| 144 | + $this->checkHookConstraints($columnName, $this->registeredUpdateHooks); |
|
| 145 | + |
|
| 146 | + if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 147 | + $this->registeredUpdateHooks[$columnName] = [$this, $fn]; |
|
| 148 | + } else if (is_callable($fn)) { |
|
| 149 | + $this->registeredUpdateHooks[$columnName] = $fn; |
|
| 150 | + } else { |
|
| 151 | + throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 152 | + } |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * Register a new hook for a specific column that gets called before execution of the delete() method |
|
| 157 | + * Only one hook per column can be registered at a time |
|
| 158 | + * @param string $columnName The name of the column that is registered. |
|
| 159 | + * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. |
|
| 160 | + */ |
|
| 161 | + public function registerDeleteHook($columnName, $fn) |
|
| 162 | + { |
|
| 163 | + $this->checkHookConstraints($columnName, $this->registeredDeleteHooks); |
|
| 164 | + |
|
| 165 | + if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 166 | + $this->registeredDeleteHooks[$columnName] = [$this, $fn]; |
|
| 167 | + } else if (is_callable($fn)) { |
|
| 168 | + $this->registeredDeleteHooks[$columnName] = $fn; |
|
| 169 | + } else { |
|
| 170 | + throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 171 | + } |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + /** |
|
| 175 | + * Register a new hook for a specific column that gets called before execution of the search() method |
|
| 176 | + * Only one hook per column can be registered at a time |
|
| 177 | + * @param string $columnName The name of the column that is registered. |
|
| 178 | + * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. The callable is required to take one argument: an instance of miBadger\Query\Query; |
|
| 179 | + */ |
|
| 180 | + public function registerSearchHook($columnName, $fn) |
|
| 181 | + { |
|
| 182 | + $this->checkHookConstraints($columnName, $this->registeredSearchHooks); |
|
| 183 | + |
|
| 184 | + if (is_string($fn) && is_callable([$this, $fn])) { |
|
| 185 | + $this->registeredSearchHooks[$columnName] = [$this, $fn]; |
|
| 186 | + } else if (is_callable($fn)) { |
|
| 187 | + $this->registeredSearchHooks[$columnName] = $fn; |
|
| 188 | + } else { |
|
| 189 | + throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0); |
|
| 190 | + } |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + /** |
|
| 194 | + * Adds a new column definition to the table. |
|
| 195 | + * @param string $columnName The name of the column that is registered. |
|
| 196 | + * @param Array $definition The definition of that column. |
|
| 197 | + */ |
|
| 198 | + public function extendTableDefinition($columnName, $definition) |
|
| 199 | + { |
|
| 200 | + if ($this->tableDefinition === null) { |
|
| 201 | + throw new ActiveRecordException("tableDefinition is null, most likely due to parent class not having been initialized in constructor"); |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + // Enforcing table can only be extended with new columns |
|
| 205 | + if (array_key_exists($columnName, $this->tableDefinition)) { |
|
| 206 | + $message = "Table is being extended with a column that already exists, "; |
|
| 207 | + $message .= "\"$columnName\" conflicts with your table definition"; |
|
| 208 | + throw new ActiveRecordException($message, 0); |
|
| 209 | + } |
|
| 210 | + |
|
| 211 | + $this->tableDefinition[$columnName] = $definition; |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Returns the type string as it should appear in the mysql create table statement for the given column |
|
| 216 | + * @return string The type string |
|
| 217 | + */ |
|
| 218 | + private function getDatabaseTypeString($colName, $type, $length) |
|
| 219 | + { |
|
| 220 | + switch (strtoupper($type)) { |
|
| 221 | + case '': |
|
| 222 | + throw new ActiveRecordException(sprintf("Column %s has invalid type \"NULL\"", $colName)); |
|
| 223 | 223 | |
| 224 | - case 'DATETIME': |
|
| 225 | - case 'DATE': |
|
| 226 | - case 'TIME': |
|
| 227 | - case 'TEXT': |
|
| 228 | - case 'INT UNSIGNED': |
|
| 229 | - return $type; |
|
| 230 | - |
|
| 231 | - case 'VARCHAR': |
|
| 232 | - if ($length === null) { |
|
| 233 | - throw new ActiveRecordException(sprintf("field type %s requires specified column field \"LENGTH\"", $colName)); |
|
| 234 | - } else { |
|
| 235 | - return sprintf('%s(%d)', $type, $length); |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - case 'INT': |
|
| 239 | - case 'TINYINT': |
|
| 240 | - case 'BIGINT': |
|
| 241 | - default: |
|
| 242 | - // @TODO(Default): throw exception, or implicitly assume that type is correct? (For when using SQL databases with different types) |
|
| 243 | - if ($length === null) { |
|
| 244 | - return $type; |
|
| 245 | - } else { |
|
| 246 | - return sprintf('%s(%d)', $type, $length); |
|
| 247 | - } |
|
| 248 | - } |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - /** |
|
| 252 | - * Builds the part of a MySQL create table statement that corresponds to the supplied column |
|
| 253 | - * @param string $colName Name of the database column |
|
| 254 | - * @param string $type The type of the string |
|
| 255 | - * @param int $properties The set of Column properties that apply to this column (See ColumnProperty for options) |
|
| 256 | - * @return string |
|
| 257 | - */ |
|
| 258 | - private function buildCreateTableColumnEntry($colName, $type, $length, $properties, $default) |
|
| 259 | - { |
|
| 260 | - $stmnt = sprintf('`%s` %s ', $colName, $this->getDatabaseTypeString($colName, $type, $length)); |
|
| 261 | - if ($properties & ColumnProperty::NOT_NULL) { |
|
| 262 | - $stmnt .= 'NOT NULL '; |
|
| 263 | - } else { |
|
| 264 | - $stmnt .= 'NULL '; |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - if ($default !== NULL) { |
|
| 268 | - $stmnt .= ' DEFAULT ' . $default . ' '; |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - if ($properties & ColumnProperty::AUTO_INCREMENT) { |
|
| 272 | - $stmnt .= 'AUTO_INCREMENT '; |
|
| 273 | - } |
|
| 274 | - |
|
| 275 | - if ($properties & ColumnProperty::UNIQUE) { |
|
| 276 | - $stmnt .= 'UNIQUE '; |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - if ($properties & ColumnProperty::PRIMARY_KEY) { |
|
| 280 | - $stmnt .= 'PRIMARY KEY '; |
|
| 281 | - } |
|
| 282 | - |
|
| 283 | - return $stmnt; |
|
| 284 | - } |
|
| 285 | - |
|
| 286 | - /** |
|
| 287 | - * Sorts the column statement components in the order such that the id appears first, |
|
| 288 | - * followed by all other columns in alphabetical ascending order |
|
| 289 | - * @param Array $colStatements Array of column statements |
|
| 290 | - * @return Array |
|
| 291 | - */ |
|
| 292 | - private function sortColumnStatements($colStatements) |
|
| 293 | - { |
|
| 294 | - // Find ID statement and put it first |
|
| 295 | - $sortedStatements = []; |
|
| 296 | - |
|
| 297 | - $sortedStatements[] = $colStatements[self::COLUMN_NAME_ID]; |
|
| 298 | - unset($colStatements[self::COLUMN_NAME_ID]); |
|
| 299 | - |
|
| 300 | - // Sort remaining columns in alphabetical order |
|
| 301 | - $columns = array_keys($colStatements); |
|
| 302 | - sort($columns); |
|
| 303 | - foreach ($columns as $colName) { |
|
| 304 | - $sortedStatements[] = $colStatements[$colName]; |
|
| 305 | - } |
|
| 306 | - |
|
| 307 | - return $sortedStatements; |
|
| 308 | - } |
|
| 309 | - |
|
| 310 | - /** |
|
| 311 | - * Builds the MySQL Create Table statement for the internal table definition |
|
| 312 | - * @return string |
|
| 313 | - */ |
|
| 314 | - public function buildCreateTableSQL() |
|
| 315 | - { |
|
| 316 | - $columnStatements = []; |
|
| 317 | - foreach ($this->tableDefinition as $colName => $definition) { |
|
| 318 | - // Destructure column definition |
|
| 319 | - $type = $definition['type'] ?? null; |
|
| 320 | - $default = $definition['default'] ?? null; |
|
| 321 | - $length = $definition['length'] ?? null; |
|
| 322 | - $properties = $definition['properties'] ?? null; |
|
| 323 | - |
|
| 324 | - if (isset($definition['relation']) && $type !== null) { |
|
| 325 | - $msg = "Column \"$colName\": "; |
|
| 326 | - $msg .= "Relationship columns have an automatically inferred type, so type should be omitted"; |
|
| 327 | - throw new ActiveRecordException($msg); |
|
| 328 | - } else if (isset($definition['relation'])) { |
|
| 329 | - $type = self::COLUMN_TYPE_ID; |
|
| 330 | - } |
|
| 331 | - |
|
| 332 | - $columnStatements[$colName] = $this->buildCreateTableColumnEntry($colName, $type, $length, $properties, $default); |
|
| 333 | - } |
|
| 334 | - |
|
| 335 | - // Sort table (first column is id, the remaining are alphabetically sorted) |
|
| 336 | - $columnStatements = $this->sortColumnStatements($columnStatements); |
|
| 337 | - |
|
| 338 | - $sql = 'CREATE TABLE ' . $this->getActiveRecordTable() . ' '; |
|
| 339 | - $sql .= "(\n"; |
|
| 340 | - $sql .= implode(",\n", $columnStatements); |
|
| 341 | - $sql .= "\n);"; |
|
| 342 | - |
|
| 343 | - return $sql; |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - /** |
|
| 347 | - * Creates the entity as a table in the database |
|
| 348 | - */ |
|
| 349 | - public function createTable() |
|
| 350 | - { |
|
| 351 | - $this->pdo->query($this->buildCreateTableSQL()); |
|
| 352 | - } |
|
| 353 | - |
|
| 354 | - /** |
|
| 355 | - * builds a MySQL constraint statement for the given parameters |
|
| 356 | - * @param string $parentTable |
|
| 357 | - * @param string $parentColumn |
|
| 358 | - * @param string $childTable |
|
| 359 | - * @param string $childColumn |
|
| 360 | - * @return string The MySQL table constraint string |
|
| 361 | - */ |
|
| 362 | - protected function buildConstraint($parentTable, $parentColumn, $childTable, $childColumn) |
|
| 363 | - { |
|
| 364 | - $template = <<<SQL |
|
| 224 | + case 'DATETIME': |
|
| 225 | + case 'DATE': |
|
| 226 | + case 'TIME': |
|
| 227 | + case 'TEXT': |
|
| 228 | + case 'INT UNSIGNED': |
|
| 229 | + return $type; |
|
| 230 | + |
|
| 231 | + case 'VARCHAR': |
|
| 232 | + if ($length === null) { |
|
| 233 | + throw new ActiveRecordException(sprintf("field type %s requires specified column field \"LENGTH\"", $colName)); |
|
| 234 | + } else { |
|
| 235 | + return sprintf('%s(%d)', $type, $length); |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + case 'INT': |
|
| 239 | + case 'TINYINT': |
|
| 240 | + case 'BIGINT': |
|
| 241 | + default: |
|
| 242 | + // @TODO(Default): throw exception, or implicitly assume that type is correct? (For when using SQL databases with different types) |
|
| 243 | + if ($length === null) { |
|
| 244 | + return $type; |
|
| 245 | + } else { |
|
| 246 | + return sprintf('%s(%d)', $type, $length); |
|
| 247 | + } |
|
| 248 | + } |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + /** |
|
| 252 | + * Builds the part of a MySQL create table statement that corresponds to the supplied column |
|
| 253 | + * @param string $colName Name of the database column |
|
| 254 | + * @param string $type The type of the string |
|
| 255 | + * @param int $properties The set of Column properties that apply to this column (See ColumnProperty for options) |
|
| 256 | + * @return string |
|
| 257 | + */ |
|
| 258 | + private function buildCreateTableColumnEntry($colName, $type, $length, $properties, $default) |
|
| 259 | + { |
|
| 260 | + $stmnt = sprintf('`%s` %s ', $colName, $this->getDatabaseTypeString($colName, $type, $length)); |
|
| 261 | + if ($properties & ColumnProperty::NOT_NULL) { |
|
| 262 | + $stmnt .= 'NOT NULL '; |
|
| 263 | + } else { |
|
| 264 | + $stmnt .= 'NULL '; |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + if ($default !== NULL) { |
|
| 268 | + $stmnt .= ' DEFAULT ' . $default . ' '; |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + if ($properties & ColumnProperty::AUTO_INCREMENT) { |
|
| 272 | + $stmnt .= 'AUTO_INCREMENT '; |
|
| 273 | + } |
|
| 274 | + |
|
| 275 | + if ($properties & ColumnProperty::UNIQUE) { |
|
| 276 | + $stmnt .= 'UNIQUE '; |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + if ($properties & ColumnProperty::PRIMARY_KEY) { |
|
| 280 | + $stmnt .= 'PRIMARY KEY '; |
|
| 281 | + } |
|
| 282 | + |
|
| 283 | + return $stmnt; |
|
| 284 | + } |
|
| 285 | + |
|
| 286 | + /** |
|
| 287 | + * Sorts the column statement components in the order such that the id appears first, |
|
| 288 | + * followed by all other columns in alphabetical ascending order |
|
| 289 | + * @param Array $colStatements Array of column statements |
|
| 290 | + * @return Array |
|
| 291 | + */ |
|
| 292 | + private function sortColumnStatements($colStatements) |
|
| 293 | + { |
|
| 294 | + // Find ID statement and put it first |
|
| 295 | + $sortedStatements = []; |
|
| 296 | + |
|
| 297 | + $sortedStatements[] = $colStatements[self::COLUMN_NAME_ID]; |
|
| 298 | + unset($colStatements[self::COLUMN_NAME_ID]); |
|
| 299 | + |
|
| 300 | + // Sort remaining columns in alphabetical order |
|
| 301 | + $columns = array_keys($colStatements); |
|
| 302 | + sort($columns); |
|
| 303 | + foreach ($columns as $colName) { |
|
| 304 | + $sortedStatements[] = $colStatements[$colName]; |
|
| 305 | + } |
|
| 306 | + |
|
| 307 | + return $sortedStatements; |
|
| 308 | + } |
|
| 309 | + |
|
| 310 | + /** |
|
| 311 | + * Builds the MySQL Create Table statement for the internal table definition |
|
| 312 | + * @return string |
|
| 313 | + */ |
|
| 314 | + public function buildCreateTableSQL() |
|
| 315 | + { |
|
| 316 | + $columnStatements = []; |
|
| 317 | + foreach ($this->tableDefinition as $colName => $definition) { |
|
| 318 | + // Destructure column definition |
|
| 319 | + $type = $definition['type'] ?? null; |
|
| 320 | + $default = $definition['default'] ?? null; |
|
| 321 | + $length = $definition['length'] ?? null; |
|
| 322 | + $properties = $definition['properties'] ?? null; |
|
| 323 | + |
|
| 324 | + if (isset($definition['relation']) && $type !== null) { |
|
| 325 | + $msg = "Column \"$colName\": "; |
|
| 326 | + $msg .= "Relationship columns have an automatically inferred type, so type should be omitted"; |
|
| 327 | + throw new ActiveRecordException($msg); |
|
| 328 | + } else if (isset($definition['relation'])) { |
|
| 329 | + $type = self::COLUMN_TYPE_ID; |
|
| 330 | + } |
|
| 331 | + |
|
| 332 | + $columnStatements[$colName] = $this->buildCreateTableColumnEntry($colName, $type, $length, $properties, $default); |
|
| 333 | + } |
|
| 334 | + |
|
| 335 | + // Sort table (first column is id, the remaining are alphabetically sorted) |
|
| 336 | + $columnStatements = $this->sortColumnStatements($columnStatements); |
|
| 337 | + |
|
| 338 | + $sql = 'CREATE TABLE ' . $this->getActiveRecordTable() . ' '; |
|
| 339 | + $sql .= "(\n"; |
|
| 340 | + $sql .= implode(",\n", $columnStatements); |
|
| 341 | + $sql .= "\n);"; |
|
| 342 | + |
|
| 343 | + return $sql; |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + /** |
|
| 347 | + * Creates the entity as a table in the database |
|
| 348 | + */ |
|
| 349 | + public function createTable() |
|
| 350 | + { |
|
| 351 | + $this->pdo->query($this->buildCreateTableSQL()); |
|
| 352 | + } |
|
| 353 | + |
|
| 354 | + /** |
|
| 355 | + * builds a MySQL constraint statement for the given parameters |
|
| 356 | + * @param string $parentTable |
|
| 357 | + * @param string $parentColumn |
|
| 358 | + * @param string $childTable |
|
| 359 | + * @param string $childColumn |
|
| 360 | + * @return string The MySQL table constraint string |
|
| 361 | + */ |
|
| 362 | + protected function buildConstraint($parentTable, $parentColumn, $childTable, $childColumn) |
|
| 363 | + { |
|
| 364 | + $template = <<<SQL |
|
| 365 | 365 | ALTER TABLE `%s` |
| 366 | 366 | ADD CONSTRAINT |
| 367 | 367 | FOREIGN KEY (`%s`) |
| 368 | 368 | REFERENCES `%s`(`%s`) |
| 369 | 369 | ON DELETE CASCADE; |
| 370 | 370 | SQL; |
| 371 | - return sprintf($template, $childTable, $childColumn, $parentTable, $parentColumn); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - /** |
|
| 375 | - * Iterates over the specified constraints in the table definition, |
|
| 376 | - * and applies these to the database. |
|
| 377 | - */ |
|
| 378 | - public function createTableConstraints() |
|
| 379 | - { |
|
| 380 | - // Iterate over columns, check whether "relation" field exists, if so create constraint |
|
| 381 | - foreach ($this->tableDefinition as $colName => $definition) { |
|
| 382 | - if (isset($definition['relation']) && $definition['relation'] instanceof AbstractActiveRecord) { |
|
| 383 | - // Forge new relation |
|
| 384 | - $target = $definition['relation']; |
|
| 385 | - $constraintSql = $this->buildConstraint($target->getActiveRecordTable(), 'id', $this->getActiveRecordTable(), $colName); |
|
| 386 | - |
|
| 387 | - $this->pdo->query($constraintSql); |
|
| 388 | - } |
|
| 389 | - } |
|
| 390 | - } |
|
| 391 | - |
|
| 392 | - /** |
|
| 393 | - * Returns the name -> variable mapping for the table definition. |
|
| 394 | - * @return Array The mapping |
|
| 395 | - */ |
|
| 396 | - protected function getActiveRecordColumns() |
|
| 397 | - { |
|
| 398 | - $bindings = []; |
|
| 399 | - foreach ($this->tableDefinition as $colName => $definition) { |
|
| 400 | - |
|
| 401 | - // Ignore the id column (key) when inserting or updating |
|
| 402 | - if ($colName == self::COLUMN_NAME_ID) { |
|
| 403 | - continue; |
|
| 404 | - } |
|
| 405 | - |
|
| 406 | - $bindings[$colName] = &$definition['value']; |
|
| 407 | - } |
|
| 408 | - return $bindings; |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - /** |
|
| 412 | - * {@inheritdoc} |
|
| 413 | - */ |
|
| 414 | - public function create() |
|
| 415 | - { |
|
| 416 | - foreach ($this->registeredCreateHooks as $colName => $fn) { |
|
| 417 | - // @TODO: Would it be better to pass the Query to the function? |
|
| 418 | - $fn(); |
|
| 419 | - } |
|
| 420 | - |
|
| 421 | - try { |
|
| 422 | - (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 423 | - ->insert($this->getActiveRecordColumns()) |
|
| 424 | - ->execute(); |
|
| 425 | - |
|
| 426 | - $this->setId(intval($this->getPdo()->lastInsertId())); |
|
| 427 | - } catch (\PDOException $e) { |
|
| 428 | - throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 429 | - } |
|
| 430 | - |
|
| 431 | - return $this; |
|
| 432 | - } |
|
| 433 | - |
|
| 434 | - /** |
|
| 435 | - * {@inheritdoc} |
|
| 436 | - */ |
|
| 437 | - public function read($id) |
|
| 438 | - { |
|
| 439 | - foreach ($this->registeredReadHooks as $colName => $fn) { |
|
| 440 | - // @TODO: Would it be better to pass the Query to the function? |
|
| 441 | - $fn(); |
|
| 442 | - } |
|
| 443 | - |
|
| 444 | - try { |
|
| 445 | - $row = (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 446 | - ->select() |
|
| 447 | - ->where(Query::Equal('id', $id)) |
|
| 448 | - ->execute() |
|
| 449 | - ->fetch(); |
|
| 450 | - |
|
| 451 | - if ($row === false) { |
|
| 452 | - throw new ActiveRecordException(sprintf('Can not read the non-existent active record entry %d from the `%s` table.', $id, $this->getActiveRecordTable())); |
|
| 453 | - } |
|
| 454 | - |
|
| 455 | - $this->fill($row)->setId($id); |
|
| 456 | - } catch (\PDOException $e) { |
|
| 457 | - throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 458 | - } |
|
| 459 | - |
|
| 460 | - return $this; |
|
| 461 | - } |
|
| 462 | - |
|
| 463 | - /** |
|
| 464 | - * {@inheritdoc} |
|
| 465 | - */ |
|
| 466 | - public function update() |
|
| 467 | - { |
|
| 468 | - foreach ($this->registeredUpdateHooks as $colName => $fn) { |
|
| 469 | - // @TODO: Would it be better to pass the Query to the function? |
|
| 470 | - $fn(); |
|
| 471 | - } |
|
| 472 | - |
|
| 473 | - try { |
|
| 474 | - (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 475 | - ->update($this->getActiveRecordColumns()) |
|
| 476 | - ->where(Query::Equal('id', $this->getId())) |
|
| 477 | - ->execute(); |
|
| 478 | - } catch (\PDOException $e) { |
|
| 479 | - throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 480 | - } |
|
| 481 | - |
|
| 482 | - return $this; |
|
| 483 | - } |
|
| 484 | - |
|
| 485 | - /** |
|
| 486 | - * {@inheritdoc} |
|
| 487 | - */ |
|
| 488 | - public function delete() |
|
| 489 | - { |
|
| 490 | - foreach ($this->registeredDeleteHooks as $colName => $fn) { |
|
| 491 | - // @TODO: Would it be better to pass the Query to the function? |
|
| 492 | - $fn(); |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - try { |
|
| 496 | - (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 497 | - ->delete() |
|
| 498 | - ->where(Query::Equal('id', $this->getId())) |
|
| 499 | - ->execute(); |
|
| 500 | - |
|
| 501 | - $this->setId(null); |
|
| 502 | - } catch (\PDOException $e) { |
|
| 503 | - throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - return $this; |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - /** |
|
| 510 | - * {@inheritdoc} |
|
| 511 | - */ |
|
| 512 | - public function sync() |
|
| 513 | - { |
|
| 514 | - if (!$this->exists()) { |
|
| 515 | - return $this->create(); |
|
| 516 | - } |
|
| 517 | - |
|
| 518 | - return $this->update(); |
|
| 519 | - } |
|
| 520 | - |
|
| 521 | - /** |
|
| 522 | - * {@inheritdoc} |
|
| 523 | - */ |
|
| 524 | - public function exists() |
|
| 525 | - { |
|
| 526 | - return $this->getId() !== null; |
|
| 527 | - } |
|
| 528 | - |
|
| 529 | - /** |
|
| 530 | - * {@inheritdoc} |
|
| 531 | - */ |
|
| 532 | - public function fill(array $attributes) |
|
| 533 | - { |
|
| 534 | - $columns = $this->getActiveRecordColumns(); |
|
| 535 | - $columns['id'] = &$this->id; |
|
| 536 | - |
|
| 537 | - foreach ($attributes as $key => $value) { |
|
| 538 | - if (array_key_exists($key, $columns)) { |
|
| 539 | - $columns[$key] = $value; |
|
| 540 | - } |
|
| 541 | - } |
|
| 542 | - |
|
| 543 | - return $this; |
|
| 544 | - } |
|
| 545 | - |
|
| 546 | - /** |
|
| 547 | - * {@inheritdoc} |
|
| 548 | - */ |
|
| 549 | - public function search(array $ignoredTraits = []) |
|
| 550 | - { |
|
| 551 | - $clauses = []; |
|
| 552 | - foreach ($this->registeredSearchHooks as $column => $fn) { |
|
| 553 | - if (!in_array($column, $ignoredTraits)) { |
|
| 554 | - $clauses[] = $fn(); |
|
| 555 | - } |
|
| 556 | - } |
|
| 557 | - |
|
| 558 | - return new ActiveRecordQuery($this, $this->getActiveRecordTable(), $clauses); |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - /** |
|
| 562 | - * Returns the PDO. |
|
| 563 | - * |
|
| 564 | - * @return \PDO the PDO. |
|
| 565 | - */ |
|
| 566 | - public function getPdo() |
|
| 567 | - { |
|
| 568 | - return $this->pdo; |
|
| 569 | - } |
|
| 570 | - |
|
| 571 | - /** |
|
| 572 | - * Set the PDO. |
|
| 573 | - * |
|
| 574 | - * @param \PDO $pdo |
|
| 575 | - * @return $this |
|
| 576 | - */ |
|
| 577 | - protected function setPdo($pdo) |
|
| 578 | - { |
|
| 579 | - $this->pdo = $pdo; |
|
| 580 | - |
|
| 581 | - return $this; |
|
| 582 | - } |
|
| 583 | - |
|
| 584 | - /** |
|
| 585 | - * Returns the ID. |
|
| 586 | - * |
|
| 587 | - * @return null|int The ID. |
|
| 588 | - */ |
|
| 589 | - public function getId() |
|
| 590 | - { |
|
| 591 | - return $this->id; |
|
| 592 | - } |
|
| 593 | - |
|
| 594 | - /** |
|
| 595 | - * Set the ID. |
|
| 596 | - * |
|
| 597 | - * @param int $id |
|
| 598 | - * @return $this |
|
| 599 | - */ |
|
| 600 | - protected function setId($id) |
|
| 601 | - { |
|
| 602 | - $this->id = $id; |
|
| 603 | - |
|
| 604 | - return $this; |
|
| 605 | - } |
|
| 606 | - |
|
| 607 | - /** |
|
| 608 | - * Returns the active record table. |
|
| 609 | - * |
|
| 610 | - * @return string the active record table name. |
|
| 611 | - */ |
|
| 612 | - abstract protected function getActiveRecordTable(); |
|
| 613 | - |
|
| 614 | - /** |
|
| 615 | - * Returns the active record columns. |
|
| 616 | - * |
|
| 617 | - * @return array the active record columns. |
|
| 618 | - */ |
|
| 619 | - abstract protected function getActiveRecordTableDefinition(); |
|
| 371 | + return sprintf($template, $childTable, $childColumn, $parentTable, $parentColumn); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + /** |
|
| 375 | + * Iterates over the specified constraints in the table definition, |
|
| 376 | + * and applies these to the database. |
|
| 377 | + */ |
|
| 378 | + public function createTableConstraints() |
|
| 379 | + { |
|
| 380 | + // Iterate over columns, check whether "relation" field exists, if so create constraint |
|
| 381 | + foreach ($this->tableDefinition as $colName => $definition) { |
|
| 382 | + if (isset($definition['relation']) && $definition['relation'] instanceof AbstractActiveRecord) { |
|
| 383 | + // Forge new relation |
|
| 384 | + $target = $definition['relation']; |
|
| 385 | + $constraintSql = $this->buildConstraint($target->getActiveRecordTable(), 'id', $this->getActiveRecordTable(), $colName); |
|
| 386 | + |
|
| 387 | + $this->pdo->query($constraintSql); |
|
| 388 | + } |
|
| 389 | + } |
|
| 390 | + } |
|
| 391 | + |
|
| 392 | + /** |
|
| 393 | + * Returns the name -> variable mapping for the table definition. |
|
| 394 | + * @return Array The mapping |
|
| 395 | + */ |
|
| 396 | + protected function getActiveRecordColumns() |
|
| 397 | + { |
|
| 398 | + $bindings = []; |
|
| 399 | + foreach ($this->tableDefinition as $colName => $definition) { |
|
| 400 | + |
|
| 401 | + // Ignore the id column (key) when inserting or updating |
|
| 402 | + if ($colName == self::COLUMN_NAME_ID) { |
|
| 403 | + continue; |
|
| 404 | + } |
|
| 405 | + |
|
| 406 | + $bindings[$colName] = &$definition['value']; |
|
| 407 | + } |
|
| 408 | + return $bindings; |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + /** |
|
| 412 | + * {@inheritdoc} |
|
| 413 | + */ |
|
| 414 | + public function create() |
|
| 415 | + { |
|
| 416 | + foreach ($this->registeredCreateHooks as $colName => $fn) { |
|
| 417 | + // @TODO: Would it be better to pass the Query to the function? |
|
| 418 | + $fn(); |
|
| 419 | + } |
|
| 420 | + |
|
| 421 | + try { |
|
| 422 | + (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 423 | + ->insert($this->getActiveRecordColumns()) |
|
| 424 | + ->execute(); |
|
| 425 | + |
|
| 426 | + $this->setId(intval($this->getPdo()->lastInsertId())); |
|
| 427 | + } catch (\PDOException $e) { |
|
| 428 | + throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 429 | + } |
|
| 430 | + |
|
| 431 | + return $this; |
|
| 432 | + } |
|
| 433 | + |
|
| 434 | + /** |
|
| 435 | + * {@inheritdoc} |
|
| 436 | + */ |
|
| 437 | + public function read($id) |
|
| 438 | + { |
|
| 439 | + foreach ($this->registeredReadHooks as $colName => $fn) { |
|
| 440 | + // @TODO: Would it be better to pass the Query to the function? |
|
| 441 | + $fn(); |
|
| 442 | + } |
|
| 443 | + |
|
| 444 | + try { |
|
| 445 | + $row = (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 446 | + ->select() |
|
| 447 | + ->where(Query::Equal('id', $id)) |
|
| 448 | + ->execute() |
|
| 449 | + ->fetch(); |
|
| 450 | + |
|
| 451 | + if ($row === false) { |
|
| 452 | + throw new ActiveRecordException(sprintf('Can not read the non-existent active record entry %d from the `%s` table.', $id, $this->getActiveRecordTable())); |
|
| 453 | + } |
|
| 454 | + |
|
| 455 | + $this->fill($row)->setId($id); |
|
| 456 | + } catch (\PDOException $e) { |
|
| 457 | + throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 458 | + } |
|
| 459 | + |
|
| 460 | + return $this; |
|
| 461 | + } |
|
| 462 | + |
|
| 463 | + /** |
|
| 464 | + * {@inheritdoc} |
|
| 465 | + */ |
|
| 466 | + public function update() |
|
| 467 | + { |
|
| 468 | + foreach ($this->registeredUpdateHooks as $colName => $fn) { |
|
| 469 | + // @TODO: Would it be better to pass the Query to the function? |
|
| 470 | + $fn(); |
|
| 471 | + } |
|
| 472 | + |
|
| 473 | + try { |
|
| 474 | + (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 475 | + ->update($this->getActiveRecordColumns()) |
|
| 476 | + ->where(Query::Equal('id', $this->getId())) |
|
| 477 | + ->execute(); |
|
| 478 | + } catch (\PDOException $e) { |
|
| 479 | + throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 480 | + } |
|
| 481 | + |
|
| 482 | + return $this; |
|
| 483 | + } |
|
| 484 | + |
|
| 485 | + /** |
|
| 486 | + * {@inheritdoc} |
|
| 487 | + */ |
|
| 488 | + public function delete() |
|
| 489 | + { |
|
| 490 | + foreach ($this->registeredDeleteHooks as $colName => $fn) { |
|
| 491 | + // @TODO: Would it be better to pass the Query to the function? |
|
| 492 | + $fn(); |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + try { |
|
| 496 | + (new Query($this->getPdo(), $this->getActiveRecordTable())) |
|
| 497 | + ->delete() |
|
| 498 | + ->where(Query::Equal('id', $this->getId())) |
|
| 499 | + ->execute(); |
|
| 500 | + |
|
| 501 | + $this->setId(null); |
|
| 502 | + } catch (\PDOException $e) { |
|
| 503 | + throw new ActiveRecordException($e->getMessage(), 0, $e); |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + return $this; |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + /** |
|
| 510 | + * {@inheritdoc} |
|
| 511 | + */ |
|
| 512 | + public function sync() |
|
| 513 | + { |
|
| 514 | + if (!$this->exists()) { |
|
| 515 | + return $this->create(); |
|
| 516 | + } |
|
| 517 | + |
|
| 518 | + return $this->update(); |
|
| 519 | + } |
|
| 520 | + |
|
| 521 | + /** |
|
| 522 | + * {@inheritdoc} |
|
| 523 | + */ |
|
| 524 | + public function exists() |
|
| 525 | + { |
|
| 526 | + return $this->getId() !== null; |
|
| 527 | + } |
|
| 528 | + |
|
| 529 | + /** |
|
| 530 | + * {@inheritdoc} |
|
| 531 | + */ |
|
| 532 | + public function fill(array $attributes) |
|
| 533 | + { |
|
| 534 | + $columns = $this->getActiveRecordColumns(); |
|
| 535 | + $columns['id'] = &$this->id; |
|
| 536 | + |
|
| 537 | + foreach ($attributes as $key => $value) { |
|
| 538 | + if (array_key_exists($key, $columns)) { |
|
| 539 | + $columns[$key] = $value; |
|
| 540 | + } |
|
| 541 | + } |
|
| 542 | + |
|
| 543 | + return $this; |
|
| 544 | + } |
|
| 545 | + |
|
| 546 | + /** |
|
| 547 | + * {@inheritdoc} |
|
| 548 | + */ |
|
| 549 | + public function search(array $ignoredTraits = []) |
|
| 550 | + { |
|
| 551 | + $clauses = []; |
|
| 552 | + foreach ($this->registeredSearchHooks as $column => $fn) { |
|
| 553 | + if (!in_array($column, $ignoredTraits)) { |
|
| 554 | + $clauses[] = $fn(); |
|
| 555 | + } |
|
| 556 | + } |
|
| 557 | + |
|
| 558 | + return new ActiveRecordQuery($this, $this->getActiveRecordTable(), $clauses); |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + /** |
|
| 562 | + * Returns the PDO. |
|
| 563 | + * |
|
| 564 | + * @return \PDO the PDO. |
|
| 565 | + */ |
|
| 566 | + public function getPdo() |
|
| 567 | + { |
|
| 568 | + return $this->pdo; |
|
| 569 | + } |
|
| 570 | + |
|
| 571 | + /** |
|
| 572 | + * Set the PDO. |
|
| 573 | + * |
|
| 574 | + * @param \PDO $pdo |
|
| 575 | + * @return $this |
|
| 576 | + */ |
|
| 577 | + protected function setPdo($pdo) |
|
| 578 | + { |
|
| 579 | + $this->pdo = $pdo; |
|
| 580 | + |
|
| 581 | + return $this; |
|
| 582 | + } |
|
| 583 | + |
|
| 584 | + /** |
|
| 585 | + * Returns the ID. |
|
| 586 | + * |
|
| 587 | + * @return null|int The ID. |
|
| 588 | + */ |
|
| 589 | + public function getId() |
|
| 590 | + { |
|
| 591 | + return $this->id; |
|
| 592 | + } |
|
| 593 | + |
|
| 594 | + /** |
|
| 595 | + * Set the ID. |
|
| 596 | + * |
|
| 597 | + * @param int $id |
|
| 598 | + * @return $this |
|
| 599 | + */ |
|
| 600 | + protected function setId($id) |
|
| 601 | + { |
|
| 602 | + $this->id = $id; |
|
| 603 | + |
|
| 604 | + return $this; |
|
| 605 | + } |
|
| 606 | + |
|
| 607 | + /** |
|
| 608 | + * Returns the active record table. |
|
| 609 | + * |
|
| 610 | + * @return string the active record table name. |
|
| 611 | + */ |
|
| 612 | + abstract protected function getActiveRecordTable(); |
|
| 613 | + |
|
| 614 | + /** |
|
| 615 | + * Returns the active record columns. |
|
| 616 | + * |
|
| 617 | + * @return array the active record columns. |
|
| 618 | + */ |
|
| 619 | + abstract protected function getActiveRecordTableDefinition(); |
|
| 620 | 620 | } |