Download the PHP package smpita/configas without Composer
On this page you can find all versions of the php package smpita/configas. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download smpita/configas
More information about smpita/configas
Files in smpita/configas
Package configas
Short Description Typed Config Resolver for Laravel
License MIT
Homepage https://github.com/smpita/makeas
Informations about the package configas
Typed Config Resolver for Laravel
Do you use Laravel and fight the mixed signatures of config()
when performing static analysis?
Smpita/ConfigAs types your config calls for you.
This package wraps Smpita/TypeAs, a generalized PHP library useful on any PHP project employing static analysis or tight type enforcement.
Installation
You can install the package via composer:
Usage
Please see SIGNATURES for the list of current methods and signatures.
General Usage
SIGNATURES#resolving
Pass a key
and it will throw a ConfigAsResolutionException
if the key
isn't of the given type.
If you want to suppress throwing exceptions, provide a default.
The Class Method
SIGNATURES#class
class()
has a slightly different signature because you need to specify the class you are expecting.
You can still provide a default.
Nullables
If you would prefer to receive null
instead of having an exception thrown, each type method has a nullable counterpart.
Cache
SIGNATURES#cache
To keep things performant, types are only validated once and results are cached in static arrays for the lifetime of the request.
To guarantee a fresh value, you may use the fresh
methods that are available for each type.
Forgetting
SIGNATURES#forgetting
For each type, you can forget any given cached value.
You can flush the cache of a type.
You can flush all keys.
Resolvers
SIGNATURES#resolver-registration
You can leverage the included Smpita\TypeAs library to create your own custom resolvers. For creation, global registration, and full instructions, see the library docs.
Single use
Helpers
SIGNATURES#helpers
There is a configAs()
helper method located in the Smpita\ConfigAs
namespace.
Resolver methods have an associated helper method located in the Smpita\ConfigAs
namespace.
The helper method names follow the ConfigAs
method names, but are prepended by config
and are camelCased.
Deprecations
SIGNATURES#deprecations
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Sean Pearce
- All Contributors
License
The MIT License (MIT). Please see License File for more information.