EntryLockingStringMap.php

Go to the documentation of this file.

<?php

namespace ILIAS\FileUpload\Collection;

use ILIAS\FileUpload\Collection\Exception\ElementAlreadyExistsException;
use ILIAS\FileUpload\Collection\Exception\NoSuchElementException;
use ILIAS\FileUpload\ScalarTypeCheckAware;

/******************************************************************************
 *
 * This file is part of ILIAS, a powerful learning management system.
 *
 * ILIAS is licensed with the GPL-3.0, you should have received a copy
 * of said license along with the source code.
 *
 * If this is not the case or you just want to try ILIAS, you'll find
 * us at:
 *      https://www.ilias.de
 *      https://github.com/ILIAS-eLearning
 *
 *****************************************************************************/
final class EntryLockingStringMap implements StringMap
{
    use ScalarTypeCheckAware;
    private \ArrayObject $map;


    public function __construct()
    {
        $this->map = new \ArrayObject();
    }


    public function get(string $key): string
    {
        $this->stringTypeCheck($key, 'key');

        if ($this->map->offsetExists($key)) {
            return $this->map->offsetGet($key);
        }

        throw new NoSuchElementException("No meta data associated with key \"$key\".");
    }


    public function toArray(): array
    {
        return $this->map->getArrayCopy();
    }


    public function has(string $key): bool
    {
        $this->stringTypeCheck($key, 'key');

        return $this->map->offsetExists($key);
    }


    public function put(string $key, string $value): void
    {
        $this->stringTypeCheck($key, 'key');
        $this->stringTypeCheck($value, 'value');

        if ($this->map->offsetExists($key)) {
            throw new ElementAlreadyExistsException("Element $key can not be overwritten.");
        }

        $this->map->offsetSet($key, $value);
    }
}