ViewHelperVariableContainer.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 ViewHelperVariableContainer
{
    protected $objects = [];

    protected $view;

    public function add($viewHelperName, $key, $value)
    {
        if ($this->exists($viewHelperName, $key)) {
            throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException('The key "' . $viewHelperName . '->' . $key . '" was already stored and you cannot override it.', 1243352010);
        }
        $this->addOrUpdate($viewHelperName, $key, $value);
    }

    public function addOrUpdate($viewHelperName, $key, $value)
    {
        if (!isset($this->objects[$viewHelperName])) {
            $this->objects[$viewHelperName] = [];
        }
        $this->objects[$viewHelperName][$key] = $value;
    }

    public function get($viewHelperName, $key)
    {
        if (!$this->exists($viewHelperName, $key)) {
            throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException('No value found for key "' . $viewHelperName . '->' . $key . '"', 1243325768);
        }
        return $this->objects[$viewHelperName][$key];
    }

    public function exists($viewHelperName, $key)
    {
        return isset($this->objects[$viewHelperName]) && array_key_exists($key, $this->objects[$viewHelperName]);
    }

    public function remove($viewHelperName, $key)
    {
        if (!$this->exists($viewHelperName, $key)) {
            throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException('No value found for key "' . $viewHelperName . '->' . $key . '", thus the key cannot be removed.', 1243352249);
        }
        unset($this->objects[$viewHelperName][$key]);
    }

    public function setView(\TYPO3\CMS\Fluid\View\AbstractTemplateView $view)
    {
        $this->view = $view;
    }

    public function getView()
    {
        return $this->view;
    }

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