XpressEngine Core  1.11.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
editorController Class Reference
Inheritance diagram for editorController:
editor ModuleObject BaseObject

Public Member Functions

 init ()
 Initialization. More...
 
 procEditorSaveDoc ()
 AutoSave. More...
 
 procEditorRemoveSavedDoc ()
 Delete autosaved documents. More...
 
 procEditorCall ()
 Execute a method of the component when the component requests ajax. More...
 
 procEditorInsertModuleConfig ()
 Save Editor's additional form for each module. More...
 
 triggerEditorComponentCompile (&$content)
 convert editor component codes to be returned and specify content style. More...
 
 transComponent ($content)
 Convert editor component codes to be returned. More...
 
 transEditorComponent ($match)
 Convert editor component code of the contents. More...
 
 doSaveDoc ($args)
 AutoSave. More...
 
 procEditorLoadSavedDocument ()
 Load the srl of autosaved document - for those who uses XE older versions. More...
 
 triggerDeleteSavedDoc (&$obj)
 A trigger to remove auto-saved document when inserting/updating the document. More...
 
 deleteSavedDoc ($mode=false)
 Delete the auto-saved document Based on the current logged-in user. More...
 
 removeEditorConfig ($site_srl)
 ERemove editor component information used on the virtual site. More...
 
 makeCache ($filter_enabled=true, $site_srl)
 Caching a list of editor component (editorModel::getComponentList) For the editor component list, use a caching file because of DB query and Xml parsing. More...
 
 removeCache ($site_srl=0)
 Delete cache files. More...
 
 triggerCopyModule (&$obj)
 
- Public Member Functions inherited from editor
 moduleInstall ()
 Implement if additional tasks are necessary when installing. More...
 
 checkUpdate ()
 a method to check if successfully installed More...
 
 moduleUpdate ()
 Execute update. More...
 
 recompileCache ()
 Re-generate the cache file. More...
 
- 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 ()
 

Additional Inherited Members

- 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

Definition at line 8 of file editor.controller.php.

Member Function Documentation

editorController::deleteSavedDoc (   $mode = false)

Delete the auto-saved document Based on the current logged-in user.

Definition at line 321 of file editor.controller.php.

editorController::doSaveDoc (   $args)

AutoSave.

Definition at line 260 of file editor.controller.php.

editorController::init ( )

Initialization.

Definition at line 13 of file editor.controller.php.

editorController::makeCache (   $filter_enabled = true,
  $site_srl 
)

Caching a list of editor component (editorModel::getComponentList) For the editor component list, use a caching file because of DB query and Xml parsing.

Definition at line 380 of file editor.controller.php.

editorController::procEditorCall ( )

Execute a method of the component when the component requests ajax.

Definition at line 46 of file editor.controller.php.

editorController::procEditorInsertModuleConfig ( )

Save Editor's additional form for each module.

Definition at line 81 of file editor.controller.php.

editorController::procEditorLoadSavedDocument ( )

Load the srl of autosaved document - for those who uses XE older versions.

Definition at line 290 of file editor.controller.php.

editorController::procEditorRemoveSavedDoc ( )

Delete autosaved documents.

Definition at line 37 of file editor.controller.php.

editorController::procEditorSaveDoc ( )

AutoSave.

Definition at line 20 of file editor.controller.php.

editorController::removeCache (   $site_srl = 0)

Delete cache files.

Definition at line 511 of file editor.controller.php.

editorController::removeEditorConfig (   $site_srl)

ERemove editor component information used on the virtual site.

Definition at line 370 of file editor.controller.php.

editorController::transComponent (   $content)

Convert editor component codes to be returned.

Definition at line 223 of file editor.controller.php.

editorController::transEditorComponent (   $match)

Convert editor component code of the contents.

Definition at line 232 of file editor.controller.php.

editorController::triggerCopyModule ( $obj)

Definition at line 526 of file editor.controller.php.

editorController::triggerDeleteSavedDoc ( $obj)

A trigger to remove auto-saved document when inserting/updating the document.

Definition at line 311 of file editor.controller.php.

editorController::triggerEditorComponentCompile ( $content)

convert editor component codes to be returned and specify content style.

Definition at line 170 of file editor.controller.php.


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