GXModuleCenterModule
extends AbstractModuleCenterModule
in package
Class GXModuleCenterModule
Tags
Table of Contents
- LEGACY_PREFIX = 'gm_configuration/'
- $cacheControl : CacheControl
- $db : CI_DB_query_builder
- $description : string
- $isInstalled : null|bool
- $languageTextManager : LanguageTextManager
- $moduleData : mixed
- $name : string
- $sortOrder : int
- $title : string
- __construct() : mixed
- getDescription() : string
- Returns the description of the module
- getName() : string
- Returns the name of the module
- getSortOrder() : float
- Returns the sort order of the module
- getTitle() : string
- Returns the title of the module
- install() : mixed
- Installs a GXModule and sets active
- isInstalled() : bool
- Returns true, if the module is installed. Otherwise false is returned.
- isVisible() : bool
- Returns true, if the module should be displayed in module center.
- setDescription() : mixed
- Set the description of the module to display in overview
- setModuleData() : mixed
- setName() : mixed
- Set the name of the module to use in ajax requests
- setSortOrder() : mixed
- Set the sort order of module in overview
- setTitle() : mixed
- Set the tile of the module to show in the oveview
- setVersion() : mixed
- Set the version of the module
- uninstall() : mixed
- Uninstalls a GXModule an deletes everything in GXModuleConfigurationStorage
- _callUserMethod() : mixed
- Call the method from the controller
- _clearCache() : mixed
- Empty modules cache after module installation
- _getGXModule() : array<string|int, mixed>|bool|mixed
- Loads the json data of the GXModule
- _getInstallMethod() : bool|mixed
- Get the controller and method for install
- _getUninstallMethod() : bool|mixed
- Get the controller and method for uninstall
- _init() : mixed
- Initialize the module e.g. set title, description, sort order etc.
- _setIsInstalled() : mixed
- Set isInstalled flag
- _setModuleName() : mixed
- Set module name
- _store() : mixed
Constants
LEGACY_PREFIX
private
mixed
LEGACY_PREFIX
= 'gm_configuration/'
Properties
$cacheControl
protected
CacheControl
$cacheControl
$db
protected
CI_DB_query_builder
$db
$description
protected
string
$description
= ''
$isInstalled
protected
null|bool
$isInstalled
=
ull
$languageTextManager
protected
LanguageTextManager
$languageTextManager
$moduleData
protected
mixed
$moduleData
$name
protected
string
$name
= ''
$sortOrder
protected
int
$sortOrder
= 100000
$title
protected
string
$title
= ''
Methods
__construct()
public
__construct(LanguageTextManager $languageTextManager, CI_DB_query_builder $db, CacheControl $cacheControl) : mixed
Parameters
- $languageTextManager : LanguageTextManager
- $db : CI_DB_query_builder
- $cacheControl : CacheControl
Return values
mixed —getDescription()
Returns the description of the module
public
final getDescription() : string
Return values
string —getName()
Returns the name of the module
public
final getName() : string
The name is filtered by a regular expression. Only alphanumeric characters are allowed.
Return values
string —getSortOrder()
Returns the sort order of the module
public
final getSortOrder() : float
Return values
float —getTitle()
Returns the title of the module
public
final getTitle() : string
Return values
string —install()
Installs a GXModule and sets active
public
install() : mixed
Return values
mixed —isInstalled()
Returns true, if the module is installed. Otherwise false is returned.
public
final isInstalled() : bool
Return values
bool —isVisible()
Returns true, if the module should be displayed in module center.
public
isVisible() : bool
Return values
bool —setDescription()
Set the description of the module to display in overview
public
setDescription( $description) : mixed
Parameters
Return values
mixed —setModuleData()
public
setModuleData(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —setName()
Set the name of the module to use in ajax requests
public
setName( $name) : mixed
Parameters
Return values
mixed —setSortOrder()
Set the sort order of module in overview
public
setSortOrder( $sortOrder) : mixed
Parameters
Return values
mixed —setTitle()
Set the tile of the module to show in the oveview
public
setTitle( $title) : mixed
Parameters
Return values
mixed —setVersion()
Set the version of the module
public
setVersion( $version) : mixed
Parameters
Return values
mixed —uninstall()
Uninstalls a GXModule an deletes everything in GXModuleConfigurationStorage
public
uninstall() : mixed
Return values
mixed —_callUserMethod()
Call the method from the controller
protected
_callUserMethod( $action) : mixed
Parameters
Return values
mixed —_clearCache()
Empty modules cache after module installation
protected
final _clearCache() : mixed
Return values
mixed —_getGXModule()
Loads the json data of the GXModule
protected
_getGXModule( $name) : array<string|int, mixed>|bool|mixed
Parameters
Return values
array<string|int, mixed>|bool|mixed —_getInstallMethod()
Get the controller and method for install
protected
_getInstallMethod( $module) : bool|mixed
Parameters
Return values
bool|mixed —_getUninstallMethod()
Get the controller and method for uninstall
protected
_getUninstallMethod( $module) : bool|mixed
Parameters
Return values
bool|mixed —_init()
Initialize the module e.g. set title, description, sort order etc.
protected
_init() : mixed
Function will be called in the constructor
Return values
mixed —_setIsInstalled()
Set isInstalled flag
protected
_setIsInstalled() : mixed
Return values
mixed —_setModuleName()
Set module name
protected
_setModuleName() : mixed
Return values
mixed —_store()
protected
final _store(mixed $installed) : mixed
Parameters
- $installed : mixed