2.0 — Refactor: Reasonable model methods and properties are made static

.github/workflows/tests-php.yml

@@ -10,15 +10,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 1000
           submodules: recursive
       # ------------------------------------------------------------------------------
       # Checkout slic
       # ------------------------------------------------------------------------------
       - name: Checkout slic
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           repository: stellarwp/slic
           ref: main
@@ -30,8 +30,8 @@ jobs:
       - name: Get Composer Cache Directory
         id: get-composer-cache-dir
         run: |
-          echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - uses: actions/cache@v2
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
         id: composer-cache
         with:
           path: ${{ steps.get-composer-cache-dir.outputs.dir }}

README.md

@@ -68,7 +68,7 @@ class Breakfast_Model extends Model {
 	/**
 	 * @inheritDoc
 	 */
-	protected $properties = [
+	protected static $properties = [
 		'id'        => 'int',
 		'name'      => 'string',
 		'price'     => 'float',
@@ -95,7 +95,7 @@ class Breakfast_Model extends Model implements Contracts\ModelReadOnly {
 	/**
 	 * @inheritDoc
 	 */
-	protected $properties = [
+	protected static $properties = [
 		'id'        => 'int',
 		'name'      => 'string',
 		'price'     => 'float',
@@ -136,7 +136,7 @@ class Breakfast_Model extends Model implements Contracts\ModelCrud {
 	/**
 	 * @inheritDoc
 	 */
-	protected $properties = [
+	protected static $properties = [
 		'id'        => 'int',
 		'name'      => 'string',
 		'price'     => 'float',
@@ -199,7 +199,7 @@ class Breakfast_Model extends Model {
 	/**
 	 * @inheritDoc
 	 */
-	protected $properties = [
+	protected static $properties = [
 		'id'        => 'int',
 		'name'      => 'string',
 		'price'     => 'float',

src/Models/Config.php

@@ -103,4 +103,8 @@ public static function setInvalidArgumentException( string $class ) {
 
 		static::$invalidArgumentException = $class;
 	}
+
+	public static function throwInvalidArgumentException( string $message ) {
+		throw new static::$invalidArgumentException( $message );
+	}
 }

src/Models/Contracts/Model.php

@@ -61,13 +61,14 @@ public function getOriginal( string $key = null );
 	/**
 	 * Determines if the model has the given property.
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
 	 * @param string $key Property name.
 	 *
 	 * @return bool
 	 */
-	public function hasProperty( string $key ) : bool;
+	public static function hasProperty( string $key ) : bool;
 
 	/**
 	 * Determines if a given attribute is clean.
@@ -94,18 +95,20 @@ public function isDirty( string $attribute = null ) : bool;
 	/**
 	 * Validates an attribute to a PHP type.
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
 	 * @param string $key   Attribute name.
 	 * @param mixed  $value Attribute value.
 	 *
 	 * @return bool
 	 */
-	public function isPropertyTypeValid( string $key, $value ) : bool;
+	public static function isPropertyTypeValid( string $key, $value ) : bool;
 
 	/**
 	 * Returns the property keys.
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
 	 * @return int[]|string[]

src/Models/Model.php

@@ -26,16 +26,16 @@ abstract class Model implements ModelInterface, Arrayable, JsonSerializable {
 	/**
 	 * The model properties assigned to their types.
 	 *
-	 * @var array<string,string>
+	 * @var array<string,string|array>
 	 */
-	protected $properties = [];
+	static protected $properties = [];
 
 	/**
 	 * The model relationships assigned to their relationship types.
 	 *
 	 * @var array<string,string>
 	 */
-	protected $relationships = [];
+	static protected $relationships = [];
 
 	/**
 	 * Relationships that have already been loaded and don't need to be loaded again.
@@ -52,7 +52,7 @@ abstract class Model implements ModelInterface, Arrayable, JsonSerializable {
 	 * @param array<string,mixed> $attributes Attributes.
 	 */
 	public function __construct( array $attributes = [] ) {
-		$this->fill( array_merge( $this->getPropertyDefaults(), $attributes ) );
+		$this->fill( array_merge( static::getPropertyDefaults(), $attributes ) );
 
 		$this->syncOriginal();
 	}
@@ -87,7 +87,7 @@ public function fill( array $attributes ) : ModelInterface {
 	 * @throws RuntimeException
 	 */
 	public function getAttribute( string $key, $default = null ) {
-		$this->validatePropertyExists( $key );
+		static::validatePropertyExists( $key );
 
 		return $this->attributes[ $key ] ?? $default;
 	}
@@ -133,34 +133,36 @@ public function getOriginal( string $key = null ) {
 	 * @return boolean
 	 */
 	public function isSet( string $key ): bool {
-		return array_key_exists( $key, $this->attributes ) || $this->hasDefault( $key );
+		return array_key_exists( $key, $this->attributes ) || static::hasDefault( $key );
 	}
 
 	/**
 	 * Check if there is a default value for a property.
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.2.2
 	 *
 	 * @param string $key Property name.
 	 *
 	 * @return bool
 	 */
-	protected function hasDefault( string $key ): bool {
-		return is_array( $this->properties[ $key ] ) && array_key_exists( 1, $this->properties[ $key ] );
+	protected static function hasDefault( string $key ): bool {
+		return is_array( static::$properties[ $key ] ) && array_key_exists( 1, static::$properties[ $key ] );
 	}
 
 	/**
 	 * Returns the default value for a property if one is provided, otherwise null.
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
 	 * @param string $key Property name.
 	 *
 	 * @return mixed|null
 	 */
-	protected function getPropertyDefault( string $key ) {
-		if ( $this->hasDefault( $key ) ) {
-			return $this->properties[ $key ][1];
+	protected static function getPropertyDefault( string $key ) {
+		if ( static::hasDefault( $key ) ) {
+			return static::$properties[ $key ][1];
 		}
 
 		return null;
@@ -169,15 +171,16 @@ protected function getPropertyDefault( string $key ) {
 	/**
 	 * Returns the defaults for all the properties. If a default is omitted it defaults to null.
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
 	 * @return array<string,mixed>
 	 */
-	protected function getPropertyDefaults() : array {
+	protected static function getPropertyDefaults() : array {
 		$defaults = [];
-		foreach ( array_keys( $this->properties ) as $property ) {
-			if ( $this->hasDefault( $property ) ) {
-				$defaults[ $property ] = $this->getPropertyDefault( $property );
+		foreach ( array_keys( static::$properties ) as $property ) {
+			if ( static::hasDefault( $property ) ) {
+				$defaults[ $property ] = static::getPropertyDefault( $property );
 			}
 		}
 
@@ -194,7 +197,7 @@ protected function getPropertyDefaults() : array {
 	 * @return string
 	 */
 	protected function getPropertyType( string $key ) : string {
-		$type = is_array( $this->properties[ $key ] ) ? $this->properties[ $key ][0] : $this->properties[ $key ];
+		$type = is_array( static::$properties[ $key ] ) ? static::$properties[ $key ][0] : static::$properties[ $key ];
 
 		return strtolower( trim( $type ) );
 	}
@@ -262,14 +265,15 @@ protected function hasCachedRelationship( string $key ) : bool {
 	/**
 	 * Determines if the model has the given property.
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
 	 * @param string $key Property name.
 	 *
 	 * @return bool
 	 */
-	public function hasProperty( string $key ) : bool {
-		return array_key_exists( $key, $this->properties );
+	public static function hasProperty( string $key ) : bool {
+		return array_key_exists( $key, static::$properties );
 	}
 
 	/**
@@ -305,19 +309,20 @@ public function isDirty( string $attribute = null ) : bool {
 	/**
 	 * Validates an attribute to a PHP type.
 	 *
+	 * @since 2.0.0
 	 * @since 1.0.0
 	 *
 	 * @param string $key   Property name.
 	 * @param mixed  $value Property value.
 	 *
 	 * @return bool
 	 */
-	public function isPropertyTypeValid( string $key, $value ) : bool {
+	public static function isPropertyTypeValid( string $key, $value ) : bool {
 		if ( is_null( $value ) ) {
 			return true;
 		}
 
-		$type = $this->getPropertyType( $key );
+		$type = static::getPropertyType( $key );
 
 		switch ( $type ) {
 			case 'int':
@@ -357,7 +362,7 @@ public function jsonSerialize() {
 	 * @return int[]|string[]
 	 */
 	public static function propertyKeys() : array {
-		return array_keys( ( new static() )->properties );
+		return array_keys( static::$properties );
 	}
 
 	/**
@@ -428,14 +433,15 @@ public function toArray() : array {
 	/**
 	 * Validates that the given property exists
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
 	 * @param string $key Property name.
 	 *
 	 * @return void
 	 */
-	protected function validatePropertyExists( string $key ) {
-		if ( ! $this->hasProperty( $key ) ) {
+	protected static function validatePropertyExists( string $key ) {
+		if ( ! static::hasProperty( $key ) ) {
 			$exception = Config::getInvalidArgumentException();
 			throw new $exception( "Invalid property. '$key' does not exist." );
 		}
@@ -444,16 +450,17 @@ protected function validatePropertyExists( string $key ) {
 	/**
 	 * Validates that the given value is a valid type for the given property.
 	 *
+	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
 	 * @param string $key   Property name.
 	 * @param mixed  $value Property value.
 	 *
 	 * @return void
 	 */
-	protected function validatePropertyType( string $key, $value ) {
-		if ( ! $this->isPropertyTypeValid( $key, $value ) ) {
-			$type = $this->getPropertyType( $key );
+	protected static function validatePropertyType( string $key, $value ) {
+		if ( ! static::isPropertyTypeValid( $key, $value ) ) {
+			$type = static::getPropertyType( $key );
 
 			$exception = Config::getInvalidArgumentException();
 			throw new $exception( "Invalid attribute assignment. '$key' should be of type: '$type'" );
@@ -470,7 +477,7 @@ protected function validatePropertyType( string $key, $value ) {
 	 * @return mixed
 	 */
 	public function __get( string $key ) {
-		if ( array_key_exists( $key, $this->relationships ) ) {
+		if ( array_key_exists( $key, static::$relationships ) ) {
 			return $this->getRelationship( $key );
 		}
 

tests/_support/Helper/MockModel.php

@@ -5,7 +5,7 @@
 use StellarWP\Models\Model;
 
 class MockModel extends Model {
-	protected $properties = [
+	protected static $properties = [
 		'id'           => 'int',
 		'firstName'    => [ 'string', 'Michael' ],
 		'lastName'     => 'string',

tests/_support/Helper/MockModelWithRelationship.php

@@ -8,11 +8,11 @@
 use StellarWP\Models\ValueObjects\Relationship;
 
 class MockModelWithRelationship extends Model {
-	protected $properties = [
+	protected static $properties = [
 		'id' => 'int',
 	];
 
-	protected $relationships = [
+	protected static $relationships = [
 		'relatedButNotCallable'     => Relationship::HAS_ONE,
 		'relatedAndCallableHasOne'  => Relationship::HAS_ONE,
 		'relatedAndCallableHasMany' => Relationship::HAS_MANY,

tests/wpunit/ModelFactoryTest.php

@@ -320,7 +320,7 @@ class MockModel extends Model
 {
 	protected static $autoIncrementId = 1;
 
-	protected $properties = [
+	protected static $properties = [
 		'id' => 'int',
 	];
 
@@ -342,7 +342,7 @@ public static function resetAutoIncrementId() {
  */
 class MockModelWithDependency extends MockModel
 {
-	protected $properties = [
+	protected static $properties = [
 		'id' => 'int',
 		'nestedId' => 'int',
 	];
@@ -363,7 +363,7 @@ abstract public function __invoke();
  */
 class MockModelWithInvokableProperty extends MockModel
 {
-	protected $properties = [
+	protected static $properties = [
 		'invokable' => MockInvokableClass::class,
 	];
 }

tests/wpunit/ModelTest.php

@@ -110,9 +110,7 @@ public function testSetAttributeShouldAssignPropertyValue() {
 	 * @return void
 	 */
 	public function testIsPropertyTypeValidShouldReturnTrueWhenPropertyIsValid() {
-		$model = new MockModel();
-
-		$this->assertTrue( $model->isPropertyTypeValid( 'id', 1 ) );
+		$this->assertTrue( MockModel::isPropertyTypeValid( 'id', 1 ) );
 	}
 
 	/**
@@ -123,9 +121,7 @@ public function testIsPropertyTypeValidShouldReturnTrueWhenPropertyIsValid() {
 	 * @return void
 	 */
 	public function testIsPropertyTypeValidShouldReturnFalseWhenPropertyIsInValid( $key, $value ) {
-		$model = new MockModel();
-
-		$this->assertFalse( $model->isPropertyTypeValid( $key, $value ) );
+		$this->assertFalse( MockModel::isPropertyTypeValid( $key, $value ) );
 	}
 
 	/**