PluginProperties
extends Element
in package
This is the plugin properties class.
The API plugin data will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $pluginId | : int | |
| $pluginModule | : string | |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getPluginId() | Returns the plugin id. | : int |
| getPluginModule() | Returns the plugin module. | : string |
| setError() | : void |
Properties
$error
protected
Error|null
$error
= null
$pluginId
protected
int
$pluginId
= 0
$pluginModule
protected
string
$pluginModule
= ''
Methods
getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getPluginId()
Returns the plugin id.
public
getPluginId() : int
Return values
int —getPluginModule()
Returns the plugin module.
public
getPluginModule() : string
Return values
string —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed