EditableFileField::migrateSettings() - Code Metrics - Inspection of "Partial revert of #458" - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#463)

by Damian

created 2016-04-28 06:05 UTC

EditableFileField::migrateSettings() A

↳ Parent: EditableFileField

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	9
rs	9.6666
cc	2
eloc	5
nc	2
nop	1

<?php

/**
 * Allows a user to add a field that can be used to upload a file.
 *
 * @package userforms
 */

class EditableFileField extends EditableFormField {
namespace YourVendor;

class YourClass { }

	private static $singular_name = 'File Upload Field';


	private static $plural_names = 'File Fields';


	private static $has_one = array(

		'Folder' => 'Folder' // From CustomFields
	);

	/**
	 * Further limit uploadable file extensions in addition to the restrictions
	 * imposed by the File.allowed_extensions global configuration.
	 * @config
	 */
	private static $allowed_extensions_blacklist = array(

		'htm', 'html', 'xhtml', 'swf', 'xml'
	);

	/**
	 * @return FieldList
	 */
	public function getCMSFields() {
		$fields = parent::getCMSFields();

		$fields->addFieldToTab(
			'Root.Main',
			TreeDropdownField::create(
				'FolderID',
				_t('EditableUploadField.SELECTUPLOADFOLDER', 'Select upload folder'),
				'Folder'
			)
		);

		$fields->addFieldToTab("Root.Main", new LiteralField("FileUploadWarning",
				"<p class=\"message notice\">" . _t("UserDefinedForm.FileUploadWarning",
				"Files uploaded through this field could be publicly accessible if the exact URL is known")
				. "</p>"), "Type");

		return $fields;
	}

	public function getFormField() {
        $field = FileField::create($this->Name, $this->EscapedTitle)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
 			->setFieldHolderTemplate('UserFormsField_holder')
 			->setTemplate('UserFormsFileField');

		$field->setFieldHolderTemplate('UserFormsField_holder')
				->setTemplate('UserFormsFileField');

		$field->getValidator()->setAllowedExtensions(
			array_diff(
				// filter out '' since this would be a regex problem on JS end
				array_filter(Config::inst()->get('File', 'allowed_extensions')),
				$this->config()->allowed_extensions_blacklist
			)
		);

		$folder = $this->Folder();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		if($folder && $folder->exists()) {
			$field->setFolderName(
				preg_replace("/^assets\//","", $folder->Filename)
			);
		}

		$this->doUpdateFormField($field);

		return $field;
	}


	/**
	 * Return the value for the database, link to the file is stored as a
	 * relation so value for the field can be null.
	 *
	 * @return string
	 */
	public function getValueFromData() {
		return null;
	}

	public function getSubmittedFormField() {
		return new SubmittedFileField();
	}


	public function migrateSettings($data) {
		// Migrate 'Folder' setting to 'FolderID'
		if(isset($data['Folder'])) {
			$this->FolderID = $data['Folder'];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			unset($data['Folder']);
		}

		parent::migrateSettings($data);
	}
}


1			<?php
2
3			/**
4			* Allows a user to add a field that can be used to upload a file.
5			*
6			* @package userforms
7			*/
8
9			class EditableFileField extends EditableFormField {
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 07:02 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...
10
11			private static $singular_name = 'File Upload Field';
			0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 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 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$singular_name` 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...
12
13			private static $plural_names = 'File Fields';
			0 ignored issues – show Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$plural_names` 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...
14
15			private static $has_one = array(
			0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 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 2015-11-21 07:02 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...
16			'Folder' => 'Folder' // From CustomFields
17			);
18
19			/**
20			* Further limit uploadable file extensions in addition to the restrictions
21			* imposed by the File.allowed_extensions global configuration.
22			* @config
23			*/
24			private static $allowed_extensions_blacklist = array(
			0 ignored issues – show Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$allowed_extensions_blacklist` 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...
25			'htm', 'html', 'xhtml', 'swf', 'xml'
26			);
27
28			/**
29			* @return FieldList
30			*/
31			public function getCMSFields() {
32			$fields = parent::getCMSFields();
33
34			$fields->addFieldToTab(
35			'Root.Main',
36			TreeDropdownField::create(
37			'FolderID',
38			_t('EditableUploadField.SELECTUPLOADFOLDER', 'Select upload folder'),
39			'Folder'
40			)
41			);
42
43			$fields->addFieldToTab("Root.Main", new LiteralField("FileUploadWarning",
44			"<p class=\"message notice\">" . _t("UserDefinedForm.FileUploadWarning",
45			"Files uploaded through this field could be publicly accessible if the exact URL is known")
46			. "</p>"), "Type");
47
48			return $fields;
49			}
50
51			public function getFormField() {
52			$field = FileField::create($this->Name, $this->EscapedTitle)
			0 ignored issues – show Documentation introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `EscapedTitle` does not exist on `object<EditableFileField>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
53			->setFieldHolderTemplate('UserFormsField_holder')
54			->setTemplate('UserFormsFileField');
55
56			$field->setFieldHolderTemplate('UserFormsField_holder')
57			->setTemplate('UserFormsFileField');
58
59			$field->getValidator()->setAllowedExtensions(
60			array_diff(
61			// filter out '' since this would be a regex problem on JS end
62			array_filter(Config::inst()->get('File', 'allowed_extensions')),
63			$this->config()->allowed_extensions_blacklist
64			)
65			);
66
67			$folder = $this->Folder();
			0 ignored issues – show Documentation Bug introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The method `Folder` does not exist on `object<EditableFileField>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
68			if($folder && $folder->exists()) {
69			$field->setFolderName(
70			preg_replace("/^assets\//","", $folder->Filename)
71			);
72			}
73
74			$this->doUpdateFormField($field);
75
76			return $field;
77			}
78
79
80			/**
81			* Return the value for the database, link to the file is stored as a
82			* relation so value for the field can be null.
83			*
84			* @return string
85			*/
86			public function getValueFromData() {
87			return null;
88			}
89
90			public function getSubmittedFormField() {
91			return new SubmittedFileField();
92			}
93
94
95			public function migrateSettings($data) {
96			// Migrate 'Folder' setting to 'FolderID'
97			if(isset($data['Folder'])) {
98			$this->FolderID = $data['Folder'];
			0 ignored issues – show Documentation introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `FolderID` does not exist on `object<EditableFileField>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
99			unset($data['Folder']);
100			}
101
102			parent::migrateSettings($data);
103			}
104			}
105

silverstripe / silverstripe-userforms

Pull Request — master (#463)

EditableFileField::migrateSettings() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like