XpressEngine Core  1.11.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ModuleHandler Class Reference
Inheritance diagram for ModuleHandler:
Handler

Public Member Functions

 __construct ($module= '', $act= '', $mid= '', $document_srl= '', $module_srl= '')
 
 shutdownHandler ()
 
 init ()
 
 procModule ()
 
 _setInputErrorToContext ()
 
 _clearErrorSession ()
 
 _setInputValueToSession ()
 
 displayContent ($oModule=NULL)
 
 getModulePath ($module)
 
getModuleInstance ($module, $type= 'view', $kind= '')
 
 _getModuleFilePath ($module, $type, $kind, &$classPath, &$highClassFile, &$classFile, &$instanceName)
 
 triggerCall ($trigger_name, $called_position, &$obj)
 
 _setHttpStatusMessage ($code)
 

Static Public Member Functions

static xeErrorLog ($errnumber, $errormassage, $errorfile, $errorline, $errorcontext)
 
static getErrorType ($errno)
 

Public Attributes

 $module = NULL
 Module. More...
 
 $act = NULL
 action More...
 
 $mid = NULL
 Module ID. More...
 
 $document_srl = NULL
 Document Number. More...
 
 $module_srl = NULL
 Module Number. More...
 
 $module_info = NULL
 Module Info. Object. More...
 
 $error = NULL
 an error code. More...
 
 $httpStatusCode = NULL
 http status code. More...
 

Detailed Description

Author
NAVER (devel.nosp@m.oper.nosp@m.s@xpr.nosp@m.esse.nosp@m.ngine.nosp@m..com) Handling modules
Remarks
This class is to excute actions of modules. Constructing an instance without any parameterconstructor, it finds the target module based on Context. If there is no act on the found module, excute an action referencing action_forward.

Definition at line 13 of file ModuleHandler.class.php.

Constructor & Destructor Documentation

ModuleHandler::__construct (   $module = '',
  $act = '',
  $mid = '',
  $document_srl = '',
  $module_srl = '' 
)

prepares variables to use in moduleHandler

Parameters
string$modulename of module
string$actname of action
int$mid
int$document_srl
int$module_srl
Returns
void

Definition at line 35 of file ModuleHandler.class.php.

Member Function Documentation

ModuleHandler::_clearErrorSession ( )

clear error message to Session.

Returns
void

Definition at line 938 of file ModuleHandler.class.php.

ModuleHandler::_getModuleFilePath (   $module,
  $type,
  $kind,
$classPath,
$highClassFile,
$classFile,
$instanceName 
)

Definition at line 1255 of file ModuleHandler.class.php.

ModuleHandler::_setHttpStatusMessage (   $code)

get http status message by http status code

Parameters
string$code
Returns
string

Definition at line 1357 of file ModuleHandler.class.php.

ModuleHandler::_setInputErrorToContext ( )

set error message to Session.

Returns
void

Definition at line 904 of file ModuleHandler.class.php.

ModuleHandler::_setInputValueToSession ( )

occured error when, set input values to session.

Returns
void

Definition at line 952 of file ModuleHandler.class.php.

ModuleHandler::displayContent (   $oModule = NULL)

display contents from executed module

Parameters
ModuleObject$oModulemodule instance
Returns
void

Definition at line 967 of file ModuleHandler.class.php.

static ModuleHandler::getErrorType (   $errno)
static

Definition at line 184 of file ModuleHandler.class.php.

& ModuleHandler::getModuleInstance (   $module,
  $type = 'view',
  $kind = '' 
)

It creates a module instance

Parameters
string$modulemodule name
string$typeinstance type, (e.g., view, controller, model)
string$kindadmin or svc
Returns
ModuleObject module instance (if failed it returns null)
Remarks
if there exists a module instance created before, returns it.

Definition at line 1168 of file ModuleHandler.class.php.

ModuleHandler::getModulePath (   $module)

returns module's path

Parameters
string$modulemodule name
Returns
string path of the module

Definition at line 1155 of file ModuleHandler.class.php.

ModuleHandler::init ( )

Initialization. It finds the target module based on module, mid, document_srl, and prepares to execute an action

Returns
boolean true: OK, false: redirected

Definition at line 211 of file ModuleHandler.class.php.

ModuleHandler::procModule ( )

get a module instance and execute an action

Returns
ModuleObject executed module instance

Definition at line 410 of file ModuleHandler.class.php.

ModuleHandler::shutdownHandler ( )

Definition at line 154 of file ModuleHandler.class.php.

ModuleHandler::triggerCall (   $trigger_name,
  $called_position,
$obj 
)

call a trigger

Parameters
string$trigger_nametrigger's name to call
string$called_positioncalled position
object$objan object as a parameter to trigger
Returns
BaseObject

Definition at line 1294 of file ModuleHandler.class.php.

static ModuleHandler::xeErrorLog (   $errnumber,
  $errormassage,
  $errorfile,
  $errorline,
  $errorcontext 
)
static

Definition at line 118 of file ModuleHandler.class.php.

Member Data Documentation

ModuleHandler::$act = NULL

action

Definition at line 17 of file ModuleHandler.class.php.

ModuleHandler::$document_srl = NULL

Document Number.

Definition at line 19 of file ModuleHandler.class.php.

ModuleHandler::$error = NULL

an error code.

Definition at line 22 of file ModuleHandler.class.php.

ModuleHandler::$httpStatusCode = NULL

http status code.

Definition at line 23 of file ModuleHandler.class.php.

ModuleHandler::$mid = NULL

Module ID.

Definition at line 18 of file ModuleHandler.class.php.

ModuleHandler::$module = NULL

Module.

Definition at line 16 of file ModuleHandler.class.php.

ModuleHandler::$module_info = NULL

Module Info. Object.

Definition at line 21 of file ModuleHandler.class.php.

ModuleHandler::$module_srl = NULL

Module Number.

Definition at line 20 of file ModuleHandler.class.php.


The documentation for this class was generated from the following file: