project/plugins/Admin/Plugin.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  PivipPluginsDefault
  22  * @package   Plugin_Admin
  23  * @copyright (C) 2008 Vincent Tunru
  24  * @author    Vincent Tunru <email@vincentt.org>
  25  */
  26
  27 /**
  28  * Manage the Admin plugin
  29  *
  30  * The Admin plugin provides an administrative interface to Pivip and plugins.
  31  *
  32  * @see /library/Pivip/Plugin/Abstract.php
  33  */
  34 class Admin_Plugin extends Pivip_Plugin_Abstract
  35 {
  36         /**
  37          * Checks whether the Admin plugin is installed
  38          *
  39          * @return boolean Whether Admin is already installed.
  40          */
  41         public static function isInstalled()
  42         {
  43         }
  44
  45         /**
  46          * Communicate that Admin does not need configuration
  47          *
  48          * Always returns false.
  49          *
  50          * @return boolean false, Admin does not need to be configured
  51          */
  52         public static function needsConfiguring()
  53         {
  54                 return false;
  55         }
  56
  57         /**
  58          * Install the Admin plugin
  59          *
  60          * @throws Pivip_Install_Exception
  61          * @return boolean Whether the installation succeeded
  62          */
  63         public function install()
  64         {
  65         }
  66
  67         /**
  68          * Uninstall the Admin plugin
  69          *
  70          * @throws Pivip_Install_Exception
  71          * @return boolean Whether uninstallation succeeded
  72          */
  73         public function uninstall()
  74         {
  75         }
  76
  77         /**
  78          * Load the plugin
  79          *
  80          * Set up routes.
  81          */
  82         public static function bootstrap()
  83         {
  84         }
  85 }