nystudio107\fastcgicachebust\FastcgiCacheBust

Complexity

Total Complexity

9

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	settingsHtml()	0	12	2
A	__construct()	0	7	1
A	init()	0	56	2
A	shouldBustCache()	0	11	3
A	createSettingsModel()	0	3	1

<?php
/**
 * FastCGI Cache Bust plugin for Craft CMS 3.x
 *
 * Bust the Nginx FastCGI Cache when entries are saved or created.
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\fastcgicachebust;

use Craft;
use craft\base\Element;
use craft\base\Plugin;
use craft\elements\Entry;
use craft\events\DeleteTemplateCachesEvent;
use craft\events\ElementEvent;
use craft\events\RegisterCacheOptionsEvent;
use craft\services\Elements;
use craft\services\TemplateCaches;
use craft\utilities\ClearCaches;
use nystudio107\fastcgicachebust\models\Settings;
use nystudio107\fastcgicachebust\services\Cache as CacheService;
use yii\base\Event;
use yii\base\Exception;
use function get_class;

/**
 * Class FastcgiCacheBust
 *
 * @author    nystudio107

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @package   FastcgiCacheBust

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 *
 * @property  CacheService cache

Tag value for @property tag indented incorrectly; expected 1 spaces but found 2

 */

Missing @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

class FastcgiCacheBust extends Plugin
{
    // Static Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var FastcgiCacheBust
     */
    public static $plugin;

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSection = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSettings = true;

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

    /**

Missing short description in doc comment

Parameter $id should have a doc-comment as per coding-style.

Parameter $parent should have a doc-comment as per coding-style.

Parameter $config should have a doc-comment as per coding-style.

     * @inheritdoc
     */
    public function __construct($id, $parent = null, array $config = [])
    {
        $config['components'] = [
            'cache' => CacheService::class,
        ];

        parent::__construct($id, $parent, $config);
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        self::$plugin = $this;

        // Handler: Elements::EVENT_AFTER_SAVE_ELEMENT
        Event::on(
            Elements::class,
            Elements::EVENT_AFTER_SAVE_ELEMENT,
            function (ElementEvent $event) {
                Craft::debug(
                    'Elements::EVENT_AFTER_SAVE_ELEMENT',
                    __METHOD__
                );
                /** @var Element $element */

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

Missing short description in doc comment

                $element = $event->element;
                // Only bust the cache if it's not certain excluded element types
                if ($this->shouldBustCache($element)) {
                    Craft::debug(
                        'Cache busted due to saving: ' . get_class($element) . ' - ' . $element->title,
                        __METHOD__
                    );
                    FastcgiCacheBust::$plugin->cache->clearAll();
                }
            }
        );
        // Handler: TemplateCaches::EVENT_AFTER_DELETE_CACHES
        Event::on(
            TemplateCaches::class,
            TemplateCaches::EVENT_AFTER_DELETE_CACHES,

The constant craft\services\TemplateCaches::EVENT_AFTER_DELETE_CACHES has been deprecated: in 3.5.0

            static function (DeleteTemplateCachesEvent $event) {

The parameter $event is not used and could be removed.

                FastcgiCacheBust::$plugin->cache->clearAll();
            }
        );
        // Handler: ClearCaches::EVENT_REGISTER_CACHE_OPTIONS
        Event::on(
            ClearCaches::class,
            ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
            static function (RegisterCacheOptionsEvent $event) {
                $event->options[] = [
                    'key' => 'fastcgi-cache-bust',
                    'label' => Craft::t('fastcgi-cache-bust', 'FastCGI Cache'),
                    'action' => function () {
                        FastcgiCacheBust::$plugin->cache->clearAll();
                    },
                ];
            }
        );

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

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

    /**
     * Determine whether the cache should be busted or not based on the $element
     *
     * @param Element $element

Missing parameter comment

     *
     * @return bool
     */
    protected function shouldBustCache(Element $element): bool
    {
        $bustCache = true;
        // Only bust the cache if the element is ENABLED or LIVE
        if (($element->getStatus() !== Element::STATUS_ENABLED)
            && ($element->getStatus() !== Entry::STATUS_LIVE)
        ) {
            $bustCache = false;
        }

        return $bustCache;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function createSettingsModel()
    {
        return new Settings();
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function settingsHtml(): string
    {
        try {
            return Craft::$app->view->renderTemplate(
                'fastcgi-cache-bust/settings',
                [
                    'settings' => $this->getSettings(),
                ]
            );
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
            return '';
        }
    }
}