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 |
string fixObjectFullname(string $obj_fullname)
Fixes incomplete object names. Full object name must be in format "modulename.objectname"
obj_fullname
- Object name.mixed getModuleDir(string $obj_fullname)
Finds module directory by given object full name.
obj_fullname
- Object full name (string in format "modulename.objectname").string getModuleName(string $obj_fullname)
Returns module name part of the object full name.
obj_fullname
- Object full name (string in format "modulename.objectname").string getObjectLoadError(string $obj_fullname)
Returns object loading error (or status) message.
obj_fullname
- Object full name (string in format "modulename.objectname").string getObjectName(string $obj_fullname)
Returns object name part of the object full name.
obj_fullname
- Object full name (string in format "modulename.objectname").boolean isObjectLoaded(string $obj_fullname)
Checks if the module is already loaded.
obj_fullname
- Object full name (string in format "modulename.objectname").boolean loadLibrary(string $file_name)
Loads library.
file_name
- Library file name relative to LIB_DIR.object& loadObject(string $obj_fullname, [boolean $separate_instance])
Loads object.
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.boolean unloadObject(string $obj_fullname, object& $object)
Unloads an object.
obj_fullname
- Object full name (string in format "modulename.objectname").object
- Object to unload.Constant Detail |
mixed $ENGINE_DIR
Directory where the engine files are located.
mixed $FILES_DIR
Web-accessible files directory.
mixed $LIB_DIR
Directory where the library files are located.
mixed $MODULE_DIR
Directory where the module files are located.
mixed $START_ENGINE
Engine start script file name.
string $SYSTEM_DIR
Directory where the system files are located.
mixed $TPL_DIR
Template directory.
mixed $UPLOADS_DIR
Directory for storing web-accessible uploaded files.
string $WEB_DIR
Directory where the web-accessible files and scripts are located.
Variable Detail |
array $config
Modules config.
array $loadstatuses
Object loading error and status messages.
array $modconfig
Object and module configuration.
array $modstatus
Object loading status array.
array $modules
Loaded object array.