nystudio107 / craft-twigprofiler

src/services/Profile.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\services;

use Craft;
use craft\base\Component;
use nystudio107\twigprofiler\TwigProfiler;

/**

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   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 Profile extends Component
{
    // Constants
    // =========================================================================
    /**

Missing short description in doc comment

     * @var string
     */
    public const CATEGORY_PREFIX = 'Twig Profiler';

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

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

     * Start logging profiling data
     */

Missing @return tag in function comment

    public function begin(string $profile): void
    {
        Craft::beginProfile(
            $profile,
            Craft::t('twig-profiler', self::CATEGORY_PREFIX)
            . TwigProfiler::$renderingTemplate
        );
    }

    /**

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

     * End logging profiling data
     */

Missing @return tag in function comment

    public function end(string $profile): void
    {
        Craft::endProfile(
            $profile,
            Craft::t('twig-profiler', self::CATEGORY_PREFIX)
            . TwigProfiler::$renderingTemplate
        );
    }
}