[6.2] [RFC] CMSPlugin: Subscriber Registration Checker Interface

[Fedik]

Summary of Changes

Adding Subscriber Registration Checker. Interface that allows Plugins to be checked before listener registration.
This allows the plugin to be registered only wheen special conditions are met, eg: only for specific application.

Testing Instructions

Code review by maintainers.

Edit

joomla-cms/plugins/system/guidedtours/src/Extension/GuidedTours.php

Lines 124 to 126 in 98f3ecd

	public function onBeforeCompileHead()
	{
	$app = $this->getApplication();

And add dd('Works'); at top of this method.

Then open Administrator page: you should get message "works"
And then open Site page: the page should be opened as usual

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: Info about new Subscriber Registration Checker Manual#272
• No documentation changes for manual.joomla.org needed

[HLeithner]

This pull request has been automatically rebased to 5.3-dev.

[HLeithner]

This pull request has been automatically rebased to 6.0-dev.

[HLeithner]

This pull request has been automatically rebased to 6.1-dev.

[HLeithner]

It's a bit contra productive if the check function gets no information about where to register.

We have the situation that we might not have an own dispatcher we want the plugin to register. Or we boot the plugin for the SiteRouter in the backend (see autoredirect plugin).

I also think it should be static so it doesn't access the plugin object it self.

More might be provided to the plugin to get a qualified answer to the "should register" question.

[Fedik]

Initially I wanted detached handler. Then service provider could be:

$container->set(PluginRegistrationChecker::class, function() {
  return true/false; 
});
$container->set(PluginInterface::class, function() {
 // our existing code for plugin initialisation
});

Then plugin helper checking for PluginRegistrationChecker first and only then for plugin.
But with current architecture it is not possible, and the checker need to be part of PluginInterface.

Also the idea that checker can access to the plugin parameters. We have plugin that can be configured to run: site/admin/both (example skipto plugin).

I set it to draft for now. Maybe later we will get a better idea.

[HLeithner]

This pull request has been automatically rebased to 6.2-dev.