nystudio107\seomatic\models\MetaScript

Complexity

Total Complexity

33

Size/Duplication

Total Lines	281
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	5	2
A	fields()	0	18	2
A	rules()	0	38	1
A	loadTemplate()	0	18	3
A	prepForRender()	0	7	2
A	create()	0	14	5
A	normalizeScriptVars()	0	15	5
A	renderAttributes()	0	17	4
A	render()	0	13	5
A	renderBodyHtml()	0	11	4

<?php
/**
 * SEOmatic plugin for Craft CMS 3.x
 *
 * A turnkey SEO implementation for Craft CMS that is comprehensive, powerful,
 * and flexible
 *
 * @link      https://nystudio107.com
 * @copyright Copyright (c) 2017 nystudio107
 */

namespace nystudio107\seomatic\models;

use nystudio107\seomatic\Seomatic;
use nystudio107\seomatic\base\NonceItem;
use nystudio107\seomatic\helpers\PluginTemplate as PluginTemplateHelper;

use Craft;

use yii\web\View;

/**
 * @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>"

 * @package   Seomatic
 * @since     3.0.0
 */
class MetaScript extends NonceItem
{
    // Constants
    // =========================================================================

    const ITEM_TYPE = 'MetaScript';

    // Static Methods
    // =========================================================================
    /**
     * @var string
     */
    public $name;

    // Public Properties
    // =========================================================================

    /**
     * @var string
     */
    public $description;

    /**
     * @var string
     */
    public $templatePath;

    /**
     * @var string
     */
    public $templateString;

    /**
     * @var int
     */
    public $position = View::POS_HEAD;

    /**
     * @var
     */
    public $bodyTemplatePath;

    /**
     * @var
     */
    public $bodyTemplateString;

    /**
     * @var int
     */
    public $bodyPosition = View::POS_BEGIN;

    /**
     * @var array
     */
    public $vars;

    /**
     * @var array
     */
    public $dataLayer = [];

    /**
     * @param array $config

Missing parameter comment

     *
     * @return MetaScript
     */
    public static function create(array $config = []): MetaScript
    {
        $model = new MetaScript($config);
        // Load $templateString from the source template if it's not set
        if (empty($model->templateString) && !empty($model->templatePath)) {
            $model->templateString = $model->loadTemplate($model->templatePath);
        }

        // Load $templateString from the source template if it's not set
        if (empty($model->bodyTemplateString) && !empty($model->bodyTemplatePath)) {
            $model->bodyTemplateString = $model->loadTemplate($model->bodyTemplatePath);
        }

        return $model;
    }

    // Public Methods
    // =========================================================================

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();

        $this->key = $this->key ?: lcfirst($this->name);
    }

    /**
     * Load the existing template into a string
     *
     * @param string $templatePath

Missing parameter comment

     *
     * @return string
     */
    public function loadTemplate(string $templatePath): string
    {
        $result = '';
        // Try it from our plugin directory first
        $path = Craft::getAlias('@nystudio107/seomatic/templates/')
            .$templatePath;
        if (file_exists($path)) {
            $result = @file_get_contents($path);
        } else {
            // Next try it from the Craft template directory
            $path = Craft::getAlias('@templates/')
                .$templatePath;
            if (file_exists($path)) {
                $result = @file_get_contents($path);
            }
        }

        return $result;
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        $rules = parent::rules();
        $rules = array_merge($rules, [
            [
                [
                    'name',
                    'description',
                    'templatePath',
                    'templateString',
                    'bodyTemplatePath',
                    'bodyTemplateString',
                ],
                'string',
            ],
            [
                [
                    'position',
                ],
                'integer',
            ],
            [
                [
                    'name',
                    'description',
                    'templatePath',
                    'templateString',
                    'bodyTemplatePath',
                    'bodyTemplateString',
                    'position',
                ],
                'required',
            ],
            [['vars'], 'safe'],
            [['dataLayer'], 'safe'],
        ]);

        return $rules;
    }

    /**
     * @inheritdoc
     */
    public function fields()
    {
        $fields = parent::fields();
        switch ($this->scenario) {
            case 'render':

Line indented incorrectly; expected 8 spaces, found 12

                $fields = array_diff_key(
                    $fields,
                    array_flip([
                        'name',
                        'description',
                        'environment',
                        'dependencies',
                    ])
                );
                break;
        }

        return $fields;
    }

    /**

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

     * @inheritdoc
     */
    public function prepForRender(&$data): bool
    {
        $shouldRender = parent::prepForRender($data);
        if ($shouldRender) {
        }

        return $shouldRender;
    }

    /**
     * Render the script body HTML
     *
     * @param array $params

Missing parameter comment

     *
     * @return string
     */
    public function renderBodyHtml(array $params = []): string
    {
        $html = '';
        if (!empty($this->bodyTemplatePath) && $this->prepForRender($params)) {
            $variables = $this->normalizeScriptVars();
            if (!empty($this->bodyTemplateString)) {
                $html = PluginTemplateHelper::renderStringTemplate($this->bodyTemplateString, $variables);
            }
        }

        return $html;
    }

    /**

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

     * @inheritdoc
     */
    public function render(array $params = []): string
    {
        $html = '';
        if (!empty($this->templatePath) && $this->prepForRender($params)) {
            $variables = $this->normalizeScriptVars();
            $html = PluginTemplateHelper::renderStringTemplate($this->templateString, $variables);
        }

        if (empty($html) && !empty($this->templatePath)) {
            $html = '/* '.$this->name.Craft::t('seomatic', ' script did not render').' */'.PHP_EOL;
        }

        return $html;
    }

    /**

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

     * @inheritdoc
     */
    public function renderAttributes(array $params = []): array
    {
        $attributes = [];

        if ($this->prepForRender($options)) {
            $variables = $this->normalizeScriptVars();
            if (!empty($this->templateString)) {
                $attributes['script']
                    = PluginTemplateHelper::renderStringTemplate($this->templateString, $variables);
            }
            if (!empty($this->bodyTemplateString)) {
                $attributes['bodyScript']
                    = PluginTemplateHelper::renderStringTemplate($this->bodyTemplateString, $variables);
            }
        }

        return $attributes;
    }

    /**
     * Normalize the script variables by parsing them as environment variables, and trimming whitespace
     *
     * @return array
     */
    private function normalizeScriptVars(): array

Private method name "MetaScript::normalizeScriptVars" must be prefixed with an underscore

    {
        $variables = array_merge($this->vars, [
            'dataLayer' => $this->dataLayer,
        ]);
        if (Seomatic::$craft31) {
            foreach ($variables as $key => $value) {
                if (!empty($value['value']) && \is_string($value['value'])) {
                    $variables[$key]['value'] = Craft::parseEnv($value['value']);
                    $variables[$key]['value'] = trim($value['value']);
                }
            }
        }

        return $variables;
    }
}