EditableFileField

Complexity

Total Complexity

10

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	19	1
B	getFormField()	0	29	5
A	getValueFromData()	0	3	1
A	getSubmittedFormField()	0	3	1
A	migrateSettings()	0	9	2

<?php

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

class EditableFileField extends EditableFormField {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

	private static $singular_name = 'File Upload Field';

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

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

	private static $plural_names = 'File Fields';

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

	private static $has_one = array(

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.

		'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(

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

		'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() {
		if(isset(Config::inst()->get('EditableFileField', 'use_uploadfield')) && Config::inst()->get('EditableFileField', 'use_uploadfield')) {
			$field = Upload::create($this->Name, $this->EscapedTitle);

The property EscapedTitle does not exist on object<EditableFileField>. Since you implemented __get, maybe consider adding a @property annotation.

The expression \Upload::create($this->Name, $this->EscapedTitle); of type Upload adds the type Upload to the return on line 78 which is incompatible with the return type of the parent method EditableFormField::getFormField of type FormField|null.

		} else {
			$field = FileField::create($this->Name, $this->EscapedTitle);

The property EscapedTitle does not exist on object<EditableFileField>. Since you implemented __get, maybe consider adding a @property annotation.

		}
	
		$field->setFieldHolderTemplate('UserFormsField_holder')

The method setFieldHolderTemplate does only exist in FileField, but not in Upload.

				->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();

The method Folder does not exist on object<EditableFileField>? Since you implemented __call, maybe consider adding a @method annotation.

		if($folder && $folder->exists()) {
			$field->setFolderName(

The method setFolderName does only exist in FileField, but not in Upload.

				preg_replace("/^assets\//","", $folder->Filename)
			);
		}

		$this->doUpdateFormField($field);

It seems like $field defined by \Upload::create($this->Name, $this->EscapedTitle) on line 53 can also be of type object<Upload>; however, EditableFormField::doUpdateFormField() does only seem to accept object<FormField>, maybe add an additional type check?

		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'];

The property FolderID does not exist on object<EditableFileField>. Since you implemented __set, maybe consider adding a @property annotation.

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

		parent::migrateSettings($data);
	}
}