Giter Club home page Giter Club logo

php-enum's Introduction

php-enum

This is a native PHP implementation to add enumeration support to PHP >= 7.1. It's an abstract class that needs to be extended to use it.

Usage

Basics

/**
 * Class StatusEnum
 *
 * @method static $this active()
 * @method static $this inactive()
 * @method string label()
 */
class StatusEnum extends Enum
{
    public const ACTIVE = ['value' => 1, 'label' => 'active'];
    public const INACTIVE = ['value' => 0, 'label' => 'inactive'];
}

// ways to instantiate an enumerator
$status = StatusEnum::get(StatusEnum::ACTIVE['value']); // by value or instance
$status = StatusEnum::active();                         // by name as callable
$status = StatusEnum::byValue('1');                      // by value
$status = StatusEnum::byName('ACTIVE');                 // by name

// basic methods of an instantiated enumerator
$status->getValue();   // 1
$status->getName();    // ACTIVE

// basic methods to list defined enumerators
StatusEnum::enumerators();  // returns a list of enumerator instances
StatusEnum::values();       // returns a list of enumerator values['value']
StatusEnum::names();        // returns a list of enumerator names
StatusEnum::constants();    // returns an associative array of enumerator names to enumerator values

// same enumerators (of the same enumeration class) holds the same instance
StatusEnum::get(StatusEnum::ACTIVE['value']) === StatusEnum::ACTIVE()
StatusEnum::get(StatusEnum::ACTIVE['value']) != StatusEnum::INACTIVE()

// simplified way to compare two enumerators
$status = StatusEnum::active();
$status->is(StatusEnum::ACTIVE['value']);      // true
$status->is(StatusEnum::active());             // true
$status->is(StatusEnum::INACTIVE['value']);    // false
$status->is(StatusEnum::inactive());           // false

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.