mistralys/application-utils-collections

Interfaces, traits and classes for handling static item collections, similar to Enums and with useful getter methods.

Maintainers

Details

github.com/Mistralys/application-utils-collections

Source

Issues

Installs: 262

Dependents: 3

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.1.2 2024-07-25 14:59 UTC

Requires

Requires (Dev)

MIT 99a7c24e351ba54b4f95c128b9dc7dac2e4d7626

This package is auto-updated.

Last update: 2024-10-25 15:34:27 UTC

README

Interfaces, traits and classes for handling static item collections, similar to Enums and with useful getter methods.

In essence, it allows creating collections like this with a minimum of code:

$basil = Herbs::getInstance()->getByID(Herbs::BASIL);

echo $basil->getID(); // basil
echo $basil->getName(); // Basil
foreach(Herbs::getInstance()->getAll() as $herb) {
    echo $herb->getName();
}

This is part of the Application Utils ecology.

The Principle

The basic principle is to have a collection class for a data type, which knows all the possible values for that type, and a record class that represents a single value of that type.

The collections and records are distinguished by the return type of their getID() method.

Currently, only string and integer types are supported.

Implementation

There are two ways to implement collections:

  1. By extending the abstract base classes (e.g. BaseStringPrimaryCollection)
  2. By implementing the interface and trait (e.g. StringPrimaryCollectionTrait)

The second way is useful when working with classes that already extend another class.

The records have no abstract base class, only an interface that contains the getID() method with the relevant return type.

Usage

There are example implementations of the string and integer collections in the unit test classes: