classes/plugins/AuthPlugin.inc.php

Go to the documentation of this file.

<?php

//$Id$

define('AUTH_PLUGIN_CATEGORY', 'auth');

class AuthPlugin extends Plugin {

   var $settings;

   var $authId;

   function AuthPlugin($settings = array(), $authId = null) {
      parent::Plugin();
      $this->settings = $settings;
      $this->authId = $authId;
   }


   //
   // General Plugin Functions
   //

   function getName() {
      return 'auth';
   }

   function getDisplayName() {
      return 'Abstract Authentication Plugin';
   }

   function getDescription() {
      'Authentication plugin base class';
   }

   function getSettingsTemplate() {
      return $this->getTemplatePath() . 'settings.tpl';
   }


   //
   // Wrapper Functions
   //

   function doGetUserInfo(&$user) {
      if (isset($this->settings['syncProfiles'])) {
         return $this->getUserInfo($user);
      }
      return false;
   }

   function doSetUserInfo(&$user) {
      if (isset($this->settings['syncProfiles'])) {
         return $this->setUserInfo($user);
      }
      return false;
   }

   function doSetUserPassword($username, $password) {
      if (isset($this->settings['syncPasswords'])) {
         return $this->setUserPassword($username, $password);
      }
      return false;
   }

   function doCreateUser(&$user) {
      if (isset($this->settings['createUsers'])) {
         return $this->createUser($user);
      }
      return false;
   }


   //
   // Core Plugin Functions
   // (Must be implemented by every authentication plugin)
   //

   function &getInstance($settings, $authId) {
      $returner = null;
      return $returner;
   }

   function authenticate($username, $password) {
      return false;
   }


   //
   // Optional Plugin Functions
   // (Required for extended functionality but not for authentication-only plugins)
   //

   function userExists($username) {
      return false;
   }

   function getUserInfo(&$user) {
      return false;
   }

   function setUserInfo(&$user) {
      return false;
   }

   function setUserPassword($username, $password) {
      return false;
   }

   function createUser(&$user) {
      return false;
   }

   function deleteUser($username) {
      return false;
   }

   function isSitePlugin() {
      return true;
   }

   function getManagementVerbs() {
      return array(
         array(
            'authSources',
            __('admin.authSources')
         )
      );
   }

   function manage($verb, $args) {
      if ($verb === 'authSources') {
         Request::redirect('index', 'index', ROLE_PATH_SITE_ADMIN, 'auth');
      }
      return false;
   }
}

?>

---