PHPackages                             yiisoft/yii-event - 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/yii-event

ActiveLibrary[Framework](/categories/framework)

yiisoft/yii-event
=================

Yii Event

2.2.0(5mo ago)17306.6k—0.3%10[1 issues](https://github.com/yiisoft/yii-event/issues)[1 PRs](https://github.com/yiisoft/yii-event/pulls)8BSD-3-ClausePHPPHP 8.1 - 8.5CI passing

Since May 13Pushed 5mo ago17 watchersCompare

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

READMEChangelog (4)Dependencies (13)Versions (9)Used By (8)

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

Yii Event
=========

[](#yii-event)

[![Latest Stable Version](https://camo.githubusercontent.com/fc6e7c2ace2841ac663a1991900af72f0f4a32d1b72ed7dfa3489dfbf114d9e8/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d6576656e742f76)](https://packagist.org/packages/yiisoft/yii-event)[![Total Downloads](https://camo.githubusercontent.com/7c5c188325abc9a186d17ed4d6b59495d373097518328cb4a4a9b750f72cb60f/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d6576656e742f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/yii-event)[![Build status](https://github.com/yiisoft/yii-event/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/yii-event/actions/workflows/build.yml)[![Code coverage](https://camo.githubusercontent.com/0674a4bce86d7f2d2f14184e6f0f5c55a87d08e989016ecc5577da66cad23e94/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f7969692d6576656e742f67726170682f62616467652e7376673f746f6b656e3d533351584f3643485638)](https://codecov.io/gh/yiisoft/yii-event)[![Mutation testing badge](https://camo.githubusercontent.com/6ce5c786db15836f1b05b676859808e8a1a624bbc43e5eb43c42f48f459094d2/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f66742532467969692d6576656e742532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-event/master)[![static analysis](https://github.com/yiisoft/yii-event/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-event/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/6aabad314a10659366e36f86cd7a7d724aa844642bb529811a0f2c97451a12c7/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f7969692d6576656e742f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/yii-event)

This package is a configuration wrapper for the [yiisoft/event-dispatcher](https://github.com/yiisoft/event-dispatcher) package. It is intended to make event listener declaration simpler than you could ever imagine. All you need is to use any [PSR-11](https://www.php-fig.org/psr/psr-11/) compatible DI container.

Requirements
------------

[](#requirements)

- PHP 8.1 - 8.5.

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

[](#installation)

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

```
composer require yiisoft/yii-event
```

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

[](#general-usage)

### DI configuration

[](#di-configuration)

You can find default configuration in the [config directory](config):

- [di.php](config/di.php) contains the configuration for the [PSR-14](https://www.php-fig.org/psr/psr-14/) interfaces.
- [di-web.php](config/di-web.php) and [di-console.php](config/di-consle.php) contains the configuration for the `Yiisoft\EventDispatcher\Provider\ListenerCollection`.
- [params-web.php](config/params-web.php) and [params-console.php](config/params-consle.php) contains parameters for `web` and `console` configurations.

All these settings will be used automatically in projects with the [yiisoft/config](https://github.com/yiisoft/config).

If you have custom `events` configuration group name, for example `events-api`, redefine it in the `eventsConfigGroup` params key.

params.php

```
return [
    'yiisoft/yii-event' => [
        'eventsConfigGroup' => 'events-api',
    ],
]
```

### Event configuration example

[](#event-configuration-example)

The configuration is an array where keys are event names and values are array of handlers:

```
return [
    EventName::class => [
        // Just a regular closure, it will be called from the Dispatcher "as is".
        static fn (EventName $event) => someStuff($event),

        // A regular closure with additional dependency. All the parameters after the first one (the event itself)
        // will be resolved from your DI container within `yiisoft/injector`.
        static fn (EventName $event, DependencyClass $dependency) => someStuff($event),

        // An example with a regular callable. If the `staticMethodName` method contains some dependencies,
        // they will be resolved the same way as in the previous example.
        [SomeClass::class, 'staticMethodName'],

        // Non-static methods are allowed too. In this case `SomeClass` will be instantiated by your DI container.
        [SomeClass::class, 'methodName'],

        // An object of a class with the `__invoke` method implemented
        new InvokableClass(),

        // In this case the `InvokableClass` with the `__invoke` method will be instantiated by your DI container
        InvokableClass::class,

        // Any definition of an invokable class may be here while your `$container->has('the definition)`
        'di-alias'
    ],
];
```

The dependency resolving is done in a lazy way: dependencies will not be resolved before the corresponding event will happen.

### Configuration checker

[](#configuration-checker)

To help you with event listener configuration validation there is the `ListenerConfigurationChecker`. It is converting your whole listener config to actual callables at once to validate it. It is intended to be used in development environment or in tests since it is a resource greedy operation in large projects. An `InvalidEventConfigurationFormatException`will be thrown if your configuration contains an invalid listener.

Usage example:

```
$checker->check($configuration->get('events-web'));
```

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 Event 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

59

—

FairBetter than 99% of packages

Maintenance72

Regular maintenance activity

Popularity45

Moderate usage in the ecosystem

Community36

Small or concentrated contributor base

Maturity75

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 ~280 days

Recently: every ~388 days

Total

7

Last Release

151d ago

Major Versions

1.0.3 → 2.0.02023-02-16

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

2.0.0PHP ^8.0

2.2.0PHP 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

[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (28 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (24 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (10 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (7 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (7 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (5 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (4 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (3 commits)")[![thenotsoft](https://avatars.githubusercontent.com/u/44147615?v=4)](https://github.com/thenotsoft "thenotsoft (2 commits)")[![romkatsu](https://avatars.githubusercontent.com/u/1677515?v=4)](https://github.com/romkatsu "romkatsu (1 commits)")[![execut](https://avatars.githubusercontent.com/u/2357407?v=4)](https://github.com/execut "execut (1 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (1 commits)")[![olegbaturin](https://avatars.githubusercontent.com/u/15981018?v=4)](https://github.com/olegbaturin "olegbaturin (1 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (1 commits)")

---

Tags

eventshacktoberfestyii3eventyii3

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm, Rector

Type Coverage Yes

### Embed Badge

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

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

###  Alternatives

[yiisoft/yii-dataview

Yii data displaying widgets

4252.6k1](/packages/yiisoft-yii-dataview)[yiisoft/app

Yii3 web application template

35512.3k](/packages/yiisoft-app)[yiisoft/widget

Widget

25230.9k15](/packages/yiisoft-widget)[yiisoft/event-dispatcher

Yii Event Dispatcher

72900.2k25](/packages/yiisoft-event-dispatcher)[yiisoft/yii-cycle

Cycle ORM v2 support

47115.1k](/packages/yiisoft-yii-cycle)[yiisoft/error-handler

Yii Error Handling Library

21363.6k15](/packages/yiisoft-error-handler)

PHPackages © 2026

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