takeoto/attributable

Abstraction for objects with custom attributes.

0.1 2023-05-04 13:58 UTC

Requires

• php: >=7.4

MIT

• Vladysalv Vernyhora

• php
• abstraction
• dto
• takeoto
• attributable

README

Abstraction for objects with custom attributes

Usage

use Takeoto\Attributable\Contract\ReadableAttributesInterface;
use Takeoto\Attributable\Contract\WritableAttributesInterface;
use Takeoto\Attributable\TraitReadableAttributes;
use Takeoto\Attributable\TraitWriteableAttributes;

# --- Readable attributes

class SomeClassReadable implements ReadableAttributesInterface
{
    use TraitReadableAttributes;

    /**
     * @param mixed[] $attributes
     */
    public function __construct(private array $attributes = [])
    {
    }

    # some class logic ...
}

$object = new SomeClassReadable([
    'someAttribute' => 'someValue',
    'someAttribute1' => 'someValue1',
]);

if ($object->hasAttr('someAttribute')) { # true
    echo $object->getAttr('someAttribute'); # "someValue"
}

$object->getAttrs(); # [ 'someAttribute' => 'someValue', 'someAttribute1' => 'someValue1' ]
$object->getAttr('undefinedAttribute'); # throws an exception

# --- Writable attributes

class SomeClassWritable implements WritableAttributesInterface
{
    use TraitWriteableAttributes;
    # some class logic ...
}

$object = new SomeClassWritable();
$object->setAttr('someAttribute', 'someValue');
$object->unsetAttr('someAttribute');