UserForm::setupFormErrors() - Code Metrics - Inspection of "API Use core validation for form submission" - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#409)

by Damian

created 2016-03-01 00:46 UTC

UserForm::setupFormErrors() A

↳ Parent: UserForm

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

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

<?php

/**
 * @package userforms
 */
class UserForm extends Form {
namespace YourVendor;

class YourClass { }

	/**
	 * @param Controller $controller
	 * @param string $name
	 */
	public function __construct(Controller $controller, $name = 'Form') {

		$this->controller = $controller;
		$this->setRedirectToFormOnValidationError(true);

		parent::__construct(
			$controller,
			$name,
			new FieldList(),
			new FieldList()
		);

		$this->setFields($this->getFormFields());
		$this->setActions($this->getFormActions());
		$this->setValidator($this->getRequiredFields());

		// This needs to be re-evaluated since fields have been assigned
		$this->setupFormErrors();

		// Number each page
		$stepNumber = 1;
		foreach($this->getSteps() as $step) {
			$step->setStepNumber($stepNumber++);
		}

		if($controller->DisableCsrfSecurityToken) {
			$this->disableSecurityToken();
		}

		$data = Session::get("FormInfo.{$this->FormName()}.data");

		if(is_array($data)) {
			$this->loadDataFrom($data);
		}

		$this->extend('updateForm');
	}

	public function setupFormErrors()
	{
		// Suppress setupFormErrors if fields haven't been bootstrapped
		if($this->fields && $this->fields->exists()) {
			return parent::setupFormErrors();
		}

		return $this;
	}

	/**
	 * Used for partial caching in the template.
	 *
	 * @return string
	 */
	public function getLastEdited() {
		return $this->controller->LastEdited;
	}

	/**
	 * @return bool
	 */
	public function getDisplayErrorMessagesAtTop() {
		return (bool)$this->controller->DisplayErrorMessagesAtTop;
	}

	/**
	 * Return the fieldlist, filtered to only contain steps
	 *
	 * @return ArrayList
	 */
	public function getSteps() {
		return $this->Fields()->filterByCallback(function($field) {
			return $field instanceof UserFormsStepField;
		});
	}

	/**
	 * Get the form fields for the form on this page. Can modify this FieldSet
	 * by using {@link updateFormFields()} on an {@link Extension} subclass which
	 * is applied to this controller.
	 *
	 * This will be a list of top level composite steps
	 *
	 * @return FieldList
	 */
	public function getFormFields() {
		$fields = new UserFormsFieldList();
		$target = $fields;
		foreach ($this->controller->Fields() as $field) {
			$target = $target->processNext($field);
		}
		$fields->clearEmptySteps();
		$this->extend('updateFormFields', $fields);
		$fields->setForm($this);
		return $fields;
	}

	/**
	 * Generate the form actions for the UserDefinedForm. You
	 * can manipulate these by using {@link updateFormActions()} on
	 * a decorator.
	 *
	 * @todo Make form actions editable via their own field editor.
	 *
	 * @return FieldList
	 */
	public function getFormActions() {
		$submitText = ($this->controller->SubmitButtonText) ? $this->controller->SubmitButtonText : _t('UserDefinedForm.SUBMITBUTTON', 'Submit');
		$clearText = ($this->controller->ClearButtonText) ? $this->controller->ClearButtonText : _t('UserDefinedForm.CLEARBUTTON', 'Clear');

		$actions = new FieldList(
			new FormAction("process", $submitText)
		);

		if($this->controller->ShowClearButton) {
			$actions->push(new ResetFormAction("clearForm", $clearText));
		}

		$this->extend('updateFormActions', $actions);
		$actions->setForm($this);
		return $actions;
	}

	/**
	 * Get the required form fields for this form.
	 *
	 * @return RequiredFields
	 */
	public function getRequiredFields() {
		// Generate required field validator
		$requiredNames = $this
			->getController()
			->Fields()
			->filter('Required', true)
			->column('Name');
		$required = new RequiredFields($requiredNames);
		$this->extend('updateRequiredFields', $required);
		$required->setForm($this);
		return $required;
	}

	/**
	 * Override some we can add UserForm specific attributes to the form.
	 *
	 * @return array
	 */
	public function getAttributes() {
		$attrs = parent::getAttributes();

		$attrs['class'] = $attrs['class'] . ' userform';
		$attrs['data-livevalidation'] = (bool)$this->controller->EnableLiveValidation;
		$attrs['data-toperrors'] = (bool)$this->controller->DisplayErrorMessagesAtTop;
		$attrs['data-hidefieldlabels'] = (bool)$this->controller->HideFieldLabels;

		return $attrs;
	}
}


1			<?php
2
3			/**
4			* @package userforms
5			*/
6			class UserForm extends Form {
			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...
7
8			/**
9			* @param Controller $controller
10			* @param string $name
11			*/
12			public function __construct(Controller $controller, $name = 'Form') {
13
14			$this->controller = $controller;
15			$this->setRedirectToFormOnValidationError(true);
16
17			parent::__construct(
18			$controller,
19			$name,
20			new FieldList(),
21			new FieldList()
22			);
23
24			$this->setFields($this->getFormFields());
25			$this->setActions($this->getFormActions());
26			$this->setValidator($this->getRequiredFields());
27
28			// This needs to be re-evaluated since fields have been assigned
29			$this->setupFormErrors();
30
31			// Number each page
32			$stepNumber = 1;
33			foreach($this->getSteps() as $step) {
34			$step->setStepNumber($stepNumber++);
35			}
36
37			if($controller->DisableCsrfSecurityToken) {
38			$this->disableSecurityToken();
39			}
40
41			$data = Session::get("FormInfo.{$this->FormName()}.data");
42
43			if(is_array($data)) {
44			$this->loadDataFrom($data);
45			}
46
47			$this->extend('updateForm');
48			}
49
50			public function setupFormErrors()
51			{
52			// Suppress setupFormErrors if fields haven't been bootstrapped
53			if($this->fields && $this->fields->exists()) {
54			return parent::setupFormErrors();
55			}
56
57			return $this;
58			}
59
60			/**
61			* Used for partial caching in the template.
62			*
63			* @return string
64			*/
65			public function getLastEdited() {
66			return $this->controller->LastEdited;
67			}
68
69			/**
70			* @return bool
71			*/
72			public function getDisplayErrorMessagesAtTop() {
73			return (bool)$this->controller->DisplayErrorMessagesAtTop;
74			}
75
76			/**
77			* Return the fieldlist, filtered to only contain steps
78			*
79			* @return ArrayList
80			*/
81			public function getSteps() {
82			return $this->Fields()->filterByCallback(function($field) {
83			return $field instanceof UserFormsStepField;
84			});
85			}
86
87			/**
88			* Get the form fields for the form on this page. Can modify this FieldSet
89			* by using {@link updateFormFields()} on an {@link Extension} subclass which
90			* is applied to this controller.
91			*
92			* This will be a list of top level composite steps
93			*
94			* @return FieldList
95			*/
96			public function getFormFields() {
97			$fields = new UserFormsFieldList();
98			$target = $fields;
99			foreach ($this->controller->Fields() as $field) {
100			$target = $target->processNext($field);
101			}
102			$fields->clearEmptySteps();
103			$this->extend('updateFormFields', $fields);
104			$fields->setForm($this);
105			return $fields;
106			}
107
108			/**
109			* Generate the form actions for the UserDefinedForm. You
110			* can manipulate these by using {@link updateFormActions()} on
111			* a decorator.
112			*
113			* @todo Make form actions editable via their own field editor.
114			*
115			* @return FieldList
116			*/
117			public function getFormActions() {
118			$submitText = ($this->controller->SubmitButtonText) ? $this->controller->SubmitButtonText : _t('UserDefinedForm.SUBMITBUTTON', 'Submit');
119			$clearText = ($this->controller->ClearButtonText) ? $this->controller->ClearButtonText : _t('UserDefinedForm.CLEARBUTTON', 'Clear');
120
121			$actions = new FieldList(
122			new FormAction("process", $submitText)
123			);
124
125			if($this->controller->ShowClearButton) {
126			$actions->push(new ResetFormAction("clearForm", $clearText));
127			}
128
129			$this->extend('updateFormActions', $actions);
130			$actions->setForm($this);
131			return $actions;
132			}
133
134			/**
135			* Get the required form fields for this form.
136			*
137			* @return RequiredFields
138			*/
139			public function getRequiredFields() {
140			// Generate required field validator
141			$requiredNames = $this
142			->getController()
143			->Fields()
144			->filter('Required', true)
145			->column('Name');
146			$required = new RequiredFields($requiredNames);
147			$this->extend('updateRequiredFields', $required);
148			$required->setForm($this);
149			return $required;
150			}
151
152			/**
153			* Override some we can add UserForm specific attributes to the form.
154			*
155			* @return array
156			*/
157			public function getAttributes() {
158			$attrs = parent::getAttributes();
159
160			$attrs['class'] = $attrs['class'] . ' userform';
161			$attrs['data-livevalidation'] = (bool)$this->controller->EnableLiveValidation;
162			$attrs['data-toperrors'] = (bool)$this->controller->DisplayErrorMessagesAtTop;
163			$attrs['data-hidefieldlabels'] = (bool)$this->controller->HideFieldLabels;
164
165			return $attrs;
166			}
167			}
168

silverstripe / silverstripe-userforms

Pull Request — master (#409)

UserForm::setupFormErrors() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like