XpressEngine Core  1.11.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
moduleController Class Reference

controller class of the module module More...

Inheritance diagram for moduleController:
module ModuleObject BaseObject

Public Member Functions

 init ()
 Initialization. More...
 
 insertActionForward ($module, $type, $act)
 Add action forward Action forward finds and forwards if an action is not in the requested module This is used when installing a module. More...
 
 deleteActionForward ($module, $type, $act)
 Delete action forward. More...
 
 insertTrigger ($trigger_name, $module, $type, $called_method, $called_position)
 Add module trigger module trigger is to call a trigger to a target module. More...
 
 deleteTrigger ($trigger_name, $module, $type, $called_method, $called_position)
 Delete module trigger. More...
 
 deleteModuleTriggers ($module)
 Delete module trigger. More...
 
 insertModuleExtend ($parent_module, $extend_module, $type, $kind='')
 Add module extend. More...
 
 deleteModuleExtend ($parent_module, $extend_module, $type, $kind='')
 Delete module extend. More...
 
 updateModuleConfig ($module, $config, $site_srl=0)
 
 insertModuleConfig ($module, $config, $site_srl=0)
 Enter a specific set of modules In order to manage global configurations of modules such as board, member and so on. More...
 
 insertModulePartConfig ($module, $module_srl, $config)
 Save module configurations of the mid Manage mid configurations depending on module. More...
 
 insertSite ($domain, $index_module_srl)
 create virtual site More...
 
 updateSite ($args)
 modify virtual site More...
 
 arrangeModuleInfo (&$args, &$extra_vars)
 Arrange module information. More...
 
 insertModule ($args)
 Insert module. More...
 
 updateModule ($args)
 Modify module information. More...
 
 insertUpdatedLog ($update_id)
 업데이트 기록 저장 More...
 
 updateModuleSite ($module_srl, $site_srl, $layout_srl=0)
 Change the module's virtual site. More...
 
 deleteModule ($module_srl, $site_srl=0)
 
 onlyDeleteModule ($module_srl)
 
 updateModuleSkinVars ($module_srl, $skin_vars)
 Change other information of the module. More...
 
 clearDefaultModule ()
 Set is_default as N in all modules(the default module is disabled) More...
 
 updateModuleMenu ($args)
 Update menu_srl of mid which belongs to menu_srl. More...
 
 updateModuleLayout ($layout_srl, $menu_srl_list)
 Update layout_srl of mid which belongs to menu_srl. More...
 
 insertSiteAdmin ($site_srl, $arr_admins)
 Change the site administrator. More...
 
 insertAdminId ($module_srl, $admin_id)
 Specify the admin ID to a module. More...
 
 deleteAdminId ($module_srl, $admin_id= '')
 Remove the admin ID from a module. More...
 
 insertModuleSkinVars ($module_srl, $obj)
 
 insertModuleMobileSkinVars ($module_srl, $obj)
 
 _insertModuleSkinVars ($module_srl, $obj, $mode)
 Insert skin vars to a module. More...
 
 deleteModuleSkinVars ($module_srl)
 
 deleteModuleMobileSkinVars ($module_srl)
 
 _deleteModuleSkinVars ($module_srl, $mode)
 Remove skin vars of a module. More...
 
 insertModuleExtraVars ($module_srl, $obj)
 Register extra vars to the module. More...
 
 deleteModuleExtraVars ($module_srl)
 Remove extra vars from the module. More...
 
 insertModuleGrants ($module_srl, $obj)
 Grant permission to the module. More...
 
 deleteModuleGrants ($module_srl)
 Remove permission from the module. More...
 
 replaceDefinedLangCode (&$output, $isReplaceLangCode=true)
 Change user-defined language. More...
 
 _replaceLangCode ($matches)
 
 procModuleFileBoxAdd ()
 Add and update a file into the file box. More...
 
 updateModuleFileBox ($vars)
 Update a file into the file box. More...
 
 insertModuleFileBox ($vars)
 Add a file into the file box. More...
 
 procModuleFileBoxDelete ()
 Delete a file from the file box. More...
 
 deleteModuleFileBox ($vars)
 
 lock ($lock_name, $timeout, $member_srl=null)
 function of locking (timeout is in seconds) More...
 
 unlockTimeoutPassed ()
 
 unlock ($lock_name, $deadline)
 
 updateModuleInSites ($site_srls, $args)
 
- 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
 

Detailed Description

controller class of the module module

Author
NAVER (devel.nosp@m.oper.nosp@m.s@xpr.nosp@m.esse.nosp@m.ngine.nosp@m..com)

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

Member Function Documentation

moduleController::_deleteModuleSkinVars (   $module_srl,
  $mode 
)

Remove skin vars of a module.

Definition at line 1038 of file module.controller.php.

moduleController::_insertModuleSkinVars (   $module_srl,
  $obj,
  $mode 
)

Insert skin vars to a module.

Definition at line 965 of file module.controller.php.

moduleController::_replaceLangCode (   $matches)

Definition at line 1162 of file module.controller.php.

moduleController::arrangeModuleInfo ( $args,
$extra_vars 
)

Arrange module information.

Definition at line 341 of file module.controller.php.

moduleController::clearDefaultModule ( )

Set is_default as N in all modules(the default module is disabled)

Definition at line 807 of file module.controller.php.

moduleController::deleteActionForward (   $module,
  $type,
  $act 
)

Delete action forward.

Definition at line 44 of file module.controller.php.

moduleController::deleteAdminId (   $module_srl,
  $admin_id = '' 
)

Remove the admin ID from a module.

Definition at line 927 of file module.controller.php.

moduleController::deleteModule (   $module_srl,
  $site_srl = 0 
)

Delete module Attempt to delete all related information when deleting a module. Origin method is changed. because menu validation check is needed

Definition at line 672 of file module.controller.php.

moduleController::deleteModuleExtend (   $parent_module,
  $extend_module,
  $type,
  $kind = '' 
)

Delete module extend.

Definition at line 177 of file module.controller.php.

moduleController::deleteModuleExtraVars (   $module_srl)

Remove extra vars from the module.

Definition at line 1099 of file module.controller.php.

moduleController::deleteModuleFileBox (   $vars)

Definition at line 1359 of file module.controller.php.

moduleController::deleteModuleGrants (   $module_srl)

Remove permission from the module.

Definition at line 1144 of file module.controller.php.

moduleController::deleteModuleMobileSkinVars (   $module_srl)

Remove mobile skin vars ofa module

Parameters
$module_srlseqence of module

Definition at line 1030 of file module.controller.php.

moduleController::deleteModuleSkinVars (   $module_srl)

Remove skin vars ofa module

Parameters
$module_srlseqence of module

Definition at line 1021 of file module.controller.php.

moduleController::deleteModuleTriggers (   $module)

Delete module trigger.

Definition at line 126 of file module.controller.php.

moduleController::deleteTrigger (   $trigger_name,
  $module,
  $type,
  $called_method,
  $called_position 
)

Delete module trigger.

Definition at line 97 of file module.controller.php.

moduleController::init ( )

Initialization.

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

moduleController::insertActionForward (   $module,
  $type,
  $act 
)

Add action forward Action forward finds and forwards if an action is not in the requested module This is used when installing a module.

Definition at line 22 of file module.controller.php.

moduleController::insertAdminId (   $module_srl,
  $admin_id 
)

Specify the admin ID to a module.

Definition at line 907 of file module.controller.php.

moduleController::insertModule (   $args)

Insert module.

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

moduleController::insertModuleConfig (   $module,
  $config,
  $site_srl = 0 
)

Enter a specific set of modules In order to manage global configurations of modules such as board, member and so on.

Definition at line 216 of file module.controller.php.

moduleController::insertModuleExtend (   $parent_module,
  $extend_module,
  $type,
  $kind = '' 
)

Add module extend.

Definition at line 151 of file module.controller.php.

moduleController::insertModuleExtraVars (   $module_srl,
  $obj 
)

Register extra vars to the module.

Definition at line 1069 of file module.controller.php.

moduleController::insertModuleFileBox (   $vars)

Add a file into the file box.

Definition at line 1307 of file module.controller.php.

moduleController::insertModuleGrants (   $module_srl,
  $obj 
)

Grant permission to the module.

Definition at line 1120 of file module.controller.php.

moduleController::insertModuleMobileSkinVars (   $module_srl,
  $obj 
)

Insert mobile skin vars to a module

Parameters
$module_srlSequence of module
$objSkin variables

Definition at line 956 of file module.controller.php.

moduleController::insertModulePartConfig (   $module,
  $module_srl,
  $config 
)

Save module configurations of the mid Manage mid configurations depending on module.

Definition at line 241 of file module.controller.php.

moduleController::insertModuleSkinVars (   $module_srl,
  $obj 
)

Insert skin vars to a module

Parameters
$module_srlSequence of module
$objSkin variables

Definition at line 946 of file module.controller.php.

moduleController::insertSite (   $domain,
  $index_module_srl 
)

create virtual site

Definition at line 266 of file module.controller.php.

moduleController::insertSiteAdmin (   $site_srl,
  $arr_admins 
)

Change the site administrator.

Definition at line 861 of file module.controller.php.

moduleController::insertTrigger (   $trigger_name,
  $module,
  $type,
  $called_method,
  $called_position 
)

Add module trigger module trigger is to call a trigger to a target module.

Definition at line 68 of file module.controller.php.

moduleController::insertUpdatedLog (   $update_id)

업데이트 기록 저장

Parameters
string$update_id
Returns
Boolean

Definition at line 634 of file module.controller.php.

moduleController::lock (   $lock_name,
  $timeout,
  $member_srl = null 
)

function of locking (timeout is in seconds)

Definition at line 1374 of file module.controller.php.

moduleController::onlyDeleteModule (   $module_srl)

Delete module Attempt to delete all related information when deleting a module.

Definition at line 735 of file module.controller.php.

moduleController::procModuleFileBoxAdd ( )

Add and update a file into the file box.

Definition at line 1196 of file module.controller.php.

moduleController::procModuleFileBoxDelete ( )

Delete a file from the file box.

Definition at line 1346 of file module.controller.php.

moduleController::replaceDefinedLangCode ( $output,
  $isReplaceLangCode = true 
)

Change user-defined language.

Definition at line 1154 of file module.controller.php.

moduleController::unlock (   $lock_name,
  $deadline 
)

Definition at line 1396 of file module.controller.php.

moduleController::unlockTimeoutPassed ( )

Definition at line 1391 of file module.controller.php.

moduleController::updateModule (   $args)

Modify module information.

Definition at line 508 of file module.controller.php.

moduleController::updateModuleConfig (   $module,
  $config,
  $site_srl = 0 
)

Definition at line 193 of file module.controller.php.

moduleController::updateModuleFileBox (   $vars)

Update a file into the file box.

Definition at line 1266 of file module.controller.php.

moduleController::updateModuleInSites (   $site_srls,
  $args 
)

Definition at line 1405 of file module.controller.php.

moduleController::updateModuleLayout (   $layout_srl,
  $menu_srl_list 
)

Update layout_srl of mid which belongs to menu_srl.

Definition at line 840 of file module.controller.php.

moduleController::updateModuleMenu (   $args)

Update menu_srl of mid which belongs to menu_srl.

Definition at line 824 of file module.controller.php.

moduleController::updateModuleSite (   $module_srl,
  $site_srl,
  $layout_srl = 0 
)

Change the module's virtual site.

Definition at line 648 of file module.controller.php.

moduleController::updateModuleSkinVars (   $module_srl,
  $skin_vars 
)

Change other information of the module.

Deprecated:

Definition at line 799 of file module.controller.php.

moduleController::updateSite (   $args)

modify virtual site

Definition at line 299 of file module.controller.php.


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