phpmyadmin/libraries/plugins/PluginObserver.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * The PluginObserver class is used alongside PluginManager to implement
   5  * the Observer Design Pattern.
   6  *
   7  * @package PhpMyAdmin
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /* Each PluginObserver instance contains a PluginManager instance */
  14 require_once 'PluginManager.class.php';
  15
  16 /**
  17  * This class implements the SplObserver interface
  18  *
  19  * @package PhpMyAdmin
  20  * @link    http://php.net/manual/en/class.splobserver.php
  21  */
  22 abstract class PluginObserver implements SplObserver
  23 {
  24     /**
  25      * PluginManager instance that contains a list with all the observer
  26      * plugins that attach to it
  27      *
  28      * @var type PluginManager
  29      */
  30     private $_pluginManager;
  31
  32     /**
  33      * Constructor
  34      *
  35      * @param PluginManager $pluginManager The Plugin Manager instance
  36      */
  37     public function __construct($pluginManager)
  38     {
  39         $this->_pluginManager = $pluginManager;
  40     }
  41
  42     /**
  43      * This method is called when any PluginManager to which the observer
  44      * is attached calls PluginManager::notify()
  45      *
  46      * TODO Declare this function abstract, removing its body,
  47      * as soon as we drop support for PHP 5.2.x.
  48      * See bug #3538655.
  49      *
  50      * @param SplSubject $subject The PluginManager notifying the observer
  51      *                            of an update.
  52      *
  53      * @return void
  54      */
  55     public function update (SplSubject $subject)
  56     {
  57         throw new Exception(
  58             'PluginObserver::update must be overridden in child classes.'
  59         );
  60     }
  61
  62
  63     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  64
  65
  66     /**
  67      * Gets the PluginManager instance that contains the list with all the
  68      * plugins that attached to it
  69      *
  70      * @return type PluginManager
  71      */
  72     public function getPluginManager()
  73     {
  74         return $this->_pluginManager;
  75     }
  76
  77     /**
  78      * Setter for $_pluginManager
  79      *
  80      * @param PluginManager $_pluginManager the private instance that it will
  81      *                                      attach to
  82      *
  83      * @return void
  84      */
  85     public function setPluginManager($_pluginManager)
  86     {
  87         $this->_pluginManager = $_pluginManager;
  88     }
  89 }
  90 ?>