php immutable collections

Coleções imutáveis ​​minimalistas e digitadas para PHP

Uma biblioteca que fornece um conjunto de coleções imutáveis ​​minimalistas, digitadas e canalizadas para PHP.

Requisitos

PHP > 7.2

Instalação

composer require dcsg/php-immutable-collections

Que problemas isso resolve?

A falta de Genéricos em PHP não permite ter coleções digitadas em PHP.

Esta biblioteca fornece duas coleções abstratas imutáveis:

• Coleção de lista imutável - ImmutableCollection
• Coleção de conjuntos imutáveis ​​- SetImmutableCollection

Por que coleções imutáveis ​​digitadas

Coleções digitadas

Como o PHP não possui genéricos como o Java, não é possível ter coleções digitadas nativas. As Coleções disponíveis nesta Biblioteca são a base para você criar suas próprias Coleções Digitadas, bastando apenas estendê-las.

Coleções imutáveis ​​digitadas para DDD (Domain Driven Design)

DDD tem tudo a ver com ter seu código falando a linguagem de negócios, a chamada Linguagem Ubíqua. Sem coleções em PHP, isso é muito difícil de conseguir usando Arrays porque você não pode adicionar comportamento a eles. Então, o que geralmente acontece é que você adiciona esse comportamento à sua entidade, mas ele não deveria estar lá. Outro problema é a mutabilidade dos Arrays , VOs (Value Objects) DEVEM ser sempre imutáveis ​​e isso é impossível com Arrays e você deve sempre garantir que os elements desse Array sejam todos do mesmo tipo.

Coleções vs matrizes

• Collections e Arrays representam um grupo de elementos.
• Collections não são suportadas nativamente pelo PHP, enquanto Arrays são.
• Arrays é A estrutura de dados do PHP e é usado para quase tudo.
• Arrays não permitem adicionar novos comportamentos enquanto Collections permitem.
• Arrays não permitem definir um tipo para seus elementos, enquanto Collections permitem.

Outras coleções PHP

Existem outras coleções para PHP por aí, citando algumas como Doctrine Collections e Illuminate Collections. Essas coleções resolvem problemas diferentes, são adaptadas ao seu caso de uso específico e suas APIs são extensas e, mais importante, essas coleções são mutáveis. Essas combinações dificultam o uso dessas coleções em casos de uso mais simples. É por isso que as Collections que fornecemos aqui possuem uma API muito pequena e nem expõem a API do Iterator. Desta forma você tem a possibilidade de utilizá-los e ampliar seu comportamento sob medida para suas necessidades.

Características

• Construção estática para uso em tubos.
• Métodos utilitários como isEmpty , count , toArray , contains , get , map , filter , slice , merge , reverse , reduce , first , last , head , tail .

Uso básico

Criando uma coleção de lista digitada

 <?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']} 

Criando uma coleção de conjuntos digitados

 <?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 

Exemplos

Fornecemos dois exemplos simples para melhor compreensão. Uma relativa a faturas e outra relativa a Pernas de Navio de Carga.

Registro de alterações

Consulte CHANGELOG para obter mais informações sobre o que mudou recentemente.

Teste

$ composer test 

Contribuindo

Consulte CONTRIBUIÇÃO e CÓDIGO DE CONDUTA para obter detalhes.

Segurança

Se você descobrir algum problema relacionado à segurança, envie um e-mail para [email protected] em vez de usar o rastreador de problemas.

Créditos

• Daniel Gomes
• Todos os colaboradores

Licença

A licença MIT (MIT). Consulte Arquivo de licença para obter mais informações.