CommentTemplateLoader::_resolveTemplate() - Code Metrics - Inspection of "Merge branch 'release/1.2.1' into v1" - nystudio107/craft-templatecomments - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v1 ( 128ec0...1ece52 )

by Andrew

created 2024-04-19 03:14 UTC

CommentTemplateLoader::_resolveTemplate() A

↳ Parent: CommentTemplateLoader

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
c	2
b	0
f	0
nc	2
nop	1
dl	0
loc	9
rs	10

<?php
/**
 * Template Comments plugin for Craft CMS 3.x
 *
 * Adds a HTML comment to demarcate each Twig template that is included or extended.
 *
 * @link      https://nystudio107.com/

 * @copyright Copyright (c) 2018 nystudio107

 */


namespace nystudio107\templatecomments\web\twig;

use Craft;
use craft\web\twig\TemplateLoader;
use craft\web\twig\TemplateLoaderException;
use Twig_Source;

/**

 * @author    nystudio107

 * @package   TemplateComments

 * @since     1.0.0

 */

class CommentTemplateLoader extends TemplateLoader
{
    /**

     * @inheritdoc
     */

    public function getSourceContext($name)
    {
        $template = $this->_resolveTemplate($name);

        if (!is_readable($template)) {
            throw new TemplateLoaderException($name, Craft::t('app', 'Tried to read the template at {path}, but could not. Check the permissions.', ['path' => $template]));
        }

        $escapedName = addslashes($name);
        $prefix = "{% comments '{$escapedName}' %}" . PHP_EOL;
        $suffix = PHP_EOL . "{% endcomments %}";

        return new Twig_Source($prefix . file_get_contents($template) . $suffix, $name, $template);
        return /** @scrutinizer ignore-deprecated */ new Twig_Source($prefix . file_get_contents($template) . $suffix, $name, $template);
    }

    // Private Methods
    // =========================================================================

    /**

     * @inheritdoc
     */

    private function _resolveTemplate(string $name): string
    {
        $template = $this->view->resolveTemplate($name);
        $template = $this->view->resolveTemplate($name);

        if ($template !== false) {
            return $template;
        }

        throw new TemplateLoaderException($name, Craft::t('app', 'Unable to find the template “{template}”.', ['template' => $name]));
    }
}


nystudio107 / craft-templatecomments

Push — v1 ( 128ec0...1ece52 )

CommentTemplateLoader::_resolveTemplate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like