MapWrap<`Tk`,`Tv`>

Provides convenience methods for getting values out of maps.

class MapWrap<Tk,Tv>

Copyright: 2015-2016 Appertly

License: Apache-2.0

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`?KeyedTraversable<Tk,Tv> $map`) Creates a new MapWrap.

Instance Methods

Public
Returns	Signature and Description
`bool`	`containsKey`(`Tk $key`) Whether the delegate map contains the key.
`?Tv`	`get`(`Tk $key`) Convenience method that delegates the Map's get
`ConstMap`<`Tk`,`Tv`>	`getMap`() Gets the original delegate map.
`mixed`	`nested`(`string $key`) Gets a value in nested maps.
`MapWrap`<`arraykey`,`mixed`>	`nestedw`(`string $key`) Gets a MapWrap in nested maps.
`Map`<`Tk`,`Tv`>	`sub`(`Tk $key`) Looks for a Map at the given key; automatically converts arrays.
`MapWrap`<`Tk`,`Tv`>	`subw`(`Tk $key`) Looks for a MapWrap at the given key; automatically converts arrays.
`string`	`trim`(`Tk $key`) Gets a value as a trimmed string.

Method Details

__construct

public function __construct(?KeyedTraversable<Tk,Tv> $map)

Creates a new MapWrap.

Parameters
Name	Type	Description
`$map`	`?KeyedTraversable`<`Tk`,`Tv`>	The Map to wrap

containsKey

public function containsKey(Tk $key)

Whether the delegate map contains the key.

Parameters
Name	Type	Description
`$key`	`Tk`	The key

Returns
Type	Description
`bool`	Whether this value is contained

get

public function get(Tk $key)

Convenience method that delegates the Map's get

Parameters
Name	Type	Description
`$key`	`Tk`

Returns
Type	Description
`?Tv`	The value found (or null)

getMap

public function getMap()

Gets the original delegate map.

Returns
Type	Description
`ConstMap`<`Tk`,`Tv`>	The original delegate map

nested

public function nested(string $key)

Gets a value in nested maps.

Parameters
Name	Type	Description
`$key`	`string`	The dot-separated key

Returns
Type	Description
`mixed`	The nested value

nestedw

public function nestedw(string $key)

Gets a MapWrap in nested maps.

Parameters
Name	Type	Description
`$key`	`string`	The dot-separated key

Returns
Type	Description
`MapWrap`<`arraykey`,`mixed`>	The nested MapWrap

sub

public function sub(Tk $key)

Looks for a Map at the given key; automatically converts arrays.

Parameters
Name	Type	Description
`$key`	`Tk`	The key

Returns
Type	Description
`Map`<`Tk`,`Tv`>	A map (potentially empty)

subw

public function subw(Tk $key)

Looks for a MapWrap at the given key; automatically converts arrays.

Parameters
Name	Type	Description
`$key`	`Tk`	The key

Returns
Type	Description
`MapWrap`<`Tk`,`Tv`>	A MapWrap (potentially empty)

trim

public function trim(Tk $key)

Gets a value as a trimmed string.

Parameters
Name	Type	Description
`$key`	`Tk`	The key

Returns
Type	Description
`string`	A trimmed string