kamilwylegala/immutable-setter

Utility class for PHP that helps making your classes immutable.

0.1.1 2018-06-02 16:23 UTC

Requires

• php: >=5.4.0

Requires (Dev)

• phpunit/phpunit: 5.4.*

MIT

• Kamil Wylegala

• immutable
• setter
• wither

README

Tiny utillity class that helps you making your classes immutable by adding wither methods.

Inspired by Lombok's @Wither annotation.

It lets you easily add witherX methods to clone object with modified one property.

Installation

Use composer to get library from packagist:

$ php composer.phar require kamilwylegala/immutable-setter

Usage

1. Add wither field to your class.
2. Assign new Wither($this, ["arg1", "arg2"]) to this field and provide constructor schema with proper order of arguments. You can also skip second argument and let Wither resolve constructor arguments automatically.
3. Add public withArg1 method to your class and put:

return $this->wither->getInstance("arg1", $newArg1)

1. Running $valueObject->withArg1($newArg1) will create copy of your object with changed $arg1 field.

Example

use KamilWylegala\ImmutableSetter\Wither;

class Person
{

    private $name;
    private $age;

    private $wither;

    public function __construct($name, $age)
    {
        $this->name = $name;
        $this->age = $age;

        $this->wither = new Wither($this, ["name", "age"]); //Second param is optional.
    }

    public function withName($newName)
    {
        return $this->wither->getInstance("name", $newName);   
    }

}

Tests

Install dev dependencies and run in root:

$ vendor/bin/phpunit

Licence

MIT