BackendUserConfiguration.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Backend\Configuration;
 
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪BackendUserConfiguration
{
    protected ‪$backendUser;
 
    public function ‪__construct(‪BackendUserAuthentication ‪$backendUser = null)
    {
        $this->backendUser = ‪$backendUser ?: ‪$GLOBALS['BE_USER'];
    }
 
    public function get(string $key)
    {
        return (strpos($key, '.') !== false) ? $this->‪getFromDottedNotation($key) : $this->backendUser->uc[$key];
    }
 
    public function ‪getAll()
    {
        return $this->backendUser->uc;
    }
 
    public function set(string $key, $value): void
    {
        if (strpos($key, '.') !== false) {
            $this->‪setFromDottedNotation($key, $value);
        } else {
            $this->backendUser->uc[$key] = $value;
        }
 
        $this->backendUser->writeUC($this->backendUser->uc);
    }
 
    public function ‪addToList(string $key, $value): void
    {
        $list = $this->get($key);
 
        if (!isset($list)) {
            $list = $value;
        } elseif (!GeneralUtility::inList($list, $value)) {
            $list .= ',' . $value;
        }
 
        $this->set($key, $list);
    }
 
    public function ‪removeFromList(string $key, $value): void
    {
        $list = $this->get($key);
 
        if (GeneralUtility::inList($list, $value)) {
            $list = ‪GeneralUtility::trimExplode(',', $list, true);
            $list = ‪ArrayUtility::removeArrayEntryByValue($list, $value);
            $this->set($key, implode(',', $list));
        }
    }
 
    public function ‪clear(): void
    {
        $this->backendUser->resetUC();
    }
 
    public function ‪unsetOption(string $key): void
    {
        if (isset($this->backendUser->uc[$key])) {
            unset($this->backendUser->uc[$key]);
            $this->backendUser->writeUC($this->backendUser->uc);
        }
    }
 
    protected function ‪getFromDottedNotation(string $key)
    {
        $subkeys = ‪GeneralUtility::trimExplode('.', $key);
        $configuration = $this->backendUser->uc;
 
        foreach ($subkeys as $subkey) {
            if (isset($configuration[$subkey])) {
                $configuration = &$configuration[$subkey];
            } else {
                $configuration = [];
                break;
            }
        }
 
        return $configuration;
    }
 
    protected function ‪setFromDottedNotation(string $key, $value): void
    {
        $subkeys = ‪GeneralUtility::trimExplode('.', $key, true);
        $lastKey = $subkeys[count($subkeys) - 1];
        $configuration = &$this->backendUser->uc;
 
        foreach ($subkeys as $subkey) {
            if ($subkey === $lastKey) {
                $configuration[$subkey] = $value;
            } else {
                $configuration = &$configuration[$subkey];
            }
        }
    }
}