project/plugins/Openid/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_Openid
  23  * @copyright (C) 2008 Vincent Tunru
  24  * @author    Vincent Tunru <email@vincentt.org>
  25  */
  26
  27 /**
  28  * Manage the Openid plugin
  29  *
  30  * The Openid plugin allows for authentication using OpenID.
  31  *
  32  * @see /library/Pivip/Plugin/Abstract.php
  33  * @link http://openid.net/ OpenID.net
  34  */
  35 class Openid_Plugin extends Pivip_Plugin_Abstract
  36 {
  37         /**
  38          * Defines the dependencies
  39          *
  40          * Openid depends on Pivip and the Page plugin
  41          */
  42         public function __construct()
  43         {
  44         }
  45
  46         /**
  47          * Checks whether the OpenID database table exists
  48          *
  49          * Will check for a cache hit - if there's a hit, Plugin_Openid is installed,
  50          * if there's a miss, it will check whether the database table has been
  51          * created. If it has, then it will save it to cache.
  52          *
  53          * @return boolean Whether Openid is already installed.
  54          */
  55         public static function isInstalled()
  56         {
  57         }
  58
  59         /**
  60          * Communicate that Openid needs configuration
  61          *
  62          * Always returns true since OpenID needs to be told the name of the first,
  63          * allmighty, user.
  64          *
  65          * @return boolean True, OpenID needs to be configured
  66          */
  67         public static function needsConfiguring()
  68         {
  69                 return true;
  70         }
  71
  72         /**
  73          * Creates the table in the database and perform the first authentication
  74          *
  75          * @throws Pivip_Install_Exception
  76          * @return boolean Whether the installation succeeded
  77          */
  78         public function install()
  79         {
  80         }
  81
  82         /**
  83          * Remove the table from the database
  84          *
  85          * @throws Pivip_Install_Exception
  86          * @return boolean Whether uninstallation succeeded
  87          */
  88         public function uninstall()
  89         {
  90         }
  91
  92         /**
  93          * Load the plugin
  94          *
  95          * Set up routes.
  96          */
  97         public static function bootstrap()
  98         {
  99         }
 100 }