nystudio107 / craft-templatecomments

src/web/twig/tokenparsers/CommentBlockTokenParser.php

<?php

You must use "/**" style comments for a file comment

/*
 * This file is part of Twig.
 *
 * (c) Fabien Potencier
 * (c) Armin Ronacher
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace nystudio107\templatecomments\web\twig\tokenparsers;

use nystudio107\templatecomments\TemplateComments;
use nystudio107\templatecomments\web\twig\nodes\CommentBlockNode;
use Twig\Error\SyntaxError;
use Twig\Node\BlockNode;
use Twig\Node\BlockReferenceNode;
use Twig\Node\Node;
use Twig\Node\PrintNode;
use Twig\Token;
use Twig\TokenParser\AbstractTokenParser;
use function sprintf;

/**
 * Marks a section of a template as being reusable.
 *
 * <pre>
 *  {% block head %}
 *    <link rel="stylesheet" href="style.css" />
 *    <title>{% block title %}{% endblock %} - My Webpage</title>
 *  {% endblock %}
 * </pre>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

final class CommentBlockTokenParser extends AbstractTokenParser
{
    public function parse(Token $token): Node

Missing doc comment for function parse()

    {
        $lineno = $token->getLine();
        $stream = $this->parser->getStream();
        $name = $stream->expect(Token::NAME_TYPE)->getValue();

        // Exclude certain blocks from being CommentBlockNodes
        $blockClass = CommentBlockNode::class;
        $settings = TemplateComments::$settings;
        foreach ($settings->excludeBlocksThatContain as $excludeString) {
            if (stripos($name, $excludeString) !== false) {
                $blockClass = BlockNode::class;
            }
        }

        $this->parser->setBlock($name, $block = new $blockClass($name, new Node([]), $lineno));
        $this->parser->pushLocalScope();
        $this->parser->pushBlockStack($name);

        if ($stream->nextIf(Token::BLOCK_END_TYPE)) {
            $body = $this->parser->subparse([$this, 'decideBlockEnd'], true);
            if ($token = $stream->nextIf(Token::NAME_TYPE)) {
                $value = $token->getValue();

                if ($value != $name) {
                    throw new SyntaxError(sprintf('Expected endblock for block "%s" (but "%s" given).', $name, $value), $stream->getCurrent()->getLine(), $stream->getSourceContext());
                }
            }
        } else {
            $body = new Node([

The opening parenthesis of a multi-line function call should be the last content on the line.

                new PrintNode($this->parser->getExpressionParser()->parseExpression(), $lineno),
            ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        }
        $stream->expect(Token::BLOCK_END_TYPE);

        $block->setNode('body', $body);
        $this->parser->popBlockStack();
        $this->parser->popLocalScope();

        return new BlockReferenceNode($name, $lineno);
    }

    public function decideBlockEnd(Token $token): bool

Missing doc comment for function decideBlockEnd()

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

    public function getTag(): string

Missing doc comment for function getTag()

    {
        return 'block';
    }
}