rex_plugin
extends rex_package
in package
implements
rex_plugin_interface
Class for plugins.
Tags
Interfaces, Classes, Traits and Enums
- rex_plugin_interface
- Interface for plugins.
Table of Contents
- FILE_BOOT = 'boot.php'
- FILE_INSTALL = 'install.php'
- FILE_INSTALL_SQL = 'install.sql'
- FILE_PACKAGE = 'package.yml'
- FILE_UNINSTALL = 'uninstall.php'
- FILE_UNINSTALL_SQL = 'uninstall.sql'
- FILE_UPDATE = 'update.php'
- __construct() : mixed
- Constructor.
- boot() : mixed
- clearCache() : mixed
- Clears the cache of the package.
- enlist() : mixed
- exists() : bool
- Returns if the plugin exists.
- get() : rex_plugin_interface
- Returns the plugin by the given name.
- getAddon() : rex_addon
- {@inheritdoc}
- getAssetsPath() : mixed
- {@inheritdoc}
- getAssetsUrl() : mixed
- {@inheritdoc}
- getAuthor() : string|null
- Returns the author.
- getAvailablePackages() : array<string, self>
- Returns the available packages.
- getAvailablePlugins() : array<string, self>
- Returns the available plugins of the given addons.
- getCachePath() : mixed
- {@inheritdoc}
- getConfig() : mixed
- getDataPath() : mixed
- {@inheritdoc}
- getInstalledPackages() : array<string, self>
- Returns the installed packages.
- getInstalledPlugins() : array<string, self>
- Returns the installed plugins of the given addons.
- getName() : string
- Returns the name of the package.
- getPackageId() : string
- Returns the package ID.
- getPath() : mixed
- {@inheritdoc}
- getProperty() : mixed
- Returns a property.
- getRegisteredPackages() : array<string, self>
- Returns the registered packages.
- getRegisteredPlugins() : array<string, self>
- Returns the registered plugins of the given addon.
- getSetupPackages() : array<string, self>
- Returns the setup packages.
- getSupportPage() : string|null
- Returns the supportpage.
- getSystemPackages() : array<string, self>
- Returns the system packages.
- getSystemPlugins() : array<string, self>
- Returns the system plugins of the given addons.
- getType() : mixed
- {@inheritdoc}
- getVersion() : string
- Returns the version.
- hasConfig() : mixed
- hasProperty() : bool
- Returns if a property is set.
- i18n() : mixed
- {@inheritdoc}
- includeFile() : mixed
- Includes a file in the package context.
- isAvailable() : bool
- Returns if the package is available (activated and installed).
- isInstalled() : bool
- Returns if the package is installed.
- isSystemPackage() : mixed
- {@inheritdoc}
- loadProperties() : mixed
- Loads the properties of package.yml.
- removeConfig() : mixed
- removeProperty() : mixed
- Removes a property.
- require() : self
- Returns the plugin by the given name.
- setConfig() : mixed
- setProperty() : mixed
- Sets a property.
- splitId() : array<string|int, mixed>
- Splits the package id into a tuple of addon id and plugin id (if existing).
Constants
FILE_BOOT
public
mixed
FILE_BOOT
= 'boot.php'
FILE_INSTALL
public
mixed
FILE_INSTALL
= 'install.php'
FILE_INSTALL_SQL
public
mixed
FILE_INSTALL_SQL
= 'install.sql'
FILE_PACKAGE
public
mixed
FILE_PACKAGE
= 'package.yml'
FILE_UNINSTALL
public
mixed
FILE_UNINSTALL
= 'uninstall.php'
FILE_UNINSTALL_SQL
public
mixed
FILE_UNINSTALL_SQL
= 'uninstall.sql'
FILE_UPDATE
public
mixed
FILE_UPDATE
= 'update.php'
Methods
__construct()
Constructor.
public
__construct(string $name, rex_addon $addon) : mixed
Parameters
- $name : string
-
Name
- $addon : rex_addon
-
Parent addon
Return values
mixed —boot()
public
boot() : mixed
Return values
mixed —clearCache()
Clears the cache of the package.
public
clearCache() : mixed
Tags
Return values
mixed —enlist()
public
enlist() : mixed
Return values
mixed —exists()
Returns if the plugin exists.
public
static exists(string $addon[, string $plugin = null ]) : bool
Parameters
- $addon : string
-
Name of the addon
- $plugin : string = null
-
Name of the plugin
Tags
Return values
bool —get()
Returns the plugin by the given name.
public
static get(string $addon[, string $plugin = null ]) : rex_plugin_interface
Parameters
- $addon : string
-
Name of the addon
- $plugin : string = null
-
Name of the plugin
Tags
Return values
rex_plugin_interface —If the plugin exists, a rex_plugin is returned, otherwise a rex_null_plugin
getAddon()
{@inheritdoc}
public
getAddon() : rex_addon
Return values
rex_addon —getAssetsPath()
{@inheritdoc}
public
getAssetsPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —getAssetsUrl()
{@inheritdoc}
public
getAssetsUrl([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —getAuthor()
Returns the author.
public
getAuthor([mixed $default = null ]) : string|null
Parameters
- $default : mixed = null
-
Default value, will be returned if the property isn't set
Return values
string|null —getAvailablePackages()
Returns the available packages.
public
static getAvailablePackages() : array<string, self>
Return values
array<string, self> —getAvailablePlugins()
Returns the available plugins of the given addons.
public
static getAvailablePlugins(string $addon) : array<string, self>
Parameters
- $addon : string
-
Addon name
Return values
array<string, self> —getCachePath()
{@inheritdoc}
public
getCachePath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —getConfig()
public
getConfig([mixed $key = null ][, mixed $default = null ]) : mixed
Parameters
- $key : mixed = null
- $default : mixed = null
Return values
mixed —getDataPath()
{@inheritdoc}
public
getDataPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —getInstalledPackages()
Returns the installed packages.
public
static getInstalledPackages() : array<string, self>
Return values
array<string, self> —getInstalledPlugins()
Returns the installed plugins of the given addons.
public
static getInstalledPlugins(string $addon) : array<string, self>
Parameters
- $addon : string
-
Addon name
Return values
array<string, self> —getName()
Returns the name of the package.
public
getName() : string
Return values
string —Name
getPackageId()
Returns the package ID.
public
getPackageId() : string
Return values
string —getPath()
{@inheritdoc}
public
getPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —getProperty()
Returns a property.
public
getProperty(mixed $key[, mixed $default = null ]) : mixed
Parameters
- $key : mixed
-
Key of the property
- $default : mixed = null
-
Default value, will be returned if the property isn't set
Return values
mixed —getRegisteredPackages()
Returns the registered packages.
public
static getRegisteredPackages() : array<string, self>
Return values
array<string, self> —getRegisteredPlugins()
Returns the registered plugins of the given addon.
public
static getRegisteredPlugins(string $addon) : array<string, self>
Parameters
- $addon : string
-
Addon name
Return values
array<string, self> —getSetupPackages()
Returns the setup packages.
public
static getSetupPackages() : array<string, self>
Return values
array<string, self> —getSupportPage()
Returns the supportpage.
public
getSupportPage([mixed $default = null ]) : string|null
Parameters
- $default : mixed = null
-
Default value, will be returned if the property isn't set
Return values
string|null —getSystemPackages()
Returns the system packages.
public
static getSystemPackages() : array<string, self>
Return values
array<string, self> —getSystemPlugins()
Returns the system plugins of the given addons.
public
static getSystemPlugins(string $addon) : array<string, self>
Parameters
- $addon : string
-
Addon name
Return values
array<string, self> —getType()
{@inheritdoc}
public
getType() : mixed
Return values
mixed —getVersion()
Returns the version.
public
getVersion([mixed $format = null ]) : string
Parameters
Return values
string —hasConfig()
public
hasConfig([mixed $key = null ]) : mixed
Parameters
- $key : mixed = null
Return values
mixed —hasProperty()
Returns if a property is set.
public
hasProperty(mixed $key) : bool
Parameters
- $key : mixed
-
Key of the property
Return values
bool —i18n()
{@inheritdoc}
public
i18n(mixed $key, mixed ...$replacements) : mixed
Parameters
- $key : mixed
- $replacements : mixed
Return values
mixed —includeFile()
Includes a file in the package context.
public
includeFile(mixed $file[, array<string|int, mixed> $context = [] ]) : mixed
Parameters
- $file : mixed
-
Filename
- $context : array<string|int, mixed> = []
-
Context values, available as variables in given file
Return values
mixed —isAvailable()
Returns if the package is available (activated and installed).
public
isAvailable() : bool
Return values
bool —isInstalled()
Returns if the package is installed.
public
isInstalled() : bool
Return values
bool —isSystemPackage()
{@inheritdoc}
public
isSystemPackage() : mixed
Return values
mixed —loadProperties()
Loads the properties of package.yml.
public
loadProperties() : mixed
Return values
mixed —removeConfig()
public
removeConfig(mixed $key) : mixed
Parameters
- $key : mixed
Return values
mixed —removeProperty()
Removes a property.
public
removeProperty(mixed $key) : mixed
Parameters
- $key : mixed
-
Key of the property
Return values
mixed —require()
Returns the plugin by the given name.
public
static require(string $addon[, string $plugin = null ]) : self
Parameters
- $addon : string
- $plugin : string = null
Tags
Return values
self —setConfig()
public
setConfig(mixed $key[, mixed $value = null ]) : mixed
Parameters
- $key : mixed
- $value : mixed = null
Return values
mixed —setProperty()
Sets a property.
public
setProperty(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
-
Key of the property
- $value : mixed
-
New value for the property
Return values
mixed —splitId()
Splits the package id into a tuple of addon id and plugin id (if existing).
public
static splitId(string $packageId) : array<string|int, mixed>
Parameters
- $packageId : string