Registry.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core;

/*
 * 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!
 */

class Registry implements \TYPO3\CMS\Core\SingletonInterface
{
    protected $entries = [];

    protected $loadedNamespaces = [];

    public function get($namespace, $key, $defaultValue = null)
    {
        $this->validateNamespace($namespace);
        if (!$this->isNamespaceLoaded($namespace)) {
            $this->loadEntriesByNamespace($namespace);
        }
        return isset($this->entries[$namespace][$key]) ? $this->entries[$namespace][$key] : $defaultValue;
    }

    public function set($namespace, $key, $value)
    {
        $this->validateNamespace($namespace);
        if (!$this->isNamespaceLoaded($namespace)) {
            $this->loadEntriesByNamespace($namespace);
        }
        $serializedValue = serialize($value);
        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'sys_registry', 'entry_namespace = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($namespace, 'sys_registry') . ' AND entry_key = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($key, 'sys_registry'));
        if ($GLOBALS['TYPO3_DB']->sql_num_rows($res) < 1) {
            $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_registry', [
                'entry_namespace' => $namespace,
                'entry_key' => $key,
                'entry_value' => $serializedValue
            ]);
        } else {
            $GLOBALS['TYPO3_DB']->exec_UPDATEquery('sys_registry', 'entry_namespace = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($namespace, 'sys_registry') . ' AND entry_key = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($key, 'sys_registry'), [
                'entry_value' => $serializedValue
            ]);
        }
        $this->entries[$namespace][$key] = $value;
    }

    public function remove($namespace, $key)
    {
        $this->validateNamespace($namespace);
        $GLOBALS['TYPO3_DB']->exec_DELETEquery('sys_registry', 'entry_namespace = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($namespace, 'sys_registry') . ' AND entry_key = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($key, 'sys_registry'));
        unset($this->entries[$namespace][$key]);
    }

    public function removeAllByNamespace($namespace)
    {
        $this->validateNamespace($namespace);
        $GLOBALS['TYPO3_DB']->exec_DELETEquery('sys_registry', 'entry_namespace = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($namespace, 'sys_registry'));
        unset($this->entries[$namespace]);
    }

    protected function isNamespaceLoaded($namespace)
    {
        return isset($this->loadedNamespaces[$namespace]);
    }

    protected function loadEntriesByNamespace($namespace)
    {
        $this->validateNamespace($namespace);
        $storedEntries = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('*', 'sys_registry', 'entry_namespace = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($namespace, 'sys_registry'));
        foreach ($storedEntries as $storedEntry) {
            $key = $storedEntry['entry_key'];
            $this->entries[$namespace][$key] = unserialize($storedEntry['entry_value']);
        }
        $this->loadedNamespaces[$namespace] = true;
    }

    protected function validateNamespace($namespace)
    {
        if (strlen($namespace) < 2) {
            throw new \InvalidArgumentException('Given namespace must be longer than two characters.', 1249755131);
        }
    }
}