|
XpressEngine Core
1.11.2
|
|
XpressEngine Core
1.11.2
|
Model class of module module. More...
Public Member Functions | |
| init () | |
| Initialization. More... | |
| isIDExists ($id, $site_srl=0) | |
| Check if mid, vid are available. More... | |
| getSiteInfo ($site_srl, $columnList=array()) | |
| Get site information. More... | |
| getSiteInfoByDomain ($domain, $columnList=array()) | |
| getModuleInfoByDocumentSrl ($document_srl) | |
| Get module information with document_srl In this case, it is unable to use the cache file. More... | |
| getDefaultMid () | |
| Get the default mid according to the domain. More... | |
| getModuleInfoByMid ($mid, $site_srl=0, $columnList=array()) | |
| Get module information by mid. More... | |
| getModuleInfoByMenuItemSrl ($menu_item_srl=0) | |
| getModuleInfoByModuleSrl ($module_srl, $columnList=array()) | |
| Get module information corresponding to module_srl. More... | |
| getModulesInfoByLayout ($layout_srl, $columnList=array()) | |
| Get module information corresponding to layout_srl. More... | |
| getModulesInfo ($module_srls, $columnList=array()) | |
| Get module information corresponding to multiple module_srls. More... | |
| addModuleExtraVars ($module_info) | |
| Add extra vars to the module basic information. More... | |
| getMidList ($args=null, $columnList=array()) | |
| Get a complete list of mid, which is created in the DB. More... | |
| getModuleSrlList ($args=null, $columnList=array()) | |
| Get a complete list of module_srl, which is created in the DB. More... | |
| getModuleSrlByMid ($mid) | |
| Return an array of module_srl corresponding to a mid list. More... | |
| getActionForward ($act) | |
| Get forward value by the value of act. More... | |
| getTriggers ($trigger_name, $called_position) | |
| Get a list of all triggers on the trigger_name. More... | |
| getTrigger ($trigger_name, $module, $type, $called_method, $called_position) | |
| Get specific triggers from the trigger_name. More... | |
| getModuleExtend ($parent_module, $type, $kind='') | |
| Get module extend. More... | |
| loadModuleExtends () | |
| Get all the module extend. More... | |
| getModuleInfoXml ($module) | |
| Get information from conf/info.xml. More... | |
| getModuleActionXml ($module) | |
| Return permisson and action data by conf/module.xml in the module Cache it because it takes too long to parse module.xml file When caching, add codes so to include it directly This is apparently good for performance, but not sure about its side-effects. More... | |
| getModuleSkinInfoList () | |
| getSkins ($path, $dir= 'skins') | |
| Get a list of skins for the module Return file analysis of skin and skin.xml. More... | |
| loadSkinInfo ($path, $skin, $dir= 'skins') | |
| Get skin information on a specific location. More... | |
| getModuleCount ($site_srl, $module=null) | |
| Return the number of modules which are registered on a virtual site. More... | |
| getModuleConfig ($module, $site_srl=0) | |
| Return module configurations Global configuration is used to manage board, member and others. More... | |
| getModulePartConfig ($module, $module_srl) | |
| Return the module configuration of mid Manage mid configurations which depend on module. More... | |
| getModulePartConfigs ($module, $site_srl=0) | |
| Get all of module configurations for each mid. More... | |
| getModuleCategories ($moduleCategorySrl=array()) | |
| Get a list of module category. More... | |
| getModuleCategory ($module_category_srl) | |
| Get content from the module category. More... | |
| getModulesXmlInfo () | |
| Get xml information of the module. More... | |
| checkNeedInstall ($module_name) | |
| checkNeedUpdate ($module_name) | |
| needUpdate ($update_id) | |
| 업데이트 적용 여부 확인 More... | |
| getModuleList () | |
| Get a type and information of the module. More... | |
| syncModuleToSite (&$data) | |
| Combine module_srls with domain of sites Because XE DBHandler doesn't support left outer join, it should be as same as $Output->data[]->module_srl. More... | |
| isSiteAdmin ($member_info, $site_srl=null) | |
| Check if it is an administrator of site_module_info. More... | |
| getSiteAdmin ($site_srl) | |
| Get admin information of the site. More... | |
| getAdminId ($module_srl) | |
| Get admin ID of the module. More... | |
| getModuleExtraVars ($list_module_srl) | |
| Get extra vars of the module Extra information, not in the modules table. More... | |
| getModuleSkinVars ($module_srl) | |
| Get skin information of the module. More... | |
| getModuleDefaultSkin ($module_name, $skin_type= 'P', $site_srl=0, $updateCache=true) | |
| syncSkinInfoToModuleInfo (&$module_info) | |
| Combine skin information with module information. More... | |
| getModuleMobileSkinVars ($module_srl) | |
| syncMobileSkinInfoToModuleInfo (&$module_info) | |
| getGrant ($module_info, $member_info, $xml_info= '') | |
| Return permission by using module info, xml info and member info. More... | |
| getModuleFileBox ($module_filebox_srl) | |
| getModuleFileBoxList () | |
| unserializeAttributes ($module_filebox_list) | |
| getFileBoxListHtml () | |
| getModuleFileBoxPath ($module_filebox_srl) | |
| getValidatorFilePath ($module, $ruleset, $mid=null) | |
| Return ruleset cache file path. More... | |
| getLangListByLangcodeForAutoComplete () | |
| getModuleListByInstance ($site_srl=0, $columnList=array()) | |
| already instance created module list More... | |
| getLangByLangcode () | |
 Public Member Functions inherited from module | |
| moduleInstall () | |
| Implement if additional tasks are necessary when installing. More... | |
| checkUpdate () | |
| a method to check if successfully installed More... | |
| moduleUpdate () | |
| Execute update. More... | |
| updateForUniqueSiteDomain () | |
| 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 | |
Model class of module module.
Definition at line 8 of file module.model.php.
| moduleModel::addModuleExtraVars | ( | $module_info | ) |
Add extra vars to the module basic information.
Definition at line 464 of file module.model.php.
| moduleModel::checkNeedInstall | ( | $module_name | ) |
Definition at line 1528 of file module.model.php.
| moduleModel::checkNeedUpdate | ( | $module_name | ) |
Definition at line 1552 of file module.model.php.
| moduleModel::getActionForward | ( | $act | ) |
Get forward value by the value of act.
Definition at line 585 of file module.model.php.
| moduleModel::getAdminId | ( | $module_srl | ) |
Get admin ID of the module.
Definition at line 1731 of file module.model.php.
| moduleModel::getDefaultMid | ( | ) |
Get the default mid according to the domain.
Definition at line 82 of file module.model.php.
| moduleModel::getFileBoxListHtml | ( | ) |
Definition at line 2217 of file module.model.php.
| moduleModel::getGrant | ( | $module_info, | |
| $member_info, | |||
$xml_info = '' |
|||
| ) |
Return permission by using module info, xml info and member info.
Definition at line 2004 of file module.model.php.
| moduleModel::getLangByLangcode | ( | ) |
Definition at line 2332 of file module.model.php.
| moduleModel::getLangListByLangcodeForAutoComplete | ( | ) |
Definition at line 2290 of file module.model.php.
| moduleModel::getMidList | ( | $args = null, |
|
$columnList = array() |
|||
| ) |
Get a complete list of mid, which is created in the DB.
Definition at line 498 of file module.model.php.
| moduleModel::getModuleActionXml | ( | $module | ) |
Return permisson and action data by conf/module.xml in the module Cache it because it takes too long to parse module.xml file When caching, add codes so to include it directly This is apparently good for performance, but not sure about its side-effects.
Definition at line 816 of file module.model.php.
| moduleModel::getModuleCategories | ( | $moduleCategorySrl = array() | ) |
Get a list of module category.
Definition at line 1465 of file module.model.php.
| moduleModel::getModuleCategory | ( | $module_category_srl | ) |
Get content from the module category.
Definition at line 1486 of file module.model.php.
| moduleModel::getModuleConfig | ( | $module, | |
$site_srl = 0 |
|||
| ) |
Return module configurations Global configuration is used to manage board, member and others.
Definition at line 1368 of file module.model.php.
| moduleModel::getModuleCount | ( | $site_srl, | |
$module = null |
|||
| ) |
Return the number of modules which are registered on a virtual site.
Definition at line 1355 of file module.model.php.
| moduleModel::getModuleDefaultSkin | ( | $module_name, | |
$skin_type = 'P', |
|||
$site_srl = 0, |
|||
$updateCache = true |
|||
| ) |
Get default skin name
Definition at line 1853 of file module.model.php.
| moduleModel::getModuleExtend | ( | $parent_module, | |
| $type, | |||
$kind = '' |
|||
| ) |
Get module extend.
Definition at line 682 of file module.model.php.
| moduleModel::getModuleExtraVars | ( | $list_module_srl | ) |
Get extra vars of the module Extra information, not in the modules table.
Definition at line 1745 of file module.model.php.
| moduleModel::getModuleFileBox | ( | $module_filebox_srl | ) |
Definition at line 2166 of file module.model.php.
| moduleModel::getModuleFileBoxList | ( | ) |
Definition at line 2173 of file module.model.php.
| moduleModel::getModuleFileBoxPath | ( | $module_filebox_srl | ) |
Definition at line 2250 of file module.model.php.
| moduleModel::getModuleInfoByDocumentSrl | ( | $document_srl | ) |
Get module information with document_srl In this case, it is unable to use the cache file.
Definition at line 70 of file module.model.php.
| moduleModel::getModuleInfoByMenuItemSrl | ( | $menu_item_srl = 0 | ) |
Get module info by menu_item_srl.
int $menu_item_srl
Definition at line 262 of file module.model.php.
| moduleModel::getModuleInfoByMid | ( | $mid, | |
$site_srl = 0, |
|||
$columnList = array() |
|||
| ) |
Get module information by mid.
Definition at line 208 of file module.model.php.
| moduleModel::getModuleInfoByModuleSrl | ( | $module_srl, | |
$columnList = array() |
|||
| ) |
Get module information corresponding to module_srl.
Definition at line 367 of file module.model.php.
| moduleModel::getModuleInfoXml | ( | $module | ) |
Get information from conf/info.xml.
Definition at line 741 of file module.model.php.
| moduleModel::getModuleList | ( | ) |
Get a type and information of the module.
Definition at line 1586 of file module.model.php.
| moduleModel::getModuleListByInstance | ( | $site_srl = 0, |
|
$columnList = array() |
|||
| ) |
already instance created module list
Definition at line 2324 of file module.model.php.
| moduleModel::getModuleMobileSkinVars | ( | $module_srl | ) |
Get mobile skin information of the module
| $module_srl | Sequence of module |
Definition at line 1935 of file module.model.php.
| moduleModel::getModulePartConfig | ( | $module, | |
| $module_srl | |||
| ) |
Return the module configuration of mid Manage mid configurations which depend on module.
Definition at line 1408 of file module.model.php.
| moduleModel::getModulePartConfigs | ( | $module, | |
$site_srl = 0 |
|||
| ) |
Get all of module configurations for each mid.
Definition at line 1447 of file module.model.php.
| moduleModel::getModulesInfo | ( | $module_srls, | |
$columnList = array() |
|||
| ) |
Get module information corresponding to multiple module_srls.
Definition at line 451 of file module.model.php.
| moduleModel::getModulesInfoByLayout | ( | $layout_srl, | |
$columnList = array() |
|||
| ) |
Get module information corresponding to layout_srl.
Definition at line 431 of file module.model.php.
| moduleModel::getModuleSkinInfoList | ( | ) |
Get a skin list for js API. return void
Definition at line 1022 of file module.model.php.
| moduleModel::getModuleSkinVars | ( | $module_srl | ) |
Get skin information of the module.
Definition at line 1820 of file module.model.php.
| moduleModel::getModuleSrlByMid | ( | $mid | ) |
Return an array of module_srl corresponding to a mid list.
Definition at line 557 of file module.model.php.
| moduleModel::getModuleSrlList | ( | $args = null, |
|
$columnList = array() |
|||
| ) |
Get a complete list of module_srl, which is created in the DB.
Definition at line 543 of file module.model.php.
| moduleModel::getModulesXmlInfo | ( | ) |
Get xml information of the module.
Definition at line 1499 of file module.model.php.
| moduleModel::getSiteAdmin | ( | $site_srl | ) |
Get admin information of the site.
Definition at line 1720 of file module.model.php.
| moduleModel::getSiteInfo | ( | $site_srl, | |
$columnList = array() |
|||
| ) |
Get site information.
Definition at line 50 of file module.model.php.
| moduleModel::getSiteInfoByDomain | ( | $domain, | |
$columnList = array() |
|||
| ) |
Definition at line 58 of file module.model.php.
| moduleModel::getSkins | ( | $path, | |
$dir = 'skins' |
|||
| ) |
Get a list of skins for the module Return file analysis of skin and skin.xml.
Definition at line 1044 of file module.model.php.
| moduleModel::getTrigger | ( | $trigger_name, | |
| $module, | |||
| $type, | |||
| $called_method, | |||
| $called_position | |||
| ) |
Get specific triggers from the trigger_name.
Definition at line 661 of file module.model.php.
| moduleModel::getTriggers | ( | $trigger_name, | |
| $called_position | |||
| ) |
Get a list of all triggers on the trigger_name.
Definition at line 629 of file module.model.php.
| moduleModel::getValidatorFilePath | ( | $module, | |
| $ruleset, | |||
$mid = null |
|||
| ) |
Return ruleset cache file path.
| module,act |
Definition at line 2259 of file module.model.php.
| moduleModel::init | ( | ) |
Initialization.
Definition at line 13 of file module.model.php.
| moduleModel::isIDExists | ( | $id, | |
$site_srl = 0 |
|||
| ) |
Check if mid, vid are available.
Definition at line 20 of file module.model.php.
| moduleModel::isSiteAdmin | ( | $member_info, | |
$site_srl = null |
|||
| ) |
Check if it is an administrator of site_module_info.
Definition at line 1694 of file module.model.php.
| moduleModel::loadModuleExtends | ( | ) |
Get all the module extend.
Definition at line 698 of file module.model.php.
| moduleModel::loadSkinInfo | ( | $path, | |
| $skin, | |||
$dir = 'skins' |
|||
| ) |
Get skin information on a specific location.
Definition at line 1133 of file module.model.php.
| moduleModel::needUpdate | ( | $update_id | ) |
업데이트 적용 여부 확인
| array | string | $update_id |
Definition at line 1568 of file module.model.php.
| moduleModel::syncMobileSkinInfoToModuleInfo | ( | & | $module_info | ) |
Combine skin information with module information
| $module_info | Module information |
Definition at line 1969 of file module.model.php.
| moduleModel::syncModuleToSite | ( | & | $data | ) |
Combine module_srls with domain of sites Because XE DBHandler doesn't support left outer join, it should be as same as $Output->data[]->module_srl.
Definition at line 1652 of file module.model.php.
| moduleModel::syncSkinInfoToModuleInfo | ( | & | $module_info | ) |
Combine skin information with module information.
Definition at line 1907 of file module.model.php.
| moduleModel::unserializeAttributes | ( | $module_filebox_list | ) |
Definition at line 2186 of file module.model.php.
1.8.5
