nystudio107 / craft-seomatic

src/models/MetaScriptContainer.php

<?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 Craft;
use craft\helpers\Html;
use nystudio107\seomatic\base\NonceContainer;
use nystudio107\seomatic\helpers\ImageTransform as ImageTransformHelper;
use nystudio107\seomatic\Seomatic;
use yii\caching\TagDependency;
use yii\web\View;

/**
 * @author    nystudio107
 * @package   Seomatic
 * @since     3.0.0
 */
class MetaScriptContainer extends NonceContainer
{
    // Constants
    // =========================================================================

    const CONTAINER_TYPE = 'MetaScriptContainer';

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

    /**
     * The data in this container
     *
     * @var MetaScript[] $data
     */
    public $data = [];

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

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

    /**
     * @inheritdoc
     */
    public function includeMetaData($dependency)
    {
        Craft::beginProfile('MetaScriptContainer::includeMetaData', __METHOD__);
        $uniqueKey = $this->handle . $dependency->tags[3] . $this->dataLayerHash();
        $cache = Craft::$app->getCache();
        if ($this->clearCache) {
            TagDependency::invalidate($cache, $dependency->tags[3]);
        }
        $tagData = $cache->getOrSet(
            self::CONTAINER_TYPE . $uniqueKey,
            function() use ($uniqueKey) {
                Craft::info(
                    self::CONTAINER_TYPE . ' cache miss: ' . $uniqueKey,
                    __METHOD__
                );

                return $this->renderInternal();
            },
            Seomatic::$cacheDuration,
            $dependency
        );
        // Invalidate the cache we just created if there were pending image transforms in it
        // or we were asked to clear the cache for this container (because it's a preview request, etc.)
        if ($this->clearCache || ImageTransformHelper::$pendingImageTransforms) {
            TagDependency::invalidate($cache, $dependency->tags[3]);
        }
        // Register the tags
        foreach ($tagData as $config) {
            // Register the tags
            $attrs = $config['tagAttrs'] ?? [];
            if (!empty($config['nonce'])) {
                /** @noinspection SlowArrayOperationsInLoopInspection */
                $attrs = array_merge($attrs, [
                    'nonce' => $config['nonce'],
                ]);
            }
            $bodyJs = $config['bodyJs'] ?? false;
            if ($bodyJs) {
                Seomatic::$view->registerHtml(
                    $config['js'],
                    $config['position']
                );
            } else {
                Seomatic::$view->registerScript(
                    $config['js'],
                    $config['position'],
                    $attrs
                );
            }
        }

        Craft::endProfile('MetaScriptContainer::includeMetaData', __METHOD__);
    }

    /**
     * @inheritdoc
     */
    public function render(array $params = [
        'renderScriptTags' => true,
    ]): string
    {
        $html = '';
        $linebreak = '';
        // If `devMode` is enabled, make the scripts human-readable
        if (Seomatic::$devMode) {
            $linebreak = PHP_EOL;
        }
        $tagData = $this->renderInternal();
        // Register the tags
        foreach ($tagData as $config) {
            // Register the tags
            $attrs = $config['tagAttrs'] ?? [];
            if (!empty($config['nonce'])) {
                /** @noinspection SlowArrayOperationsInLoopInspection */
                $attrs = array_merge($attrs, [
                    'nonce' => $config['nonce'],
                ]);
            }
            $bodyJs = $config['bodyJs'] ?? false;
            // If `devMode` is enabled, add some positional information
            if (Seomatic::$devMode) {
                $positionNames = [
                    '<head>',
                    '<body>',
                    '</body>',
                    'jQuery(document).ready()',
                    'jQuery(window).load()',
                ];
                $position = $positionNames[$config['position'] - 1] ?? 'unknown';
                $html .= "<!-- Position: {$position} -->" . PHP_EOL;
            }
            if ($bodyJs || !$params['renderScriptTags']) {
                $html .= $config['js'];
            } else {
                $html .= Html::script($config['js'], $attrs);
            }
            $html .= $linebreak;
        }

        return trim($html);
    }

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

        /** @var array $config */
        foreach ($this->data as $key => $config) {
            $config['key'] = $key;
            $this->data[$key] = MetaScript::create($config);

$config of type nystudio107\seomatic\models\MetaScript is incompatible with the type array expected by parameter $config of nystudio107\seomatic\models\MetaScript::create().

        }
    }

    // Protected Methods
    // =========================================================================

    /**
     * Render all of the scripts out into tagData
     *
     * @return array
     */
    protected function renderInternal(): array
    {
        $tagData = [];
        if ($this->prepForInclusion()) {
            foreach ($this->data as $metaScriptModel) {
                if ($metaScriptModel->include) {
                    // The regular script JS
                    $js = $metaScriptModel->render();
                    if (!empty($js)) {
                        $scenario = $this->scenario;
                        $metaScriptModel->setScenario('render');
                        $options = $metaScriptModel->tagAttributes();
                        $metaScriptModel->setScenario($scenario);
                        $tagData[] = [
                            'js' => $js,
                            'position' => $metaScriptModel->position,
                            'nonce' => $metaScriptModel->nonce ?? null,
                            'tagAttrs' => $options,
                            'bodyJs' => false,
                        ];
                        // If `devMode` is enabled, validate the Meta Script and output any model errors
                        if (Seomatic::$devMode) {
                            $metaScriptModel->debugMetaItem(
                                'Script attribute: '
                            );
                        }
                    }
                    // The body script JS (has no wrapping <script></script> tags, as it can be arbitrary HTML)
                    $bodyJs = $metaScriptModel->renderBodyHtml();
                    if (!empty($bodyJs)) {
                        $scenario = $this->scenario;
                        $metaScriptModel->setScenario('render');
                        $options = $metaScriptModel->tagAttributes();
                        $metaScriptModel->setScenario($scenario);
                        $tagData[] = [
                            'js' => $bodyJs,
                            'position' => $metaScriptModel->bodyPosition,
                            'nonce' => $metaScriptModel->nonce ?? null,
                            'tagAttrs' => $options,
                            'bodyJs' => true,
                        ];
                        // If `devMode` is enabled, validate the Meta Script and output any model errors
                        if (Seomatic::$devMode) {
                            $metaScriptModel->debugMetaItem(
                                'Script attribute: '
                            );
                        }
                    }
                }
            }
        }

        return $tagData;
    }

    protected function dataLayerHash(): string
    {
        $data = '';
        foreach ($this->data as $metaScriptModel) {
            $data .= serialize($metaScriptModel->dataLayer);
        }

        return md5($data);
    }
}