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

Source for file Abstract.php

Documentation is available at Abstract.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.  * $Revision$
  15.  * 
  16.  * @category    Console
  17.  * @package     Console_Application
  18.  * @copyright   Copyright (c) 2009 Sven Strittmatter
  19.  */
  20.  
  21. /**
  22.  * Console_Application_Abstract.
  23.  *
  24.  * @see Console_Application_Abstract
  25.  */
  26. require_once('Console/Application/Abstract.php');
  27. /**
  28.  * Console_Exception.
  29.  *
  30.  * @see Console_Exception
  31.  */
  32. require_once('Console/Exception.php');
  33.  
  34. /**
  35.  * Class which is running in a loop.
  36.  *
  37.  * @abstract
  38.  * @category   Console
  39.  * @package    Console_Deamon
  40.  * @uses       Console_Application_Abstract
  41.  * @uses       Console_Exception
  42.  * @copyright  Copyright (c) 2009 Sven Strittmatter
  43.  */
  44. abstract class Console_Deamon_Abstract extends Console_Application_Abstract {
  45.     /**
  46.      * Flag to signal to break the loop.
  47.      *
  48.      * @access private
  49.      * @var bool 
  50.      */
  51.     private $breakLoop;
  52.     /**
  53.      * Counts the executed loops.
  54.      * 
  55.      * @access private
  56.      * @var int 
  57.      */
  58.     private $counter = 0;
  59.  
  60.     /**
  61.      * Template method from Console_Application_Abstract.
  62.      * This method runs the method doLoopCycle() which you must
  63.      * implement in your deamon class implementation.
  64.      *
  65.      * @see Console_Application_Abstract
  66.      *
  67.      * @final
  68.      * @access protected
  69.      */
  70.     final protected function run() {
  71.         $this->onPreLoop();
  72.  
  73.         while (true) {
  74.             if ($this->breakLoop) {
  75.                 $this->onBreakLoop();
  76.                 break;
  77.             }
  78.  
  79.             $this->doLoopCycle();
  80.             $this->counter++;
  81.         }
  82.  
  83.         $this->onPostLoop();
  84.     }
  85.  
  86.     /**
  87.      * Overwrite this method to hook the pre loop phase.
  88.      * This method is called first before the loop. But after
  89.      * Console_Application_Abstract::setUp().
  90.      *
  91.      * @access protected
  92.      */
  93.     protected function onPreLoop() {}
  94.     /**
  95.      * Overwrite this method to hook the moment the internal breakLoop flag
  96.      * is set true by the script.
  97.      *
  98.      * @access protected
  99.      */
  100.     protected function onBreakLoop() {}
  101.     /**
  102.      * Overwrite this method to hook the phase after the loop. This Method
  103.      * is called imediately after self::onBreakLoop(). But before
  104.      * Console_Application_Abstract::tearDown().
  105.      *
  106.      * @access protected
  107.      */
  108.     protected function onPostLoop() {}
  109.     /**
  110.      * You need to implement this method with your loop code.
  111.      * This method is called periodicly until self::breakLoop()
  112.      * is called.
  113.      *
  114.      * Important is, that after self::breakLoop() this method runs
  115.      * until it returns. If you want to break out from your loop
  116.      * method directly after setting the demaon to break the loop,
  117.      * you need to return:
  118.      *
  119.      * <code>
  120.      * protected function onPostLoop() {
  121.      *      // some work ...
  122.      *
  123.      *      if ($something) {
  124.      *          // We break out imediately.
  125.      *          // some other work will not be executed
  126.      *          self::breakLoop();
  127.      *          return;
  128.      *      }
  129.      *
  130.      *      if ($somethingElse) {
  131.      *          // We only break the loop.
  132.      *          // This method will not be executed anymore.
  133.      *          // But some other work will be executed the last time!
  134.      *          self::breakLoop();
  135.      *      }
  136.      *
  137.      *      // some other work ...
  138.      * }
  139.      * </code>
  140.      */
  141.     protected abstract function doLoopCycle();
  142.  
  143.     /**
  144.      * Signals the object to do no more loop cycles.
  145.      * After the actual call to self::doLoopCycle() has finished
  146.      * self::onBreakLoop() will be called.
  147.      */
  148.     protected function breakLoop() {
  149.         $this->breakLoop = true;
  150.     }
  151.  
  152.     /**
  153.      * Bind the signal SIG_TERM to brek the loop.
  154.      *
  155.      * @access public
  156.      * @param int $signal 
  157.      */
  158.     public function signalTerm($signal) {
  159.         $this->breakLoop();
  160.     }
  161.  
  162.     /**
  163.      * Bind the signal SIG_INT to brek the loop.
  164.      *
  165.      * @access public
  166.      * @param int $signal 
  167.      */
  168.     public function signalInt($signal) {
  169.         $this->breakLoop();
  170.     }
  171. }
Documentation generated on Mon, 17 Aug 2009 15:51:54 +0200 by phpDocumentor 1.4.2