Merge branch 'release/2.3.1'

Author: brandonkelly

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release Notes for Webhooks for Craft CMS
 
+## 2.3.1 - 2020-07-19
+
+### Added
+- Added a new “Element is enabled” filter. ([#29](https://github.com/craftcms/webhooks/issues/29))
+
 ## 2.3.0 - 2020-07-18
 
 ### Added

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "craftcms/webhooks",
   "description": "Post webhooks when events are triggered in Craft CMS.",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "type": "craft-plugin",
   "keywords": [
     "html",

src/Plugin.php

@@ -13,6 +13,7 @@
 use craft\web\UrlManager;
 use craft\webhooks\filters\DraftFilter;
 use craft\webhooks\filters\DuplicatingFilter;
+use craft\webhooks\filters\ElementEnabledFilter;
 use craft\webhooks\filters\FilterInterface;
 use craft\webhooks\filters\NewElementFilter;
 use craft\webhooks\filters\PropagatingFilter;
@@ -475,6 +476,7 @@ public function getAllFilters(): array
     {
         $filterTypes = [
             NewElementFilter::class,
+            ElementEnabledFilter::class,
             DraftFilter::class,
             RevisionFilter::class,
             DuplicatingFilter::class,

src/filters/BaseElementFilter.php

@@ -17,11 +17,6 @@
  */
 abstract class BaseElementFilter implements FilterInterface
 {
-    public static function displayName(): string
-    {
-        return Craft::t('webhooks', 'Element is a draft');
-    }
-
     public static function show(string $class, string $event): bool
     {
         return (is_subclass_of($class, ElementInterface::class) || (

src/filters/ElementEnabledFilter.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace craft\webhooks\filters;
+
+use Craft;
+use craft\base\Element;
+use craft\base\ElementInterface;
+use craft\events\ElementEvent;
+use craft\events\ModelEvent;
+use yii\base\Event;
+
+/**
+ * Filters events based on whether the element is enabled
+ *
+ * @author Pixel & Tonic, Inc. <[email protected]>
+ * @since 2.3.1
+ */
+class ElementEnabledFilter extends BaseElementFilter
+{
+    public static function displayName(): string
+    {
+        return Craft::t('webhooks', 'Element is enabled');
+    }
+
+    protected static function checkElement(ElementInterface $element, bool $value): bool
+    {
+        /** @var Element $element */
+        return $value === ($element->enabled && $element->enabledForSite);
+    }
+}