OptionForm.class.php

<?php

namespace wcf\acp\form;

use wcf\data\option\category\OptionCategory;
use wcf\data\option\OptionAction;
use wcf\event\acp\option\RewriteApplicationCollecting;
use wcf\system\application\ApplicationHandler;
use wcf\system\event\EventHandler;
use wcf\system\exception\IllegalLinkException;
use wcf\system\menu\acp\ACPMenu;
use wcf\system\option\OptionHandler;
use wcf\system\service\worker\ServiceWorkerHandler;
use wcf\system\style\StyleHandler;
use wcf\system\WCF;

/**
 * Shows the option edit form.
 *
 * @author  Marcel Werk
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 *
 * @extends AbstractOptionListForm<OptionHandler>
 */
class OptionForm extends AbstractOptionListForm
{
    /**
     * category option
     * @var OptionCategory
     */
    public $category;

    /**
     * category id
     * @var int
     */
    public $categoryID = 0;

    /**
     * the option tree
     * @var mixed[]
     */
    public $optionTree = [];

    /**
     * @inheritDoc
     */
    protected $languageItemPattern = 'wcf.acp.option.option\d+';

    /**
     * @inheritDoc
     */
    public function readParameters()
    {
        if (isset($_REQUEST['id'])) {
            $this->categoryID = \intval($_REQUEST['id']);
        }
        $this->category = new OptionCategory($this->categoryID);
        if (!$this->category->categoryID) {
            throw new IllegalLinkException();
        }
        $this->categoryName = $this->category->categoryName;

        parent::readParameters();
    }

    /**
     * @inheritDoc
     */
    public function save()
    {
        parent::save();

        // save options
        $saveOptions = $this->optionHandler->save('wcf.acp.option', 'wcf.acp.option.option');
        $this->objectAction = new OptionAction([], 'updateAll', ['data' => $saveOptions]);
        $this->objectAction->executeAction();
        $this->saved();

        ServiceWorkerHandler::getInstance()->updateKeys();

        // reset styles to make sure the updated option values are used
        StyleHandler::resetStylesheets();

        // show success message
        WCF::getTPL()->assign('success', true);
    }

    /**
     * @inheritDoc
     */
    public function readData()
    {
        parent::readData();

        // load option tree
        $this->optionTree = $this->optionHandler->getOptionTree($this->category->categoryName);

        if (empty($_POST)) {
            // not a valid top (level 1 or 2) category
            if (!isset($this->optionTree[0])) {
                throw new IllegalLinkException();
            }
        }
    }

    /**
     * @inheritDoc
     */
    public function assignVariables()
    {
        parent::assignVariables();

        $event = new RewriteApplicationCollecting();
        foreach (ApplicationHandler::getInstance()->getApplications() as $application) {
            $event->register($application->getPackage()->getName(), WCF::getPath($application->getAbbreviation()));
        }

        EventHandler::getInstance()->fire($event);
        $applications = $event->getApplications();

        // Generate a static route to enforce URL rewriting.
        $applications = \array_map(
            static fn(string $path) => $path . 'core-rewrite-test/',
            $applications
        );

        WCF::getTPL()->assign([
            'category' => $this->category,
            'optionTree' => $this->optionTree,
            'rewriteTestApplications' => $applications,
        ]);
    }

    /**
     * @inheritDoc
     */
    public function show()
    {
        // set active menu item
        ACPMenu::getInstance()->setActiveMenuItem('wcf.acp.option.category.' . $this->category->categoryName);

        // check permission
        WCF::getSession()->checkPermissions(['admin.configuration.canEditOption']);

        // show form
        parent::show();
    }
}