UserSettingsController.php

Go to the documentation of this file.

<?php

namespace TYPO3\CMS\Backend\Controller;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class UserSettingsController
{
    public function processAjaxRequest(ServerRequestInterface $request, ResponseInterface $response)
    {
        // do the regular / main logic, depending on the action parameter
        $action = isset($request->getParsedBody()['action']) ? $request->getParsedBody()['action'] : $request->getQueryParams()['action'];
        $key = isset($request->getParsedBody()['key']) ? $request->getParsedBody()['key'] : $request->getQueryParams()['key'];
        $value = isset($request->getParsedBody()['value']) ? $request->getParsedBody()['value'] : $request->getQueryParams()['value'];

        $content = $this->process($action, $key, $value);

        $response->getBody()->write(json_encode($content));
        return $response;
    }

    public function process($action, $key = '', $value = '')
    {
        switch ($action) {
            case 'get':
                $content = $this->get($key);
                break;
            case 'getAll':
                $content = $this->getAll();
                break;
            case 'set':
                $this->set($key, $value);
                $content = $this->getAll();
                break;
            case 'addToList':
                $this->addToList($key, $value);
                $content = $this->getAll();
                break;
            case 'removeFromList':
                $this->removeFromList($key, $value);
                $content = $this->getAll();
                break;
            case 'unset':
                $this->unsetOption($key);
                $content = $this->getAll();
                break;
            case 'clear':
                $this->clear();
                $content = ['result' => true];
                break;
            default:
                $content = ['result' => false];
        }

        return $content;
    }

    protected function get($key)
    {
        return (strpos($key, '.') !== false) ? $this->getFromDottedNotation($key) : $this->getBackendUser()->uc[$key];
    }

    protected function getAll()
    {
        return $this->getBackendUser()->uc;
    }

    protected function set($key, $value)
    {
        $beUser = $this->getBackendUser();
        if (strpos($key, '.') !== false) {
            $this->setFromDottedNotation($key, $value);
        } else {
            $beUser->uc[$key] = $value;
        }
        $beUser->writeUC($beUser->uc);
    }

    protected function addToList($key, $value)
    {
        $list = $this->get($key);
        if (!isset($list)) {
            $list = $value;
        } else {
            if (!GeneralUtility::inList($list, $value)) {
                $list .= ',' . $value;
            }
        }
        $this->set($key, $list);
    }

    protected function removeFromList($key, $value)
    {
        $list = $this->get($key);
        if (GeneralUtility::inList($list, $value)) {
            $list = GeneralUtility::trimExplode(',', $list, true);
            $list = ArrayUtility::removeArrayEntryByValue($list, $value);
            $this->set($key, implode(',', $list));
        }
    }

    protected function clear()
    {
        $this->getBackendUser()->resetUC();
    }

    protected function unsetOption($key)
    {
        $beUser = $this->getBackendUser();
        if (isset($beUser->uc[$key])) {
            unset($beUser->uc[$key]);
            $beUser->writeUC($beUser->uc);
        }
    }

    protected function getFromDottedNotation($key)
    {
        $subkeys = GeneralUtility::trimExplode('.', $key);
        $array = $this->getBackendUser()->uc;
        foreach ($subkeys as $subkey) {
            if (isset($array[$subkey])) {
                $array = &$array[$subkey];
            } else {
                $array = [];
                break;
            }
        }
        return $array;
    }

    protected function setFromDottedNotation($key, $value)
    {
        $subkeys = GeneralUtility::trimExplode('.', $key, true);
        $lastKey = $subkeys[count($subkeys) - 1];
        $array = &$this->getBackendUser()->uc;
        foreach ($subkeys as $subkey) {
            if ($subkey === $lastKey) {
                $array[$subkey] = $value;
            } else {
                $array = &$array[$subkey];
            }
        }
    }

    protected function getBackendUser()
    {
        return $GLOBALS['BE_USER'];
    }
}