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

Public Member Functions

 init ()
 
 __construct ()
 
 procMenuAdminInsert ()
 
 addMenu ($title, $siteSrl=0)
 
 linkAllModuleInstancesToSitemap ()
 
 getUnlinkedMenu ()
 
 updateLinkModule ($moduleInfos, $menuSrl)
 
 procMenuAdminUpdate ()
 
 procMenuAdminDelete ()
 
 deleteMenu ($menu_srl)
 
 procMenuAdminInsertItem ($request=NULL)
 
 procMenuAdminUpdateItem ()
 
 procMenuAdminButtonUpload ()
 
 updateMenuItem ($itemInfo)
 
 _updateMenuItem ($itemInfo)
 
 procMenuAdminDeleteItem ()
 
 deleteItem ($args)
 
 procMenuAdminMoveItem ()
 
 procMenuAdminCopyItem ()
 
 procMenuAdminArrangeItem ()
 
 _setParent ($parent_srl, $child_index, &$target)
 
 _recursiveMoveMenuItem ($result)
 
 moveMenuItem ($menu_srl, $parent_srl, $source_srl, $target_srl, $mode, $isShortcut='Y', $url=NULL)
 
 procMenuAdminMakeXmlFile ()
 
 procMenuAdminUploadButton ()
 
 procMenuAdminDeleteButton ()
 
 procMenuAdminAllActList ()
 
 procMenuAdminInsertItemForAdminMenu ()
 
 procMenuAdminUpdateAuth ()
 
 makeXmlFile ($menu_srl)
 
 getXmlTree ($source_node, $tree, $site_srl, $domain)
 
 getPhpCacheCode ($source_node, $tree, $site_srl, $domain)
 
 updateMenuLayout ($layout_srl, $menu_srl_list)
 
 _uploadButton ($args)
 
 makeHomemenuCacheFile ($menuSrl)
 
 getHomeMenuCacheFile ()
 
- Public Member Functions inherited from menu
 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 ()
 

Public Attributes

 $menuSrl = null
 
 $itemKeyList = array()
 
 $map = array()
 
 $checked = array()
 
 $insertedMenuItemSrlList = 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
 

Detailed Description

Definition at line 11 of file menu.admin.controller.php.

Constructor & Destructor Documentation

menuAdminController::__construct ( )

Definition at line 58 of file menu.admin.controller.php.

Member Function Documentation

menuAdminController::_recursiveMoveMenuItem (   $result)

move item with sub directory(recursive)

Parameters
object$result
Returns
void

Definition at line 1383 of file menu.admin.controller.php.

menuAdminController::_setParent (   $parent_srl,
  $child_index,
&  $target 
)

Set parent number to child

Parameters
int$parent_srl
int$child_index
object$target
Returns
void

Definition at line 1360 of file menu.admin.controller.php.

menuAdminController::_updateMenuItem (   $itemInfo)

Definition at line 807 of file menu.admin.controller.php.

menuAdminController::_uploadButton (   $args)

Register a menu image button

Parameters
object$args
Returns
array

Definition at line 2142 of file menu.admin.controller.php.

menuAdminController::addMenu (   $title,
  $siteSrl = 0 
)

Add a menu

Parameters
string$title
int$siteSrl
Returns
BaseObject If success, it contains menuSrl

Definition at line 88 of file menu.admin.controller.php.

menuAdminController::deleteItem (   $args)

Delete menu item ( Only include BO ) menu_srl, menu_item_srl, is_force

Returns
void|BaseObject

Definition at line 846 of file menu.admin.controller.php.

menuAdminController::deleteMenu (   $menu_srl)

Delete menu Delete menu_item and xml cache files

Returns
BaseObject

Definition at line 309 of file menu.admin.controller.php.

menuAdminController::getHomeMenuCacheFile ( )

Definition at line 2271 of file menu.admin.controller.php.

menuAdminController::getPhpCacheCode (   $source_node,
  $tree,
  $site_srl,
  $domain 
)

Return php code converted from nodes in an array Although xml data can be used for tpl, menu to menu, it needs to use javascript separately By creating cache file in php and then you can get menu information without DB This cache includes in ModuleHandler::displayContent() and then Context::set()

Parameters
array$source_node
array$tree
int$site_srl
string$domain
Returns
array

Definition at line 1989 of file menu.admin.controller.php.

menuAdminController::getUnlinkedMenu ( )

Definition at line 126 of file menu.admin.controller.php.

menuAdminController::getXmlTree (   $source_node,
  $tree,
  $site_srl,
  $domain 
)

Create xml data recursively looping for array nodes by referencing to parent_srl menu xml file uses a tag named "node" and this XML configures menus on admin page. (Implement tree menu by reading the xml file in tree_menu.js)

Parameters
array$source_node
array$tree
int$site_srl
string$domain
Returns
string

Definition at line 1888 of file menu.admin.controller.php.

menuAdminController::init ( )

Initialization

Returns
void

Definition at line 53 of file menu.admin.controller.php.

menuAdminController::linkAllModuleInstancesToSitemap ( )

Definition at line 107 of file menu.admin.controller.php.

menuAdminController::makeHomemenuCacheFile (   $menuSrl)

Definition at line 2263 of file menu.admin.controller.php.

menuAdminController::makeXmlFile (   $menu_srl)

Generate XML file for menu and return its location

Parameters
int$menu_srl
Returns
string

Definition at line 1766 of file menu.admin.controller.php.

menuAdminController::moveMenuItem (   $menu_srl,
  $parent_srl,
  $source_srl,
  $target_srl,
  $mode,
  $isShortcut = 'Y',
  $url = NULL 
)

move menu item

Parameters
int$menu_srl
int$parent_srl
int$source_srl
int$target_srl
string$mode'move' or 'insert'
Returns
void

Definition at line 1406 of file menu.admin.controller.php.

menuAdminController::procMenuAdminAllActList ( )

Get all act list for admin menu

Returns
void

Definition at line 1563 of file menu.admin.controller.php.

menuAdminController::procMenuAdminArrangeItem ( )

Arrange menu items

Returns
void|object

Definition at line 1291 of file menu.admin.controller.php.

menuAdminController::procMenuAdminButtonUpload ( )

upload button void

Definition at line 746 of file menu.admin.controller.php.

menuAdminController::procMenuAdminCopyItem ( )

cop menu item

Returns
void

Definition at line 1121 of file menu.admin.controller.php.

menuAdminController::procMenuAdminDelete ( )

Delete menu process method

Returns
void|BaseObject

Definition at line 250 of file menu.admin.controller.php.

menuAdminController::procMenuAdminDeleteButton ( )

Remove the menu image button

Returns
void

Definition at line 1548 of file menu.admin.controller.php.

menuAdminController::procMenuAdminDeleteItem ( )

Delete menu item(menu of the menu)

Returns
void|BaseObject

Definition at line 818 of file menu.admin.controller.php.

menuAdminController::procMenuAdminInsert ( )

Add a menu

Returns
void|object

Definition at line 66 of file menu.admin.controller.php.

menuAdminController::procMenuAdminInsertItem (   $request = NULL)

Add an item to the menu, simple version

Returns
void

Definition at line 385 of file menu.admin.controller.php.

menuAdminController::procMenuAdminInsertItemForAdminMenu ( )

Get all act list for admin menu

Returns
void|object

Definition at line 1585 of file menu.admin.controller.php.

menuAdminController::procMenuAdminMakeXmlFile ( )

Update xml file XML file is not often generated after setting menus on the admin page
For this occasional cases, manually update was implemented.
It looks unnecessary at this moment however no need to eliminate the feature. Just leave it.

Returns
void

Definition at line 1489 of file menu.admin.controller.php.

menuAdminController::procMenuAdminMoveItem ( )

Move menu items

Returns
void

Definition at line 1013 of file menu.admin.controller.php.

menuAdminController::procMenuAdminUpdate ( )

Change the menu title

Returns
void|object

Definition at line 230 of file menu.admin.controller.php.

menuAdminController::procMenuAdminUpdateAuth ( )

Update menu auth (Exposure and Access)

Returns
void

Definition at line 1662 of file menu.admin.controller.php.

menuAdminController::procMenuAdminUpdateItem ( )

Update an item to the menu, simple version

Returns
void

Definition at line 645 of file menu.admin.controller.php.

menuAdminController::procMenuAdminUploadButton ( )

Register a menu image button

Returns
void

Definition at line 1508 of file menu.admin.controller.php.

menuAdminController::updateLinkModule (   $moduleInfos,
  $menuSrl 
)

insert menu when not linked module.

Parameters
array$moduleInfos
int$menuSrl
Returns
BaseObject

Definition at line 169 of file menu.admin.controller.php.

menuAdminController::updateMenuItem (   $itemInfo)

Definition at line 798 of file menu.admin.controller.php.

menuAdminController::updateMenuLayout (   $layout_srl,
  $menu_srl_list 
)

Mapping menu and layout When setting menu on the layout, map the default layout

Parameters
int$layout_srl
array$menu_srl_list

Definition at line 2119 of file menu.admin.controller.php.

Member Data Documentation

menuAdminController::$checked = array()

Definition at line 32 of file menu.admin.controller.php.

menuAdminController::$insertedMenuItemSrlList = array()

Definition at line 37 of file menu.admin.controller.php.

menuAdminController::$itemKeyList = array()

Definition at line 22 of file menu.admin.controller.php.

menuAdminController::$map = array()

Definition at line 27 of file menu.admin.controller.php.

menuAdminController::$menuSrl = null

Definition at line 17 of file menu.admin.controller.php.

The documentation for this class was generated from the following file:
Generated on Tue Dec 18 2018 17:04:31 for XpressEngine Core by   doxygen 1.8.5