o2system /
database
| Total Complexity | 69 |
| Total Lines | 523 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Row often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Row, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 29 | class Row implements |
||
| 30 | \IteratorAggregate, |
||
| 31 | \ArrayAccess, |
||
| 32 | \Countable, |
||
| 33 | \Serializable, |
||
| 34 | \JsonSerializable |
||
| 35 | {
|
||
| 36 | use ArrayConversionTrait; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Row::$columns |
||
| 40 | * |
||
| 41 | * List of result row fields |
||
| 42 | * |
||
| 43 | * @access protected |
||
| 44 | * @type array |
||
| 45 | */ |
||
| 46 | protected $columns = []; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Row::$record |
||
| 50 | * |
||
| 51 | * @var Record |
||
| 52 | */ |
||
| 53 | protected $record; |
||
| 54 | |||
| 55 | // ------------------------------------------------------------------------ |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Row::__construct |
||
| 59 | * |
||
| 60 | * @param array $columns |
||
| 61 | */ |
||
| 62 | public function __construct(array $columns = []) |
||
| 63 | {
|
||
| 64 | $this->record = new Record(); |
||
| 65 | |||
| 66 | foreach ($columns as $name => $value) {
|
||
| 67 | if (strpos($name, 'record_create') !== false) {
|
||
| 68 | $this->record->create->offsetSet( |
||
|
Bug
Best Practice
introduced
by
|
|||
| 69 | str_replace('record_create_', '', $name),
|
||
| 70 | $value |
||
| 71 | ); |
||
| 72 | unset($columns[ $name ]); |
||
| 73 | } elseif (strpos($name, 'record_update') !== false) {
|
||
| 74 | $this->record->create->offsetSet( |
||
| 75 | str_replace('record_update_', '', $name),
|
||
| 76 | $value |
||
| 77 | ); |
||
| 78 | unset($columns[ $name ]); |
||
| 79 | } elseif (strpos($name, 'record') !== false) {
|
||
| 80 | $this->record->offsetSet( |
||
| 81 | str_replace('record_', '', $name),
|
||
| 82 | $value |
||
| 83 | ); |
||
| 84 | unset($columns[ $name ]); |
||
| 85 | } |
||
| 86 | } |
||
| 87 | |||
| 88 | $this->columns = $columns; |
||
| 89 | } |
||
| 90 | |||
| 91 | // ------------------------------------------------------------------------ |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Row::count |
||
| 95 | * |
||
| 96 | * Num of row fields |
||
| 97 | * |
||
| 98 | * @return int |
||
| 99 | */ |
||
| 100 | public function count() |
||
| 101 | {
|
||
| 102 | return count($this->columns); |
||
| 103 | } |
||
| 104 | |||
| 105 | // ------------------------------------------------------------------------ |
||
| 106 | |||
| 107 | /** |
||
| 108 | * Row::getFields |
||
| 109 | * |
||
| 110 | * Return row fields |
||
| 111 | * |
||
| 112 | * @return array |
||
| 113 | */ |
||
| 114 | public function getColumns() |
||
| 115 | {
|
||
| 116 | return array_keys($this->columns); |
||
| 117 | } |
||
| 118 | |||
| 119 | // ------------------------------------------------------------------------ |
||
| 120 | |||
| 121 | /** |
||
| 122 | * Row::fetchFieldsInto |
||
| 123 | * |
||
| 124 | * @param string $className Name of the created class.. |
||
| 125 | * @param array $classArgs Arguments to be passed into created class constructor. |
||
| 126 | * |
||
| 127 | * @return object |
||
| 128 | * @throws \O2System\Spl\Exceptions\Logic\InvalidArgumentException |
||
| 129 | * @throws \ReflectionException |
||
| 130 | */ |
||
| 131 | public function fetchFieldsInto($className, array $classArgs = []) |
||
| 170 | } |
||
| 171 | |||
| 172 | // ------------------------------------------------------------------------ |
||
| 173 | |||
| 174 | /** |
||
| 175 | * Row::isJSON |
||
| 176 | * |
||
| 177 | * Checks if field value is JSON format. |
||
| 178 | * |
||
| 179 | * @param string $string |
||
| 180 | * |
||
| 181 | * @return bool |
||
| 182 | */ |
||
| 183 | protected function isJSON($string) |
||
| 184 | {
|
||
| 185 | // make sure provided input is of type string |
||
| 186 | if ( ! is_string($string)) {
|
||
| 187 | return false; |
||
| 188 | } |
||
| 189 | |||
| 190 | // trim white spaces |
||
| 191 | $string = trim($string); |
||
| 192 | |||
| 193 | // get first character |
||
| 194 | $first_char = substr($string, 0, 1); |
||
| 195 | |||
| 196 | // get last character |
||
| 197 | $last_char = substr($string, -1); |
||
| 198 | |||
| 199 | // check if there is a first and last character |
||
| 200 | if ( ! $first_char || ! $last_char) {
|
||
| 201 | return false; |
||
| 202 | } |
||
| 203 | |||
| 204 | // make sure first character is either { or [
|
||
| 205 | if ($first_char !== '{' && $first_char !== '[') {
|
||
| 206 | return false; |
||
| 207 | } |
||
| 208 | |||
| 209 | // make sure last character is either } or ] |
||
| 210 | if ($last_char !== '}' && $last_char !== ']') {
|
||
| 211 | return false; |
||
| 212 | } |
||
| 213 | |||
| 214 | // let's leave the rest to PHP. |
||
| 215 | // try to decode string |
||
| 216 | json_decode($string); |
||
| 217 | |||
| 218 | // check if error occurred |
||
| 219 | if (json_last_error() === JSON_ERROR_NONE) {
|
||
| 220 | return true; |
||
| 221 | } |
||
| 222 | |||
| 223 | return false; |
||
| 224 | } |
||
| 225 | |||
| 226 | // ------------------------------------------------------------------------ |
||
| 227 | |||
| 228 | /** |
||
| 229 | * Row::isSerialized |
||
| 230 | * |
||
| 231 | * Checks if field value is PHP serialize format. |
||
| 232 | * |
||
| 233 | * @param $string |
||
| 234 | * |
||
| 235 | * @return bool |
||
| 236 | */ |
||
| 237 | protected function isSerialized($string) |
||
| 238 | {
|
||
| 239 | // if it isn't a string, it isn't serialized |
||
| 240 | if ( ! is_string($string)) {
|
||
| 241 | return false; |
||
| 242 | } |
||
| 243 | $string = trim($string); |
||
| 244 | if ('N;' == $string) {
|
||
| 245 | return true; |
||
| 246 | } |
||
| 247 | if ( ! preg_match('/^([adObis]):/', $string, $matches)) {
|
||
| 248 | return false; |
||
| 249 | } |
||
| 250 | switch ($matches[ 1 ]) {
|
||
| 251 | case 'a' : |
||
| 252 | case 'O' : |
||
| 253 | case 's' : |
||
| 254 | if (preg_match("/^{$matches[1]}:[0-9]+:.*[;}]\$/s", $string)) {
|
||
| 255 | return true; |
||
| 256 | } |
||
| 257 | break; |
||
| 258 | case 'b' : |
||
| 259 | case 'i' : |
||
| 260 | case 'd' : |
||
| 261 | if (preg_match("/^{$matches[1]}:[0-9.E-]+;\$/", $string)) {
|
||
| 262 | return true; |
||
| 263 | } |
||
| 264 | break; |
||
| 265 | } |
||
| 266 | |||
| 267 | return false; |
||
| 268 | } |
||
| 269 | |||
| 270 | // ------------------------------------------------------------------------ |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Row::getArrayCopy |
||
| 274 | * |
||
| 275 | * Gets array fields copy. |
||
| 276 | * |
||
| 277 | * @return array |
||
| 278 | */ |
||
| 279 | public function getArrayCopy() |
||
| 280 | {
|
||
| 281 | $fields = $this->columns; |
||
| 282 | |||
| 283 | foreach ($fields as $fieldName => $fieldValue) {
|
||
| 284 | if ($this->isJSON($fieldValue)) {
|
||
| 285 | $fields[ $fieldName ] = new Row\Columns\DataJSON(json_decode($fieldValue, true)); |
||
| 286 | } elseif ($this->isSerialized($fieldValue)) {
|
||
| 287 | $fields[ $fieldName ] = new Row\Columns\DataSerialize(unserialize($fieldValue)); |
||
| 288 | } else {
|
||
| 289 | $fields[ $fieldName ] = $fieldValue; |
||
| 290 | } |
||
| 291 | } |
||
| 292 | |||
| 293 | return $fields; |
||
| 294 | } |
||
| 295 | |||
| 296 | // ------------------------------------------------------------------------ |
||
| 297 | |||
| 298 | /** |
||
| 299 | * Row::getValues |
||
| 300 | * |
||
| 301 | * Return row fields values. |
||
| 302 | * |
||
| 303 | * @return array |
||
| 304 | */ |
||
| 305 | public function getValues() |
||
| 306 | {
|
||
| 307 | return array_values($this->columns); |
||
| 308 | } |
||
| 309 | |||
| 310 | // ------------------------------------------------------------------------ |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Row::__get |
||
| 314 | * |
||
| 315 | * Route magic method __get into offsetGet method. |
||
| 316 | * |
||
| 317 | * @param string $field Field name. |
||
| 318 | * |
||
| 319 | * @return mixed|null |
||
| 320 | */ |
||
| 321 | public function __get($field) |
||
| 322 | {
|
||
| 323 | return $this->offsetGet($field); |
||
| 324 | } |
||
| 325 | |||
| 326 | // ------------------------------------------------------------------------ |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Row::__set |
||
| 330 | * |
||
| 331 | * Route magic method __set into offsetSet method. |
||
| 332 | * |
||
| 333 | * @param string $field Input name |
||
| 334 | * @param mixed $value Input value |
||
| 335 | */ |
||
| 336 | public function __set($field, $value) |
||
| 337 | {
|
||
| 338 | $this->offsetSet($field, $value); |
||
| 339 | } |
||
| 340 | |||
| 341 | // ------------------------------------------------------------------------ |
||
| 342 | |||
| 343 | /** |
||
| 344 | * Row::offsetGet |
||
| 345 | * |
||
| 346 | * Offset to retrieve |
||
| 347 | * |
||
| 348 | * @link http://php.net/manual/en/arrayaccess.offsetget.php |
||
| 349 | * |
||
| 350 | * @param mixed $offset <p> |
||
| 351 | * The offset to retrieve. |
||
| 352 | * </p> |
||
| 353 | * |
||
| 354 | * @return mixed Can return all value types. |
||
| 355 | * @since 5.0.0 |
||
| 356 | */ |
||
| 357 | public function offsetGet($offset) |
||
| 358 | {
|
||
| 359 | if (isset($this->columns[ $offset ])) {
|
||
| 360 | |||
| 361 | $data = $this->columns[ $offset ]; |
||
| 362 | |||
| 363 | if ($this->isJSON($data)) {
|
||
| 364 | return new Row\Columns\DataJSON(json_decode($data, true)); |
||
| 365 | } elseif ($this->isSerialized($data)) {
|
||
| 366 | return new Row\Columns\DataSerialize(unserialize($data)); |
||
| 367 | } else {
|
||
| 368 | return $data; |
||
| 369 | } |
||
| 370 | } elseif(strpos($offset, 'record') !== false) {
|
||
| 371 | switch ($offset) {
|
||
| 372 | case 'record': |
||
| 373 | return $this->record; |
||
| 374 | break; |
||
| 375 | case 'record_status': |
||
| 376 | return $this->record->status; |
||
| 377 | break; |
||
| 378 | case 'record_left': |
||
| 379 | return $this->record->left; |
||
| 380 | break; |
||
| 381 | case 'record_right': |
||
| 382 | return $this->record->right; |
||
| 383 | break; |
||
| 384 | case 'record_depth': |
||
| 385 | return $this->record->depth; |
||
| 386 | break; |
||
| 387 | case 'record_ordering': |
||
| 388 | return $this->record->ordering; |
||
| 389 | break; |
||
| 390 | case 'record_create_user': |
||
| 391 | return $this->record->create->user; |
||
| 392 | break; |
||
| 393 | case 'record_create_timestamp': |
||
| 394 | return $this->record->create->timestamp; |
||
| 395 | break; |
||
| 396 | case 'record_update_user': |
||
| 397 | return $this->record->update->user; |
||
| 398 | break; |
||
| 399 | case 'record_update_timestamp': |
||
| 400 | return $this->record->update->timestamp; |
||
| 401 | break; |
||
| 402 | } |
||
| 403 | } |
||
| 404 | |||
| 405 | return null; |
||
| 406 | } |
||
| 407 | |||
| 408 | // ------------------------------------------------------------------------ |
||
| 409 | |||
| 410 | /** |
||
| 411 | * Row::getRecord |
||
| 412 | * |
||
| 413 | * @return \O2System\Database\DataObjects\Result\Row\Record |
||
| 414 | */ |
||
| 415 | public function getRecord() |
||
| 416 | {
|
||
| 417 | return $this->record; |
||
| 418 | } |
||
| 419 | |||
| 420 | // ------------------------------------------------------------------------ |
||
| 421 | |||
| 422 | /** |
||
| 423 | * Row::offsetSet |
||
| 424 | * |
||
| 425 | * Offset to set |
||
| 426 | * |
||
| 427 | * @link http://php.net/manual/en/arrayaccess.offsetset.php |
||
| 428 | * |
||
| 429 | * @param mixed $offset <p> |
||
| 430 | * The offset to assign the value to. |
||
| 431 | * </p> |
||
| 432 | * @param mixed $value <p> |
||
| 433 | * The value to set. |
||
| 434 | * </p> |
||
| 435 | * |
||
| 436 | * @return void |
||
| 437 | * @since 5.0.0 |
||
| 438 | */ |
||
| 439 | public function offsetSet($offset, $value) |
||
| 440 | {
|
||
| 441 | $this->columns[ $offset ] = $value; |
||
| 442 | } |
||
| 443 | |||
| 444 | // ------------------------------------------------------------------------ |
||
| 445 | |||
| 446 | /** |
||
| 447 | * Row::getIterator |
||
| 448 | * |
||
| 449 | * Retrieve an external iterator |
||
| 450 | * |
||
| 451 | * @link http://php.net/manual/en/iteratoraggregate.getiterator.php |
||
| 452 | * @return Traversable An instance of an object implementing <b>Iterator</b> or |
||
| 453 | * <b>Traversable</b> |
||
| 454 | * @since 5.0.0 |
||
| 455 | */ |
||
| 456 | public function getIterator() |
||
| 457 | {
|
||
| 458 | return new ArrayIterator($this->columns); |
||
| 459 | } |
||
| 460 | |||
| 461 | // ------------------------------------------------------------------------ |
||
| 462 | |||
| 463 | /** |
||
| 464 | * Row::offsetExists |
||
| 465 | * |
||
| 466 | * Whether a offset exists |
||
| 467 | * |
||
| 468 | * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
||
| 469 | * |
||
| 470 | * @param mixed $offset <p> |
||
| 471 | * An offset to check for. |
||
| 472 | * </p> |
||
| 473 | * |
||
| 474 | * @return boolean true on success or false on failure. |
||
| 475 | * </p> |
||
| 476 | * <p> |
||
| 477 | * The return value will be casted to boolean if non-boolean was returned. |
||
| 478 | * @since 5.0.0 |
||
| 479 | */ |
||
| 480 | public function offsetExists($offset) |
||
| 483 | } |
||
| 484 | |||
| 485 | // ------------------------------------------------------------------------ |
||
| 486 | |||
| 487 | /** |
||
| 488 | * Row::offsetUnset |
||
| 489 | * |
||
| 490 | * Offset to unset |
||
| 491 | * |
||
| 492 | * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
||
| 493 | * |
||
| 494 | * @param mixed $offset <p> |
||
| 495 | * The offset to unset. |
||
| 496 | * </p> |
||
| 497 | * |
||
| 498 | * @return void |
||
| 499 | * @since 5.0.0 |
||
| 500 | */ |
||
| 501 | public function offsetUnset($field) |
||
| 502 | {
|
||
| 503 | unset($this->columns[ $field ]); |
||
| 504 | } |
||
| 505 | |||
| 506 | // ------------------------------------------------------------------------ |
||
| 507 | |||
| 508 | /** |
||
| 509 | * String representation of object |
||
| 510 | * |
||
| 511 | * @link http://php.net/manual/en/serializable.serialize.php |
||
| 512 | * @return string the string representation of the object or null |
||
| 513 | * @since 5.1.0 |
||
| 514 | */ |
||
| 515 | public function serialize() |
||
| 516 | {
|
||
| 517 | return serialize($this->rows); |
||
| 518 | } |
||
| 519 | |||
| 520 | // ------------------------------------------------------------------------ |
||
| 521 | |||
| 522 | /** |
||
| 523 | * Constructs the object |
||
| 524 | * |
||
| 525 | * @link http://php.net/manual/en/serializable.unserialize.php |
||
| 526 | * |
||
| 527 | * @param string $serialized <p> |
||
| 528 | * The string representation of the object. |
||
| 529 | * </p> |
||
| 530 | * |
||
| 531 | * @return void |
||
| 532 | * @since 5.1.0 |
||
| 533 | */ |
||
| 534 | public function unserialize($serialized) |
||
| 535 | {
|
||
| 536 | $this->rows = unserialize($serialized); |
||
| 537 | } |
||
| 538 | |||
| 539 | // ------------------------------------------------------------------------ |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Specify data which should be serialized to JSON |
||
| 543 | * |
||
| 544 | * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
||
| 545 | * @return mixed data which can be serialized by <b>json_encode</b>, |
||
| 546 | * which is a value of any type other than a resource. |
||
| 547 | * @since 5.4.0 |
||
| 548 | */ |
||
| 549 | public function jsonSerialize() |
||
| 552 | } |
||
| 553 | } |
Loading history...
