https://github.com/stavarengo/php-enum

Native PHP implementation to add enumerable support to PHP. It's an abstract class that can be extended to emulate enumerables.
https://github.com/stavarengo/php-enum

Last synced: 8 days ago
JSON representation

Native PHP implementation to add enumerable support to PHP. It's an abstract class that can be extended to emulate enumerables.

• Host: GitHub
• URL: https://github.com/stavarengo/php-enum
• Owner: stavarengo
• Created: 2015-01-30T17:48:18.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-30T17:48:56.000Z (almost 10 years ago)
• Last Synced: 2024-11-09T03:39:03.092Z (2 months ago)
• Language: PHP
• Homepage:
• Size: 102 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# php-enum 

This is a native PHP implementation to add enumarable support to PHP.

It's an abstract class that can be extended to emulate enumerables.

## Why not ```SplEnum```

* It's not build-in PHP and requires pecl/extension

* SplEnum is too much magic under the hod

* SplEnum hasn't strict comparison

## Examples

TODO

# Class constants vs. php-enum

## The way of class constants

TODO: change the bellow example to use the RainbowColors class

    class User

    {

        const INACTIVE = 0;

        const ACTIVE   = 1;

        const DELETED  = 2;

        protected $status = 0;

        public function setStatus($status)

        {

            $intStatus = (int)$status;

            if (!in_array($intStatus, array(self::INACTIVE, self::ACTIVE, self::DELETED))) {

                throw new InvalidArgumentException("Invalid status {$status}");

            }

            $this->status = $intStatus;

        }

        public function getStatus()

        {

            return $this->status;

        }

    }

    $user = new User();

    echo 'Default user status: ' . $user->getStatus() . PHP_EOL;

    $user->setStatus(User::ACTIVE);

    echo 'Changed user status: ' . $user->getStatus() . PHP_EOL;

    PRINTS:

    Default user status: 0

    Changed user status: 1

* Requires validation on every use

* Hard to extend the list of possible values

* Hard to get a human readable name of a value

## The way of php-enum:

TODO: change the bellow example to use the RainbowColors class

    class UserStatusEnum extends Enum

    {

        const INACTIVE = 0;

        const ACTIVE   = 1;

        const DELETED  = 2;

        // default value

        protected $value = self::INACTIVE;

    }

    class User

    {

        protected $status;

        public function setStatus(UserStatusEnum $status)

        {

            $this->status = $status;

        }

 

        public function getStatus()

        {

            if (!$this->status) {

                // init default status

                $this->status = new UserStatusEnum();

            }

            return $this->status;

        }

    }

    $user = new User();

    echo 'Default user status: ' . $user->getStatus() . '(' . $user->getStatus()->getValue() . ')' . PHP_EOL;

    $user->setStatus(new UserStatusEnum(UserStatusEnum::ACTIVE));

    echo 'Changed user status: ' . $user->getStatus() . '(' . $user->getStatus()->getValue() . ')' . PHP_EOL;

    PRINTS:

    Default user status: INACTIVE (0)

    Changed user status: ACTIVE (1)

* Validation already done on basic class ```Enum```

* Using type-hint makes arguments save

* Human readable name of a value is simple accessable

# New BSD License

TODO