sunnysideup / silverstripe-sharethis

code/extension/SocialNetworksSTE.php

<?php

namespace SunnysideUp\ShareThis;

use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\View\Requirements;
use SilverStripe\Core\Config\Config;
use SunnysideUp\ShareThis\SocialNetworkingLinksDataObject;
use SilverStripe\CMS\Model\SiteTreeExtension;

/**
 * Add a field to each SiteTree object and it's subclasses to enable "follow us on ...", this can be a blog, twitter, facebook or whatever else.
 * it uses the SocialNetworkingLinksDataObject to get a list of icons.
 * @author nicolaas [at] sunnysideup.co.nz
 * @todo fix populateDefaults to make sure SiteConfig table is built first
 */
class SocialNetworksSTE extends SiteTreeExtension
{

    /**
     * Use the font-awesome icon collection?
     * @var Boolean
     */
    private static $use_font_awesome = false;

The private property $use_font_awesome is not used, and could be removed.

    /**
     * list of sitetree extending classnames where
     * the ShareThis functionality should be included
     * @var Array
     */
    private static $always_include_in = [];

The private property $always_include_in is not used, and could be removed.

    /**
     * list of sitetree extending classnames where
     * the ShareThis functionality should NEVER be included
     * @var Array
     */
    private static $never_include_in = [];

The private property $never_include_in is not used, and could be removed.

    /**
     * @var array
     */
    private static $db = [

The private property $db is not used, and could be removed.

        'HasSocialNetworkingLinks' => 'Boolean'
    ];

    /**
     * @param  FieldList $fields
     *
     * @return FieldList $fields
     */
    public function updateCMSFields(FieldList $fields)
    {
        if ($this->applyToOwnerClass()) {
            $config = $this->owner->getSiteConfig();
            if (! $config->AlwaysIncludeSocialNetworkingLinks) {
                $fields->addFieldToTab('Root.SocialMedia', HeaderField::create('SocialNetworksHeader', 'Ask visitors to JOIN YOU on your social media'));
                $fields->addFieldToTab('Root.SocialMedia', CheckboxField::create('HasSocialNetworkingLinks', 'Show Join Us on our Social Networks Links on this Page (e.g. follow us on Twitter) - make sure to specify social networking links!'));
            }
            $fields->addFieldToTab('Root.SocialMedia', LiteralField::create('LinkToSiteConfigSocialMedia', "<p>There are more social media settings in the <a href=\"{$config->CMSEditLink()}\">Site Config</a>.</p>"));
        }
        return $fields;
    }

    /**
     * @return boolean
     */
    public function ShowSocialNetworks()
    {
        if ($this->applyToOwnerClass()) {
            $config = $this->owner->getSiteConfig();
            if ($config->AlwaysIncludeSocialNetworkingLinks) {
                return true;
            }
            return $this->owner->HasSocialNetworkingLinks;
        }
        return false;
    }

    /**
     * @return SocialNetworkingLinksDataObject
     */
    public function SocialNetworks()
    {
        Requirements::themedCSS('SocialNetworking', "sharethis");

        if (Config::inst()->get(SocialNetworksSTE::class, "use_font_awesome")) {
            Requirements::css("//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css");
        }
        return SocialNetworkingLinksDataObject::get();
    }

    /**
     * @return boolean
     */
    private function applyToOwnerClass()
    {
        $always = Config::inst()->get(SocialNetworksSTE::class, "always_include_in");
        $never = Config::inst()->get(SocialNetworksSTE::class, "never_include_in");
        if (count($always) == 0 && count($never) == 0) {
            return true;
        }
        if (count($never) && count($always) == 0) {
            if (in_array($this->owner->ClassName, $never)) {
                return false;
            }
            return true;
        }
        if (count($always) && count($never) == 0) {
            if (in_array($this->owner->ClassName, $always)) {
                return true;
            }
            return false;
        }
        if (count($never) && count($always)) {
            if (in_array($this->owner->ClassName, $never)) {
                return false;
            }
            if (in_array($this->owner->ClassName, $always)) {
                return true;
            }
            //exception... if dev sets both always and never
            //then the ones not set will be included by default.
            return true;
        }
    }
}