UploadField::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-29 02:40 UTC

UploadField::setIsMultiUpload() A

↳ Parent: UploadField

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php

namespace SilverStripe\AssetAdmin\Forms;

use SilverStripe\AssetAdmin\Controller\AssetAdmin;
use SilverStripe\Assets\Folder;
use SilverStripe\Forms\FileUploadReceiver;
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 UploadField extends FormField
{
    use FileUploadReceiver;

    /**
     * @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 = 'UploadField';

    /**
     * @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->constructFileUploadReceiver();
        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
     * @return $this
     */
    public function setIsMultiUpload($multi)
    {
        $this->multiUpload = $multi;
        return $this;
    }
}


1			<?php
2
3			namespace SilverStripe\AssetAdmin\Forms;
4
5			use SilverStripe\AssetAdmin\Controller\AssetAdmin;
6			use SilverStripe\Assets\Folder;
7			use SilverStripe\Forms\FileUploadReceiver;
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 UploadField extends FormField
24			{
25			use FileUploadReceiver;
26
27			/**
28			* @config
29			* @var int
30			*/
31			private static $thumbnail_width = 60;
			0 ignored issues – show Unused Code introduced 2016-11-29 02:42 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-29 02:42 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 = 'UploadField';
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			{
57			$this->constructFileUploadReceiver();
58			parent::__construct($name, $title);
59			if($items) {
60			$this->setItems($items);
61			}
62			}
63
64			public function getSchemaDataDefaults()
65			{
66			$defaults = parent::getSchemaDataDefaults();
67			$uploadLink = AssetAdmin::singleton()->Link('api/createFile');
68			$defaults['data']['createFileEndpoint'] = [
69			'url' => $uploadLink,
70			'method' => 'post',
71			'payloadFormat' => 'urlencoded',
72			];
73			$defaults['data']['multi'] = $this->getIsMultiUpload();
74			$defaults['data']['parentid'] = $this->getFolderID();
75			return $defaults;
76			}
77
78			/**
79			* Get ID of target parent folder
80			*
81			* @return int
82			*/
83			protected function getFolderID()
84			{
85			$folderName = $this->getFolderName();
86			if (!$folderName) {
87			return 0;
88			}
89			$folder = Folder::find_or_make($folderName);
90			return $folder ? $folder->ID : 0;
91			}
92
93			public function getSchemaStateDefaults()
94			{
95			$state = parent::getSchemaStateDefaults();
96			$state['data']['files'] = $this->getEncodedItems();
97			return $state;
98			}
99
100			/**
101			* Encode selected values for react
102			*
103			* @return array
104			*/
105			protected function getEncodedItems()
106			{
107			$assetAdmin = AssetAdmin::singleton();
108			$fileData = [];
109			foreach ($this->getItems() as $file) {
110			$fileData[] = $assetAdmin->getObjectFromData($file);
111			}
112			return $fileData;
113			}
114
115			/**
116			* Check if allowed to upload more than one file
117			*
118			* @return bool
119			*/
120			public function getIsMultiUpload()
121			{
122			if (isset($this->multiUpload)) {
123			return $this->multiUpload;
124			}
125			// Guess from record
126			$record = $this->getRecord();
127			$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...
128
129			// Disabled for has_one components
130			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...
131			return false;
132			}
133			return true;
134			}
135
136			/**
137			* Set upload type to multi / single
138			*
139			* @param $multi
140			* @return $this
141			*/
142			public function setIsMultiUpload($multi)
143			{
144			$this->multiUpload = $multi;
145			return $this;
146			}
147			}
148

silverstripe / silverstripe-asset-admin

Pull Request — master (#312)

UploadField::setIsMultiUpload() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like