mcustiel/typed-php

There is no license information available for the latest version (v0.8.0) of this package.

Object wrappers for primitives and typed arrays in PHP

v0.8.0 2017-03-19 20:59 UTC

This package is auto-updated.

Last update: 2022-06-19 05:17:55 UTC


README

Immutable Object representation for PHP primitive types and Typed Arrays in PHP.

Build Status Code Coverage Scrutinizer Code Quality

Motivations

In PHP versions 5.5 and 5.6 type hinting is supported for classes and arrays, but not for scalar types. In PHP version 7, type hinting for scalar types is supported, but not typed arrays. So I created object wrappers for scalar types that can be used in PHP 5 and also typed arrays that can be used in PHP7. These objects can be extended to create your own ValueObjects suitable for your domain.

Installation

Composer

"require": {
    "mcustiel/typed-php": "*"
}

How to use

All wrappers implement Primitive interface:

interface Primitive
{
    /**
     * @return mixed
     */
    public function value();
}

Also all of them return themselves as string, through implementation of __toString magic method. So you can echo them directly.

Primitives

  • DoubleValue
  • IntegerValue
  • StringValue
  • BooleanValue

Arrays:

There are two base types:

  • PrimitivesArray
  • ObjectsArray

PrimitivesArray

PrimitivesArray object allows a collection of variables an internal PHP type. And there are already three classes using it:

  • DoubleArray
  • IntegerArray
  • StringArray
  • BooleanArray

All of them are constructed with an array as argument. If there is a value in the array of a type that is not correct, an exception will be thrown.

ObjectsArray

This type allows a collection of instances of a given class. An example to create a type for this is as follow:

use Mcustiel\TypedPhp\ValueObjects\Multiple\ObjectsArray;

class Foo 
{
    private function bar()
    {
        echo 'I am Bar';
    }
}

class FooArray extends ObjectsArray
{
    public function __construct(array $array)
    {
        parent::__construct(Foo::class, $array);
    }
}

That's it, you have an array type that accepts only Foo objects. In your code you can use any FooArray object as a regular array.

If there are classes that extend Foo, FooArray will allow them, so polymorphism is supported.

Immutable arrays

For each array type provider there is an immutable version, that allows to be created with a set of values and is not allowed to change.

  • ImmutableDoubleArray
  • ImmutableIntegerArray
  • ImmutableStringArray
  • ImmutableBooleanArray

Flyweight implementation

A basic flyweight pattern implementation is provided. It will return the exact same value object on multiple calls:

use Mcustiel\TypedPhp\Values\IntegerCreator;

$a = IntegerCreator::instance()->getValueObject(5);
$b = IntegerCreator::instance()->getValueObject(5);

In this example $a and $b reference the exact same instance of IntegerValue.