Download the PHP package rikudou/enums-trait without Composer
On this page you can find all versions of the php package rikudou/enums-trait. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package enums-trait
PHP Enums
This is yet another PHP enum implementation.
What is so different about this one? It uses trait which solves one problem all the other implementations I've seen have - extending some base enum class.
All the enums return the same instance for the same enum, so you can check for equality
(===) and the result is true.
The constructor is made private, so you cannot directly construct an instance via
new keyword (but you can create an constructor in your class and make it public
if you need to, but I advise against it).
Every internal method is made private so you cannot extend the enum (well, you can but it would be useless).
Usage:
Creating enum
That's it, you just created an enum. It's a pretty basic one, that supports pretty much
any value via magic method __callStatic. For example:
If you want IDE completion you have two options:
- create the static methods yourself
- add phpdoc comments to the class (for example PHPStorm supports it)
Create the methods yourself
Your IDE will now autocomplete for EnumValue1 and EnumValue2 static methods.
Add phpdoc comments
The result for IDE is the same as creating the methods yourself.
Limiting the allowed enums
If you don't like the idea that you can create pretty much any enum via the magic method, you can limit them like this:
Now your enum contains only Value1, Value2 and Value3.
Anything else will throw InvalidArgumentException.
As you can see, the allowedValues() array doesn't care about the methods
you create manually.
Using the enums
As you can see, you can typehint the enum and php itself will check that it's really an instance of the enum.
Then you can just check them in switch or if/else or whatever.
Getting enum value
If you need the value that the enum holds, you can use the getValue() method.
The methods constructed __callStatic magic method hold the value of the method name:
The methods you create have a value that you give them:
Some caveats
-
the trait caches the objects based on value, meaning that if you create two enum values (static methods) with same value, they will return the same object, e.g. they will return true for equality test
- if you for any reason wanted to serialize the enum and store it (session, db, etc.),
after unserializing it wouldn't pass the equality test, therefore the enum cannot be
serialized and will throw a
LogicExceptionif you try to (using magic methods__sleepand__wakeup)
And that's all, folks. Now all that remains is waiting for a real enum implementation on the php side.
