nystudio107 / craft-routemap

src/RouteMap.php

<?php
/**
 * Route Map plugin for Craft CMS
 *
 * Returns a list of public routes for elements with URLs
 *
 * @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\routemap;

use Craft;
use craft\base\Element;
use craft\base\Plugin;
use craft\elements\Entry;
use craft\events\ElementEvent;
use craft\events\RegisterCacheOptionsEvent;
use craft\services\Elements;
use craft\utilities\ClearCaches;
use craft\web\twig\variables\CraftVariable;
use nystudio107\routemap\services\ServicesTrait;
use nystudio107\routemap\variables\RouteMapVariable;
use yii\base\Event;

/**
 * Class RouteMap
 *
 * @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   RouteMap

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 RouteMap extends Plugin
{
    // Traits
    // =========================================================================

    use ServicesTrait;

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

    /**

Missing short description in doc comment

     * @var ?RouteMap
     */
    public static ?RouteMap $plugin = null;

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

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

        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            static function(Event $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                /** @var CraftVariable $variable */

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

Missing short description in doc comment

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

                $variable = $event->sender;
                $variable->set('routeMap', RouteMapVariable::class);
            }
        );

        // Handler: Elements::EVENT_AFTER_SAVE_ELEMENT
        Event::on(
            Elements::class,
            Elements::EVENT_AFTER_SAVE_ELEMENT,
            static function(ElementEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                Craft::debug(
                    'Elements::EVENT_AFTER_SAVE_ELEMENT',
                    __METHOD__
                );
                /** @var Element $element */

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

Missing short description in doc comment

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

                $element = $event->element;
                $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;
                }

                if ($bustCache) {
                    Craft::debug(
                        'Cache busted due to saving: ' . $element::class . ' - ' . $element->title,
                        __METHOD__
                    );
                    RouteMap::$plugin->routes->invalidateCache();
                }
            }
        );

        // Handler: ClearCaches::EVENT_REGISTER_CACHE_OPTIONS
        Event::on(
            ClearCaches::class,
            ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
            static function(RegisterCacheOptionsEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                $event->options[] = [
                    'key' => 'route-map',
                    'label' => Craft::t('route-map', 'Route Map Cache'),
                    'action' => function(): void {

Expected 1 space after FUNCTION keyword; 0 found

                        RouteMap::$plugin->routes->invalidateCache();
                    },
                ];
            }
        );

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

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