FileField::setIsMultiUpload() - Code Metrics - Inspection of "API Implement react FileField" - silverstripe/silverstripe-asset-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#312)

by Damian

created 2016-11-23 22:19 UTC

FileField::setIsMultiUpload() A

↳ Parent: FileField

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace SilverStripe\AssetAdmin\Forms;

use SilverStripe\AssetAdmin\Controller\AssetAdmin;
use SilverStripe\Assets\Folder;
use SilverStripe\Forms\FileUploadable;
use SilverStripe\Forms\FormField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\SS_List;

/**
 * Represents a file upload field with ReactJS based frontend.
 *
 * Allows writing to a parent record with the following relation types:
 *   - has_one
 *   - has_many
 *   - many_many
 *
 * Additionally supports writing directly to the File table not attached
 * to any parent record.
 */
class FileField extends FormField
{
    use FileUploadable;

    /**
     * @config
     * @var int
     */
    private static $thumbnail_width = 60;


    /**
     * @config
     * @var int
     */
    private static $thumbnail_height = 60;


    protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_CUSTOM;

    protected $schemaComponent = 'FileField';

    /**
     * @var bool|null
     */
    protected $multiUpload = null;

	/**
	 * Create a new file field.
	 *
	 * @param string $name The internal field name, passed to forms.
	 * @param string $title The field label.
	 * @param SS_List $items Items assigned to this field
	 */
	public function __construct($name, $title = null, SS_List $items = null) {
		$this->constructFileUploadable();
		parent::__construct($name, $title);
		if($items) {
			$this->setItems($items);
		}
	}

	public function getSchemaDataDefaults()
    {
        $defaults = parent::getSchemaDataDefaults();
        $uploadLink = AssetAdmin::singleton()->Link('api/createFile');
        $defaults['data']['createFileEndpoint'] = [
            'url' => $uploadLink,
            'method' => 'post',
            'payloadFormat' => 'urlencoded',
        ];
        $defaults['data']['multi'] = $this->getIsMultiUpload();
        $defaults['data']['parentid'] = $this->getFolderID();
        return $defaults;
    }

    /**
     * Get ID of target parent folder
     *
     * @return int
     */
    protected function getFolderID() {
        $folderName = $this->getFolderName();
        if (!$folderName) {
            return 0;
        }
        $folder = Folder::find_or_make($folderName);
        return $folder ? $folder->ID : 0;
    }

    public function getSchemaStateDefaults()
    {
        $state = parent::getSchemaStateDefaults();
        $state['data']['files'] = $this->getEncodedItems();
        return $state;
    }

    /**
     * Encode selected values for react
     *
     * @return array
     */
    protected function getEncodedItems()
    {
        $assetAdmin = AssetAdmin::singleton();
        $fileData = [];
        foreach ($this->getItems() as $file) {
            $fileData[] = $assetAdmin->getObjectFromData($file);
        }
        return $fileData;
    }

    /**
     * Check if allowed to upload more than one file
     *
     * @return bool
     */
    public function getIsMultiUpload() {
        if (isset($this->multiUpload)) {
            return $this->multiUpload;
        }
        // Guess from record
        $record = $this->getRecord();
        $name = $this->getName();


        // Disabled for has_one components
        if ($record && DataObject::getSchema()->hasOneComponent(get_class($record), $name)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return false;
        }
        return true;
    }

    /**
     * Set upload type to multi / single
     * @param $multi
     */
    public function setIsMultiUpload($multi) {
        $this->multiUpload = $multi;
    }
}


1			<?php
2
3			namespace SilverStripe\AssetAdmin\Forms;
4
5			use SilverStripe\AssetAdmin\Controller\AssetAdmin;
6			use SilverStripe\Assets\Folder;
7			use SilverStripe\Forms\FileUploadable;
8			use SilverStripe\Forms\FormField;
9			use SilverStripe\ORM\DataObject;
10			use SilverStripe\ORM\SS_List;
11
12			/**
13			* Represents a file upload field with ReactJS based frontend.
14			*
15			* Allows writing to a parent record with the following relation types:
16			* - has_one
17			* - has_many
18			* - many_many
19			*
20			* Additionally supports writing directly to the File table not attached
21			* to any parent record.
22			*/
23			class FileField extends FormField
24			{
25			use FileUploadable;
26
27			/**
28			* @config
29			* @var int
30			*/
31			private static $thumbnail_width = 60;
			0 ignored issues – show Unused Code introduced 2016-11-22 04:11 UTC by Report Bug Copy Issue Report The property `$thumbnail_width` 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...
32
33			/**
34			* @config
35			* @var int
36			*/
37			private static $thumbnail_height = 60;
			0 ignored issues – show Unused Code introduced 2016-11-22 04:11 UTC by Report Bug Copy Issue Report The property `$thumbnail_height` 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
39			protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_CUSTOM;
40
41			protected $schemaComponent = 'FileField';
42
43			/**
44			* @var bool\|null
45			*/
46			protected $multiUpload = null;
47
48			/**
49			* Create a new file field.
50			*
51			* @param string $name The internal field name, passed to forms.
52			* @param string $title The field label.
53			* @param SS_List $items Items assigned to this field
54			*/
55			public function __construct($name, $title = null, SS_List $items = null) {
56			$this->constructFileUploadable();
57			parent::__construct($name, $title);
58			if($items) {
59			$this->setItems($items);
60			}
61			}
62
63			public function getSchemaDataDefaults()
64			{
65			$defaults = parent::getSchemaDataDefaults();
66			$uploadLink = AssetAdmin::singleton()->Link('api/createFile');
67			$defaults['data']['createFileEndpoint'] = [
68			'url' => $uploadLink,
69			'method' => 'post',
70			'payloadFormat' => 'urlencoded',
71			];
72			$defaults['data']['multi'] = $this->getIsMultiUpload();
73			$defaults['data']['parentid'] = $this->getFolderID();
74			return $defaults;
75			}
76
77			/**
78			* Get ID of target parent folder
79			*
80			* @return int
81			*/
82			protected function getFolderID() {
83			$folderName = $this->getFolderName();
84			if (!$folderName) {
85			return 0;
86			}
87			$folder = Folder::find_or_make($folderName);
88			return $folder ? $folder->ID : 0;
89			}
90
91			public function getSchemaStateDefaults()
92			{
93			$state = parent::getSchemaStateDefaults();
94			$state['data']['files'] = $this->getEncodedItems();
95			return $state;
96			}
97
98			/**
99			* Encode selected values for react
100			*
101			* @return array
102			*/
103			protected function getEncodedItems()
104			{
105			$assetAdmin = AssetAdmin::singleton();
106			$fileData = [];
107			foreach ($this->getItems() as $file) {
108			$fileData[] = $assetAdmin->getObjectFromData($file);
109			}
110			return $fileData;
111			}
112
113			/**
114			* Check if allowed to upload more than one file
115			*
116			* @return bool
117			*/
118			public function getIsMultiUpload() {
119			if (isset($this->multiUpload)) {
120			return $this->multiUpload;
121			}
122			// Guess from record
123			$record = $this->getRecord();
124			$name = $this->getName();
			0 ignored issues – show Bug introduced 2016-11-22 04:11 UTC by Report Bug Copy Issue Report Consider using `$this->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
125
126			// Disabled for has_one components
127			if ($record && DataObject::getSchema()->hasOneComponent(get_class($record), $name)) {
			0 ignored issues – show Bug Best Practice introduced 2016-11-22 04:11 UTC by Report Bug Copy Issue Report The expression `\SilverStripe\ORM\DataOb..._class($record), $name)` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` 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...
128			return false;
129			}
130			return true;
131			}
132
133			/**
134			* Set upload type to multi / single
135			* @param $multi
136			*/
137			public function setIsMultiUpload($multi) {
138			$this->multiUpload = $multi;
139			}
140			}
141

silverstripe / silverstripe-asset-admin

Pull Request — master (#312)

FileField::setIsMultiUpload() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like