ymaker\social\share\base\DriverAbstract

Complexity

Total Complexity

21

Size/Duplication

Total Lines	206
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	19	3
A	setTitle()	0	3	1
A	addUrlParam()	0	13	4
A	decodeData()	0	11	3
A	setDescription()	0	3	1
A	setUrl()	0	3	1
A	getLink()	0	3	1
A	getMetaTags()	0	3	1
A	encodeData()	0	11	3
A	setImageUrl()	0	3	1
A	appendToData()	0	4	2

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

namespace ymaker\social\share\base;

use Yii;
use yii\base\BaseObject;
use yii\helpers\ArrayHelper;

/**
 * Base driver for social network definition classes.
 *
 * @property-write $url
 * @property-write $title
 * @property-write $description
 * @property-write $imageUrl
 *
 * @author Vladimir Kuprienko <vldmr.kuprienko@gmail.com>
 * @since 1.0
 */
abstract class DriverAbstract extends BaseObject
{
    /**
     * Absolute URL to the page.
     *
     * @var string
     */
    protected $url;
    /**
     * Title for share.
     *
     * @var string
     */
    protected $title;
    /**
     * Description for share.
     *
     * @var string
     */
    protected $description;
    /**
     * Absolute URL to the image for share.
     *
     * @var string
     */
    protected $imageUrl;

    /**
     * Contains data for URL.
     *
     * @var array
     */
    private $_data = [];


    /**
     * @param string $url
     * @since 2.0
     */
    public function setUrl($url)
    {
        $this->url = $url;
    }

    /**
     * @param string $title
     * @since 2.0
     */
    public function setTitle($title)
    {
        $this->title = $title;
    }

    /**
     * @param string $description
     * @since 2.0
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

    /**
     * @param string $imageUrl
     * @since 2.0
     */
    public function setImageUrl($imageUrl)
    {
        $this->imageUrl = $imageUrl;
    }

    /**
     * Append value to data array.
     *
     * @param string $key
     * @param string $value
     * @param bool $urlEncode
     * @since 2.0
     */
    public function appendToData($key, $value, $urlEncode = true)
    {
        $key = '{' . $key . '}';
        $this->_data[$key] = $urlEncode ? static::encodeData($value) : $value;
    }

    /**
     * Prepare data data to insert into the link.
     */
    public function init()
    {
        $this->processShareData();

        $this->_data = ArrayHelper::merge([
            '{url}'         => $this->url,
            '{title}'       => $this->title,
            '{description}' => $this->description,
            '{imageUrl}'    => $this->imageUrl
        ], $this->_data);

        $metaTags = $this->getMetaTags();
        if (!empty($metaTags)) {
            $rawData = static::decodeData($this->_data);
            $view = Yii::$app->getView();

            foreach ($metaTags as $metaTag) {
                $metaTag['content'] = strtr($metaTag['content'], $rawData);
                $view->registerMetaTag($metaTag);
            }
        }
    }

    /**
     * Generates share link.
     *
     * @return string
     */
    final public function getLink()
    {
        return strtr($this->buildLink(), $this->_data);
    }

    /**
     * Encode data for URL.
     *
     * @param string|array $data
     * @return string|array
     */
    public static function encodeData($data)
    {
        if (is_array($data)) {
            foreach ($data as $key => $value) {
                $data[$key] = urlencode($value);
            }

            return $data;
        }

        return urlencode($data);
    }

    /**
     * Decode the encoded data.
     *
     * @param string|array $data
     * @return string|array
     */
    public static function decodeData($data)
    {
        if (is_array($data)) {
            foreach ($data as $key => $value) {
                $data[$key] = urldecode($value);
            }

            return $data;
        }

        return urldecode($data);
    }

    /**
     * Adds URL param to link.
     *
     * @param string $link
     * @param string $name Param name.
     * @param string $value Param value.
     * @since 1.4.0
     */
    final protected function addUrlParam(&$link, $name, $value)
    {
        $base = $name . '=' . $value;

        if (strpos($link, '?') !== false) {
            $last = substr($link, -1);
            if ('?' === $last || '&' === $last) {
                $link .= $base;
            } else {
                $link .= '&' . $base;
            }
        } else {
            $link .= '?' . $base;
        }
    }

    /**
     * Returns array of meta tags.
     *
     * @return array
     * @since 2.0
     */
    protected function getMetaTags()
    {
        return [];
    }

    /**
     * Method should process the share data for current driver.
     */
    abstract protected function processShareData();

    /**
     * Method should build template of share link.
     *
     * @return string
     * @since 2.0
     */
    abstract protected function buildLink();
}