dynamic / silverstripe-flexslider

src/ORM/FlexSlider.php

<?php

namespace Dynamic\FlexSlider\ORM;

use Dynamic\FlexSlider\Model\SlideImage;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use SilverStripe\Forms\NumericField;
use SilverStripe\Forms\ToggleCompositeField;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\DataObject;
use SilverStripe\View\Requirements;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

/**
 * Class FlexSlider
 * @package Dynamic\FlexSlider\ORM
 * @property string $Animation
 * @property bool $Loop
 * @property bool $Animate
 * @property bool $ThumbnailNav
 * @property bool $SliderControlNav
 * @property bool $CarouselControlNav
 * @property bool $CarouselDirectionNav
 * @property int $CarouselThumbnailCt
 * @property double $FlexSliderSpeed
 *
 * @property-read DataObject|FlexSlider $owner
 */
class FlexSlider extends DataExtension
{
    use Configurable;

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

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

        'Animation' => "Enum('slide, fade', 'slide')",
        'Loop' => 'Boolean',
        'Animate' => 'Boolean',
        'ThumbnailNav' => 'Boolean',
        'SliderControlNav' => 'Boolean',
        'SliderDirectionNav' => 'Boolean',
        'CarouselControlNav' => 'Boolean',
        'CarouselDirectionNav' => 'Boolean',
        'CarouselThumbnailCt' => 'Int',
        'FlexSliderSpeed' => 'Double',
    ];

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

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

        'Slides' => SlideImage::class,
    ];

    /**
     *
     */
    public function populateDefaults()
    {
        $this->owner->Loop = 1;

The property $Loop was declared of type boolean, but 1 is of type integer. Maybe add a type cast?

        $this->owner->Animate = 1;

The property $Animate was declared of type boolean, but 1 is of type integer. Maybe add a type cast?

        $this->owner->SliderControlNav = 0;

The property $SliderControlNav was declared of type boolean, but 0 is of type integer. Maybe add a type cast?

        $this->owner->SliderDirectionNav = 1;

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

        $this->owner->CarouselControlNav = 0;

The property $CarouselControlNav was declared of type boolean, but 0 is of type integer. Maybe add a type cast?

        $this->owner->CarouselDirectionNav = 1;

The property $CarouselDirectionNav was declared of type boolean, but 1 is of type integer. Maybe add a type cast?

        $this->owner->CarouselThumbnailCt = 6;
        $this->owner->FlexSliderSpeed = $this->getDefaultSpeed();

        return parent::populateDefaults();

Are you sure the usage of parent::populateDefaults() targeting SilverStripe\ORM\DataExtension::populateDefaults() seems to always return null.

    }

    /**
     * @param FieldList $fields
     */
    public function updateCMSFields(FieldList $fields)
    {
        $fields->removeByName([
            'Animation',
            'Loop',
            'Animate',
            'ThumbnailNav',
            'SliderControlNav',
            'SliderDirectionNav',
            'CarouselControlNav',
            'CarouselDirectionNav',
            'CarouselThumbnailCt',
            'FlexSliderSpeed',
            'Slides',
        ]);

        // Slides
        if ($this->owner->ID) {

The property ID does not exist on Dynamic\FlexSlider\ORM\FlexSlider. Did you maybe forget to declare it?

            $config = GridFieldConfig_RecordEditor::create();
            $config->addComponent(new GridFieldOrderableRows('SortOrder'));
            $config->removeComponentsByType([
                GridFieldAddExistingAutocompleter::class,
                GridFieldDeleteAction::class,
            ]);
            $SlidesField = GridField::create(
                'Slides',
                _t(__CLASS__ . '.SLIDES', 'Slides'),
                $this->owner->Slides()->sort('SortOrder'),

The method Slides() does not exist on Dynamic\FlexSlider\ORM\FlexSlider. Did you maybe mean getSlideshowSpeed()?

                $config
            );

            $slideTitle = $this->owner->stat('slide_tab_title') ?: _t(__CLASS__ . '.SLIDES', 'Slides');

The function SilverStripe\View\ViewableData::stat() has been deprecated: 5.0 Use ->config()->get() instead

The function Dynamic\FlexSlider\ORM\FlexSlider::stat() has been deprecated: 5.0 Use ->config()->get() instead

            $animations = [];
            $animationOptions = $this->owner->dbObject('Animation')->getEnum();

The method dbObject() does not exist on Dynamic\FlexSlider\ORM\FlexSlider.

            foreach ($animationOptions as $value) {
                $animations[$value] = _t(__CLASS__ . ".$value", $value);
            }

            $fields->addFieldsToTab("Root.{$slideTitle}", [
                $SlidesField,
                ToggleCompositeField::create('ConfigHD', _t(__CLASS__ . '.SettingsLabel', 'Slider Settings'), [
                    DropdownField::create(
                        'Animation',
                        _t(__CLASS__ . '.ANIMATION_OPTION', 'Animation option'),
                        $animations
                    ),
                    CheckboxField::create(
                        'Animate',
                        _t(__CLASS__ . '.ANIMATE', 'Animate automatically')
                    ),
                    CheckboxField::create(
                        'Loop',
                        _t(__CLASS__ . '.LOOP', 'Loop the carousel')
                    ),
                    CheckboxField::create(
                        'SliderControlNav',
                        _t(__CLASS__ . '.CONTROL_NAV', 'Show ControlNav')
                    ),
                    CheckboxField::create(
                        'SliderDirectionNav',
                        _t(__CLASS__ . '.DIRECTION_NAV', 'Show DirectionNav')
                    ),
                    CheckboxField::create(
                        'ThumbnailNav',
                        _t(__CLASS__ . '.THUMBNAIL_NAV', 'Thumbnail Navigation')
                    ),
                    //DisplayLogicWrapper::create(
                    CheckboxField::create(
                        'CarouselControlNav',
                        _t(__CLASS__ . '.CAROUSEL_CONTROL_NAV', 'Show Carousel ControlNav')
                    ),
                    CheckboxField::create(
                        'CarouselDirectionNav',
                        _t(__CLASS__ . '.CAROUSEL_DIRECTION_NAV', 'Show Carousel DirectionNav')
                    ),
                    NumericField::create(
                        'CarouselThumbnailCt',
                        _t(__CLASS__ . '.CAROUSEL_THUMBNAIL_COUNT', 'Number of thumbnails')
                    ),
                    NumericField::create(
                        'FlexSliderSpeed',
                        _t(__CLASS__ . '.SLIDER_SPEED', 'Slider Speed')
                    )
                        ->setDescription('In Seconds')
                        ->setScale(2),
                ]),
            ]);
        }
    }

    /**
     * @return mixed
     */
    public function getSlideShow()
    {
        $owner = $this->owner;

        if (!($owner instanceof SiteTree)) {
            $this->getCustomScript();
        }

        return $this->owner->Slides()->sort('SortOrder');
    }

    /**
     * add requirements to PageController init()
     */
    public function contentcontrollerInit()
    {
        // only call custom script if page has Slides and DataExtension
        if (DataObject::has_extension($this->owner->Classname, FlexSlider::class)) {

The property Classname does not exist on Dynamic\FlexSlider\ORM\FlexSlider. Did you maybe forget to declare it?

            if ($this->owner->getSlideShow()->exists()) {
                $this->getCustomScript();
            }
        }
    }

    /**
     *
     */
    public function getCustomScript()
    {
        // Flexslider options
        $sync = ($this->owner->ThumbnailNav == true) ? "sync: '.fs-carousel:eq('+index+')'," : '';

        $before = $this->owner->hasMethod('flexSliderBeforeAction')

The method hasMethod() does not exist on Dynamic\FlexSlider\ORM\FlexSlider.

            ? $this->owner->flexSliderBeforeAction()

The method flexSliderBeforeAction() does not exist on Dynamic\FlexSlider\ORM\FlexSlider.

            : 'function(){}';

        $after = $this->owner->hasMethod('flexSliderAfterAction')
            ? $this->owner->flexSliderAfterAction()

The method flexSliderAfterAction() does not exist on Dynamic\FlexSlider\ORM\FlexSlider.

            : 'function(){}';

        $speed = $this->getSlideshowSpeed();

        Requirements::customScript(
            "(function($) {
                $(document).ready(function(){
                    jQuery('.flexslider').each(function(index){
					 
                         if(jQuery('.fs-carousel').eq(index).length) {
                             jQuery('.fs-carousel').eq(index).flexslider({
                                slideshow: " . $this->owner->obj('Animate')->NiceAsBoolean() . ",

The method obj() does not exist on Dynamic\FlexSlider\ORM\FlexSlider.

                                animation: 'slide',
                                animationLoop: " . $this->owner->obj('Loop')->NiceAsBoolean() . ",
                                controlNav: " . $this->owner->obj('CarouselControlNav')->NiceAsBoolean() . ", 
                                directionNav: " . $this->owner->obj('CarouselDirectionNav')->NiceAsBoolean() . ",
                                prevText: '',
                                nextText: '',
                                pausePlay: false,
                                asNavFor: '.flexslider:eq('+index+')',
                                minItems: " . $this->owner->obj('CarouselThumbnailCt') . ",

Are you sure $this->owner->obj('CarouselThumbnailCt') of type SilverStripe\ORM\FieldType\DBField|object can be used in concatenation?

                                maxItems: " . $this->owner->obj('CarouselThumbnailCt') . ",
                                move: " . $this->owner->obj('CarouselThumbnailCt') . ",
                                itemWidth: 100,
                                itemMargin: 10
                              });
                         }
 
                        if(jQuery('.flexslider').eq(index).length){
                            jQuery('.flexslider').eq(index).flexslider({
                                slideshow: " . $this->owner->obj('Animate')->NiceAsBoolean() . ",
                                animation: '" . $this->owner->Animation . "',
                                animationLoop: " . $this->owner->obj('Loop')->NiceAsBoolean() . ",
                                controlNav: " . $this->owner->obj('SliderControlNav')->NiceAsBoolean() . ",
                                directionNav: " . $this->owner->obj('SliderDirectionNav')->NiceAsBoolean() . ",
                                prevText: '',
                                nextText: '',
                                pauseOnAction: true,
                                pauseOnHover: true,
                                " . $sync . "
                                start: function(slider){
                                  $('body').removeClass('loading');
                                },
                                before: " . $before . ',
                                after: ' . $after . ',
                                slideshowSpeed: ' . $speed . ' 
                            });
                        }
                    })
                });
            }(jQuery));'
        );
    }

    /**
     * @return int
     */
    public function getSlideshowSpeed()
    {
        $speed = $this->owner->FlexSliderSpeed > 0
            ? $this->owner->FlexSliderSpeed
            : $this->getDefaultSpeed();

        return $speed * 1000;
    }

    /**
     * @return mixed
     */
    protected function getDefaultSpeed()
    {
        return $this->owner->config()->get('flex_slider_speed')
            ?: Config::inst()->get(FlexSlider::class, 'flex_slider_speed');
    }

    /**
     *
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();

        if (!$this->owner->CarouselThumbnailCt) {
            $this->owner->CarouselThumbnailCt = 6;
        }
    }
}