Zikula_System_Modules
[ class tree: Zikula_System_Modules ] [ index: Zikula_System_Modules ] [ all elements ]

Source for file pninit.php

Documentation is available at pninit.php

  1. <?php
  2. /**
  3.  * Zikula Application Framework
  4.  * @copyright (c) 2001, Zikula Development Team
  5.  * @link http://www.zikula.org
  6.  * @version $Id: pninit.php 24342 2008-06-06 12:03:14Z markwest $
  7.  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
  8.  * @package      Zikula_System_Modules
  9.  * @subpackage   AuthPN
  10.  * @author       Mark West
  11.  */
  12.  
  13.  
  14. /**
  15.  * initialise the AuthPN module
  16.  *
  17.  * This function is only ever called once during the lifetime of a particular
  18.  * module instance.
  19.  * This function MUST exist in the pninit file for a module
  20.  *
  21.  * @author       Jim McDonald
  22.  * @return       bool       true on success, false otherwise
  23.  */
  24. function AuthPN_init()
  25. {
  26.     // Set up an initial value for a module variable.  Note that all module
  27.     // variables should be initialised with some value in this way rather
  28.     // than just left blank, this helps the user-side code and means that
  29.     // there doesn't need to be a check to see if the variable is set in
  30.     // the rest of the code as it always will be
  31.     pnModSetVar('AuthPN''authmodules''AuthPN');
  32.  
  33.     // Initialisation successful
  34.     return true;
  35. }
  36.  
  37.  
  38. /**
  39.  * upgrade the AuthPN module from an old version
  40.  *
  41.  * This function can be called multiple times
  42.  * This function MUST exist in the pninit file for a module
  43.  *
  44.  * @author       Jim McDonald
  45.  * @return       bool       true on success, false otherwise
  46.  */
  47. function AuthPN_upgrade($oldversion)
  48. {
  49.     // Update successful
  50.     return true;
  51. }
  52.  
  53.  
  54. /**
  55.  * delete the AuthPN module
  56.  *
  57.  * This function is only ever called once during the lifetime of a particular
  58.  * module instance
  59.  * This function MUST exist in the pninit file for a module
  60.  *
  61.  * @author       Jim McDonald
  62.  * @return       bool       true on success, false otherwise
  63.  */
  64. function AuthPN_delete()
  65. {
  66.     // Delete any module variables
  67.     pnModDelVar('AuthPN');
  68.  
  69.     // Deletion successful
  70.     return true;
  71. }

Documentation generated on Fri, 18 Jul 2008 21:53:38 +0200 by phpDocumentor 1.4.1