silverstripe / cwp-agencyextensions

src/Extensions/CarouselPageExtension.php

<?php

namespace CWP\AgencyExtensions\Extensions;

use CWP\AgencyExtensions\Model\CarouselItem;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataExtension;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use SilverStripe\Forms\GridField\GridFieldSortableHeader;
use SilverStripe\ORM\DataList;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
use SilverStripe\Forms\GridField\GridFieldVersionedState;
use SilverStripe\Forms\LiteralField;

class CarouselPageExtension extends DataExtension
{
    private static $db = [

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

        'CarouselTitle' => 'Text',
    ];

    private static $has_many = [

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

        'CarouselItems' => CarouselItem::class,
    ];

    private static $owns = [

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

        'CarouselItems',
    ];

    /**
     * @return DataList
     */
    public function getCarouselItems()
    {
        return $this->owner->getComponents('CarouselItems')->sort('SortOrder');

The expression return $this->owner->getComponents('CarouselItems')->sort('SortOrder') also could return the type SilverStripe\ORM\UnsavedRelationList which is incompatible with the documented return type SilverStripe\ORM\DataList.

    }

    /**
     * Add the carousel management GridField to the Page's CMS fields
     *
     * @param FieldList $fields
     */
    public function updateCMSFields(FieldList $fields)
    {
        $gridField = GridField::create(
            'CarouselItems',
            _t(__CLASS__ . 'TITLE', 'Hero/Carousel'),
            $this->getCarouselItems(),
            GridFieldConfig_RelationEditor::create()
        );
        $gridField->setDescription(_t(
            __CLASS__ . 'NOTE',
            'Carousel functionality will automatically be loaded when 2 or more items are added below'
        ));
        $gridConfig = $gridField->getConfig();
        $gridConfig->getComponentByType(GridFieldAddNewButton::class)->setButtonName(
            _t(__CLASS__ . 'ADDNEW', 'Add new')
        );
        $gridConfig->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
        $gridConfig->removeComponentsByType(GridFieldDeleteAction::class);
        $gridConfig->addComponent(new GridFieldDeleteAction());
        $gridConfig->addComponent(new GridFieldOrderableRows('SortOrder'));
        $gridConfig->removeComponentsByType(GridFieldSortableHeader::class);
        $gridField->setModelClass(CarouselItem::class);

        $fields->findOrMakeTab(
            'Root.Carousel',
            _t(__CLASS__ . 'TITLE', 'Hero/Carousel')
        );

        $titleField = TextField::create('CarouselTitle', 'Carousel Title');
        $titleField->setDescription(_t(
            __CLASS__ . 'TITLE_NOTE',
            'Used by screen readers'
        ));

        $fields->addFieldToTab('Root.Carousel', $titleField);
        $fields->addFieldToTab('Root.Carousel', $gridField);
    }
}