CommentsTokenParser::parse() - Code Metrics - nystudio107/craft-templatecomments - Measure and Improve Code Quality continuously with Scrutinizer

CommentsTokenParser::parse() A
last analyzed 2024-11-29 19:17 UTC

↳ Parent: CommentsTokenParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	1
eloc	8
c	3
b	0
f	0
nc	1
nop	1
dl	0
loc	12
rs	10

<?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/

 * @copyright Copyright (c)  nystudio107

 */


namespace nystudio107\templatecomments\web\twig\tokenparsers;

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

/**

 * @author    nystudio107

 * @package   TemplateComments

 * @since     1.0.0

 */

class CommentsTokenParser extends AbstractTokenParser
{
    // Public Methods
    // =========================================================================

    /**

     * @inheritdoc
     */

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

    /**

     * @inheritdoc
     */

    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());
    }


    /**

     * @param Token $token

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


1			<?php
2			/**
3			* Template Comments plugin for Craft CMS
4			*
5			* Adds a HTML comment to demarcate each Twig template that is included or extended.
6			*
7			* @link https://nystudio107.com/
			0 ignored issues – show Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
8			* @copyright Copyright (c) nystudio107
			0 ignored issues – show Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
9			*/
			0 ignored issues – show Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
10
11			namespace nystudio107\templatecomments\web\twig\tokenparsers;
12
13			use nystudio107\templatecomments\web\twig\nodes\CommentsNode;
14			use Twig\Token;
15			use Twig\TokenParser\AbstractTokenParser;
16
17			/**
			0 ignored issues – show Coding Style introduced 2024-04-19 03:27 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
18			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2019-06-12 17:02 UTC by Report Bug Copy Issue Report Tag value for @author tag indented incorrectly; expected 2 spaces but found 4 Loading history...
19			* @package TemplateComments
			0 ignored issues – show Coding Style introduced 2019-06-12 17:02 UTC by Report Bug Copy Issue Report Tag value for @package tag indented incorrectly; expected 1 spaces but found 3 Loading history...
20			* @since 1.0.0
			0 ignored issues – show Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history... Coding Style introduced 2019-06-12 17:02 UTC by Report Bug Copy Issue Report Tag value for @since tag indented incorrectly; expected 3 spaces but found 5 Loading history...
21			*/
			0 ignored issues – show Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2018-10-04 14:50 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
22			class CommentsTokenParser extends AbstractTokenParser
23			{
24			// Public Methods
25			// =========================================================================
26
27			/**
			0 ignored issues – show Coding Style introduced 2018-10-02 16:17 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
28			* @inheritdoc
29			*/
			0 ignored issues – show Coding Style introduced 2018-10-02 16:17 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
30			public function getTag()
31			{
32			return 'comments';
33			}
34
35			/**
			0 ignored issues – show Coding Style introduced 2018-10-02 16:17 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-10-02 16:17 UTC by Report Bug Copy Issue Report Parameter `$token` should have a doc-comment as per coding-style. Loading history...
36			* @inheritdoc
37			*/
			0 ignored issues – show Coding Style introduced 2018-10-02 16:17 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
38			public function parse(Token $token)
39			{
40			$lineno = $token->getLine();
41			$stream = $this->parser->getStream();
42			$nodes = [
43			'templateName' => $this->parser->getExpressionParser()->parseExpression(),
44			];
45			$stream->expect(Token::BLOCK_END_TYPE);
46			$nodes['body'] = $this->parser->subparse([$this, 'decideCommentsEnd'], true);
47			$stream->expect(Token::BLOCK_END_TYPE);
48
49			return new CommentsNode($nodes, [], $lineno, $this->getTag());
50			}
51
52
53			/**
			0 ignored issues – show Coding Style introduced 2018-10-02 16:17 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
54			* @param Token $token
			0 ignored issues – show Coding Style introduced 2018-10-02 16:17 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
55			*
56			* @return bool
57			*/
58			public function decideCommentsEnd(Token $token): bool
59			{
60			return $token->test('endcomments');
61			}
62			}
63

nystudio107 / craft-templatecomments

CommentsTokenParser::parse() A last analyzed 2024-11-29 19:17 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CommentsTokenParser::parse() A
last analyzed 2024-11-29 19:17 UTC