benrowe/properties

A simple runtime package for handling properties on a class

Properties

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Adds the ability to add properties to a class at runtime., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require benrowe/properties, <sub>(*4)</sub>

## Usage

``` php
class Sample extends AbstractBase
{
    public function __construct()
    {
        // do stuff
        $this->configureProperties();
        // properties now available
    }

    /**
     * This method is automatically called by AbstractBase once
     * the constructor has finished executing
     */
    public function configureProperties()
    {
        $this->
            addProperty('simple')

        $this
            ->addProperty('complex', 'string', 'default value')
            ->setter(function($value) {
                return trim($value);
            })
            ->getter(function($value) {
                return str_reverse($value);
            })
            ->validate(function ($value) {
                return strlen($value) > 0;
            });

    }
}

$sample = new Sample;
$sample->simple = 'test';
$sample->undefined = 'newval'; // throws PropertyException "Undefined property 'undefined'"
$sample->complex; // 'default value'
$sample->complex = ''; // throws PropertyException "property 'complex' invalid value on set"
$sample->complex = ' hello world';
echo $sample->complex; //'dlrow olleh';

Each property is defined programatically (at runtime), and requires the class to run this code (with a hook)., <sub>(*5)</sub>

Each property can have a, <sub>(*6)</sub>

• name:string
• data type(s): string
• validation: string|closure
• setter: closure
• getter:string
• default value (null): mixed
• value: mixed (depends on data type/validation/setter)

TODO

• add the ability for a setter to reject a value by throwing an exception
• build custom validation support for setting the value
  • instead of providing a closure for the setter, provide a laravel style validation string.
  • add a helper function to restrict the setter to a list of known values $this->addProperty('key')->isIn(['foo', 'bar']);

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*7)</sub>

Testing

bash $ composer test, <sub>(*8)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*9)</sub>

Security

If you discover any security related issues, please email ben.rowe.83@gmail.com instead of using the issue tracker., <sub>(*10)</sub>

Credits

• Ben Rowe
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*11)</sub>