mmikkel\cacheflag\controllers\DefaultController

Complexity

Total Complexity

18

Size/Duplication

Total Lines	201
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	actionSaveFlags()	0	49	8
A	actionDeleteAllFlaggedCaches()	0	3	1
A	actionInvalidateAllFlaggedCaches()	0	19	3
A	actionDeleteFlaggedCachesByFlags()	0	3	1
A	actionInvalidateFlaggedCachesByFlags()	0	33	4
A	_getRandomSuccessMessage()	0	45	1

<?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\controllers;

use mmikkel\cacheflag\CacheFlag;

use Craft;
use craft\web\Controller;
use yii\web\BadRequestHttpException;

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

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

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

        $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' => $this->_getRandomSuccessMessage(),
            'flags' => CacheFlag::getInstance()->cacheFlag->getAllFlags(),
        ]);

    }

    /**
     * @return \yii\web\Response
     * @throws BadRequestHttpException
     * @throws \yii\base\InvalidConfigException
     * @deprecated since 1.1.0
     */
    public function actionDeleteFlaggedCachesByFlags()
    {
        return $this->actionInvalidateFlaggedCachesByFlags();
    }

    /**
     * @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', 'Caches invalidated'),
        ]);
    }

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

    /**
     * @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();
    }

    /**
     * @return string
     */
    private function _getRandomSuccessMessage(): string
    {
        $messages = [
            "Flags saved! Good day to you.",
            "Ahoy! All flags saved.",
            "Flags. Saved. High five.",
            "Flags! We haz them.",
            "Cache flags saved, friend.",
            "Yarr! Yer flags be safe.",
            "Dun dun dun. All flags saved.",
            "You are awesome. And so are your flags.",
            "Flags, so many flags. All mine!",
            "Flags flags flags flags",
            "You say save, I say sure.",
            "Before, your flags were lost. But now they are saved.",
            "My, what beautiful flags you have.",
            "Your flags are safe with me.",
            "I'll just hang on to these flags for you.",
            "If you want a symbolic gesture, don't burn the flag; save it.",
            'Those are the second biggest flags I\'ve ever seen!',
            'Put a flag on it.',
            'No worries, your flags are totally saved.',
            'I just can\'t believe Cache Flag is finally running on Craft 3',
            'Current state: flags saved.',
            'Mhmm, yummy flags been saved.',
            'Much flags. So saved.',
            'Your Cache Flags (tm) are safely saved.',
            'Flags saved! Go forth and conquer!',
            'Saving flags is my favorite thing in the world',
            'Safe and sound.',
            'It\'s getting hot in here',
            'Flags. Saved. Profit.',
            'These might just be the prettiest lil\' flags I\'ve ever saved',
            'Saving cache flags sure is fun, huh',
            'Come on! Moar flags!',
            'Thank you for these wonderful flags',
            'Cache Flags! Exactly what I needed right now!',
            'Nice one! Successfully saved your flags.',
            'Oh man, just wait until people see these flags',
            'Not gonna lie. Those are some fine flags.',
            'Your flags are safe and sound.',
            'That templatecaches table won\'t know what hit it!',
            'Tweet it out?',
        ];
        return $messages[\array_rand($messages)];
    }

}