VideoSliderItem::singular_name() - Code Metrics - Inspection of "adding slider block" - Pixelneat/silverstripe-content-blocks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (003c26)

by Pixelneat

created 2017-05-04 14:05 UTC

VideoSliderItem::singular_name() A

↳ Parent: VideoSliderItem

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * @author    Donatas Navidonskis <[email protected]>
 * @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 {
namespace YourVendor;

class YourClass { }

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

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

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

        '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 = [

        "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')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->setRightTitle(
                _t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    'extensions' => '.mp4',
                ])
            )
            ->setFolderName(
                sprintf('%s/Video-Sliders', BaseBlock::config()->upload_directory)
            );

        $webMUploadField
            ->setAllowedMaxFileNumber(1)
            ->setAllowedExtensions('webm')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->setRightTitle(
                _t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    'extensions' => '.webm',
                ])
            )
            ->setFolderName(
                sprintf('%s/Video-Sliders', BaseBlock::config()->upload_directory)
            );

        $oggUploadField
            ->setAllowedMaxFileNumber(1)
            ->setAllowedExtensions('ogg')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->setRightTitle(
                _t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    '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) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $validation->error(_t('VideoSliderItem.INVALID_URL_ADDRESS_OR_THE_TYPE', 'Invalid URL address or the type'));
            }
        }

        return $validation;
    }

}

1			<?php
2
3			/**
4			* @author Donatas Navidonskis <[email protected]>
5			* @since 2017
6			* @class VideoSliderItem
7			*
8			* @property int Mp4ID
9			* @property int WebMID
10			* @property int OggID
11			* @property string Type
12			* @property string URL
13			* @property boolean AutoPlay
14			*
15			* @method File Mp4
16			* @method File WebM
17			* @method File Ogg
18			*
19			* @TODO implement https://github.com/xemle/html5-video-php package to convert webm and ogg videos when saving.
20			*/
21			class VideoSliderItem extends BaseSliderItem {
			0 ignored issues – show Coding Style Compatibility introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
22
23			/**
24			* @var array
25			* @config
26			*/
27			private static $db = [
			0 ignored issues – show Comprehensibility introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
28			'Type' => 'Enum(array("Youtube", "Vimeo", "File"), "File")',
29			'URL' => 'Varchar(128)',
30			'AutoPlay' => 'Boolean(true)',
31			];
32
33			/**
34			* @var array
35			* @config
36			*/
37			private static $has_one = [
			0 ignored issues – show Comprehensibility introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report The property `$has_one` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
38			'Mp4' => 'File',
39			'WebM' => 'File',
40			'Ogg' => 'File',
41			];
42
43			/**
44			* Set providers default embed link. The key value should
45			* be equal within Type field value.
46			* {VideoId} - will be replaced with actual video id
47			* {AutoPlay} - will be replaced within key of AutoPlay if AutoPlay field is true.
48			*
49			* @var array
50			* @config
51			*/
52			private static $embed_links = [
			0 ignored issues – show Unused Code introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report The property `$embed_links` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
53			"Youtube" => [
54			"Link" => "https://www.youtube.com/embed/{VideoId}{AutoPlay}",
55			"AutoPlay" => "?autoplay=1",
56			],
57			"Vimeo" => [
58			"Link" => "https://player.vimeo.com/video/{VideoId}{AutoPlay}",
59			"AutoPlay" => "?autoplay=1",
60			],
61			// Set your own providers options
62			];
63
64			/**
65			* @return string
66			*/
67			public function singular_name() {
68			return _t('VideoSliderItem.SINGULARNAME', 'Video slider');
69			}
70
71			/**
72			* @return string
73			*/
74			public function plural_name() {
75			return _t('VideoSliderItem.PLURALNAME', 'Video sliders');
76			}
77
78			/**
79			* @return array
80			*/
81			public function getSliderTypes() {
82			$types = [];
83
84			foreach ($this->dbObject('Type')->enumValues() as $type) {
85			$types[$type] = $this->fieldLabel($type);
86			}
87
88			return $types;
89			}
90
91			/**
92			* @return \FieldList
93			*/
94			public function getCMSFields() {
95			$fields = parent::getCMSFields();
96			$fields->removeByName(['Type', 'Mp4', 'WebM', 'Ogg', 'URL', 'AutoPlay']);
97			$fields->findOrMakeTab('Root.Media', $this->fieldLabel('Media'));
98
99			$fields->addFieldsToTab('Root.Media', [
100			DropdownField::create('AutoPlay', $this->fieldLabel('TurnOnAutoPlayMode'), BlocksUtility::localized_answers()),
101			$videoType = OptionsetField::create('Type', $this->fieldLabel('Type'), $this->getSliderTypes(), 'File'),
102			$uploadFieldContainer = DisplayLogicWrapper::create(
103			$mp4UploadField = UploadField::create('Mp4', $this->fieldLabel('VideoMp4')),
104			$webMUploadField = UploadField::create('WebM', $this->fieldLabel('VideoWebM')),
105			$oggUploadField = UploadField::create('Ogg', $this->fieldLabel('VideoOgg'))
106			),
107			$urlAddressField = TextField::create('URL', $this->fieldLabel('URLAddress'))->setRightTitle(
108			$this->fieldLabel('SetVideoURLAddress')
109			),
110			]);
111
112			$mp4UploadField
113			->setAllowedMaxFileNumber(1)
114			->setAllowedExtensions('mp4')
			0 ignored issues – show Documentation introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report `'mp4'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
115			->setRightTitle(
116			_t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [
			0 ignored issues – show Documentation introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report `array('extensions' => '.mp4')` is of type `array<string,string,{"extensions":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
117			'extensions' => '.mp4',
118			])
119			)
120			->setFolderName(
121			sprintf('%s/Video-Sliders', BaseBlock::config()->upload_directory)
122			);
123
124			$webMUploadField
125			->setAllowedMaxFileNumber(1)
126			->setAllowedExtensions('webm')
			0 ignored issues – show Documentation introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report `'webm'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
127			->setRightTitle(
128			_t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [
			0 ignored issues – show Documentation introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report `array('extensions' => '.webm')` is of type `array<string,string,{"extensions":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
129			'extensions' => '.webm',
130			])
131			)
132			->setFolderName(
133			sprintf('%s/Video-Sliders', BaseBlock::config()->upload_directory)
134			);
135
136			$oggUploadField
137			->setAllowedMaxFileNumber(1)
138			->setAllowedExtensions('ogg')
			0 ignored issues – show Documentation introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report `'ogg'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
139			->setRightTitle(
140			_t('VideoSliderItem.ALLOWED_FILE_EXTENSIONS', 'Allowed file extensions: {extensions}', [
			0 ignored issues – show Documentation introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report `array('extensions' => '.ogg')` is of type `array<string,string,{"extensions":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
141			'extensions' => '.ogg',
142			])
143			)
144			->setFolderName(
145			sprintf('%s/Video-Sliders', BaseBlock::config()->upload_directory)
146			);
147
148			$uploadFieldContainer->displayIf('Type')->isEqualTo('File');
149			$urlAddressField->displayIf('Type')->isNotEqualTo('File');
150
151			$this->extend('updateCMSFields', $fields);
152
153			return $fields;
154			}
155
156			/**
157			* @param bool $includeRelations
158			*
159			* @return array
160			*/
161			public function fieldLabels($includeRelations = true) {
162			return array_merge(parent::fieldLabels($includeRelations), [
163			'Type' => _t('VideoSliderItem.TYPE', 'Type'),
164			'Youtube' => _t('VideoSliderItem.YOUTUBE', 'Youtube'),
165			'Vimeo' => _t('VideoSliderItem.VIMEO', 'Vimeo'),
166			'File' => _t('VideoSliderItem.FILE', 'File'),
167			'URLAddress' => _t('VideoSliderItem.URL_ADDRESS', 'URL address'),
168			'SetVideoURLAddress' => _t('VideoSliderItem.SET_VIDEO_URL_ADDRESS', 'Set video URL address'),
169			'VideoMp4' => _t('SliderItem.VIDEO_MP4', 'Video Mp4'),
170			'VideoWebM' => _t('SliderItem.VIDEO_WEBM', 'Video WebM'),
171			'VideoOgg' => _t('SliderItem.VIDEO_OGG', 'Video Ogg'),
172			'TurnOnAutoPlayMode' => _t('SliderItem.TURN_ON_AUTO_PLAY_MODE', 'Turn on auto play mode?'),
173			]);
174			}
175
176			/**
177			* This will get an id of the URL address or false
178			* if can't parsed, object type not one of supported
179			* providers or just empty url address field.
180			*
181			* @return bool\|string
182			* @throws ProviderNotFound
183			*/
184			public function getVideoId() {
185			if (! empty($this->URL) && $this->Type != 'File') {
186			$videoId = BlocksUtility::parse_video_id($this->URL, $this->Type);
187
188			return $videoId;
189			}
190
191			return false;
192			}
193
194			/**
195			* Get embed link by the set of Type field. Method depends by
196			* static::$embed_links property.
197			*
198			* @return bool\|string
199			*/
200			public function getEmbedLink() {
201			if (! empty($this->URL) && $this->Type != 'File') {
202			try {
203			$videoId = BlocksUtility::parse_video_id($this->URL, $this->Type);
204			} catch (ProviderNotFound $ex) {
205			return false;
206			}
207
208			if ($videoId && array_key_exists($this->Type, ($options = static::config()->embed_links))) {
209			$options = $options[$this->Type];
210			$autoPlay = array_key_exists("AutoPlay", $options) && ! empty($options["AutoPlay"]) ? $options["AutoPlay"] : '';
211
212			return str_replace(
213			['{VideoId}', '{AutoPlay}'],
214			[$videoId, $autoPlay],
215			$options["Link"]
216			);
217			}
218			}
219
220			return false;
221			}
222
223			/**
224			* @return \ValidationResult
225			*/
226			protected function validate() {
227			$validation = parent::validate();
228
229			if (! empty($this->URL) && $this->Type != 'File') {
230			try {
231			$result = $this->getVideoId();
232			} catch (ProviderNotFound $ex) {
233			$validation->error($ex->getMessage());
234
235			return $validation;
236			}
237
238			// if we can't parse url address, return an error with bad url address or
239			// the type is not of the url address providers.
240			if (! $result) {
			0 ignored issues – show Bug Best Practice introduced 2017-05-04 14:07 UTC by Report Bug Copy Issue Report 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. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
241			$validation->error(_t('VideoSliderItem.INVALID_URL_ADDRESS_OR_THE_TYPE', 'Invalid URL address or the type'));
242			}
243			}
244
245			return $validation;
246			}
247
248			}

Pixelneat / silverstripe-content-blocks

Branch — master (003c26)

VideoSliderItem::singular_name() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like