lekoala / silverstripe-admini

src/SiteConfigLeftAndMain.php

<?php

namespace LeKoala\Admini;

use SilverStripe\Forms\Form;
use LeKoala\Admini\LeftAndMain;
use LeKoala\Admini\MaterialIcons;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\View\ArrayData;
use SilverStripe\Control\Director;
use SilverStripe\Forms\FormAction;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\Versioned\RecursivePublishable;

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;

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

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

    /**
     * @var string
     */
    private static $menu_icon = MaterialIcons::SETTINGS;

The private property $menu_icon is not used, and could be removed.

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

    /**
     * @param null $id Not used.

Are you sure the doc-type for parameter $id is correct as it would always require null to be passed?

     * @param null $fields Not used.

Are you sure the doc-type for parameter $fields is correct as it would always require null to be passed?

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

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

        $actions = $siteConfig->getCMSActions();
        $saveAction = $actions->fieldByName("action_save_siteconfig");

Are you sure the assignment to $saveAction is correct as $actions->fieldByName('action_save_siteconfig') targeting SilverStripe\Forms\FieldList::fieldByName() seems to always return null.

        if ($saveAction) {

$saveAction is of type null, thus it always evaluated to false.

            $saveAction->removeExtraClass("btn-primary");
            $saveAction->addExtraClass("btn-outline-success");
            $saveAction->setIcon(MaterialIcons::DONE);
        }
        // $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;
                    }
                ));
            }
        });*/

        $this->setCMSTabset($form);

        $form->setHTMLID('Form_EditForm');
        $form->loadDataFrom($siteConfig);
        $form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));

        $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.
     * The method is defined in SiteConfig::getCMSActions
     *
     * @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_by_id(SiteConfig::class, $data['ID']);
        $form->saveInto($siteConfig);

It seems like $siteConfig can also be of type null; however, parameter $dataObject of SilverStripe\Forms\Form::saveInto() does only seem to accept SilverStripe\ORM\DataObjectInterface, maybe add an additional type check?

        $siteConfig->write();

        if ($siteConfig->hasExtension(RecursivePublishable::class)) {
            $siteConfig->publishRecursive();
        }

        $message = _t('SilverStripe\\Admin\\LeftAndMain.SAVEDUP', 'Saved.');

        // TODO: implement our own logic
        // if (Director::is_ajax()) {
        //     $this->response->addHeader(
        //         'X-Status',
        //         rawurlencode($message)
        //     );
        //     return $form->forTemplate();
        // }
        $this->successMessage($message);
        return $this->redirect($this->LinkHash());
    }

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