document Class Reference

document the module's high class { More...

Inheritance diagram for document:

Public Member Functions
	moduleInstall ()
	checkUpdate ()
	moduleUpdate ()
	recompileCache ()
	getStatusList ()
	getDefaultStatus ()
	getConfigStatus ($key)
Public Member Functions inherited from ModuleObject
	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
	$search_option = array('title','content','title_content','user_name',)
	$statusList = array('private'=>'PRIVATE', 'public'=>'PUBLIC', 'secret'=>'SECRET', 'temp'=>'TEMP')
Public Attributes inherited from ModuleObject
	$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

document the module's high class {

document class

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

Member Function Documentation

document::checkUpdate

(

)

A method to check if successfully installed

Returns

bool

1. 01. 29: Add a column(lang_code) if not exist in the document_extra_vars table

Definition at line 64 of file document.class.php.

document::getConfigStatus

(

$key

)

Return status by key

Returns

string

Definition at line 377 of file document.class.php.

document::getDefaultStatus

(

)

Return default status

Returns

string

Definition at line 368 of file document.class.php.

document::getStatusList

(

)

Document Status List

Returns

array

Definition at line 359 of file document.class.php.

document::moduleInstall

(

)

Implement if additional tasks are necessary when installing

Returns

BaseObject

Definition at line 31 of file document.class.php.

document::moduleUpdate

(

)

Execute update

Returns

BaseObject

Definition at line 146 of file document.class.php.

document::recompileCache

(

)

Re-generate the cache file

Returns

void

Definition at line 347 of file document.class.php.

Member Data Documentation

document::$search_option = array('title','content','title_content','user_name',)

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

document::$statusList = array('private'=>'PRIVATE', 'public'=>'PUBLIC', 'secret'=>'SECRET', 'temp'=>'TEMP')

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

---

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

• modules/document/document.class.php