nystudio107 / craft-templatecomments

src/web/twig/nodes/CommentsNode.php

<?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\nodes;

use Twig\Compiler;
use Twig\Node\Node;

/**

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 CommentsNode extends Node
{
    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function compile(Compiler $compiler): void
    {
        $compiler
            ->addDebugInfo($this)
            ->write('$_templateTimer = microtime(true)')
            ->raw(";\n")
            ->write('$_templateName = ')
            ->subcompile($this->getNode('templateName'))
            ->raw(";\n")
            ->write('echo PHP_EOL."<!-- >>> TEMPLATE BEGIN >>> ".$_templateName." -->".PHP_EOL')
            ->raw(";\n");
        // Make sure there is a body node
        if (!empty($this->nodes['body'])) {
            $compiler
                ->indent()
                ->subcompile($this->getNode('body'))
                ->outdent();
        }
        $compiler
            ->write('echo PHP_EOL."<!-- <<< TEMPLATE END <<< FROM ".$_templateName." TIME ".number_format((microtime(true)-$_templateTimer)*1000,2)."ms -->".PHP_EOL')
            ->raw(";\n")
            ->write("unset(\$_templateName);\n")
            ->write("unset(\$_templateTimer);\n");
    }
}