AbstractModuleCenterModule

Implements \ModuleCenterModuleInterface

Class AbstractModuleCenterModule

implements	ModuleCenterModuleInterface
category	System
package	Modules

Methods

__construct

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

Arguments

$languageTextManager

\LanguageTextManager

$db

\CI_DB_query_builder

$cacheControl

\CacheControl

Empty modules cache after module installation

_clearCache()

final

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

_init()

abstract

Function will be called in the constructor

Set isInstalled flag

_setIsInstalled()

Set module name

_setModuleName()

_store

_store( $installed)

final

Arguments

$installed

Returns the description of the module

getDescription() : string

final

Response

string

Returns the name of the module

getName() : string

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

final

Response

double

Returns the title of the module

getTitle() : string

final

Response

string

Installs the module

install()

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

isInstalled() : boolean

final

Response

boolean

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

isVisible() : boolean

Response

boolean

Uninstalls the module

uninstall()

Properties

languageTextManager

languageTextManager : \LanguageTextManager

var

Type(s)

\LanguageTextManager

db

db : \CI_DB_query_builder

var

Type(s)

\CI_DB_query_builder

isInstalled

isInstalled : null|boolean

var

Type(s)

null|boolean

name

name : string

var

Type(s)

string

title

title : string

var

Type(s)

string

description

description : string

var

Type(s)

string

sortOrder

sortOrder : integer

var

Type(s)

integer

cacheControl

cacheControl : \CacheControl

var

Type(s)

\CacheControl