joomla-cms
joomla-cms copied to clipboard
joomla
[6.0] CMSPlugin: use Lazy Object feature
Summary of Changes
Alternative to https://github.com/joomla/joomla-cms/pull/43658
Use of PHP Lazy Object feature for plugins. This allows to instantiate the plugin only when event is triggered, and saving some resources (time and memory).
This does not applied automatically for every plugins, the plugin service provider need to be updated to support Lazy Object.
Few thing that need to figure out:
-
~Following code will trigger lazy object initialization, we need to get rid of it, somehow.~ https://github.com/joomla/joomla-cms/blob/2c859aa0da3cbc075c28b8d1da2222ba84a89c5d/libraries/src/Plugin/PluginHelper.php#L234-L236
-
Current use of
registerListeners()need to be deprecated. There is PR for it:
- https://github.com/joomla/joomla-cms/pull/43395 Would be good if it get in to 5.x.
As next step we have to:
OR change the return type to boolean for registerListeners(),
OR replace it with new method, see the PR:
- https://github.com/joomla/joomla-cms/pull/43657
Testing Instructions
Apply patch, and test on PHP 8.x and 8.4 The following plugins should work as before:
- schedulerunner
- tasknotification
- webauthn
Link to documentations
Please select:
- [ ] Documentation link for docs.joomla.org:
- [ ] No documentation changes for docs.joomla.org needed
- [ ] Pull Request link for manual.joomla.org: TBD
- [ ] No documentation changes for manual.joomla.org needed
As said already, this should be done in the DI container and not every plugin itself should implement this. Or do you see problems when the DI container does that?
Similar cod you have in the service provider, I would do here https://github.com/joomla-framework/di/blob/3.x-dev/src/ContainerResource.php#L160.
hm, yeah, that also could work, need to check. We need it to be flexible.
But I thought that you have some ready to use solution :)
I would suggest to add a simple shortcut for creating lazy proxies:
// Container
public function lazy(string $class, callable $factory): callable
{
if (PHP_VERSION_ID < 80400) {
return $factory;
}
return function () use ($class, $factory) {
return (new \ReflectionClass($class))->newLazyProxy(fn() => $factory($this));
};
}
Then defining lazy service would look like this:
$container->share(
'foo',
$container->lazy(Foo::class, function($container) {
return new Foo($container->get('bar'));
}),
);
Full implementation you can see here:
I've created a PR with more advanced implementation: https://github.com/joomla-framework/di/pull/58
@laoneo That is require changes in Container code with b/c breaks (need new flags and changed method signature). @voronkovich That implementation does not look good.
I will keep it without DI, there more important issue that need to resolve to make it work.
I'm pretty sure that this can be achieved in a backwards compatible way or with a minimum of bc breaks which shouldn't affect the CMS code.
I was playing around with lazy objects and made a lightweight version with https://github.com/joomla-framework/di/pull/63. You can see the outcome in #45392. It doesn't affect the existing CMS code but allows us to define a service with a lazy object.
@laoneo fedir update the pr to use reflections, this would solve the b/c problem without introducing a new interface.
It still fine, with introducing of "Reflection checker" it does not change existing behavior.
✅ Tested my random quotation module zitat-service.de with JBT: it installs from JED Web, is is configurable and working on frontend site
