BackendUserSettingsDataProvider.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\User\ExtDirect;

use TYPO3\CMS\Core\Utility\GeneralUtility;

class BackendUserSettingsDataProvider {

    public function get($key = '') {
        if (strpos($key, '.') !== FALSE) {
            $return = $this->getFromDottedNotation($key);
        } else {
            $return = $key === '' ? $GLOBALS['BE_USER']->uc : $GLOBALS['BE_USER']->uc[$key];
        }
        return $return;
    }

    public function set($key, $value) {
        if (strpos($key, '.') !== FALSE) {
            $this->setFromDottedNotation($key, $value);
        } else {
            $GLOBALS['BE_USER']->uc[$key] = $value;
        }
        $GLOBALS['BE_USER']->writeUC($GLOBALS['BE_USER']->uc);
    }

    public function setFromArray(array $array) {
        $GLOBALS['BE_USER']->uc = array_merge($GLOBALS['BE_USER']->uc, $array);
        $GLOBALS['BE_USER']->writeUC($GLOBALS['BE_USER']->uc);
    }

    public function reset() {
        $GLOBALS['BE_USER']->resetUC();
    }

    public function unsetKey($key) {
        if (isset($GLOBALS['BE_USER']->uc[$key])) {
            unset($GLOBALS['BE_USER']->uc[$key]);
            $GLOBALS['BE_USER']->writeUC($GLOBALS['BE_USER']->uc);
        }
    }

    public 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);
    }

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

    protected function getFromDottedNotation($key) {
        $subkeys = GeneralUtility::trimExplode('.', $key);
        $array = &$GLOBALS['BE_USER']->uc;
        foreach ($subkeys as $subkey) {
            $array = &$array[$subkey];
        }
        return $array;
    }

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

    protected function getLastKeyFromDottedNotation($key) {
        $subkeys = GeneralUtility::trimExplode('.', $key, TRUE);
        return $subkeys[count($subkeys) - 1];
    }

}