Skip to content

Commit

Permalink
Merge pull request #54 from visto9259/fix_51
Browse files Browse the repository at this point in the history
updated LazyListeners (#51) and navigation (#52)
  • Loading branch information
Ocramius committed Jun 24, 2024
2 parents ce5ba8b + a39f492 commit 933d1b5
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 32 deletions.
4 changes: 2 additions & 2 deletions doc/book/lazy-listeners/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ The feature consists of three classes:
## Preparation

In order to use the lazy listeners feature, you will need to install
container-interop, if you haven't already:
[PSR-11](https://www.php-fig.org/psr/psr-11/) Container, if you haven't already:

```bash
$ composer require container-interop/container-interop
$ composer require psr/container
```
2 changes: 1 addition & 1 deletion doc/book/lazy-listeners/lazy-event-listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ As an example, let's assume:
- we want to attach it to the event `dispatch`,
- at priority 100.

Additionally, we'll assume that we have a container-interop instance in the
Additionally, we'll assume that we have a PSR-11 container instance in the
variable `$container` and an event manager in the variable `$events`.

You could create the lazy event listener as follows:
Expand Down
2 changes: 1 addition & 1 deletion doc/book/lazy-listeners/lazy-listener-aggregate.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ number of listeners as lazy listeners.

Similar to a [LazyListener](lazy-listener.md) or
[LazyEventListener](lazy-event-listener.md), the `LazyListenerAggregate` accepts
a definition (or, rather, set of definitions) a container-interop instance, and
a definition (or, rather, set of definitions), a PSR-11 container instance, and
optionall an `$env` array to its constructor.

Unlike either, however, the definition provided is an array of definitions to
Expand Down
6 changes: 3 additions & 3 deletions doc/book/lazy-listeners/lazy-listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To create a `LazyListener` instance, you must pass to its constructor:
- a *definition* of the listener; this is an array defining:
- a `listener` key, with the name of the listener service to pull from the container.
- a `method` key, with the name of the method to invoke on the listener instance.
- a *container*; this is a [container-interop](https://github.com/container-interop/container-interop),
- a *container*; this is a [PSR-11](https://www.php-fig.org/psr/psr-11/) container,
such as provided by
[laminas-servicemanager](https://github.com/laminas/laminas-servicemanager),
[Aura.Di](https://github.com/auraphp/Aura.Di), etc.
Expand All @@ -24,10 +24,10 @@ As an example, let's assume:
- We have a listener registered in our container with the service name
`My\Application\Listener`.
- The specific listener method is `onDispatch`.
- I have a container-interop instance in the variable `$container` and an event
- You have a PSR-11 container instance in the variable `$container` and an event
manager in the variable `$events`.

I might then create and attach my lazy listener as follows:
You might then create and attach your lazy listener as follows:

```php
use My\Application\Listener;
Expand Down
49 changes: 24 additions & 25 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,29 @@
docs_dir: doc/book
site_dir: doc/html
nav:
- Home: index.md
- Intro: intro.md
- "Quick Start": quick-start.md
- Tutorial: tutorial.md
- Examples: examples.md
- Reference:
- "Wildcard Listeners": wildcard-listeners.md
- "Listener Aggregates": aggregates.md
- "Lazy Listeners":
- Intro: lazy-listeners/intro.md
- LazyListener: lazy-listeners/lazy-listener.md
- LazyEventListener: lazy-listeners/lazy-event-listener.md
- LazyListenerAggregate: lazy-listeners/lazy-listener-aggregate.md
- "EventManager API": api.md
- "Intercepting Filters": intercepting-filters.md
- "Application Integration":
- "Usage in a laminas-mvc Application": application-integration/usage-in-a-laminas-mvc-application.md
- "Migration Guide":
- Intro: migration/intro.md
- "Removed Functionality": migration/removed.md
- "Changed Functionality": migration/changed.md
- Home: index.md
- Intro: intro.md
- Quick Start: quick-start.md
- Tutorial: tutorial.md
- Examples: examples.md
- Wildcard Listeners: wildcard-listeners.md
- Listener Aggregates: aggregates.md
- Lazy Listeners:
- Intro: lazy-listeners/intro.md
- LazyListener: lazy-listeners/lazy-listener.md
- LazyEventListener: lazy-listeners/lazy-event-listener.md
- LazyListenerAggregate: lazy-listeners/lazy-listener-aggregate.md
- EventManager API: api.md
- Intercepting Filters: intercepting-filters.md
- Application Integration:
- Usage in a laminas-mvc Application: application-integration/usage-in-a-laminas-mvc-application.md
- Migration Guide:
- Intro: migration/intro.md
- Removed Functionality: migration/removed.md
- Changed Functionality: migration/changed.md
repo_url: https://github.com/laminas/laminas-eventmanager
site_description: Implement events, signal slots, aspects, and observers!
site_name: laminas-eventmanager
site_description: 'Implement events, signal slots, aspects, and observers!'
repo_url: 'https://github.com/laminas/laminas-eventmanager'
extra:
project: Components
show_special_homepage: true
project: Components
show_special_homepage: true

0 comments on commit 933d1b5

Please sign in to comment.