ENUM.md

Enum

Declaration

use Atrapalo\PHPTools\Enum\Enum;

/**
 * Action enum
 */
class Action extends Enum
{
    const VIEW = 'view';
    const EDIT = 'edit';
}

Usage

$action = new Action(Action::VIEW);

// or
$action = Action::view();

As you can see, static methods are automatically implemented to provide quick access to an enum value.

One advantage over using class constants is to be able to type-hint enum values:

function setAction(Action $action) {
    // ...
}

Documentation

• __construct() The constructor checks that the value exist in the enum
• __toString() You can echo $myValue, it will display the enum value (value of the constant)
• value() Returns the current value of the enum
• key() Returns the key of the current value on Enum
• equals() Tests whether enum instances are equal (returns true if enum values are equal, false otherwise)

Static methods:

• toArray() method Returns all possible values as an array (constant name in key, constant value in value)
• keys() Returns the names (keys) of all constants in the Enum class
• values() Returns instances of the Enum class of all Enum constants (constant name in key, Enum instance in value)
• isValid() Check if tested value is valid on enum set
• isValidKey() Check if tested key is valid on enum set
• search() Return key for searched value

Static and magic methods

class Action extends Enum
{
    const VIEW_POST = 'view';
    const EDIT = 'edit';
}

// Static method:
$action = Action::viewPost();
$action = Action::edit();

// Magic method:
$actionEdit = Action::edit();
$actionEdit->isEdit() // return true 
$actionEdit->isViewPost() // return false 

Static method helpers are implemented using __callStatic(). Magic method helpers are implemented using __call().

If you care about IDE autocompletion, you can either implement the static methods yourself:

class Action extends Enum
{
    const VIEW_POST = 'view';

    /**
     * @return Action
     */
    public static function viewPost() {
        return new Action(self::VIEW_POST);
    }
    
    /**
     * @return bool
     */
    public function isViewPost() {
        return $this->value() === self::VIEW_POST;
    }
}

or you can use phpdoc (this is supported in PhpStorm for example):

/**
 * @method static Action viewPost()
 * @method static Action edit()
 *
 * @method bool isViewPost()
 * @method bool isEdit()
 */
class Action extends Enum
{
    const VIEW_POST = 'view';
    const EDIT = 'edit';
}

PHPDoc IDE Helper

Run the command enum-doc passing the complete namespace of your class and will automatically generate the PHPDoc IDE autocomplete

$ php enum-doc "Atrapalo\PHPTools\Tests\Enum\DeloreanEnum"

You can paste the output into your Enum class

/**
 * Class DeloreanEnum
 * @package Atrapalo\PHPTools\Tests\Enum
 * 
 * @method static DeloreanEnum foo()
 * @method static DeloreanEnum bar()
 * @method static DeloreanEnum number()
 * @method static DeloreanEnum problematicNumber()
 * @method static DeloreanEnum problematicNull()
 * @method static DeloreanEnum problematicEmptyString()
 * @method static DeloreanEnum problematicBooleanFalse()
 * 
 * @method bool isFoo()
 * @method bool isBar()
 * @method bool isNumber()
 * @method bool isProblematicNumber()
 * @method bool isProblematicNull()
 * @method bool isProblematicEmptyString()
 * @method bool isProblematicBooleanFalse()
 */