VideoSliderItem

Complexity

Total Complexity

22

Size/Duplication

Total Lines	228
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	11

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	singular_name()	0	3	1
A	plural_name()	0	3	1
A	getSliderTypes()	0	9	2
A	getCMSFields()	0	61	1
A	fieldLabels()	0	14	1
A	getVideoId()	0	9	3
C	getEmbedLink()	0	22	8
B	validate()	0	21	5

<?php

/**
 * @author    Donatas Navidonskis <donatas@navidonskis.com>
 * @since     2017
 * @class     VideoSliderItem
 *
 * @property int     Mp4ID
 * @property int     WebMID
 * @property int     OggID
 * @property string  Type
 * @property string  URL
 * @property boolean AutoPlay
 *
 * @method File Mp4
 * @method File WebM
 * @method File Ogg
 *
 * @TODO      implement https://github.com/xemle/html5-video-php package to convert webm and ogg videos when saving.
 */
class VideoSliderItem extends BaseSliderItem {

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.

        'Type'     => 'Enum(array("Youtube", "Vimeo", "File"), "File")',
        'URL'      => 'Varchar(128)',
        'AutoPlay' => 'Boolean(true)',
    ];

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

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

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

        'Mp4'  => 'File',
        'WebM' => 'File',
        'Ogg'  => 'File',
    ];

    /**
     * Set providers default embed link. The key value should
     * be equal within Type field value.
     * {VideoId} - will be replaced with actual video id
     * {AutoPlay} - will be replaced within key of AutoPlay if AutoPlay field is true.
     *
     * @var array
     * @config
     */
    private static $embed_links = [

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

        "Youtube" => [
            "Link"     => "https://www.youtube.com/embed/{VideoId}{AutoPlay}",
            "AutoPlay" => "?autoplay=1",
        ],
        "Vimeo"   => [
            "Link"     => "https://player.vimeo.com/video/{VideoId}{AutoPlay}",
            "AutoPlay" => "?autoplay=1",
        ],
        // Set your own providers options
    ];

    /**
     * @return string
     */
    public function singular_name() {
        return _t('VideoSliderItem.SINGULARNAME', 'Video slider');
    }

    /**
     * @return string
     */
    public function plural_name() {
        return _t('VideoSliderItem.PLURALNAME', 'Video sliders');
    }

    /**
     * @return array
     */
    public function getSliderTypes() {
        $types = [];

        foreach ($this->dbObject('Type')->enumValues() as $type) {
            $types[$type] = $this->fieldLabel($type);
        }

        return $types;
    }

    /**
     * @return \FieldList
     */
    public function getCMSFields() {
        $fields = parent::getCMSFields();
        $fields->removeByName(['Type', 'Mp4', 'WebM', 'Ogg', 'URL', 'AutoPlay']);
        $fields->findOrMakeTab('Root.Media', $this->fieldLabel('Media'));

        $fields->addFieldsToTab('Root.Media', [
            DropdownField::create('AutoPlay', $this->fieldLabel('TurnOnAutoPlayMode'), BlocksUtility::localized_answers()),
            $videoType = OptionsetField::create('Type', $this->fieldLabel('Type'), $this->getSliderTypes(), 'File'),
            $uploadFieldContainer = DisplayLogicWrapper::create(
                $mp4UploadField = UploadField::create('Mp4', $this->fieldLabel('VideoMp4')),
                $webMUploadField = UploadField::create('WebM', $this->fieldLabel('VideoWebM')),
                $oggUploadField = UploadField::create('Ogg', $this->fieldLabel('VideoOgg'))
            ),
            $urlAddressField = TextField::create('URL', $this->fieldLabel('URLAddress'))->setRightTitle(
                $this->fieldLabel('SetVideoURLAddress')
            ),
        ]);

        $mp4UploadField
            ->setAllowedMaxFileNumber(1)
            ->setAllowedExtensions('mp4')

'mp4' is of type string, but the function expects a array.

            ->setRightTitle(
                _t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [

array('extensions' => '.mp4') is of type array<string,string,{"extensions":"string"}>, but the function expects a string.

                    'extensions' => '.mp4',
                ])
            )
            ->setFolderName(
                sprintf('%s/Video-Sliders', BaseBlock::config()->upload_directory)
            );

        $webMUploadField
            ->setAllowedMaxFileNumber(1)
            ->setAllowedExtensions('webm')

'webm' is of type string, but the function expects a array.

            ->setRightTitle(
                _t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [

array('extensions' => '.webm') is of type array<string,string,{"extensions":"string"}>, but the function expects a string.

                    'extensions' => '.webm',
                ])
            )
            ->setFolderName(
                sprintf('%s/Video-Sliders', BaseBlock::config()->upload_directory)
            );

        $oggUploadField
            ->setAllowedMaxFileNumber(1)
            ->setAllowedExtensions('ogg')

'ogg' is of type string, but the function expects a array.

            ->setRightTitle(
                _t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [

array('extensions' => '.ogg') is of type array<string,string,{"extensions":"string"}>, but the function expects a string.

                    'extensions' => '.ogg',
                ])
            )
            ->setFolderName(
                sprintf('%s/Video-Sliders', BaseBlock::config()->upload_directory)
            );

        $uploadFieldContainer->displayIf('Type')->isEqualTo('File');
        $urlAddressField->displayIf('Type')->isNotEqualTo('File');

        $this->extend('updateCMSFields', $fields);

        return $fields;
    }

    /**
     * @param bool $includeRelations
     *
     * @return array
     */
    public function fieldLabels($includeRelations = true) {
        return array_merge(parent::fieldLabels($includeRelations), [
            'Type'               => _t('VideoSliderItem.TYPE', 'Type'),
            'Youtube'            => _t('VideoSliderItem.YOUTUBE', 'Youtube'),
            'Vimeo'              => _t('VideoSliderItem.VIMEO', 'Vimeo'),
            'File'               => _t('VideoSliderItem.FILE', 'File'),
            'URLAddress'         => _t('VideoSliderItem.URL_ADDRESS', 'URL address'),
            'SetVideoURLAddress' => _t('VideoSliderItem.SET_VIDEO_URL_ADDRESS', 'Set video URL address'),
            'VideoMp4'           => _t('SliderItem.VIDEO_MP4', 'Video Mp4'),
            'VideoWebM'          => _t('SliderItem.VIDEO_WEBM', 'Video WebM'),
            'VideoOgg'           => _t('SliderItem.VIDEO_OGG', 'Video Ogg'),
            'TurnOnAutoPlayMode' => _t('SliderItem.TURN_ON_AUTO_PLAY_MODE', 'Turn on auto play mode?'),
        ]);
    }

    /**
     * This will get an id of the URL address or false
     * if can't parsed, object type not one of supported
     * providers or just empty url address field.
     *
     * @return bool|string
     * @throws ProviderNotFound
     */
    public function getVideoId() {
        if (! empty($this->URL) && $this->Type != 'File') {
            $videoId = BlocksUtility::parse_video_id($this->URL, $this->Type);

            return $videoId;
        }

        return false;
    }

    /**
     * Get embed link by the set of Type field. Method depends by
     * static::$embed_links property.
     *
     * @return bool|string
     */
    public function getEmbedLink() {
        if (! empty($this->URL) && $this->Type != 'File') {
            try {
                $videoId = BlocksUtility::parse_video_id($this->URL, $this->Type);
            } catch (ProviderNotFound $ex) {
                return false;
            }

            if ($videoId && array_key_exists($this->Type, ($options = static::config()->embed_links))) {
                $options = $options[$this->Type];
                $autoPlay = array_key_exists("AutoPlay", $options) && ! empty($options["AutoPlay"]) ? $options["AutoPlay"] : '';

                return str_replace(
                    ['{VideoId}', '{AutoPlay}'],
                    [$videoId, $autoPlay],
                    $options["Link"]
                );
            }
        }

        return false;
    }

    /**
     * @return \ValidationResult
     */
    protected function validate() {
        $validation = parent::validate();

        if (! empty($this->URL) && $this->Type != 'File') {
            try {
                $result = $this->getVideoId();
            } catch (ProviderNotFound $ex) {
                $validation->error($ex->getMessage());

                return $validation;
            }

            // if we can't parse url address, return an error with bad url address or
            // the type is not of the url address providers.
            if (! $result) {

The expression $result of type string|false is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === false instead.

                $validation->error(_t('VideoSliderItem.INVALID_URL_ADDRESS_OR_THE_TYPE', 'Invalid URL address or the type'));
            }
        }

        return $validation;
    }

}