Skip to content
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

[5.2][Events] Use event classes for Extension plugins #43617

Merged
merged 8 commits into from
Aug 28, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
extension finder
  • Loading branch information
Fedik committed Jun 4, 2024
commit 547996a125f45ac148574963df88750fe9509456
47 changes: 35 additions & 12 deletions plugins/extension/finder/src/Extension/Finder.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,16 @@

namespace Joomla\Plugin\Extension\Finder\Extension;

use Joomla\CMS\Event\Extension\AbstractExtensionEvent;
use Joomla\CMS\Event\Extension\AfterInstallEvent;
use Joomla\CMS\Event\Extension\AfterUninstallEvent;
use Joomla\CMS\Event\Extension\AfterUpdateEvent;
use Joomla\CMS\Installer\Installer;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\Component\Finder\Administrator\Indexer\Helper;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\ParameterType;
use Joomla\Event\SubscriberInterface;
use Joomla\String\StringHelper;

// phpcs:disable PSR1.Files.SideEffects
Expand All @@ -26,22 +31,39 @@
*
* @since 4.0.0
*/
final class Finder extends CMSPlugin
final class Finder extends CMSPlugin implements SubscriberInterface
{
use DatabaseAwareTrait;

/**
* Returns an array of events this subscriber will listen to.
*
* @return array
*
* @since __DEPLOY_VERSION__
*/
public static function getSubscribedEvents(): array
{
return [
'onExtensionAfterInstall' => 'onExtensionAfterInstall',
'onExtensionAfterUpdate' => 'onExtensionAfterUpdate',
'onExtensionAfterUninstall' => 'onExtensionAfterUninstall',
];
}

/**
* Add common words to finder after language got installed
*
* @param Installer $installer Installer object
* @param integer $eid Extension Identifier
* @param AfterInstallEvent $event Event instance.
*
* @return void
*
* @since 4.0.0
*/
public function onExtensionAfterInstall($installer, $eid)
public function onExtensionAfterInstall(AbstractExtensionEvent $event): void
{
$eid = $event->getEid();

if (!$eid) {
return;
}
Expand All @@ -68,31 +90,32 @@ public function onExtensionAfterInstall($installer, $eid)
/**
* Add common words to finder after language got updated
*
* @param Installer $installer Installer object
* @param integer $eid Extension identifier
* @param AfterUpdateEvent $event Event instance.
*
* @return void
*
* @since 4.0.0
*/
public function onExtensionAfterUpdate($installer, $eid)
public function onExtensionAfterUpdate(AfterUpdateEvent $event): void
{
$this->onExtensionAfterInstall($installer, $eid);
$this->onExtensionAfterInstall($event);
}

/**
* Remove common words to finder after language got uninstalled
*
* @param Installer $installer Installer instance
* @param integer $eid Extension id
* @param boolean $removed Installation result
* @param AfterUninstallEvent $event Event instance.
*
* @return void
*
* @since 4.0.0
*/
public function onExtensionAfterUninstall($installer, $eid, $removed)
public function onExtensionAfterUninstall(AfterUninstallEvent $event): void
{
$installer = $event->getInstaller();
$eid = $event->getEid();
$removed = $event->getRemoved();

// Check that the language was successfully uninstalled.
if ($eid && $removed && $installer->extension->type === 'language') {
$this->removeCommonWords($installer->extension);
Expand Down