Sunnysideup\ShareThisSimple\Api\ShareThisSimpleProvider

Complexity

Total Complexity

67

Size/Duplication

Total Lines	545
Duplicated Lines	0 %

Importance

Changes	12
Bugs	1	Features	0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	FacebookShareLink()	0	3	1
A	PinterestShareLink()	0	3	1
A	getTumblrShareLink()	0	8	2
A	getRedditShareLink()	0	5	2
A	__construct()	0	7	2
A	setLinkMethod()	0	4	1
A	TumblrShareLink()	0	3	1
A	ShareThisLinks()	0	19	2
A	LinkedInShareLink()	0	3	1
A	setHashTags()	0	4	1
A	setTitleMethod()	0	4	1
A	setDescriptionMethod()	0	4	1
A	setMentions()	0	4	1
A	setVias()	0	4	1
A	setImageMethods()	0	4	1
A	EmailShareLink()	0	3	1
A	getWindowPopupHtml()	0	10	1
A	getEmailShareLink()	0	5	2
A	RedditShareLink()	0	3	1
A	getLinkedInShareLink()	0	8	2
A	getPinterestShareLink()	0	8	2
A	shareThisTitleField()	0	3	1
A	shareThisLinkField()	0	3	1
A	getShareThisArray()	0	37	3
B	shareThisMediaField()	0	28	10
A	getTwitterShareLink()	0	7	2
A	PinterestLinkForSpecificImage()	0	5	1
B	getPinterestLinkForSpecificImage()	0	17	7
A	shareThisDescriptionField()	0	20	4
A	shareThisFieldAsString()	0	10	3
A	TwitterShareLink()	0	3	1
A	getFacebookShareLink()	0	7	2
A	getValuesFromArrayToString()	0	13	4

<?php

namespace Sunnysideup\ShareThisSimple\Api;

use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;

use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\View\ArrayData;
use SilverStripe\View\ViewableData;

class ShareThisSimpleProvider extends ViewableData
{
    /**
     * @var DataObject
     */
    protected $object;

    protected $linkMethod = 'AbsoluteLink';

    protected $titleMethod = 'Title';

    protected $imageMethods = [];

    protected $descriptionMethod = 'SocialMediaDescription'; //change to 'SocialMediaDescription'

    protected $hashTagArray = [];

    protected $mentionsArray = [];

    protected $viasArray = [];

    /**
     * @var string
     */
    protected $pageURL = '';

    /**
     * @var string
     */
    protected $title = '';

    /**
     * @var string
     */
    protected $titleFull = '';

    /**
     * @var string
     */
    protected $media = '';

    /**
     * @var string
     */
    protected $description = '';

    /**
     * @var string
     */
    protected $descriptionFull = '';

    /**
     * @var string
     */
    protected $hashTags = '';

    /**
     * @var string
     */
    protected $mentions = '';

    /**
     * @var string
     */
    protected $vias = '';

    protected static $pop_up_window_height = 320;

    protected static $pop_up_window_width = 200;

    protected static $cacheGetShareThisArray = [];

    private static $description_method = '';

    private static $default_mentions = [];

    private static $default_vias = [];

    private static $default_hash_tags = [];

    private static $image_methods = [];

    private static $casting = [
        'FacebookShareLink' => 'Varchar',
        'TwitterShareLink' => 'Varchar',
        'TumblrShareLink' => 'Varchar',
        'PinterestShareLink' => 'Varchar',
        'EmailShareLink' => 'Varchar',
        'RedditShareLink' => 'Varchar',
        'PinterestLinkForSpecificImage' => 'Varchar',
    ];

    /**
     * @param DataObject $object
     */
    public function __construct($object)
    {
        parent::__construct();
        if (! $object instanceof DataObject) {

$object is always a sub-type of SilverStripe\ORM\DataObject.

            user_error('Please provide a DataObject, you have provided a: ' . get_class($object));
        }
        $this->object = $object;
    }

    public function setLinkMethod(string $s): self
    {
        $this->linkMethod = $s;
        return $this;
    }

    public function setTitleMethod(string $s): self
    {
        $this->titleMethod = $s;
        return $this;
    }

    public function setImageMethods(string $a): self
    {
        $this->imageMethods = $a;
        return $this;
    }

    public function setDescriptionMethod(string $s): self
    {
        $this->descriptionMethod = $s;
        return $this;
    }

    public function setHashTags(array $a): self
    {
        $this->hashTagsArray = $a;

The property hashTagsArray does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $this;
    }

    public function setMentions(array $a): self
    {
        $this->mentionsArray = $a;
        return $this;
    }

    public function setVias(array $a): self
    {
        $this->viasArray = $a;
        return $this;
    }

    public function getWindowPopupHtml(): string
    {
        $width = $this->Config()->get('pop_up_window_width');
        $height = $this->Config()->get('pop_up_window_height');
        $html = <<<html
                    onclick="window.open(this.href,'Share','width=${width},height=${height},toolbar=no,menubar=no,location=no,status=no,scrollbars=no,resizable=yes'); return '';"
html;
        $html = preg_replace('!\s+!', ' ', $html);

        return DBField::create_field('HTMLText', $html);
    }

    /**
     * return of ShareThisLinks.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return ArrayList
     */
    public function ShareThisLinks(?string $customDescription = ''): ArrayList
    {
        $arrayList = ArrayList::create();
        $options = array_keys($this->config()->get('casting')); //$this->config()->get('casting') ???
        foreach ($options as $option) {
            $className = str_replace('ShareLink', '', $option);
            $className = strtolower($className);
            $method = 'get' . $option;
            $arrayList->push(
                ArrayData::create(
                    [
                        'Class' => $className,
                        'Link' => $this->{$method}($customDescription),
                    ]
                )
            );
        }

        return $arrayList;
    }

    /**
     * ALIAS
     * Generate a URL to share this content on Facebook.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function FacebookShareLink(?string $customDescription = ''): string
    {
        return $this->getFacebookShareLink($customDescription);
    }

    /**
     * Generate a URL to share this content on Facebook.
     * @param string $customDescription   e.g. foo bar cool stuff
     * https://www.facebook.com/dialog/feed?
     *  &link=URL_HERE
     *  &picture=IMAGE_LINK_HERE
     *  &name=TITLE_HERE
     *  &caption=%20
     *  &description=DESCRIPTION_HERE
     *  &redirect_uri=http%3A%2F%2Fwww.facebook.com%2F
     * @return string
     */
    public function getFacebookShareLink(?string $customDescription = ''): string
    {
        $this->getShareThisArray($customDescription);
        return $this->pageURL ?
            'https://www.facebook.com/sharer/sharer.php?u=' . $this->pageURL . '&t=' . $this->title . ''
            :
            '';
    }

    /**
     * ALIAS
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function TwitterShareLink(?string $customDescription = ''): string
    {
        return $this->getTwitterShareLink($customDescription);
    }

    /**
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * example: https://twitter.com/intent/tweet?
     *  &source=http%3A%2F%2Fsunnysideup.co.nz
     *  &text=test:%20http%3A%2F%2Fsunnysideup.co.nz
     *  &via=foobar
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function getTwitterShareLink(?string $customDescription = ''): string
    {
        $this->getShareThisArray($customDescription);
        return $this->pageURL ?
            'https://twitter.com/intent/tweet?source=' . $this->pageURL . '&text=' . $this->titleFull . '' . urlencode(': ') . $this->pageURL
            :
            '';
    }

    /**
     * ALIAS
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function LinkedInShareLink(?string $customDescription = ''): string
    {
        return $this->getLinkedInShareLink($customDescription);
    }

    /**
     * Generate a URL to share this content on Twitter
     * Specs: ???
     * example: https://www.linkedin.com/shareArticle?
     * mini=true&url=http://www.cnn.com&title=&summary=chek this out&source=
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function getLinkedInShareLink(?string $customDescription = ''): string
    {
        $this->getShareThisArray($customDescription);

        return $this->pageURL ?
           'https://www.linkedin.com/shareArticle?mini=true&url=' . $this->pageURL . '&summary=' . $this->titleFull . ''
           :
           '';
    }

    /**
     * ALIAS
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function TumblrShareLink(?string $customDescription = ''): string
    {
        return $this->getTumblrShareLink($customDescription);
    }

    /**
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function getTumblrShareLink(?string $customDescription = '')
    {
        $this->getShareThisArray($customDescription);

        return $this->pageURL ?
            'http://www.tumblr.com/share/link?url=' . $this->pageURL . '&name=' . $this->title . '&description=' . $this->description . ''
            :
            '';
    }

    /**
     * ALIAS
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function PinterestShareLink(?string $customDescription = ''): string
    {
        return $this->getPinterestShareLink($customDescription);
    }

    /**
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function getPinterestShareLink(?string $customDescription = ''): string
    {
        $this->getShareThisArray($customDescription);

        return $this->pageURL ?
            'http://pinterest.com/pin/create/button/?url=' . $this->pageURL . '&description=' . $this->description . '&media=' . $this->media . ''
            :
            '';
    }

    /**
     * ALIAS
     * Generate a 'mailto' URL to share this content via Email.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function EmailShareLink(?string $customDescription = ''): string
    {
        return $this->getEmailShareLink($customDescription);
    }

    /**
     * Generate a 'mailto' URL to share this content via Email.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function getEmailShareLink(?string $customDescription = ''): string
    {
        $this->getShareThisArray($customDescription);

        return $this->pageURL ? 'mailto:?subject=' . $this->title . '&body=' . $this->pageURL . '' : '';
    }

    /**
     * ALIAS
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function RedditShareLink(?string $customDescription = ''): string
    {
        return $this->getRedditShareLink($customDescription);
    }

    /**
     * Generate a URL to share this content on Twitter
     * Specs: https://dev.twitter.com/web/tweet-button/web-intent.
     * @param string $customDescription   e.g. foo bar cool stuff
     * @return string
     */
    public function getRedditShareLink(?string $customDescription = ''): string
    {
        $this->getShareThisArray($customDescription);

        return $this->pageURL ? 'http://reddit.com/submit?url=' . $this->pageURL . '&title=' . $this->title . '' : '';
    }

    /**
     * @param string $customDescription   e.g. foo bar cool stuff
     *
     * @return array
     */
    public function getShareThisArray(?string $customDescription = ''): array
    {
        $cacheKey = $this->object->ID . '_' . preg_replace('/[^A-Za-z0-9]/', '_', $customDescription);
        if (! isset(self::$cacheGetShareThisArray[$cacheKey])) {
            //1. link
            $this->link = $this->shareThisLinkField();

The property link does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->title = $this->shareThisTitleField();

            $this->media = $this->shareThisMediaField();

            $this->description = $this->shareThisDescriptionField($customDescription);

            $this->hashTags = $this->getValuesFromArrayToString('hashTagsArray', 'hash_tags', '#');
            $this->mentions = $this->getValuesFromArrayToString('mentionsArray', 'mentions', '@');
            $this->vias = $this->getValuesFromArrayToString('viasArray', 'vias', '@');
            $this->titleFull = trim($this->mentions . ' ' . $this->title . ' ' . $this->hashTags . ' ' . $this->vias);
            $this->descriptionFull = trim($this->mentions . ' ' . $this->description . ' ' . $this->hashTags . ' ' . $this->vias);

            //return ...
            self::$cacheGetShareThisArray[$cacheKey] = [
                'pageURL' => rawurlencode($this->link),
                'title' => rawurlencode($this->title),
                'titleFull' => rawurlencode($this->titleFull),
                'media' => rawurlencode($this->media),
                'description' => rawurlencode($this->description),
                'descriptionFull' => rawurlencode($this->descriptionFull),
                'hashTags' => rawurlencode($this->hashTags),
                'mentions' => rawurlencode($this->mentions),
                'vias' => rawurlencode($this->vias),
            ];
        }
        foreach (self::$cacheGetShareThisArray[$cacheKey] as $field => $value) {
            $this->{$field} = $value;
        }

        return self::$cacheGetShareThisArray[$cacheKey];
    }

    /**
     * @param string $imageMethod   e.g. MyImage
     * @param bool $useImageTitle  if set to false, it will use the page title as the image title
     *
     * @return string
     */
    public function PinterestLinkForSpecificImage(string $imageMethod, ?bool $useImageTitle = false): string
    {
        return $this->getPinterestLinkForSpecificImage(
            $imageMethod,
            $useImageTitle
        );
    }

    public function getPinterestLinkForSpecificImage(string $imageMethod, ?bool $useImageTitle = false): string
    {
        if ($this->object && $this->object->exists() && $this->object->hasMethod($imageMethod)) {
            $image = $this->object->{$imageMethod}();
            if ($image && $image->exists()) {
                if ($useImageTitle) {
                    $imageTitle = $image->Title;
                } else {
                    $imageTitle = $this->object->Title;
                }
                return 'http://pinterest.com/pin/create/button/'
                    . '?url=' . urlencode($this->object->AbsoluteLink()) . '&'
                    . 'description=' . urlencode($imageTitle) . '&'
                    . 'media=' . urlencode($image->AbsoluteLink());
            }
        }
        return '';
    }

    protected function getValuesFromArrayToString(string $variable, string $staticVariable, ?string $prepender = '@')
    {
        if (! empty($this->{$variable})) {
            $a = $this->{$variable};
        } else {
            $a = $this->Config()->get($staticVariable);
        }
        $str = '';
        if (is_array($a) && count($a)) {
            $str = $prepender . implode(' ' . $prepender, $a);
        }

        return trim($str);
    }

    private function shareThisLinkField(): string
    {
        return $this->shareThisFieldAsString($this->linkMethod);
    }

    private function shareThisTitleField(): string
    {
        return $this->shareThisFieldAsString($this->titleMethod);
    }

    private function shareThisFieldAsString(string $field): string
    {
        $value = '';
        if ($this->object->hasMethod($field)) {
            $value = $this->object->{$field}();
        } elseif (isset($this->object->{$field})) {
            $value = $this->object->{$field};
        }

        return (string) $value;
    }

    private function shareThisMediaField(): string
    {
        $media = '';
        $imageMethods = $this->imageMethods;
        if (is_array($imageMethods) && count($imageMethods)) {
            //do nothing
        } else {
            $imageMethods = Config::inst()->get(
                'ShareThisSimpleProvider',
                'image_methods'
            );
        }
        if (is_array($imageMethods) && count($imageMethods)) {
            foreach ($imageMethods as $imageMethod) {
                if ($this->object->hasMethod($imageMethod)) {
                    $imageField = $imageMethod . 'ID';
                    if ($this->{$imageField}) {
                        $image = $this->object->{$imageMethod}();
                        if ($image && $image->exists()) {
                            $media = $image->AbsoluteLink();
                            break;
                        }
                    }
                }
            }
        }

        return $media;
    }

    private function shareThisDescriptionField(?string $customDescription = ''): string
    {
        if ($customDescription) {
            $description = $customDescription;
        } else {
            $description = '';
            if ($descriptionMethod = $this->descriptionMethod) {
                //do nothing
            } else {
                $descriptionMethod = Config::inst()->get(
                    'ShareThisSimpleProvider',
                    'description_method'
                );
            }
            if ($descriptionMethod) {
                $description = $this->shareThisFieldAsString($descriptionMethod);
            }
        }

        return (string) $description;
    }
}