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
This commit is contained in:
ovclas 2012-06-25 09:30:08 +00:00
parent e7e74da1f8
commit 19a7be5b1f
5 changed files with 296 additions and 157 deletions

View file

@ -1,23 +1,27 @@
<?php
/**
* @class menuAdminView
* @author NHN (developers@xpressengine.com)
* @brief admin view class of the menu module
**/
/**
* menuAdminView class
* admin view class of the menu module
*
* @author NHN (developers@xpressengine.com)
* @package /modules/menu
* @version 0.1
*/
class menuAdminView extends menu {
var $tmpMenu = null;
/**
* @brief Initialization
**/
/**
* Initialization
* @return void
*/
function init() {
$this->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))