Plugin
Table of Contents
- $config : PluginConfig|null
- The config of a plugin.
- $enabled : bool|null
- True if the plugin is running. False if the plugin is not running, only installed.
- $id : string|null
- $name : string|null
- $pluginReference : string|null
- plugin remote reference used to push/pull the plugin.
- $settings : PluginSettings|null
- Settings that can be modified by users.
- getConfig() : PluginConfig|null
- The config of a plugin.
- getEnabled() : bool|null
- True if the plugin is running. False if the plugin is not running, only installed.
- getId() : string|null
- getName() : string|null
- getPluginReference() : string|null
- plugin remote reference used to push/pull the plugin.
- getSettings() : PluginSettings|null
- Settings that can be modified by users.
- setConfig() : self
- The config of a plugin.
- setEnabled() : self
- True if the plugin is running. False if the plugin is not running, only installed.
- setId() : self
- setName() : self
- setPluginReference() : self
- plugin remote reference used to push/pull the plugin.
- setSettings() : self
- Settings that can be modified by users.
Properties
$config
The config of a plugin.
protected
PluginConfig|null
$config
$enabled
True if the plugin is running. False if the plugin is not running, only installed.
protected
bool|null
$enabled
$id
protected
string|null
$id
$name
protected
string|null
$name
$pluginReference
plugin remote reference used to push/pull the plugin.
protected
string|null
$pluginReference
$settings
Settings that can be modified by users.
protected
PluginSettings|null
$settings
Methods
getConfig()
The config of a plugin.
public
getConfig() : PluginConfig|null
Return values
PluginConfig|null —getEnabled()
True if the plugin is running. False if the plugin is not running, only installed.
public
getEnabled() : bool|null
Return values
bool|null —getId()
public
getId() : string|null
Return values
string|null —getName()
public
getName() : string|null
Return values
string|null —getPluginReference()
plugin remote reference used to push/pull the plugin.
public
getPluginReference() : string|null
Return values
string|null —getSettings()
Settings that can be modified by users.
public
getSettings() : PluginSettings|null
Return values
PluginSettings|null —setConfig()
The config of a plugin.
public
setConfig(PluginConfig|null $config) : self
Parameters
- $config : PluginConfig|null
Return values
self —setEnabled()
True if the plugin is running. False if the plugin is not running, only installed.
public
setEnabled(bool|null $enabled) : self
Parameters
- $enabled : bool|null
Return values
self —setId()
public
setId(string|null $id) : self
Parameters
- $id : string|null
Return values
self —setName()
public
setName(string|null $name) : self
Parameters
- $name : string|null
Return values
self —setPluginReference()
plugin remote reference used to push/pull the plugin.
public
setPluginReference(string|null $pluginReference) : self
Parameters
- $pluginReference : string|null
Return values
self —setSettings()
Settings that can be modified by users.
public
setSettings(PluginSettings|null $settings) : self
Parameters
- $settings : PluginSettings|null