nystudio107\templatecomments\web\twig\tokenparsers\CommentsTokenParser

Complexity

Total Complexity

3

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getTag()	0	3	1
A	decideCommentsEnd()	0	3	1
A	parse()	0	12	1

<?php
/**
 * Template Comments plugin for Craft CMS
 *
 * Adds a HTML comment to demarcate each Twig template that is included or extended.
 *
 * @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\templatecomments\web\twig\tokenparsers;

use nystudio107\templatecomments\web\twig\nodes\CommentsNode;
use Twig\Token;
use Twig\TokenParser\AbstractTokenParser;

/**

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   TemplateComments

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getTag()
    {
        return 'comments';
    }

    /**

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)
    {
        $lineno = $token->getLine();
        $stream = $this->parser->getStream();
        $nodes = [
            'templateName' => $this->parser->getExpressionParser()->parseExpression(),
        ];
        $stream->expect(Token::BLOCK_END_TYPE);
        $nodes['body'] = $this->parser->subparse([$this, 'decideCommentsEnd'], true);
        $stream->expect(Token::BLOCK_END_TYPE);

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


    /**

Missing short description in doc comment

     * @param Token $token

Missing parameter comment

     *
     * @return bool
     */
    public function decideCommentsEnd(Token $token): bool
    {
        return $token->test('endcomments');
    }
}