1. class
  2. Michaels
  3. Manager
  4. IocManager

IocManager

class IocManager implements ManagesItemsInterface, ContainerInterface, IocManagerInterface

Manages deeply nested, complex data.

This concrete class implements ManagesItems and ChainsNestedItems as well as Container interoperability and various array functionality.

Traits

ManagesItemsTrait
Manages complex, nested data
ManagesIocTrait
Manages complex, nested data
DependsOnManagesItemsTrait

Methods

$this
initManager(array $items = null)

Initializes a new manager instance.

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

Hydrate with external data, optionally append

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

Adds a single item.

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

Updates an item

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

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

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

Get a single item

from DependsOnManagesItemsTrait
mixed
getRaw(string $alias, string $fallback = '_michaels_no_fallback')

Get a single item

from ManagesItemsTrait
NoItemFoundMessage
getIfExists($alias)

Return an item if it exist

from DependsOnManagesItemsTrait
NoItemFoundMessage
getIfHas($alias)

Return an item if it exist Alias of getIfExists()

from DependsOnManagesItemsTrait
array
getAll()

Return all items as array

from DependsOnManagesItemsTrait
array
all()

Return all items as array Alias of getAll()

from DependsOnManagesItemsTrait
bool
exists($alias)

Confirm or deny that an item exists

from DependsOnManagesItemsTrait
bool
has($alias)

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

from DependsOnManagesItemsTrait
boolean
isEmpty()

Confirm that manager has no items

from DependsOnManagesItemsTrait
$this
remove($alias)

Deletes an item

from DependsOnManagesItemsTrait
$this
clear()

Clear the manager

from DependsOnManagesItemsTrait
mixed
reset(array $items)

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

from DependsOnManagesItemsTrait
$this
protect($item)

Guard an alias from being modified

from ManagesItemsTrait
$this
loadDefaults(array $defaults)

Merge a set of defaults with the current items

from ManagesItemsTrait
string
getItemsName()

Returns the name of the property that holds data items

from ManagesItemsTrait
$this
setItemsName($nameOfItemsRepository)

Sets the name of the property that holds data items

from ManagesItemsTrait
string
toJson(int $options)

Get the collection of items as JSON.

from DependsOnManagesItemsTrait
string
__toString()

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

from DependsOnManagesItemsTrait
mixed
fetch(string $alias, string|mixed $fallback = '_michaels_no_fallback')

Alias of get() for backwards comparability

from ManagesIocTrait
mixed
share($alias)

Turns a dependency into a singleton.

from ManagesIocTrait
$this
setup($alias, $pipeline)

Add a pipeline to to the que

from ManagesIocTrait
__construct(array $items = array())

Build a new manager instance

Details

in DependsOnManagesItemsTrait at line line 15
abstract $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

in DependsOnManagesItemsTrait at line line 24
abstract $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

in DependsOnManagesItemsTrait at line line 36
abstract $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

Return Value

$this

in DependsOnManagesItemsTrait at line line 46
abstract $this set(string $alias, null $item = null)

Updates an item

Parameters

string $alias
null $item

Return Value

$this

in DependsOnManagesItemsTrait at line line 56
abstract 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 apend

Return Value

int Number of items pushed

Exceptions

ItemNotFoundException If pushing to unset array

in DependsOnManagesItemsTrait at line line 66
abstract 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

in ManagesItemsTrait at line line 214
mixed getRaw(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

in DependsOnManagesItemsTrait at line line 73
abstract NoItemFoundMessage getIfExists($alias)

Return an item if it exist

Parameters

$alias

Return Value

NoItemFoundMessage

in DependsOnManagesItemsTrait at line line 82
abstract NoItemFoundMessage getIfHas($alias)

Return an item if it exist Alias of getIfExists()

Parameters

$alias

Return Value

NoItemFoundMessage

in DependsOnManagesItemsTrait at line line 89
abstract array getAll()

Return all items as array

Return Value

array

in DependsOnManagesItemsTrait at line line 96
abstract array all()

Return all items as array Alias of getAll()

Return Value

array

in DependsOnManagesItemsTrait at line line 104
abstract bool exists($alias)

Confirm or deny that an item exists

Parameters

$alias

Return Value

bool

in DependsOnManagesItemsTrait at line line 113
abstract bool has($alias)

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

Parameters

$alias

Return Value

bool

in DependsOnManagesItemsTrait at line line 119
abstract boolean isEmpty()

Confirm that manager has no items

Return Value

boolean

in DependsOnManagesItemsTrait at line line 127
abstract $this remove($alias)

Deletes an item

Parameters

$alias

Return Value

$this

in DependsOnManagesItemsTrait at line line 133
abstract $this clear()

Clear the manager

Return Value

$this

in DependsOnManagesItemsTrait at line line 142
abstract mixed reset(array $items)

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

Parameters

array $items

Return Value

mixed

in ManagesItemsTrait at line line 376
$this protect($item)

Guard an alias from being modified

Parameters

$item

Return Value

$this

in ManagesItemsTrait at line line 387
$this loadDefaults(array $defaults)

Merge a set of defaults with the current items

Parameters

array $defaults

Return Value

$this

in ManagesItemsTrait at line line 397
string getItemsName()

Returns the name of the property that holds data items

Return Value

string

in ManagesItemsTrait at line line 407
$this setItemsName($nameOfItemsRepository)

Sets the name of the property that holds data items

Parameters

$nameOfItemsRepository

Return Value

$this

in DependsOnManagesItemsTrait at line line 150
abstract string toJson(int $options)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

in DependsOnManagesItemsTrait at line line 156
abstract string __toString()

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

Return Value

string

in ManagesIocTrait at line line 69
mixed fetch(string $alias, string|mixed $fallback = '_michaels_no_fallback')

Alias of get() for backwards comparability

Parameters

string $alias
string|mixed $fallback

Return Value

mixed

Exceptions

Exception

in ManagesIocTrait at line line 118
mixed share($alias)

Turns a dependency into a singleton.

Parameters

$alias

Return Value

mixed

in ManagesIocTrait at line line 130
$this setup($alias, $pipeline)

Add a pipeline to to the que

Parameters

$alias
$pipeline

Return Value

$this

at line line 29
__construct(array $items = array())

Build a new manager instance

Parameters

array $items