Source for file StartupRequirement.interface.php

Documentation is available at StartupRequirement.interface.php

  1. <?php
    2. 

  2. /**
    3. 

  3.  * @package polyphony.startupcheck
    4. 

  4.  * 
    5. 

  5.  * @copyright Copyright &copy; 2005, Middlebury College
    6. 

  6.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
    7. 

  7.  *
    8. 

  8.  * @version $Id: StartupRequirement.interface.php,v 1.8 2007/09/19 14:04:50 adamfranco Exp $
    9. 

  9.  */
    10. 

  10.  
    11. 

  11. /**
    12. 

  12.  * A startup requirement is part of the application install/update system. A requirement class has the ability to check to make sure that
    13. 

  13.  * the environment for running said program is OK, or to make updates to settings, database tables, etc to adjust for changes
    14. 

  14.  * or program updates.
    15. 

  15.  *
    16. 

  16.  * @package polyphony.startupcheck
    17. 

  17.  * 
    18. 

  18.  * @copyright Copyright &copy; 2005, Middlebury College
    19. 

  19.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
    20. 

  20.  *
    21. 

  21.  * @version $Id: StartupRequirement.interface.php,v 1.8 2007/09/19 14:04:50 adamfranco Exp $
    22. 

  22.  */
    23. 

  23. class StartupRequirement {
    24. 

  24.  
    25. 

  25.     /**
    26. 

  26.      * Checks the environment and returns a status value. Return value is one of STARTUP_STATUS_* defines.
    27. 

  27.      * @access public
    28. 

  28.      * @return integer 
    29. 

  29.      */
    30. 

  30.     function getStatus()
    31. 

  31.     {
    32. 

  32.         
    33. 

  33.     }
    34. 

  34.     
    35. 

  35.     /**
    36. 

  36.      * Returns this requirement's display name.
    37. 

  37.      * @access public
    38. 

  38.      * @return string 
    39. 

  39.      */
    40. 

  40.     function getDisplayName()
    41. 

  41.     {
    42. 

  42.         
    43. 

  43.     }
    44. 

  44.     
    45. 

  45.     /**
    46. 

  46.      * Returns a {@link Wizard} object containing fields for user input to complete installation process.
    47. 

  47.      * @access public
    48. 

  48.      * @return ref object
    49. 

  49.      */
    50. 

  50.     function createWizard()
    51. 

  51.     {
    52. 

  52.         
    53. 

  53.     }
    54. 

  54.     
    55. 

  55.     /**
    56. 

  56.      * Tells the requirement class to perform its update/install operation. If user input is required, it is passed in the form of a {@link WizardStep} containing field values.
    57. 

  57.      * @param optional array $properties An array of values gotten from the {@link Wizard} as created by {@link StartupRequirement::createWizard()}.
    58. 

  58.      * @access public
    59. 

  59.      * @return int Returns the new status of this requirement after attempting update.
    60. 

  60.      */
    61. 

  61.     function doUpdate( $properties = null )
    62. 

  62.     {
    63. 

  63.         
    64. 

  64.     }
    65. 

  65.  
    66. 

  66. }
    67. 

  67.  
    68. 

  68.  
    69. 

  69. ?>
    70.

Documentation generated on Wed, 19 Sep 2007 10:26:41 -0400 by phpDocumentor 1.3.0RC3