|
XpressEngine Core
1.11.2
|
|
XpressEngine Core
1.11.2
|
model class of the editor odule More...
Public Member Functions | |
| getEditorConfig ($module_srl=null) | |
| Return the editor. More... | |
| loadDrComponents () | |
| getDrComponentXmlInfo ($drComponentName) | |
| getEditor ($upload_target_srl=0, $option=null) | |
| Return the editor template You can call upload_target_srl when modifying content The upload_target_srl is used for a routine to check if an attachment exists. More... | |
| getModuleEditor ($type= 'document', $module_srl, $upload_target_srl, $primary_key_name, $content_key_name) | |
| Return editor template which contains settings of each module Result of getModuleEditor() is as same as getEditor(). But getModuleEditor()uses additional settings of each module to generate an editor. More... | |
| getSavedDoc ($upload_target_srl) | |
| Get information which has been auto-saved. More... | |
| getComponentObject ($component, $editor_sequence=0, $site_srl=0) | |
| create objects of the component More... | |
| getEditorSkinList () | |
| Return a list of the editor skin. More... | |
| getCacheFile ($filter_enabled=true, $site_srl=0) | |
| Return the cache file name of editor component list. More... | |
| getComponentListCacheKey ($filter_enabled=true, $site_srl=0) | |
| getComponentList ($filter_enabled=true, $site_srl=0, $from_db=false) | |
| Return a component list (DB Information included) More... | |
| getComponent ($component_name, $site_srl=0) | |
| Get xml and db information of the component. More... | |
| getComponentXmlInfo ($component) | |
| Read xml information of the component. More... | |
 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 () | |
Public Attributes | |
| $loaded_component_list = array() | |
| 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 | |
model class of the editor odule
Definition at line 8 of file editor.model.php.
| editorModel::getCacheFile | ( | $filter_enabled = true, |
|
$site_srl = 0 |
|||
| ) |
Return the cache file name of editor component list.
Definition at line 588 of file editor.model.php.
| editorModel::getComponent | ( | $component_name, | |
$site_srl = 0 |
|||
| ) |
Get xml and db information of the component.
Definition at line 693 of file editor.model.php.
| editorModel::getComponentList | ( | $filter_enabled = true, |
|
$site_srl = 0, |
|||
$from_db = false |
|||
| ) |
Return a component list (DB Information included)
Definition at line 613 of file editor.model.php.
| editorModel::getComponentListCacheKey | ( | $filter_enabled = true, |
|
$site_srl = 0 |
|||
| ) |
Definition at line 600 of file editor.model.php.
| editorModel::getComponentObject | ( | $component, | |
$editor_sequence = 0, |
|||
$site_srl = 0 |
|||
| ) |
create objects of the component
Definition at line 554 of file editor.model.php.
| editorModel::getComponentXmlInfo | ( | $component | ) |
Read xml information of the component.
Definition at line 752 of file editor.model.php.
| editorModel::getDrComponentXmlInfo | ( | $drComponentName | ) |
Definition at line 116 of file editor.model.php.
| editorModel::getEditor | ( | $upload_target_srl = 0, |
|
$option = null |
|||
| ) |
Return the editor template You can call upload_target_srl when modifying content The upload_target_srl is used for a routine to check if an attachment exists.
Editor's default options
Check the automatic backup feature (do not use if the post is edited)
Extract editor's unique number (in order to display multiple editors on a single page)
Upload setting by using configuration of the file module internally
Check editor component
Variable setting if html_mode is available
Set a height of editor
Set a skin path to pre-compile the template
Definition at line 195 of file editor.model.php.
| editorModel::getEditorConfig | ( | $module_srl = null | ) |
Return the editor.
Editor internally generates editor_sequence from 1 to 30 for temporary use. That means there is a limitation that more than 30 editors cannot be displayed on a single page.
However, editor_sequence can be value from getNextSequence() in case of the modified or the auto-saved for file upload Return editor setting for each module
Definition at line 24 of file editor.model.php.
| editorModel::getEditorSkinList | ( | ) |
Return a list of the editor skin.
Definition at line 580 of file editor.model.php.
| editorModel::getModuleEditor | ( | $type = 'document', |
|
| $module_srl, | |||
| $upload_target_srl, | |||
| $primary_key_name, | |||
| $content_key_name | |||
| ) |
Return editor template which contains settings of each module Result of getModuleEditor() is as same as getEditor(). But getModuleEditor()uses additional settings of each module to generate an editor.
2 types of editors supported; document and comment. 2 types of editors can be used on a single module. For instance each for original post and reply port.
Definition at line 361 of file editor.model.php.
| editorModel::getSavedDoc | ( | $upload_target_srl | ) |
Get information which has been auto-saved.
Definition at line 493 of file editor.model.php.
| editorModel::loadDrComponents | ( | ) |
Definition at line 93 of file editor.model.php.
| editorModel::$loaded_component_list = array() |
Definition at line 10 of file editor.model.php.
1.8.5
