mpscholten / typesafe-enum
A lightweight, type safe enum library
Installs: 1 124
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 4
Forks: 2
Open Issues: 0
Requires (Dev)
- phpunit/phpunit: ^4.7
This package is auto-updated.
Last update: 2024-10-22 20:42:50 UTC
README
A lightweight, type safe enum library for PHP.
Use it to provide safe enums with autocompletion support. Fits well in domain driven designed applications.
Get started
Install via composer
composer install mpscholten/typesafe-enum
Basic Usage
class UserType extends \TypesafeEnum\Enum { public static function PAID() { return new UserType('paid'); } public static function FREE() { return new UserType('free'); } public function isPaid() { return $this->is('paid'); } public function isFree() { return $this->is('free'); } } class User { public function __construct($email, UserType $type) { $this->type = $type; } public function getType() { return $this->type; } } $user = new User('hello@example.com', UserType::PAID()); // Good $user->getType()->isPaid(); // true $user->getType()->isFree(); // false (string) $user->getType(); // "paid" $user = new User('hello@example.com', UserType::FREE()); // Good $user->getType()->isFree(); // true $user->getType()->isPaid(); // false (string) $user->getType(); // "free" $user = new User('hello@example.com', 'some string'); // Type error (PHP Catchable fatal error: Argument 2 passed to User::__construct() must be an instance of UserType, integer given, called in ...) $user = new User('hello@example.com', null); // Type error (PHP Catchable fatal error: Argument 2 passed to User::__construct() must be an instance of UserType, null given, called in ...)
Extended Usage
class Temperature extends Enum { private $celsius; protected function __construct($value, $celsius) { parent::__construct($value); $this->celsius = $celsius; } public static function HOT() { return new Temperature('hot', 40); } public static function COLD() { return new Temperature('cold', 10); } public function isHot() { return $this->is('hot'); } public function isCold() { return $this->is('cold'); } /** * @return int */ public function getCelsius() { return $this->celsius; } } $temperature = Temperature::HOT(); $temperature->isHot(); // true $temperature->isCold(); // false $temperature->getCelsius(); // 40 (string) $temperature; // "hot" $temperature = Temperature::COLD(); $temperature->isCold(); // true $temperature->isHot(); // false $temperature->getCelsius(); // 10 (string) $temperature; // "cold"
As you can see above the suggested way to assign an attribute (in this case celsius) to each value in the value set of the enum is to add a new property to the class and to override the constructor. Don't use a switch
statement for this.
This will make sure that there's always one assigned attribute per value in the value set of the enum, so the assigned attributes will not get out of sync with the value set.
Usage with doctrine2
You can use this library together with doctrine2 by using so called embeddables:
/** @Embeddable */ class UserType extends \TypesafeEnum\Enum { /** @Column(type = "smallint", name = "type") */ protected $value; // Override the `$value` property of \TypesafeEnum\Enum and apply mapping public static function PAID() { return new UserType(0); } public static function FREE() { return new UserType(1); } public function isPaid() { return $this->is(0); } public function isFree() { return $this->is(1); } } class User { /** @Embedded(class = "UserType", columnPrefix = false) */ private $type; public function __construct($email, UserType $type) { $this->type = $type; } }
Tests
You can run the phpunit
suite with make
make tests
Contributing
Feel free to send pull requests!