expModules
in package
This is the class expModules
Tags
Table of Contents
- controllerExists() : bool
- Does a controller of controllername exist in system?
- getActiveControllersList() : array<string|int, mixed>
- Looks through the database returns a list of all module class names that exist in the system and have been turned on by the administrator. Inactive modules will not be included.
- getActiveModulesAndControllersList() : array<string|int, mixed>
- Looks through the database returns a list of all module class names that exist in the system and have been turned on by the administrator. Inactive modules will not be included.
- getController() : object|string
- Returns new controller object
- getControllerClassName() : null|string
- Returns the full controller classname with the 'Controller' suffix
- getControllerDisplayName() : null|string
- Returns the controller display (formal) name
- getControllerName() : null|string
- Returns the base controller name sans the 'Controller' suffix in most cases this is also the module name
- getModuleBaseName() : null|string
- Returns the base controller or module name sans the 'Controller' or 'module' suffix
- getModuleClassName() : null|string
- Returns the full controller or module class name with the 'Controller' or 'module' suffix as needed to instantiate the class
- getModuleName() : null|string
- Returns the controller sans the 'Controller' or module name with 'module' suffix this is how we store them in the db as 2.0/old school and in most cases it is the name of the model/data
- initializeControllers() : array<string|int, mixed>
- Initializes list of system and custom (theme) controllers
- initializeModels() : array<string|int, mixed>
- Initializes list of system and custom (theme) models
- listActiveControllers() : array<string|int, mixed>
- Returns list of active controllers
- listControllers() : mixed
- listInstalledControllers() : array<string|int, mixed>
- Returns list of installed/used controllers
- listUserRunnableControllers() : array<string|int, mixed>
- Returns list of controllers with user actions
- loadModels() : mixed
- Recursive function used to load 2.0 models
- loadModules() : mixed
- Recursive function used to load 2.0 modules controllers
Methods
controllerExists()
Does a controller of controllername exist in system?
public
static controllerExists([string $controllername = '' ]) : bool
Parameters
- $controllername : string = ''
Return values
bool —getActiveControllersList()
Looks through the database returns a list of all module class names that exist in the system and have been turned on by the administrator. Inactive modules will not be included.
public
static getActiveControllersList() : array<string|int, mixed>
Returns the list of active module class names.
Tags
Return values
array<string|int, mixed> —getActiveModulesAndControllersList()
Looks through the database returns a list of all module class names that exist in the system and have been turned on by the administrator. Inactive modules will not be included.
public
static getActiveModulesAndControllersList() : array<string|int, mixed>
Returns the list of active module class names.
Tags
Return values
array<string|int, mixed> —getController()
Returns new controller object
public
static getController([string|object $controllername = '' ][, null $param = null ]) : object|string
Parameters
- $controllername : string|object = ''
- $param : null = null
Return values
object|string —getControllerClassName()
Returns the full controller classname with the 'Controller' suffix
public
static getControllerClassName( $controllername) : null|string
Parameters
Return values
null|string —getControllerDisplayName()
Returns the controller display (formal) name
public
static getControllerDisplayName( $controllername) : null|string
Parameters
Return values
null|string —getControllerName()
Returns the base controller name sans the 'Controller' suffix in most cases this is also the module name
public
static getControllerName( $controllername) : null|string
Parameters
Return values
null|string —getModuleBaseName()
Returns the base controller or module name sans the 'Controller' or 'module' suffix
public
static getModuleBaseName( $modulename) : null|string
Parameters
Return values
null|string —getModuleClassName()
Returns the full controller or module class name with the 'Controller' or 'module' suffix as needed to instantiate the class
public
static getModuleClassName( $modulename) : null|string
Parameters
Return values
null|string —getModuleName()
Returns the controller sans the 'Controller' or module name with 'module' suffix this is how we store them in the db as 2.0/old school and in most cases it is the name of the model/data
public
static getModuleName( $modulename) : null|string
Parameters
Return values
null|string —initializeControllers()
Initializes list of system and custom (theme) controllers
public
static initializeControllers() : array<string|int, mixed>
Return values
array<string|int, mixed> —initializeModels()
Initializes list of system and custom (theme) models
public
static initializeModels() : array<string|int, mixed>
Return values
array<string|int, mixed> —listActiveControllers()
Returns list of active controllers
public
static listActiveControllers() : array<string|int, mixed>
Return values
array<string|int, mixed> —listControllers()
public
static listControllers() : mixed
Return values
mixed —listInstalledControllers()
Returns list of installed/used controllers
public
static listInstalledControllers([null $type = null ][, null $loc = null ]) : array<string|int, mixed>
Parameters
- $type : null = null
- $loc : null = null
Return values
array<string|int, mixed> —listUserRunnableControllers()
Returns list of controllers with user actions
public
static listUserRunnableControllers() : array<string|int, mixed>
Return values
array<string|int, mixed> —loadModels()
Recursive function used to load 2.0 models
public
static loadModels( $dir, &$models) : mixed
Parameters
Return values
mixed —loadModules()
Recursive function used to load 2.0 modules controllers
public
static loadModules( $dir, &$controllers) : mixed