Zikula_Value_Addons
[ class tree: Zikula_Value_Addons ] [ index: Zikula_Value_Addons ] [ all elements ]
Packages:
Zikula 1.0.1
axmls
PHPLayersMenu
PHPMailer
phpSniff
pnForm
PostNuke_Core
RC4Crypt
SafeHTML
Services_JSON
SimplePie
Smarty
Xanthia_Templating_Environment
XML_HTMLSax3
ZikulaTemplate_Plugins
Zikula_Core
Zikula_Docs
Zikula_System_Modules
Zikula_Template_Plugins
Zikula_Themes
Zikula_Value_Addons

Source for file pnadmin.php

Documentation is available at pnadmin.php

  1. <?php
  2. /**
  3.  * Zikula Application Framework
  4.  *
  5.  * @copyright (c) 2002, Zikula Development Team
  6.  * @link http://www.zikula.org
  7.  * @version $Id: pnadmin.php 24342 2008-06-06 12:03:14Z markwest $
  8.  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
  9.  * @package Zikula_Value_Addons
  10.  * @subpackage AvantGo
  11.  */
  12.  
  13. /**
  14.  * the main administration function
  15.  * This function is the default function, and is called whenever the
  16.  * module is initiated without defining arguments.  As such it can
  17.  * be used for a number of things, but most commonly it either just
  18.  * shows the module menu and returns or calls whatever the module
  19.  * designer feels should be the default function (often this is the
  20.  * view() function)
  21.  * @author Mark West
  22.  * @link http://www.markwest.me.uk
  23.  * @return string HTML string
  24.  */
  25. function AvantGo_admin_main()
  26. {
  27.     // Security check
  28.     if (!SecurityUtil::checkPermission('AvantGo::', '::', ACCESS_EDIT)) {
  29.         return LogUtil::registerPermissionError();
  30.     }
  31.  
  32.     // Create output object
  33.     $pnRender = pnRender::getInstance('AvantGo');
  34.  
  35.     // Return the output that has been generated by this function
  36.     return $pnRender->fetch('avantgo_admin_main.htm');
  37. }
  38.  
  39. /**
  40.  * View items that would be displayed by the module within PN framework
  41.  * @author Mark West
  42.  * @link http://www.markwest.me.uk
  43.  * @param 'startnum' the starting article numbner
  44.  * @return strong HTML string
  45.  */
  46. function AvantGo_admin_view()
  47. {
  48.     // Security check
  49.     if (!SecurityUtil::checkPermission('AvantGo::', '::', ACCESS_EDIT)) {
  50.         return LogUtil::registerPermissionError();
  51.     }
  52.  
  53.     $startnum = FormUtil::getPassedValue('startnum', isset($args['startnum']) ? $args['startnum'] : null, 'GET');
  54.  
  55.     // Create output object
  56.     $pnRender = pnRender::getInstance('AvantGo', false);
  57.  
  58.     // Get all the items from the API
  59.     $items = pnModAPIFunc('News', 'user', 'getall',
  60.                           array('startnum' => $startnum,
  61.                                 'numitems' => pnModGetVar('AvantGo', 'itemsperpage')));
  62.  
  63.     // assign the result set
  64.     $pnRender->assign('storyitems', $items);
  65.  
  66.     // Return the output that has been generated by this function
  67.     return $pnRender->fetch('avantgo_admin_view.htm');
  68. }
  69.  
  70. /**
  71.  * This is a standard function to modify the configuration parameters of the
  72.  * module
  73.  * @author Mark West
  74.  * @link http://www.markwest.me.uk
  75.  * @return string HTML string
  76.  */
  77. function AvantGo_admin_modifyconfig()
  78. {
  79.     // Security check
  80.     if (!SecurityUtil::checkPermission('AvantGo::', '::', ACCESS_ADMIN)) {
  81.         return LogUtil::registerPermissionError();
  82.     }
  83.  
  84.     // Create output object
  85.     $pnRender = pnRender::getInstance('AvantGo', false);
  86.  
  87.     // assign all module vars
  88.     $pnRender->assign(pnModGetVar('AvantGo'));
  89.  
  90.     // Return the output that has been generated by this function
  91.     return $pnRender->fetch('avantgo_admin_modifyconfig.htm');
  92. }
  93.  
  94. /**
  95.  * This is a standard function to update the configuration parameters of the
  96.  * module given the information passed back by the modification form
  97.  * @author Mark West
  98.  * @link http://www.markwest.me.uk
  99.  * @param 'itemsperpage' the number of items to display on the module page
  100.  * @return bool true if update successful, false otherwise
  101.  */
  102. function AvantGo_admin_updateconfig()
  103. {
  104.     // Security check
  105.     if (!SecurityUtil::checkPermission('AvantGo::', '::', ACCESS_ADMIN)) {
  106.         return LogUtil::registerPermissionError();
  107.     }
  108.  
  109.     // Confirm authorisation code.
  110.     if (!SecurityUtil::confirmAuthKey()) {
  111.         return LogUtil::registerAuthidError (pnModURL('AvantGo', 'admin', 'view'));
  112.     }
  113.  
  114.     // Update module variables.
  115.     $itemsperpage = FormUtil::getPassedValue('itemsperpage', 25, 'POST');
  116.     pnModSetVar('AvantGo', 'itemsperpage', $itemsperpage);
  117.  
  118.     // Let any other modules know that the modules configuration has been updated
  119.     pnModCallHooks('module','updateconfig','AvantGo', array('module' => 'AvantGo'));
  120.  
  121.     // the module configuration has been updated successfuly
  122.     LogUtil::registerStatus (_CONFIGUPDATED);
  123.  
  124.     // This function generated no output, and so now it is complete we redirect
  125.     // the user to an appropriate page for them to carry on their work
  126.     return pnRedirect(pnModURL('AvantGo', 'admin', 'view'));
  127. }
Documentation generated on Fri, 18 Jul 2008 21:50:01 +0200 by phpDocumentor 1.4.1