NamedParameterMap

NamedParameterMap represents a mapping of values to a set of named keys that may optionally be typed

Full name: \Ramsey\Collection\Map\NamedParameterMap
Parent class: \Ramsey\Collection\Map\AbstractMap

Properties

namedParameters

Named parameters defined for this map.

protected array&lt;string,string&gt; $namedParameters

Methods

__construct

Constructs a new NamedParameterMap.

public __construct(array&lt;array-key,string&gt; $namedParameters, array&lt;array-key,mixed&gt; $data = []): mixed

Parameters:

Parameter	Type	Description
`$namedParameters`	array	The named parameters defined for this map.
`$data`	array	An initial set of data to set on this map.

getNamedParameters

Returns named parameters set for this NamedParameterMap.

public getNamedParameters(): array&lt;string,string&gt;

offsetSet

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

public offsetSet(mixed $offset, mixed $value): void

Parameters:

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

filterNamedParameters

Given an array of named parameters, constructs a proper mapping of named parameters to types.

protected filterNamedParameters(array&lt;array-key,string&gt; $namedParameters): array&lt;string,string&gt;

Parameters:

Parameter	Type	Description
`$namedParameters`	array	The named parameters to filter.

Inherited methods

__construct

Constructs a new array object.

public __construct(array&lt;array-key,\Ramsey\Collection\T&gt; $data = []): mixed

Parameters:

Parameter	Type	Description
`$data`	array	The initial items to add to this array.

getIterator

Returns an iterator for this array.

public getIterator(): \Traversable&lt;array-key,\Ramsey\Collection\T&gt;

See Also:

http://php.net/manual/en/iteratoraggregate.getiterator.php - IteratorAggregate::getIterator()

offsetExists

Returns true if the given offset exists in this array.

public offsetExists(array-key $offset): bool

Parameters:

Parameter	Type	Description
`$offset`	array-key	The offset to check.

See Also:

http://php.net/manual/en/arrayaccess.offsetexists.php - ArrayAccess::offsetExists()

offsetGet

Returns the value at the specified offset.

public offsetGet(array-key $offset): \Ramsey\Collection\T|null

Parameters:

Parameter	Type	Description
`$offset`	array-key	The offset for which a value should be returned.

Return Value:

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

See Also:

http://php.net/manual/en/arrayaccess.offsetget.php - ArrayAccess::offsetGet()

offsetSet

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

public offsetSet(mixed $offset, mixed $value): void

Parameters:

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

offsetUnset

Removes the given offset and its value from the array.

public offsetUnset(array-key $offset): void

Parameters:

Parameter	Type	Description
`$offset`	array-key	The offset to remove from the array.

See Also:

http://php.net/manual/en/arrayaccess.offsetunset.php - ArrayAccess::offsetUnset()

serialize

Returns a serialized string representation of this array object.

public serialize(): string

Warning: this method is deprecated. This means that this method will likely be removed in a future version.

Return Value:

a PHP serialized string.

See Also:

http://php.net/manual/en/serializable.serialize.php - Serializable::serialize()

__serialize

Returns data suitable for PHP serialization.

public __serialize(): array&lt;array-key,\Ramsey\Collection\T&gt;

See Also:

https://www.php.net/manual/en/language.oop5.magic.php#language.oop5.magic.serialize - * https://www.php.net/serialize -

unserialize

Converts a serialized string representation into an instance object.

public unserialize(string $serialized): void

Warning: this method is deprecated. This means that this method will likely be removed in a future version.

Parameters:

Parameter	Type	Description
`$serialized`	string	A PHP serialized string to unserialize.

See Also:

http://php.net/manual/en/serializable.unserialize.php - Serializable::unserialize()

__unserialize

Adds unserialized data to the object.

public __unserialize(array&lt;array-key,\Ramsey\Collection\T&gt; $data): void

Parameters:

Parameter	Type	Description
`$data`	array

count

Returns the number of items in this array.

public count(): int

See Also:

http://php.net/manual/en/countable.count.php - Countable::count()

clear

Removes all items from this array.

public clear(): void

toArray

Returns a native PHP array representation of this array object.

public toArray(): array&lt;array-key,\Ramsey\Collection\T&gt;

isEmpty

Returns true if this array is empty.

public isEmpty(): bool

containsKey

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

public containsKey(mixed $key): bool

Parameters:

Parameter	Type	Description
`$key`	mixed	The key to check in the map.

containsValue

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

public containsValue(mixed $value): bool

Parameters:

Parameter	Type	Description
`$value`	mixed	The value to check in the map.

keys

Return an array of the keys contained in this map.

public keys(): list&lt;array-key&gt;

get

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.

public get(mixed $key, mixed $defaultValue = null): \Ramsey\Collection\Map\T|null

Parameters:

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

Return Value:

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

put

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

public put(mixed $key, mixed $value): \Ramsey\Collection\Map\T|null

Parameters:

Parameter	Type	Description
`$key`	mixed	The key to put or replace in the map.
`$value`	mixed	The value to store at `$key`.

Return Value:

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

putIfAbsent

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

public putIfAbsent(mixed $key, mixed $value): \Ramsey\Collection\Map\T|null

Parameters:

Parameter	Type	Description
`$key`	mixed	The key to put in the map.
`$value`	mixed	The value to store at `$key`.

Return Value:

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

remove

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

public remove(mixed $key): \Ramsey\Collection\Map\T|null

Parameters:

Parameter	Type	Description
`$key`	mixed	The key to remove from the map.

Return Value:

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

removeIf

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

public removeIf(mixed $key, mixed $value): bool

Parameters:

Parameter	Type	Description
`$key`	mixed	The key to remove from the map.
`$value`	mixed	The value to match.

Return Value:

true if the value was removed.

replace

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

public replace(mixed $key, mixed $value): \Ramsey\Collection\Map\T|null

Parameters:

Parameter	Type	Description
`$key`	mixed	The key to replace.
`$value`	mixed	The value to set at `$key`.

Return Value:

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

replaceIf

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

public replaceIf(mixed $key, mixed $oldValue, mixed $newValue): bool

Parameters:

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

Return Value:

true if the value was replaced.

toolValueToString

Returns a string representation of the value.

protected toolValueToString(mixed $value): string

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:

Parameter	Type	Description
`$value`	mixed	the value to return as a string.

checkType

Returns true if value is of the specified type.

protected checkType(string $type, mixed $value): bool

Parameters:

Parameter	Type	Description
`$type`	string	The type to check the value against.
`$value`	mixed	The value to check.

Automatically generated on 2025-03-18