php immutable collections

PHP のミニマリストで型指定された不変コレクション

PHP 用の最小限の、型指定およびパイプされた不変コレクションのセットを提供するライブラリ。

要件

PHP > 7.2

インストール

composer require dcsg/php-immutable-collections

これでどのような問題が解決しますか?

PHP にはジェネリックがないため、PHP で型付きコレクションを持つことができません。

このライブラリは、2 つの抽象的な不変コレクションを提供します。

• 不変リストコレクション - ImmutableCollection
• 不変セットコレクション - SetImmutableCollection

型付き不変コレクションを使用する理由

型付きコレクション

PHP には Java のようなジェネリックがないため、ネイティブ型のコレクションを持つことはできません。このライブラリで利用可能なコレクションは、独自の型付きコレクションを作成するための基盤であり、拡張するだけで済みます。

DDD (ドメイン駆動設計) の型付き不変コレクション

DDD は、ユビキタス言語と呼ばれるビジネス言語をコードで話すようにすることです。 PHP でコレクションがなければ、配列に動作を追加できないため、 Arraysを使用してこれを実現するのは非常に困難です。したがって、通常はその動作をエンティティに追加しますが、それは存在すべきではありません。もう 1 つの問題はArraysの可変性ですVOs (Value Object) は常に不変でなければなりませんが、 Arraysではそれは不可能であり、そのArrayのelementsすべて同じ型であることを常に保証する必要があります。

コレクションと配列の比較

• CollectionsとArraysどちらも要素のグループを表します。
• PHP ではCollectionsはネイティブにサポートされていませんが、 Arraysサポートされています。
• Arrays PHP のデータ構造であり、ほとんどすべてのものに使用されます。
• Arrays新しい動作を追加できませんが、 Collectionsではそれが可能です。
• Arrays要素の型を定義できませんが、 Collectionsではそれが可能です。

その他の PHP コレクション

PHP 用のコレクションは他にもあり、その中には Doctrine Collection や Illuminate Collection などがあります。これらのコレクションはさまざまな問題を解決し、特定のユースケースに合わせて調整されており、その API は広範囲にわたっており、さらに重要なのはコレクションが変更可能であることです。これらの組み合わせにより、これらのコレクションをより単純なユースケースに使用することが困難になります。そのため、ここで提供するコレクションの API は非常に小さく、Iterator API も公開していません。このようにして、それらを使用し、ニーズに合わせて動作を拡張することができます。

特徴

• パイプ使用のための静的構造。
• isEmpty 、 count 、 toArray 、 contains 、 get 、 map 、 filter 、 slice 、 merge 、 reverse 、 reduce 、 first 、 last 、 head 、 tailなどの Util メソッド。

基本的な使い方

型付きリストコレクションの作成

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

型付きセットコレクションの作成

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

例

理解を深めるために、2 つの簡単な例を示します。 1 つは請求書に関するもので、もう 1 つは貨物船の脚に関するものです。

変更ログ

最近の変更点の詳細については、CHANGELOG を参照してください。

テスト

$ composer test 

貢献する

詳細については、「貢献」と「行動規範」をご覧ください。

安全

セキュリティ関連の問題を発見した場合は、問題トラッカーを使用する代わりに、[email protected] に電子メールを送信してください。

クレジット

• ダニエル・ゴメス
• すべての貢献者

ライセンス

MIT ライセンス (MIT)。詳細については、ライセンス ファイルを参照してください。