Constants

VERSION

VERSION = '1.3.0' : string

Application version

Properties

$application

$application : \Pop\Application

Application

Type

\Pop\Application

$name

$name : string

Module name

Type

string

$version

$version : string

Module version

Type

string

$config

$config : mixed

Application config

Type

mixed

Methods

__construct()

__construct() 

Constructor

Instantiate a module object

Optional parameters are an application instance or a configuration object or array

__set()

__set(string  $name, mixed  $value) : \Pop\Module\Module

Set a pre-designated value in the module object

Parameters

string $name
mixed $value

Returns

\Pop\Module\Module

__get()

__get(string  $name) : mixed

Get a pre-designated value from the module object

Parameters

string $name

Returns

mixed

__isset()

__isset(string  $name) : boolean

Determine if a pre-designated value in the module object exists

Parameters

string $name

Returns

boolean

__unset()

__unset(string  $name) : \Pop\Module\Module

Unset a pre-designated value in the module object

Parameters

string $name

Returns

\Pop\Module\Module

offsetSet()

offsetSet(string  $offset, mixed  $value) : \Pop\Module\Module

Set a value in the array

Parameters

string $offset
mixed $value

Returns

\Pop\Module\Module

offsetGet()

offsetGet(string  $offset) : mixed

Get a value from the array

Parameters

string $offset

Returns

mixed

offsetExists()

offsetExists(string  $offset) : boolean

Determine if a value exists

Parameters

string $offset

Returns

boolean

offsetUnset()

offsetUnset(string  $offset) : \Pop\Module\Module

Unset a value from the array

Parameters

string $offset

Returns

\Pop\Module\Module

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

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

cliError()

cliError(\Exception  $exception) : void

CLI error handler method

Parameters

\Exception $exception