nystudio107 / craft-twigprofiler

src/TwigProfiler.php

<?php
/**
 * Twig Profiler plugin for Craft CMS
 *
 * Twig Profiler allows you to profile sections of your Twig templates, and see
 * the resulting timings in the Yii2 Debug Toolbar
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 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\twigprofiler;

use Craft;
use craft\base\Plugin;
use craft\events\TemplateEvent;
use craft\web\View;
use nystudio107\twigprofiler\models\Settings;
use nystudio107\twigprofiler\services\ServicesTrait;
use nystudio107\twigprofiler\twigextensions\ProfilerTwigExtension;
use yii\base\Event;

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

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

    use ServicesTrait;

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var string The name of the rendering template
     */
    public static string $renderingTemplate = '';

    // 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;

        /** @var Settings $settings */

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

        $settings = $this->getSettings();
        Craft::$app->view->registerTwigExtension(new ProfilerTwigExtension());

        if ($settings !== null && $settings->appendTemplateName) {
            // Handler: View::EVENT_BEFORE_RENDER_TEMPLATE
            Event::on(
                View::class,
                View::EVENT_BEFORE_RENDER_TEMPLATE,
                static function(TemplateEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                    Craft::debug(
                        'View::EVENT_BEFORE_RENDER_TEMPLATE',
                        __METHOD__
                    );
                    self::$renderingTemplate = ' - ' . $event->template;
                }
            );
        }

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

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