README

A small collection of the most basic value objects. These can help make your code more expressive, and save some manual validation.

Install

All the available versions is visible on Packagist.

Via Composer

$ composer require martindilling/basicvalueobjects

Usage

Using these value objects you can type-hint method arguments to make it more sure the arguments will be given in the right format.

In this example the fields will hold instances of the value objects.

use BasicValueObjects\String;
use BasicValueObjects\Integer;
use BasicValueObjects\Boolean;

class CrewMember
{
    /** @var \BasicValueObjects\String */
    private $firstname;

    /** @var \BasicValueObjects\String */
    private $lastname;

    /** @var \BasicValueObjects\Integer */
    private $age;

    /** @var \BasicValueObjects\Boolean */
    private $captain;

    function __construct(String $firstname, String $lastname, Integer $age, Boolean $captain)
    {
        $this->firstname = $firstname;
        $this->lastname  = $lastname;
        $this->age       = $age;
        $this->captain   = $captain;
    }
}

$person = new CrewMember(
    new String('Malcolm'),
    new String('Reynolds'),
    new Integer(49),
    Boolean::true()
);

If you don't want the fields on the object to hold the instances but want the type-hinting, you can just assign the native value of the value object to the fields:

use BasicValueObjects\String;
use BasicValueObjects\Integer;
use BasicValueObjects\Boolean;

class CrewMember
{
    /** @var string */
    private $firstname;

    /** @var string */
    private $lastname;

    /** @var int */
    private $age;

    /** @var bool */
    private $captain;

    function __construct(String $firstname, String $lastname, Integer $age, Boolean $captain)
    {
        $this->firstname = $firstname->native();
        $this->lastname  = $lastname->native();
        $this->age       = $age->native();
        $this->captain   = $captain->native();
    }
}

$person = new CrewMember(
    new String('River'),
    new String('Tam'),
    new Integer('28'),
    Boolean::false()
);

Demonstration of how to work with the value objects:

// String
$shiny = new String("Everything's shiny, Cap'n. Not to fret.");
$fool  = new String("Oh, she'll fool ya.");

$shiny->native();       // (string) Everything's shiny, Cap'n. Not to fret.
$fool->__toString();    // (string) Oh, she'll fool ya.
$shiny->equals($fool);  // (bool) false

// Integer
$integer1 = new Integer(42);
$integer2 = new Integer(37);

$integer1->native();           // (integer) 42
$integer2->__toString();       // (string) 37
$integer1->equals($integer2);  // (bool) false

// Boolean
$boolean1 = new Boolean(true);
$boolean2 = new Boolean(Boolean::TRUE);
$boolean3 = Boolean::false();

$boolean1->native();           // (bool) true
$boolean2->__toString();       // (string) true
$boolean1->equals($boolean2);  // (bool) true
$boolean1->equals($boolean3);  // (bool) false

Testing

$ phpunit

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email martindilling@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

martindilling / basicvalueobjects

Maintainers

Details