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

Public Member Functions

 init ()
 
 getCacheFilePath ($type="pc")
 
 _getMidList ($selected_addon, $site_srl=0)
 
 makeCacheFile ($site_srl=0, $type="pc", $gtype= 'site')
 
 doSetup ($addon, $extra_vars, $site_srl=0, $gtype= 'site')
 
 removeAddonConfig ($site_srl)
 
- Public Member Functions inherited from addon
 moduleInstall ()
 
 checkUpdate ()
 
 moduleUpdate ()
 
 recompileCache ()
 
- 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

Addon module's controller class

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 addon.controller.php.

Member Function Documentation

addonController::_getMidList (   $selected_addon,
  $site_srl = 0 
)

Returns mid list that addons is run

Parameters
string$selected_addonName to get list
int$site_srlSite srl
Returns
string[] Returns list that contain mid

Definition at line 64 of file addon.controller.php.

addonController::doSetup (   $addon,
  $extra_vars,
  $site_srl = 0,
  $gtype = 'site' 
)

Save setup

Parameters
string$addonAddon name
object$extra_varsExtra variables
int$site_srlSite srl
string$gtypesite or global
Returns
BaseObject

Definition at line 153 of file addon.controller.php.

addonController::getCacheFilePath (   $type = "pc")

Returns a cache file path

Parameters
$typepc or mobile
Returns
string Returns a path

Definition at line 26 of file addon.controller.php.

addonController::init ( )

Initialization

Returns
void

Definition at line 16 of file addon.controller.php.

addonController::makeCacheFile (   $site_srl = 0,
  $type = "pc",
  $gtype = 'site' 
)

Re-generate the cache file

Parameters
int$site_srlSite srl
string$typepc or mobile
string$gtypesite or global
Returns
void

Definition at line 79 of file addon.controller.php.

addonController::removeAddonConfig (   $site_srl)

Remove add-on information in the virtual site

Parameters
int$site_srlSite srl
Returns
void

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


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