From 19a7be5b1f9f3866104524d34996bb4b2991a1c4 Mon Sep 17 00:00:00 2001 From: ovclas Date: Mon, 25 Jun 2012 09:30:08 +0000 Subject: [PATCH] add phpDoc comment in menu module git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10792 201d5d3c-b55e-5fd7-737f-ddc643e51545 --- modules/menu/menu.admin.controller.php | 212 +++++++++++++++++-------- modules/menu/menu.admin.model.php | 109 ++++++++----- modules/menu/menu.admin.view.php | 68 +++++--- modules/menu/menu.class.php | 43 ++--- modules/menu/menu.mobile.php | 21 ++- 5 files changed, 296 insertions(+), 157 deletions(-) diff --git a/modules/menu/menu.admin.controller.php b/modules/menu/menu.admin.controller.php index 696c04416..98459d3eb 100644 --- a/modules/menu/menu.admin.controller.php +++ b/modules/menu/menu.admin.controller.php @@ -1,25 +1,45 @@ title = Context::get('title'); @@ -60,10 +81,10 @@ } } - /** - * @brief Delete menu - * Delete menu_item and xml cache files - **/ + /** + * Delete menu process method + * @return void|Object + */ function procMenuAdminDelete() { $menu_srl = Context::get('menu_srl'); @@ -83,6 +104,11 @@ } } + /** + * Delete menu + * Delete menu_item and xml cache files + * @return Object + */ function deleteMenu($menu_srl) { // Delete cache files $cache_list = FileHandler::readDir("./files/cache/menu","",false,true); @@ -107,9 +133,10 @@ return new Object(0,'success_deleted'); } - /** - * @brief Add an item to the menu - **/ + /** + * Add an item to the menu + * @return void + */ function procMenuAdminInsertItem() { // List variables to insert $source_args = Context::getRequestVars(); @@ -233,9 +260,10 @@ } } - /** - * @brief Delete menu item(menu of the menu) - **/ + /** + * Delete menu item(menu of the menu) + * @return void|Object + */ function procMenuAdminDeleteItem() { // List variables $args = Context::gets('menu_srl','menu_item_srl'); @@ -278,9 +306,10 @@ } } - /** - * @brief Move menu items - **/ + /** + * Move menu items + * @return void + */ function procMenuAdminMoveItem() { $menu_srl = Context::get('menu_srl'); $mode = Context::get('mode'); @@ -292,9 +321,10 @@ $this->moveMenuItem($menu_srl,$parent_srl,$source_srl,$target_srl,$mode); } - /** - * @brief Arrange menu items - **/ + /** + * Arrange menu items + * @return void|object + */ function procMenuAdminArrangeItem() { $this->menuSrl = Context::get('menu_srl'); @@ -356,6 +386,13 @@ } } + /** + * Set parent number to child + * @param int $parent_srl + * @param int $child_index + * @param object $target + * @return void + */ function _setParent($parent_srl, $child_index, &$target) { $child_srl = $this->itemKeyList[$child_index]; @@ -372,6 +409,11 @@ //return $target; } + /** + * move item with sub directory(recursive) + * @param object $result + * @return void + */ function _recursiveMoveMenuItem($result) { $i = 0; @@ -386,6 +428,15 @@ } } + /** + * move menu item + * @param int $menu_srl + * @param int $parent_srl + * @param int $source_srl + * @param int $target_srl + * @param string $mode 'move' or 'insert' + * @return void + */ function moveMenuItem($menu_srl,$parent_srl,$source_srl,$target_srl,$mode){ // Get the original menus $oMenuAdminModel = &getAdminModel('menu'); @@ -428,12 +479,13 @@ return $xml_file; } - /** - * @brief Update xml file - * XML file is not often generated after setting menus on the admin page\n - * For this occasional cases, manually update was implemented. \n - * It looks unnecessary at this moment however no need to eliminate the feature. Just leave it. - **/ + /** + * Update xml file + * XML file is not often generated after setting menus on the admin page\n + * For this occasional cases, manually update was implemented. \n + * It looks unnecessary at this moment however no need to eliminate the feature. Just leave it. + * @return void + */ function procMenuAdminMakeXmlFile() { // Check input value $menu_srl = Context::get('menu_srl'); @@ -448,9 +500,10 @@ $this->add('xml_file',$xml_file); } - /** - * @brief Register a menu image button - **/ + /** + * Register a menu image button + * @return void + */ function procMenuAdminUploadButton() { $menu_srl = Context::get('menu_srl'); $menu_item_srl = Context::get('menu_item_srl'); @@ -478,9 +531,10 @@ $this->setTemplateFile('menu_file_uploaded'); } - /** - * @brief Remove the menu image button - **/ + /** + * Remove the menu image button + * @return void + */ function procMenuAdminDeleteButton() { $menu_srl = Context::get('menu_srl'); $menu_item_srl = Context::get('menu_item_srl'); @@ -491,9 +545,10 @@ $this->add('target', $target); } - /** - * @brief get all act list for admin menu - **/ + /** + * Get all act list for admin menu + * @return void + */ function procMenuAdminAllActList() { $oModuleModel = &getModel('module'); $installed_module_list = $oModuleModel->getModulesXmlInfo(); @@ -511,9 +566,10 @@ $this->add('menuList', $menuList); } - /** - * @brief get all act list for admin menu - **/ + /** + * Get all act list for admin menu + * @return void|object + */ function procMenuAdminInsertItemForAdminMenu() { $requestArgs = Context::getRequestVars(); @@ -578,9 +634,11 @@ } } - /** - * @brief Generate XML file for menu and return its location - **/ + /** + * Generate XML file for menu and return its location + * @param int $menu_srl + * @return string + */ function makeXmlFile($menu_srl) { // Return if there is no information when creating the xml file if(!$menu_srl) return; @@ -686,11 +744,16 @@ return $xml_file; } - /** - * @brief 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) - **/ + /** + * 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) + * @param array $source_node + * @param array $tree + * @param int $site_srl + * @param string $domain + * @return string + */ function getXmlTree($source_node, $tree, $site_srl, $domain) { if(!$source_node) return; @@ -765,12 +828,17 @@ return $buff; } - /** - * @brief 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() - **/ + /** + * 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() + * @param array $source_node + * @param array $tree + * @param int $site_srl + * @param string $domain + * @return array + */ function getPhpCacheCode($source_node, $tree, $site_srl, $domain) { $output = array("buff"=>"", "url_list"=>array()); if(!$source_node) return $output; @@ -867,10 +935,12 @@ return $output; } - /** - * @brief Mapping menu and layout - * When setting menu on the layout, map the default layout - **/ + /** + * Mapping menu and layout + * When setting menu on the layout, map the default layout + * @param int $layout_srl + * @param array $menu_srl_list + */ function updateMenuLayout($layout_srl, $menu_srl_list) { if(!count($menu_srl_list)) return; // Delete the value of menu_srls @@ -887,9 +957,11 @@ } } - /** - * @brief Register a menu image button - **/ + /** + * Register a menu image button + * @param object $args + * @return array + */ function _uploadButton($args) { // path setting diff --git a/modules/menu/menu.admin.model.php b/modules/menu/menu.admin.model.php index 8790bcfd9..33af4eb08 100644 --- a/modules/menu/menu.admin.model.php +++ b/modules/menu/menu.admin.model.php @@ -1,22 +1,25 @@ site_srl) { $site_module_info = Context::get('site_module_info'); @@ -35,9 +38,11 @@ return $output; } - /** - * @brief Return all menus - **/ + /** + * Return all menus + * @param int $site_srl + * @return array + */ function getMenus($site_srl = null) { if(!isset($site_srl)) { $site_module_info = Context::get('site_module_info'); @@ -52,10 +57,12 @@ return $menus; } - /** - * @brief Get information of a new menu from the DB - * Return DB and XML information of the menu - **/ + /** + * Get information of a new menu from the DB + * Return DB and XML information of the menu + * @param int $menu_srl + * @return object + */ function getMenu($menu_srl) { // Get information from the DB $args->menu_srl = $menu_srl; @@ -68,10 +75,12 @@ return $menu_info; } - /** - * @brief Get information of a new menu from the DB, search condition is menu title - * Return DB and XML information of the menu - **/ + /** + * Get information of a new menu from the DB, search condition is menu title + * Return DB and XML information of the menu + * @param string $title + * @return object + */ function getMenuByTitle($title) { // Get information from the DB $args->title = $title; @@ -89,10 +98,12 @@ return $menu_info; } - /** - * @brief Return item information of the menu_srl - * group_srls uses a seperator with comma(,) and converts to an array by explode - **/ + /** + * Return item information of the menu_srl + * group_srls uses a seperator with comma(,) and converts to an array by explode + * @param int $menu_item_srl + * @return object + */ function getMenuItemInfo($menu_item_srl) { // Get the menu information if menu_item_srl exists $args->menu_item_srl = $menu_item_srl; @@ -112,9 +123,10 @@ return $node; } - /** - * @brief Return item information of the menu_srl - **/ + /** + * Return item information of the menu_srl + * @return void + */ function getMenuAdminItemInfo() { $menuItemSrl = Context::get('menu_item_srl'); @@ -169,6 +181,13 @@ $this->add('menu_item', $menuItem); } + /** + * Return menu item list by menu number + * @param int $menu_srl + * @param int $parent_srl + * @param array $columnList + * @return object + */ function getMenuItems($menu_srl, $parent_srl = null, $columnList = array()) { $args->menu_srl = $menu_srl; @@ -178,9 +197,12 @@ return $output; } - /** - * @brief Return menu name in each language to support multi-language - */ + /** + * Return menu name in each language to support multi-language + * @param string $source_name + * @param int $site_srl + * @return array + */ function getMenuItemNames($source_name, $site_srl = null) { if(!$site_srl) { $site_module_info = Context::get('site_module_info'); @@ -191,10 +213,11 @@ return $oModuleAdminModel->getLangCode($site_srl, $source_name); } - /** - * @brief Get a template by using the menu_srl and retrun. - * Return html after compiling tpl on the server in order to add menu information on the admin page - **/ + /** + * Get a template by using the menu_srl and retrun. + * Return html after compiling tpl on the server in order to add menu information on the admin page + * @return void + */ function getMenuAdminTplInfo() { // Get information on the menu for the parameter settings $menu_item_srl = Context::get('menu_item_srl'); @@ -234,10 +257,12 @@ $this->add('tpl', str_replace("\n"," ",$tpl)); } - /** - * @brief when menu add in sitemap, select module list + /** + * @brief when menu add in sitemap, select module list * this menu showing with trigger - **/ + * @param int $site_srl + * @return array + */ function getModuleListInSitemap($site_srl = 0) { $oModuleModel = &getModel('module'); diff --git a/modules/menu/menu.admin.view.php b/modules/menu/menu.admin.view.php index a105e2030..75bdd6c05 100644 --- a/modules/menu/menu.admin.view.php +++ b/modules/menu/menu.admin.view.php @@ -1,23 +1,27 @@ setTemplatePath($this->module_path.'tpl'); } - /** - * @brief The first page of the menu admin - **/ + /** + * The first page of the menu admin + * @return void + */ function dispMenuAdminContent() { // Get a list of registered menus $obj->page = Context::get('page'); @@ -41,9 +45,10 @@ $this->setTemplateFile('index'); } - /** - * @brief Page to insert a menu - **/ + /** + * Page to insert a menu + * @return void + */ function dispMenuAdminInsert() { // Set the menu with menu information $menu_srl = Context::get('menu_srl'); @@ -58,9 +63,10 @@ $this->setTemplateFile('menu_insert'); } - /** - * @brief Menu admin page - **/ + /** + * Menu admin page + * @return void + */ function dispMenuAdminManagement() { // Get information of the menu $menu_srl = Context::get('menu_srl'); @@ -82,10 +88,11 @@ } - /** - * @brief Display a mid list to be able to select on the menu - * @perphaps this method not use - **/ + /** + * Display a mid list to be able to select on the menu + * Perphaps this method not use + * @return void + */ function dispMenuAdminMidList() { $oModuleModel = &getModel('module'); // Get a list of module categories @@ -113,9 +120,10 @@ $this->setTemplateFile('mid_list'); } - /** - * @brief Site map admin menu index page - **/ + /** + * Site map admin menu index page + * @return void + */ function dispMenuAdminSiteMap() { Context::loadLang(_XE_PATH_.'modules/document/lang/'); @@ -187,6 +195,11 @@ $this->setTemplateFile('sitemap'); } + /** + * Setting menu information(recursive) + * @param array $menu + * @return void + */ function _menuInfoSetting(&$menu) { $oModuleModel = &getModel('module'); @@ -211,6 +224,11 @@ } } + /** + * Tree-shaped sorting + * @param array $menuItems + * @return array + */ function _arrangeMenuItem($menuItems) { if(is_array($menuItems)) diff --git a/modules/menu/menu.class.php b/modules/menu/menu.class.php index 839c19e1c..01ba40c0b 100644 --- a/modules/menu/menu.class.php +++ b/modules/menu/menu.class.php @@ -1,15 +1,17 @@