[6.x] Replace Yii2 Element events with Laravel events

src/Asset/Elements/Asset.php

@@ -32,9 +32,6 @@
 use craft\errors\FsException;
 use craft\errors\ImageTransformException;
 use craft\errors\VolumeException;
-use craft\events\AssetEvent;
-use craft\events\DefineAssetUrlEvent;
-use craft\events\GenerateTransformEvent;
 use craft\gql\interfaces\elements\Asset as AssetInterface;
 use craft\helpers\Assets;
 use craft\helpers\Cp;
@@ -56,6 +53,11 @@
 use craft\validators\AssetLocationValidator;
 use craft\web\twig\AllowedInSandbox;
 use CraftCms\Aliases\Aliases;
+use CraftCms\Cms\Asset\Events\AfterGenerateTransform;
+use CraftCms\Cms\Asset\Events\BeforeDefineAssetUrl;
+use CraftCms\Cms\Asset\Events\BeforeGenerateTransform;
+use CraftCms\Cms\Asset\Events\BeforeHandleFile;
+use CraftCms\Cms\Asset\Events\DefineAssetUrl;
 use CraftCms\Cms\Asset\Models\Asset as AssetModel;
 use CraftCms\Cms\Asset\Validation\AssetRules;
 use CraftCms\Cms\Cms;
@@ -128,40 +130,8 @@
  * @property-read string|null $mimeType the file’s MIME type, if it can be determined
  */
 #[Ruleset(AssetRules::class)]
-final class Asset extends Element
+class Asset extends Element
 {
-    // Events
-    // -------------------------------------------------------------------------
-
-    /**
-     * @event AssetEvent The event that is triggered before an asset is uploaded to volume.
-     */
-    public const string EVENT_BEFORE_HANDLE_FILE = 'beforeHandleFile';
-
-    /**
-     * @event GenerateTransformEvent The event that is triggered before a transform is generated for an asset.
-     */
-    public const string EVENT_BEFORE_GENERATE_TRANSFORM = 'beforeGenerateTransform';
-
-    /**
-     * @event GenerateTransformEvent The event that is triggered after a transform is generated for an asset.
-     */
-    public const string EVENT_AFTER_GENERATE_TRANSFORM = 'afterGenerateTransform';
-
-    /**
-     * @event DefineAssetUrlEvent The event that is triggered before defining the asset’s URL.
-     *
-     * @see getUrl()
-     */
-    public const string EVENT_BEFORE_DEFINE_URL = 'beforeDefineUrl';
-
-    /**
-     * @event DefineAssetUrlEvent The event that is triggered when defining the asset’s URL.
-     *
-     * @see getUrl()
-     */
-    public const string EVENT_DEFINE_URL = 'defineUrl';
-
     // Location error codes
     // -------------------------------------------------------------------------
 
@@ -2087,35 +2057,20 @@ public function getUrl(mixed $transform = null, ?bool $immediately = null): ?str
 
         $transform ??= $this->_transform;
 
-        // Fire a 'beforeDefineUrl' event
-        if ($this->hasEventHandlers(self::EVENT_BEFORE_DEFINE_URL)) {
-            $event = new DefineAssetUrlEvent([
-                'transform' => $transform,
-                'asset' => $this,
-            ]);
-            $this->trigger(self::EVENT_BEFORE_DEFINE_URL, $event);
-            $url = $event->url;
-        } else {
-            $url = null;
-        }
+        event($event = new BeforeDefineAssetUrl($this, $transform));
+
+        $url = $event->url;
 
-        // If DefineAssetUrlEvent::$url is set to null, only respect that if $handled is true
-        if ($url === null && ! ($event->handled ?? false)) {
+        // If BeforeDefineAssetUrl::$url is set to null, only respect that if $handled is true
+        if ($event->url === null && ! ($event->handled ?? false)) {
             $url = $this->_url($transform, $immediately);
         }
 
-        // Fire a 'defineUrl' event
-        if ($this->hasEventHandlers(self::EVENT_DEFINE_URL)) {
-            $event = new DefineAssetUrlEvent([
-                'url' => $url,
-                'transform' => $transform,
-                'asset' => $this,
-            ]);
-            $this->trigger(self::EVENT_DEFINE_URL, $event);
-            // If DefineAssetUrlEvent::$url is set to null, only respect that if $handled is true
-            if ($event->url !== null || $event->handled) {
-                $url = $event->url;
-            }
+        event($event = new DefineAssetUrl($this, $transform, $url));
+
+        // If DefineAssetUrl::$url is set to null, only respect that if $handled is true
+        if ($event->url !== null || $event->handled) {
+            $url = $event->url;
         }
 
         return $url !== null ? Html::encodeSpaces($url) : $url;
@@ -2157,17 +2112,11 @@ private function _url(mixed $transform = null, ?bool $immediately = null): ?stri
                 $immediately = Cms::config()->generateTransformsBeforePageLoad;
             }
 
-            // Fire a 'beforeGenerateTransform' event
-            if ($this->hasEventHandlers(self::EVENT_BEFORE_GENERATE_TRANSFORM)) {
-                $event = new GenerateTransformEvent([
-                    'asset' => $this,
-                    'transform' => $transform,
-                ]);
-                $this->trigger(self::EVENT_BEFORE_GENERATE_TRANSFORM, $event);
-                // If a plugin set the url, we'll just use that.
-                if ($event->url !== null) {
-                    return Html::encodeSpaces($event->url);
-                }
+            event($event = new BeforeGenerateTransform($this, $transform));
+
+            // If a plugin set the url, we'll just use that.
+            if ($event->url !== null) {
+                return Html::encodeSpaces($event->url);
             }
 
             $imageTransformer = $transform->getImageTransformer();
@@ -2183,15 +2132,7 @@ private function _url(mixed $transform = null, ?bool $immediately = null): ?stri
                 return null;
             }
 
-            // Fire an 'afterGenerateTransform' event
-            if ($this->hasEventHandlers(self::EVENT_AFTER_GENERATE_TRANSFORM)) {
-                $event = new GenerateTransformEvent([
-                    'asset' => $this,
-                    'transform' => $transform,
-                    'url' => $url,
-                ]);
-                $this->trigger(self::EVENT_AFTER_GENERATE_TRANSFORM, $event);
-            }
+            event(new AfterGenerateTransform($this, $transform, $url));
 
             return $url;
         }
@@ -3120,14 +3061,8 @@ public function beforeSave(bool $isNew): bool
         }
 
         // Fire a 'beforeHandleFile' event if we're going to be doing any file operations in afterSave()
-        if (
-            (isset($this->newLocation) || isset($this->tempFilePath)) &&
-            $this->hasEventHandlers(self::EVENT_BEFORE_HANDLE_FILE)
-        ) {
-            $this->trigger(self::EVENT_BEFORE_HANDLE_FILE, new AssetEvent([
-                'asset' => $this,
-                'isNew' => ! $this->id,
-            ]));
+        if (isset($this->newLocation) || isset($this->tempFilePath)) {
+            event(new BeforeHandleFile($this, isNew: ! $this->id));
         }
 
         // Set the kind based on filename

src/Asset/Events/AfterGenerateTransform.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Asset\Events;
+
+use craft\models\ImageTransform;
+use CraftCms\Cms\Asset\Elements\Asset;
+
+/**
+ * @event AfterGenerateTransform The event that is triggered after a transform is generated for an asset.
+ */
+final readonly class AfterGenerateTransform
+{
+    public function __construct(
+        public Asset $asset,
+        public ImageTransform|string|array|null $transform,
+        public string $url,
+    ) {}
+}

src/Asset/Events/BeforeDefineAssetUrl.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Asset\Events;
+
+use craft\models\ImageTransform;
+use CraftCms\Cms\Asset\Elements\Asset;
+use CraftCms\Cms\Element\Events\BeforeDefineUrl;
+
+/**
+ * @event BeforeDefineAssetUrl The event that is triggered before defining the asset’s URL.
+ *
+ * @see getUrl()
+ */
+final class BeforeDefineAssetUrl extends BeforeDefineUrl
+{
+    public function __construct(
+        public Asset $asset,
+        public ImageTransform|string|array|null $transform,
+        public ?string $url = null,
+    ) {
+        parent::__construct($asset, $url);
+    }
+}

src/Asset/Events/BeforeGenerateTransform.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Asset\Events;
+
+use craft\models\ImageTransform;
+use CraftCms\Cms\Asset\Elements\Asset;
+
+/**
+ * @event BeforeGenerateTransform The event that is triggered before a transform is generated for an asset.
+ */
+final class BeforeGenerateTransform
+{
+    public function __construct(
+        public Asset $asset,
+        public ImageTransform|string|array|null $transform,
+        public ?string $url = null,
+    ) {}
+}

src/Asset/Events/BeforeHandleFile.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Asset\Events;
+
+use CraftCms\Cms\Asset\Elements\Asset;
+
+/**
+ * @event BeforeHandleFile The event that is triggered before an asset is uploaded to volume.
+ */
+final class BeforeHandleFile
+{
+    public function __construct(
+        public Asset $asset,
+        public bool $isNew,
+    ) {}
+}

src/Asset/Events/DefineAssetUrl.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Asset\Events;
+
+use craft\models\ImageTransform;
+use CraftCms\Cms\Asset\Elements\Asset;
+use CraftCms\Cms\Element\Events\DefineUrl;
+
+/**
+ * @event DefineAssetUrl The event that is triggered when defining the asset’s URL.
+ *
+ * @see getUrl()
+ */
+final class DefineAssetUrl extends DefineUrl
+{
+    public function __construct(
+        public Asset $asset,
+        public ImageTransform|string|array|null $transform,
+        public ?string $url = null,
+    ) {
+        parent::__construct($asset, $url);
+    }
+}

src/Cp/Events/RegisterCpNavItems.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Cp\Events;
+
+/**
+ * @event RegisterCpNavItems The event that is triggered when registering control panel nav items.
+ *
+ * ```php
+ * use CraftCms\Cms\Cp\Events\RegisterCpNavItems;
+ * use Illuminate\Support\Facades\Event;
+ *
+ * Event::listen(
+ *     function(RegisterCpNavItems $e) {
+ *         $e->navItems[] = [
+ *             'label' => 'Item Label',
+ *             'url' => 'my-module',
+ *             'icon' => '/path/to/icon.svg',
+ *         ];
+ *     }
+ * );
+ * ```
+ *
+ * [[RegisterCpNavItems::$navItems]] is an array whose values are sub-arrays that define the nav items. Each sub-array can have the following keys:
+ *
+ * - `label` – The item’s label.
+ * - `url` – The URL or path of the control panel page the item should link to.
+ * - `icon` – The path to the SVG icon that should be used for the item.
+ * - `badgeCount` _(optional)_ – The badge count number that should be displayed next to the label.
+ * - `external` _(optional)_ – Set to `true` if the item links to an external URL.
+ * - `id` _(optional)_ – The ID of the `<li>` element. If not specified, it will default to `nav-`.
+ * - `subnav` _(optional)_ – A nested array of sub-navigation items that should be displayed if the main item is selected.
+ *
+ *   The keys of the array should define the items’ IDs, and the values should be nested arrays with `label` and `url` keys, and optionally
+ *   `badgeCount` and `external` keys.
+ *
+ * If a subnav is defined, subpages can specify which subnav item should be selected by defining a `selectedSubnavItem` variable that is set to
+ * the selected item’s ID (its key in the `subnav` array).
+ */
+final class RegisterCpNavItems
+{
+    public function __construct(
+        public array $navItems,
+    ) {}
+}

src/Cp/Navigation.php

@@ -7,6 +7,7 @@
 use Craft;
 use craft\helpers\UrlHelper;
 use CraftCms\Cms\Config\GeneralConfig;
+use CraftCms\Cms\Cp\Events\RegisterCpNavItems;
 use CraftCms\Cms\Edition;
 use CraftCms\Cms\Plugin\Plugins;
 use CraftCms\Cms\Support\Facades\Sections;
@@ -162,13 +163,9 @@ public function getItems(): array
             ];
         }
 
-        // Fire a 'registerCpNavItems' event
-        // @TODO Bring this back
-        // if ($this->hasEventHandlers(self::EVENT_REGISTER_CP_NAV_ITEMS)) {
-        //     $event = new RegisterCpNavItemsEvent(['navItems' => $navItems]);
-        //     $this->trigger(self::EVENT_REGISTER_CP_NAV_ITEMS, $event);
-        //     $navItems = $event->navItems;
-        // }
+        event($event = new RegisterCpNavItems($navItems));
+
+        $navItems = $event->navItems;
 
         // Figure out which item is selected, and normalize the items
         $path = $this->request->getPathInfo();

src/Element/Concerns/Cacheable.php

@@ -4,7 +4,7 @@
 
 namespace CraftCms\Cms\Element\Concerns;
 
-use craft\events\DefineValueEvent;
+use CraftCms\Cms\Element\Events\DefineCacheTags;
 
 /**
  * Cacheable provides cache tag management for elements.
@@ -16,15 +16,6 @@
  */
 trait Cacheable
 {
-    /**
-     * @event DefineValueEvent The event that is triggered when defining the cache tags that should be cleared when
-     * this element is saved.
-     *
-     * @see getCacheTags()
-     * @since 4.1.0
-     */
-    public const EVENT_DEFINE_CACHE_TAGS = 'defineCacheTags';
-
     /**
      * Returns the cache tags that should be cleared when this element is saved.
      *
@@ -34,17 +25,9 @@ trait Cacheable
      */
     public function getCacheTags(): array
     {
-        $cacheTags = $this->cacheTags();
-
-        // Fire a 'defineCacheTags' event
-        if ($this->hasEventHandlers(self::EVENT_DEFINE_CACHE_TAGS)) {
-            $event = new DefineValueEvent(['value' => $cacheTags]);
-            $this->trigger(self::EVENT_DEFINE_CACHE_TAGS, $event);
-
-            return $event->value;
-        }
+        event($event = new DefineCacheTags($this, $this->cacheTags()));
 
-        return $cacheTags;
+        return $event->tags;
     }
 
     /**