php immutable collections Télécharger - php immutable collections Téléchargement du code source

php immutable collections

Autres catégories

versions

Télécharger

Collections immuables minimalistes et typées pour PHP

Une bibliothèque qui fournit un ensemble de collections immuables minimalistes, typées et canalisées pour PHP.

Exigences

PHP > 7.2

Installation

composer require dcsg/php-immutable-collections

Quels problèmes cela résout-il ?

Le manque de Génériques en PHP ne permet pas d'avoir des collections typées en PHP.

Cette bibliothèque fournit deux collections abstraites immuables :

Collection de listes immuables - ImmutableCollection
Collection d'ensembles immuables - SetImmutableCollection

Pourquoi des collections immuables typées

Collections typées

Puisque PHP n'a pas de génériques comme Java, il n'est pas possible d'avoir des collections typées natives. Les collections disponibles dans cette bibliothèque constituent la base sur laquelle vous pouvez créer vos propres collections typées, il vous suffit de les étendre.

Collections immuables typées pour DDD (Domain Driven Design)

DDD consiste à ce que votre code parle le langage des affaires, appelé langage omniprésent. Sans collections en PHP, cela est très difficile à réaliser en utilisant Arrays car vous ne pouvez pas leur ajouter de comportement. Donc, ce qui se passe habituellement, vous ajoutez ce comportement à votre entité mais il ne devrait pas être là. Un autre problème est la mutabilité des Arrays , VOs (Value Objects) DOIVENT être toujours immuables et c'est impossible avec Arrays et vous devez toujours garantir que les elements de ce Array sont tous du même type.

Collections et tableaux

Collections et Arrays représentent tous deux un groupe d'éléments.
Collections ne sont pas nativement prises en charge par PHP, contrairement Arrays .
Arrays sont LA structure de données de PHP et sont utilisés pour presque tout.
Arrays ne vous permettent pas d'ajouter de nouveaux comportements alors que Collections le permettent.
Arrays ne vous permettent pas de définir un type pour ses éléments alors que Collections le permettent.

Autres collections PHP

Il existe d'autres collections pour PHP, pour n'en citer que quelques-unes : Doctrine Collections et Illuminate Collections. Ces collections résolvent différents problèmes, sont adaptées à leur cas d'utilisation spécifique, et leurs API sont étendues et plus importantes encore, ces collections sont mutables. Ces combinaisons rendent difficile l'utilisation de ces collections pour des cas d'utilisation plus simples. C'est pourquoi les collections que nous proposons ici ont une très petite API et n'exposent même pas l'API Iterator. De cette façon, vous avez la possibilité de les utiliser et d'étendre son comportement adapté à vos besoins.

Caractéristiques

Construction statique pour utilisation de tuyaux.
Méthodes utiles comme isEmpty , count , toArray , contains , get , map , filter , slice , merge , reverse , reduce , first , last , head , tail .

Utilisation de base

Création d'une collection de listes typées

 <?php declare (strict_types= 1 );

use DCSG  ImmutableCollections  ImmutableCollection ;

final class MyStringCollection extends ImmutableCollection {
    protected function validateItems ( array $ elements ): void
    {
        foreach ( $ elements as $ element ) {
            if (! is_string ( $ element )) {
                throw new InvalidArgumentException ( ' Element is not a String. ' );
            }
        }
    }
}

$ collection = MyStringCollection:: create ([ ' foo ' , ' bar ' ]);
echo $ collection -> count (); // 2
$ slicedCollection = $ collection -> slice ( 0 , 1 ); // MyStringCollection { $elements=['foo']}

Création d'une collection d'ensembles typés

 <?php declare (strict_types= 1 );

use DCSG  ImmutableCollections  SetImmutableCollection ;

final class MyStringSetCollection extends SetImmutableCollection {
    protected function validateItems ( array $ elements ): void
    {
        foreach ( $ elements as $ element ) {
            if (! is_string ( $ element )) {
                throw new InvalidArgumentException ( ' Element is not a String. ' );
            }
        }
    }
}

$ collection = MyStringSetCollection:: create ([ ' foo ' , ' bar ' ]);
echo $ collection -> count (); // 2
$ slicedCollection = $ collection -> tail (); // MyStringSetCollection { $elements=['bar']}

$ collection = MyStringSetCollection:: create ([ ' foo ' , ' bar ' , ' foo ' ]); // Throws InvalidArgumentException