dynamic / silverstripe-elemental-promos

src/Elements/ElementPromos.php

<?php

namespace Dynamic\Elements\Promos\Elements;

use DNADesign\Elemental\Models\BaseElement;
use Dynamic\Elements\Promos\Model\PromoObject;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\FieldType\DBHTMLText;
use SilverStripe\Versioned\GridFieldArchiveAction;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

/**
 * Class ElementPromos
 * @package Dynamic\Elements\Promos\Elements
 *
 * @property string $Content
 *
 * @method \SilverStripe\ORM\ManyManyList Promos()
 */
class ElementPromos extends BaseElement
{
    /**
     * @var string
     */
    private static $icon = 'font-icon-block-banner';

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

    /**
     * @return string
     */
    private static $singular_name = 'Promos Element';

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

    /**
     * @return string
     */
    private static $plural_name = 'Promos Elements';

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

    /**
     * @var string
     */
    private static $table_name = 'ElementPromos';

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

    /**
     * @var array
     */
    private static $styles = array();

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

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

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

        'Content' => 'HTMLText',
    ];

    /**
     * @var array
     */
    private static $many_many = array(

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

        'Promos' => PromoObject::class,
    );

    /**
     * @var array
     */
    private static $many_many_extraFields = array(

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

        'Promos' => array(
            'SortOrder' => 'Int',
        ),
    );

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

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

        'Promos',
    ];

    /**
     * Set to false to prevent an in-line edit form from showing in an elemental area. Instead the element will be
     * clickable and a GridFieldDetailForm will be used.
     *
     * @config
     * @var bool
     */
    private static $inline_editable = false;

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

    /**
     * @param bool $includerelations
     * @return array
     */
    public function fieldLabels($includerelations = true)
    {
        $labels = parent::fieldLabels($includerelations);

        $labels['Content'] = _t(__CLASS__.'.ContentLabel', 'Intro');
        $labels['Promos'] = _t(__CLASS__ . '.PromosLabel', 'Promos');

        return $labels;
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (FieldList $fields) {
            $fields->dataFieldByName('Content')
                ->setRows(5);

            if ($this->ID) {
                /** @var \SilverStripe\Forms\GridField\GridField $promoField */
                $promoField = $fields->dataFieldByName('Promos');
                $fields->removeByName('Promos');
                $config = $promoField->getConfig();
                $config->removeComponentsByType([
                    GridFieldAddExistingAutocompleter::class,
                    GridFieldDeleteAction::class,

The type Dynamic\Elements\Promos\Elements\GridFieldDeleteAction was not found. Maybe you did not declare it correctly or list all dependencies?

                    GridFieldArchiveAction::class,
                ])->addComponents(
                    new GridFieldOrderableRows('SortOrder'),
                    new GridFieldAddExistingSearchButton()
                );

                $fields->addFieldsToTab('Root.Main', array(
                    $promoField,
                ));
            }
        });

        return parent::getCMSFields();
    }

    /**
     * @return mixed
     */
    public function getPromoList()
    {
        return $this->Promos()->sort('SortOrder');
    }

    /**
     * @return DBHTMLText
     */
    public function getSummary()
    {
        if ($this->Promos()->count() == 1) {
            $label = ' promo';
        } else {
            $label = ' promos';
        }
        return DBField::create_field('HTMLText', $this->Promos()->count() . $label)->Summary(20);
    }

    /**
     * @return array
     */
    protected function provideBlockSchema()
    {
        $blockSchema = parent::provideBlockSchema();
        $blockSchema['content'] = $this->getSummary();
        return $blockSchema;
    }

    /**
     * @return string
     */
    public function getType()
    {
        return _t(__CLASS__.'.BlockType', 'Promos');
    }
}