Documentation

ModuleChecker
in package

Module Checker Checks for installed and activated modules

Tags
copyright

CLOUDREXX CMS - CLOUDREXX AG

author

Cloudrexx Development Team info@cloudrexx.com

author

Michael Ritter michael.ritter@cloudrexx.com

version
2.0.0
subpackage

core

Table of Contents

Properties

$allActivated  : bool
Sets all modules activated
$arrActiveModules  : array<string|int, mixed>
Names of active modules
$arrCoreModules  : array<string|int, mixed>
Names of all core modules
$arrInstalledModules  : array<string|int, mixed>
Names of installed modules
$arrModules  : array<string|int, mixed>
Names of all modules (except core modules)
$cl  : ClassLoader
ClassLoader
$db  : ADONewConnection
Database
$em  : EntityManager
Entity Manager
$instance  : mixed

Methods

getActiveModules()  : array<string|int, mixed>
Returns the active cloudrexx modules
getCoreModules()  : array<string|int, mixed>
Returns the cloudrexx core modules
getInstalledModules()  : array<string|int, mixed>
Returns the installed cloudrexx modules
getInstance()  : self
Singleton pattern instance getter
getModules()  : array<string|int, mixed>
Returns the cloudrexx modules
isCoreModule()  : bool
Checks if the passed module is a core module.
isModuleActive()  : bool
Checks if the passed module is active (application page exists and is active).
isModuleInstalled()  : bool
Checks if the passed module is installed (application page exists).
__construct()  : mixed
Constructor
init()  : mixed
Initialisation

Properties

$arrActiveModules

Names of active modules

protected array<string|int, mixed> $arrActiveModules = array()
Tags
access

protected

$arrCoreModules

Names of all core modules

protected array<string|int, mixed> $arrCoreModules = array()
Tags
access

protected

$arrInstalledModules

Names of installed modules

protected array<string|int, mixed> $arrInstalledModules = array()
Tags
access

protected

$arrModules

Names of all modules (except core modules)

protected array<string|int, mixed> $arrModules = array()
Tags
access

protected

Methods

getActiveModules()

Returns the active cloudrexx modules

public getActiveModules() : array<string|int, mixed>
Return values
array<string|int, mixed>

List of active modules

getCoreModules()

Returns the cloudrexx core modules

public getCoreModules() : array<string|int, mixed>
Return values
array<string|int, mixed>

List of core modules

getInstalledModules()

Returns the installed cloudrexx modules

public getInstalledModules() : array<string|int, mixed>
Return values
array<string|int, mixed>

List of installed modules

getInstance()

Singleton pattern instance getter

public static getInstance(EntityManager $em, ADONewConnection $db, ClassLoader $cl[, bool $setAllActivated = false ]) : self
Parameters
$em : EntityManager

Doctrine EntityManager

$db : ADONewConnection

AdoDB connection

$cl : ClassLoader

Cloudrexx class loader

$setAllActivated : bool = false

(optional) Shows all modules as activated, default false

Return values
self

Unique instance of this class

getModules()

Returns the cloudrexx modules

public getModules() : array<string|int, mixed>
Return values
array<string|int, mixed>

List of modules

isCoreModule()

Checks if the passed module is a core module.

public isCoreModule(string $moduleName) : bool
Parameters
$moduleName : string
Tags
access

public

Return values
bool

isModuleActive()

Checks if the passed module is active (application page exists and is active).

public isModuleActive(string $moduleName) : bool
Parameters
$moduleName : string
Tags
access

public

Return values
bool

isModuleInstalled()

Checks if the passed module is installed (application page exists).

public isModuleInstalled(string $moduleName) : bool
Parameters
$moduleName : string
Tags
access

public

Return values
bool

__construct()

Constructor

protected __construct(EntityManager $em, ADONewConnection $db, ClassLoader $cl[, bool $setAllActivated = false ]) : mixed
Parameters
$em : EntityManager

Doctrine EntityManager

$db : ADONewConnection

AdoDB connection

$cl : ClassLoader

Cloudrexx class loader

$setAllActivated : bool = false

(optional) Shows all modules as activated, default false


        
On this page

Search results