phpmyadmin/libraries/plugins/AuthenticationPlugin.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the authentication plugins
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /* This class extends the PluginObserver class */
  13 require_once 'PluginObserver.class.php';
  14
  15 /**
  16  * Provides a common interface that will have to be implemented by all of the
  17  * authentication plugins.
  18  *
  19  * @package PhpMyAdmin
  20  */
  21 abstract class AuthenticationPlugin extends PluginObserver
  22 {
  23     /**
  24      * Displays authentication form
  25      *
  26      * @return boolean
  27      */
  28     abstract public function auth();
  29
  30     /**
  31      * Gets advanced authentication settings
  32      *
  33      * @return boolean
  34      */
  35     abstract public function authCheck();
  36
  37     /**
  38      * Set the user and password after last checkings if required
  39      *
  40      * @return boolean
  41      */
  42     abstract public function authSetUser();
  43
  44     /**
  45      * User is not allowed to login to MySQL -> authentication failed
  46      *
  47      * @return boolean
  48      */
  49     abstract public function authFails();
  50 }
  51 ?>