nystudio107 / craft-fastcgicachebust

src/services/Cache.php

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

use Craft;
use craft\base\Component;
use craft\base\Element;
use craft\elements\Entry;
use craft\helpers\ElementHelper;
use craft\helpers\FileHelper;
use nystudio107\fastcgicachebust\FastcgiCacheBust;
use yii\base\ErrorException;

/**

Missing short description in doc comment

 * @author    nystudio107

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>"

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

 * @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

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Cache extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Clears the entirety of the FastCGI Cache
     */

Missing @return tag in function comment

    public function clearAll(): void
    {
        $settings = FastcgiCacheBust::$plugin->getSettings();

The method getSettings() does not exist on null.

        if ($settings !== null && !empty($settings->cachePath)) {
            $cacheDirs = explode(',', $settings->cachePath);
            foreach ($cacheDirs as $cacheDir) {
                $cacheDir = Craft::parseEnv($cacheDir);

The function Craft::parseEnv() has been deprecated: in 3.7.29. [[App::parseEnv()]] should be used instead.

                $cacheDir = trim($cacheDir);

It seems like $cacheDir can also be of type null; however, parameter $string of trim() does only seem to accept string, maybe add an additional type check?

                try {
                    FileHelper::clearDirectory($cacheDir);
                } catch (ErrorException $errorException) {
                    Craft::error($errorException->getMessage(), __METHOD__);
                }

                Craft::info(
                    Craft::t(
                        'fastcgi-cache-bust',
                        'FastCGI Cache busted: `' . $cacheDir
                    ),
                    __METHOD__
                );
            }
        }
    }

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

Missing parameter comment

     *
     * @return bool
     */
    public function shouldBustCache(Element $element): bool
    {
        // Don't bust the cache if the element isn't ENABLED or LIVE
        if (($element->getStatus() !== Element::STATUS_ENABLED) && ($element->getStatus() !== Entry::STATUS_LIVE)) {
            return false;
        }
        // Don't bust the cache if the element is a draft or revision
        if (ElementHelper::isDraftOrRevision($element)) {
            return false;
        }

        return true;
    }
}