SliderBlock

Complexity

Total Complexity

12

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	20

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	singular_name()	0	3	1
A	plural_name()	0	3	1
A	getCMSFields()	0	22	2
B	createSliderGridField()	0	31	4
A	getSliderClasses()	0	9	2
A	getSliderOptions()	0	7	2

<?php

/**
 * @author    Donatas Navidonskis <donatas@navidonskis.com>
 * @since     2017
 * @class     SliderBlock
 *
 * @property int     SlideSpeed
 * @property boolean EnableMouseEvents
 * @property boolean Infinite
 *
 * @method DataList Sliders
 */
class SliderBlock extends BaseBlock {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

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

Consider using a different property name as you override a private property of the parent class.

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

        'SlideSpeed'        => 'Int(600)',
        'EnableMouseEvents' => 'Boolean(true)',
        'Infinite'          => 'Boolean(true)',
    ];

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

Consider using a different property name as you override a private property of the parent class.

        'Sliders' => 'BaseSliderItem',
    ];

    /**
     * When slider is rendering, load javascript module for the slider.
     *
     * @var bool
     * @config
     */
    private static $load_slider_script = true;

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

Consider using a different property name as you override a private property of the parent class.

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

        'SlideSpeed'        => 600,
        'EnableMouseEvents' => true,
        'Infinite'          => true,
    ];

    /**
     * @return string
     */
    public function singular_name() {
        return _t('SliderBlock.SINGULARNAME', 'Slider Block');
    }

    /**
     * @return string
     */
    public function plural_name() {
        return _t('SliderBlock.PLURALNAME', 'Slider Blocks');
    }

    /**
     * @return \FieldList
     */
    public function getCMSFields() {
        $fields = parent::getCMSFields();
        $fields->removeByName(['Content', 'SlideSpeed', 'EnableMouseEvents', 'Infinite']);
        $fields->findOrMakeTab('Root.Sliders', _t('SliderItem.PLURALNAME', 'Sliders'));

        if ($this->ID) {
            $sliderField = $this->createSliderGridField();
        } else {
            $label = _t('SliderBlock.PLEASE_SAVE_BEFORE_ADD_SLIDERS', 'Please save block before add sliders');
            $sliderField = LiteralField::create("PleaseSaveBeforeAddSliders", "<p class=\"message notice\">{$label}</p>");
        }

        $fields->addFieldsToTab('Root.Main', [
            TextField::create('SlideSpeed', _t('SliderBlock.SLIDE_SPEED', 'Slide speed (ms)')),
            DropdownField::create('EnableMouseEvents', _t('SliderBlock.ENABLE_MOUSE_EVENTS', 'Enable mouse events?'), BlocksUtility::localized_answers()),
            DropdownField::create('Infinite', _t('SliderBlock.INFINITE', 'Infinite?'), BlocksUtility::localized_answers()),
        ]);

        $fields->addFieldToTab('Root.Sliders', $sliderField);

        return $fields;
    }

    /**
     * @return GridField
     */
    protected function createSliderGridField() {
        $config = GridFieldConfig::create()->addComponents(
            new GridFieldToolbarHeader(),
            new GridFieldSortableHeader(),
            new GridFieldDataColumns(),
            new GridFieldPaginator(20),
            new GridFieldDetailForm()
        );

        if ($this->ID) {
            $config->addComponent(new GridFieldOrderableRows('SortOrder'));
        }

        if ($this->canEdit()) {
            $multiClass = new GridFieldAddNewMultiClass();
            $multiClass->setClasses($this->getSliderClasses());

            $config->addComponents(
                $multiClass,
                new GridFieldEditButton()
            );
        }

        if ($this->canDelete()) {
            $config->addComponent(new GridFieldDeleteAction());
        }

        $sliders = new GridField('Sliders', null, $this->Sliders(), $config);

The method Sliders does not exist on object<SliderBlock>? Since you implemented __call, maybe consider adding a @method annotation.

        return $sliders;
    }

    /**
     * Get slider types which are sub classes for BaseSliderItem
     *
     * @return array
     */
    public function getSliderClasses() {
        $classes = ArrayLib::valuekey(ClassInfo::subclassesFor('BaseSliderItem'));
        array_shift($classes);
        foreach ($classes as $k => $v) {
            $classes[$k] = singleton($k)->singular_name();
        }

        return $classes;
    }

    /**
     * @return array|string
     */
    public function getSliderOptions() {
        return \Convert::raw2att(\Convert::array2json([
            'slideSpeed'        => ! empty($this->SlideSpeed) ? (int) $this->SlideSpeed : 300,
            'enableMouseEvents' => (bool) $this->EnableMouseEvents,
            'infinite'          => (int) $this->Infinite,
        ]));
    }
}

class SliderBlock_Controller extends Block_Controller {

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

    public function init() {
        if (SliderBlock::config()->load_slider_script) {

This if statement is empty and can be removed.

//            Requirements::javascript("//cdnjs.cloudflare.com/ajax/libs/lory.js/2.2.0/lory.min.js");

53% of this comment could be valid code. Did you maybe forget this after debugging?

//            Requirements::javascript(CONTENT_BLOCKS_DIR."/assets/javascript/universal-slider.js");
        }

        parent::init();
    }

}