Example
[ class tree: Example ] [ index: Example ] [ all elements ]
Packages:
Console_Application
Console_Deamon
Console_Enviroment
Console_Exception
Example
Unittests

Source for file HelloWorldApplication.php

Documentation is available at HelloWorldApplication.php

  1. <?php
  2. /**
  3.  * Console Library
  4.  *
  5.  * LICENSE
  6.  *
  7.  * "THE BEER-WARE LICENSE" (Revision 42):
  8.  * "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
  9.  * As long as you retain this notice you can do whatever you want with
  10.  * this stuff. If we meet some day, and you think this stuff is worth it,
  11.  * you can buy me a beer in return.
  12.  *
  13.  * $Author$
  14.  * $Revisio$
  15.  *
  16.  * @category    Console
  17.  * @package     Example
  18.  * @copyright   Copyright (c) 2009 Sven Strittmatter
  19.  */
  20.  
  21. /**
  22.  * @see Console_Application_Abstract
  23.  */
  24. require_once('Console/Application/Abstract.php');
  25. /**
  26.  * @see Console_Exception
  27.  */
  28. require_once('Console/Exception.php');
  29.  
  30. /*
  31.  * Neccessary for the signal handler
  32.  */
  33. declare(ticks = 1);
  34.  
  35. /**
  36.  * Template method class for CLI commands.
  37.  *
  38.  * @see HelloWorldApplication for an example implementation.
  39.  *
  40.  * @abstract
  41.  * @category   Console
  42.  * @package    Example
  43.  * @uses       Console_Application_Abstract
  44.  * @uses       Console_Exception
  45.  * @copyright  Copyright (c) 2009 Sven Strittmatter
  46.  */
  47. class HelloWorldApplication extends Console_Application_Abstract {
  48.     /**
  49.      * @access protected
  50.      * @var string 
  51.      */
  52.     protected $name  = 'world';
  53.     /**
  54.      * @access protected
  55.      * @var int 
  56.      */
  57.     protected $sleep = 0;
  58.  
  59.     /**
  60.      * @see Console_Application_Abstract::run()
  61.      */
  62.     protected function run() {
  63.         // if this constant is defined, then this script runs in an unit test.
  64.         // there we wont echo some messages to cli.
  65.         $quiet = defined('TESTS_CONSOLE_APPLICATION_LOCATION');
  66.  
  67.         if (!$quiet) {
  68.             echo "Hello";
  69.             sleep($this->sleep);
  70.             echo " {$this->name}!\n";
  71.         }
  72.     }
  73.  
  74.     /**
  75.      * @see Console_Application_Abstract::signalInt()
  76.      */
  77.     public function signalInt($signal) {
  78.         throw new Console_Exception('bye bye');
  79.     }
  80.  
  81.     /**
  82.      * @see Console_Application_Abstract::findConsoleParameters()
  83.      */
  84.     protected function findConsoleParameters() {
  85.         $options = getopt('n:s:');
  86.  
  87.         if (!parent::findConsoleParameters()) {
  88.             return false;
  89.         }
  90.  
  91.         if (isset($options['n']) && !empty($options['n'])) {
  92.             $this->name = $options['n'];
  93.         }
  94.  
  95.         if (isset($options['s']) && !empty($options['s'])) {
  96.             $this->sleep = (int) $options['s'];
  97.         }
  98.  
  99.         return true;
  100.     }
  101.  
  102.     /**
  103.      * @see Console_Application_Abstract::getUsage()
  104.      */
  105.     public function getUsage($options = null) {
  106.         return parent::getUsage('[-n name] [-s seconds]');
  107.     }
  108.  
  109.     /**
  110.      * @see Console_Application_Abstract::getHelpMessage()
  111.      */
  112.     public function getHelpMessage($author = 'Sven Strittmatter', $email = 'ich@weltraumschaf.de') {
  113.         $message  = "This is a sample console application. It prints some hello world statements." . PHP_EOL . PHP_EOL;
  114.         $message .= $this->getUsage() . PHP_EOL;
  115.         $message .= "\t{$this->scriptname} -n : You can specify a name to be hellowed" . PHP_EOL;
  116.         $message .= "\t{$this->scriptname} -s : You can specify the seconds to sleep between hello and name."  . PHP_EOL;
  117.         $message .= parent::getHelpMessage($author, $email);
  118.  
  119.         throw new Console_Exception($message);
  120.     }
Documentation generated on Mon, 17 Aug 2009 15:52:39 +0200 by phpDocumentor 1.4.2