PHPackages                             yiisoft/definitions - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/definitions

ActiveLibrary[Framework](/categories/framework)

yiisoft/definitions
===================

The package provides definition syntax

3.4.1(5mo ago)151.3M—9.9%5[3 issues](https://github.com/yiisoft/definitions/issues)[3 PRs](https://github.com/yiisoft/definitions/pulls)20BSD-3-ClausePHPPHP 8.1 - 8.5CI passing

Since Nov 30Pushed 3mo ago14 watchersCompare

[ Source](https://github.com/yiisoft/definitions)[ Packagist](https://packagist.org/packages/yiisoft/definitions)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-definitions/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (8)Versions (21)Used By (20)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii Definitions
===============

[](#yii-definitions)

[![Latest Stable Version](https://camo.githubusercontent.com/11f2dcf9277254ffd72cea6df45e9a8d7149cebe31cd23eb94d9945dfbac0650/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f646566696e6974696f6e732f76)](https://packagist.org/packages/yiisoft/definitions)[![Total Downloads](https://camo.githubusercontent.com/db243b4e26007f5b4adbadb5f05fc6f4e32b3fb4c918fb463f768ad3c546c3a8/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f646566696e6974696f6e732f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/definitions)[![Build status](https://github.com/yiisoft/definitions/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/definitions/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/01d50d18043f6baac0989a6302a226a2a099f70219ea2df8272df551d792e1ac/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f646566696e6974696f6e732f67726170682f62616467652e7376673f746f6b656e3d39737258506157476c6a)](https://codecov.io/gh/yiisoft/definitions)[![Mutation testing badge](https://camo.githubusercontent.com/2a905468b651dd1589784893fde4b3fe19ecb59cc186ca931e9958541d6a1ecf/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246646566696e6974696f6e732532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/definitions/master)[![Static analysis](https://github.com/yiisoft/definitions/actions/workflows/static.yml/badge.svg?branch=master)](https://github.com/yiisoft/definitions/actions/workflows/static.yml?query=branch%3Amaster)[![type-coverage](https://camo.githubusercontent.com/10d0821893f7ffb3dda5a6e2f59953b529d9f7545bccb23cce86d49169db710e/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f646566696e6974696f6e732f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/definitions)

The package provides syntax constructs describing a way to create and configure a service or an object. It is used by [yiisoft/di](https://github.com/yiisoft/di) and [yiisoft/factory](https://github.com/yiisoft/factory)but could be used in other [PSR-11](https://www.php-fig.org/psr/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
------------

[](#requirements)

- PHP 8.1 - 8.5.

Installation
------------

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/definitions
```

General usage
-------------

[](#general-usage)

### Definitions

[](#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 an object at the moment of getting a service instance or creating an object.

#### `ArrayDefinition`

[](#arraydefinition)

Array definition allows describing a service or an object declaratively:

```
use \Yiisoft\Definitions\ArrayDefinition;

$definition = ArrayDefinition::fromConfig([
    'class' => MyServiceInterface::class,
    '__construct()' => [42],
    '$propertyName' => 'value',
    'setName()' => ['Alex'],
]);
$object = $definition->resolve($container);
```

In the above:

- `class` contains the name of the class to be instantiated.
- `__construct()` holds an array of constructor arguments.
- The rests 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:

```
[
    'class' => Collector::class,
    'add()' => ['Alex'],
    'add()2' => ['Mike'],
]
```

#### `CallableDefinition`

[](#callabledefinition)

Callable definition builds an object by executing a callable injecting dependencies based on types used in its signature:

```
use \Yiisoft\Definitions\CallableDefinition;

$definition = new CallableDefinition(
    fn (SomeFactory $factory) => $factory->create('args')
);
$object = $definition->resolve($container);

// or

$definition = new CallableDefinition(
    fn () => MyFactory::create('args')
);
$object = $definition->resolve($container);

// or

$definition = new CallableDefinition(
    [MyFactory::class, 'create']
);
$object = $definition->resolve($container);
```

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`

[](#parameterdefinition)

Parameter definition resolves an object based on information from `ReflectionParameter` instance:

```
use \Yiisoft\Definitions\ParameterDefinition;

$definition = new ParameterDefinition($reflectionParameter);
$object = $definition->resolve($container);
```

It is mostly used internally when working with callables.

#### `ValueDefinition`

[](#valuedefinition)

Value definition resolves value passed as is:

```
use \Yiisoft\Definitions\ValueDefinition;

$definition = new ValueDefinition(42, 'int');
$value = $definition->resolve($container); // 42
```

### References

[](#references)

References point to other definitions, so when defining a definition, you can use other definitions as its dependencies:

```
[
    InterfaceA::class => ConcreteA::class,
    'alternativeForA' => ConcreteB::class,
    MyService::class => [
        '__construct()' => [
            Reference::to('alternativeForA'),
        ],
    ],
]
```

Optional reference returns `null` when there's no corresponding definition in container:

```
[
    MyService::class => [
        '__construct()' => [
            // If a container doesn't have definition for `EventDispatcherInterface` reference returns `null`
            // when resolving dependencies
            Reference::optional(EventDispatcherInterface::class),
        ],
    ],
]
```

The `DynamicReference` defines a dependency to a service not defined in the container:

```
[
   MyService::class => [
       '__construct()' => [
           DynamicReference::to([
               'class' => SomeClass::class,
               '$someProp' => 15
           ])
       ]
   ]
]
```

To pass an array of IDs as references to a property or an argument, `Yiisoft\Definitions\ReferencesArray` or `Yiisoft\Definitions\DynamicReferencesArray` could be used:

```
//params.php
return [
   'yiisoft/data-response' => [
       'contentFormatters' => [
           'text/html' => HtmlDataResponseFormatter::class,
           'application/xml' => XmlDataResponseFormatter::class,
           'application/json' => JsonDataResponseFormatter::class,
       ],
   ],
];

//web.php

ContentNegotiator::class => [
    '__construct()' => [
        'contentFormatters' => ReferencesArray::from($params['yiisoft/data-response']['contentFormatters']),
    ],
],
```

### Class aliases

[](#class-aliases)

To define another instance of a class with specific configuration, you can use native PHP `class_alias()`:

```
class_alias(Yiisoft\Db\Pgsql\Connection::class, 'MyPgSql');

return [
    MyPgSql::class => [ ... ]
];
```

### Definition storage

[](#definition-storage)

Definition storage could be used to hold and get definitions and check if a certain definition could be instantiated. Usually it is used by an implementation using the definitions:

```
use Yiisoft\Definitions\DefinitionStorage;

$storage = new DefinitionStorage([
    MyInterface::class => MyClass::class,
]);
$storage->setDelegateContainer($fallbackContainer);

if (!$storage->has(MyInterface::class)) {
    $buildStack = $storage->getBuildStack();
    // ...
}
```

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:

```
use Yiisoft\Definitions\DefinitionStorage;

$storage = new DefinitionStorage([], true);
var_dump($storage->has(EngineMarkOne::class));
```

`has()` will return `false` even if `EngineMarkOne` exists.

Documentation
-------------

[](#documentation)

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii Definitions is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

Support the project
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

61

—

FairBetter than 99% of packages

Maintenance71

Regular maintenance activity

Popularity48

Moderate usage in the ecosystem

Community37

Small or concentrated contributor base

Maturity76

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~112 days

Recently: every ~256 days

Total

14

Last Release

168d ago

Major Versions

1.0.2 → 2.0.02022-06-17

2.1.0 → 3.0.02022-11-04

PHP version history (4 changes)1.0.0PHP ^7.4|^8.0

3.0.0PHP ^8.0

3.4.0PHP ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0

3.4.1PHP 8.1 - 8.5

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (59 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (33 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (31 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (7 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (6 commits)")[![yiiliveext](https://avatars.githubusercontent.com/u/37578608?v=4)](https://github.com/yiiliveext "yiiliveext (5 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (3 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (2 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (1 commits)")

---

Tags

di-containerfactoryhacktoberfestyii3definitions

###  Code Quality

TestsPHPUnit

Static AnalysisRector

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/yiisoft-definitions/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-definitions/health.svg)](https://phpackages.com/packages/yiisoft-definitions)
```

###  Alternatives

[cakephp/cakephp

The CakePHP framework

8.8k18.5M1.6k](/packages/cakephp-cakephp)[silverstripe/framework

The SilverStripe framework

7213.5M2.5k](/packages/silverstripe-framework)[drupal/core-recommended

Locked core dependencies; require this project INSTEAD OF drupal/core.

6939.5M343](/packages/drupal-core-recommended)[cakephp/core

CakePHP Framework Core classes

6126.8M39](/packages/cakephp-core)[contao/core-bundle

Contao Open Source CMS

1231.6M2.4k](/packages/contao-core-bundle)[neos/flow

Flow Application Framework

862.0M451](/packages/neos-flow)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)