SilverStripe\CMS\Controllers\CMSPageAddController

Complexity

Total Complexity

19

Size/Duplication

Total Lines	194
Duplicated Lines	6.19 %

Coupling/Cohesion

Components	1
Dependencies	20

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	AddForm()	12	126	6
D	doAdd()	0	40	12
A	doCancel()	0	3	1

<?php

namespace SilverStripe\CMS\Controllers;

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Session;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\OptionsetField;
use SilverStripe\Forms\SelectionGroup;
use SilverStripe\Forms\SelectionGroup_Item;
use SilverStripe\Forms\TreeDropdownField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\ValidationException;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\Member;
use SilverStripe\Security\Security;

class CMSPageAddController extends CMSPageEditController {

	private static $url_segment = 'pages/add';

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

	private static $url_rule = '/$Action/$ID/$OtherID';

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

	private static $url_priority = 42;

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

	private static $menu_title = 'Add page';

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

	private static $required_permission_codes = 'CMS_ACCESS_CMSMain';

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

	private static $allowed_actions = array(

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

		'AddForm',
		'doAdd',
		'doCancel'
	);

	/**
	 * @return Form
	 */
	public function AddForm() {
		$pageTypes = array();
		foreach($this->PageTypes() as $type) {
			$html = sprintf('<span class="page-icon class-%s"></span><span class="title">%s</span><span class="form__field-description">%s</span>',
				$type->getField('ClassName'),
				$type->getField('AddAction'),
				$type->getField('Description')
			);
			$pageTypes[$type->getField('ClassName')] = DBField::create_field('HTMLFragment', $html);
		}
		// Ensure generic page type shows on top
		if(isset($pageTypes['Page'])) {
			$pageTitle = $pageTypes['Page'];
			$pageTypes = array_merge(array('Page' => $pageTitle), $pageTypes);
		}

		$numericLabelTmpl = '<span class="step-label"><span class="flyout">Step %d. </span><span class="title">%s</span></span>';

		$topTitle = _t('CMSPageAddController.ParentMode_top', 'Top level');
		$childTitle = _t('CMSPageAddController.ParentMode_child', 'Under another page');

		$fields = new FieldList(
			$parentModeField = new SelectionGroup(
				"ParentModeField",
				array(
					new SelectionGroup_Item(
						"top",
						null,
						$topTitle
					),
					new SelectionGroup_Item(
						'child',
						$parentField = new TreeDropdownField(
							"ParentID",
							"",
							'SilverStripe\\CMS\\Model\\SiteTree',
							'ID',
							'TreeTitle'
						),
						$childTitle
					)
				)
			),
			new LiteralField(
				'RestrictedNote',
				sprintf(
					'<p class="message notice message-restricted">%s</p>',
					_t(
						'CMSMain.AddPageRestriction',
						'Note: Some page types are not allowed for this selection'
					)
				)
			),
			$typeField = new OptionsetField(
				"PageType",
				DBField::create_field(
					'HTMLFragment',
					sprintf($numericLabelTmpl, 2, _t('CMSMain.ChoosePageType', 'Choose page type'))
				),
				$pageTypes,
				'Page'
			)
		);

		$parentModeField->setTitle(DBField::create_field(
			'HTMLFragment',
			sprintf($numericLabelTmpl, 1, _t('CMSMain.ChoosePageParentMode', 'Choose where to create this page'))
		));

		$parentField->setSearchFunction(function ($sourceObject, $labelField, $search) {
			return DataObject::get($sourceObject)
				->filterAny([
					'MenuTitle:PartialMatch' => $search,
					'Title:PartialMatch' => $search,
				]);
		});

		// TODO Re-enable search once it allows for HTML title display,
		// see http://open.silverstripe.org/ticket/7455
		// $parentField->setShowSearch(true);

		$parentModeField->addExtraClass('parent-mode');

		// CMSMain->currentPageID() automatically sets the homepage,
		// which we need to counteract in the default selection (which should default to root, ID=0)
		if($parentID = $this->getRequest()->getVar('ParentID')) {
			$parentModeField->setValue('child');
			$parentField->setValue((int)$parentID);
		} else {
			$parentModeField->setValue('top');
		}

		$actions = new FieldList(
			FormAction::create("doAdd", _t('CMSMain.Create',"Create"))
				->addExtraClass('ss-ui-action-constructive')->setAttribute('data-icon', 'accept')
				->setUseButtonTag(true),
			FormAction::create("doCancel", _t('CMSMain.Cancel',"Cancel"))
				->addExtraClass('ss-ui-action-destructive ss-ui-action-cancel')
				->setUseButtonTag(true)
		);

		$this->extend('updatePageOptions', $fields);

		$negotiator = $this->getResponseNegotiator();
		$form = Form::create(
			$this, "AddForm", $fields, $actions
		)->setHTMLID('Form_AddForm');
		$form->setAttribute('data-hints', $this->SiteTreeHints());
		$form->setAttribute('data-childfilter', $this->Link('childfilter'));
		$form->setValidationResponseCallback(function(ValidationResult $errors) use ($negotiator, $form) {

The parameter $errors is not used and could be removed.

This code seems to be duplicated across your project.

			$request = $this->getRequest();
			if($request->isAjax() && $negotiator) {
				$result = $form->forTemplate();
				return $negotiator->respond($request, array(
					'CurrentForm' => function() use($result) {
						return $result;
					}
				));
			}
			return null;
		});
		$form->addExtraClass('flexbox-area-grow fill-height cms-add-form cms-content cms-edit-form ' . $this->BaseCSSClasses());
		$form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));

		return $form;
	}

	/**
	 * @param array $data
	 * @param Form $form
	 * @return HTTPResponse
	 */
	public function doAdd($data, $form) {
		$className = isset($data['PageType']) ? $data['PageType'] : "Page";
		$parentID = isset($data['ParentID']) ? (int)$data['ParentID'] : 0;

		$suffix = isset($data['Suffix']) ? "-" . $data['Suffix'] : null;

		if(!$parentID && isset($data['Parent'])) {
			$page = SiteTree::get_by_link($data['Parent']);
			if($page) $parentID = $page->ID;
		}

		if(is_numeric($parentID) && $parentID > 0) {
			$parentObj = SiteTree::get()->byID($parentID);
		} else {
			$parentObj = null;
		}

		if(!$parentObj || !$parentObj->ID) {
			$parentID = 0;
		}

		if(!singleton($className)->canCreate(Member::currentUser(), array('Parent' => $parentObj))) {
			return Security::permissionFailure($this);
		}

		$record = $this->getNewItem("new-$className-$parentID".$suffix, false);
		$this->extend('updateDoAdd', $record, $form);
		$record->write();

		$editController = CMSPageEditController::singleton();
		$editController->setCurrentPageID($record->ID);

		Session::set(
			"FormInfo.Form_EditForm.formError.message",
			_t('CMSMain.PageAdded', 'Successfully created page')
		);
		Session::set("FormInfo.Form_EditForm.formError.type", 'good');

		return $this->redirect(Controller::join_links($editController->Link('show'), $record->ID));

The expression $this->redirect(\SilverStripe\Control\Controller::join_links($editController->Link('show'), $record->ID)); of type string|null adds the type string to the return on line 211 which is incompatible with the return type documented by SilverStripe\CMS\Controllers\CMSPageAddController::doAdd of type SilverStripe\Control\HTTPResponse|null.

	}

	public function doCancel($data, $form) {

The parameter $data is not used and could be removed.

The parameter $form is not used and could be removed.

		return $this->redirect(CMSMain::singleton()->Link());
	}
}