CSModuleStatus
in package
Defines a module status
Tags
Table of Contents
- createStatus() : CSModuleStatus
- Creates an instance of a module status
- getEntries() : array<string|int, CSModuleStatusEntry>
- Returns all status entries
- getErrors() : array<string|int, CSModuleStatusEntry>
- Returns all status entries with the type error
- getModule() : CSModule
- Returns the module instance
- getType() : ModuleStatusType
- Returns the current status type
- getWarnings() : array<string|int, CSModuleStatusEntry>
- Returns all status entries with the type warnings
Methods
createStatus()
Creates an instance of a module status
public
static createStatus(CSModule $oModule[, array<string|int, CSModuleStatusEntry> $aEntries = array() ]) : CSModuleStatus
Parameters
- $oModule : CSModule
-
The module instance
- $aEntries : array<string|int, CSModuleStatusEntry> = array()
-
List of status entries
Tags
Return values
CSModuleStatus —The module status instance
getEntries()
Returns all status entries
public
getEntries() : array<string|int, CSModuleStatusEntry>
Tags
Return values
array<string|int, CSModuleStatusEntry> —List of status entries
getErrors()
Returns all status entries with the type error
public
getErrors() : array<string|int, CSModuleStatusEntry>
Tags
Return values
array<string|int, CSModuleStatusEntry> —List of status entries
getModule()
Returns the module instance
public
getModule() : CSModule
Tags
Return values
CSModule —The module instance
getType()
Returns the current status type
public
getType() : ModuleStatusType
Tags
Return values
ModuleStatusType —The status type of the current module status instance
getWarnings()
Returns all status entries with the type warnings
public
getWarnings() : array<string|int, CSModuleStatusEntry>
Tags
Return values
array<string|int, CSModuleStatusEntry> —List of status entries