API Documentation
Back to top  

GXModuleCenterModule

Extends \AbstractModuleCenterModule

Class GXModuleCenterModule

extends

AbstractModuleCenterModule
category

System
package

Modules
subpackage

Controllers

Methods

__construct

__construct(\LanguageTextManager $languageTextManager, \CI_DB_query_builder $db, \CacheControl $cacheControl)
inherited

Arguments

$languageTextManager

\LanguageTextManager

$db

\CI_DB_query_builder

$cacheControl

\CacheControl

Call the method from the controller

_callUserMethod( $action)

Arguments

$action

Empty modules cache after module installation

_clearCache()
inherited final

Loads the json data of the GXModule

_getGXModule( $name) : array|boolean|mixed

Arguments

$name

Response

array|boolean|mixed

Get the controller and method for install

_getInstallMethod( $module) : boolean|mixed

Arguments

$module

Response

boolean|mixed

Get the controller and method for uninstall

_getUninstallMethod( $module) : boolean|mixed

Arguments

$module

Response

boolean|mixed

Initialize the module e.g. set title, description, sort order etc.

_init()
inherited abstract

Function will be called in the constructor

Set isInstalled flag

_setIsInstalled()
inherited

Set module name

_setModuleName()
inherited

_store

_store( $installed)
inherited final

Arguments

$installed

Returns the description of the module

getDescription() : string
inherited final

Response

string

Returns the name of the module

getName() : string
inherited final

The name is filtered by a regular expression. Only alphanumeric characters are allowed.

Response

string

Returns the sort order of the module

getSortOrder() : double
inherited final

Response

double

Returns the title of the module

getTitle() : string
inherited final

Response

string

Installs the module

install()
inherited

Returns true, if the module is installed. Otherwise false is returned.

isInstalled() : boolean
inherited final

Response

boolean

Returns true, if the module should be displayed in module center.

isVisible() : boolean
inherited

Response

boolean

Set the description of the module to display in overview

setDescription( $description)

Arguments

$description

setModuleData

setModuleData( $data)

Arguments

$data

Set the name of the module to use in ajax requests

setName( $name)

Arguments

$name

Set the sort order of module in overview

setSortOrder( $sortOrder)

Arguments

$sortOrder

Set the tile of the module to show in the oveview

setTitle( $title)

Arguments

$title

Set the version of the module

setVersion( $version)

Arguments

$version

Uninstalls the module

uninstall()
inherited

Properties

moduleData

moduleData :

Type(s)

languageTextManager

languageTextManager : \LanguageTextManager
inherited
var

Type(s)

\LanguageTextManager

db

db : \CI_DB_query_builder
inherited
var

Type(s)

\CI_DB_query_builder

isInstalled

isInstalled : null|boolean
inherited
var

Type(s)

null|boolean

name

name : string
inherited
var

Type(s)

string

title

title : string
inherited
var

Type(s)

string

description

description : string
inherited
var

Type(s)

string

sortOrder

sortOrder : integer
inherited
var

Type(s)

integer

cacheControl

cacheControl : \CacheControl
inherited
var

Type(s)

\CacheControl