Entries
in package
Uses
NotInstanciable
Functions on Entry.
Tags
Table of Contents
Methods
- baseEntriesOf() : Iterator<K, V>
- Maps each entry to get its base value.
- baseValueOf() : V
- Gets the base value of an interpolation value, or the value itself if not an interpolation.
- consumeEntry() : Consumer<mixed, mixed>
- Constructs a consumer from a closure.
- entriesOf() : Iterator<K, V|Interpolation<string|int, V>>
- Maps each entry to get its base|raw|interpolated value according to a reading mode.
- interpolatedEntriesOf() : Iterator<K, V|Interpolation<string|int, V>>
- Maps each entry to get its interpolated value.
- interpolatedValueOf() : V
- Gets the interpolation of an Interpolation value, or the value itself if not an interpolation.
- mapAsConsumer() : Consumer<K, V>
- Transforms a value mapping to a consumer.
- mapEntry() : MapKey|MapValue<mixed, mixed>
- Constructs an entry mapping from an entry mapping closure.
- mapKey() : MapKey<mixed, mixed>
- Constructs a MapKey from a key mapping closure.
- mapKeyFromValue() : MapKey<mixed, mixed>
- Constructs a MapKey from a value mapping closure.
- mapValue() : MapValue<mixed, mixed>
- Constructs a MapValue from a value mapping closure.
- mapValueFromKey() : MapValue<mixed, mixed>
- Constructs a MapValue from a key mapping closure.
- valueOf() : V|Interpolation<string|int, V>
- Gets a value from a raw value according to a reading mode.
Methods
baseEntriesOf()
Maps each entry to get its base value.
public
static baseEntriesOf(iterable<K, V|Interpolation<string|int, V>> $rawEntries) : Iterator<K, V>
Parameters
- $rawEntries : iterable<K, V|Interpolation<string|int, V>>
-
A sequence of raw entries.
Tags
Return values
Iterator<K, V> —The sequence of base values.
baseValueOf()
Gets the base value of an interpolation value, or the value itself if not an interpolation.
public
static baseValueOf(Interpolation<string|int, V>|V $rawValue) : V
Parameters
- $rawValue : Interpolation<string|int, V>|V
-
A raw value.
Tags
Return values
V —The base value.
consumeEntry()
Constructs a consumer from a closure.
public
static consumeEntry(Closure $consumer) : Consumer<mixed, mixed>
Parameters
- $consumer : Closure
-
- $consumer(Configuration<K,V>, K $key, V $value):void
Return values
Consumer<mixed, mixed> —A consumer.
entriesOf()
Maps each entry to get its base|raw|interpolated value according to a reading mode.
public
static entriesOf(Iterator<K, V|Interpolation<string|int, V>> $rawEntries, Configuration<K, V> $config[, ReadingMode $mode = ReadingMode::Normal ]) : Iterator<K, V|Interpolation<string|int, V>>
Parameters
- $rawEntries : Iterator<K, V|Interpolation<string|int, V>>
-
A sequence of raw entries.
- $config : Configuration<K, V>
-
The configuration where the values belongs to.
- $mode : ReadingMode = ReadingMode::Normal
-
The reading mode to use.
Tags
Return values
Iterator<K, V|Interpolation<string|int, V>> —The sequence of values.
interpolatedEntriesOf()
Maps each entry to get its interpolated value.
public
static interpolatedEntriesOf(iterable<K, V|Interpolation<string|int, V>> $rawEntries, Configuration<K, V> $config) : Iterator<K, V|Interpolation<string|int, V>>
Parameters
- $rawEntries : iterable<K, V|Interpolation<string|int, V>>
-
A sequence of raw entries.
- $config : Configuration<K, V>
-
The configuration where the values belongs to.
Tags
Return values
Iterator<K, V|Interpolation<string|int, V>> —The sequence of interpolated values.
interpolatedValueOf()
Gets the interpolation of an Interpolation value, or the value itself if not an interpolation.
public
static interpolatedValueOf(Interpolation<string|int, V>|V $rawValue, Configuration<mixed, V> $config) : V
Parameters
- $rawValue : Interpolation<string|int, V>|V
-
A raw value to interpolate.
- $config : Configuration<mixed, V>
-
The configuration where the value belongs to.
Tags
Return values
V —The interpolated value.
mapAsConsumer()
Transforms a value mapping to a consumer.
public
static mapAsConsumer(Map<MK, MV> $map) : Consumer<K, V>
The Entry returned by the initial mapping is then unused.
Parameters
- $map : Map<MK, MV>
-
An entry mapper.
Tags
Return values
Consumer<K, V>mapEntry()
Constructs an entry mapping from an entry mapping closure.
public
static mapEntry(Closure $map) : MapKey|MapValue<mixed, mixed>
Parameters
- $map : Closure
-
- $consumer(K $key, V $value, Configuration<K,V>): Entry
Return values
MapKey|MapValue<mixed, mixed> —A consumer.
mapKey()
Constructs a MapKey from a key mapping closure.
public
static mapKey(Closure $map) : MapKey<mixed, mixed>
Parameters
- $map : Closure
-
- $consumer(K $key, Configuration<K,V>): Entry
Return values
MapKey<mixed, mixed> —A key mapping.
mapKeyFromValue()
Constructs a MapKey from a value mapping closure.
public
static mapKeyFromValue(Closure $map) : MapKey<mixed, mixed>
Parameters
- $map : Closure
-
- $consumer(V $value, K $key, Configuration<K,V>): Entry
Return values
MapKey<mixed, mixed> —A key mapping.
mapValue()
Constructs a MapValue from a value mapping closure.
public
static mapValue(Closure $map) : MapValue<mixed, mixed>
Parameters
- $map : Closure
-
- $consumer(V $value, K $key, Configuration<K,V>): Entry
Return values
MapValue<mixed, mixed> —A value mapping.
mapValueFromKey()
Constructs a MapValue from a key mapping closure.
public
static mapValueFromKey(Closure $map) : MapValue<mixed, mixed>
Parameters
- $map : Closure
-
- $consumer(K $key, Configuration<K,V>): Entry
Return values
MapValue<mixed, mixed> —A value mapping.
valueOf()
Gets a value from a raw value according to a reading mode.
public
static valueOf(V $rawValue, Configuration<K, V> $config[, ReadingMode $mode = ReadingMode::Normal ]) : V|Interpolation<string|int, V>
Parameters
- $rawValue : V
-
A raw value to interpolate.
- $config : Configuration<K, V>
-
The configuration where the value belongs to.
- $mode : ReadingMode = ReadingMode::Normal
-
The reading mode to use.
Tags
Return values
V|Interpolation<string|int, V> —The value.