FinisherVariableProvider.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\Form\Domain\Finishers;
 
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\Exception\MissingArrayPathException;
 
final class ‪FinisherVariableProvider implements \ArrayAccess, \IteratorAggregate, \Countable
{
    protected ‪$objects = [];
 
    public function ‪add(string $finisherIdentifier, string $key, $value)
    {
        $this->‪addOrUpdate($finisherIdentifier, $key, $value);
    }
 
    public function ‪addOrUpdate(string $finisherIdentifier, string $key, $value)
    {
        if (!array_key_exists($finisherIdentifier, $this->objects)) {
            $this->objects[$finisherIdentifier] = [];
        }
        $this->objects[$finisherIdentifier] = ‪ArrayUtility::setValueByPath(
            $this->objects[$finisherIdentifier],
            $key,
            $value,
            '.'
        );
    }
 
    public function get(string $finisherIdentifier, string $key, $default = null)
    {
        if ($this->‪exists($finisherIdentifier, $key)) {
            return ‪ArrayUtility::getValueByPath($this->objects[$finisherIdentifier], $key, '.');
        }
        return $default;
    }
 
    public function ‪exists($finisherIdentifier, $key): bool
    {
        try {
            ‪ArrayUtility::getValueByPath($this->objects[$finisherIdentifier] ?? [], $key, '.');
        } catch (‪MissingArrayPathException $e) {
            return false;
        }
        return true;
    }
 
    public function remove(string $finisherIdentifier, string $key)
    {
        if ($this->‪exists($finisherIdentifier, $key)) {
            $this->objects[$finisherIdentifier] = ‪ArrayUtility::removeByPath(
                $this->objects[$finisherIdentifier],
                $key,
                '.'
            );
        }
    }
 
    public function ‪__sleep()
    {
        return ['objects'];
    }
 
    public function ‪offsetExists(mixed $offset): bool
    {
        return isset($this->objects[$offset]);
    }
 
    public function ‪offsetGet(mixed $offset): mixed
    {
        return $this->objects[$offset];
    }
 
    public function ‪offsetSet(mixed $offset, mixed $value): void
    {
        $this->objects[$offset] = $value;
    }
 
    public function ‪offsetUnset(mixed $offset): void
    {
        unset($this->objects[$offset]);
    }
 
    public function ‪getIterator(): \Traversable
    {
        foreach ($this->objects as $offset => $value) {
            yield $offset => $value;
        }
    }
 
    public function ‪count(): int
    {
        return ‪count($this->objects);
    }
}