DefaultController::actionSaveFlags() - Code Metrics - mmikkel/CacheFlag-Craft3 - Measure and Improve Code Quality continuously with Scrutinizer

DefaultController::actionSaveFlags() B
last analyzed 2025-06-16 17:20 UTC

↳ Parent: DefaultController

Complexity

Conditions	9
Paths	19

Size

Total Lines	53
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	9
eloc	31
nc	19
nop	0
dl	0
loc	53
rs	8.0555
c	1
b	0
f	0

How to fix Long Method

<?php

namespace mmikkel\cacheflag\controllers;

use mmikkel\cacheflag\CacheFlag;

use Craft;
use craft\web\Controller;

use yii\web\BadRequestHttpException;
use yii\web\ForbiddenHttpException;

/**
 * @author    Mats Mikkel Rummelhoff
 * @package   CacheFlag
 * @since     1.0.0
 */
class DefaultController extends Controller
{

    /** @var array|bool|int */
    public array|bool|int $allowAnonymous = self::ALLOW_ANONYMOUS_NEVER;

    /**
     * @return \yii\web\Response
     * @throws BadRequestHttpException
     * @throws \yii\base\InvalidConfigException
     */
    public function actionSaveFlags(): \yii\web\Response
    {
        $this->requirePostRequest();
        $this->requireAcceptsJson();

        if (!Craft::$app->getConfig()->getGeneral()->allowAdminChanges) {
            throw new ForbiddenHttpException('Administrative changes are disallowed in this environment.');
        }

        $params = Craft::$app->getRequest()->getBodyParams();
        $cacheFlags = $params['cacheflags'] ?? null;

        $error = null;

        foreach ($cacheFlags as $source => $flags) {

            $sourceArray = explode(':', $source);
            $sourceColumn = $sourceArray[0] ?? null;
            $sourceId = $sourceArray[1] ?? null;

            if (!$sourceColumn || !$sourceId) {
                continue;
            }

            $flags = preg_replace('/\s+/', '', $flags);

            try {
                if (!$flags) {
                    CacheFlag::getInstance()->cacheFlag->deleteFlagsBySource($sourceColumn, $sourceId);
                    continue;
                }
                CacheFlag::getInstance()->cacheFlag->saveFlags($flags, $sourceColumn, $sourceId);
            } catch (\Throwable $e) {
                $error = $e->getMessage();
            }

            if ($error) {
                break;
            }

        }

        if ($error) {
            return $this->asJson([
                'success' => false,
                'message' => $error,
            ]);
        }

        return $this->asJson([
            'success' => true,
            'message' => Craft::t('cache-flag', 'Cache flags saved'),
            'flags' => CacheFlag::getInstance()->cacheFlag->getAllFlags(),
        ]);

    }

    /**
     * @return \yii\web\Response
     * @throws BadRequestHttpException
     * @throws \yii\base\InvalidConfigException
     */
    public function actionInvalidateFlaggedCachesByFlags()
    {
        $this->requirePostRequest();
        $this->requireAcceptsJson();

        $params = Craft::$app->getRequest()->getBodyParams();
        $flags = $params['flags'] ?? null;

        if (!$flags) {
            return $this->asJson([
                'success' => false,
                'message' => Craft::t('cache-flag', 'No flags to invalidate caches for'),
            ]);
        }

        $error = null;

        try {
            CacheFlag::getInstance()->cacheFlag->invalidateFlaggedCachesByFlags($flags);
        } catch (\Throwable $e) {
            $error = $e->getMessage();
        }

        if ($error) {
            return $this->asJson([
                'success' => false,
                'message' => $error,
            ]);
        }

        return $this->asJson([
            'success' => true,
            'message' => Craft::t('cache-flag', 'Flagged caches invalidated'),
        ]);
    }

    /**
     * @return \yii\web\Response
     * @throws BadRequestHttpException
     * @throws \craft\errors\MissingComponentException
     */
    public function actionInvalidateAllFlaggedCaches()
    {
        $this->requirePostRequest();

        $error = null;

        try {
            CacheFlag::getInstance()->cacheFlag->invalidateAllFlaggedCaches();
        } catch (\Throwable $e) {
            $error = $e;
        }

        if ($error) {
            Craft::$app->getSession()->setError($error);
        } else {
            Craft::$app->getSession()->setNotice(Craft::t('cache-flag', 'All flagged caches invalidated'));
        }

        return $this->redirectToPostedUrl();
    }

}


1			<?php
2
3			namespace mmikkel\cacheflag\controllers;
4
5			use mmikkel\cacheflag\CacheFlag;
6
7			use Craft;
8			use craft\web\Controller;
9
10			use yii\web\BadRequestHttpException;
11			use yii\web\ForbiddenHttpException;
12
13			/**
14			* @author Mats Mikkel Rummelhoff
15			* @package CacheFlag
16			* @since 1.0.0
17			*/
18			class DefaultController extends Controller
19			{
20
21			/** @var array\|bool\|int */
22			public array\|bool\|int $allowAnonymous = self::ALLOW_ANONYMOUS_NEVER;
23
24			/**
25			* @return \yii\web\Response
26			* @throws BadRequestHttpException
27			* @throws \yii\base\InvalidConfigException
28			*/
29			public function actionSaveFlags(): \yii\web\Response
30			{
31			$this->requirePostRequest();
32			$this->requireAcceptsJson();
33
34			if (!Craft::$app->getConfig()->getGeneral()->allowAdminChanges) {
35			throw new ForbiddenHttpException('Administrative changes are disallowed in this environment.');
36			}
37
38			$params = Craft::$app->getRequest()->getBodyParams();
39			$cacheFlags = $params['cacheflags'] ?? null;
40
41			$error = null;
42
43			foreach ($cacheFlags as $source => $flags) {
44
45			$sourceArray = explode(':', $source);
46			$sourceColumn = $sourceArray[0] ?? null;
47			$sourceId = $sourceArray[1] ?? null;
48
49			if (!$sourceColumn \|\| !$sourceId) {
50			continue;
51			}
52
53			$flags = preg_replace('/\s+/', '', $flags);
54
55			try {
56			if (!$flags) {
57			CacheFlag::getInstance()->cacheFlag->deleteFlagsBySource($sourceColumn, $sourceId);
58			continue;
59			}
60			CacheFlag::getInstance()->cacheFlag->saveFlags($flags, $sourceColumn, $sourceId);
61			} catch (\Throwable $e) {
62			$error = $e->getMessage();
63			}
64
65			if ($error) {
66			break;
67			}
68
69			}
70
71			if ($error) {
72			return $this->asJson([
73			'success' => false,
74			'message' => $error,
75			]);
76			}
77
78			return $this->asJson([
79			'success' => true,
80			'message' => Craft::t('cache-flag', 'Cache flags saved'),
81			'flags' => CacheFlag::getInstance()->cacheFlag->getAllFlags(),
82			]);
83
84			}
85
86			/**
87			* @return \yii\web\Response
88			* @throws BadRequestHttpException
89			* @throws \yii\base\InvalidConfigException
90			*/
91			public function actionInvalidateFlaggedCachesByFlags()
92			{
93			$this->requirePostRequest();
94			$this->requireAcceptsJson();
95
96			$params = Craft::$app->getRequest()->getBodyParams();
97			$flags = $params['flags'] ?? null;
98
99			if (!$flags) {
100			return $this->asJson([
101			'success' => false,
102			'message' => Craft::t('cache-flag', 'No flags to invalidate caches for'),
103			]);
104			}
105
106			$error = null;
107
108			try {
109			CacheFlag::getInstance()->cacheFlag->invalidateFlaggedCachesByFlags($flags);
110			} catch (\Throwable $e) {
111			$error = $e->getMessage();
112			}
113
114			if ($error) {
115			return $this->asJson([
116			'success' => false,
117			'message' => $error,
118			]);
119			}
120
121			return $this->asJson([
122			'success' => true,
123			'message' => Craft::t('cache-flag', 'Flagged caches invalidated'),
124			]);
125			}
126
127			/**
128			* @return \yii\web\Response
129			* @throws BadRequestHttpException
130			* @throws \craft\errors\MissingComponentException
131			*/
132			public function actionInvalidateAllFlaggedCaches()
133			{
134			$this->requirePostRequest();
135
136			$error = null;
137
138			try {
139			CacheFlag::getInstance()->cacheFlag->invalidateAllFlaggedCaches();
140			} catch (\Throwable $e) {
141			$error = $e;
142			}
143
144			if ($error) {
145			Craft::$app->getSession()->setError($error);
146			} else {
147			Craft::$app->getSession()->setNotice(Craft::t('cache-flag', 'All flagged caches invalidated'));
148			}
149
150			return $this->redirectToPostedUrl();
151			}
152
153			}
154

mmikkel / CacheFlag-Craft3

DefaultController::actionSaveFlags() B last analyzed 2025-06-16 17:20 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

DefaultController::actionSaveFlags() B
last analyzed 2025-06-16 17:20 UTC