dbx12/base-object

Configurable objects, inspired by the Yii2 framework.

v1.0.1 2021-11-22 09:16 UTC

Requires (Dev)

• codeception/assert-throws: ^1.1
• codeception/codeception: ^4.1
• codeception/module-asserts: ^1.0
• codeception/specify: ^1.4
• roave/security-advisories: dev-latest

MIT

• DBX12

README

This library is heavily inspired by the configurable objects of the Yii2 framework

Installation

As with any composer library:

composer require dbx12/base-object

Concept

The base object allows you to set the properties of a class with a configuration array. By default, only public and protected properties can be set this way. If you want to set a private property, define a setter for it. The pattern for setter is set + property name, e.g. for the property $name -> function setName($value). The getter names are created similar (for the same example: function getName()).

If you expose your private or protected properties with public setters and getters, you can help your IDE by annotating your class with @property-read and @property-write annotations. If you have a getter and a setter, you can combine them into @property. For above example (without the setter), you would write @property-write string $name.

Usage

Default (Without setter)

class MyObject extends \dbx12\baseObject\BaseObject {
    public $publicVariable;
    protected $protectedVariable;
    private $privateVariable;
}

// this will fail with an UnknownPropertyException because setting $privateVariable is not allowed
$instance = new MyObject([
    'publicVariable' => 'publicValue',
    'protectedVariable' => 'protectedValue',
    'privateVariable' => 'privateValue',
]);

With protected setter

class MyObject extends \dbx12\baseObject\BaseObject {
    public $publicVariable;
    protected $protectedVariable;
    private $privateVariable;
    
    protected function setPrivateVariable($value): void
    {
        $this->privateVariable = $value;
    }
}

// this will succeed
$instance = new MyObject([
    'publicVariable' => 'publicValue',
    'protectedVariable' => 'protectedValue',
    'privateVariable' => 'privateValue',
]);

// and this will produce an error as the setter is not visible from the global scope
$myObject->setPrivateVariable('bar');

Without a public getter

class MyObject extends \dbx12\baseObject\BaseObject {
    public $publicVariable;
    protected $protectedVariable;
    private $privateVariable;

    protected function setPrivateVariable($value): void
    {
        $this->privateVariable = $value;
    }
}

$myObject = new MyObject([
    'publicVariable' => 'publicValue',
    'protectedVariable' => 'protectedValue',
    'privateVariable' => 'privateValue',
]);

// this will throw an UnknownPropertyException
echo $myObject->protectedVariable;

With a public getter

/**
 * @property-read $protectedVariable
 */
class MyObject extends \dbx12\baseObject\BaseObject {
    public $publicVariable;
    protected $protectedVariable;
    private $privateVariable;

    protected function setPrivateVariable($value): void
    {
        $this->privateVariable = $value;
    }

    public function getProtectedVariable()
    {
        return $this->protectedVariable;
    }
}

$myObject = new MyObject([
    'publicVariable' => 'publicValue',
    'protectedVariable' => 'protectedValue',
    'privateVariable' => 'privateValue',
]);

// this will succeed
echo $myObject->getProtectedVariable();

// this will succeed and your IDE will show you a hint for it thanks to the @property-read annotation
echo $myObject->protectedVariable;