tleckie/value-object

PHP value-object. Library to implement value-object / nullable-value-object in PHP

1.0.2 2021-05-09 09:07 UTC

This package is auto-updated.

Last update: 2022-06-13 11:04:16 UTC


README

Scrutinizer Code Quality Build Status Total Downloads Code Intelligence Status

Create your own value-object type:

You should only extend from the ValueObject class

<?php

/**
 * Class Age
 */
class Age extends ValueObject
{

}

Compare value-objects:

<?php

/**
 * Class Age
 */
class Age extends ValueObject
{

}

$john = new Age(34);
$mario = new Age(34);
$raquel = new Age("34");


$john->equals($mario);  // true

$john->equals($raquel); // false

$john->equals(new FirstName('Mario')); // false

$raquel->value();       // "34"

Force primitive type:

Override value() method to indicate the return primitive type.

<?php

/**
 * Class Age
 */
class Age extends ValueObject
{
    /**
    * @return int
    */
    public function value(): int
    {
        return parent::value();
    }
}

$raquel = new Age("34");
$mario = new Age(34);

$raquel->value();        // int 34

$mario->equals($raquel); // true

(string)$mario;          // string "34"

Nullable value-object

If your object can contain null value you can extend of NullableValueObject class

<?php

/**
 * Class Age
 */
class Age extends NullableValueObject
{

}

// That's all! I hope this helps you