sunnysideup / silverstripe-sharethis

code/model/ShareThisDataObject.php

<?php

namespace SunnysideUp\ShareThis;

use SilverStripe\Assets\Image;
use SilverStripe\Core\Config\Config;
use SilverStripe\Forms\LiteralField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use SunnysideUp\ShareThis\ShareThisOptions;
use SunnysideUp\ShareThis\ShareThisSTE;

/**
 * @author nicolaas[at]sunnysideup.co.nz
 * @description: list of Share This Options that can be shown
 * @todo finish onAfterWrite and delete objects
 */
// class ShareThisDataObject extends DataObject implements PermissionProvider
class ShareThisDataObject extends DataObject
{
    /**
     * @var string
     */
    private static $table_name = 'ShareThisDataObject';

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

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

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

        "SOCIAL_MEDIA" => [
            'name' => "Social Media Management",
            'category' => "Social Media",
            'help' => 'Edit relationships, links and data of various social media platforms.',
            'sort' => 0
        ]
    ];

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

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

        'Title' => 'Varchar(20)',
        'IncludeThisIcon' => 'Boolean',
        'IncludeThisIconInExtendedList' => 'Boolean',
        'Sort' => 'Int'
    ];

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

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

        'AlternativeIcon' => Image::class
    ];

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

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

        'Icon' => 'HTMLText',
        'IncludeThisIconNice' => 'Varchar',
        'IncludeThisIconInExtendedListNice' => 'IncludeThisIconInExtendedList'
    ];

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

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

        'Title' => 'Name',
        'IncludeThisIcon' => 'Include in main list',
        'IncludeThisIconNice' => 'Include in primary list',
        'IncludeThisIconInExtendedList' => 'Include in secondary list',
        'IncludeThisIconInExtendedListNice' => 'Include in secondary list',
        'Sort' => 'Sort Index (lower numbers shown first)',
        'AlternativeIcon' => 'Optional Alternative Icon (can be any size, a 32px by 32px square is recommended)'
    ];

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

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

        'Title' => 'Name',
    ];

    /**
     * @var string
     */
    private static $singular_name = 'Icon to share this page';

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

    /**
     * @var string
     */
    private static $plural_name = 'Icons to share this page';

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

    /**
     * @var string
     */
    private static $default_sort = 'IncludeThisIcon DESC, IncludeThisIconInExtendedList ASC, Sort ASC, Title ASC';

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

    /**
     * @return string
     */
    public function providePermissions()
    {
        return Config::inst()->get(ShareThisDataObject::class, "permission_framework");
    }

    /**
     * @return boolean
     */
    public function canView($member = null)
    {
        return Permission::checkMember($member, 'SOCIAL_MEDIA');
    }

    /**
     * @return boolean
     */
    public function canCreate($member = null, $context = [])
    {
        return Permission::checkMember($member, 'SOCIAL_MEDIA');
    }

    /**
     * @return boolean
     */
    public function canEdit($member = null)
    {
        return Permission::checkMember($member, 'SOCIAL_MEDIA');
    }

    /**
     * @return boolean
     */
    public function canDelete($member = null)
    {
        return Permission::checkMember($member, 'SOCIAL_MEDIA');
    }

    /**
     * @return string
     */
    public function IncludeThisIconNice()
    {
        return $this->getIncludeThisIconNice();
    }

    /**
     * @return string
     */
    public function getIncludeThisIconNice()
    {
        return $this->IncludeThisIcon ? "Yes" : "No" ;
    }

    /**
     * @return string
     */
    public function IncludeThisIconInExtendedListNice()
    {
        return $this->getIncludeThisIconInExtendedListNice();
    }

    /**
     * @return string
     */
    public function getIncludeThisIconInExtendedListNice()
    {
        return $this->IncludeThisIconInExtendedList ? "Yes" : "No" ;

The property IncludeThisIconInExtendedList does not exist on SunnysideUp\ShareThis\ShareThisDataObject. Since you implemented __get, consider adding a @property annotation.

    }

    /**
     * Icon
     */
    public function Icon()
    {
        return $this->getIcon();
    }

    /**
     * Get the icon
     *
     * @return  DBField [<description>]
     */
    public function getIcon()
    {
        $icon = $this->AlternativeIcon();

The method AlternativeIcon() does not exist on SunnysideUp\ShareThis\ShareThisDataObject. Since you implemented __call, consider adding a @method annotation.

        if ($icon->exists()) {
            return $icon->ScaleHeight(16);
        }

        $html = '<img src="' . SS_SHARETHIS_DIR . '/images/icons/' . strtolower($this->Title) . ".png\" alt=\"{$this->Title}\"/>";

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

    /**
     * @return FieldList $fields

The type SunnysideUp\ShareThis\FieldList was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        if (class_exists("DataObjectSorterDOD")) {
            $fields->addFieldToTab("Root.Sort", LiteralField::create("SortShortList", $this->dataObjectSorterPopupLink("IncludeThisIcon", 1, "<h3>Sort Main Icons</h3>")));

The method dataObjectSorterPopupLink() does not exist on SunnysideUp\ShareThis\ShareThisDataObject. Since you implemented __call, consider adding a @method annotation.

        }

        return $fields;
    }

    /**
     * @return void
     */
    public function onAfterWrite()
    {
        parent::onAfterWrite();
        $objects = ShareThisDataObject::get()->filter('Title', $this->Title)->exclude('ID', $this->ID);

The assignment to $objects is dead and can be removed.

    }

    /**
     * @return ValidationResult $result
     */
    public function validate()
    {
        $result = parent::validate();
        $bookmarks = ShareThisOptions::get_page_specific_data("", "", "");
        if (!isset($bookmarks[$this->Title])) {
            $result->addError(sprintf(
                _t(
                    'ShareThisDataObject.NON_EXISTING_TITLE',
                    'This social plaform "%s" does not exist.  Please change / delete the this entry.'
                ),
                $this->Title
            ));
        }

        return $result;
    }

    /**
     * Setting default records
     *
     * @return void
     */
    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        $actualArray = ShareThisOptions::get_general_data();
        Config::inst()->update(ShareThisSTE::class, "included_icons", []);

The method update() does not exist on SilverStripe\Config\Collections\ConfigCollectionInterface. It seems like you code against a sub-type of SilverStripe\Config\Collections\ConfigCollectionInterface such as SilverStripe\Config\Collections\MemoryConfigCollection.

        Config::inst()->update(ShareThisSTE::class, "excluded_icons", []);
        ShareThisOptions::set_general_data(null);

The call to SunnysideUp\ShareThis\ShareThisOptions::set_general_data() has too many arguments starting with null.

        $fullArray = ShareThisOptions::get_general_data();

        foreach ($fullArray as $key) {
            $object = ShareThisDataObject::get()->filter('Title', $key);

            if (!$object->exists()) {
                $object = new ShareThisDataObject();
                $object->Title = $key;
                $style = 'excluded';
                $object->IncludeThisIcon = false;

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

                if (in_array($key, $actualArray)) {

$actualArray of type SunnysideUp\ShareThis\general_data is incompatible with the type array expected by parameter $haystack of in_array().

                    $object->IncludeThisIcon = true;
                    $style = 'included';
                }

                $object->write();
                DB::alteration_message("Added Bookmark Icon for $key ($style)", 'created');
            }
        }

        $inc = Config::inst()->get(ShareThisSTE::class, "included_icons");

        foreach ($inc as $key) {
            $object = ShareThisDataObject::get()->filter(['Title' => $key, 'IncludeThisIcon' => 0]);

            if ($object->exists()) {
                $object = $object->first();
                $object->IncludeThisIcon = true;
                $object->write();
                DB::alteration_message("Updated inclusion for $key", 'created');
            }
        }

        $exc = Config::inst()->get(ShareThisSTE::class, "excluded_icons");

        foreach ($exc as $key) {
            $object = ShareThisDataObject::get()->filter(['Title' => $key, 'IncludeThisIcon' => 1]);

            if ($object->exists()) {
                $object = $object->first();
                $object->IncludeThisIcon = false;
                $object->write();
                DB::alteration_message("Updated inclusion for $key", 'created');
            }
        }
    }
}