fanbinit/rhymix
1
0
Fork 0
mirror of https://github.com/Lastorder-DC/rhymix.git synced 2026-05-09 12:02:24 +09:00
Code Issues Projects Releases Packages Wiki Activity

adds comments for phpDoc

Browse source 
git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10754 201d5d3c-b55e-5fd7-737f-ddc643e51545
This commit is contained in:
flyskyko 2012-05-30 08:17:56 +00:00
parent 455091f7e8
commit e010c07440
5 changed files with 149 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

51
modules/addon/addon.admin.controller.php
View file

@ -1,22 +1,24 @@
<?php <?php
/**
* @class addonAdminController
* @author NHN (developers@xpressengine.com)
* @brief admin controller class of addon modules
**/
require_once(_XE_PATH_.'modules/addon/addon.controller.php'); require_once(_XE_PATH_.'modules/addon/addon.controller.php');
/**
* Admin controller class of addon modules
* @author NHN (developers@xpressengine.com)
**/
class addonAdminController extends addonController { class addonAdminController extends addonController {
/** /**
* @brief Initialization * Initialization
*
* @return void
**/ **/
function init() { function init() {
} }
/** /**
* @brief Set addon activate * Set addon activate
*
* @return Object
**/ **/
function procAddonAdminSaveActivate() function procAddonAdminSaveActivate()
{ {
@ -109,7 +111,9 @@
} }
/** /**
* @brief Add active/inactive change * Add active/inactive change
*
* @return Object
**/ **/
function procAddonAdminToggleActivate() { function procAddonAdminToggleActivate() {
$oAddonModel = &getAdminModel('addon'); $oAddonModel = &getAdminModel('addon');
@ -130,7 +134,9 @@
} }
/** /**
* @brief Add the configuration information input * Add the configuration information input
*
* @return Object
**/ **/
function procAddonAdminSetupAddon() { function procAddonAdminSetupAddon() {
$args = Context::getRequestVars(); $args = Context::getRequestVars();
@ -156,8 +162,13 @@
/** /**
* @brief Add-on * Adds addon to DB
* Adds Add to DB *
* @param string $addon Addon name
* @param int $site_srl Site srl
* @param string $gtype site or global
* @param string $isUsed Whether to use
* @return Object
**/ **/
function doInsert($addon, $site_srl = 0, $gtype = 'site', $isUsed = 'N') { function doInsert($addon, $site_srl = 0, $gtype = 'site', $isUsed = 'N') {
$args->addon = $addon; $args->addon = $addon;
@ -168,8 +179,13 @@
} }
/** /**
* @brief Add-activated * Activate addon
* addons add-ons to the table on the activation state sikyeojum *
* @param string $addon Addon name
* @param int $site_srl Site srl
* @param string $type pc or modile
* @param string $gtype site or global
* @return Object
**/ **/
function doActivate($addon, $site_srl = 0, $type = "pc", $gtype = 'site') { function doActivate($addon, $site_srl = 0, $type = "pc", $gtype = 'site') {
$args->addon = $addon; $args->addon = $addon;
@ -181,9 +197,12 @@
} }
/** /**
* @brief Disable Add-ons * Deactivate Addon
* *
* addons add a table to remove the name of the deactivation is sikige * @param string $addon Addon name
* @param int $site_srl Site srl
* @param string $type pc or mobile
* @param string $gtype site or global
**/ **/
function doDeactivate($addon, $site_srl = 0, $type = "pc", $gtype = 'site') { function doDeactivate($addon, $site_srl = 0, $type = "pc", $gtype = 'site') {
$args->addon = $addon; $args->addon = $addon;

44
modules/addon/addon.admin.model.php
View file

@ -1,20 +1,23 @@
<?php <?php
/** /**
* @class addonAdminModel * Admin model class of addon module
* @author NHN (developers@xpressengine.com) * @author NHN (developers@xpressengine.com)
* @brief admin model class of addon modules
**/ **/
class addonAdminModel extends addon { class addonAdminModel extends addon {
/** /**
* @brief Initialization * Initialization
*
* @return void
**/ **/
function init() { function init() {
} }
/** /**
* @brief Wanted to add the path to * Returns a path of addon
*
* @param string $addon_name Name to get path
* @return string Returns a path
**/ **/
function getAddonPath($addon_name) { function getAddonPath($addon_name) {
$class_path = sprintf('./addons/%s/', $addon_name); $class_path = sprintf('./addons/%s/', $addon_name);
@ -23,7 +26,9 @@
} }
/** /**
* @brief Get addon list for super admin * Get addon list for super admin
*
* @return Object
**/ **/
function getAddonListForSuperAdmin() function getAddonListForSuperAdmin()
{ {
@ -51,7 +56,11 @@
} }
/** /**
* @brief Wanted to add the kind of information and * Returns addon list
*
* @param int $site_srl Site srl
* @param string $gtype site or global
* @return array Returns addon list
**/ **/
function getAddonList($site_srl = 0, $gtype = 'site') { function getAddonList($site_srl = 0, $gtype = 'site') {
// Wanted to add a list of activated // Wanted to add a list of activated
@ -96,7 +105,12 @@
} }
/** /**
* @brief Modules conf/info.xml wanted to read the information * Returns a information of addon
*
* @param string $addon Name to get information
* @param int $site_srl Site srl
* @param string $gtype site or global
* @return object Returns a information
**/ **/
function getAddonInfoXml($addon, $site_srl = 0, $gtype = 'site') { function getAddonInfoXml($addon, $site_srl = 0, $gtype = 'site') {
// Get a path of the requested module. Return if not exists. // Get a path of the requested module. Return if not exists.
@ -294,7 +308,11 @@
} }
/** /**
* @brief Add to the list of active guhaeom * Returns activated addon list
*
* @param int $site_srl Site srl
* @param string $gtype site or global
* @return array Returns list
**/ **/
function getInsertedAddons($site_srl = 0, $gtype = 'site') { function getInsertedAddons($site_srl = 0, $gtype = 'site') {
$args->list_order = 'addon'; $args->list_order = 'addon';
@ -315,7 +333,13 @@
} }
/** /**
* @brief Add-on is enabled, check whether * Returns whether to activate
*
* @param string $addon Name to check
* @param int $site_srl Site srl
* @param string $type pc or mobile
* @param string $gtype site or global
* @return bool If addon is activated returns true. Otherwise returns false.
**/ **/
function isActivatedAddon($addon, $site_srl = 0, $type = "pc", $gtype = 'site') { function isActivatedAddon($addon, $site_srl = 0, $type = "pc", $gtype = 'site') {
$args->addon = $addon; $args->addon = $addon;

20
modules/addon/addon.admin.view.php
View file

@ -1,21 +1,23 @@
<?php <?php
/** /**
* @class addonAdminView * Admin view class of addon modules
* @author NHN (developers@xpressengine.com) * @author NHN (developers@xpressengine.com)
* @brief admin view class of addon modules
**/ **/
class addonAdminView extends addon { class addonAdminView extends addon {
/** /**
* @brief Initialization * Initialization
*
* @return void
**/ **/
function init() { function init() {
$this->setTemplatePath($this->module_path.'tpl'); $this->setTemplatePath($this->module_path.'tpl');
} }
/** /**
* @brief Add Management main page (showing the list) * Add Management main page (showing the list)
*
* @return Object
**/ **/
function dispAddonAdminIndex() { function dispAddonAdminIndex() {
$oAdminModel = &getAdminModel('admin'); $oAdminModel = &getAdminModel('admin');
@ -39,7 +41,9 @@
} }
/** /**
* @biref Setting out the details pop-up add-on * Display setup page
*
* @return Object
**/ **/
function dispAddonAdminSetup() { function dispAddonAdminSetup() {
$site_module_info = Context::get('site_module_info'); $site_module_info = Context::get('site_module_info');
@ -86,7 +90,9 @@
} }
/** /**
* @brief Add details (conf/info.xml) a pop-out * Display information
*
* @return Object
**/ **/
function dispAddonAdminInfo() { function dispAddonAdminInfo() {
$site_module_info = Context::get('site_module_info'); $site_module_info = Context::get('site_module_info');

20
modules/addon/addon.class.php
View file

@ -1,14 +1,14 @@
<?php <?php
/** /**
* @class addon * High class of addon modules
* @author NHN (developers@xpressengine.com) * @author NHN (developers@xpressengine.com)
* @brief high class of addon modules
**/ **/
class addon extends ModuleObject { class addon extends ModuleObject {
/** /**
* @brief Implement if additional tasks are necessary when installing * Implement if additional tasks are necessary when installing
*
* @return Object
**/ **/
function moduleInstall() { function moduleInstall() {
// Register to add a few // Register to add a few
@ -28,7 +28,9 @@
} }
/** /**
* @brief a method to check if successfully installed * A method to check if successfully installed
*
* @return bool
**/ **/
function checkUpdate() { function checkUpdate() {
$oDB = &DB::getInstance(); $oDB = &DB::getInstance();
@ -42,7 +44,9 @@
} }
/** /**
* @brief Execute update * Execute update
*
* @return Object
**/ **/
function moduleUpdate() { function moduleUpdate() {
$oDB = &DB::getInstance(); $oDB = &DB::getInstance();
@ -78,7 +82,9 @@
} }
/** /**
* @brief Re-generate the cache file * Re-generate the cache file
*
* @return Object
**/ **/
function recompileCache() { function recompileCache() {
} }

69
modules/addon/addon.controller.php
View file

@ -1,21 +1,23 @@
<?php <?php
/** /**
* @class addonController * Addon module's controller class
* @author NHN (developers@xpressengine.com) * @author NHN (developers@xpressengine.com)
* @brief addon module's controller class
**/ **/
class addonController extends addon { class addonController extends addon {
/** /**
* @brief Initialization * Initialization
*
* @return void
**/ **/
function init() { function init() {
} }
/** /**
* @brief Main/Virtual-specific add-on file, the location of the cache Wanted * Returns a cache file path
*
* @param $type pc or mobile
* @return string Returns a path
**/ **/
function getCacheFilePath($type = "pc") { function getCacheFilePath($type = "pc") {
static $addon_file; static $addon_file;
@ -38,7 +40,11 @@
/** /**
* @brief Add-on mid settings * Returns mid list that addons is run
*
* @param string $selected_addon Name to get list
* @param int $site_srl Site srl
* @return string[] Returns list that contain mid
**/ **/
function _getMidList($selected_addon, $site_srl = 0) { function _getMidList($selected_addon, $site_srl = 0) {
@ -50,7 +56,12 @@
/** /**
* @brief Add-on mid settings * Adds mid into running mid list
*
* @param string $selected_addon Addon name to add mid
* @param string $mid Module id to add
* @param int $site_srl Site srl
* @return void
**/ **/
function _setAddMid($selected_addon,$mid, $site_srl=0) { function _setAddMid($selected_addon,$mid, $site_srl=0) {
// Wanted to add the requested information // Wanted to add the requested information
@ -63,7 +74,12 @@
/** /**
* @brief Add-on mid settings * Deletes mid from running mid list
*
* @param string $selected_addon Addon name to delete mid
* @param string $mid Module id to delete
* @param int $site_srl Site srl
* @return void
**/ **/
function _setDelMid($selected_addon,$mid,$site_srl=0) { function _setDelMid($selected_addon,$mid,$site_srl=0) {
// Wanted to add the requested information // Wanted to add the requested information
@ -83,7 +99,12 @@
} }
/** /**
* @brief Add-on mid settings * Set running mid list
*
* @param string $selected_addon Addon name to set
* @param string[] $mid_list List to set
* @param int $site_srl Site srl
* @return void
**/ **/
function _setMid($selected_addon,$mid_list,$site_srl=0) { function _setMid($selected_addon,$mid_list,$site_srl=0) {
$args->mid_list = join('|@|',$mid_list); $args->mid_list = join('|@|',$mid_list);
@ -93,7 +114,9 @@
/** /**
* @brief Add mid-on * Adds mid into running mid list
*
* @return Object
**/ **/
function procAddonSetupAddonAddMid() { function procAddonSetupAddonAddMid() {
$site_module_info = Context::get('site_module_info'); $site_module_info = Context::get('site_module_info');
@ -105,7 +128,9 @@
} }
/** /**
* @brief Add mid Delete * Deletes mid from running mid list
*
* @return Object
**/ **/
function procAddonSetupAddonDelMid() { function procAddonSetupAddonDelMid() {
$site_module_info = Context::get('site_module_info'); $site_module_info = Context::get('site_module_info');
@ -118,7 +143,12 @@
} }
/** /**
* @brief Re-generate the cache file * Re-generate the cache file
*
* @param int $site_srl Site srl
* @param string $type pc or mobile
* @param string $gtype site or global
* @return void
**/ **/
function makeCacheFile($site_srl = 0, $type = "pc", $gtype = 'site') { function makeCacheFile($site_srl = 0, $type = "pc", $gtype = 'site') {
// Add-on module for use in creating the cache file // Add-on module for use in creating the cache file
@ -155,7 +185,13 @@
} }
/** /**
* @brief Add-On Set * Save setup
*
* @param string $addon Addon name
* @param object $extra_vars Extra variables
* @param int $site_srl Site srl
* @param string $gtype site or global
* @return Object
**/ **/
function doSetup($addon, $extra_vars,$site_srl=0, $gtype = 'site') { function doSetup($addon, $extra_vars,$site_srl=0, $gtype = 'site') {
if(!is_array($extra_vars->mid_list)) unset($extra_vars->mid_list); if(!is_array($extra_vars->mid_list)) unset($extra_vars->mid_list);
@ -168,7 +204,10 @@
} }
/** /**
* @brief Remove add-on information in the virtual site * Remove add-on information in the virtual site
*
* @param int $site_srl Site srl
* @return void
**/ **/
function removeAddonConfig($site_srl) { function removeAddonConfig($site_srl) {
$addon_path = _XE_PATH_.'files/cache/addons/'; $addon_path = _XE_PATH_.'files/cache/addons/';