phpmyadmin/libraries/plugins/PluginManager.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * The PluginManager class is used alongside PluginObserver to implement
   5  * the Observer Design Pattern.
   6  *
   7  * @package PhpMyAdmin
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /**
  14  * This class implements the SplSubject interface
  15  *
  16  * @todo    implement all methods
  17  * @package PhpMyAdmin
  18  * @link    http://php.net/manual/en/class.splsubject.php
  19  *
  20  */
  21 class PluginManager implements SplSubject
  22 {
  23     /**
  24      * Contains a list with all the plugins that attach to it
  25      *
  26      * @var type SplObjectStorage
  27      */
  28     private $_storage;
  29
  30     /**
  31      * Contains information about the current plugin state
  32      *
  33      * @var type string
  34      */
  35     private $_status;
  36
  37     /**
  38      * Constructor
  39      * Initializes $_storage with an empty SplObjectStorage
  40      */
  41     public function __construct()
  42     {
  43         $this->_storage = new SplObjectStorage();
  44     }
  45
  46     /**
  47      * Attaches an SplObserver so that it can be notified of updates
  48      *
  49      * @param SplObserver $observer The SplObserver to attach
  50      *
  51      * @return void
  52      */
  53     function attach (SplObserver $observer )
  54     {
  55         $this->_storage->attach($observer);
  56     }
  57
  58     /**
  59      * Detaches an observer from the subject to no longer notify it of updates
  60      *
  61      * @param SplObserver $observer The SplObserver to detach
  62      *
  63      * @return void
  64      */
  65     function detach (SplObserver $observer)
  66     {
  67          $this->_storage->detach($observer);
  68     }
  69
  70     /**
  71      * It is called after setStatus() was run by a certain plugin, and has
  72      * the role of sending a notification to all of the plugins in $_storage,
  73      * by calling the update() method for each of them.
  74      *
  75      * @todo implement
  76      * @return void
  77      */
  78     function notify ()
  79     {
  80     }
  81
  82     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  83
  84     /**
  85      * Gets the list with all the plugins that attach to it
  86      *
  87      * @return type SplObjectStorage
  88      */
  89     public function getStorage()
  90     {
  91         return $this->_storage;
  92     }
  93
  94     /**
  95      * Setter for $_storage
  96      *
  97      * @param SplObjectStorage $_storage the list with all the plugins that
  98      *                                  attach to it
  99      *
 100      * @return void
 101      */
 102     public function setStorage($_storage)
 103     {
 104         $this->_storage = $_storage;
 105     }
 106
 107     /**
 108      * Gets the information about the current plugin state
 109      * It is called by all the plugins in $_storage in their update() method
 110      *
 111      * @return type mixed
 112      */
 113     public function getStatus()
 114     {
 115         return $this->_status;
 116     }
 117
 118     /**
 119      * Setter for $_status
 120      * If a plugin changes its status, this has to be remembered in order to
 121      * notify the rest of the plugins that they should update
 122      *
 123      * @param mixed $_status contains information about the current plugin state
 124      *
 125      * @return void
 126      */
 127     public function setStatus($_status)
 128     {
 129         $this->_status = $_status;
 130     }
 131 }
 132 ?>