API Documentation
\
Pop
Acl
Assertion
Audit
Adapter
Model
Auth
Bootstrap
Controller
Event
Model
Cache
Adapter
Code
Generator
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Parser
Record
Sql
Migration
Predicate
Schema
Debug
Handler
Storage
Dir
Dom
Event
Form
Element
Input
Select
Ftp
Http
Client
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Router
Match
Service
Session
Validator
View
Template
Popcorn

\Pop\ModuleModule

Pop module class

Summary

Methods
Properties
Constants
__construct()
setName()
getName()
hasName()
registerConfig()
register()
addConfigValue()
updateConfigValue()
deleteConfigValue()
mergeConfig()
application()
config()
isRegistered()
__set()
__get()
__isset()
__unset()
offsetSet()
offsetGet()
offsetExists()
offsetUnset()
No public properties found
No constants found
No protected methods found
$config
$application
$name
N/A
No private methods found
No private properties found
N/A

Properties

$config

$config : mixed

Module config

Type

mixed

$application

$application : \Pop\Application

Application

Type

\Pop\Application

$name

$name : string

Module name

Type

string

Methods

__construct()

__construct()

Constructor

Instantiate a module object

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

setName()

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

Set module name

Parameters

string $name

Returns

\Pop\Module\Module

getName()

getName() : string

Get module name

Returns

string

hasName()

hasName() : boolean

Determine if module has name

Returns

boolean

registerConfig()

registerConfig(mixed  $config) : \Pop\Module\Module

Register a configuration with the module object

Parameters

mixed $config

Throws

\InvalidArgumentException

Returns

\Pop\Module\Module

addConfigValue()

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

Add new value to config

Parameters

string $name
string $value

Returns

\Pop\Module\Module

updateConfigValue()

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

Update existing value in config

Parameters

string $name
string $value

Returns

\Pop\Module\Module

deleteConfigValue()

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

Replace existing value in config

Parameters

string $name

Returns

\Pop\Module\Module

mergeConfig()

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

Merge new or altered config values with the existing config values

Parameters

mixed $config
boolean $preserve

Returns

\Pop\Module\Module

application()

application() : \Pop\Application

Get application

Returns

\Pop\Application

config()

config() : mixed

Access module config

Returns

mixed

isRegistered()

isRegistered() : boolean

Determine if the module has been registered with an application object

Returns

boolean

__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