2017 © Pedro Peláez
 

library php-enum

PHP Enum implementation

image

corp-soft/php-enum

PHP Enum implementation

  • Tuesday, December 5, 2017
  • by igor-chepurnoi
  • Repository
  • 2 Watchers
  • 5 Stars
  • 354 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 2 Versions
  • 7 % Grown

The README.md

, (*1)

PHP Enum implementation


Latest Stable Version Total Downloads License Build Status Scrutinizer Code Quality, (*2)

Installation

The preferred way to install this extension is through composer., (*3)

Either run, (*4)

php composer.phar require --prefer-dist corp-soft/php-enum "*"

or add, (*5)

"corp-soft/php-enum": "*"

to the require section of your composer.json file., (*6)

Available Methods:

  • createByName() - Creates a new type instance using the name of a value.
  • getValueByName() - Returns the constant key by value(label)
  • createByValue() - Creates a new type instance using the value.
  • listData() - Returns the associative array with constants values and labels
  • getLabel()- Returns the constant label by key
  • getConstantsByName() - Returns the list of constants (by name) for this type.
  • getConstantsByValue() - Returns the list of constants (by value) for this type.
  • isValidName() - Checks if a name is valid for this type.
  • isValidValue() - Checks if a value is valid for this type.

Declaration

<?php

namespace App\Enums;

use CorpSoft\Enum\BaseEnum;

class PostStatus extends BaseEnum
{
    const PENDING = 0;
    const APPROVED = 1;
    const REJECTED = 2;
    const POSTPONED = 3;

    /**
     * @var array
     */
    public static $list = [
        self::PENDING => 'Pending',
        self::APPROVED => 'Approved',
        self::REJECTED => 'Rejected',
        self::POSTPONED => 'Postponed',
    ];
}

Enum creation

$status = new PostStatus(PostStatus::PENDING);

// or you can use the magic methods

$status = PostStatus::PENDING();

Static methods

PostStatus::getConstantsByValue() // ['PENDING', 'APPROVED', 'REJECTED', 'POSTPONED']
PostStatus::getConstantsByName() // ['PENDING' => 0, 'APPROVED' => 1, 'REJECTED' => 2, 'POSTPONED' => 3]
PostStatus::isValidName(1) // false
PostStatus::isValidName('APPROVED') // true
PostStatus::isValidValue(1) // true
PostStatus::isValidValue('Approved') // false
PostStatus::listData() // ['Pending', 'Approved', 'Rejected', 'Postponed']
PostStatus::getLabel(1) // Approved
PostStatus::getValueByName('Approved') // 1

Type-Hint and Validation Rules

<?php

use App\Enums\PostStatus;

class Post
{
   /**
    * @var integer status 
    */
    public $status;

    public function setStatus(PostStatus $status)
    {
        $this->status = $status->getValue();
    }

    public function getStatus(): PostStatus
    {
        return $this->status;
    }
}

The Versions

05/12 2017

dev-master

9999999-dev

PHP Enum implementation

  Sources   Download

MIT

The Requires

  • php >=7.1

 

The Development Requires

by Igor Chepurnoi

enum enumerator enumeration

28/11 2017

1.0.0

1.0.0.0

PHP Enum implementation

  Sources   Download

MIT

The Requires

  • php >=7.1

 

The Development Requires

by Igor Chepurnoi

enum enumerator enumeration