Constants, Variables, Functions

This is a list of all global constants, variables and functions that are used in the framework.

Functions

fixObjectFullname Fixes incomplete object names.

getModuleDir Finds module directory by given object full name.

getModuleName Returns module name part of the object full name.

getObjectLoadError Returns object loading error (or status) message.

getObjectName Returns object name part of the object full name.

isObjectLoaded Checks if the module is already loaded.

loadLibrary Loads library.

loadObject Loads object.

unloadObject Unloads an object.

Constants

ENGINE_DIR Directory where the engine files are located.

FILES_DIR Web-accessible files directory.

LIB_DIR Directory where the library files are located.

MODULE_DIR Directory where the module files are located.

START_ENGINE Engine start script file name.

SYSTEM_DIR Directory where the system files are located.

TPL_DIR Template directory.

UPLOADS_DIR Directory for storing web-accessible uploaded files.

WEB_DIR Directory where the web-accessible files and scripts are located.

Variables

config Modules config.

loadstatuses Object loading error and status messages.

modconfig Object and module configuration.

modstatus Object loading status array.

modules Loaded object array.

Function Detail

fixObjectFullname()

string fixObjectFullname(string $obj_fullname)

Fixes incomplete object names. Full object name must be in format "modulename.objectname"

Parameters:: obj_fullname - Object name.

Returns:: Full object name.

getModuleDir()

mixed getModuleDir(string $obj_fullname)

Finds module directory by given object full name.

Parameters:: obj_fullname - Object full name (string in format "modulename.objectname").

Returns:: Directory name string on success, FALSE on failure.

Uses the global variables:: modconfig

getModuleName()

string getModuleName(string $obj_fullname)

Returns module name part of the object full name.

Parameters:: obj_fullname - Object full name (string in format "modulename.objectname").

Returns:: Module name.

getObjectLoadError()

string getObjectLoadError(string $obj_fullname)

Returns object loading error (or status) message.

Parameters:: obj_fullname - Object full name (string in format "modulename.objectname").

Returns:: Status message text.

Uses the global variables:: modstatus, loadstatuses

getObjectName()

string getObjectName(string $obj_fullname)

Returns object name part of the object full name.

Parameters:: obj_fullname - Object full name (string in format "modulename.objectname").

Returns:: Object name.

isObjectLoaded()

boolean isObjectLoaded(string $obj_fullname)

Checks if the module is already loaded.

Parameters:: obj_fullname - Object full name (string in format "modulename.objectname").

Returns:: TRUE if module is loaded successfully, FALSE otherwise.

Uses the global variables:: modstatus

loadLibrary()

boolean loadLibrary(string $file_name)

Loads library.

Parameters:: file_name - Library file name relative to LIB_DIR.

Returns:: TRUE on success, FALSE on failure.

loadObject()

object& loadObject(string $obj_fullname, [boolean $separate_instance])

Loads object.

Parameters:: obj_fullname - Object name.
separate_instance - Specifies if a separate instance of the object has to be loaded. This instance is not added into global modules array.

Returns:: object Loaded object, or FALSE on error.

Uses the global variables:: modconfig, modstatus, config, modules

unloadObject()

boolean unloadObject(string $obj_fullname, object& $object)

Unloads an object.

Parameters:: obj_fullname - Object full name (string in format "modulename.objectname").
object - Object to unload.

Returns:: TRUE on success, FALSE on error.

Uses the global variables:: modconfig, modstatus, modules

Constant Detail

ENGINE_DIR

mixed $ENGINE_DIR

Directory where the engine files are located.

FILES_DIR

mixed $FILES_DIR

Web-accessible files directory.

LIB_DIR

mixed $LIB_DIR

Directory where the library files are located.

MODULE_DIR

mixed $MODULE_DIR

Directory where the module files are located.

START_ENGINE

mixed $START_ENGINE

Engine start script file name.

SYSTEM_DIR

string $SYSTEM_DIR

Directory where the system files are located.

TPL_DIR

mixed $TPL_DIR

Template directory.

UPLOADS_DIR

mixed $UPLOADS_DIR

Directory for storing web-accessible uploaded files.

WEB_DIR

string $WEB_DIR

Directory where the web-accessible files and scripts are located.

Variable Detail

config

array $config

Modules config.

loadstatuses

array $loadstatuses

Object loading error and status messages.

modconfig

array $modconfig

Object and module configuration.

modstatus

array $modstatus

Object loading status array.

modules

array $modules

Loaded object array.

Functions
fixObjectFullname	Fixes incomplete object names.
getModuleDir	Finds module directory by given object full name.
getModuleName	Returns module name part of the object full name.
getObjectLoadError	Returns object loading error (or status) message.
getObjectName	Returns object name part of the object full name.
isObjectLoaded	Checks if the module is already loaded.
loadLibrary	Loads library.
loadObject	Loads object.
unloadObject	Unloads an object.

Constants
ENGINE_DIR	Directory where the engine files are located.
FILES_DIR	Web-accessible files directory.
LIB_DIR	Directory where the library files are located.
MODULE_DIR	Directory where the module files are located.
START_ENGINE	Engine start script file name.
SYSTEM_DIR	Directory where the system files are located.
TPL_DIR	Template directory.
UPLOADS_DIR	Directory for storing web-accessible uploaded files.
WEB_DIR	Directory where the web-accessible files and scripts are located.

Variables
config	Modules config.
loadstatuses	Object loading error and status messages.
modconfig	Object and module configuration.
modstatus	Object loading status array.
modules	Loaded object array.