robusto/enum

A PHP 7.0+ Robust enumeration library.

2.0 2017-05-26 18:30 UTC

Requires

• php: >=7.0

Requires (Dev)

• phpunit/phpunit: ^5.5
• squizlabs/php_codesniffer: 2.7.1

MIT

• Jarddel Antunes

• type
• enum
• enumerative

README

A robust and simple way to define enumerative types in php.

Requirements:

• PHP 7.0+
• DBAL (only for use EnumType)

Simple Example: ```php class DayWeekEnum extends Enum { const SUNDAY = 1, MONDAY = 2, TUESDAY = 3, WEDNESDAY = 4, THURSDAY = 5, FRIDAY = 6, SATURDAY = 7 ; } ```

Example using descriptions for the enumerative values:

class LanguageEnum extends Enum
{
    const JAVA   = 1,
	      PHP    = 2,
	      PYTHON = 3,
	      RUBY   = 4,
	      JS     = 5
    ;

    protected static $descriptions = [
    	'Java',
    	'PHP',
    	'Python',
    	'Ruby',
    	'Javascript'
    ];
}

Possibility of using enum with php typehint, restricting their value according to their respective values of type:

public function setLanguage(LanguageEnum $language) 
{
    $this->language = $language;
}

$language = LanguageEnum::JAVA();

$foo->setLanguage($language);

Printing description of its enum value:

public function getLanguage(): LanguageEnum 
{
    return $this->language;
}


$foo->setLanguage(LanguageEnum::JS());

echo $foo->getLanguage(); // Javascript

echo LanguageEnum::JS;    // 5

echo get_class($foo->getLanguage()); // LanguageEnum