nystudio107\seomatic\variables\SeomaticVariable

Complexity

Total Complexity

28

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	6
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	1
A	getEnvironment()	0	3	1
B	getEnvironmentMessage()	0	56	11
A	getPluginName()	0	3	1
C	init()	0	26	14

<?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\variables;

use craft\helpers\UrlHelper;
use nystudio107\seomatic\Seomatic;
use nystudio107\seomatic\helpers\Environment as EnvironmentHelper;
use nystudio107\seomatic\models\MetaGlobalVars;
use nystudio107\seomatic\models\MetaSiteVars;
use nystudio107\seomatic\models\MetaSitemapVars;
use nystudio107\seomatic\models\Settings;
use nystudio107\seomatic\services\Helper;
use nystudio107\seomatic\services\JsonLd;
use nystudio107\seomatic\services\Link;
use nystudio107\seomatic\services\Script;
use nystudio107\seomatic\services\Tag;
use nystudio107\seomatic\services\Title;
use nystudio107\seomatic\services\MetaContainers;
use nystudio107\seomatic\services\MetaBundles;

use nystudio107\pluginmanifest\variables\ManifestVariable as Manifest;

use Craft;

use yii\di\ServiceLocator;

/**
 * Seomatic defines the `seomatic` global template variable.
 *
 * @property Helper     helper

The tag in position 1 should be the @package tag

 * @property JsonLd     jsonLd
 * @property Link       link
 * @property Script     script
 * @property Tag        tag
 * @property Title      title
 * @property Manifest   manifest
 *
 * @author    nystudio107

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @package   Seomatic
 * @since     3.0.0
 */
class SeomaticVariable extends ServiceLocator
{
    // Properties
    // =========================================================================

    /**
     * @var MetaGlobalVars
     */
    public $meta;

    /**
     * @var MetaSiteVars
     */
    public $site;

    /**
     * @var MetaSitemapVars
     */
    public $sitemap;

    /**
     * @var Settings
     */
    public $config;

    /**
     * @var MetaContainers
     */
    public $containers;

    /**
     * @var MetaBundles
     */
    public $bundles;

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

    /**

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

     * @inheritdoc
     */
    public function __construct($config = [])
    {
        /** @noinspection PhpDeprecationInspection */

The close comment tag must be the only content on the line

The open comment tag must be the only content on the line

        $components = [
            'helper' => Helper::class,
            'jsonLd' => JsonLd::class,
            'link' => Link::class,
            'script' => Script::class,
            'tag' => Tag::class,
            'title' => Title::class,
            'manifest' => [
                'class' => Manifest::class,
                'manifestService' => Seomatic::$plugin->manifest,
            ]
        ];

        $config['components'] = $components;

        parent::__construct($config);
    }

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

        $replaceVars = Seomatic::$loadingMetaContainers || Seomatic::$previewingMetaContainers;
        if ($this->meta === null || $replaceVars) {
            $this->meta = Seomatic::$plugin->metaContainers->metaGlobalVars;
        }
        if ($this->site === null || $replaceVars) {
            $this->site = Seomatic::$plugin->metaContainers->metaSiteVars;
        }
        if ($this->sitemap === null || $replaceVars) {
            $this->sitemap = Seomatic::$plugin->metaContainers->metaSitemapVars;
        }
        if ($this->containers === null || $replaceVars) {
            $this->containers = Seomatic::$plugin->metaContainers;
        }
        if ($this->bundles === null || $replaceVars) {
            $this->bundles = Seomatic::$plugin->metaBundles;
        }
        // Set the config settings, parsing the environment if its a frontend request
        $configSettings = Seomatic::$settings;
        if (!$replaceVars && !Craft::$app->getRequest()->getIsCpRequest()) {
            $configSettings->environment = Seomatic::$environment;
        }
        $this->config = $configSettings;
    }

    /**
     * Get the plugin's name
     *
     * @return null|string
     */
    public function getPluginName()
    {
        return Seomatic::$plugin->name;
    }

    /**
     * @return string
     */
    public function getEnvironment()
    {
        return Craft::parseEnv(Seomatic::$environment);

The expression return Craft::parseEnv(nystudio107\seomatic\Seomatic::environment) also could return the type boolean which is incompatible with the documented return type string.

    }

    /**
     * @return string
     */
    public function getEnvironmentMessage()
    {
        $result = '';
        /** @var Settings $settings */

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

        $settings = Seomatic::$plugin->getSettings();
        $settingsEnv = $settings->environment;
        if (Seomatic::$craft31) {
            $settingsEnv = Craft::parseEnv($settingsEnv);
        }
        $env = Seomatic::$environment;
        $settingsUrl = UrlHelper::cpUrl('seomatic/plugin');
        $general = Craft::$app->getConfig()->getGeneral();
        if (!$general->allowAdminChanges) {
            $settingsUrl = '';
        }
        // If they've manually overridden the environment, just return it
        if (EnvironmentHelper::environmentOverriddenByConfig()) {
            return Craft::t('seomatic', 'This is overridden by the `config/seomatic.php` config setting',
                []
            );
        }
        // If devMode is on, always force the environment to be 'local'
        if (Seomatic::$devMode) {
            return Craft::t('seomatic', 'The `{settingsEnv}` [SEOmatic Environment]({settingsUrl}) setting has been overriden to `{env}`, because the `devMode` config setting is enabled. Tracking scripts are disabled, and the `robots` tag is set to `none` to prevent search engine indexing.',
                ['env' => $env, 'settingsEnv' => $settingsEnv, 'settingsUrl' => $settingsUrl]
            );
        }
        // Try to also check the `ENVIRONMENT` env var
        $envVar = getenv('ENVIRONMENT');
        if (Seomatic::$settings->manuallySetEnvironment) {
            $envVar = $settingsEnv;
        }
        if (!empty($envVar)) {
            $env = EnvironmentHelper::determineEnvironment();
            switch ($env) {
                case EnvironmentHelper::SEOMATIC_DEV_ENV:

Line indented incorrectly; expected 12 spaces, found 16

                    $additionalMessage = 'Tracking scripts are disabled, and the `robots` tag is set to `none` to prevent search engine indexing.';
                    break;
                case EnvironmentHelper::SEOMATIC_STAGING_ENV:

Line indented incorrectly; expected 12 spaces, found 16

                    $additionalMessage = 'The `robots` tag is set to `none` to prevent search engine indexing.';
                    break;
                case EnvironmentHelper::SEOMATIC_PRODUCTION_ENV:

Line indented incorrectly; expected 12 spaces, found 16

                    $additionalMessage = '';
                    break;
                default:

Line indented incorrectly; expected 12 spaces, found 16

                    $additionalMessage = '';
                    break;
            }
            if ($settings->environment !== $env) {
                return Craft::t('seomatic', 'The `{settingsEnv}` [SEOmatic Environment]({settingsUrl}) setting has been overriden to `{env}`, because the `.env` setting `ENVIRONMENT` is set to `{envVar}`. {additionalMessage}',
                    ['env' => $env, 'settingsEnv' => $settingsEnv, 'settingsUrl' => $settingsUrl, 'envVar' => $envVar, 'additionalMessage' => $additionalMessage]
                );
            }
        }

        return $result;
    }
}