i-lateral / silverstripe-carousel

src/extensions/CarouselPage.php

<?php

namespace ilateral\SilverStripe\Carousel\Extensions;

use SilverStripe\Dev\Debug;
use SilverStripe\Assets\Image;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\ORM\DataExtension;
use SilverStripe\Core\Config\Config;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\NumericField;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\GridField\GridField;
use Heyday\ResponsiveImages\ResponsiveImageExtension;
use ilateral\SilverStripe\Carousel\Model\CarouselSlide;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;

/**
 * Extension to all page objects that add carousel slide relationships
 * 
 * @author i-lateral (http://www.i-lateral.com)
 * @package carousel
 */
class CarouselPage extends DataExtension
{
    
    /**
     * DB Columns
     * 
     * @var array
     * @config
     */
    private static $db = [

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

        'ShowCarousel'  => 'Boolean',
        "CarouselShowIndicators" => "Boolean",
        "CarouselShowControls" => "Boolean",
        "CarouselProfile" => "Varchar",
        "CarouselInterval" => "Int"
    ];

    /**
     * Has Many relations
     * 
     * @var array
     * @config
     */
    private static $has_many = [

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

        'Slides' => CarouselSlide::class
    ];

    /**
     * Default variables
     * 
     * @var array
     * @config
     */
    private static $defaults = [

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

        'CarouselProfile' => 'ShortCarousel',
        'CarouselInterval' => 3000,
    ];

    public function updateCMSFields(FieldList $fields)
    {
        if($this->owner->ShowCarousel) {
            $carousel_table = GridField::create(
                'Slides',
                false,
                $this->owner->Slides(),
                GridFieldConfig_RecordEditor::create()
                    ->addComponent(new GridFieldOrderableRows('Sort'))
            );

            $fields->addFieldToTab('Root.Carousel', $carousel_table);
        } else {
            $fields->removeByName('Slides');
        }

        $fields->removeByName('ShowCarousel');
        $fields->removeByName('CarouselProfile');

        parent::updateCMSFields($fields);
    }

    public function updateSettingsFields(FieldList $fields)
    {
        $message = '<p>Configure this page to use a carousel</p>';
        
        $fields->addFieldToTab(
            'Root.Settings',
            LiteralField::create("CarouselMessage", $message)
        );

        $carousel = FieldGroup::create(
            CheckboxField::create(
                'ShowCarousel',
                'Show a carousel on this page?'
            ),
            CheckboxField::create(
                'CarouselShowIndicators',
                $this->owner->fieldLabel('CarouselShowIndicators')
            ),
            CheckboxField::create(
                'CarouselShowControls',
                $this->owner->fieldLabel('CarouselShowControls')
            )
        )->setTitle('Carousel');

        $fields->addFieldToTab(
            'Root.Settings',
            $carousel
        );

        if($this->owner->ShowCarousel) {
            $array = [];
            foreach (array_keys(Config::inst()->get(ResponsiveImageExtension::class, 'sets')) as $key => $value) {
                $array[$value] = $value;
            }
            $fields->addFieldsToTab(
                'Root.Settings',
                [
                    DropdownField::create(
                        'CarouselProfile',
                        $this->owner->fieldLabel('CarouselProfile'),
                        $array
                    )->setEmptyString('Choose one'),
                    NumericField::create(
                        'CarouselInterval',
                        $this->owner->fieldLabel('CarouselInterval')
                    )
                ]
            );
        }
    }

    public function CarouselSlides() {
        return $this
            ->owner
            ->renderWith(
                'ilateral\SilverStripe\Carousel\Includes\CarouselSlides',
                [
                    'Slides' => $this->owner->Slides(),
                    'Interval' => $this->owner->CarouselInterval ? $this->owner->CarouselInterval : 3000,
                    'ShowIndicators' => $this->owner->CarouselShowIndicators,
                    'ShowControls' => $this->owner->CarouselShowControls
                ]
            );
    }
}