CacheFlag::addEventListeners() - Code Metrics - Inspection of "Use the new template caching system in Craft 3.5" - mmikkel/CacheFlag-Craft3 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 542723...1a75a9 )

by M. Mikkel

created 2020-07-21 13:43 UTC

CacheFlag::addEventListeners() B

↳ Parent: CacheFlag

Complexity

Conditions	8
Paths	1

Size

Total Lines	57
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	8
eloc	32
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	57
rs	8.1635

How to fix Long Method

<?php
/**
 * Cache Flag plugin for Craft CMS 3.x
 *
 * Flag and clear template caches.
 *
 * @link      https://vaersaagod.no
 * @copyright Copyright (c) 2018 Mats Mikkel Rummelhoff
 */

namespace mmikkel\cacheflag;

use Craft;
use craft\base\ElementInterface;
use craft\base\Plugin;
use craft\elements\actions\SetStatus;
use craft\events\ElementEvent;
use craft\events\ElementActionEvent;
use craft\events\MergeElementsEvent;
use craft\events\MoveElementEvent;
use craft\events\PluginEvent;
use craft\events\RegisterCacheOptionsEvent;
use craft\events\TemplateEvent;
use craft\helpers\ElementHelper;
use craft\services\Elements;
use craft\services\Plugins;
use craft\services\Structures;
use craft\utilities\ClearCaches;
use craft\web\UrlManager;
use craft\web\twig\variables\CraftVariable;
use craft\web\View;

use yii\base\Event;
use yii\base\InvalidConfigException;

use mmikkel\cacheflag\services\CacheFlagService;
use mmikkel\cacheflag\services\TemplateCachesService;
use mmikkel\cacheflag\twigextensions\Extension as CacheFlagTwigExtension;
use mmikkel\cacheflag\variables\CpVariable;

/**
 * Class CacheFlag
 *
 * @author    Mats Mikkel Rummelhoff
 * @package   CacheFlag
 * @since     1.0.0
 *
 * @property  CacheFlagService $cacheFlag
 * @property  TemplateCachesService $templateCaches
 */
class CacheFlag extends Plugin
{
    // Static Properties
    // =========================================================================

    /**
     * @var CacheFlag
     */
    public static $plugin;

    // Public Properties
    // =========================================================================

    /**
     * @var string
     */
    public $schemaVersion = '1.0.0';

    // Public Methods
    // =========================================================================

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        self::$plugin = $this;

        // Register services
        $this->setComponents([
            'cacheFlag' => CacheFlagService::class,
            'templateCaches' => TemplateCachesService::class,
        ]);

        Craft::$app->getView()->registerTwigExtension(new CacheFlagTwigExtension());

        $this->addElementEventListeners();

        Event::on(ClearCaches::class, ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
            static function (RegisterCacheOptionsEvent $event) {
                $event->options[] = [
                    'key' => 'cacheflag-flagged-caches',
                    'label' => Craft::t('cache-flag', 'Flagged template caches'),
                    'action' => [CacheFlag::getInstance()->cacheFlag, 'invalidateAllFlaggedCaches'],
                    'info' => Craft::t('cache-flag', 'All template caches flagged using Cache Flag'),
                ];
            }
        );

        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_LOAD_PLUGINS,
            function () {
                $this->maybeRegisterResources();
            }
        );

        Craft::info(
            Craft::t(
                'cache-flag',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    // Protected Methods
    // =========================================================================

    /**
     * Add event listeners for cache breaking
     */
    protected function addElementEventListeners()
    {
        Event::on(
            Elements::class,
            Elements::EVENT_AFTER_SAVE_ELEMENT,
            function (ElementEvent $event) {
                $element = $event->element;
                if (!$element || ElementHelper::isDraftOrRevision($element)) {
                    return;
                }
                CacheFlag::$plugin->cacheFlag->invalidateFlaggedCachesByElement($element);
            }
        );

        Event::on(
            Elements::class,
            Elements::EVENT_BEFORE_DELETE_ELEMENT,
            function (ElementEvent $event) {
                $element = $event->element;
                if (!$element || ElementHelper::isDraftOrRevision($element)) {
                    return;
                }
                CacheFlag::$plugin->cacheFlag->invalidateFlaggedCachesByElement($element);
            }
        );

        Event::on(
            Structures::class,
            Structures::EVENT_AFTER_MOVE_ELEMENT,
            function (MoveElementEvent $event) {
                $element = $event->element;
                if (!$element || ElementHelper::isDraftOrRevision($element)) {
                    return;
                }
                CacheFlag::$plugin->cacheFlag->invalidateFlaggedCachesByElement($element);
            }
        );

        Event::on(
            Elements::class,
            Elements::EVENT_AFTER_PERFORM_ACTION,
            function (ElementActionEvent $event) {

                /* @var ElementQueryInterface|null $criteria */
                $criteria = $event->criteria;

                if (!$criteria) {
                    return;
                }

                /* @var ElementActionInterface|null $action */
                $action = $event->action;

                if (!$action || !\in_array(\get_class($action), [
                        SetStatus::class,
                    ])) {
                    return;
                }

                /** @var ElementInterface[] $elements */
                $elements = $criteria->all();

                foreach ($elements as $element) {
                    if (ElementHelper::isDraftOrRevision($element)) {
                        continue;
                    }
                    CacheFlag::$plugin->cacheFlag->invalidateFlaggedCachesByElement($element);
                }
            }
        );
    }

    /**
     *  Maybe register CP assets bundle and variable
     */
    protected function maybeRegisterResources()
    {

        $request = Craft::$app->getRequest();

        if (!Craft::$app->getUser() || !$request->getIsCpRequest() || $request->getIsConsoleRequest() || ($request->getSegments()[0] ?? null) !== 'cache-flag') {
            return;
        }

        // Register CP variable
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function (Event $event) {
                /** @var CraftVariable $variable */
                $variable = $event->sender;
                $variable->set('cacheFlag', CpVariable::class);
            }
        );
    }

}


1			<?php
2			/**
3			* Cache Flag plugin for Craft CMS 3.x
4			*
5			* Flag and clear template caches.
6			*
7			* @link https://vaersaagod.no
8			* @copyright Copyright (c) 2018 Mats Mikkel Rummelhoff
9			*/
10
11			namespace mmikkel\cacheflag;
12
13			use Craft;
14			use craft\base\ElementInterface;
15			use craft\base\Plugin;
16			use craft\elements\actions\SetStatus;
17			use craft\events\ElementEvent;
18			use craft\events\ElementActionEvent;
19			use craft\events\MergeElementsEvent;
20			use craft\events\MoveElementEvent;
21			use craft\events\PluginEvent;
22			use craft\events\RegisterCacheOptionsEvent;
23			use craft\events\TemplateEvent;
24			use craft\helpers\ElementHelper;
25			use craft\services\Elements;
26			use craft\services\Plugins;
27			use craft\services\Structures;
28			use craft\utilities\ClearCaches;
29			use craft\web\UrlManager;
30			use craft\web\twig\variables\CraftVariable;
31			use craft\web\View;
32
33			use yii\base\Event;
34			use yii\base\InvalidConfigException;
35
36			use mmikkel\cacheflag\services\CacheFlagService;
37			use mmikkel\cacheflag\services\TemplateCachesService;
38			use mmikkel\cacheflag\twigextensions\Extension as CacheFlagTwigExtension;
39			use mmikkel\cacheflag\variables\CpVariable;
40
41			/**
42			* Class CacheFlag
43			*
44			* @author Mats Mikkel Rummelhoff
45			* @package CacheFlag
46			* @since 1.0.0
47			*
48			* @property CacheFlagService $cacheFlag
49			* @property TemplateCachesService $templateCaches
50			*/
51			class CacheFlag extends Plugin
52			{
53			// Static Properties
54			// =========================================================================
55
56			/**
57			* @var CacheFlag
58			*/
59			public static $plugin;
60
61			// Public Properties
62			// =========================================================================
63
64			/**
65			* @var string
66			*/
67			public $schemaVersion = '1.0.0';
68
69			// Public Methods
70			// =========================================================================
71
72			/**
73			* @inheritdoc
74			*/
75			public function init()
76			{
77			parent::init();
78			self::$plugin = $this;
79
80			// Register services
81			$this->setComponents([
82			'cacheFlag' => CacheFlagService::class,
83			'templateCaches' => TemplateCachesService::class,
84			]);
85
86			Craft::$app->getView()->registerTwigExtension(new CacheFlagTwigExtension());
87
88			$this->addElementEventListeners();
89
90			Event::on(ClearCaches::class, ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
91			static function (RegisterCacheOptionsEvent $event) {
92			$event->options[] = [
93			'key' => 'cacheflag-flagged-caches',
94			'label' => Craft::t('cache-flag', 'Flagged template caches'),
95			'action' => [CacheFlag::getInstance()->cacheFlag, 'invalidateAllFlaggedCaches'],
96			'info' => Craft::t('cache-flag', 'All template caches flagged using Cache Flag'),
97			];
98			}
99			);
100
101			Event::on(
102			Plugins::class,
103			Plugins::EVENT_AFTER_LOAD_PLUGINS,
104			function () {
105			$this->maybeRegisterResources();
106			}
107			);
108
109			Craft::info(
110			Craft::t(
111			'cache-flag',
112			'{name} plugin loaded',
113			['name' => $this->name]
114			),
115			__METHOD__
116			);
117			}
118
119			// Protected Methods
120			// =========================================================================
121
122			/**
123			* Add event listeners for cache breaking
124			*/
125			protected function addElementEventListeners()
126			{
127			Event::on(
128			Elements::class,
129			Elements::EVENT_AFTER_SAVE_ELEMENT,
130			function (ElementEvent $event) {
131			$element = $event->element;
132			if (!$element \|\| ElementHelper::isDraftOrRevision($element)) {
133			return;
134			}
135			CacheFlag::$plugin->cacheFlag->invalidateFlaggedCachesByElement($element);
136			}
137			);
138
139			Event::on(
140			Elements::class,
141			Elements::EVENT_BEFORE_DELETE_ELEMENT,
142			function (ElementEvent $event) {
143			$element = $event->element;
144			if (!$element \|\| ElementHelper::isDraftOrRevision($element)) {
145			return;
146			}
147			CacheFlag::$plugin->cacheFlag->invalidateFlaggedCachesByElement($element);
148			}
149			);
150
151			Event::on(
152			Structures::class,
153			Structures::EVENT_AFTER_MOVE_ELEMENT,
154			function (MoveElementEvent $event) {
155			$element = $event->element;
156			if (!$element \|\| ElementHelper::isDraftOrRevision($element)) {
157			return;
158			}
159			CacheFlag::$plugin->cacheFlag->invalidateFlaggedCachesByElement($element);
160			}
161			);
162
163			Event::on(
164			Elements::class,
165			Elements::EVENT_AFTER_PERFORM_ACTION,
166			function (ElementActionEvent $event) {
167
168			/* @var ElementQueryInterface\|null $criteria */
169			$criteria = $event->criteria;
170
171			if (!$criteria) {
172			return;
173			}
174
175			/* @var ElementActionInterface\|null $action */
176			$action = $event->action;
177
178			if (!$action \|\| !\in_array(\get_class($action), [
179			SetStatus::class,
180			])) {
181			return;
182			}
183
184			/** @var ElementInterface[] $elements */
185			$elements = $criteria->all();
186
187			foreach ($elements as $element) {
188			if (ElementHelper::isDraftOrRevision($element)) {
189			continue;
190			}
191			CacheFlag::$plugin->cacheFlag->invalidateFlaggedCachesByElement($element);
192			}
193			}
194			);
195			}
196
197			/**
198			* Maybe register CP assets bundle and variable
199			*/
200			protected function maybeRegisterResources()
201			{
202
203			$request = Craft::$app->getRequest();
204
205			if (!Craft::$app->getUser() \|\| !$request->getIsCpRequest() \|\| $request->getIsConsoleRequest() \|\| ($request->getSegments()[0] ?? null) !== 'cache-flag') {
206			return;
207			}
208
209			// Register CP variable
210			Event::on(
211			CraftVariable::class,
212			CraftVariable::EVENT_INIT,
213			function (Event $event) {
214			/** @var CraftVariable $variable */
215			$variable = $event->sender;
216			$variable->set('cacheFlag', CpVariable::class);
217			}
218			);
219			}
220
221			}
222

mmikkel / CacheFlag-Craft3

Push — develop ( 542723...1a75a9 )

CacheFlag::addEventListeners() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like