nystudio107 / craft-seomatic

src/base/MetaItem.php

<?php
/**
 * SEOmatic plugin for Craft CMS
 *
 * 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\base;

use Craft;
use Exception;
use nystudio107\seomatic\behaviors\MetaItemAttributeParserBehavior;
use nystudio107\seomatic\helpers\ArrayHelper;
use nystudio107\seomatic\helpers\Dependency;
use nystudio107\seomatic\models\MetaJsonLd;
use nystudio107\seomatic\Seomatic;
use yii\helpers\Inflector;
use function count;
use function get_class;
use function is_array;
use function is_string;

/**
 * @author    nystudio107
 * @package   Seomatic
 * @since     3.0.0
 */
abstract class MetaItem extends FluentModel implements MetaItemInterface
{
    // Traits
    // =========================================================================

    use MetaItemTrait;

    // Constants
    // =========================================================================

    public const ARRAY_PROPERTIES = [
    ];

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

    /**
     * @inheritdoc
     */
    public function init(): void
    {
        parent::init();
        // Set any per-environment attributes
        if (!Seomatic::$previewingMetaContainers || Seomatic::$headlessRequest) {
            $attributes = [];
            $envVars = null;
            try {
                $envVars = ArrayHelper::getValue($this->environment, Seomatic::$environment);
            } catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

            }
            if (is_array($envVars)) {
                foreach ($envVars as $key => $value) {
                    $attributes[$key] = $value;
                }
            }
            $this->setAttributes($attributes, false);
        }
    }

    /**
     * @inheritdoc
     */
    public function rules(): array
    {
        $rules = parent::rules();
        $rules = array_merge($rules, [
            [['key'], 'required'],
            [['include'], 'boolean'],
            [['key'], 'string'],
            [['environment'], 'safe'],
            [['dependencies'], 'safe'],
            [['tagAttrs'], 'safe'],
        ]);

        return $rules;
    }

    /**
     * @inheritdoc
     */
    public function fields(): array
    {
        $fields = parent::fields();
        switch ($this->scenario) {
            case 'render':
                $fields = array_diff_key(
                    $fields,
                    array_flip([
                        'include',
                        'key',
                        'environment',
                        'dependencies',
                        'tagAttrs',
                    ])
                );
                break;
        }

        return $fields;
    }

    /**
     * @inheritdoc
     */
    public function prepForRender(&$data): bool
    {
        if ($this->include) {
            return Dependency::validateDependencies($this->dependencies);
        }

        return false;
    }

    /**
     * @inheritdoc
     */
    public function render(array $params = []): string
    {
        return '';
    }

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

    /**
     * Add debug logging for the MetaItem
     *
     * @param string $errorLabel
     * @param array $scenarios
     */
    public function debugMetaItem(
        $errorLabel = 'Error: ',
        array $scenarios = ['default' => 'error'],
    ) {
        $isMetaJsonLdModel = false;
        if (is_subclass_of($this, MetaJsonLd::class)) {
            $isMetaJsonLdModel = true;
        }
        $modelScenarios = $this->scenarios();
        $scenarios = array_intersect_key($scenarios, $modelScenarios);
        foreach ($scenarios as $scenario => $logLevel) {
            $this->setScenario($scenario);
            if (!$this->validate()) {
                $extraInfo = '';
                // Add a URL to the schema.org type if this is a MetaJsonLD object
                if ($isMetaJsonLdModel) {
                    /** @var MetaJsonLd $this */
                    $extraInfo = ' for http://schema.org/' . $this->type;
                }
                $errorMsg =
                    Craft::t('seomatic', 'Scenario: "')
                    . $scenario
                    . '"'
                    . $extraInfo
                    . PHP_EOL
                    . print_r($this->render(), true);
                Craft::info($errorMsg, __METHOD__);
                foreach ($this->errors as $param => $errors) {
                    $errorMsg = Craft::t('seomatic', $errorLabel) . $param;
                    /** @var array $errors */
                    foreach ($errors as $error) {
                        $errorMsg .= ' -> ' . $error;
                        // Change the error level depending on the error message if this is a MetaJsonLD object
                        if ($isMetaJsonLdModel) {
                            if (strpos($error, 'recommended') !== false) {
                                $logLevel = 'warning';
                            }
                            if (strpos($error, 'required') !== false
                                || strpos($error, 'Must be') !== false
                            ) {
                                $logLevel = 'error';
                            }
                        }
                    }
                    Craft::info(strtoupper($logLevel) . ' - ' . $errorMsg, __METHOD__);
                    // Extra debugging info for MetaJsonLd objects
                    if ($isMetaJsonLdModel) {
                        /** @var MetaJsonLd $className */
                        $className = get_class($this);
                        if (!empty($className->schemaPropertyDescriptions[$param])) {
                            $errorMsg = Craft::t('seomatic', $errorLabel) . $param;
                            $errorMsg .= ' -> ' . $className->schemaPropertyDescriptions[$param];
                            Craft::info($errorMsg, __METHOD__);
                        }
                    }
                }
            }
        }
    }

    /**
     * Return an array of tag attributes, normalizing the keys
     *
     * @return array
     */
    public function tagAttributes(): array
    {
        $attrs = $this->tagAttrs;
        if (!is_array($attrs)) {
            $attrs = [];
        }
        if (!empty($attrs) && ArrayHelper::isIndexed($attrs, true)) {
            $attrs = [];
            foreach ($this->tagAttrs as $attr) {
                $attrs[$attr['name']] = $attr['value'];
            }
        }
        $tagAttributes = array_merge($this->toArray(), $attrs);
        $tagAttributes = array_filter($tagAttributes);
        foreach ($tagAttributes as $key => $value) {
            ArrayHelper::rename($tagAttributes, $key, Inflector::slug(Inflector::titleize($key)));
        }
        ksort($tagAttributes);

        return $tagAttributes;
    }

    /**
     * Return an array of arrays that contain the meta tag attributes
     *
     * @return array
     */
    public function tagAttributesArray(): array
    {
        $result = [];
        $optionsCount = 1;
        $scenario = $this->scenario;
        $this->setScenario('render');
        $options = $this->tagAttributes();
        $this->setScenario($scenario);

        // See if any of the potentially array properties actually are
        foreach (static::ARRAY_PROPERTIES as $arrayProperty) {
            if (!empty($options[$arrayProperty]) && is_array($options[$arrayProperty])) {
                $optionsCount = count($options[$arrayProperty]) > $optionsCount
                    ? count($options[$arrayProperty]) : $optionsCount;
            }
        }
        // Return an array of resulting options
        while ($optionsCount--) {
            $resultOptions = $options;
            foreach ($resultOptions as $key => $value) {
                $resultOptions[$key] = (is_array($value) && isset($value[$optionsCount]))
                    ? $value[$optionsCount] : $value;
            }
            $result[] = $resultOptions;
        }

        return $result;
    }

    /**
     * Validate the passed in $attribute as either an array or a string
     *
     * @param mixed $attribute the attribute currently being validated
     * @param mixed $params the value of the "params" given in the rule
     */
    public function validateStringOrArray(
        $attribute,
        $params,
    ) {
        $validated = false;
        if (is_string($attribute)) {
            $validated = true;
        }
        if (is_array($attribute)) {
            $validated = true;
        }
        if (!$validated) {
            $this->addError($attribute, 'Must be either a string or an array');
        }
    }

    /**
     * @inheritdoc
     */
    protected function defineBehaviors(): array
    {
        return [
            'parser' => [
                'class' => MetaItemAttributeParserBehavior::class,
                'attributes' => [
                ],
            ],
        ];
    }
}