silverstripe / silverstripe-siteconfig

code/SiteConfigLeftAndMain.php

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The method getCMSValidator does not exist on object<SilverStripe\SiteConfig\SiteConfig>? Since you implemented __call, maybe consider adding a @method annotation.

        } 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) {

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

            $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'));

It seems like $this->getTemplatesWithSuffix('_EditForm') targeting SilverStripe\Admin\LeftAndMain::getTemplatesWithSuffix() can also be of type array; however, SilverStripe\Forms\Form::setTemplate() does only seem to accept string, maybe add an additional type check?

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

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.

            /** @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)

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

    {
        $data = $form->getData();
        $siteConfig = DataObject::get_one(SiteConfig::class, ['ID' => $data['ID']]);
        $form->saveInto($siteConfig);

It seems like $siteConfig defined by \SilverStripe\ORM\DataObject::get_one(\SilverStripe\SiteConfig\SiteConfig::class, array('ID' => $data['ID'])) on line 148 can be null; however, SilverStripe\Forms\Form::saveInto() does not accept null, maybe add an additional type check?

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