Wallogit.com
2017 © Pedro Peláez
Enumeration (enum) implementation for PHP
Warning If you are using PHP 8.1 or higher, we recommend you use native php enums in place of this package., (*1)
We may release some maintenance patches but support for this package is otherwise being discontinued., (*2)
Feel free to fork our code and adapt it to your needs., (*3)
, (*4)
This library provides an Enum / Enumeration implementation for PHP., (*5)
map() method.First create a new class that extends \Rexlabs\Enum\Enum and do the following;, (*6)
map() method:<?php
namespace Rexlabs\Enum\Readme;
use Rexlabs\Enum\Enum;
/**
* Class City
*
* @package Rexlabs\Enum\Readme
*
* @method static static BRISBANE()
* @method static static MELBOURNE()
* @method static static SYDNEY()
*/
class City extends Enum
{
const BRISBANE = 'Brisbane';
const MELBOURNE = 'Melbourne';
const SYDNEY = 'Sydney';
// OPTIONAL - Provide a map() method if you would like to
// map additional data, which will be available from the ->value() method
public static function map(): array
{
return [
self::BRISBANE => ["state"=>"QLD", "population"=>""],
self::MELBOURNE => ["state"=>"VIC", "population"=>"5m"],
self::SYDNEY => ["state"=>"NSW", "population"=>"5m"],
];
}
}
// Static access
echo City::BRISBANE; // "Brisbane"
echo City::MELBOURNE; // "Melbourne"
City::names(); // (array)["BRISBANE", "BRISBANE", "SYDNEY"]
City::keys(); // (array)["Brisbane", "Melbourne", "Sydney"]
City::keyForName('BRISBANE'); // "Brisbane"
City::nameForKey('Melbourne'); // "MELBOURNE"
City::isValidKey('Sydney'); // (boolean)true
City::isValidKey('Paris'); // (boolean)false
// Getting an instance - all return a City instance.
$city = City::BRISBANE();
$city = City::instanceFromName('BRISBANE');
$city = City::instanceFromKey('Brisbane');
// Working with an instance
$city->name(); // "BRISBANE"
$city->key(); // "Brisbane"
$city->value()['population']; // null - no value mapped
$city->is(City::BRISBANE); // (boolean)true
$city->is(City::BRISBANE()); // (boolean)true
$city->is(City::SYDNEY()); // (boolean)false
$city->isNot(City::SYDNEY()); // (boolean)true
$city->isAnyOf([City::BRISBANE()]); // (boolean)true
$city->isNoneOf([City::BRISBANE()]); // (boolean)false
// Or ...
City::SYDNEY()->key(); // "Sydney"
City::SYDNEY()->value(); // (array)["state"=>"NSW", "population"=>"5m"]
To install in your project:, (*7)
composer require rexlabs/enum
Now you can type-hint your Enum object as a dependency:, (*8)
<?php
function announceCity(City $city) {
echo "{$city->key()} is located in {$city->value()["state"]}, population: {$city->value()["population"]}\n";
}
// Get a new instance
announceCity(City::SYDNEY()); // "Sydney is located in NSW, population: 5m"
Each instance of Enum provides the following methods:, (*9)
Returns the constant name., (*10)
$enum->name();
Returns the value/key assigned to the constant in the const MY_CONST = 'key' declaration., (*11)
$enum->key();
Returns the value (if-any) that is mapped (in the array returned by map()).
If no value is mapped, then this method returns null., (*12)
$enum->value();
Returns true if this instance is the same as the given constant key or enumeration instance., (*13)
$enum->is(City::SYDNEY); // Compare to constant key $enum->is(City::SYDNEY()); // Compare to instance
The __toString() method is defined to return the constant name., (*14)
(string)City::SYDNEY(); // "SYDNEY"
Returns an array which maps the constant keys to a value.
This method can be optionally implemented in a sub-class.
The default implementation returns an array of keys mapped to null., (*15)
Returns an array of Enum instances., (*16)
Returns an array of constant keys., (*17)
Returns an array of values defined in map(). If map() is not implemented then an array of null values will
be returned., (*18)
Returns an array of all the constant names declared with the class., (*19)
Returns an associative array of CONSTANT_NAME => key, for all the constant names declared within the class., (*20)
Returns the key for the given constant name., (*21)
Returns the constant name for the given key (the inverse of keyForName)., (*22)
Returns the value (or null if not mapped) for the given key (as declared in the map() method)., (*23)
Returns the key for the given value (as declared in the map() method)., (*24)
Note: If duplicate values are contained within the
map()method then only the first key will be returned., (*25)
Create instance of this Enum from the given constant name., (*26)
Create instance of this Enum from the given key., (*27)
Returns true if the given key exists., (*28)
Returns true if the given constant name (case-sensitive) has been declared in the class., (*29)
Throws a \Rexlabs\Enum\Exceptions\InvalidKeyException if the given key does NOT exist., (*30)
To run tests:, (*31)
composer tests
To run coverage report:, (*32)
composer coverage
Coverage report is output to ./tests/report/index.html, (*33)
Contributions are welcome, please submit a pull-request or create an issue. Your submitted code should be formatted using PSR-1/PSR-2 standards., (*34)
Enumeration (enum) implementation for PHP
MIT
library enum enumeration constants valuelist
Enumeration (enum) implementation for PHP
MIT
library enum enumeration constants valuelist