royalcms-enum

This class gives the ability to emulate and get enumeration data natively in PHP.

Getting started

Install

composer require royalcms/enum

Example

Create a class for an enum data, like this:

<?php

namespace Royalcms\Component\Enum\Demo;

use Royalcms\Component\Enum\Enum;

/**
 * custom global request code
 */
class RequestCode extends Enum
{
    CONST SUCCESS = 0;
    CONST ERROR = 1;

    protected function __statusMap()
    {
        /**
         * The display value for view.
         */
        return [
            self::SUCCESS => 'request success',
            self::ERROR   => 'request failure',
        ];

    }
}

Use

- Scope Resolution Operator

<?php

use Royalcms\Component\Enum\Demo\RequestCode;

// Use value.
RequestCode::SUCCESS;                   // 0
RequestCode::ERROR;                     // 1

// Determine if the name has been in Enum.
RequestCode::hasName('SUCCESS');        // true
RequestCode::hasName('TEST');           // false

// Determine if the name has been in Enum.
// Using strict comparison usually, unless strict is set to false.
RequestCode::hasValue(1);               // true
RequestCode::hasValue('1');             // false

RequestCode::hasValue('1', false);      // true
RequestCode::hasValue(9);               // false

// Value & Name, convert each other.
RequestCode::nameToValue('SUCCESS');    // 0
RequestCode::nameToValue('TEST');       // throw UnexpectedValueException

RequestCode::valueToName(1);            // 'ERROR'
RequestCode::valueToName(9);            // throw UnexpectedValueException

// Translate the given constant name/value to the display value.
RequestCode::transName('ERROR');        // 'request failure'
RequestCode::transName('TEST');         // 'TEST'

RequestCode::transValue(0);             // 'request success'
RequestCode::transValue(9);             // 9

// Some Getter methods.
RequestCode::getMap();
return:
[
    'SUCCESS' => 0,
    'ERROR' => 1,
]

RequestCode::getNameMap();
return:
[
    0 => 'SUCCESS',
    1 => 'ERROR',
]

RequestCode::getDict();
return:
[
    0 => 'request success',
    1 => 'request failure',
]

RequestCode::getNameDict();
return:
[
    'SUCCESS' => 'request success',
    'ERROR' => 'request failure',
]

- Instantiable

<?php

use Royalcms\Component\Enum\Demo\RequestCode;

// create instance via value
$requestSuccess = new RequestCode(0);
$requestSuccess->getName();  // SUCCESS
$requestSuccess->getValue(); // 0

// __toString
echo $requestSuccess; // '0'

// Same as Staticable use.
// It is implemented in __call and __callStatic
$requestSuccess->getNameDict();
return:
[
    'SUCCESS' => 'request success',
    'ERROR' => 'request failure',
]

// var_dump($requestSuccess)
object(Royalcms\Component\Enum\Demo\RequestCode)
  protected 'name' => string 'SUCCESS'
  protected 'value' => int 0
  protected 'valueMap' =>
    array (size=2)
      'SUCCESS' => int 0
      'ERROR' => int 1
  protected 'nameMap' =>
    array (size=2)
      0 => string 'SUCCESS'
      1 => string 'ERROR'
  protected 'nameDict' =>
    array (size=2)
      'SUCCESS' => string 'request success'
      'ERROR' => string 'request failure'