Source for file jIInstallReporter.iface.php

Documentation is available at jIInstallReporter.iface.php

  1. <?php
  2. /**
  3. * @package     jelix
  4. * @subpackage  installer
  5. * @author      Laurent Jouanneau
  6. * @copyright   2008-2009 Laurent Jouanneau
  7. * @link        http://jelix.org
  8. * @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
  9. */
  10.  
  11. /**
  12. * interface for classes used as reporter for installation or check etc...
  13. * This classes are responsible to show informations to the user
  14. * @package     jelix
  15. * @subpackage  installer
  16. * @since 1.2
  17. */
  18. interface jIInstallReporter {
  19.  
  20.     /**
  21.      * start the process
  22.      */
  23.     function start();
  24.  
  25.     /**
  26.      * displays a message
  27.      * @param string $message the message to display
  28.      * @param string $type the type of the message : 'error', 'notice', 'warning', ''
  29.      */
  30.     function message($message, $type='');
  31.  
  32.     /**
  33.      * called when the installation is finished
  34.      * @param array $results an array which contains, for each type of message,
  35.      *  the number of messages
  36.      */
  37.     function end($results);
  38.  
  39. }

Documentation generated on Mon, 19 Sep 2011 14:12:57 +0200 by phpDocumentor 1.4.3