AbstractApplication
in package
implements
ApplicationInterface
AbstractYes
Abstract application class
Tags
Table of Contents
Interfaces
- ApplicationInterface
- Application interface
Properties
- $config : mixed
- Application config
- $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
- addConfigValue() : AbstractApplication
- Add new value to config
- 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
- 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
- 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
Properties
$config
Application config
protected
mixed
$config
= 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
addConfigValue()
Add new value to config
public
addConfigValue(string $name, string $value) : AbstractApplication
Parameters
- $name : string
- $value : string
Return values
AbstractApplicationconfig()
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
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
AbstractApplicationregisterConfig()
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