ymaker\social\share\configurators\Configurator

Complexity

Total Complexity

16

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getSocialNetworks()	0	3	1
A	getOptions()	0	5	2
A	canRegisterMetaTags()	0	3	1
A	getIconSelector()	0	3	2
A	isDefaultAssetEnabled()	0	3	2
A	isSeoEnabled()	0	3	1
A	isIconsEnabled()	0	3	2
A	init()	0	11	5

<?php
/**
 * @link https://github.com/yiimaker/yii2-social-share
 * @copyright Copyright (c) 2017-2018 Yii Maker
 * @license BSD 3-Clause License
 */

namespace ymaker\social\share\configurators;

use yii\base\BaseObject;
use yii\helpers\ArrayHelper;
use ymaker\social\share\drivers\Facebook;
use ymaker\social\share\drivers\GooglePlus;
use ymaker\social\share\drivers\LinkedIn;
use ymaker\social\share\drivers\Gmail;
use ymaker\social\share\drivers\Trello;
use ymaker\social\share\drivers\WhatsApp;
use ymaker\social\share\drivers\Telegram;
use ymaker\social\share\drivers\Pinterest;
use ymaker\social\share\drivers\Tumblr;
use ymaker\social\share\drivers\Twitter;
use ymaker\social\share\drivers\Vkontakte;
use ymaker\social\share\drivers\Yahoo;
use ymaker\social\share\drivers\Odnoklassniki;

/**
 * Configurator for social network drivers.
 *
 * @author Vladimir Kuprienko <vldmr.kuprienko@gmail.com>
 * @since 1.0
 */
class Configurator extends BaseObject implements ConfiguratorInterface, IconsConfigInterface, SeoConfigInterface
{
    const DEFAULT_ICONS_MAP = [
        Vkontakte::class     => 'si si-vk',
        Facebook::class      => 'si si-facebook',
        Twitter::class       => 'si si-twitter',
        GooglePlus::class    => 'si si-google-plus',
        LinkedIn::class      => 'si si-linkedin',
        Pinterest::class     => 'si si-pinterest',
        Telegram::class      => 'si si-telegram',
        WhatsApp::class      => 'si si-whatsapp',
        Gmail::class         => 'si si-gmail',
        Tumblr::class        => 'si si-tumblr',
        Yahoo::class         => 'si si-yahoo',
        Odnoklassniki::class => 'si si-odnoklassniki',
        Trello::class        => 'si si-trello',
    ];

    /**
     * Configuration of social network drivers.
     *
     * @var array
     */
    public $socialNetworks = [];
    /**
     * CSS options for share links.
     *
     * @var array
     */
    public $options = [];
    /**
     * Enable SEO options for share links.
     *
     * @var bool
     */
    public $enableSeoOptions = true;
    /**
     * HTML attributes from this option will be applied if `enableSeoOptions` is true.
     *
     * @var array
     */
    public $seoOptions = [];
    /**
     * Enable default icons instead labels for social networks.
     *
     * @var bool
     *
     * @deprecated since 2.3
     */
    public $enableDefaultIcons = false;
    /**
     * Enable icons instead of text labels.
     *
     * @var bool
     *
     * @since 2.3
     */
    public $enableIcons = false;
    /**
     * Enable default icons asset.
     *
     * @var bool
     *
     * @since 2.3
     */
    public $enableDefaultAsset = true;
    /**
     * Configuration of icons for social network drivers.
     *
     * @var array
     */
    public $icons = [];
    /**
     * Enable registering of drivers meta tags.
     *
     * @var bool
     *
     * @since 2.1
     */
    public $registerMetaTags = true;


    /**
     * Set default values for special link options.
     */
    public function init()
    {
        if ($this->isSeoEnabled() && empty($this->seoOptions)) {
            $this->seoOptions = [
                'target' => '_blank',
                'rel'    => 'noopener',
            ];
        }

        if ($this->enableIcons || $this->enableDefaultIcons) {

The property ymaker\social\share\configurators\Configurator::$enableDefaultIcons has been deprecated: since 2.3

            $this->icons = ArrayHelper::merge(self::DEFAULT_ICONS_MAP, $this->icons);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getSocialNetworks()
    {
        return $this->socialNetworks;
    }

    /**
     * {@inheritdoc}
     */
    public function getOptions()
    {
        return $this->isSeoEnabled()
            ? ArrayHelper::merge($this->options, $this->seoOptions)
            : $this->options;
    }

    /**
     * {@inheritdoc}
     */
    public function canRegisterMetaTags()
    {
        return $this->registerMetaTags;
    }

    /**
     * {@inheritdoc}
     */
    public function isIconsEnabled()
    {
        return $this->enableIcons || $this->enableDefaultIcons;

The property ymaker\social\share\configurators\Configurator::$enableDefaultIcons has been deprecated: since 2.3

    }

    /**
     * {@inheritdoc}
     */
    public function isDefaultAssetEnabled()
    {
        return $this->enableDefaultAsset || $this->enableDefaultIcons;

The property ymaker\social\share\configurators\Configurator::$enableDefaultIcons has been deprecated: since 2.3

    }

    /**
     * {@inheritdoc}
     *
     * @param string $driverName Class name of the needed driver.
     */
    public function getIconSelector($driverName)
    {
        return isset($this->icons[$driverName]) ? $this->icons[$driverName] : '';
    }

    /**
     * {@inheritdoc}
     */
    public function isSeoEnabled()
    {
        return $this->enableSeoOptions;
    }
}