Manager
in package
implements
ArrayAccess, Countable, IteratorAggregate
Module manager class
Tags
Interfaces, Classes and Traits
- ArrayAccess
- Countable
- IteratorAggregate
Table of Contents
- $modules : array<string|int, mixed>
- Modules
- __construct() : mixed
- Constructor
- __get() : Module
- Get a registered module
- __isset() : bool
- Determine if a module is registered with the manager object
- __set() : Manager
- Register a module with the manager
- __unset() : Manager
- Unregister a module with the manager
- count() : int
- Return count
- get() : mixed
- Get a module
- getIterator() : ArrayIterator
- Get iterator
- getModuleName() : string
- Get a module object's registered name
- hasModule() : bool
- Determine if a module object is registered with the manager by $module object comparison
- isRegistered() : bool
- Determine if a module object is registered with the manager by $name
- offsetExists() : bool
- Determine if a module is registered with the manager object
- offsetGet() : Module
- Get a registered module
- offsetSet() : Manager
- Register a module with the manager
- offsetUnset() : Manager
- Unregister a module with the manager
- register() : Manager
- Register a module object
- registerModules() : Manager
- Register module objects
- unregister() : Manager
- Unregister a module
Properties
$modules
Modules
protected
array<string|int, mixed>
$modules
= []
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $modules = null ]) : mixed
Instantiate the module manager object.
Parameters
- $modules : array<string|int, mixed> = null
Tags
Return values
mixed —__get()
Get a registered module
public
__get(string $name) : Module
Parameters
- $name : string
Return values
Module —__isset()
Determine if a module is registered with the manager object
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool —__set()
Register a module with the manager
public
__set(string $name, mixed $value) : Manager
Parameters
- $name : string
- $value : mixed
Tags
Return values
Manager —__unset()
Unregister a module with the manager
public
__unset(string $name) : Manager
Parameters
- $name : string
Return values
Manager —count()
Return count
public
count() : int
Return values
int —get()
Get a module
public
get(string $name) : mixed
Parameters
- $name : string
Return values
mixed —getIterator()
Get iterator
public
getIterator() : ArrayIterator
Return values
ArrayIterator —getModuleName()
Get a module object's registered name
public
getModuleName(ModuleInterface $module) : string
Parameters
- $module : ModuleInterface
Return values
string —hasModule()
Determine if a module object is registered with the manager by $module object comparison
public
hasModule(ModuleInterface $module) : bool
Parameters
- $module : ModuleInterface
Return values
bool —isRegistered()
Determine if a module object is registered with the manager by $name
public
isRegistered(string $name) : bool
Parameters
- $name : string
Return values
bool —offsetExists()
Determine if a module is registered with the manager object
public
offsetExists(string $offset) : bool
Parameters
- $offset : string
Return values
bool —offsetGet()
Get a registered module
public
offsetGet(string $offset) : Module
Parameters
- $offset : string
Return values
Module —offsetSet()
Register a module with the manager
public
offsetSet(string $offset, mixed $value) : Manager
Parameters
- $offset : string
- $value : mixed
Tags
Return values
Manager —offsetUnset()
Unregister a module with the manager
public
offsetUnset(string $offset) : Manager
Parameters
- $offset : string
Return values
Manager —register()
Register a module object
public
register(ModuleInterface $module) : Manager
Parameters
- $module : ModuleInterface
Tags
Return values
Manager —registerModules()
Register module objects
public
registerModules(array<string|int, mixed> $modules) : Manager
Parameters
- $modules : array<string|int, mixed>
Tags
Return values
Manager —unregister()
Unregister a module
public
unregister(string $name) : Manager
Parameters
- $name : string