ILIAS\FileUpload\Collection\EntryLockingStringMap Class Reference

Class EntryLockingStringMap. More...

Inheritance diagram for ILIAS\FileUpload\Collection\EntryLockingStringMap:

Collaboration diagram for ILIAS\FileUpload\Collection\EntryLockingStringMap:

Public Member Functions
	__construct ()
	EntryLockingStringMap constructor. More...
	get (string $key)
	Returns the value of the given key. More...
	toArray ()
	Returns all currently known entries. More...
	has (string $key)
	Probe if the key is known and associated with a value. More...
	put (string $key, string $value)
	Puts a new key value pair into the string array. More...
	put (string $key, string $value)
	Puts a new key value pair into the string array. More...
	get (string $key)
	Returns the value of the key from the additional metadata. More...
	toArray ()
	Returns all currently known entries. More...
	has (string $key)
	Probe if the key is known and associated with a value. More...

Private Attributes
ArrayObject	$map

Detailed Description

Class EntryLockingStringMap.

Implementation of the StringMap which locks the entry after it got created. Therefore it is not possible to overwrite an existing key.

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Since

5.3

Version

1.0

@Internal

Definition at line 34 of file EntryLockingStringMap.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\Collection\EntryLockingStringMap::__construct

(

)

EntryLockingStringMap constructor.

Definition at line 43 of file EntryLockingStringMap.php.

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

Member Function Documentation

get()

ILIAS\FileUpload\Collection\EntryLockingStringMap::get

(

string

$key

)

Returns the value of the given key.

Parameters

string

$key

The key which should be used to search the corresponding value.

Exceptions

NoSuchElementException	Thrown if the entry is not found with the given key.

InvalidArgumentException Thrown if the key type is not of the type string.

Since

5.3

Implements ILIAS\FileUpload\Collection\ImmutableStringMap.

Definition at line 58 of file EntryLockingStringMap.php.

                                    : 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\".");
    }

References ILIAS\LTI\ToolProvider\$key.

has()

ILIAS\FileUpload\Collection\EntryLockingStringMap::has

(

string

$key

)

Probe if the key is known and associated with a value.

Parameters

string

$key

The key which should be checked.

Exceptions

InvalidArgumentException Thrown if the key type is not of the type string.

Since

5.3

Implements ILIAS\FileUpload\Collection\ImmutableStringMap.

Definition at line 91 of file EntryLockingStringMap.php.

                                    : bool
    {
        $this->stringTypeCheck($key, 'key');
 
        return $this->map->offsetExists($key);
    }

References ILIAS\LTI\ToolProvider\$key.

put()

ILIAS\FileUpload\Collection\EntryLockingStringMap::put	(	string	$key,
		string	$value
	)

Puts a new key value pair into the string array.

The put operation can not overwrite an existing pair.

Parameters

string	$key	The key which should be put into the map.
string	$value	The value which should be associated with the given key.

Exceptions

ElementAlreadyExistsException	Thrown if the key already exists in the map.

InvalidArgumentException Thrown if the key or value is not of the type string.

Since

5.3

Implements ILIAS\FileUpload\Collection\StringMap.

Definition at line 111 of file EntryLockingStringMap.php.

                                                   : 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);
    }

References ILIAS\LTI\ToolProvider\$key.

toArray()

ILIAS\FileUpload\Collection\EntryLockingStringMap::toArray

(

)

Returns all currently known entries.

Returns

string[]

Since

5.3

Implements ILIAS\FileUpload\Collection\ImmutableStringMap.

Definition at line 77 of file EntryLockingStringMap.php.

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

Field Documentation

$map

ArrayObject ILIAS\FileUpload\Collection\EntryLockingStringMap::$map

private

Definition at line 37 of file EntryLockingStringMap.php.

---

The documentation for this class was generated from the following file:

• src/FileUpload/Collection/EntryLockingStringMap.php