ldap.authentication.inc in Lightweight Directory Access Protocol (LDAP) 6

Defines the authentication class and related functions.

File

includes/ldap.authentication.inc

<?php

/**
 * @file
 * Defines the authentication class and related functions.
 *
 */

/**
 * LDAP Authentication Class
 *
 *  This class is used to properly authenticate to an LDAP server.
 */
class ldap_authentication {

  /**
   * Constructor Method
   */
  function __construct() {
  }

  /**
   * Destructor Method
   */
  function __destruct() {
  }

  /**
   * Invoke Method
   */
  function __invoke() {
  }

  /**
   * Error Handling Method
   *
   * @param int errno
   *   The level of the error raised.
   *
   * @param string errstr
   *   The error message.
   *
   * @param string errfile
   *   The filename that the error was raised in.
   *
   * @param int errline
   *   The line number the error was raised at.
   *
   * @param array errcontext
   *   An array of every variable that existed in the scope the error was
   *   triggered in.
   *
   * @return bool
   *   Always return TRUE to avoid PHP's builtin handler.
   */
  function error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
    return TRUE;
  }

  /**
   * Perform LDAP authentication
   *
   * @parm
   * @return boolean
   * TRUE if authentication succeeds, FALSE otherwise.
   */
  function authenticate($user, $pass) {
  }

}

/**
 * LDAP Authentication Functions
 *
 *   These functions provide additional authentication support while not quite 
 * fitting within the class.
 */

// vim:fenc=utf-8:ft=php:ai:si:ts=2:sw=2:et:

Classes

Name	Description
ldap_authentication	LDAP Authentication Class