TemplateVariableContainer.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\Core\ViewHelper;

/*                                                                        *
 * This script is backported from the TYPO3 Flow package "TYPO3.Fluid".   *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 *  of the License, or (at your option) any later version.                *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

class TemplateVariableContainer implements \ArrayAccess
{
    protected static $reservedVariableNames = ['true', 'false', 'on', 'off', 'yes', 'no', '_all'];

    protected $variables = [];

    public function __construct(array $variableArray = [])
    {
        $this->variables = $variableArray;
    }

    public function add($identifier, $value)
    {
        if (array_key_exists($identifier, $this->variables)) {
            throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException('Duplicate variable declaration, "' . $identifier . '" already set!', 1224479063);
        }
        if (in_array(strtolower($identifier), self::$reservedVariableNames)) {
            throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException('"' . $identifier . '" is a reserved variable name and cannot be used as variable identifier.', 1256730379);
        }
        $this->variables[$identifier] = $value;
    }

    public function get($identifier)
    {
        if ($identifier === '_all') {
            return $this->variables;
        }
        if (!array_key_exists($identifier, $this->variables)) {
            throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException('Tried to get a variable "' . $identifier . '" which is not stored in the context!', 1224479370);
        }
        return $this->variables[$identifier];
    }

    public function remove($identifier)
    {
        if (!array_key_exists($identifier, $this->variables)) {
            throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException('Tried to remove a variable "' . $identifier . '" which is not stored in the context!', 1224479372);
        }
        unset($this->variables[$identifier]);
    }

    public function getAllIdentifiers()
    {
        return array_keys($this->variables);
    }

    public function getAll()
    {
        return $this->variables;
    }

    public function exists($identifier)
    {
        if ($identifier === '_all') {
            return true;
        }

        return array_key_exists($identifier, $this->variables);
    }

    public function __sleep()
    {
        return ['variables'];
    }

    public function offsetSet($identifier, $value)
    {
        $this->add($identifier, $value);
    }

    public function offsetUnset($identifier)
    {
        $this->remove($identifier);
    }

    public function offsetExists($identifier)
    {
        return $this->exists($identifier);
    }

    public function offsetGet($identifier)
    {
        return $this->get($identifier);
    }

    public function getOrNull($variableName)
    {
        if ($variableName === '_all') {
            return $this->variables;
        }

        return isset($this->variables[$variableName]) ? $this->variables[$variableName] : null;
    }
}