1. class
  2. Ramsey
  3. \
  4. Collection
  5. \
  6. Map
  7. \
  8. TypedMap

TypedMap

class TypedMap extends AbstractTypedMap (View source)

A TypedMap represents a map of elements where key and value are typed.

Each element is identified by a key with defined type and a value of defined type. The keys of the map must be unique. The values on the map can be= repeated but each with its own different key.

The most common case is to use a string type key, but it's not limited to this type of keys.

This is a direct implementation of TypedMapInterface, provided for the sake of convenience.

Example usage:

$map = new TypedMap('string', Foo::class);
$map['x'] = new Foo();
foreach ($map as $key => $value) {
    // do something with $key, it will be a Foo::class
}

// this will throw an exception since key must be string
$map[10] = new Foo();

// this will throw an exception since value must be a Foo
$map['bar'] = 'bar';

// initialize map with contents
$map = new TypedMap('string', Foo::class, [
    new Foo(), new Foo(), new Foo()
]);

It is preferable to subclass AbstractTypedMap to create your own typed map implementation:

class FooTypedMap extends AbstractTypedMap
{
    public function getKeyType()
    {
        return 'int';
    }

    public function getValueType()
    {
         return Foo::class;
    }
}

… but you also may use the TypedMap class:

class FooTypedMap extends TypedMap
{
    public function __constructor(array $data = [])
    {
        parent::__construct('int', Foo::class, $data);
    }
}

Traits

TypeTrait
Provides functionality to check values for specific types.
TypeTrait
Provides functionality to check values for specific types.
ValueToStringTrait
Provides functionality to express a value as string

Properties

protected array $data The items of this array. from AbstractArray

Methods

__construct(string $keyType, string $valueType, array $data = [])

Constructs a map object of the specified key and value types, optionally with the specified data.

Traversable
getIterator()

Returns an iterator for this array.

from AbstractArray
bool
offsetExists(mixed $offset)

Returns true if the given offset exists in this array.

from AbstractArray
mixed|null
offsetGet(mixed $offset)

Returns the value at the specified offset.

from AbstractArray
void
offsetSet(mixed|null $offset, mixed $value)

Sets the given value to the given offset in the map.

from AbstractTypedMap
void
offsetUnset(mixed $offset)

Removes the given offset and its value from the array.

from AbstractArray
string
serialize()

Returns a serialized string representation of this array object.

from AbstractArray
void
unserialize(string $serialized)

Converts a serialized string representation into an instance object.

from AbstractArray
int
count()

Returns the number of items in this array.

from AbstractArray
void
clear()

Removes all items from this array.

from AbstractArray
array
toArray()

Returns a native PHP array representation of this array object.

from AbstractArray
bool
isEmpty()

Returns true if this array is empty.

from AbstractArray
bool
containsKey(mixed $key)

Returns true if this map contains a mapping for the specified key.

from AbstractMap
bool
containsValue(mixed $value)

Returns true if this map maps one or more keys to the specified value.

from AbstractMap
array
keys()

Return an array of the keys contained in this map.

from AbstractMap
mixed|null
get(mixed $key, mixed $defaultValue = null)

Returns the value to which the specified key is mapped, null if this map contains no mapping for the key, or (optionally) $defaultValue if this map contains no mapping for the key.

from AbstractMap
mixed|null
put(mixed $key, mixed $value)

Associates the specified value with the specified key in this map.

from AbstractMap
mixed|null
putIfAbsent(mixed $key, mixed $value)

Associates the specified value with the specified key in this map only if it is not already set.

from AbstractMap
mixed|null
remove(mixed $key)

Removes the mapping for a key from this map if it is present.

from AbstractMap
bool
removeIf(mixed $key, mixed $value)

Removes the entry for the specified key only if it is currently mapped to the specified value.

from AbstractMap
mixed|null
replace(mixed $key, mixed $value)

Replaces the entry for the specified key only if it is currently mapped to some value.

from AbstractMap
bool
replaceIf(mixed $key, mixed $oldValue, mixed $newValue)

Replaces the entry for the specified key only if currently mapped to the specified value.

from AbstractMap
bool
checkType(string $type, mixed $value)

Returns true if value is of the specified type.

from TypeTrait
string
toolValueToString(mixed $value)

Returns a string representation of the value.

from ValueToStringTrait
string
getKeyType()

Return the type used on the key.

string
getValueType()

Return the type forced on the values.

Details

at line 115
__construct(string $keyType, string $valueType, array $data = [])

Constructs a map object of the specified key and value types, optionally with the specified data.

Parameters

string $keyType The data type of the map's keys.
string $valueType The data type of the map's values.
array $data The initial items to add to this array.

in AbstractArray at line 51
Traversable getIterator()

Returns an iterator for this array.

Return Value

Traversable

in AbstractArray at line 65
bool offsetExists(mixed $offset)

Returns true if the given offset exists in this array.

Parameters

mixed $offset The offset to check.

Return Value

bool

in AbstractArray at line 80
mixed|null offsetGet(mixed $offset)

Returns the value at the specified offset.

Parameters

mixed $offset The offset for which a value should be returned.

Return Value

mixed|null the value stored at the offset, or null if the offset does not exist.

in AbstractTypedMap at line 39
void offsetSet(mixed|null $offset, mixed $value)

Sets the given value to the given offset in the map.

Parameters

mixed|null $offset The offset to set. If null, the value may be set at a numerically-indexed offset.
mixed $value The value to set at the given offset.

Return Value

void

Exceptions

InvalidArgumentException if the offset or value do not match the expected types.

in AbstractArray at line 110
void offsetUnset(mixed $offset)

Removes the given offset and its value from the array.

Parameters

mixed $offset The offset to remove from the array.

Return Value

void

in AbstractArray at line 122
string serialize()

Returns a serialized string representation of this array object.

Return Value

string a PHP serialized string.

in AbstractArray at line 134
void unserialize(string $serialized)

Converts a serialized string representation into an instance object.

Parameters

string $serialized A PHP serialized string to unserialize.

Return Value

void

in AbstractArray at line 146
int count()

Returns the number of items in this array.

Return Value

int

in AbstractArray at line 154
void clear()

Removes all items from this array.

Return Value

void

in AbstractArray at line 164
array toArray()

Returns a native PHP array representation of this array object.

Return Value

array

in AbstractArray at line 174
bool isEmpty()

Returns true if this array is empty.

Return Value

bool

in AbstractMap at line 53
bool containsKey(mixed $key)

Returns true if this map contains a mapping for the specified key.

Parameters

mixed $key The key to check in the map.

Return Value

bool

in AbstractMap at line 67
bool containsValue(mixed $value)

Returns true if this map maps one or more keys to the specified value.

This performs a strict type check on the value.

Parameters

mixed $value The value to check in the map.

Return Value

bool

in AbstractMap at line 77
array keys()

Return an array of the keys contained in this map.

Return Value

array

in AbstractMap at line 92
mixed|null get(mixed $key, mixed $defaultValue = null)

Returns the value to which the specified key is mapped, null if this map contains no mapping for the key, or (optionally) $defaultValue if this map contains no mapping for the key.

Parameters

mixed $key The key to return from the map.
mixed $defaultValue The default value to use if $key is not found.

Return Value

mixed|null the value or null if the key could not be found.

in AbstractMap at line 113
mixed|null put(mixed $key, mixed $value)

Associates the specified value with the specified key in this map.

If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters

mixed $key The key to put or replace in the map.
mixed $value The value to store at $key.

Return Value

mixed|null the previous value associated with key, or null if there was no mapping for $key.

in AbstractMap at line 134
mixed|null putIfAbsent(mixed $key, mixed $value)

Associates the specified value with the specified key in this map only if it is not already set.

If there is already a value associated with $key, this returns that value without replacing it.

Parameters

mixed $key The key to put in the map.
mixed $value The value to store at $key.

Return Value

mixed|null the previous value associated with key, or null if there was no mapping for $key.

in AbstractMap at line 153
mixed|null remove(mixed $key)

Removes the mapping for a key from this map if it is present.

Parameters

mixed $key The key to remove from the map.

Return Value

mixed|null the previous value associated with key, or null if there was no mapping for $key.

in AbstractMap at line 172
bool removeIf(mixed $key, mixed $value)

Removes the entry for the specified key only if it is currently mapped to the specified value.

This performs a strict type check on the value.

Parameters

mixed $key The key to remove from the map.
mixed $value The value to match.

Return Value

bool true if the value was removed.

in AbstractMap at line 193
mixed|null replace(mixed $key, mixed $value)

Replaces the entry for the specified key only if it is currently mapped to some value.

Parameters

mixed $key The key to replace.
mixed $value The value to set at $key.

Return Value

mixed|null the previous value associated with key, or null if there was no mapping for $key.

in AbstractMap at line 216
bool replaceIf(mixed $key, mixed $oldValue, mixed $newValue)

Replaces the entry for the specified key only if currently mapped to the specified value.

This performs a strict type check on the value.

Parameters

mixed $key The key to remove from the map.
mixed $oldValue The value to match.
mixed $newValue The value to use as a replacement.

Return Value

bool true if the value was replaced.

in TypeTrait at line 30
protected bool checkType(string $type, mixed $value)

Returns true if value is of the specified type.

Parameters

string $type The type to check the value against.
mixed $value The value to check.

Return Value

bool

in ValueToStringTrait at line 38
protected string toolValueToString(mixed $value)

Returns a string representation of the value.

  • null value: 'NULL'
  • boolean: 'TRUE', 'FALSE'
  • array: 'Array'
  • scalar: converted-value
  • resource: '(type resource #number)'
  • object with __toString(): result of __toString()
  • object DateTime: ISO 8601 date
  • object: '(className Object)'
  • anonymous function: same as object

Parameters

mixed $value the value to return as a string.

Return Value

string

at line 127
string getKeyType()

Return the type used on the key.

Return Value

string

at line 137
string getValueType()

Return the type forced on the values.

Return Value

string