-
Notifications
You must be signed in to change notification settings - Fork 97
Info about Lazy Subscriber #273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
66 changes: 66 additions & 0 deletions
66
docs/building-extensions/plugins/advanced-plugin-features.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| Advanced Plugin features | ||
| ======================== | ||
|
|
||
| ## Lazy Subscriber | ||
|
|
||
| The decorator `Joomla\CMS\Event\LazyServiceSubscriber` allows to instantiate the plugin with heavy dependencies only when the event is actually dispatched. | ||
| The plugin should implement `Joomla\Event\SubscriberInterface` to be able to use decorator. | ||
|
|
||
| Note that the use of the lazy decorator does not make sense when the plugin is subscribed to events that happen regularly, like `onAfterInitialise`. | ||
|
|
||
| Additionally, the interface `Joomla\CMS\Event\LazySubscriberInterface` allows to use [`LazyServiceEventListener`](https://github.com/joomla-framework/event/blob/2.0-dev/src/LazyServiceEventListener.php), however the plugin should implement it on its own. | ||
|
|
||
| ### Example usage of the lazy subscriber decorator for the plugin with heavy dependencies: | ||
|
|
||
| Code for `plugins/system/example/services/provider.php`. | ||
|
|
||
| **Before, regular plugin service:** | ||
| ```php | ||
| return new class () implements ServiceProviderInterface { | ||
| public function register(Container $container) | ||
| { | ||
| $container->set( | ||
| PluginInterface::class, | ||
| function (Container $container) { | ||
| $heavyDependency1 = $container->get(Foo::class); | ||
| $heavyDependency2 = $container->get(Bar::class); | ||
|
|
||
| return new ExamplePlugin( | ||
| $container->get(DispatcherInterface::class), | ||
| (array) PluginHelper::getPlugin('system', 'example'), | ||
| $heavyDependency1, | ||
| $heavyDependency2 | ||
| ); | ||
| } | ||
| ); | ||
| } | ||
| } | ||
| ``` | ||
| **After, plugin service with LazyServiceSubscriber:** | ||
|
|
||
| ```php | ||
| return new class () implements ServiceProviderInterface { | ||
| public function register(Container $container) | ||
| { | ||
| $container->set( | ||
| ExamplePlugin::class, | ||
| function (Container $container) { | ||
| $heavyDependency1 = $container->get(Foo::class); | ||
| $heavyDependency2 = $container->get(Bar::class); | ||
|
|
||
| return new ExamplePlugin( | ||
| $container->get(DispatcherInterface::class), | ||
| (array) PluginHelper::getPlugin('system', 'example'), | ||
| $heavyDependency1, | ||
| $heavyDependency2 | ||
| ); | ||
| } | ||
| )->set( | ||
| PluginInterface::class, | ||
| function (Container $container) { | ||
| return new LazyServiceSubscriber($container, ExamplePlugin::class); | ||
| } | ||
| ); | ||
| } | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.