1. interface
  2. Michaels
  3. Manager
  4. Contracts
  5. ManagesItemsInterface

ManagesItemsInterface

interface ManagesItemsInterface

API Methods for managing items

See src/Traits/ManagesItemsTrait.php for implementation example

Methods

$this
initManager(array $items = null)

Initializes a new manager instance.

$this
hydrate($data, bool $append = false)

Hydrate with external data, optionally append

$this
add(string $alias, mixed $item = null, array $options = null)

Adds a single item.

$this
set(string $alias, null $item = null)

Updates an item

int
push(string $alias, mixed $value, null|mixed $other = null)

Push a value or values onto the end of an array inside manager

mixed
get(string $alias, string $fallback = '_michaels_no_fallback')

Get a single item

NoItemFoundMessage
getIfExists($alias)

Return an item if it exist

NoItemFoundMessage
getIfHas($alias)

Return an item if it exist Alias of getIfExists()

array
getAll()

Return all items as array

array
all()

Return all items as array Alias of getAll()

bool
exists($alias)

Confirm or deny that an item exists

bool
has($alias)

Confirm or deny that an item exists Alias of exists()

boolean
isEmpty()

Confirm that manager has no items

$this
remove($alias)

Deletes an item

$this
clear()

Clear the manager

mixed
reset(array $items)

Reset the manager with an array of items Alias of initManager()

string
toJson(int $options)

Get the collection of items as JSON.

string
__toString()

When manager instance is used as a string, return json of items

Details

at line line 20
$this initManager(array $items = null)

Initializes a new manager instance.

This is useful for implementations that have their own __construct method This is an alias for reset()

Parameters

array $items

Return Value

$this

at line line 29
$this hydrate($data, bool $append = false)

Hydrate with external data, optionally append

Parameters

$data string The data to be hydrated into the manager
bool $append When true, data will be appended to the current set

Return Value

$this

at line line 41
$this add(string $alias, mixed $item = null, array $options = null)

Adds a single item.

Allow for dot notation (one.two.three) and item nesting.

Parameters

string $alias Key to be stored
mixed $item Value to be stored
array $options Only used for some extra features

Return Value

$this

at line line 51
$this set(string $alias, null $item = null)

Updates an item

Parameters

string $alias
null $item

Return Value

$this

at line line 61
int push(string $alias, mixed $value, null|mixed $other = null)

Push a value or values onto the end of an array inside manager

Parameters

string $alias The level of nested data
mixed $value The first value to append
null|mixed $other Optional other values to amend

Return Value

int Number of items pushed

Exceptions

ItemNotFoundException If pushing to unset array

at line line 71
mixed get(string $alias, string $fallback = '_michaels_no_fallback')

Get a single item

Parameters

string $alias
string $fallback Defaults to 'michaelsno_fallback' so null can be a fallback

Return Value

mixed

Exceptions

ItemNotFoundException If item not found

at line line 78
NoItemFoundMessage getIfExists($alias)

Return an item if it exist

Parameters

$alias

Return Value

NoItemFoundMessage

at line line 87
NoItemFoundMessage getIfHas($alias)

Return an item if it exist Alias of getIfExists()

Parameters

$alias

Return Value

NoItemFoundMessage

at line line 94
array getAll()

Return all items as array

Return Value

array

at line line 101
array all()

Return all items as array Alias of getAll()

Return Value

array

at line line 109
bool exists($alias)

Confirm or deny that an item exists

Parameters

$alias

Return Value

bool

at line line 118
bool has($alias)

Confirm or deny that an item exists Alias of exists()

Parameters

$alias

Return Value

bool

at line line 124
boolean isEmpty()

Confirm that manager has no items

Return Value

boolean

at line line 132
$this remove($alias)

Deletes an item

Parameters

$alias

Return Value

$this

at line line 138
$this clear()

Clear the manager

Return Value

$this

at line line 147
mixed reset(array $items)

Reset the manager with an array of items Alias of initManager()

Parameters

array $items

Return Value

mixed

at line line 155
string toJson(int $options)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

at line line 161
string __toString()

When manager instance is used as a string, return json of items

Return Value

string