Module
extends AbstractModule
in package
implements
ArrayAccess
Pop module class
Tags
Table of Contents
Interfaces
- ArrayAccess
Properties
- $config : mixed
- $application : Application|null
- Application
- $fullName : string|null
- Full Name (Human-readable, e.g., "My Application")
- $name : string|null
- Name (Slug, e.g. "my-app")
- $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
- getFullName() : string
- Get full name
- getName() : string
- Get name
- getVersion() : string
- Get version
- hasFullName() : bool
- Determine if the full name is set
- 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
- setFullName() : static
- Set full name
- setName() : static
- Set name
- setVersion() : static
- Set version
- updateConfigValue() : AbstractApplication
- Update existing value in config
- applyConfigEvents() : void
- If events are set in the module config, register them with the application
- applyConfigMetadata() : void
- Set the module name and version from config, if available
- applyConfigMiddleware() : void
- If middleware is defined in the module config, register them with the application
- applyConfigRoutes() : void
- If routes are set in the module config, register them with the application
- applyConfigServices() : void
- If services are set in the module config, register them with the application
- registerConfiguredAutoloaderPrefix() : void
- If the autoloader is set and the module config has a defined prefix and src, register the module with the autoloader
Properties
$config
public
mixed
$config
$application
Application
protected
Application|null
$application
= null
$fullName
Full Name (Human-readable, e.g., "My Application")
protected
string|null
$fullName
= null
$name
Name (Slug, e.g. "my-app")
protected
string|null
$name
= null
$version
Version
protected
string|null
$version
= null
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
addConfigValue()
Add new value to config
public
addConfigValue(string $name, string $value) : AbstractApplication
Parameters
- $name : string
- $value : string
Return values
AbstractApplicationapplication()
Get application
public
application() : Application
Return values
Applicationconfig()
Access application config
public
config() : mixed
deleteConfigValue()
Replace existing value in config
public
deleteConfigValue(string $name) : AbstractApplication
Parameters
- $name : string
Return values
AbstractApplicationgetFullName()
Get full name
public
getFullName() : string
Return values
stringgetName()
Get name
public
getName() : string
Return values
stringgetVersion()
Get version
public
getVersion() : string
Return values
stringhasFullName()
Determine if the full name is set
public
hasFullName() : bool
Return values
boolhasName()
Determine if the name is set
public
hasName() : bool
Return values
boolhasVersion()
Determine if version has been set
public
hasVersion() : bool
Return values
boolisRegistered()
Determine if the module has been registered with an application object
public
isRegistered() : bool
Return values
boolload()
Optional method that can be used to load custom operations/configurations for an application to run
public
load() : AbstractApplication
Return values
AbstractApplicationmergeConfig()
Merge new or altered config values with the existing config values
public
mergeConfig(mixed $config[, bool $preserve = false ][, array<string|int, mixed> $exclude = [] ]) : AbstractApplication
Parameters
- $config : mixed
- $preserve : bool = false
- $exclude : array<string|int, mixed> = []
Tags
Return values
AbstractApplicationoffsetExists()
Determine if a value exists
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
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
register()
Register module
public
register(Application $application) : static
Parameters
- $application : Application
Tags
Return values
staticregisterConfig()
Register a new configuration with the application
public
registerConfig(mixed $config) : AbstractApplication
Parameters
- $config : mixed
Tags
Return values
AbstractApplicationsetFullName()
Set full name
public
setFullName(string $fullName) : static
Parameters
- $fullName : string
Return values
staticsetName()
Set name
public
setName(string $name) : static
Parameters
- $name : string
Return values
staticsetVersion()
Set version
public
setVersion(string $version) : static
Parameters
- $version : string
Return values
staticupdateConfigValue()
Update existing value in config
public
updateConfigValue(string $name, string $value) : AbstractApplication
Parameters
- $name : string
- $value : string
Return values
AbstractApplicationapplyConfigEvents()
If events are set in the module config, register them with the application
protected
applyConfigEvents() : void
applyConfigMetadata()
Set the module name and version from config, if available
protected
applyConfigMetadata() : void
applyConfigMiddleware()
If middleware is defined in the module config, register them with the application
protected
applyConfigMiddleware() : void
applyConfigRoutes()
If routes are set in the module config, register them with the application
protected
applyConfigRoutes() : void
applyConfigServices()
If services are set in the module config, register them with the application
protected
applyConfigServices() : void
registerConfiguredAutoloaderPrefix()
If the autoloader is set and the module config has a defined prefix and src, register the module with the autoloader
protected
registerConfiguredAutoloaderPrefix() : void