Source for file Observer.class.php

Documentation is available at Observer.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Observer
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Observer Pattern Interface, Observer
  22.  * 
  23.  * An Observer is simply an object that wants to receive constant updates
  24.  * to the changes of another object (Observerable).  The Observer constructor
  25.  * should register with the Observerable.  The Observer should also define
  26.  * a destructor method (__destruct) to remove itself from any Observerable
  27.  * objects it registered with.
  28.  *
  29.  * @category Gumbo
  30.  * @package Observer
  31.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  32.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  33.  * @author Michael Luster <mluster79@yahoo.com>
  34.  * @link http://sourceforge.net/projects/phpgumbo
  35.  * @desc Observer Pattern Interface, Observer
  36.  * @version 0.0.1
  37.  */
  38.  
  39. interface Gumbo_Interface_Observer {
  40.     
  41.     /**
  42.      * Receives updated information from an Observerable object
  43.      * 
  44.      * The Observerable will send changes to the Observer through this method.  The
  45.      * data is a key=>val array, containing important information about the
  46.      * Observerable.  Each Observer will be required to parse the array for the
  47.      * correct details.  For example, if an Observerable send out updates on it's
  48.      * current status ($data['status'] = value), the Observer should look for
  49.      * just the 'status' key.
  50.      * 
  51.      * <pre>
  52.      * foreach ($data as $key=>$val) {
  53.      *     if ($key == "status") {
  54.      *         // do something with the value
  55.      *     }
  56.      * }
  57.      * </pre>
  58.      * 
  59.      * The key=>value approach was used because a single Observer can be registered
  60.      * with multiple Observerable objects.
  61.      * 
  62.      * @param array $data key=>val array with important data for the Observer
  63.      */
  64.     public function update ($data);
  65.     
  66. }
  67.  
  68. ?>