SiteConfigLeftAndMain::getEditForm() - Code Metrics - silverstripe/silverstripe-siteconfig - Measure and Improve Code Quality continuously with Scrutinizer

SiteConfigLeftAndMain::getEditForm() B
last analyzed 2017-09-28 16:40 UTC

↳ Parent: SiteConfigLeftAndMain

Complexity

Conditions	7
Paths	8

Size

Total Lines	65
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	65
rs	7.1439
cc	7
eloc	40
nc	8
nop	2

How to fix Long Method

<?php

namespace SilverStripe\SiteConfig;

use SilverStripe\Admin\LeftAndMain;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Director;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\HiddenField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\View\ArrayData;
use SilverStripe\View\Requirements;

class SiteConfigLeftAndMain extends LeftAndMain
{
    /**
     * @var string
     */
    private static $url_segment = 'settings';


    /**
     * @var string
     */
    private static $url_rule = '/$Action/$ID/$OtherID';


    /**
     * @var int
     */
    private static $menu_priority = -1;


    /**
     * @var string
     */
    private static $menu_title = 'Settings';


    /**
     * @var string
     */
    private static $menu_icon_class = 'font-icon-cog';


    /**
     * @var string
     */
    private static $tree_class = SiteConfig::class;


    /**
     * @var array
     */
    private static $required_permission_codes = array('EDIT_SITECONFIG');


    /**
     * Initialises the {@link SiteConfig} controller.
     */
    public function init()
    {
        parent::init();
        if (class_exists(SiteTree::class)) {
            Requirements::javascript('silverstripe/cms: client/dist/js/bundle.js');
        }
    }

    /**
     * @param null $id Not used.
     * @param null $fields Not used.
     *
     * @return Form
     */
    public function getEditForm($id = null, $fields = null)
    {
        $siteConfig = SiteConfig::current_site_config();
        $fields = $siteConfig->getCMSFields();

        // Tell the CMS what URL the preview should show
        $home = Director::absoluteBaseURL();
        $fields->push(new HiddenField('PreviewURL', 'Preview URL', $home));

        // Added in-line to the form, but plucked into different view by LeftAndMain.Preview.js upon load
        /** @skipUpgrade */
        $fields->push($navField = new LiteralField('SilverStripeNavigator', $this->getSilverStripeNavigator()));
        $navField->setAllowHTML(true);

        // Retrieve validator, if one has been setup (e.g. via data extensions).
        if ($siteConfig->hasMethod("getCMSValidator")) {
            $validator = $siteConfig->getCMSValidator();
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 { }
        } else {
            $validator = null;
        }

        $actions = $siteConfig->getCMSActions();
        $negotiator = $this->getResponseNegotiator();
        /** @var Form $form */
        $form = Form::create(
            $this,
            'EditForm',
            $fields,
            $actions,
            $validator
        )->setHTMLID('Form_EditForm');
        $form->setValidationResponseCallback(function (ValidationResult $errors) use ($negotiator, $form) {

            $request = $this->getRequest();
            if ($request->isAjax() && $negotiator) {
                $result = $form->forTemplate();
                return $negotiator->respond($request, array(
                    'CurrentForm' => function () use ($result) {
                        return $result;
                    }
                ));
            }
        });
        $form->addExtraClass('flexbox-area-grow fill-height cms-content cms-edit-form');
        $form->setAttribute('data-pjax-fragment', 'CurrentForm');

        if ($form->Fields()->hasTabSet()) {
            $form->Fields()->findOrMakeTab('Root')->setTemplate('SilverStripe\\Forms\\CMSTabSet');
        }
        $form->setHTMLID('Form_EditForm');
        $form->loadDataFrom($siteConfig);
        $form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));


        // Use <button> to allow full jQuery UI styling
        $actions = $actions->dataFields();
        if ($actions) {

            /** @var FormAction $action */
            foreach ($actions as $action) {
                $action->setUseButtonTag(true);
            }
        }

        $this->extend('updateEditForm', $form);

        return $form;
    }

    /**
     * Save the current sites {@link SiteConfig} into the database.
     *
     * @param array $data
     * @param Form $form
     * @return String
     */
    public function save_siteconfig($data, $form)

    {
        $data = $form->getData();
        $siteConfig = DataObject::get_one(SiteConfig::class, ['ID' => $data['ID']]);
        $form->saveInto($siteConfig);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $siteConfig->write();
        $this->response->addHeader('X-Status', rawurlencode(_t(LeftAndMain::class . '.SAVEDUP', 'Saved.')));
        return $form->forTemplate();
    }


    public function Breadcrumbs($unlinked = false)
    {
        return new ArrayList(array(
            new ArrayData(array(
                'Title' => static::menu_title(),
                'Link' => $this->Link()
            ))
        ));
    }
}


1			<?php
2
3			namespace SilverStripe\SiteConfig;
4
5			use SilverStripe\Admin\LeftAndMain;
6			use SilverStripe\CMS\Model\SiteTree;
7			use SilverStripe\Control\Director;
8			use SilverStripe\Forms\Form;
9			use SilverStripe\Forms\FormAction;
10			use SilverStripe\Forms\HiddenField;
11			use SilverStripe\Forms\LiteralField;
12			use SilverStripe\ORM\ArrayList;
13			use SilverStripe\ORM\DataObject;
14			use SilverStripe\ORM\ValidationResult;
15			use SilverStripe\View\ArrayData;
16			use SilverStripe\View\Requirements;
17
18			class SiteConfigLeftAndMain extends LeftAndMain
19			{
20			/**
21			* @var string
22			*/
23			private static $url_segment = 'settings';
			0 ignored issues – show Comprehensibility introduced 2016-03-22 20:01 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 2016-03-22 20:01 UTC by Report Bug Copy Issue Report The property `$url_segment` 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...
24
25			/**
26			* @var string
27			*/
28			private static $url_rule = '/$Action/$ID/$OtherID';
			0 ignored issues – show Comprehensibility introduced 2016-03-22 20:01 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 2016-03-22 20:01 UTC by Report Bug Copy Issue Report The property `$url_rule` 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...
29
30			/**
31			* @var int
32			*/
33			private static $menu_priority = -1;
			0 ignored issues – show Comprehensibility introduced 2016-03-22 20:01 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 2016-03-22 20:01 UTC by Report Bug Copy Issue Report The property `$menu_priority` 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...
34
35			/**
36			* @var string
37			*/
38			private static $menu_title = 'Settings';
			0 ignored issues – show Comprehensibility introduced 2016-03-22 20:01 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 2016-03-22 20:01 UTC by Report Bug Copy Issue Report The property `$menu_title` 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...
39
40			/**
41			* @var string
42			*/
43			private static $menu_icon_class = 'font-icon-cog';
			0 ignored issues – show Unused Code introduced 2017-02-26 22:26 UTC by Report Bug Copy Issue Report The property `$menu_icon_class` 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...
44
45			/**
46			* @var string
47			*/
48			private static $tree_class = SiteConfig::class;
			0 ignored issues – show Comprehensibility introduced 2017-09-28 16:40 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 2017-09-28 16:40 UTC by Report Bug Copy Issue Report The property `$tree_class` 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...
49
50			/**
51			* @var array
52			*/
53			private static $required_permission_codes = array('EDIT_SITECONFIG');
			0 ignored issues – show Comprehensibility introduced 2016-03-22 20:01 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 2016-03-22 20:01 UTC by Report Bug Copy Issue Report The property `$required_permission_codes` 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...
54
55			/**
56			* Initialises the {@link SiteConfig} controller.
57			*/
58			public function init()
59			{
60			parent::init();
61			if (class_exists(SiteTree::class)) {
62			Requirements::javascript('silverstripe/cms: client/dist/js/bundle.js');
63			}
64			}
65
66			/**
67			* @param null $id Not used.
68			* @param null $fields Not used.
69			*
70			* @return Form
71			*/
72			public function getEditForm($id = null, $fields = null)
73			{
74			$siteConfig = SiteConfig::current_site_config();
75			$fields = $siteConfig->getCMSFields();
76
77			// Tell the CMS what URL the preview should show
78			$home = Director::absoluteBaseURL();
79			$fields->push(new HiddenField('PreviewURL', 'Preview URL', $home));
80
81			// Added in-line to the form, but plucked into different view by LeftAndMain.Preview.js upon load
82			/** @skipUpgrade */
83			$fields->push($navField = new LiteralField('SilverStripeNavigator', $this->getSilverStripeNavigator()));
84			$navField->setAllowHTML(true);
85
86			// Retrieve validator, if one has been setup (e.g. via data extensions).
87			if ($siteConfig->hasMethod("getCMSValidator")) {
88			$validator = $siteConfig->getCMSValidator();
			0 ignored issues – show Documentation Bug introduced 2017-02-26 22:26 UTC by Report Bug Copy Issue Report The method `getCMSValidator` does not exist on `object<SilverStripe\SiteConfig\SiteConfig>`? 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...
89			} else {
90			$validator = null;
91			}
92
93			$actions = $siteConfig->getCMSActions();
94			$negotiator = $this->getResponseNegotiator();
95			/** @var Form $form */
96			$form = Form::create(
97			$this,
98			'EditForm',
99			$fields,
100			$actions,
101			$validator
102			)->setHTMLID('Form_EditForm');
103			$form->setValidationResponseCallback(function (ValidationResult $errors) use ($negotiator, $form) {
			0 ignored issues – show Unused Code introduced 2017-02-26 22:26 UTC by Report Bug Copy Issue Report The parameter `$errors` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
104			$request = $this->getRequest();
105			if ($request->isAjax() && $negotiator) {
106			$result = $form->forTemplate();
107			return $negotiator->respond($request, array(
108			'CurrentForm' => function () use ($result) {
109			return $result;
110			}
111			));
112			}
113			});
114			$form->addExtraClass('flexbox-area-grow fill-height cms-content cms-edit-form');
115			$form->setAttribute('data-pjax-fragment', 'CurrentForm');
116
117			if ($form->Fields()->hasTabSet()) {
118			$form->Fields()->findOrMakeTab('Root')->setTemplate('SilverStripe\\Forms\\CMSTabSet');
119			}
120			$form->setHTMLID('Form_EditForm');
121			$form->loadDataFrom($siteConfig);
122			$form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));
			0 ignored issues – show Bug introduced 2017-07-26 09:58 UTC by Report Bug Copy Issue Report It seems like `$this->getTemplatesWithSuffix('_EditForm')` targeting `SilverStripe\Admin\LeftA...etTemplatesWithSuffix()` can also be of type `array`; however, `SilverStripe\Forms\Form::setTemplate()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
123
124			// Use <button> to allow full jQuery UI styling
125			$actions = $actions->dataFields();
126			if ($actions) {
			0 ignored issues – show Bug Best Practice introduced 2017-02-26 22:26 UTC by Report Bug Copy Issue Report The expression `$actions` of type `SilverStripe\Forms\FormField[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
127			/** @var FormAction $action */
128			foreach ($actions as $action) {
129			$action->setUseButtonTag(true);
130			}
131			}
132
133			$this->extend('updateEditForm', $form);
134
135			return $form;
136			}
137
138			/**
139			* Save the current sites {@link SiteConfig} into the database.
140			*
141			* @param array $data
142			* @param Form $form
143			* @return String
144			*/
145			public function save_siteconfig($data, $form)
			0 ignored issues – show Unused Code introduced 2017-09-28 16:40 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
146			{
147			$data = $form->getData();
148			$siteConfig = DataObject::get_one(SiteConfig::class, ['ID' => $data['ID']]);
149			$form->saveInto($siteConfig);
			0 ignored issues – show Bug introduced 2017-09-28 16:40 UTC by Report Bug Copy Issue Report It seems like `$siteConfig` defined by `\SilverStripe\ORM\DataOb...y('ID' => $data['ID']))` on line `148` can be `null`; however, `SilverStripe\Forms\Form::saveInto()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
150			$siteConfig->write();
151			$this->response->addHeader('X-Status', rawurlencode(_t(LeftAndMain::class . '.SAVEDUP', 'Saved.')));
152			return $form->forTemplate();
153			}
154
155
156			public function Breadcrumbs($unlinked = false)
157			{
158			return new ArrayList(array(
159			new ArrayData(array(
160			'Title' => static::menu_title(),
161			'Link' => $this->Link()
162			))
163			));
164			}
165			}
166

silverstripe / silverstripe-siteconfig

SiteConfigLeftAndMain::getEditForm() B last analyzed 2017-09-28 16:40 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

SiteConfigLeftAndMain::getEditForm() B
last analyzed 2017-09-28 16:40 UTC