@@ -10,21 +10,21 @@ |
||
| 10 | 10 | * @subpackage Axolotl |
| 11 | 11 | */ |
| 12 | 12 | class GuardedPropertyException extends RuntimeException { |
| 13 | - /** |
|
| 14 | - * Property that threw. |
|
| 15 | - * |
|
| 16 | - * @var string |
|
| 17 | - */ |
|
| 18 | - public $property; |
|
| 13 | + /** |
|
| 14 | + * Property that threw. |
|
| 15 | + * |
|
| 16 | + * @var string |
|
| 17 | + */ |
|
| 18 | + public $property; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * Construct a GuardedPropertyException. |
|
| 22 | - * @param string $property Property that was guarded. |
|
| 23 | - * @param mixed[] $args Parent args. |
|
| 24 | - */ |
|
| 25 | - public function __construct( $property, ...$args ) { |
|
| 26 | - parent::__construct( ...$args ); |
|
| 20 | + /** |
|
| 21 | + * Construct a GuardedPropertyException. |
|
| 22 | + * @param string $property Property that was guarded. |
|
| 23 | + * @param mixed[] $args Parent args. |
|
| 24 | + */ |
|
| 25 | + public function __construct( $property, ...$args ) { |
|
| 26 | + parent::__construct( ...$args ); |
|
| 27 | 27 | |
| 28 | - $this->property = $property; |
|
| 29 | - } |
|
| 28 | + $this->property = $property; |
|
| 29 | + } |
|
| 30 | 30 | } |
@@ -22,8 +22,8 @@ |
||
| 22 | 22 | * @param string $property Property that was guarded. |
| 23 | 23 | * @param mixed[] $args Parent args. |
| 24 | 24 | */ |
| 25 | - public function __construct( $property, ...$args ) { |
|
| 26 | - parent::__construct( ...$args ); |
|
| 25 | + public function __construct($property, ...$args) { |
|
| 26 | + parent::__construct(...$args); |
|
| 27 | 27 | |
| 28 | 28 | $this->property = $property; |
| 29 | 29 | } |
@@ -22,738 +22,738 @@ |
||
| 22 | 22 | * @since 0.1.0 |
| 23 | 23 | */ |
| 24 | 24 | abstract class Model implements Serializes { |
| 25 | - /** |
|
| 26 | - * Table attribute key. |
|
| 27 | - */ |
|
| 28 | - const TABLE_KEY = '@@table'; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * Object attribute key. |
|
| 32 | - */ |
|
| 33 | - const OBJECT_KEY = '@@object'; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * Memoized values for class methods. |
|
| 37 | - * |
|
| 38 | - * @var array |
|
| 39 | - */ |
|
| 40 | - private static $memo = array(); |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Model attributes. |
|
| 44 | - * |
|
| 45 | - * @var array |
|
| 46 | - */ |
|
| 47 | - private $attributes = array( |
|
| 48 | - self::TABLE_KEY => array(), |
|
| 49 | - self::OBJECT_KEY => null, |
|
| 50 | - ); |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Model's original attributes. |
|
| 54 | - * |
|
| 55 | - * @var array |
|
| 56 | - */ |
|
| 57 | - private $original = array( |
|
| 58 | - self::TABLE_KEY => array(), |
|
| 59 | - self::OBJECT_KEY => null, |
|
| 60 | - ); |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * Default attribute values. |
|
| 64 | - * |
|
| 65 | - * @var array |
|
| 66 | - */ |
|
| 67 | - protected $defaults = array(); |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * Properties which are allowed to be set on the model. |
|
| 71 | - * |
|
| 72 | - * If this array is empty, any attributes can be set on the model. |
|
| 73 | - * |
|
| 74 | - * @var string[] |
|
| 75 | - */ |
|
| 76 | - protected $fillable = array(); |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Properties which cannot be automatically filled on the model. |
|
| 80 | - * |
|
| 81 | - * If the model is unguarded, these properties can be filled. |
|
| 82 | - * |
|
| 83 | - * @var array |
|
| 84 | - */ |
|
| 85 | - protected $guarded = array(); |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Properties which should not be serialized. |
|
| 89 | - * |
|
| 90 | - * @var array |
|
| 91 | - */ |
|
| 92 | - protected $hidden = array(); |
|
| 93 | - |
|
| 94 | - /** |
|
| 95 | - * Properties which should be serialized. |
|
| 96 | - * |
|
| 97 | - * @var array |
|
| 98 | - */ |
|
| 99 | - protected $visible = array(); |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Whether the model's properties are guarded. |
|
| 103 | - * |
|
| 104 | - * When false, allows guarded properties to be filled. |
|
| 105 | - * |
|
| 106 | - * @var bool |
|
| 107 | - */ |
|
| 108 | - protected $is_guarded = true; |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Constructs a new model with provided attributes. |
|
| 112 | - * |
|
| 113 | - * If self::OBJECT_KEY is passed as one of the attributes, the underlying post |
|
| 114 | - * will be overwritten. |
|
| 115 | - * |
|
| 116 | - * @param array <string, mixed> $attributes |
|
| 117 | - */ |
|
| 118 | - public function __construct( array $attributes = array() ) { |
|
| 119 | - $this->maybe_boot(); |
|
| 120 | - $this->sync_original(); |
|
| 121 | - |
|
| 122 | - if ( $this->uses_wp_object() ) { |
|
| 123 | - $this->create_wp_object(); |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - $this->unguard(); |
|
| 127 | - $this->refresh( $attributes ); |
|
| 128 | - $this->reguard(); |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * Refreshes the model's current attributes with the provided array. |
|
| 133 | - * |
|
| 134 | - * The model's attributes will match what was provided in the array, |
|
| 135 | - * and any attributes not passed |
|
| 136 | - * |
|
| 137 | - * @param array $attributes |
|
| 138 | - * |
|
| 139 | - * @return $this |
|
| 140 | - */ |
|
| 141 | - public function refresh( array $attributes ) { |
|
| 142 | - $this->clear(); |
|
| 143 | - |
|
| 144 | - return $this->merge( $attributes ); |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - /** |
|
| 148 | - * Merges the provided attributes with the provided array. |
|
| 149 | - * |
|
| 150 | - * @param array $attributes |
|
| 151 | - * |
|
| 152 | - * @return $this |
|
| 153 | - */ |
|
| 154 | - public function merge( array $attributes ) { |
|
| 155 | - foreach ( $attributes as $name => $value ) { |
|
| 156 | - $this->set_attribute( $name, $value ); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - return $this; |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * Get the model's table attributes. |
|
| 164 | - * |
|
| 165 | - * Returns the array of for the model that will either need to be |
|
| 166 | - * saved in postmeta or a separate table. |
|
| 167 | - * |
|
| 168 | - * @return array |
|
| 169 | - */ |
|
| 170 | - public function get_table_attributes() { |
|
| 171 | - return $this->attributes[ self::TABLE_KEY ]; |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - /** |
|
| 175 | - * Get the model's original attributes. |
|
| 176 | - * |
|
| 177 | - * @return array |
|
| 178 | - */ |
|
| 179 | - public function get_original_table_attributes() { |
|
| 180 | - return $this->original[ self::TABLE_KEY ]; |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - /** |
|
| 184 | - * Retrieve an array of the attributes on the model |
|
| 185 | - * that have changed compared to the model's |
|
| 186 | - * original data. |
|
| 187 | - * |
|
| 188 | - * @return array |
|
| 189 | - */ |
|
| 190 | - public function get_changed_table_attributes() { |
|
| 191 | - $changed = array(); |
|
| 192 | - |
|
| 193 | - foreach ( $this->get_table_attributes() as $key => $value ) { |
|
| 194 | - if ( $value !== |
|
| 195 | - $this->get_original_attribute( $key ) |
|
| 196 | - ) { |
|
| 197 | - $changed[ $key ] = $value; |
|
| 198 | - } |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - return $changed; |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * Get the model's underlying post. |
|
| 206 | - * |
|
| 207 | - * Returns the underlying WP_Post object for the model, representing |
|
| 208 | - * the data that will be save in the wp_posts table. |
|
| 209 | - * |
|
| 210 | - * @return false|WP_Post|WP_Term |
|
| 211 | - */ |
|
| 212 | - public function get_underlying_wp_object() { |
|
| 213 | - if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) { |
|
| 214 | - return $this->attributes[ self::OBJECT_KEY ]; |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - return false; |
|
| 218 | - } |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * Get the model's original underlying post. |
|
| 222 | - * |
|
| 223 | - * @return WP_Post |
|
| 224 | - */ |
|
| 225 | - public function get_original_underlying_wp_object() { |
|
| 226 | - return $this->original[ self::OBJECT_KEY ]; |
|
| 227 | - } |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * Get the model attributes on the WordPress object |
|
| 231 | - * that have changed compared to the model's |
|
| 232 | - * original attributes. |
|
| 233 | - * |
|
| 234 | - * @return array |
|
| 235 | - */ |
|
| 236 | - public function get_changed_wp_object_attributes() { |
|
| 237 | - $changed = array(); |
|
| 238 | - |
|
| 239 | - foreach ( $this->get_wp_object_keys() as $key ) { |
|
| 240 | - if ( $this->get_attribute( $key ) !== |
|
| 241 | - $this->get_original_attribute( $key ) |
|
| 242 | - ) { |
|
| 243 | - $changed[ $key ] = $this->get_attribute( $key ); |
|
| 244 | - } |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - return $changed; |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - /** |
|
| 251 | - * Magic __set method. |
|
| 252 | - * |
|
| 253 | - * Passes the name and value to set_attribute, which is where the magic happens. |
|
| 254 | - * |
|
| 255 | - * @param string $name |
|
| 256 | - * @param mixed $value |
|
| 257 | - */ |
|
| 258 | - public function __set( $name, $value ) { |
|
| 259 | - $this->set_attribute( $name, $value ); |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - /** |
|
| 263 | - * Sets the model attributes. |
|
| 264 | - * |
|
| 265 | - * Checks whether the model attribute can be set, check if it |
|
| 266 | - * maps to the WP_Post property, otherwise, assigns it to the |
|
| 267 | - * table attribute array. |
|
| 268 | - * |
|
| 269 | - * @param string $name |
|
| 270 | - * @param mixed $value |
|
| 271 | - * |
|
| 272 | - * @return $this |
|
| 273 | - * |
|
| 274 | - * @throws GuardedPropertyException |
|
| 275 | - */ |
|
| 276 | - public function set_attribute( $name, $value ) { |
|
| 277 | - if ( self::OBJECT_KEY === $name ) { |
|
| 278 | - return $this->override_wp_object( $value ); |
|
| 279 | - } |
|
| 280 | - |
|
| 281 | - if ( self::TABLE_KEY === $name ) { |
|
| 282 | - return $this->override_table( $value ); |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - if ( ! $this->is_fillable( $name ) ) { |
|
| 286 | - throw new GuardedPropertyException( $name ); |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - if ( $method = $this->has_map_method( $name ) ) { |
|
| 290 | - $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value; |
|
| 291 | - } else { |
|
| 292 | - $this->attributes[ self::TABLE_KEY ][ $name ] = $value; |
|
| 293 | - } |
|
| 294 | - |
|
| 295 | - return $this; |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - /** |
|
| 299 | - * Retrieves all the attribute keys for the model. |
|
| 300 | - * |
|
| 301 | - * @return array |
|
| 302 | - */ |
|
| 303 | - public function get_attribute_keys() { |
|
| 304 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 305 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - return self::$memo[ get_called_class() ][ __METHOD__ ] |
|
| 309 | - = array_merge( |
|
| 310 | - $this->fillable, |
|
| 311 | - $this->guarded, |
|
| 312 | - $this->get_compute_methods() |
|
| 313 | - ); |
|
| 314 | - } |
|
| 315 | - |
|
| 316 | - /** |
|
| 317 | - * Retrieves the attribute keys that aren't mapped to a post. |
|
| 318 | - * |
|
| 319 | - * @return array |
|
| 320 | - */ |
|
| 321 | - public function get_table_keys() { |
|
| 322 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 323 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - $keys = array(); |
|
| 327 | - |
|
| 328 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 329 | - if ( ! $this->has_map_method( $key ) && |
|
| 330 | - ! $this->has_compute_method( $key ) |
|
| 331 | - ) { |
|
| 332 | - $keys[] = $key; |
|
| 333 | - } |
|
| 334 | - } |
|
| 335 | - |
|
| 336 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 337 | - } |
|
| 338 | - |
|
| 339 | - /** |
|
| 340 | - * Retrieves the attribute keys that are mapped to a post. |
|
| 341 | - * |
|
| 342 | - * @return array |
|
| 343 | - */ |
|
| 344 | - public function get_wp_object_keys() { |
|
| 345 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 346 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 347 | - } |
|
| 348 | - |
|
| 349 | - $keys = array(); |
|
| 350 | - |
|
| 351 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 352 | - if ( $this->has_map_method( $key ) ) { |
|
| 353 | - $keys[] = $key; |
|
| 354 | - } |
|
| 355 | - } |
|
| 356 | - |
|
| 357 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 358 | - } |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * Returns the model's keys that are computed at call time. |
|
| 362 | - * |
|
| 363 | - * @return array |
|
| 364 | - */ |
|
| 365 | - public function get_computed_keys() { |
|
| 366 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 367 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 368 | - } |
|
| 369 | - |
|
| 370 | - $keys = array(); |
|
| 371 | - |
|
| 372 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 373 | - if ( $this->has_compute_method( $key ) ) { |
|
| 374 | - $keys[] = $key; |
|
| 375 | - } |
|
| 376 | - } |
|
| 377 | - |
|
| 378 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 379 | - } |
|
| 380 | - |
|
| 381 | - /** |
|
| 382 | - * Serializes the model's public data into an array. |
|
| 383 | - * |
|
| 384 | - * @return array |
|
| 385 | - */ |
|
| 386 | - public function serialize() { |
|
| 387 | - $attributes = array(); |
|
| 388 | - |
|
| 389 | - if ( $this->visible ) { |
|
| 390 | - // If visible attributes are set, we'll only reveal those. |
|
| 391 | - foreach ( $this->visible as $key ) { |
|
| 392 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 393 | - } |
|
| 394 | - } elseif ( $this->hidden ) { |
|
| 395 | - // If hidden attributes are set, we'll grab everything and hide those. |
|
| 396 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 397 | - if ( ! in_array( $key, $this->hidden ) ) { |
|
| 398 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 399 | - } |
|
| 400 | - } |
|
| 401 | - } else { |
|
| 402 | - // If nothing is hidden/visible, we'll grab and reveal everything. |
|
| 403 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 404 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 405 | - } |
|
| 406 | - } |
|
| 407 | - |
|
| 408 | - return array_map( function ( $attribute ) { |
|
| 409 | - if ( $attribute instanceof Serializes ) { |
|
| 410 | - return $attribute->serialize(); |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - return $attribute; |
|
| 414 | - }, $attributes ); |
|
| 415 | - } |
|
| 416 | - |
|
| 417 | - /** |
|
| 418 | - * Syncs the current attributes to the model's original. |
|
| 419 | - * |
|
| 420 | - * @return $this |
|
| 421 | - */ |
|
| 422 | - public function sync_original() { |
|
| 423 | - $this->original = $this->attributes; |
|
| 424 | - |
|
| 425 | - if ( $this->attributes[ self::OBJECT_KEY ] ) { |
|
| 426 | - $this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ]; |
|
| 427 | - } |
|
| 428 | - |
|
| 429 | - foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) { |
|
| 430 | - if ( is_object( $item ) ) { |
|
| 431 | - $this->original[ $key ] = clone $item; |
|
| 432 | - } |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - return $this; |
|
| 436 | - } |
|
| 437 | - |
|
| 438 | - /** |
|
| 439 | - * Checks if a given attribute is mass-fillable. |
|
| 440 | - * |
|
| 441 | - * Returns true if the attribute can be filled, false if it can't. |
|
| 442 | - * |
|
| 443 | - * @param string $name |
|
| 444 | - * |
|
| 445 | - * @return bool |
|
| 446 | - */ |
|
| 447 | - private function is_fillable( $name ) { |
|
| 448 | - // If this model isn't guarded, everything is fillable. |
|
| 449 | - if ( ! $this->is_guarded ) { |
|
| 450 | - return true; |
|
| 451 | - } |
|
| 452 | - |
|
| 453 | - // If it's in the fillable array, then it's fillable. |
|
| 454 | - if ( in_array( $name, $this->fillable ) ) { |
|
| 455 | - return true; |
|
| 456 | - } |
|
| 457 | - |
|
| 458 | - // If it's explicitly guarded, then it's not fillable. |
|
| 459 | - if ( in_array( $name, $this->guarded ) ) { |
|
| 460 | - return false; |
|
| 461 | - } |
|
| 462 | - |
|
| 463 | - // If fillable hasn't been defined, then everything else fillable. |
|
| 464 | - return ! $this->fillable; |
|
| 465 | - } |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * Overrides the current WordPress object with a provided one. |
|
| 469 | - * |
|
| 470 | - * Resets the post's default values and stores it in the attributes. |
|
| 471 | - * |
|
| 472 | - * @param WP_Post|WP_Term|null $value |
|
| 473 | - * |
|
| 474 | - * @return $this |
|
| 475 | - */ |
|
| 476 | - private function override_wp_object( $value ) { |
|
| 477 | - if ( is_object( $value ) ) { |
|
| 478 | - $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value ); |
|
| 479 | - } else { |
|
| 480 | - $this->attributes[ self::OBJECT_KEY ] = null; |
|
| 481 | - |
|
| 482 | - if ( $this->uses_wp_object() ) { |
|
| 483 | - $this->create_wp_object(); |
|
| 484 | - } |
|
| 485 | - } |
|
| 486 | - |
|
| 487 | - return $this; |
|
| 488 | - } |
|
| 489 | - |
|
| 490 | - /** |
|
| 491 | - * Overrides the current table attributes array with a provided one. |
|
| 492 | - * |
|
| 493 | - * @param array $value |
|
| 494 | - * |
|
| 495 | - * @return $this |
|
| 496 | - */ |
|
| 497 | - private function override_table( array $value ) { |
|
| 498 | - $this->attributes[ self::TABLE_KEY ] = $value; |
|
| 499 | - |
|
| 500 | - return $this; |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - /** |
|
| 504 | - * Create and set with a new blank post. |
|
| 505 | - * |
|
| 506 | - * Creates a new WP_Post object, assigns it the default attributes, |
|
| 507 | - * and stores it in the attributes. |
|
| 508 | - * |
|
| 509 | - * @throws LogicException |
|
| 510 | - */ |
|
| 511 | - private function create_wp_object() { |
|
| 512 | - switch ( true ) { |
|
| 513 | - case $this instanceof UsesWordPressPost: |
|
| 514 | - $object = new WP_Post( (object) array() ); |
|
| 515 | - break; |
|
| 516 | - case $this instanceof UsesWordPressTerm: |
|
| 517 | - $object = new WP_Term( (object) array() ); |
|
| 518 | - break; |
|
| 519 | - default: |
|
| 520 | - throw new LogicException; |
|
| 521 | - break; |
|
| 522 | - } |
|
| 523 | - |
|
| 524 | - $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object ); |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - /** |
|
| 528 | - * Enforces values on the post that can't change. |
|
| 529 | - * |
|
| 530 | - * Primarily, this is used to make sure the post_type always maps |
|
| 531 | - * to the model's "$type" property, but this can all be overridden |
|
| 532 | - * by the developer to enforce other values in the model. |
|
| 533 | - * |
|
| 534 | - * @param object $object |
|
| 535 | - * |
|
| 536 | - * @return object |
|
| 537 | - */ |
|
| 538 | - protected function set_wp_object_constants( $object ) { |
|
| 539 | - if ( $this instanceof UsesWordPressPost ) { |
|
| 540 | - $object->post_type = static::get_post_type(); |
|
| 541 | - } |
|
| 542 | - |
|
| 543 | - if ( $this instanceof UsesWordPressTerm ) { |
|
| 544 | - $object->taxonomy = static::get_taxonomy(); |
|
| 545 | - } |
|
| 546 | - |
|
| 547 | - return $object; |
|
| 548 | - } |
|
| 549 | - |
|
| 550 | - /** |
|
| 551 | - * Magic __get method. |
|
| 552 | - * |
|
| 553 | - * Passes the name and value to get_attribute, which is where the magic happens. |
|
| 554 | - * |
|
| 555 | - * @param string $name |
|
| 556 | - * |
|
| 557 | - * @return mixed |
|
| 558 | - */ |
|
| 559 | - public function __get( $name ) { |
|
| 560 | - return $this->get_attribute( $name ); |
|
| 561 | - } |
|
| 562 | - |
|
| 563 | - /** |
|
| 564 | - * Retrieves the model attribute. |
|
| 565 | - * |
|
| 566 | - * @param string $name |
|
| 567 | - * |
|
| 568 | - * @return mixed |
|
| 569 | - * |
|
| 570 | - * @throws PropertyDoesNotExistException If property isn't found. |
|
| 571 | - */ |
|
| 572 | - public function get_attribute( $name ) { |
|
| 573 | - if ( $method = $this->has_map_method( $name ) ) { |
|
| 574 | - return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()}; |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - if ( $method = $this->has_compute_method( $name ) ) { |
|
| 578 | - return $this->{$method}(); |
|
| 579 | - } |
|
| 580 | - |
|
| 581 | - if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) { |
|
| 582 | - return $this->attributes[ self::TABLE_KEY ][ $name ]; |
|
| 583 | - } |
|
| 584 | - |
|
| 585 | - if ( isset( $this->defaults[ $name ] ) ) { |
|
| 586 | - return $this->defaults[ $name ]; |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - return null; |
|
| 590 | - } |
|
| 591 | - |
|
| 592 | - /** |
|
| 593 | - * Retrieve the model's original attribute value. |
|
| 594 | - * |
|
| 595 | - * @param string $name |
|
| 596 | - * |
|
| 597 | - * @return mixed |
|
| 598 | - * |
|
| 599 | - * @throws PropertyDoesNotExistException If property isn't found. |
|
| 600 | - */ |
|
| 601 | - public function get_original_attribute( $name ) { |
|
| 602 | - $original_attributes = $this->original; |
|
| 603 | - |
|
| 604 | - if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) { |
|
| 605 | - unset( $original_attributes[ static::OBJECT_KEY ] ); |
|
| 606 | - } |
|
| 607 | - |
|
| 608 | - $original = new static( $original_attributes ); |
|
| 609 | - |
|
| 610 | - return $original->get_attribute( $name ); |
|
| 611 | - } |
|
| 612 | - |
|
| 613 | - /** |
|
| 614 | - * Fetches the Model's primary ID, depending on the model |
|
| 615 | - * implementation. |
|
| 616 | - * |
|
| 617 | - * @return int |
|
| 618 | - * |
|
| 619 | - * @throws LogicException |
|
| 620 | - */ |
|
| 621 | - public function get_primary_id() { |
|
| 622 | - if ( $this instanceof UsesWordPressPost ) { |
|
| 623 | - return $this->get_underlying_wp_object()->ID; |
|
| 624 | - } |
|
| 625 | - |
|
| 626 | - if ( $this instanceof UsesWordPressTerm ) { |
|
| 627 | - return $this->get_underlying_wp_object()->term_id; |
|
| 628 | - } |
|
| 629 | - |
|
| 630 | - if ( $this instanceof UsesCustomTable ) { |
|
| 631 | - return $this->get_attribute( $this->get_primary_key() ); |
|
| 632 | - } |
|
| 633 | - |
|
| 634 | - // Model w/o wp_object not yet supported. |
|
| 635 | - throw new LogicException; |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * Checks whether the attribute has a map method. |
|
| 640 | - * |
|
| 641 | - * This is used to determine whether the attribute maps to a |
|
| 642 | - * property on the underlying WP_Post object. Returns the |
|
| 643 | - * method if one exists, returns false if it doesn't. |
|
| 644 | - * |
|
| 645 | - * @param string $name |
|
| 646 | - * |
|
| 647 | - * @return false|string |
|
| 648 | - */ |
|
| 649 | - protected function has_map_method( $name ) { |
|
| 650 | - if ( method_exists( $this, $method = "map_{$name}" ) ) { |
|
| 651 | - return $method; |
|
| 652 | - } |
|
| 653 | - |
|
| 654 | - return false; |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * Checks whether the attribute has a compute method. |
|
| 659 | - * |
|
| 660 | - * This is used to determine if the attribute should be computed |
|
| 661 | - * from other attributes. |
|
| 662 | - * |
|
| 663 | - * @param string $name |
|
| 664 | - * |
|
| 665 | - * @return false|string |
|
| 666 | - */ |
|
| 667 | - protected function has_compute_method( $name ) { |
|
| 668 | - if ( method_exists( $this, $method = "compute_{$name}" ) ) { |
|
| 669 | - return $method; |
|
| 670 | - } |
|
| 671 | - |
|
| 672 | - return false; |
|
| 673 | - } |
|
| 674 | - |
|
| 675 | - /** |
|
| 676 | - * Clears all the current attributes from the model. |
|
| 677 | - * |
|
| 678 | - * This does not touch the model's original attributes, and will |
|
| 679 | - * only clear fillable attributes, unless the model is unguarded. |
|
| 680 | - * |
|
| 681 | - * @throws Exception |
|
| 682 | - * @return $this |
|
| 683 | - */ |
|
| 684 | - public function clear() { |
|
| 685 | - $keys = array_merge( |
|
| 686 | - $this->get_table_keys(), |
|
| 687 | - $this->get_wp_object_keys() |
|
| 688 | - ); |
|
| 689 | - |
|
| 690 | - foreach ( $keys as $key ) { |
|
| 691 | - try { |
|
| 692 | - $this->set_attribute( $key, null ); |
|
| 693 | - } catch ( Exception $e ) { |
|
| 694 | - // We won't clear out guarded attributes. |
|
| 695 | - if ( ! ( $e instanceof GuardedPropertyException ) ) { |
|
| 696 | - throw $e; |
|
| 697 | - } |
|
| 698 | - } |
|
| 699 | - } |
|
| 700 | - |
|
| 701 | - return $this; |
|
| 702 | - } |
|
| 703 | - |
|
| 704 | - /** |
|
| 705 | - * Unguards the model. |
|
| 706 | - * |
|
| 707 | - * Sets the model to be unguarded, allowing the filling of |
|
| 708 | - * guarded attributes. |
|
| 709 | - */ |
|
| 710 | - public function unguard() { |
|
| 711 | - $this->is_guarded = false; |
|
| 712 | - } |
|
| 713 | - |
|
| 714 | - /** |
|
| 715 | - * Reguards the model. |
|
| 716 | - * |
|
| 717 | - * Sets the model to be guarded, preventing filling of |
|
| 718 | - * guarded attributes. |
|
| 719 | - */ |
|
| 720 | - public function reguard() { |
|
| 721 | - $this->is_guarded = true; |
|
| 722 | - } |
|
| 723 | - |
|
| 724 | - /** |
|
| 725 | - * Retrieves all the compute methods on the model. |
|
| 726 | - * |
|
| 727 | - * @return array |
|
| 728 | - */ |
|
| 729 | - protected function get_compute_methods() { |
|
| 730 | - $methods = get_class_methods( get_called_class() ); |
|
| 731 | - $methods = array_filter( $methods, function ( $method ) { |
|
| 732 | - return strrpos( $method, 'compute_', - strlen( $method ) ) !== false; |
|
| 733 | - } ); |
|
| 734 | - $methods = array_map( function ( $method ) { |
|
| 735 | - return substr( $method, strlen( 'compute_' ) ); |
|
| 736 | - }, $methods ); |
|
| 737 | - |
|
| 738 | - return $methods; |
|
| 739 | - } |
|
| 740 | - |
|
| 741 | - /** |
|
| 742 | - * Sets up the memo array for the creating model. |
|
| 743 | - */ |
|
| 744 | - private function maybe_boot() { |
|
| 745 | - if ( ! isset( self::$memo[ get_called_class() ] ) ) { |
|
| 746 | - self::$memo[ get_called_class() ] = array(); |
|
| 747 | - } |
|
| 748 | - } |
|
| 749 | - |
|
| 750 | - /** |
|
| 751 | - * Whether this Model uses an underlying WordPress object. |
|
| 752 | - * |
|
| 753 | - * @return bool |
|
| 754 | - */ |
|
| 755 | - protected function uses_wp_object() { |
|
| 756 | - return $this instanceof UsesWordPressPost || |
|
| 757 | - $this instanceof UsesWordPressTerm; |
|
| 758 | - } |
|
| 25 | + /** |
|
| 26 | + * Table attribute key. |
|
| 27 | + */ |
|
| 28 | + const TABLE_KEY = '@@table'; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * Object attribute key. |
|
| 32 | + */ |
|
| 33 | + const OBJECT_KEY = '@@object'; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * Memoized values for class methods. |
|
| 37 | + * |
|
| 38 | + * @var array |
|
| 39 | + */ |
|
| 40 | + private static $memo = array(); |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Model attributes. |
|
| 44 | + * |
|
| 45 | + * @var array |
|
| 46 | + */ |
|
| 47 | + private $attributes = array( |
|
| 48 | + self::TABLE_KEY => array(), |
|
| 49 | + self::OBJECT_KEY => null, |
|
| 50 | + ); |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Model's original attributes. |
|
| 54 | + * |
|
| 55 | + * @var array |
|
| 56 | + */ |
|
| 57 | + private $original = array( |
|
| 58 | + self::TABLE_KEY => array(), |
|
| 59 | + self::OBJECT_KEY => null, |
|
| 60 | + ); |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * Default attribute values. |
|
| 64 | + * |
|
| 65 | + * @var array |
|
| 66 | + */ |
|
| 67 | + protected $defaults = array(); |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * Properties which are allowed to be set on the model. |
|
| 71 | + * |
|
| 72 | + * If this array is empty, any attributes can be set on the model. |
|
| 73 | + * |
|
| 74 | + * @var string[] |
|
| 75 | + */ |
|
| 76 | + protected $fillable = array(); |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Properties which cannot be automatically filled on the model. |
|
| 80 | + * |
|
| 81 | + * If the model is unguarded, these properties can be filled. |
|
| 82 | + * |
|
| 83 | + * @var array |
|
| 84 | + */ |
|
| 85 | + protected $guarded = array(); |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Properties which should not be serialized. |
|
| 89 | + * |
|
| 90 | + * @var array |
|
| 91 | + */ |
|
| 92 | + protected $hidden = array(); |
|
| 93 | + |
|
| 94 | + /** |
|
| 95 | + * Properties which should be serialized. |
|
| 96 | + * |
|
| 97 | + * @var array |
|
| 98 | + */ |
|
| 99 | + protected $visible = array(); |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Whether the model's properties are guarded. |
|
| 103 | + * |
|
| 104 | + * When false, allows guarded properties to be filled. |
|
| 105 | + * |
|
| 106 | + * @var bool |
|
| 107 | + */ |
|
| 108 | + protected $is_guarded = true; |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Constructs a new model with provided attributes. |
|
| 112 | + * |
|
| 113 | + * If self::OBJECT_KEY is passed as one of the attributes, the underlying post |
|
| 114 | + * will be overwritten. |
|
| 115 | + * |
|
| 116 | + * @param array <string, mixed> $attributes |
|
| 117 | + */ |
|
| 118 | + public function __construct( array $attributes = array() ) { |
|
| 119 | + $this->maybe_boot(); |
|
| 120 | + $this->sync_original(); |
|
| 121 | + |
|
| 122 | + if ( $this->uses_wp_object() ) { |
|
| 123 | + $this->create_wp_object(); |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + $this->unguard(); |
|
| 127 | + $this->refresh( $attributes ); |
|
| 128 | + $this->reguard(); |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * Refreshes the model's current attributes with the provided array. |
|
| 133 | + * |
|
| 134 | + * The model's attributes will match what was provided in the array, |
|
| 135 | + * and any attributes not passed |
|
| 136 | + * |
|
| 137 | + * @param array $attributes |
|
| 138 | + * |
|
| 139 | + * @return $this |
|
| 140 | + */ |
|
| 141 | + public function refresh( array $attributes ) { |
|
| 142 | + $this->clear(); |
|
| 143 | + |
|
| 144 | + return $this->merge( $attributes ); |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + /** |
|
| 148 | + * Merges the provided attributes with the provided array. |
|
| 149 | + * |
|
| 150 | + * @param array $attributes |
|
| 151 | + * |
|
| 152 | + * @return $this |
|
| 153 | + */ |
|
| 154 | + public function merge( array $attributes ) { |
|
| 155 | + foreach ( $attributes as $name => $value ) { |
|
| 156 | + $this->set_attribute( $name, $value ); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + return $this; |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * Get the model's table attributes. |
|
| 164 | + * |
|
| 165 | + * Returns the array of for the model that will either need to be |
|
| 166 | + * saved in postmeta or a separate table. |
|
| 167 | + * |
|
| 168 | + * @return array |
|
| 169 | + */ |
|
| 170 | + public function get_table_attributes() { |
|
| 171 | + return $this->attributes[ self::TABLE_KEY ]; |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + /** |
|
| 175 | + * Get the model's original attributes. |
|
| 176 | + * |
|
| 177 | + * @return array |
|
| 178 | + */ |
|
| 179 | + public function get_original_table_attributes() { |
|
| 180 | + return $this->original[ self::TABLE_KEY ]; |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + /** |
|
| 184 | + * Retrieve an array of the attributes on the model |
|
| 185 | + * that have changed compared to the model's |
|
| 186 | + * original data. |
|
| 187 | + * |
|
| 188 | + * @return array |
|
| 189 | + */ |
|
| 190 | + public function get_changed_table_attributes() { |
|
| 191 | + $changed = array(); |
|
| 192 | + |
|
| 193 | + foreach ( $this->get_table_attributes() as $key => $value ) { |
|
| 194 | + if ( $value !== |
|
| 195 | + $this->get_original_attribute( $key ) |
|
| 196 | + ) { |
|
| 197 | + $changed[ $key ] = $value; |
|
| 198 | + } |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + return $changed; |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * Get the model's underlying post. |
|
| 206 | + * |
|
| 207 | + * Returns the underlying WP_Post object for the model, representing |
|
| 208 | + * the data that will be save in the wp_posts table. |
|
| 209 | + * |
|
| 210 | + * @return false|WP_Post|WP_Term |
|
| 211 | + */ |
|
| 212 | + public function get_underlying_wp_object() { |
|
| 213 | + if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) { |
|
| 214 | + return $this->attributes[ self::OBJECT_KEY ]; |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + return false; |
|
| 218 | + } |
|
| 219 | + |
|
| 220 | + /** |
|
| 221 | + * Get the model's original underlying post. |
|
| 222 | + * |
|
| 223 | + * @return WP_Post |
|
| 224 | + */ |
|
| 225 | + public function get_original_underlying_wp_object() { |
|
| 226 | + return $this->original[ self::OBJECT_KEY ]; |
|
| 227 | + } |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * Get the model attributes on the WordPress object |
|
| 231 | + * that have changed compared to the model's |
|
| 232 | + * original attributes. |
|
| 233 | + * |
|
| 234 | + * @return array |
|
| 235 | + */ |
|
| 236 | + public function get_changed_wp_object_attributes() { |
|
| 237 | + $changed = array(); |
|
| 238 | + |
|
| 239 | + foreach ( $this->get_wp_object_keys() as $key ) { |
|
| 240 | + if ( $this->get_attribute( $key ) !== |
|
| 241 | + $this->get_original_attribute( $key ) |
|
| 242 | + ) { |
|
| 243 | + $changed[ $key ] = $this->get_attribute( $key ); |
|
| 244 | + } |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + return $changed; |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + /** |
|
| 251 | + * Magic __set method. |
|
| 252 | + * |
|
| 253 | + * Passes the name and value to set_attribute, which is where the magic happens. |
|
| 254 | + * |
|
| 255 | + * @param string $name |
|
| 256 | + * @param mixed $value |
|
| 257 | + */ |
|
| 258 | + public function __set( $name, $value ) { |
|
| 259 | + $this->set_attribute( $name, $value ); |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + /** |
|
| 263 | + * Sets the model attributes. |
|
| 264 | + * |
|
| 265 | + * Checks whether the model attribute can be set, check if it |
|
| 266 | + * maps to the WP_Post property, otherwise, assigns it to the |
|
| 267 | + * table attribute array. |
|
| 268 | + * |
|
| 269 | + * @param string $name |
|
| 270 | + * @param mixed $value |
|
| 271 | + * |
|
| 272 | + * @return $this |
|
| 273 | + * |
|
| 274 | + * @throws GuardedPropertyException |
|
| 275 | + */ |
|
| 276 | + public function set_attribute( $name, $value ) { |
|
| 277 | + if ( self::OBJECT_KEY === $name ) { |
|
| 278 | + return $this->override_wp_object( $value ); |
|
| 279 | + } |
|
| 280 | + |
|
| 281 | + if ( self::TABLE_KEY === $name ) { |
|
| 282 | + return $this->override_table( $value ); |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + if ( ! $this->is_fillable( $name ) ) { |
|
| 286 | + throw new GuardedPropertyException( $name ); |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + if ( $method = $this->has_map_method( $name ) ) { |
|
| 290 | + $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value; |
|
| 291 | + } else { |
|
| 292 | + $this->attributes[ self::TABLE_KEY ][ $name ] = $value; |
|
| 293 | + } |
|
| 294 | + |
|
| 295 | + return $this; |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + /** |
|
| 299 | + * Retrieves all the attribute keys for the model. |
|
| 300 | + * |
|
| 301 | + * @return array |
|
| 302 | + */ |
|
| 303 | + public function get_attribute_keys() { |
|
| 304 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 305 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + return self::$memo[ get_called_class() ][ __METHOD__ ] |
|
| 309 | + = array_merge( |
|
| 310 | + $this->fillable, |
|
| 311 | + $this->guarded, |
|
| 312 | + $this->get_compute_methods() |
|
| 313 | + ); |
|
| 314 | + } |
|
| 315 | + |
|
| 316 | + /** |
|
| 317 | + * Retrieves the attribute keys that aren't mapped to a post. |
|
| 318 | + * |
|
| 319 | + * @return array |
|
| 320 | + */ |
|
| 321 | + public function get_table_keys() { |
|
| 322 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 323 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + $keys = array(); |
|
| 327 | + |
|
| 328 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
| 329 | + if ( ! $this->has_map_method( $key ) && |
|
| 330 | + ! $this->has_compute_method( $key ) |
|
| 331 | + ) { |
|
| 332 | + $keys[] = $key; |
|
| 333 | + } |
|
| 334 | + } |
|
| 335 | + |
|
| 336 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 337 | + } |
|
| 338 | + |
|
| 339 | + /** |
|
| 340 | + * Retrieves the attribute keys that are mapped to a post. |
|
| 341 | + * |
|
| 342 | + * @return array |
|
| 343 | + */ |
|
| 344 | + public function get_wp_object_keys() { |
|
| 345 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 346 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 347 | + } |
|
| 348 | + |
|
| 349 | + $keys = array(); |
|
| 350 | + |
|
| 351 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
| 352 | + if ( $this->has_map_method( $key ) ) { |
|
| 353 | + $keys[] = $key; |
|
| 354 | + } |
|
| 355 | + } |
|
| 356 | + |
|
| 357 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 358 | + } |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * Returns the model's keys that are computed at call time. |
|
| 362 | + * |
|
| 363 | + * @return array |
|
| 364 | + */ |
|
| 365 | + public function get_computed_keys() { |
|
| 366 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 367 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 368 | + } |
|
| 369 | + |
|
| 370 | + $keys = array(); |
|
| 371 | + |
|
| 372 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
| 373 | + if ( $this->has_compute_method( $key ) ) { |
|
| 374 | + $keys[] = $key; |
|
| 375 | + } |
|
| 376 | + } |
|
| 377 | + |
|
| 378 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 379 | + } |
|
| 380 | + |
|
| 381 | + /** |
|
| 382 | + * Serializes the model's public data into an array. |
|
| 383 | + * |
|
| 384 | + * @return array |
|
| 385 | + */ |
|
| 386 | + public function serialize() { |
|
| 387 | + $attributes = array(); |
|
| 388 | + |
|
| 389 | + if ( $this->visible ) { |
|
| 390 | + // If visible attributes are set, we'll only reveal those. |
|
| 391 | + foreach ( $this->visible as $key ) { |
|
| 392 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 393 | + } |
|
| 394 | + } elseif ( $this->hidden ) { |
|
| 395 | + // If hidden attributes are set, we'll grab everything and hide those. |
|
| 396 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
| 397 | + if ( ! in_array( $key, $this->hidden ) ) { |
|
| 398 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 399 | + } |
|
| 400 | + } |
|
| 401 | + } else { |
|
| 402 | + // If nothing is hidden/visible, we'll grab and reveal everything. |
|
| 403 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
| 404 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 405 | + } |
|
| 406 | + } |
|
| 407 | + |
|
| 408 | + return array_map( function ( $attribute ) { |
|
| 409 | + if ( $attribute instanceof Serializes ) { |
|
| 410 | + return $attribute->serialize(); |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + return $attribute; |
|
| 414 | + }, $attributes ); |
|
| 415 | + } |
|
| 416 | + |
|
| 417 | + /** |
|
| 418 | + * Syncs the current attributes to the model's original. |
|
| 419 | + * |
|
| 420 | + * @return $this |
|
| 421 | + */ |
|
| 422 | + public function sync_original() { |
|
| 423 | + $this->original = $this->attributes; |
|
| 424 | + |
|
| 425 | + if ( $this->attributes[ self::OBJECT_KEY ] ) { |
|
| 426 | + $this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ]; |
|
| 427 | + } |
|
| 428 | + |
|
| 429 | + foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) { |
|
| 430 | + if ( is_object( $item ) ) { |
|
| 431 | + $this->original[ $key ] = clone $item; |
|
| 432 | + } |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + return $this; |
|
| 436 | + } |
|
| 437 | + |
|
| 438 | + /** |
|
| 439 | + * Checks if a given attribute is mass-fillable. |
|
| 440 | + * |
|
| 441 | + * Returns true if the attribute can be filled, false if it can't. |
|
| 442 | + * |
|
| 443 | + * @param string $name |
|
| 444 | + * |
|
| 445 | + * @return bool |
|
| 446 | + */ |
|
| 447 | + private function is_fillable( $name ) { |
|
| 448 | + // If this model isn't guarded, everything is fillable. |
|
| 449 | + if ( ! $this->is_guarded ) { |
|
| 450 | + return true; |
|
| 451 | + } |
|
| 452 | + |
|
| 453 | + // If it's in the fillable array, then it's fillable. |
|
| 454 | + if ( in_array( $name, $this->fillable ) ) { |
|
| 455 | + return true; |
|
| 456 | + } |
|
| 457 | + |
|
| 458 | + // If it's explicitly guarded, then it's not fillable. |
|
| 459 | + if ( in_array( $name, $this->guarded ) ) { |
|
| 460 | + return false; |
|
| 461 | + } |
|
| 462 | + |
|
| 463 | + // If fillable hasn't been defined, then everything else fillable. |
|
| 464 | + return ! $this->fillable; |
|
| 465 | + } |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * Overrides the current WordPress object with a provided one. |
|
| 469 | + * |
|
| 470 | + * Resets the post's default values and stores it in the attributes. |
|
| 471 | + * |
|
| 472 | + * @param WP_Post|WP_Term|null $value |
|
| 473 | + * |
|
| 474 | + * @return $this |
|
| 475 | + */ |
|
| 476 | + private function override_wp_object( $value ) { |
|
| 477 | + if ( is_object( $value ) ) { |
|
| 478 | + $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value ); |
|
| 479 | + } else { |
|
| 480 | + $this->attributes[ self::OBJECT_KEY ] = null; |
|
| 481 | + |
|
| 482 | + if ( $this->uses_wp_object() ) { |
|
| 483 | + $this->create_wp_object(); |
|
| 484 | + } |
|
| 485 | + } |
|
| 486 | + |
|
| 487 | + return $this; |
|
| 488 | + } |
|
| 489 | + |
|
| 490 | + /** |
|
| 491 | + * Overrides the current table attributes array with a provided one. |
|
| 492 | + * |
|
| 493 | + * @param array $value |
|
| 494 | + * |
|
| 495 | + * @return $this |
|
| 496 | + */ |
|
| 497 | + private function override_table( array $value ) { |
|
| 498 | + $this->attributes[ self::TABLE_KEY ] = $value; |
|
| 499 | + |
|
| 500 | + return $this; |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + /** |
|
| 504 | + * Create and set with a new blank post. |
|
| 505 | + * |
|
| 506 | + * Creates a new WP_Post object, assigns it the default attributes, |
|
| 507 | + * and stores it in the attributes. |
|
| 508 | + * |
|
| 509 | + * @throws LogicException |
|
| 510 | + */ |
|
| 511 | + private function create_wp_object() { |
|
| 512 | + switch ( true ) { |
|
| 513 | + case $this instanceof UsesWordPressPost: |
|
| 514 | + $object = new WP_Post( (object) array() ); |
|
| 515 | + break; |
|
| 516 | + case $this instanceof UsesWordPressTerm: |
|
| 517 | + $object = new WP_Term( (object) array() ); |
|
| 518 | + break; |
|
| 519 | + default: |
|
| 520 | + throw new LogicException; |
|
| 521 | + break; |
|
| 522 | + } |
|
| 523 | + |
|
| 524 | + $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object ); |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + /** |
|
| 528 | + * Enforces values on the post that can't change. |
|
| 529 | + * |
|
| 530 | + * Primarily, this is used to make sure the post_type always maps |
|
| 531 | + * to the model's "$type" property, but this can all be overridden |
|
| 532 | + * by the developer to enforce other values in the model. |
|
| 533 | + * |
|
| 534 | + * @param object $object |
|
| 535 | + * |
|
| 536 | + * @return object |
|
| 537 | + */ |
|
| 538 | + protected function set_wp_object_constants( $object ) { |
|
| 539 | + if ( $this instanceof UsesWordPressPost ) { |
|
| 540 | + $object->post_type = static::get_post_type(); |
|
| 541 | + } |
|
| 542 | + |
|
| 543 | + if ( $this instanceof UsesWordPressTerm ) { |
|
| 544 | + $object->taxonomy = static::get_taxonomy(); |
|
| 545 | + } |
|
| 546 | + |
|
| 547 | + return $object; |
|
| 548 | + } |
|
| 549 | + |
|
| 550 | + /** |
|
| 551 | + * Magic __get method. |
|
| 552 | + * |
|
| 553 | + * Passes the name and value to get_attribute, which is where the magic happens. |
|
| 554 | + * |
|
| 555 | + * @param string $name |
|
| 556 | + * |
|
| 557 | + * @return mixed |
|
| 558 | + */ |
|
| 559 | + public function __get( $name ) { |
|
| 560 | + return $this->get_attribute( $name ); |
|
| 561 | + } |
|
| 562 | + |
|
| 563 | + /** |
|
| 564 | + * Retrieves the model attribute. |
|
| 565 | + * |
|
| 566 | + * @param string $name |
|
| 567 | + * |
|
| 568 | + * @return mixed |
|
| 569 | + * |
|
| 570 | + * @throws PropertyDoesNotExistException If property isn't found. |
|
| 571 | + */ |
|
| 572 | + public function get_attribute( $name ) { |
|
| 573 | + if ( $method = $this->has_map_method( $name ) ) { |
|
| 574 | + return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()}; |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + if ( $method = $this->has_compute_method( $name ) ) { |
|
| 578 | + return $this->{$method}(); |
|
| 579 | + } |
|
| 580 | + |
|
| 581 | + if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) { |
|
| 582 | + return $this->attributes[ self::TABLE_KEY ][ $name ]; |
|
| 583 | + } |
|
| 584 | + |
|
| 585 | + if ( isset( $this->defaults[ $name ] ) ) { |
|
| 586 | + return $this->defaults[ $name ]; |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + return null; |
|
| 590 | + } |
|
| 591 | + |
|
| 592 | + /** |
|
| 593 | + * Retrieve the model's original attribute value. |
|
| 594 | + * |
|
| 595 | + * @param string $name |
|
| 596 | + * |
|
| 597 | + * @return mixed |
|
| 598 | + * |
|
| 599 | + * @throws PropertyDoesNotExistException If property isn't found. |
|
| 600 | + */ |
|
| 601 | + public function get_original_attribute( $name ) { |
|
| 602 | + $original_attributes = $this->original; |
|
| 603 | + |
|
| 604 | + if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) { |
|
| 605 | + unset( $original_attributes[ static::OBJECT_KEY ] ); |
|
| 606 | + } |
|
| 607 | + |
|
| 608 | + $original = new static( $original_attributes ); |
|
| 609 | + |
|
| 610 | + return $original->get_attribute( $name ); |
|
| 611 | + } |
|
| 612 | + |
|
| 613 | + /** |
|
| 614 | + * Fetches the Model's primary ID, depending on the model |
|
| 615 | + * implementation. |
|
| 616 | + * |
|
| 617 | + * @return int |
|
| 618 | + * |
|
| 619 | + * @throws LogicException |
|
| 620 | + */ |
|
| 621 | + public function get_primary_id() { |
|
| 622 | + if ( $this instanceof UsesWordPressPost ) { |
|
| 623 | + return $this->get_underlying_wp_object()->ID; |
|
| 624 | + } |
|
| 625 | + |
|
| 626 | + if ( $this instanceof UsesWordPressTerm ) { |
|
| 627 | + return $this->get_underlying_wp_object()->term_id; |
|
| 628 | + } |
|
| 629 | + |
|
| 630 | + if ( $this instanceof UsesCustomTable ) { |
|
| 631 | + return $this->get_attribute( $this->get_primary_key() ); |
|
| 632 | + } |
|
| 633 | + |
|
| 634 | + // Model w/o wp_object not yet supported. |
|
| 635 | + throw new LogicException; |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * Checks whether the attribute has a map method. |
|
| 640 | + * |
|
| 641 | + * This is used to determine whether the attribute maps to a |
|
| 642 | + * property on the underlying WP_Post object. Returns the |
|
| 643 | + * method if one exists, returns false if it doesn't. |
|
| 644 | + * |
|
| 645 | + * @param string $name |
|
| 646 | + * |
|
| 647 | + * @return false|string |
|
| 648 | + */ |
|
| 649 | + protected function has_map_method( $name ) { |
|
| 650 | + if ( method_exists( $this, $method = "map_{$name}" ) ) { |
|
| 651 | + return $method; |
|
| 652 | + } |
|
| 653 | + |
|
| 654 | + return false; |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * Checks whether the attribute has a compute method. |
|
| 659 | + * |
|
| 660 | + * This is used to determine if the attribute should be computed |
|
| 661 | + * from other attributes. |
|
| 662 | + * |
|
| 663 | + * @param string $name |
|
| 664 | + * |
|
| 665 | + * @return false|string |
|
| 666 | + */ |
|
| 667 | + protected function has_compute_method( $name ) { |
|
| 668 | + if ( method_exists( $this, $method = "compute_{$name}" ) ) { |
|
| 669 | + return $method; |
|
| 670 | + } |
|
| 671 | + |
|
| 672 | + return false; |
|
| 673 | + } |
|
| 674 | + |
|
| 675 | + /** |
|
| 676 | + * Clears all the current attributes from the model. |
|
| 677 | + * |
|
| 678 | + * This does not touch the model's original attributes, and will |
|
| 679 | + * only clear fillable attributes, unless the model is unguarded. |
|
| 680 | + * |
|
| 681 | + * @throws Exception |
|
| 682 | + * @return $this |
|
| 683 | + */ |
|
| 684 | + public function clear() { |
|
| 685 | + $keys = array_merge( |
|
| 686 | + $this->get_table_keys(), |
|
| 687 | + $this->get_wp_object_keys() |
|
| 688 | + ); |
|
| 689 | + |
|
| 690 | + foreach ( $keys as $key ) { |
|
| 691 | + try { |
|
| 692 | + $this->set_attribute( $key, null ); |
|
| 693 | + } catch ( Exception $e ) { |
|
| 694 | + // We won't clear out guarded attributes. |
|
| 695 | + if ( ! ( $e instanceof GuardedPropertyException ) ) { |
|
| 696 | + throw $e; |
|
| 697 | + } |
|
| 698 | + } |
|
| 699 | + } |
|
| 700 | + |
|
| 701 | + return $this; |
|
| 702 | + } |
|
| 703 | + |
|
| 704 | + /** |
|
| 705 | + * Unguards the model. |
|
| 706 | + * |
|
| 707 | + * Sets the model to be unguarded, allowing the filling of |
|
| 708 | + * guarded attributes. |
|
| 709 | + */ |
|
| 710 | + public function unguard() { |
|
| 711 | + $this->is_guarded = false; |
|
| 712 | + } |
|
| 713 | + |
|
| 714 | + /** |
|
| 715 | + * Reguards the model. |
|
| 716 | + * |
|
| 717 | + * Sets the model to be guarded, preventing filling of |
|
| 718 | + * guarded attributes. |
|
| 719 | + */ |
|
| 720 | + public function reguard() { |
|
| 721 | + $this->is_guarded = true; |
|
| 722 | + } |
|
| 723 | + |
|
| 724 | + /** |
|
| 725 | + * Retrieves all the compute methods on the model. |
|
| 726 | + * |
|
| 727 | + * @return array |
|
| 728 | + */ |
|
| 729 | + protected function get_compute_methods() { |
|
| 730 | + $methods = get_class_methods( get_called_class() ); |
|
| 731 | + $methods = array_filter( $methods, function ( $method ) { |
|
| 732 | + return strrpos( $method, 'compute_', - strlen( $method ) ) !== false; |
|
| 733 | + } ); |
|
| 734 | + $methods = array_map( function ( $method ) { |
|
| 735 | + return substr( $method, strlen( 'compute_' ) ); |
|
| 736 | + }, $methods ); |
|
| 737 | + |
|
| 738 | + return $methods; |
|
| 739 | + } |
|
| 740 | + |
|
| 741 | + /** |
|
| 742 | + * Sets up the memo array for the creating model. |
|
| 743 | + */ |
|
| 744 | + private function maybe_boot() { |
|
| 745 | + if ( ! isset( self::$memo[ get_called_class() ] ) ) { |
|
| 746 | + self::$memo[ get_called_class() ] = array(); |
|
| 747 | + } |
|
| 748 | + } |
|
| 749 | + |
|
| 750 | + /** |
|
| 751 | + * Whether this Model uses an underlying WordPress object. |
|
| 752 | + * |
|
| 753 | + * @return bool |
|
| 754 | + */ |
|
| 755 | + protected function uses_wp_object() { |
|
| 756 | + return $this instanceof UsesWordPressPost || |
|
| 757 | + $this instanceof UsesWordPressTerm; |
|
| 758 | + } |
|
| 759 | 759 | } |
@@ -115,16 +115,16 @@ discard block |
||
| 115 | 115 | * |
| 116 | 116 | * @param array <string, mixed> $attributes |
| 117 | 117 | */ |
| 118 | - public function __construct( array $attributes = array() ) { |
|
| 118 | + public function __construct(array $attributes = array()) { |
|
| 119 | 119 | $this->maybe_boot(); |
| 120 | 120 | $this->sync_original(); |
| 121 | 121 | |
| 122 | - if ( $this->uses_wp_object() ) { |
|
| 122 | + if ($this->uses_wp_object()) { |
|
| 123 | 123 | $this->create_wp_object(); |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | 126 | $this->unguard(); |
| 127 | - $this->refresh( $attributes ); |
|
| 127 | + $this->refresh($attributes); |
|
| 128 | 128 | $this->reguard(); |
| 129 | 129 | } |
| 130 | 130 | |
@@ -138,10 +138,10 @@ discard block |
||
| 138 | 138 | * |
| 139 | 139 | * @return $this |
| 140 | 140 | */ |
| 141 | - public function refresh( array $attributes ) { |
|
| 141 | + public function refresh(array $attributes) { |
|
| 142 | 142 | $this->clear(); |
| 143 | 143 | |
| 144 | - return $this->merge( $attributes ); |
|
| 144 | + return $this->merge($attributes); |
|
| 145 | 145 | } |
| 146 | 146 | |
| 147 | 147 | /** |
@@ -151,9 +151,9 @@ discard block |
||
| 151 | 151 | * |
| 152 | 152 | * @return $this |
| 153 | 153 | */ |
| 154 | - public function merge( array $attributes ) { |
|
| 155 | - foreach ( $attributes as $name => $value ) { |
|
| 156 | - $this->set_attribute( $name, $value ); |
|
| 154 | + public function merge(array $attributes) { |
|
| 155 | + foreach ($attributes as $name => $value) { |
|
| 156 | + $this->set_attribute($name, $value); |
|
| 157 | 157 | } |
| 158 | 158 | |
| 159 | 159 | return $this; |
@@ -168,7 +168,7 @@ discard block |
||
| 168 | 168 | * @return array |
| 169 | 169 | */ |
| 170 | 170 | public function get_table_attributes() { |
| 171 | - return $this->attributes[ self::TABLE_KEY ]; |
|
| 171 | + return $this->attributes[self::TABLE_KEY]; |
|
| 172 | 172 | } |
| 173 | 173 | |
| 174 | 174 | /** |
@@ -177,7 +177,7 @@ discard block |
||
| 177 | 177 | * @return array |
| 178 | 178 | */ |
| 179 | 179 | public function get_original_table_attributes() { |
| 180 | - return $this->original[ self::TABLE_KEY ]; |
|
| 180 | + return $this->original[self::TABLE_KEY]; |
|
| 181 | 181 | } |
| 182 | 182 | |
| 183 | 183 | /** |
@@ -190,11 +190,11 @@ discard block |
||
| 190 | 190 | public function get_changed_table_attributes() { |
| 191 | 191 | $changed = array(); |
| 192 | 192 | |
| 193 | - foreach ( $this->get_table_attributes() as $key => $value ) { |
|
| 194 | - if ( $value !== |
|
| 195 | - $this->get_original_attribute( $key ) |
|
| 193 | + foreach ($this->get_table_attributes() as $key => $value) { |
|
| 194 | + if ($value !== |
|
| 195 | + $this->get_original_attribute($key) |
|
| 196 | 196 | ) { |
| 197 | - $changed[ $key ] = $value; |
|
| 197 | + $changed[$key] = $value; |
|
| 198 | 198 | } |
| 199 | 199 | } |
| 200 | 200 | |
@@ -210,8 +210,8 @@ discard block |
||
| 210 | 210 | * @return false|WP_Post|WP_Term |
| 211 | 211 | */ |
| 212 | 212 | public function get_underlying_wp_object() { |
| 213 | - if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) { |
|
| 214 | - return $this->attributes[ self::OBJECT_KEY ]; |
|
| 213 | + if (isset($this->attributes[self::OBJECT_KEY])) { |
|
| 214 | + return $this->attributes[self::OBJECT_KEY]; |
|
| 215 | 215 | } |
| 216 | 216 | |
| 217 | 217 | return false; |
@@ -223,7 +223,7 @@ discard block |
||
| 223 | 223 | * @return WP_Post |
| 224 | 224 | */ |
| 225 | 225 | public function get_original_underlying_wp_object() { |
| 226 | - return $this->original[ self::OBJECT_KEY ]; |
|
| 226 | + return $this->original[self::OBJECT_KEY]; |
|
| 227 | 227 | } |
| 228 | 228 | |
| 229 | 229 | /** |
@@ -236,11 +236,11 @@ discard block |
||
| 236 | 236 | public function get_changed_wp_object_attributes() { |
| 237 | 237 | $changed = array(); |
| 238 | 238 | |
| 239 | - foreach ( $this->get_wp_object_keys() as $key ) { |
|
| 240 | - if ( $this->get_attribute( $key ) !== |
|
| 241 | - $this->get_original_attribute( $key ) |
|
| 239 | + foreach ($this->get_wp_object_keys() as $key) { |
|
| 240 | + if ($this->get_attribute($key) !== |
|
| 241 | + $this->get_original_attribute($key) |
|
| 242 | 242 | ) { |
| 243 | - $changed[ $key ] = $this->get_attribute( $key ); |
|
| 243 | + $changed[$key] = $this->get_attribute($key); |
|
| 244 | 244 | } |
| 245 | 245 | } |
| 246 | 246 | |
@@ -255,8 +255,8 @@ discard block |
||
| 255 | 255 | * @param string $name |
| 256 | 256 | * @param mixed $value |
| 257 | 257 | */ |
| 258 | - public function __set( $name, $value ) { |
|
| 259 | - $this->set_attribute( $name, $value ); |
|
| 258 | + public function __set($name, $value) { |
|
| 259 | + $this->set_attribute($name, $value); |
|
| 260 | 260 | } |
| 261 | 261 | |
| 262 | 262 | /** |
@@ -273,23 +273,23 @@ discard block |
||
| 273 | 273 | * |
| 274 | 274 | * @throws GuardedPropertyException |
| 275 | 275 | */ |
| 276 | - public function set_attribute( $name, $value ) { |
|
| 277 | - if ( self::OBJECT_KEY === $name ) { |
|
| 278 | - return $this->override_wp_object( $value ); |
|
| 276 | + public function set_attribute($name, $value) { |
|
| 277 | + if (self::OBJECT_KEY === $name) { |
|
| 278 | + return $this->override_wp_object($value); |
|
| 279 | 279 | } |
| 280 | 280 | |
| 281 | - if ( self::TABLE_KEY === $name ) { |
|
| 282 | - return $this->override_table( $value ); |
|
| 281 | + if (self::TABLE_KEY === $name) { |
|
| 282 | + return $this->override_table($value); |
|
| 283 | 283 | } |
| 284 | 284 | |
| 285 | - if ( ! $this->is_fillable( $name ) ) { |
|
| 286 | - throw new GuardedPropertyException( $name ); |
|
| 285 | + if (!$this->is_fillable($name)) { |
|
| 286 | + throw new GuardedPropertyException($name); |
|
| 287 | 287 | } |
| 288 | 288 | |
| 289 | - if ( $method = $this->has_map_method( $name ) ) { |
|
| 290 | - $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value; |
|
| 289 | + if ($method = $this->has_map_method($name)) { |
|
| 290 | + $this->attributes[self::OBJECT_KEY]->{$this->{$method}()} = $value; |
|
| 291 | 291 | } else { |
| 292 | - $this->attributes[ self::TABLE_KEY ][ $name ] = $value; |
|
| 292 | + $this->attributes[self::TABLE_KEY][$name] = $value; |
|
| 293 | 293 | } |
| 294 | 294 | |
| 295 | 295 | return $this; |
@@ -301,11 +301,11 @@ discard block |
||
| 301 | 301 | * @return array |
| 302 | 302 | */ |
| 303 | 303 | public function get_attribute_keys() { |
| 304 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 305 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 304 | + if (isset(self::$memo[get_called_class()][__METHOD__])) { |
|
| 305 | + return self::$memo[get_called_class()][__METHOD__]; |
|
| 306 | 306 | } |
| 307 | 307 | |
| 308 | - return self::$memo[ get_called_class() ][ __METHOD__ ] |
|
| 308 | + return self::$memo[get_called_class()][__METHOD__] |
|
| 309 | 309 | = array_merge( |
| 310 | 310 | $this->fillable, |
| 311 | 311 | $this->guarded, |
@@ -319,21 +319,21 @@ discard block |
||
| 319 | 319 | * @return array |
| 320 | 320 | */ |
| 321 | 321 | public function get_table_keys() { |
| 322 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 323 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 322 | + if (isset(self::$memo[get_called_class()][__METHOD__])) { |
|
| 323 | + return self::$memo[get_called_class()][__METHOD__]; |
|
| 324 | 324 | } |
| 325 | 325 | |
| 326 | 326 | $keys = array(); |
| 327 | 327 | |
| 328 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 329 | - if ( ! $this->has_map_method( $key ) && |
|
| 330 | - ! $this->has_compute_method( $key ) |
|
| 328 | + foreach ($this->get_attribute_keys() as $key) { |
|
| 329 | + if (!$this->has_map_method($key) && |
|
| 330 | + !$this->has_compute_method($key) |
|
| 331 | 331 | ) { |
| 332 | 332 | $keys[] = $key; |
| 333 | 333 | } |
| 334 | 334 | } |
| 335 | 335 | |
| 336 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 336 | + return self::$memo[get_called_class()][__METHOD__] = $keys; |
|
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | /** |
@@ -342,19 +342,19 @@ discard block |
||
| 342 | 342 | * @return array |
| 343 | 343 | */ |
| 344 | 344 | public function get_wp_object_keys() { |
| 345 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 346 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 345 | + if (isset(self::$memo[get_called_class()][__METHOD__])) { |
|
| 346 | + return self::$memo[get_called_class()][__METHOD__]; |
|
| 347 | 347 | } |
| 348 | 348 | |
| 349 | 349 | $keys = array(); |
| 350 | 350 | |
| 351 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 352 | - if ( $this->has_map_method( $key ) ) { |
|
| 351 | + foreach ($this->get_attribute_keys() as $key) { |
|
| 352 | + if ($this->has_map_method($key)) { |
|
| 353 | 353 | $keys[] = $key; |
| 354 | 354 | } |
| 355 | 355 | } |
| 356 | 356 | |
| 357 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 357 | + return self::$memo[get_called_class()][__METHOD__] = $keys; |
|
| 358 | 358 | } |
| 359 | 359 | |
| 360 | 360 | /** |
@@ -363,19 +363,19 @@ discard block |
||
| 363 | 363 | * @return array |
| 364 | 364 | */ |
| 365 | 365 | public function get_computed_keys() { |
| 366 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
| 367 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
| 366 | + if (isset(self::$memo[get_called_class()][__METHOD__])) { |
|
| 367 | + return self::$memo[get_called_class()][__METHOD__]; |
|
| 368 | 368 | } |
| 369 | 369 | |
| 370 | 370 | $keys = array(); |
| 371 | 371 | |
| 372 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 373 | - if ( $this->has_compute_method( $key ) ) { |
|
| 372 | + foreach ($this->get_attribute_keys() as $key) { |
|
| 373 | + if ($this->has_compute_method($key)) { |
|
| 374 | 374 | $keys[] = $key; |
| 375 | 375 | } |
| 376 | 376 | } |
| 377 | 377 | |
| 378 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
| 378 | + return self::$memo[get_called_class()][__METHOD__] = $keys; |
|
| 379 | 379 | } |
| 380 | 380 | |
| 381 | 381 | /** |
@@ -386,32 +386,32 @@ discard block |
||
| 386 | 386 | public function serialize() { |
| 387 | 387 | $attributes = array(); |
| 388 | 388 | |
| 389 | - if ( $this->visible ) { |
|
| 389 | + if ($this->visible) { |
|
| 390 | 390 | // If visible attributes are set, we'll only reveal those. |
| 391 | - foreach ( $this->visible as $key ) { |
|
| 392 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 391 | + foreach ($this->visible as $key) { |
|
| 392 | + $attributes[$key] = $this->get_attribute($key); |
|
| 393 | 393 | } |
| 394 | - } elseif ( $this->hidden ) { |
|
| 394 | + } elseif ($this->hidden) { |
|
| 395 | 395 | // If hidden attributes are set, we'll grab everything and hide those. |
| 396 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 397 | - if ( ! in_array( $key, $this->hidden ) ) { |
|
| 398 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 396 | + foreach ($this->get_attribute_keys() as $key) { |
|
| 397 | + if (!in_array($key, $this->hidden)) { |
|
| 398 | + $attributes[$key] = $this->get_attribute($key); |
|
| 399 | 399 | } |
| 400 | 400 | } |
| 401 | 401 | } else { |
| 402 | 402 | // If nothing is hidden/visible, we'll grab and reveal everything. |
| 403 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
| 404 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
| 403 | + foreach ($this->get_attribute_keys() as $key) { |
|
| 404 | + $attributes[$key] = $this->get_attribute($key); |
|
| 405 | 405 | } |
| 406 | 406 | } |
| 407 | 407 | |
| 408 | - return array_map( function ( $attribute ) { |
|
| 409 | - if ( $attribute instanceof Serializes ) { |
|
| 408 | + return array_map(function($attribute) { |
|
| 409 | + if ($attribute instanceof Serializes) { |
|
| 410 | 410 | return $attribute->serialize(); |
| 411 | 411 | } |
| 412 | 412 | |
| 413 | 413 | return $attribute; |
| 414 | - }, $attributes ); |
|
| 414 | + }, $attributes); |
|
| 415 | 415 | } |
| 416 | 416 | |
| 417 | 417 | /** |
@@ -422,13 +422,13 @@ discard block |
||
| 422 | 422 | public function sync_original() { |
| 423 | 423 | $this->original = $this->attributes; |
| 424 | 424 | |
| 425 | - if ( $this->attributes[ self::OBJECT_KEY ] ) { |
|
| 426 | - $this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ]; |
|
| 425 | + if ($this->attributes[self::OBJECT_KEY]) { |
|
| 426 | + $this->original[self::OBJECT_KEY] = clone $this->attributes[self::OBJECT_KEY]; |
|
| 427 | 427 | } |
| 428 | 428 | |
| 429 | - foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) { |
|
| 430 | - if ( is_object( $item ) ) { |
|
| 431 | - $this->original[ $key ] = clone $item; |
|
| 429 | + foreach ($this->original[self::TABLE_KEY] as $key => $item) { |
|
| 430 | + if (is_object($item)) { |
|
| 431 | + $this->original[$key] = clone $item; |
|
| 432 | 432 | } |
| 433 | 433 | } |
| 434 | 434 | |
@@ -444,24 +444,24 @@ discard block |
||
| 444 | 444 | * |
| 445 | 445 | * @return bool |
| 446 | 446 | */ |
| 447 | - private function is_fillable( $name ) { |
|
| 447 | + private function is_fillable($name) { |
|
| 448 | 448 | // If this model isn't guarded, everything is fillable. |
| 449 | - if ( ! $this->is_guarded ) { |
|
| 449 | + if (!$this->is_guarded) { |
|
| 450 | 450 | return true; |
| 451 | 451 | } |
| 452 | 452 | |
| 453 | 453 | // If it's in the fillable array, then it's fillable. |
| 454 | - if ( in_array( $name, $this->fillable ) ) { |
|
| 454 | + if (in_array($name, $this->fillable)) { |
|
| 455 | 455 | return true; |
| 456 | 456 | } |
| 457 | 457 | |
| 458 | 458 | // If it's explicitly guarded, then it's not fillable. |
| 459 | - if ( in_array( $name, $this->guarded ) ) { |
|
| 459 | + if (in_array($name, $this->guarded)) { |
|
| 460 | 460 | return false; |
| 461 | 461 | } |
| 462 | 462 | |
| 463 | 463 | // If fillable hasn't been defined, then everything else fillable. |
| 464 | - return ! $this->fillable; |
|
| 464 | + return !$this->fillable; |
|
| 465 | 465 | } |
| 466 | 466 | |
| 467 | 467 | /** |
@@ -473,13 +473,13 @@ discard block |
||
| 473 | 473 | * |
| 474 | 474 | * @return $this |
| 475 | 475 | */ |
| 476 | - private function override_wp_object( $value ) { |
|
| 477 | - if ( is_object( $value ) ) { |
|
| 478 | - $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value ); |
|
| 476 | + private function override_wp_object($value) { |
|
| 477 | + if (is_object($value)) { |
|
| 478 | + $this->attributes[self::OBJECT_KEY] = $this->set_wp_object_constants($value); |
|
| 479 | 479 | } else { |
| 480 | - $this->attributes[ self::OBJECT_KEY ] = null; |
|
| 480 | + $this->attributes[self::OBJECT_KEY] = null; |
|
| 481 | 481 | |
| 482 | - if ( $this->uses_wp_object() ) { |
|
| 482 | + if ($this->uses_wp_object()) { |
|
| 483 | 483 | $this->create_wp_object(); |
| 484 | 484 | } |
| 485 | 485 | } |
@@ -494,8 +494,8 @@ discard block |
||
| 494 | 494 | * |
| 495 | 495 | * @return $this |
| 496 | 496 | */ |
| 497 | - private function override_table( array $value ) { |
|
| 498 | - $this->attributes[ self::TABLE_KEY ] = $value; |
|
| 497 | + private function override_table(array $value) { |
|
| 498 | + $this->attributes[self::TABLE_KEY] = $value; |
|
| 499 | 499 | |
| 500 | 500 | return $this; |
| 501 | 501 | } |
@@ -509,19 +509,19 @@ discard block |
||
| 509 | 509 | * @throws LogicException |
| 510 | 510 | */ |
| 511 | 511 | private function create_wp_object() { |
| 512 | - switch ( true ) { |
|
| 512 | + switch (true) { |
|
| 513 | 513 | case $this instanceof UsesWordPressPost: |
| 514 | - $object = new WP_Post( (object) array() ); |
|
| 514 | + $object = new WP_Post((object) array()); |
|
| 515 | 515 | break; |
| 516 | 516 | case $this instanceof UsesWordPressTerm: |
| 517 | - $object = new WP_Term( (object) array() ); |
|
| 517 | + $object = new WP_Term((object) array()); |
|
| 518 | 518 | break; |
| 519 | 519 | default: |
| 520 | 520 | throw new LogicException; |
| 521 | 521 | break; |
| 522 | 522 | } |
| 523 | 523 | |
| 524 | - $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object ); |
|
| 524 | + $this->attributes[self::OBJECT_KEY] = $this->set_wp_object_constants($object); |
|
| 525 | 525 | } |
| 526 | 526 | |
| 527 | 527 | /** |
@@ -535,12 +535,12 @@ discard block |
||
| 535 | 535 | * |
| 536 | 536 | * @return object |
| 537 | 537 | */ |
| 538 | - protected function set_wp_object_constants( $object ) { |
|
| 539 | - if ( $this instanceof UsesWordPressPost ) { |
|
| 538 | + protected function set_wp_object_constants($object) { |
|
| 539 | + if ($this instanceof UsesWordPressPost) { |
|
| 540 | 540 | $object->post_type = static::get_post_type(); |
| 541 | 541 | } |
| 542 | 542 | |
| 543 | - if ( $this instanceof UsesWordPressTerm ) { |
|
| 543 | + if ($this instanceof UsesWordPressTerm) { |
|
| 544 | 544 | $object->taxonomy = static::get_taxonomy(); |
| 545 | 545 | } |
| 546 | 546 | |
@@ -556,8 +556,8 @@ discard block |
||
| 556 | 556 | * |
| 557 | 557 | * @return mixed |
| 558 | 558 | */ |
| 559 | - public function __get( $name ) { |
|
| 560 | - return $this->get_attribute( $name ); |
|
| 559 | + public function __get($name) { |
|
| 560 | + return $this->get_attribute($name); |
|
| 561 | 561 | } |
| 562 | 562 | |
| 563 | 563 | /** |
@@ -569,21 +569,21 @@ discard block |
||
| 569 | 569 | * |
| 570 | 570 | * @throws PropertyDoesNotExistException If property isn't found. |
| 571 | 571 | */ |
| 572 | - public function get_attribute( $name ) { |
|
| 573 | - if ( $method = $this->has_map_method( $name ) ) { |
|
| 574 | - return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()}; |
|
| 572 | + public function get_attribute($name) { |
|
| 573 | + if ($method = $this->has_map_method($name)) { |
|
| 574 | + return $this->attributes[self::OBJECT_KEY]->{$this->{$method}()}; |
|
| 575 | 575 | } |
| 576 | 576 | |
| 577 | - if ( $method = $this->has_compute_method( $name ) ) { |
|
| 577 | + if ($method = $this->has_compute_method($name)) { |
|
| 578 | 578 | return $this->{$method}(); |
| 579 | 579 | } |
| 580 | 580 | |
| 581 | - if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) { |
|
| 582 | - return $this->attributes[ self::TABLE_KEY ][ $name ]; |
|
| 581 | + if (isset($this->attributes[self::TABLE_KEY][$name])) { |
|
| 582 | + return $this->attributes[self::TABLE_KEY][$name]; |
|
| 583 | 583 | } |
| 584 | 584 | |
| 585 | - if ( isset( $this->defaults[ $name ] ) ) { |
|
| 586 | - return $this->defaults[ $name ]; |
|
| 585 | + if (isset($this->defaults[$name])) { |
|
| 586 | + return $this->defaults[$name]; |
|
| 587 | 587 | } |
| 588 | 588 | |
| 589 | 589 | return null; |
@@ -598,16 +598,16 @@ discard block |
||
| 598 | 598 | * |
| 599 | 599 | * @throws PropertyDoesNotExistException If property isn't found. |
| 600 | 600 | */ |
| 601 | - public function get_original_attribute( $name ) { |
|
| 601 | + public function get_original_attribute($name) { |
|
| 602 | 602 | $original_attributes = $this->original; |
| 603 | 603 | |
| 604 | - if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) { |
|
| 605 | - unset( $original_attributes[ static::OBJECT_KEY ] ); |
|
| 604 | + if (!is_object($original_attributes[static::OBJECT_KEY])) { |
|
| 605 | + unset($original_attributes[static::OBJECT_KEY]); |
|
| 606 | 606 | } |
| 607 | 607 | |
| 608 | - $original = new static( $original_attributes ); |
|
| 608 | + $original = new static($original_attributes); |
|
| 609 | 609 | |
| 610 | - return $original->get_attribute( $name ); |
|
| 610 | + return $original->get_attribute($name); |
|
| 611 | 611 | } |
| 612 | 612 | |
| 613 | 613 | /** |
@@ -619,16 +619,16 @@ discard block |
||
| 619 | 619 | * @throws LogicException |
| 620 | 620 | */ |
| 621 | 621 | public function get_primary_id() { |
| 622 | - if ( $this instanceof UsesWordPressPost ) { |
|
| 622 | + if ($this instanceof UsesWordPressPost) { |
|
| 623 | 623 | return $this->get_underlying_wp_object()->ID; |
| 624 | 624 | } |
| 625 | 625 | |
| 626 | - if ( $this instanceof UsesWordPressTerm ) { |
|
| 626 | + if ($this instanceof UsesWordPressTerm) { |
|
| 627 | 627 | return $this->get_underlying_wp_object()->term_id; |
| 628 | 628 | } |
| 629 | 629 | |
| 630 | - if ( $this instanceof UsesCustomTable ) { |
|
| 631 | - return $this->get_attribute( $this->get_primary_key() ); |
|
| 630 | + if ($this instanceof UsesCustomTable) { |
|
| 631 | + return $this->get_attribute($this->get_primary_key()); |
|
| 632 | 632 | } |
| 633 | 633 | |
| 634 | 634 | // Model w/o wp_object not yet supported. |
@@ -646,8 +646,8 @@ discard block |
||
| 646 | 646 | * |
| 647 | 647 | * @return false|string |
| 648 | 648 | */ |
| 649 | - protected function has_map_method( $name ) { |
|
| 650 | - if ( method_exists( $this, $method = "map_{$name}" ) ) { |
|
| 649 | + protected function has_map_method($name) { |
|
| 650 | + if (method_exists($this, $method = "map_{$name}")) { |
|
| 651 | 651 | return $method; |
| 652 | 652 | } |
| 653 | 653 | |
@@ -664,8 +664,8 @@ discard block |
||
| 664 | 664 | * |
| 665 | 665 | * @return false|string |
| 666 | 666 | */ |
| 667 | - protected function has_compute_method( $name ) { |
|
| 668 | - if ( method_exists( $this, $method = "compute_{$name}" ) ) { |
|
| 667 | + protected function has_compute_method($name) { |
|
| 668 | + if (method_exists($this, $method = "compute_{$name}")) { |
|
| 669 | 669 | return $method; |
| 670 | 670 | } |
| 671 | 671 | |
@@ -687,12 +687,12 @@ discard block |
||
| 687 | 687 | $this->get_wp_object_keys() |
| 688 | 688 | ); |
| 689 | 689 | |
| 690 | - foreach ( $keys as $key ) { |
|
| 690 | + foreach ($keys as $key) { |
|
| 691 | 691 | try { |
| 692 | - $this->set_attribute( $key, null ); |
|
| 693 | - } catch ( Exception $e ) { |
|
| 692 | + $this->set_attribute($key, null); |
|
| 693 | + } catch (Exception $e) { |
|
| 694 | 694 | // We won't clear out guarded attributes. |
| 695 | - if ( ! ( $e instanceof GuardedPropertyException ) ) { |
|
| 695 | + if (!($e instanceof GuardedPropertyException)) { |
|
| 696 | 696 | throw $e; |
| 697 | 697 | } |
| 698 | 698 | } |
@@ -727,13 +727,13 @@ discard block |
||
| 727 | 727 | * @return array |
| 728 | 728 | */ |
| 729 | 729 | protected function get_compute_methods() { |
| 730 | - $methods = get_class_methods( get_called_class() ); |
|
| 731 | - $methods = array_filter( $methods, function ( $method ) { |
|
| 732 | - return strrpos( $method, 'compute_', - strlen( $method ) ) !== false; |
|
| 730 | + $methods = get_class_methods(get_called_class()); |
|
| 731 | + $methods = array_filter($methods, function($method) { |
|
| 732 | + return strrpos($method, 'compute_', - strlen($method)) !== false; |
|
| 733 | 733 | } ); |
| 734 | - $methods = array_map( function ( $method ) { |
|
| 735 | - return substr( $method, strlen( 'compute_' ) ); |
|
| 736 | - }, $methods ); |
|
| 734 | + $methods = array_map(function($method) { |
|
| 735 | + return substr($method, strlen('compute_')); |
|
| 736 | + }, $methods); |
|
| 737 | 737 | |
| 738 | 738 | return $methods; |
| 739 | 739 | } |
@@ -742,8 +742,8 @@ discard block |
||
| 742 | 742 | * Sets up the memo array for the creating model. |
| 743 | 743 | */ |
| 744 | 744 | private function maybe_boot() { |
| 745 | - if ( ! isset( self::$memo[ get_called_class() ] ) ) { |
|
| 746 | - self::$memo[ get_called_class() ] = array(); |
|
| 745 | + if (!isset(self::$memo[get_called_class()])) { |
|
| 746 | + self::$memo[get_called_class()] = array(); |
|
| 747 | 747 | } |
| 748 | 748 | } |
| 749 | 749 | |