Documentation

Module extends AbstractModule
in package
implements ArrayAccess

Pop module class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.2.0

Table of Contents

Interfaces

ArrayAccess

Properties

$config  : mixed
$application  : Application|null
Application
$config  : mixed
Application config
$name  : string|null
Name
$version  : string|null
Version

Methods

__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()  : void
Set a pre-designated value in the module object
__unset()  : void
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 name
getVersion()  : string
Get version
hasName()  : bool
Determine if the name is set
hasVersion()  : bool
Determine if version has been set
isRegistered()  : bool
Determine if the module has been registered with an application object
load()  : AbstractApplication
Optional method that can be used to load custom operations/configurations for an application to run
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()  : void
Set a value in the array
offsetUnset()  : void
Unset a value from the array
register()  : static
Register module
registerConfig()  : AbstractApplication
Register a new configuration with the application
setName()  : static
Set name
setVersion()  : static
Set version
updateConfigValue()  : AbstractApplication
Update existing value in config

Properties

$config

public mixed $config

mixed

Methods

__construct()

Constructor

public __construct() : mixed

Instantiate a module object

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

__get()

Get a pre-designated value from the module object

public __get(string $name) : mixed
Parameters
$name : string

__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) : void
Parameters
$name : string
$value : mixed

__unset()

Unset a pre-designated value in the module object

public __unset(string $name) : void
Parameters
$name : string

hasVersion()

Determine if version has been set

public hasVersion() : bool
Return values
bool

isRegistered()

Determine if the module has been registered with an application object

public isRegistered() : bool
Return values
bool

offsetExists()

Determine if a value exists

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

Get a value from the array

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

offsetSet()

Set a value in the array

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

Unset a value from the array

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

setName()

Set name

public setName(string $name) : static
Parameters
$name : string
Return values
static

setVersion()

Set version

public setVersion(string $version) : static
Parameters
$version : string
Return values
static

        
On this page

Search results