aedart/athenaeum-properties

Provides means to dynamically deal with inaccessible properties, by implementing some of PHP's magic methods

8.17.0 2024-11-28 08:52 UTC

Requires

• php: ^8.2
• aedart/athenaeum-contracts: ^8.17
• aedart/athenaeum-utils: ^8.17

BSD-3-Clause

• Alin Eugen Deac

• properties
• overloading
• magic methods
• Athenaeum

README

Provides means to dynamically deal with inaccessible properties, by implementing some of PHP's magic methods.

The usage of getters- and setters-methods is enforced, ensuring that if a property is indeed available, its corresponding getter or setter method will be invoked.

The term 'overload', in this context, refers to PHP’s own definition hereof.

Example

use Aedart\Properties\Overload;

/**
 * @property string|null $name Name of a person
 */
class Person
{
    use Overload;
    
    protected ?string $name = null;
    
    public function getName() : string
    {
	    return $this->name;
    }

    public function setName(string $value)
    {
        if(empty($value)){
            throw new InvalidArgumentException('Provided name is invalid');
        }
        
        $this->name = $value;
        
        return $this;
    }
}

Elsewhere in your application, you can invoke the following:

$person = new Person();
$person->name = 'Alin'; // Invokes the setName(...)

echo $person->name;	// Invokes the getName(), then outputs 'Alin'
echo isset($person->name); // Invokes the __isset(), then outputs true

unset($person->name); // Invokes the __unset() and destroys the name property

Documentation

Please read the official documentation for additional information.

Repository

The mono repository is located at github.com/aedart/athenaeum

Versioning

This package follows Semantic Versioning 2.0.0

License

BSD-3-Clause, Read the LICENSE file included in this package