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

added comments for phpDoc - rss module

Browse source 
git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10757 201d5d3c-b55e-5fd7-737f-ddc643e51545
This commit is contained in:
chschy 2012-05-31 06:53:06 +00:00
parent 3c609ae06a
commit 32284aa5a7
6 changed files with 90 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

37
modules/rss/rss.admin.controller.php
View file

@ -1,23 +1,24 @@
<?php <?php
/** /**
* @class rssAdminController * The admin controller class of the rss module
*
* @author NHN (developers@xpressengine.com) * @author NHN (developers@xpressengine.com)
* @brief The admin controller class of the rss module
*
* RSS 2.0 format document output
*
**/ **/
class rssAdminController extends rss { class rssAdminController extends rss {
/** /**
* @brief Initialization * Initialization
*
* @return void
**/ **/
function init() { function init() {
} }
/** /**
* @brief All RSS feeds configurations * All RSS feeds configurations
*
* @return void
**/ **/
function procRssAdminInsertConfig() { function procRssAdminInsertConfig() {
$oModuleModel = &getModel('module'); $oModuleModel = &getModel('module');
@ -83,7 +84,9 @@
/** /**
* @brief RSS Module configurations * RSS Module configurations
*
* @return void
**/ **/
function procRssAdminInsertModuleConfig() { function procRssAdminInsertModuleConfig() {
// Get the object // Get the object
@ -121,7 +124,9 @@
/** /**
* @brief All Feeds with or without change * All Feeds with or without change
*
* @return Object
**/ **/
function procRssAdminToggleActivate() { function procRssAdminToggleActivate() {
$oRssModel = &getModel('rss'); $oRssModel = &getModel('rss');
@ -144,7 +149,10 @@
/** /**
* @brief A funciton to configure all Feeds of the RSS module * A funciton to configure all Feeds of the RSS module
*
* @param Object $config RSS all feeds config list
* @return Object
**/ **/
function setFeedConfig($config) { function setFeedConfig($config) {
$oModuleController = &getController('module'); $oModuleController = &getController('module');
@ -154,7 +162,14 @@
/** /**
* @brief A function t configure the RSS module * A function t configure the RSS module
*
* @param integer $module_srl Module_srl
* @param string $open_rss Choose open rss type. Y : Open all, H : Open summary, N : Not open
* @param string $open_total_feed N : use open total feed, T_N : not use open total feed
* @param string $feed_description Default value is 'N'
* @param string $feed_copyright Default value is 'N'
* @return Object
**/ **/
function setRssModuleConfig($module_srl, $open_rss, $open_total_feed = 'N', $feed_description = 'N', $feed_copyright = 'N') { function setRssModuleConfig($module_srl, $open_rss, $open_total_feed = 'N', $feed_description = 'N', $feed_copyright = 'N') {
$oModuleController = &getController('module'); $oModuleController = &getController('module');

16
modules/rss/rss.admin.view.php
View file

@ -1,13 +1,15 @@
<?php <?php
/** /**
* @class rssAdminView * The admin view class of the rss module
* @author misol (misol@korea.ac.kr) *
* @brief The admin view class of the rss module * @author NHN (developers@xpressengine.com)
**/ **/
class rssAdminView extends rss { class rssAdminView extends rss {
/** /**
* @brief Initialization * Initialization
*
* @return void
**/ **/
function init() { function init() {
//Set template path //Set template path
@ -16,7 +18,9 @@
/** /**
* @brief In case an administrator page has been initialized * In case an administrator page has been initialized
*
* @return Object
**/ **/
function dispRssAdminIndex() { function dispRssAdminIndex() {
$oModuleModel = &getModel('module'); $oModuleModel = &getModel('module');
@ -53,4 +57,4 @@
$this->setTemplateFile('rss_admin_index'); $this->setTemplateFile('rss_admin_index');
} }
} }
?> ?>

19
modules/rss/rss.class.php
View file

@ -1,14 +1,16 @@
<?php <?php
/** /**
* @class rss * High class of rss module
*
* @author NHN (developers@xpressengine.com) * @author NHN (developers@xpressengine.com)
* @brief The view class of the rss module
**/ **/
class rss extends ModuleObject { class rss extends ModuleObject {
/** /**
* @brief Additional tasks required to accomplish during the installation * Additional tasks required to accomplish during the installation
*
* @return Object
**/ **/
function moduleInstall() { function moduleInstall() {
// Register in action forward // Register in action forward
@ -25,7 +27,8 @@
} }
/** /**
* @brief A method to check if the installation has been successful * A method to check if the installation has been successful
* @return bool
**/ **/
function checkUpdate() { function checkUpdate() {
$oModuleModel = &getModel('module'); $oModuleModel = &getModel('module');
@ -42,7 +45,9 @@
} }
/** /**
* @brief Execute update * Execute update
*
* @return Object
**/ **/
function moduleUpdate() { function moduleUpdate() {
$oModuleModel = &getModel('module'); $oModuleModel = &getModel('module');
@ -63,7 +68,9 @@
} }
/** /**
* @brief Re-generate the cache file * Re-generate the cache file
*
* @return void
**/ **/
function recompileCache() { function recompileCache() {
} }

15
modules/rss/rss.controller.php
View file

@ -1,23 +1,24 @@
<?php <?php
/** /**
* @class rssController * The controller class of rss module
*
* @author NHN (developers@xpressengine.com) * @author NHN (developers@xpressengine.com)
* @brief rss module of the controller class
*
* Feed the document output
*
**/ **/
class rssController extends rss { class rssController extends rss {
/** /**
* @brief Initialization * Initialization
*
* @return void
**/ **/
function init() { function init() {
} }
/** /**
* @brief Check whether to use RSS rss url by adding * Check whether to use RSS rss url by adding
*
* @return Object
**/ **/
function triggerRssUrlInsert() { function triggerRssUrlInsert() {
$oModuleModel = &getModel('module'); $oModuleModel = &getModel('module');

19
modules/rss/rss.model.php
View file

@ -1,16 +1,18 @@
<?php <?php
/** /**
* @class rssModel * The model class of the rss module
*
* @author NHN (developers@xpressengine.com) * @author NHN (developers@xpressengine.com)
* @brief The model class of the rss module
*
* Feed the document output
*
**/ **/
class rssModel extends rss { class rssModel extends rss {
/** /**
* @brief Create the Feed url. * Create the Feed url.
*
* @param string $vid Vid
* @param string $mid mid
* @param string $format Feed format. ef)xe, atom, rss1.0
* @return string
**/ **/
function getModuleFeedUrl($vid = null, $mid, $format) { function getModuleFeedUrl($vid = null, $mid, $format) {
if(Context::isAllowRewrite()) { if(Context::isAllowRewrite()) {
@ -30,7 +32,10 @@
/** /**
* @brief Return the RSS configurations of the specific modules * Return the RSS configurations of the specific modules
*
* @param integer $module_srl Module_srl
* @return Object
**/ **/
function getRssModuleConfig($module_srl) { function getRssModuleConfig($module_srl) {
// Get the configurations of the rss module // Get the configurations of the rss module

32
modules/rss/rss.view.php
View file

@ -1,24 +1,27 @@
<?php <?php
/** /**
* @class rssView * The view class of the rss module
* @author NHN (developers@xpressengine.com) *
* @brief The view class of the rss module * @author NHN (developers@xpressengine.com)
*
* Feed the document output
*
**/ **/
class rssView extends rss { class rssView extends rss {
/** /**
* @brief Initialization * Initialization
*
* @return void
**/ **/
function init() { function init() {
} }
/** /**
* @brief Feed output * Feed output.
* When trying to directly print out the RSS, the results variable can be directly specified through $oRssView->rss($document_list) * When trying to directly print out the RSS, the results variable can be directly specified through $oRssView->rss($document_list)
*
* @param Object $document_list Document list
* @param string $rss_title Rss title
* @param string $add_description Add description
**/ **/
function rss($document_list = null, $rss_title = null, $add_description = null) { function rss($document_list = null, $rss_title = null, $add_description = null) {
$oDocumentModel = &getModel('document'); $oDocumentModel = &getModel('document');
@ -181,7 +184,9 @@
$this->setTemplateFile('display'); $this->setTemplateFile('display');
} }
/** /**
* @brief ATOM output * ATOM output
*
* @return Object
**/ **/
function atom() { function atom() {
Context::set('format', 'atom'); Context::set('format', 'atom');
@ -189,7 +194,9 @@
} }
/** /**
* @brief Error output * Error output
*
* @return Object
**/ **/
function dispError() { function dispError() {
// Prepare the output message // Prepare the output message
@ -197,8 +204,11 @@
} }
/** /**
* @brief Additional configurations for a service module * Additional configurations for a service module
* Receive the form for the form used by rss * Receive the form for the form used by rss
*
* @param string $obj Will be inserted content in template
* @return Object
**/ **/
function triggerDispRssAdditionSetup(&$obj) { function triggerDispRssAdditionSetup(&$obj) {
$current_module_srl = Context::get('module_srl'); $current_module_srl = Context::get('module_srl');