ModuleObject Class Reference

Inheritance diagram for ModuleObject:

Public Member Functions
	setModule ($module)
	setModulePath ($path)
	setRedirectUrl ($url= './', $output=NULL)
	getRedirectUrl ()
	setMessage ($message= 'success', $type=NULL)
	setMessageType ($type)
	getMessageType ()
	setRefreshPage ()
	setAct ($act)
	setModuleInfo ($module_info, $xml_info)
	stop ($msg_code)
	setTemplateFile ($filename)
	getTemplateFile ()
	setTemplatePath ($path)
	getTemplatePath ()
	setEditedLayoutFile ($filename)
	getEditedLayoutFile ()
	setLayoutFile ($filename)
	getLayoutFile ()
	setLayoutPath ($path)
	getLayoutPath ($layout_name="", $layout_type="P")
	proc ()
Public Member Functions inherited from BaseObject
	__construct ($error=0, $message= 'success')
	setError ($error=0)
	getError ()
	setHttpStatusCode ($code= '200')
	getHttpStatusCode ()
	setMessage ($message= 'success', $type=NULL)
	getMessage ()
	add ($key, $val)
	adds ($object)
	get ($key)
	gets ()
	getVariables ()
	getObjectVars ()
	toBool ()
	toBoolean ()

Public Attributes
	$mid = NULL
	string to represent run-time instance of Module (XE Module) More...
	$module = NULL
	Class name of Xe Module that is identified by mid. More...
	$module_srl = NULL
	integer value to represent a run-time instance of Module (XE Module) More...
	$module_info = NULL
	an object containing the module information More...
	$origin_module_info = NULL
	$xml_info = NULL
	an object containing the module description extracted from XML file More...
	$module_path = NULL
	a path to directory where module source code resides More...
	$act = NULL
	a string value to contain the action name More...
	$template_path = NULL
	a path of directory where template files reside More...
	$template_file = NULL
	name of template file More...
	$layout_path = ''
	a path of directory where layout files reside More...
	$layout_file = ''
	name of layout file More...
	$edited_layout_file = ''
	name of temporary layout files that is modified in an admin mode More...
	$stop_proc = FALSE
	a flag to indicating whether to stop the execution of code. More...
	$module_config = NULL
	$ajaxRequestMethod = array('XMLRPC', 'JSON')
	$gzhandler_enable = TRUE
Public Attributes inherited from BaseObject
	$error = 0
	$message = 'success'
	$variables = array()
	$httpStatusCode = NULL

Detailed Description

Author

NAVER (devel.nosp@m.oper.nosp@m.s@xpr.nosp@m.esse.nosp@m.ngine.nosp@m..com) base class of ModuleHandler

Definition at line 9 of file ModuleObject.class.php.

Member Function Documentation

ModuleObject::getEditedLayoutFile

(

)

retreived the file name of edited_layout_file

Returns

string

Definition at line 320 of file ModuleObject.class.php.

ModuleObject::getLayoutFile

(

)

get the file name of the layout file

Returns

string

Definition at line 345 of file ModuleObject.class.php.

ModuleObject::getLayoutPath	(		$layout_name = "",
			$layout_type = "P"
	)

set the directory path of the layout directory

Returns

string

Definition at line 373 of file ModuleObject.class.php.

ModuleObject::getMessageType

(

)

get type of message

Returns

string $type

Definition at line 109 of file ModuleObject.class.php.

ModuleObject::getRedirectUrl

(

)

get url for redirection

Returns

string redirect_url

Definition at line 78 of file ModuleObject.class.php.

ModuleObject::getTemplateFile

(

)

retrieve the directory path of the template directory

Returns

string

Definition at line 265 of file ModuleObject.class.php.

ModuleObject::getTemplatePath

(

)

retrieve the directory path of the template directory

Returns

string

Definition at line 295 of file ModuleObject.class.php.

ModuleObject::proc

(

)

excute the member method specified by $act variable

Returns

boolean true : success false : fail

Definition at line 382 of file ModuleObject.class.php.

ModuleObject::setAct

(

$act

)

sett to set the action name

Parameters

string

$act

Returns

void

Definition at line 137 of file ModuleObject.class.php.

ModuleObject::setEditedLayoutFile

(

$filename

)

set the file name of the temporarily modified by admin

Parameters

string

name of file

Returns

void

Definition at line 305 of file ModuleObject.class.php.

ModuleObject::setLayoutFile

(

$filename

)

set the file name of the layout file

Parameters

string

name of file

Returns

void

Definition at line 330 of file ModuleObject.class.php.

ModuleObject::setLayoutPath

(

$path

)

set the directory path of the layout directory

Parameters

string

path of layout directory.

Definition at line 354 of file ModuleObject.class.php.

ModuleObject::setMessage	(		$message = 'success',
			$type = NULL
	)

set message

Parameters

string	$message	a message string
string	$type	type of message (error, info, update)

Returns

void

Definition at line 89 of file ModuleObject.class.php.

ModuleObject::setMessageType

(

$type

)

set type of message

Parameters

string

$type

type of message (error, info, update)

Returns

void

Definition at line 100 of file ModuleObject.class.php.

ModuleObject::setModule

(

$module

)

setter to set the name of module

Parameters

string

$module

name of module

Returns

void

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

ModuleObject::setModuleInfo	(		$module_info,
			$xml_info
	)

sett to set module information

Parameters

object	$module_info	object containing module information
object	$xml_info	object containing module description

Returns

void

Definition at line 148 of file ModuleObject.class.php.

ModuleObject::setModulePath

(

$path

)

setter to set the name of module path

Parameters

string

$path

the directory path to a module directory

Returns

void

Definition at line 45 of file ModuleObject.class.php.

ModuleObject::setRedirectUrl	(		$url = './',
			$output = NULL
	)

setter to set an url for redirection

Parameters

string

$url

url for redirection

Remarks

redirect_url is used only for ajax requests

Returns

void

Definition at line 60 of file ModuleObject.class.php.

ModuleObject::setRefreshPage

(

)

sett to set the template path for refresh.html refresh.html is executed as a result of method execution Tpl as the common run of the refresh.html ..

Returns

void

Definition at line 126 of file ModuleObject.class.php.

ModuleObject::setTemplateFile

(

$filename

)

set the file name of the template file

Parameters

string

name of file

Returns

void

Definition at line 252 of file ModuleObject.class.php.

ModuleObject::setTemplatePath

(

$path

)

set the directory path of the template directory

Parameters

string

path of template directory.

Returns

void

Definition at line 275 of file ModuleObject.class.php.

ModuleObject::stop

(

$msg_code

)

set the stop_proc and approprate message for msg_code

Parameters

string

$msg_code

an error code

Returns

ModuleObject $this

Definition at line 227 of file ModuleObject.class.php.

Member Data Documentation

ModuleObject::$act = NULL

a string value to contain the action name

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

ModuleObject::$ajaxRequestMethod = array('XMLRPC', 'JSON')

Definition at line 27 of file ModuleObject.class.php.

ModuleObject::$edited_layout_file = ''

name of temporary layout files that is modified in an admin mode

Definition at line 24 of file ModuleObject.class.php.

ModuleObject::$gzhandler_enable = TRUE

Definition at line 28 of file ModuleObject.class.php.

ModuleObject::$layout_file = ''

name of layout file

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

ModuleObject::$layout_path = ''

a path of directory where layout files reside

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

ModuleObject::$mid = NULL

string to represent run-time instance of Module (XE Module)

Definition at line 12 of file ModuleObject.class.php.

ModuleObject::$module = NULL

Class name of Xe Module that is identified by mid.

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

ModuleObject::$module_config = NULL

Definition at line 26 of file ModuleObject.class.php.

ModuleObject::$module_info = NULL

an object containing the module information

Definition at line 15 of file ModuleObject.class.php.

ModuleObject::$module_path = NULL

a path to directory where module source code resides

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

ModuleObject::$module_srl = NULL

integer value to represent a run-time instance of Module (XE Module)

Definition at line 14 of file ModuleObject.class.php.

ModuleObject::$origin_module_info = NULL

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

ModuleObject::$stop_proc = FALSE

a flag to indicating whether to stop the execution of code.

Definition at line 25 of file ModuleObject.class.php.

ModuleObject::$template_file = NULL

name of template file

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

ModuleObject::$template_path = NULL

a path of directory where template files reside

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

ModuleObject::$xml_info = NULL

an object containing the module description extracted from XML file

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

---

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

• classes/module/ModuleObject.class.php