nystudio107 / craft-twigprofiler

src/twigextensions/ProfilerTokenParser.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\twigextensions;

use Twig\Token;
use Twig\TokenParser\AbstractTokenParser;

/**
 * Class ProfilerTokenParser
 *
 * @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.1

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 ProfilerTokenParser extends AbstractTokenParser
{
    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getTag(): string
    {
        return 'profile';
    }

    /**

Missing short description in doc comment

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function parse(Token $token): ProfilerNode
    {
        $lineno = $token->getLine();
        $stream = $this->parser->getStream();
        $nodes = [
            'profile' => $this->parser->getExpressionParser()->parseExpression(),
        ];
        $stream->expect(Token::BLOCK_END_TYPE);
        $nodes['body'] = $this->parser->subparse(fn(Token $token): bool => $this->decideProfilerEnd($token), true);
        $stream->expect(Token::BLOCK_END_TYPE);

        return new ProfilerNode($nodes, [], $lineno, $this->getTag());
    }

    public function decideProfilerEnd(Token $token): bool

Missing doc comment for function decideProfilerEnd()

    {
        return $token->test('endprofile');
    }
}