add description of layout module files

git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10766 201d5d3c-b55e-5fd7-737f-ddc643e51545
This commit is contained in:
chschy 2012-06-05 05:49:22 +00:00
parent 1bd252610e
commit 1245bcc648
5 changed files with 248 additions and 120 deletions

View file

@ -2,20 +2,22 @@
/**
* @class layoutAdminView
* @author NHN (developers@xpressengine.com)
* @brief admin view class of the layout module
* admin view class of the layout module
**/
class layoutAdminView extends layout {
/**
* @brief Initialization
* Initialization
* @return void
**/
function init() {
$this->setTemplatePath($this->module_path.'tpl');
}
/**
* @brief Display a installed layout list
* Display a installed layout list
* @return void
**/
function dispLayoutAdminInstalledList() {
// Set a layout list
@ -59,7 +61,8 @@
}
/**
* @brief Display a installed mobile layout list
* Display a installed mobile layout list
* @return void
*/
function dispLayoutAdminInstalledMobileList() {
// Set a layout list
@ -84,7 +87,8 @@
}
/**
* @brief Display list of pc layout instance
* Display list of pc layout instance
* @return void|Object (void : success, Object : fail)
*/
function dispLayoutAdminInstanceList()
{
@ -111,8 +115,9 @@
}
/**
* @brief Layout setting page
* Layout setting page
* Once select a layout with empty value in the DB, then adjust values
* @return void|Object (void : success, Object : fail)
**/
function dispLayoutAdminInsert() {
$oModel = &getModel('layout');
@ -154,7 +159,8 @@
}
/**
* @brief Insert Layout details
* Insert Layout details
* @return void
**/
function dispLayoutAdminModify() {
// Set the layout after getting layout information
@ -193,9 +199,10 @@
$this->setTemplateFile('layout_modify');
}
// deprecated
/**
* @brief The first page of the layout admin
* The first page of the layout admin
* @deprecated
* @return void|Object (void : success, Object : fail)
**/
function dispLayoutAdminContent() {
$path = Context::get('path');
@ -209,7 +216,11 @@
$this->setTemplateFile('index');
}
// deprecated
/**
* The first page of the mobile layout admin
* @deprecated
* @return void
**/
function dispLayoutAdminMobileContent() {
$oLayoutModel = &getModel('layout');
$columnList = array('layout_srl', 'layout', 'module_srl', 'title', 'regdate');
@ -221,7 +232,8 @@
}
/**
* @brief Edit layout codes
* Edit layout codes
* @return void
**/
function dispLayoutAdminEdit() {
// Set the layout with its information
@ -230,7 +242,7 @@
$oLayoutModel = &getModel('layout');
$layout_info = $oLayoutModel->getLayout($layout_srl);
// Error appears if there is no layout information is registered
if(!$layout_info) return $this->dispLayoutAdminContent();
if(!$layout_info) return $this->dispLayoutAdminInstalledList();
// Get Layout Code
$oLayoutModel = &getModel('layout');
@ -280,7 +292,8 @@
}
/**
* @brief Preview a layout
* Preview a layout
* @return void|Object (void : success, Object : fail)
**/
function dispLayoutAdminPreview() {
$layout_srl = Context::get('layout_srl');
@ -332,9 +345,10 @@
}
// deprecated
/**
* @brief Pop-up details of the layout(conf/info.xml)
* Pop-up details of the layout(conf/info.xml)
* @deprecated
* @return void
**/
function dispLayoutAdminInfo() {
// Get the layout information
@ -353,9 +367,10 @@
$this->setTemplateFile('layout_detail_info');
}
// deprecated
/**
* @brief Modify admin layout of faceoff
* Modify admin layout of faceoff
* @deprecated
* @return void
**/
function dispLayoutAdminLayoutModify(){
// Get layout_srl
@ -400,7 +415,11 @@
$this->setTemplateFile('faceoff_layout_edit');
}
// deprecated
/**
* display used images info for faceoff
* @deprecated
* @return void
**/
function dispLayoutAdminLayoutImageList(){
$layout_srl = Context::get('layout_srl');
$oLayoutModel = &getModel('layout');