\Pop\ModuleAbstractModule

Abstract module class

Summary

Methods
Properties
Constants
config()
registerConfig()
addConfigValue()
updateConfigValue()
deleteConfigValue()
mergeConfig()
setName()
getName()
hasName()
setVersion()
getVersion()
hasVersion()
application()
isRegistered()
register()
No public properties found
No constants found
No protected methods found
$config
$application
$name
$version
N/A
No private methods found
No private properties found
N/A

Properties

$config

$config : mixed

Application config

Type

mixed

$application

$application : \Pop\Application

Application

Type

\Pop\Application

$name

$name : string

Module name

Type

string

$version

$version : string

Module version

Type

string

Methods

config()

config() : mixed

Access application config

Returns

mixed

registerConfig()

registerConfig(mixed  $config) : \Pop\AbstractApplication

Register a new configuration with the application

Parameters

mixed $config

Throws

\InvalidArgumentException

Returns

\Pop\AbstractApplication

addConfigValue()

addConfigValue(string  $name, string  $value) : \Pop\AbstractApplication

Add new value to config

Parameters

string $name
string $value

Returns

\Pop\AbstractApplication

updateConfigValue()

updateConfigValue(string  $name, string  $value) : \Pop\AbstractApplication

Update existing value in config

Parameters

string $name
string $value

Returns

\Pop\AbstractApplication

deleteConfigValue()

deleteConfigValue(string  $name) : \Pop\AbstractApplication

Replace existing value in config

Parameters

string $name

Returns

\Pop\AbstractApplication

mergeConfig()

mergeConfig(mixed  $config, boolean  $preserve = false) : \Pop\AbstractApplication

Merge new or altered config values with the existing config values

Parameters

mixed $config
boolean $preserve

Throws

\Pop\Config\Exception

Returns

\Pop\AbstractApplication

setName()

setName(string  $name) : \Pop\Module\AbstractModule

Set module name

Parameters

string $name

Returns

\Pop\Module\AbstractModule

getName()

getName() : string

Get module name

Returns

string

hasName()

hasName() : boolean

Determine if module has name

Returns

boolean

setVersion()

setVersion(string  $version) : \Pop\Module\AbstractModule

Set module version

Parameters

string $version

Returns

\Pop\Module\AbstractModule

getVersion()

getVersion() : string

Get module version

Returns

string

hasVersion()

hasVersion() : boolean

Determine if module has version

Returns

boolean

application()

application() : \Pop\Application

Get application

Returns

\Pop\Application

isRegistered()

isRegistered() : boolean

Determine if the module has been registered with an application object

Returns

boolean