Documentation

WaiterConfig extends Collection
in package

Application

Configuration info of a waiter object

Constants

DESCRIPTION = 'description'
FAILURE_PATH = 'failure.path'
FAILURE_TYPE = 'failure.type'
FAILURE_VALUE = 'failure.value'
IGNORE_ERRORS = 'ignore_errors'
INTERVAL = 'interval'
MAX_ATTEMPTS = 'max_attempts'
OPERATION = 'operation'
SUCCESS_PATH = 'success.path'
SUCCESS_TYPE = 'success.type'
SUCCESS_VALUE = 'success.value'
WAITER_NAME = 'name'

Properties

$data : array<string|int, mixed>

Methods

__construct() : mixed
add() : Collection: Add a value to a key. If a key of the same name has already been added, the key value will be converted into an array and the new value will be pushed to the end of the array.
clear() : Collection: Removes all key value pairs
count() : mixed
filter() : Collection: Iterates over each key value pair in the collection passing them to the Closure. If the Closure function returns true, the current value from input is returned into the result Collection. The Closure must accept three parameters: (string) $key, (string) $value and return Boolean TRUE or FALSE for each value.
fromConfig() : self: Create a new collection from an array, validate the keys, and add default values where missing
get() : mixed|null: Get a specific key value.
getAll() : array<string|int, mixed>: Get all or a subset of matching key value pairs
getIterator() : mixed
getKeys() : array<string|int, mixed>: Get all keys in the collection
getPath() : mixed|null: Gets a value from the collection using an array path (e.g. foo/baz/bar would retrieve bar from two nested arrays) Allows for wildcard searches which recursively combine matches up to the level at which the wildcard occurs. This can be useful for accepting any key of a sub-array and combining matching keys from each diverging path.
hasKey() : bool: Returns whether or not the specified key is present.
hasValue() : mixed: Checks if any keys contains a certain value
inject() : string: Inject configuration settings into an input string
keySearch() : bool|string: Case insensitive search the keys in the collection
map() : Collection: Returns a Collection containing all the elements of the collection after applying the callback function to each one. The Closure should accept three parameters: (string) $key, (string) $value, (array) $context and return a modified value
merge() : Collection: Add and merge in a Collection or array of key value pair data.
offsetExists() : mixed
offsetGet() : mixed
offsetSet() : mixed
offsetUnset() : mixed
overwriteWith() : self: Over write key value pairs in this collection with all of the data from an array or collection.
remove() : Collection: Remove a specific key value pair
replace() : Collection: Replace the data of the object with the value of an array
set() : Collection: Set a key value pair
setPath() : self: Set a value into a nested array key. Keys will be created as needed to set the value.
toArray() : array<string|int, mixed>: Get the array representation of an object
extractConfig() : mixed: Create the command configuration variables

DESCRIPTION


    public
        mixed
    DESCRIPTION
    = 'description'

FAILURE_PATH


    public
        mixed
    FAILURE_PATH
    = 'failure.path'

FAILURE_TYPE


    public
        mixed
    FAILURE_TYPE
    = 'failure.type'

FAILURE_VALUE


    public
        mixed
    FAILURE_VALUE
    = 'failure.value'

IGNORE_ERRORS


    public
        mixed
    IGNORE_ERRORS
    = 'ignore_errors'

INTERVAL


    public
        mixed
    INTERVAL
    = 'interval'

MAX_ATTEMPTS


    public
        mixed
    MAX_ATTEMPTS
    = 'max_attempts'

OPERATION


    public
        mixed
    OPERATION
    = 'operation'

SUCCESS_PATH


    public
        mixed
    SUCCESS_PATH
    = 'success.path'

SUCCESS_TYPE


    public
        mixed
    SUCCESS_TYPE
    = 'success.type'

SUCCESS_VALUE


    public
        mixed
    SUCCESS_VALUE
    = 'success.value'

WAITER_NAME


    public
        mixed
    WAITER_NAME
    = 'name'

$data


    protected
        array<string|int, mixed>
    $data

Data associated with the object.

__construct()


    public
                    __construct([array<string|int, mixed> $data = array() ]) : mixed

Parameters

$data : array<string|int, mixed> = array(): Array of configuration directives

add()

Add a value to a key. If a key of the same name has already been added, the key value will be converted into an array and the new value will be pushed to the end of the array.


    public
                    add(string $key, mixed $value) : Collection

Parameters

$key : string: Key to add
$value : mixed: Value to add to the key

Return values

Collection —

Returns a reference to the object.

clear()

Removes all key value pairs


    public
                    clear() : Collection

Return values

Collection

count()


    public
                    count() : mixed

#[ReturnTypeWillChange]

filter()

Iterates over each key value pair in the collection passing them to the Closure. If the Closure function returns true, the current value from input is returned into the result Collection. The Closure must accept three parameters: (string) $key, (string) $value and return Boolean TRUE or FALSE for each value.


    public
                    filter(Closure $closure[, bool $static = true ]) : Collection

Parameters

$closure : Closure: Closure evaluation function
$static : bool = true: Set to TRUE to use the same class as the return rather than returning a Collection

Return values

Collection

fromConfig()

Create a new collection from an array, validate the keys, and add default values where missing


    public
            static        fromConfig([array<string|int, mixed> $config = array() ][, array<string|int, mixed> $defaults = array() ][, array<string|int, mixed> $required = array() ]) : self

Parameters

$config : array<string|int, mixed> = array(): Configuration values to apply.
$defaults : array<string|int, mixed> = array(): Default parameters
$required : array<string|int, mixed> = array(): Required parameter names

Return values

self

get()

Get a specific key value.


    public
                    get(string $key) : mixed|null

Parameters

$key : string: Key to retrieve.

Return values

mixed|null —

Value of the key or NULL

getAll()

Get all or a subset of matching key value pairs


    public
                    getAll([array<string|int, mixed> $keys = null ]) : array<string|int, mixed>

Parameters

$keys : array<string|int, mixed> = null: Pass an array of keys to retrieve only a subset of key value pairs

Return values

array<string|int, mixed> —

Returns an array of all matching key value pairs

getIterator()


    public
                    getIterator() : mixed

#[ReturnTypeWillChange]

getKeys()

Get all keys in the collection


    public
                    getKeys() : array<string|int, mixed>

Return values

array<string|int, mixed>

getPath()

Gets a value from the collection using an array path (e.g. foo/baz/bar would retrieve bar from two nested arrays) Allows for wildcard searches which recursively combine matches up to the level at which the wildcard occurs. This can be useful for accepting any key of a sub-array and combining matching keys from each diverging path.


    public
                    getPath(string $path[, string $separator = '/' ][, mixed $data = null ]) : mixed|null

Parameters

$path : string: Path to traverse and retrieve a value from
$separator : string = '/': Character used to add depth to the search
$data : mixed = null: Optional data to descend into (used when wildcards are encountered)

Return values

mixed|null

hasKey()

Returns whether or not the specified key is present.


    public
                    hasKey(string $key) : bool

Parameters

$key : string: The key for which to check the existence.

Return values

bool

hasValue()

Checks if any keys contains a certain value


    public
                    hasValue(string $value) : mixed

Parameters

$value : string: Value to search for

Return values

mixed —

Returns the key if the value was found FALSE if the value was not found.

inject()

Inject configuration settings into an input string


    public
                    inject(string $input) : string

Parameters

$input : string: Input to inject

Return values

string

keySearch()

Case insensitive search the keys in the collection


    public
                    keySearch(string $key) : bool|string

Parameters

$key : string: Key to search for

Return values

bool|string —

Returns false if not found, otherwise returns the key

map()

Returns a Collection containing all the elements of the collection after applying the callback function to each one. The Closure should accept three parameters: (string) $key, (string) $value, (array) $context and return a modified value


    public
                    map(Closure $closure[, array<string|int, mixed> $context = array() ][, bool $static = true ]) : Collection

Parameters

$closure : Closure: Closure to apply
$context : array<string|int, mixed> = array(): Context to pass to the closure
$static : bool = true: Set to TRUE to use the same class as the return rather than returning a Collection

Return values

Collection

merge()

Add and merge in a Collection or array of key value pair data.


    public
                    merge(Collection|array<string|int, mixed> $data) : Collection

Parameters

$data : Collection|array<string|int, mixed>: Associative array of key value pair data

Return values

Collection —

Returns a reference to the object.

offsetExists()


    public
                    offsetExists(mixed $offset) : mixed

Parameters

$offset : mixed

#[ReturnTypeWillChange]

offsetGet()


    public
                    offsetGet(mixed $offset) : mixed

Parameters

$offset : mixed

#[ReturnTypeWillChange]

offsetSet()


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

Parameters

$offset : mixed
$value : mixed

#[ReturnTypeWillChange]

offsetUnset()


    public
                    offsetUnset(mixed $offset) : mixed

Parameters

$offset : mixed

#[ReturnTypeWillChange]

overwriteWith()

Over write key value pairs in this collection with all of the data from an array or collection.


    public
                    overwriteWith(array<string|int, mixed>|Traversable $data) : self

Parameters

$data : array<string|int, mixed>|Traversable: Values to override over this config

Return values

self

remove()

Remove a specific key value pair


    public
                    remove(string $key) : Collection

Parameters

$key : string: A key to remove

Return values

Collection

replace()

Replace the data of the object with the value of an array


    public
                    replace(array<string|int, mixed> $data) : Collection

Parameters

$data : array<string|int, mixed>: Associative array of data

Return values

Collection —

Returns a reference to the object

set()

Set a key value pair


    public
                    set(string $key, mixed $value) : Collection

Parameters

$key : string: Key to set
$value : mixed: Value to set

Return values

Collection —

Returns a reference to the object

setPath()

Set a value into a nested array key. Keys will be created as needed to set the value.


    public
                    setPath(string $path, mixed $value) : self

Parameters

$path : string: Path to set
$value : mixed: Value to set at the key

Return values

self

toArray()

Get the array representation of an object


    public
                    toArray() : array<string|int, mixed>

Return values

array<string|int, mixed>

extractConfig()

Create the command configuration variables


    protected
                    extractConfig() : mixed

WaiterConfig extends Collection in package Application

Table of Contents

Constants

Properties

Methods

Constants

DESCRIPTION

FAILURE_PATH

FAILURE_TYPE

FAILURE_VALUE

IGNORE_ERRORS

INTERVAL

MAX_ATTEMPTS

OPERATION

SUCCESS_PATH

SUCCESS_TYPE

SUCCESS_VALUE

WAITER_NAME

Properties

$data

Methods

__construct()

Parameters

add()

Parameters

Return values

clear()

Return values

count()

Attributes

filter()

Parameters

Return values

fromConfig()

Parameters

Tags

Return values

get()

Parameters

Return values

getAll()

Parameters

Return values

getIterator()

Attributes

getKeys()

Return values

getPath()

Parameters

Return values

hasKey()

Parameters

Return values

hasValue()

Parameters

Return values

inject()

Parameters

Return values

keySearch()

Parameters

Return values

map()

Parameters

WaiterConfig extends Collection
in package

Application