Zend Framework: Zend_Auth_Adapter_Chain Component Proposal

Proposed Component Name	Zend_Auth_Adapter_Chain
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Auth_Adapter_Chain
Proposers	Geoffrey Tran
Zend Liaison	TBD
Revision	1.0 - 1 January 2008: Initial Draft. (wiki revision: 4)

$auth = Zend_Auth::getInstance();

$ldap = new Zend_Auth_Adapter_Ldap();
$db   = new Zend_Auth_Adapter_DbTable();

$chain->setAdapters(array($ldap, $db));

$result = $auth->authenticate($chain);
if ($result->isValid()) {
    $adapter = $chain->getLastSuccessfulAdapter();
    // do something with it...
}

9. Class Skeletons

<?php
/**
 * Zym Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 *
 * @category   Zym
 * @package    Zym_Auth
 * @subpackage Adapter
 * @copyright  Copyright (c) 2008 Zym. (http://www.zym-project.com/)
 * @license    http://www.zym-project.com/license New BSD License
 */

/**
 * @see Zend_Auth_Adapter_Interface
 */
require_once 'Zend/Auth/Adapter/Interface.php';

/**
 * @see Zend_Auth_Result
 */
require_once 'Zend/Auth/Result.php';

/**
 * Authentication adapter used for chaining other auth adapters
 * to authenticate from multiple sources
 *
 * Adapters are processed in FIFO order.
 *
 * @author     Geoffrey Tran
 * @license    http://www.zym-project.com/license New BSD License
 * @category   Zym
 * @package    Zym_Auth
 * @subpackage Adapter
 * @copyright  Copyright (c) 2008 Zym. (http://www.zym-project.com/)
 */
class Zym_Auth_Adapter_Chain implements Zend_Auth_Adapter_Interface
{
    /**
     * Authentication adapter instances
     *
     * @var array Array of Zend_Auth_Adapters
     */
    private $_adapters = array();

    /**
     * Get the last successfully authenticated adapter
     *
     * @var Zend_Auth_Adapter_Interface
     */
    private $_lastSuccessfulAdapter;

    /**
     * authenticate() - defined by Zend_Auth_Adapter_Interface.  This method is called to
     * attempt an authenication.  Previous to this call, this adapter would have already
     * been configured with all nessissary information to successfully connect to a database
     * table and attempt to find a record matching the provided identity.
     *
     * @throws Zend_Auth_Adapter_Exception if answering the authentication query is impossible
     * @return Zend_Auth_Result
     */
    public function authenticate()
    {
    }

    /**
     * Get array of authentication adapters
     *
     * @return array
     */
    public function getAdapters()
    {
    }

    /**
     * Add adapter to the stack in FIFO order
     *
     * @param Zend_Auth_Adapter_Interface $adapter
     * @return Zym_Auth_Adapter_Chain
     */
    public function addAdapter(Zend_Auth_Adapter_Interface $adapter)
    {
    }

    /**
     * Set array of authentication adapters
     *
     * @param array $adapters
     * @return Zym_Auth_Adapter_Chain
     */
    public function setAdapters(array $adapters)
    {
    }

    /**
     * Get last successfully authenticated adapter instance
     *
     * @return Zend_Auth_Adapter_Interface
     */
    public function getLastSuccessfulAdapter()
    {
    }
}

Page Operations

Browse Space

Zend_Auth_Adapter_Chain - Geoffrey Tran

Labels

Zend Framework: Zend_Auth_Adapter_Chain Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons