Download the PHP package phpoption/phpoption without Composer
On this page you can find all versions of the php package phpoption/phpoption. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
All versions of phpoption with dependencies
Informations about the package phpoption
PHP Option Type
This package implements the Option type for PHP!
The Option type is intended for cases where you sometimes might return a value (typically an object), and sometimes you might return a base value (typically null) depending on arguments, or other runtime factors.
Often times, you forget to handle the case where a base value should be returned. Not intentionally of course, but maybe you did not account for all possible states of the system; or maybe you indeed covered all cases, then time goes on, code is refactored, some of these your checks might become invalid, or incomplete. Suddenly, without noticing, the base value case is not handled anymore. As a result, you might sometimes get fatal PHP errors telling you that you called a method on a non-object; users might see blank pages, or worse.
On one hand, the Option type forces a developer to consciously think about both cases (returning a value, or returning a base value). That in itself will already make your code more robust. On the other hand, the Option type also allows the API developer to provide more concise API methods, and empowers the API user in how he consumes these methods.
Installation is super-easy via Composer:
or add it by hand to your
Using the Option Type in your API
If you are consuming an existing library, you can also use a shorter version
which by default treats
None, and everything else as
Case 1: You always Require an Entity in Calling Code
Case 2: Fallback to Default Value If Not Available
No More Boiler Plate Code
No More Control Flow Exceptions
More Concise Null Handling
Trying Multiple Alternative Options
If you'd like to try multiple alternatives, the
orElse method allows you to
do this very elegantly:
The first option which is non-empty will be returned. This is especially useful with lazy-evaluated options, see below.
The above example has the flaw that we would need to evaluate all options when the method is called which creates unnecessary overhead if the first option is already non-empty.
Fortunately, we can easily solve this by using the
This way, only the options that are necessary will actually be evaluated.
Of course, performance is important. Attached is a performance benchmark which you can run on a machine of your choosing.
The overhead incurred by the Option type comes down to the time that it takes to create one object, our wrapper. Also, we need to perform one additional method call to retrieve the value from the wrapper.
- Overhead: Creation of 1 Object, and 1 Method Call
- Average Overhead per Invocation (some case/value returned): 0.000000761s (that is 761 nano seconds)
- Average Overhead per Invocation (none case/null returned): 0.000000368s (that is 368 nano seconds)
The benchmark was run under Ubuntu precise with PHP 5.4.6. As you can see the overhead is surprisingly low, almost negligible.
So in conclusion, unless you plan to call a method thousands of times during a
request, there is no reason to stick to the
object|null return value; better give
your code some options!
If you discover a security vulnerability within this package, please send an email to [email protected] All security vulnerabilities will be promptly addressed. You may view our full security policy here.
PHP Option Type is licensed under Apache License 2.0.
Available as part of the Tidelift Subscription
The maintainers of
phpoption/phpoption and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.