project/library/Pivip/Module/Abstract.php

   1 <?php
   2
   3 /**
   4  * Pivip
   5  * Copyright (C) 2008  Vincent Tunru
   6
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; version 2
  10
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  19  *
  20  * @license   http://www.fsf.org/licensing/licenses/info/GPLv2.html GPL v.2
  21  * @category  Pivip
  22  * @package   Pivip_Install
  23  * @copyright (C) 2008 Vincent Tunru
  24  * @author    Vincent Tunru <email@vincentt.org>
  25  */
  26
  27 /**
  28  * Modules can extend this to provide an interface to the module
  29  */
  30 abstract class Pivip_Module_Abstract
  31 {
  32         /**
  33          * A list of required modules and their versions
  34          *
  35          * The module should define minimum and maximum versions, using
  36          *      array('module' => array('min' => 0.0.0dev', 'max' => '3.1.1'));
  37          *
  38          * @var array
  39          */
  40         protected $_dependencies;
  41
  42         /**
  43          * Modules must be able to determine whether they're installed
  44          *
  45          * If a module does not need to be installed, this function should return
  46          * true by default.
  47          *
  48          * @return boolean True if the module is already installed, flase if not.
  49          */
  50         abstract public static function isInstalled();
  51
  52         /**
  53          * Whether a module needs configuration before installation
  54          *
  55          * Note: if modules return true, they also need to provide a
  56          * configure() function.
  57          *
  58          * @return boolean Whether the module needs to be configured.
  59          */
  60         abstract public static function needsConfiguring();
  61
  62         /**
  63          * Install the module (prepare the database, mark installed status, ...)
  64          *
  65          * @throws Pivip_Install_Exception
  66          * @return boolean Whether the installation succeeded
  67          */
  68         public function install()
  69         {
  70         }
  71
  72         /**
  73          * Uninstall the module (remove database values, ...)
  74          *
  75          * @throws Pivip_Install_Exception
  76          * @return boolean Whether uninstallation succeeded
  77          */
  78         public function uninstall()
  79         {
  80         }
  81
  82         /**
  83          * Check whether the module's API dependencies are available
  84          *
  85          * @throws Pivip_Install_Exception
  86          * @return boolean True if API dependencies are met.
  87          */
  88         public function checkDependencies()
  89         {
  90         }
  91
  92         /**
  93          * Load the module
  94          */
  95         public function bootstrap()
  96         {
  97         }
  98
  99         /**
 100          * Allows child classes to push a request onto the stack
 101          *
 102          * @param Zend_Controller_Request_Abstract $request The request to push.
 103          */
 104         protected static function _pushStack(Zend_Controller_Request_Abstract $request)
 105         {
 106                 $frontController = Zend_Controller_Front::getInstance();
 107                 $actionStack = $frontController
 108                                 ->getPlugin('Zend_Controller_Plugin_ActionStack');
 109                 if(!$actionStack)
 110                 {
 111                         $actionStack = new Zend_Controller_Plugin_ActionStack();
 112                         $frontController->registerPlugin($actionStack);
 113                 }
 114                 $actionStack->pushStack($request);
 115         }
 116 }