BatchElementActionEvent → MultiElementActionEvent

craftcms · Dec 13, 2023 · ca62463 · ca62463
1 parent 3fd87cb
commit ca62463
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 15 deletions.
diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
@@ -259,6 +259,7 @@
 - Renamed `craft\base\PreviewableFieldInterface::getTableAttributeHtml()` to `getPreviewHtml()`.
 - Renamed `craft\base\conditions\BaseCondition::EVENT_REGISTER_CONDITION_RULE_TYPES` to `EVENT_REGISTER_CONDITION_RULES`.
 - Renamed `craft\base\conditions\BaseCondition::conditionRuleTypes()` to `selectableConditionRules()`.
+- Renamed `craft\events\BatchElementActionEvent` to `MultiElementActionEvent`.
 - Renamed `craft\events\RegisterConditionRuleTypesEvent` to `RegisterConditionRulesEvent`, and its `$conditionRuleTypes` property has been renamed to `$conditionRules`.
 - Renamed `craft\events\SetElementTableAttributeHtmlEvent` to `DefineAttributeHtmlEvent`.
 - Renamed `craft\fields\BaseRelationField::tableAttributeHtml()` to `previewHtml()`, and it now accepts an `ElementCollection` argument, rather than `Collection`.

diff --git a/src/console/controllers/ResaveController.php b/src/console/controllers/ResaveController.php
@@ -19,7 +19,7 @@
 use craft\elements\Tag;
 use craft\elements\User;
 use craft\errors\InvalidElementException;
-use craft\events\BatchElementActionEvent;
+use craft\events\MultiElementActionEvent;
 use craft\helpers\ElementHelper;
 use craft\helpers\Queue;
 use craft\helpers\StringHelper;
@@ -540,7 +540,7 @@ private function _resaveElements(ElementQueryInterface $query): int
         $elementsService = Craft::$app->getElements();
         $fail = false;
 
-        $beforeCallback = function(BatchElementActionEvent $e) use ($query, $count, $to) {
+        $beforeCallback = function(MultiElementActionEvent $e) use ($query, $count, $to) {
             if ($e->query === $query) {
                 $label = isset($this->propagateTo) ? 'Propagating' : 'Resaving';
                 $element = $e->element;
@@ -570,7 +570,7 @@ private function _resaveElements(ElementQueryInterface $query): int
             }
         };
 
-        $afterCallback = function(BatchElementActionEvent $e) use ($query, &$fail) {
+        $afterCallback = function(MultiElementActionEvent $e) use ($query, &$fail) {
             if ($e->query === $query) {
                 $element = $e->element;
                 if ($e->exception) {

diff --git a/src/events/BatchElementActionEvent.php → src/events/MultiElementActionEvent.php b/src/events/BatchElementActionEvent.php → src/events/MultiElementActionEvent.php
@@ -11,12 +11,12 @@
 use Throwable;
 
 /**
- * Batch element action event class.
+ * Multi element action event class.
  *
  * @author Pixel & Tonic, Inc. <[email protected]>
- * @since 3.2.0
+ * @since 5.0.0
  */
-class BatchElementActionEvent extends ElementQueryEvent
+class MultiElementActionEvent extends ElementQueryEvent
 {
     /**
      * @var ElementInterface The element being processed

diff --git a/src/services/Elements.php b/src/services/Elements.php
@@ -37,13 +37,13 @@
 use craft\errors\SiteNotFoundException;
 use craft\errors\UnsupportedSiteException;
 use craft\events\AuthorizationCheckEvent;
-use craft\events\BatchElementActionEvent;
 use craft\events\DeleteElementEvent;
 use craft\events\EagerLoadElementsEvent;
 use craft\events\ElementEvent;
 use craft\events\ElementQueryEvent;
 use craft\events\InvalidateElementCachesEvent;
 use craft\events\MergeElementsEvent;
+use craft\events\MultiElementActionEvent;
 use craft\events\RegisterComponentTypesEvent;
 use craft\fieldlayoutelements\CustomField;
 use craft\helpers\ArrayHelper;
@@ -216,12 +216,12 @@ class Elements extends Component
     public const EVENT_AFTER_RESAVE_ELEMENTS = 'afterResaveElements';
 
     /**
-     * @event BatchElementActionEvent The event that is triggered before an element is resaved.
+     * @event MultiElementActionEvent The event that is triggered before an element is resaved.
      */
     public const EVENT_BEFORE_RESAVE_ELEMENT = 'beforeResaveElement';
 
     /**
-     * @event BatchElementActionEvent The event that is triggered after an element is resaved.
+     * @event MultiElementActionEvent The event that is triggered after an element is resaved.
      */
     public const EVENT_AFTER_RESAVE_ELEMENT = 'afterResaveElement';
 
@@ -236,12 +236,12 @@ class Elements extends Component
     public const EVENT_AFTER_PROPAGATE_ELEMENTS = 'afterPropagateElements';
 
     /**
-     * @event BatchElementActionEvent The event that is triggered before an element is propagated.
+     * @event MultiElementActionEvent The event that is triggered before an element is propagated.
      */
     public const EVENT_BEFORE_PROPAGATE_ELEMENT = 'beforePropagateElement';
 
     /**
-     * @event BatchElementActionEvent The event that is triggered after an element is propagated.
+     * @event MultiElementActionEvent The event that is triggered after an element is propagated.
      */
     public const EVENT_AFTER_PROPAGATE_ELEMENT = 'afterPropagateElement';
 
@@ -1370,7 +1370,7 @@ public function resaveElements(
                 try {
                     // Fire a 'beforeResaveElement' event
                     if ($this->hasEventHandlers(self::EVENT_BEFORE_RESAVE_ELEMENT)) {
-                        $this->trigger(self::EVENT_BEFORE_RESAVE_ELEMENT, new BatchElementActionEvent([
+                        $this->trigger(self::EVENT_BEFORE_RESAVE_ELEMENT, new MultiElementActionEvent([
                             'query' => $query,
                             'element' => $element,
                             'position' => $position,
@@ -1403,7 +1403,7 @@ public function resaveElements(
 
                 // Fire an 'afterResaveElement' event
                 if ($this->hasEventHandlers(self::EVENT_AFTER_RESAVE_ELEMENT)) {
-                    $this->trigger(self::EVENT_AFTER_RESAVE_ELEMENT, new BatchElementActionEvent([
+                    $this->trigger(self::EVENT_AFTER_RESAVE_ELEMENT, new MultiElementActionEvent([
                         'query' => $query,
                         'element' => $element,
                         'position' => $position,
@@ -1459,7 +1459,7 @@ public function propagateElements(ElementQueryInterface $query, array|int $siteI
 
                 // Fire a 'beforePropagateElement' event
                 if ($this->hasEventHandlers(self::EVENT_BEFORE_PROPAGATE_ELEMENT)) {
-                    $this->trigger(self::EVENT_BEFORE_PROPAGATE_ELEMENT, new BatchElementActionEvent([
+                    $this->trigger(self::EVENT_BEFORE_PROPAGATE_ELEMENT, new MultiElementActionEvent([
                         'query' => $query,
                         'element' => $element,
                         'position' => $position,
@@ -1500,7 +1500,7 @@ public function propagateElements(ElementQueryInterface $query, array|int $siteI
 
                 // Fire an 'afterPropagateElement' event
                 if ($this->hasEventHandlers(self::EVENT_AFTER_PROPAGATE_ELEMENT)) {
-                    $this->trigger(self::EVENT_AFTER_PROPAGATE_ELEMENT, new BatchElementActionEvent([
+                    $this->trigger(self::EVENT_AFTER_PROPAGATE_ELEMENT, new MultiElementActionEvent([
                         'query' => $query,
                         'element' => $element,
                         'position' => $position,