Download the PHP package yiisoft/definitions without Composer
On this page you can find all versions of the php package yiisoft/definitions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yiisoft/definitions
More information about yiisoft/definitions
Files in yiisoft/definitions
Package definitions
Short Description The package provides definition syntax
License BSD-3-Clause
Homepage https://www.yiiframework.com/
Informations about the package definitions
Yii Definitions
The package provides syntax constructs describing a way to create and configure a service or an object. It is used by yiisoft/di and yiisoft/factory but could be used in other PSR-11 compatible packages as well.
The following are provided:
- Definitions describing services or objects to create. This includes syntax, its validation and resolving it to objects.
- References and dynamic references to point to other definitions. These include additional utility to refer to multiple definitions at once.
Requirements
- PHP 8.0 or higher.
Installation
The package could be installed with Composer:
General usage
Definitions
Definition is describing a way to create and configure a service, an object
or return any other value. It must implement Yiisoft\Definitions\Contract\DefinitionInterface
that has a single method resolve(ContainerInterface $container)
. References are
typically stored in the container or a factory and are resolved into object
at the moment of obtaining a service instance or creating an object.
ArrayDefinition
Array definition allows describing a service or an object declaratively:
In the above:
class
contains the name of the class to be instantiated.__construct()
holds an array of constructor arguments.- The rest of the config are property values (prefixed with
$
) and method calls, postfixed with()
. They are set/called in the order they appear in the array.
For multiple method call postfix key with unique string, for example:
CallableDefinition
Callable definition builds an object by executing a callable injecting dependencies based on types used in its signature:
In the above we use a closure, a static call and a static method passed as array-callable. In each case we determine and pass dependencies based on the types of arguments in the callable signature.
ParameterDefinition
Parameter definition resolves an object based on information from ReflectionParameter
instance:
It is mostly used internally when working with callables.
ValueDefinition
Value definition resolves value passed as is:
References
References point to other definitions so when defining a definition you can use other definitions as its dependencies:
Optional reference returns null
when there's no corresponding definition in container:
The DynamicReference
defines a dependency to a service not defined in the container:
In order to pass an array of IDs as references to a property or an argument, Yiisoft\Definitions\ReferencesArray
or
Yiisoft\Definitions\DynamicReferencesArray
could be used:
Definition storage
Definition storage could be used to hold and obtain definitions and check if a certain definition could be instantiated. Usually it is used by an implementation using the definitions:
In the above $buildStack
will contain a stack with definition IDs in the order the latest dependency obtained would be
built.
By default, if a class is checked in has()
and it is not explicitly defined, the storage tries to autoload it first
before failing. The storage may also work in a strict mode when everything in it should be defined explicitly:
has()
will return false
even if EngineMarkOne
exists.
Documentation
- Internals
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii Definitions is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.