Module
extends AbstractModule
in package
implements
ArrayAccess
Pop module class
Tags
Interfaces, Classes and Traits
- ArrayAccess
Table of Contents
- $application : Application
- Application
- $config : mixed
- Application config
- $name : string
- Module name
- $version : string
- Module version
- __construct() : mixed
- Constructor
- __get() : mixed
- Get a pre-designated value from the module object
- __isset() : bool
- Determine if a pre-designated value in the module object exists
- __set() : Module
- Set a pre-designated value in the module object
- __unset() : Module
- Unset a pre-designated value in the module object
- addConfigValue() : AbstractApplication
- Add new value to config
- application() : Application
- Get application
- config() : mixed
- Access application config
- deleteConfigValue() : AbstractApplication
- Replace existing value in config
- getName() : string
- Get module name
- getVersion() : string
- Get module version
- hasName() : bool
- Determine if module has name
- hasVersion() : bool
- Determine if module has version
- isRegistered() : bool
- Determine if the module has been registered with an application object
- mergeConfig() : AbstractApplication
- Merge new or altered config values with the existing config values
- offsetExists() : bool
- Determine if a value exists
- offsetGet() : mixed
- Get a value from the array
- offsetSet() : Module
- Set a value in the array
- offsetUnset() : Module
- Unset a value from the array
- register() : Module
- Register module
- registerConfig() : AbstractApplication
- Register a new configuration with the application
- setName() : AbstractModule
- Set module name
- setVersion() : AbstractModule
- Set module version
- updateConfigValue() : AbstractApplication
- Update existing value in config
Properties
$application
Application
protected
Application
$application
= null
$config
Application config
protected
mixed
$config
= null
$name
Module name
protected
string
$name
= null
$version
Module version
protected
string
$version
= null
Methods
__construct()
Constructor
public
__construct() : mixed
Instantiate a module object
Optional parameters are an application instance or a configuration object or array
Return values
mixed —__get()
Get a pre-designated value from the module object
public
__get(string $name) : mixed
Parameters
- $name : string
Return values
mixed —__isset()
Determine if a pre-designated value in the module object exists
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool —__set()
Set a pre-designated value in the module object
public
__set(string $name, mixed $value) : Module
Parameters
- $name : string
- $value : mixed
Return values
Module —__unset()
Unset a pre-designated value in the module object
public
__unset(string $name) : Module
Parameters
- $name : string
Return values
Module —addConfigValue()
Add new value to config
public
addConfigValue(string $name, string $value) : AbstractApplication
Parameters
- $name : string
- $value : string
Return values
AbstractApplication —application()
Get application
public
application() : Application
Return values
Application —config()
Access application config
public
config() : mixed
Return values
mixed —deleteConfigValue()
Replace existing value in config
public
deleteConfigValue(string $name) : AbstractApplication
Parameters
- $name : string
Return values
AbstractApplication —getName()
Get module name
public
getName() : string
Return values
string —getVersion()
Get module version
public
getVersion() : string
Return values
string —hasName()
Determine if module has name
public
hasName() : bool
Return values
bool —hasVersion()
Determine if module has version
public
hasVersion() : bool
Return values
bool —isRegistered()
Determine if the module has been registered with an application object
public
isRegistered() : bool
Return values
bool —mergeConfig()
Merge new or altered config values with the existing config values
public
mergeConfig(mixed $config[, bool $preserve = false ]) : AbstractApplication
Parameters
- $config : mixed
- $preserve : bool = false
Tags
Return values
AbstractApplication —offsetExists()
Determine if a value exists
public
offsetExists(string $offset) : bool
Parameters
- $offset : string
Return values
bool —offsetGet()
Get a value from the array
public
offsetGet(string $offset) : mixed
Parameters
- $offset : string
Return values
mixed —offsetSet()
Set a value in the array
public
offsetSet(string $offset, mixed $value) : Module
Parameters
- $offset : string
- $value : mixed
Return values
Module —offsetUnset()
Unset a value from the array
public
offsetUnset(string $offset) : Module
Parameters
- $offset : string
Return values
Module —register()
Register module
public
register(Application $application) : Module
Parameters
- $application : Application
Tags
Return values
Module —registerConfig()
Register a new configuration with the application
public
registerConfig(mixed $config) : AbstractApplication
Parameters
- $config : mixed
Tags
Return values
AbstractApplication —setName()
Set module name
public
setName(string $name) : AbstractModule
Parameters
- $name : string
Return values
AbstractModule —setVersion()
Set module version
public
setVersion(string $version) : AbstractModule
Parameters
- $version : string
Return values
AbstractModule —updateConfigValue()
Update existing value in config
public
updateConfigValue(string $name, string $value) : AbstractApplication
Parameters
- $name : string
- $value : string