davidianbonner/enumerated

Enums represent a set of predefined values. Useful for ensuring data consistency.

Enumerated

, _(*1)

An enumerated type (Enum) is a data type that consists of a set of predefined values. This can be useful for ensuring data consistency. The Enumerated package provides a simple base class for creating enumerated types allowing the devloper to define values statically., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require davidianbonner/enumerated, <sub>(*4)</sub>

## Usage

Most applications require some form of an enumerated type. PHP does not have native Enum support (yet: [https://wiki.php.net/rfc/enum](https://wiki.php.net/rfc/enum)). To get past this, we tend to pack groups of predefined values into config or settings files as arrays. This doesn't represent the data or it's type in a straightforward manner.

### Before

```php
<?php

return [
    'language' => [
        'php' => 'php',
        'javascript' => 'js',
        'css' => 'css',
        'go' => 'go',
    ],
];

Used like so:, <sub>(*5)</sub>

$codebase->language = config('language.php');

// or

foreach (config('language') as $language) {
    echo '<option value="'.$language.'">'.$language.'</option>';
}

After

An enum would be a better fit for this set of values., <sub>(*6)</sub>

<?php

use DavidIanBonner\Enumerated\Enum;

class Language extends Enum
{
    const PHP = 'php';
    const JAVASCRIPT = 'js';
    const GO = 'go';
    const CSS = 'css';
}

Used like so:, <sub>(*7)</sub>

$codebase->language = Language::PHP;

// or

$type = Language::PHP;
$codebase->language = Language::ofType($type)->value();

// or

foreach (Language::allValues() as $language) {
    echo '<option value="'.$language.'">'.$language.'</option>';
}

Validate a value

A value can be validated against the predefined values:, <sub>(*8)</sub>

if (Language::isValid($value)) {
    // Is valid
}

Laravel Collection instance

This package requires the Laravel Support package in order to return a collection of the available values:, <sub>(*9)</sub>

// Returns an instance of Illuminate\Support\Collection
Language::collect();

Return keys

The allValues and collect method will accept a boolean argument to return the keys/constant names:, <sub>(*10)</sub>

$values = Language::allValues(true);

// Returns
[
    'PHP' => 'php',
    'JAVASCRIPT' => 'js',
    'CSS' => 'css',
    'GO' => 'go',
]

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*11)</sub>

Testing

bash $ phpunit test, <sub>(*12)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*13)</sub>

Security

If you discover any security related issues, please email davidianbonner@gmail.com instead of using the issue tracker., <sub>(*14)</sub>

Credits

• David Bonner

License

The MIT License (MIT). Please see License File for more information., <sub>(*15)</sub>