UserFormAddNewClassesList

Complexity

Total Complexity

24

Size/Duplication

Total Lines	237
Duplicated Lines	10.13 %

Coupling/Cohesion

Components	1
Dependencies	7

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	getHTMLFragments()	0	32	3
A	getButtonClass()	0	3	1
A	setButtonClass()	0	4	1
A	setButtonName()	0	4	1
A	getButtonName()	0	3	1
A	getFragment()	0	3	1
A	setFragment()	0	4	1
A	handleAdd()	16	16	2
A	getDefaultClass()	0	3	1
A	setDefaultClass()	0	4	1
A	getActions()	0	5	1
A	getAction()	0	3	1
A	handleAction()	8	8	2
A	getFieldClasses()	0	3	1
B	getSelectedClass()	0	14	5

<?php

/**
 * A dropdown and button which allows objects to be created that was selected from the dropdown
 */
class UserFormAddNewClassesList extends Object implements GridField_HTMLProvider, GridField_ActionProvider {

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

	/**
	 * Name of fragment to insert into
	 *
	 * @var string
	 */
	protected $targetFragment;

	/**
	 * Button title
	 *
	 * @var string
	 */
	protected $buttonName;

	/**
	 * Additonal CSS classes for the button
	 *
	 * @var string
	 */
	protected $buttonClass = null;

	/**
	 * default value for the dropdown
	 */
	protected $defaultClass;

	/**
	 * @param array $default Class to be selected by default.
	 * @param string $targetFragment The fragment to render the button into
	 */
	public function __construct($default = null, $targetFragment = 'buttons-before-left') {
		$this->setFragment($targetFragment);
		$this->setDefaultClass($default);

$default is of type array|null, but the function expects a string.

	}

	/**
	 * {@inheritDoc}
	 */
	public function getHTMLFragments($grid) {
		$classes = $this->getFieldClasses();

		if(!count($classes)) {
			return array();
		}

		$field = new DropdownField(sprintf('%s[ClassName]', __CLASS__), '', $classes, $this->defaultClass);
		$field->addExtraClass('no-change-track');

		$formAction = new GridField_FormAction(
			$grid,
			$this->getAction(),
			$this->getButtonName(),
			$this->getAction(),
			array()
		);
		$formAction->setAttribute('data-icon', 'add');

		if($buttonClass = $this->getButtonClass()) {
			$formAction->addExtraClass($buttonClass);
		}

		$data = new ArrayData(array(
			'FormAction' => $formAction,
			'ClassField' => $field
		));

		return array(
			$this->getFragment() => $data->renderWith('UserFormAddNewClassesList')
		);
	}

	/**
	 * Get extra button class
	 *
	 * @return string
	 */
	public function getButtonClass() {
		return $this->buttonClass;
	}

	/**
	 * Sets extra CSS classes for this button
	 *
	 * @param string $buttonClass
	 * @return $this
	 */
	public function setButtonClass($buttonClass) {
		$this->buttonClass = $buttonClass;
		return $this;
	}

	/**
	 * Change the button name
	 *
	 * @param string $name
	 * @return $this
	 */
	public function setButtonName($name) {
		$this->buttonName = $name;
		return $this;
	}

	/**
	 * Get the button name
	 *
	 * @return string
	 */
	public function getButtonName() {
		return $this->buttonName;
	}

	/**
	 * Gets the fragment name this button is rendered into.
	 *
	 * @return string
	 */
	public function getFragment() {
		return $this->targetFragment;
	}

	/**
	 * Sets the fragment name this button is rendered into.
	 *
	 * @param string $fragment
	 * @return GridFieldAddNewInlineButton $this
	 */
	public function setFragment($fragment) {
		$this->targetFragment = $fragment;
		return $this;
	}

	/**
	 * Handles adding a new instance of a selected class.
	 *
	 * @param GridField $grid
	 * @param Array $data from request
	 * @return null
	 */
	public function handleAdd($grid, $data) {

This method seems to be duplicated in your project.

		$class = $this->getSelectedClass($data);

		if(!$class) {
			throw new SS_HTTPResponse_Exception(400);
		}

		// Add item to gridfield
		$list = $grid->getList();
		$item = $class::create();
		$item->write();
		$list->add($item);

		// Should trigger a simple reload
		return null;
	}

	/**
	 * Gets the default class that is selected automatically.
	 *
	 * @return string
	 */
	public function getDefaultClass() {
		return $this->defaultClass;
	}

	/**
	 * Sets the default class that is selected automatically.
	 *
	 * @param string $default the class name to use as default
	 * @return UserFormAddNewClassesList $this
	 */
	public function setDefaultClass($default) {
		$this->defaultClass = $default;
		return $this;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getActions($gridField) {
		return array(
			$this->getAction()
		);
	}

	/**
	 * Get the action suburl for this component
	 *
	 * @return string
	 */
	protected function getAction() {
		return 'add-classes-list';
	}

	/**
	 * {@inheritDoc}
	 */
	public function handleAction(GridField $gridField, $actionName, $arguments, $data) {

This method seems to be duplicated in your project.

		switch(strtolower($actionName)) {
			case $this->getAction():
				return $this->handleAdd($gridField, $data);
			default:
				return null;
		}
	}

	/**
	 * Get the list of classes that can be selected and created
	 *
	 * @return array
	 */
	public function getFieldClasses() {
		return singleton('EditableFormField')->getEditableFieldClasses();
	}

	/**
	 * Gets the selected value from the request data array
	 *
	 * @param array $data from request
	 * @return string|null;

The doc-type string|null; could not be parsed: Expected "|" or "end of type", but got ";" at position 11. (view supported doc-types)

	 */
	public function getSelectedClass($data = null) {
		$classes = $this->getFieldClasses();

		$class = null;
		if(is_array($data) && isset($data[__CLASS__]['ClassName'])) {
			$class = $data[__CLASS__]['ClassName'];
		}

		if($class && !array_key_exists($class, $classes)) {
			throw new SS_HTTPResponse_Exception(400);
		}

		return $class;
	}
}