nystudio107\seomatic\models\MetaJsonLdContainer

Complexity

Total Complexity

15

Size/Duplication

Total Lines	149
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	normalizeContainerData()	0	12	2
A	render()	0	5	1
A	includeMetaData()	0	31	3
B	renderInternal()	0	57	9

<?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\helpers\MetaValue as MetaValueHelper;
use nystudio107\seomatic\Seomatic;
use yii\caching\TagDependency;
use yii\web\View;

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

    const CONTAINER_TYPE = 'MetaJsonLdContainer';

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

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

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

    /**
     * @inheritdoc
     */
    public function includeMetaData($dependency)
    {
        Craft::beginProfile('MetaJsonLdContainer::includeMetaData', __METHOD__);
        $uniqueKey = $this->handle . $dependency->tags[3] . '-v2';
        $cache = Craft::$app->getCache();
        if ($this->clearCache) {
            TagDependency::invalidate($cache, $dependency->tags[3]);
        }
        [$jsonLd, $attrs] = $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
        if (ImageTransformHelper::$pendingImageTransforms) {
            TagDependency::invalidate($cache, $dependency->tags[3]);
        }
        Seomatic::$view->registerScript(
            $jsonLd,
            View::POS_END,
            $attrs
        );
        Craft::endProfile('MetaJsonLdContainer::includeMetaData', __METHOD__);
    }

    /**
     * @inheritdoc
     */
    public function render(array $params = []): string
    {
        [$jsonLd, $attrs] = $this->renderInternal();

        return trim(Html::script($jsonLd, $attrs));
    }

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

        foreach ($this->data as $key => $config) {
            $schemaType = $config['type'] ?? $config['@type'];
            $config['key'] = $key;
            $schemaType = MetaValueHelper::parseString($schemaType);
            $jsonLd = MetaJsonLd::create($schemaType, $config);

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

            // Retain the intended type
            $jsonLd->type = $config['type'] ?? $config['@type'];
            $this->data[$key] = $jsonLd;
        }
    }

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

    /**
     * Render the JSON-LD as a graph
     *
     * @return array
     */
    protected function renderInternal(): array
    {
        $tagData = [];
        if ($this->prepForInclusion()) {
            /** @var $metaJsonLdModel MetaJsonLd */
            foreach ($this->data as $metaJsonLdModel) {
                if ($metaJsonLdModel->include) {
                    $options = $metaJsonLdModel->tagAttributes();
                    if ($metaJsonLdModel->prepForRender($options)) {
                        $tagData[] = [
                            'jsonLd' => $metaJsonLdModel,
                            'position' => View::POS_END
                        ];
                        // If `devMode` is enabled, validate the JSON-LD and output any model errors
                        if (Seomatic::$devMode) {
                            $metaJsonLdModel->debugMetaItem(
                                'JSON-LD property: ',
                                [
                                    'default' => 'error',
                                    'google' => 'warning',
                                ]
                            );
                        }
                    }
                }
            }
        }

        // Create a root JSON-LD object
        $jsonLdGraph = MetaJsonLd::create('jsonLd', [
            'graph' => [],
        ]);
        $jsonLdGraph->type = null;
        // Add the JSON-LD objects to our root JSON-LD's graph
        $cspNonce = null;
        foreach ($tagData as $config) {
            $jsonLdGraph->graph[] = $config['jsonLd'];
            if (!empty($config['jsonLd']->nonce)) {
                $cspNonce = $config['jsonLd']->nonce;
            }
        }
        // Render the JSON-LD object
        $jsonLd = $jsonLdGraph->render([
            'renderRaw' => true,
            'renderScriptTags' => false,
            'array' => false,
        ]);

        // Register the tags
        $attrs = ['type' => 'application/ld+json'];
        if (!empty($cspNonce)) {
            $attrs = array_merge($attrs, [
                'nonce' => $cspNonce,
            ]);
        }

        return [$jsonLd, $attrs];
    }
}