Zend_Auth_Adapter_Chain - Geoffrey Tran

Version 2 by Geoffrey Tran
on Feb 12, 2009 14:52.

<< Changes from 1 to 2

compared with

Version 3 by Matthew Weier O'Phinney
on Jul 14, 2009 13:50.

Changes from 3 to 4 >>

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (5)

View Page History

...

{zone-template-instance:ZFPROP:Proposal Zone Template}

{zone-data:component-name}
Zend_Auth_Adapter_Chain
{zone-data}

{zone-data:proposer-list}
[Geoffrey Tran| http://zym-project.com]
{zone-data}

{zone-data:liaison}
TBD
{zone-data}

{zone-data:revision}
1.0 - 1 January 2008: Initial Draft.
{zone-data}

{zone-data:overview}
This adapter allows the chaining of other authentication adapters to authenticate from multiple sources.
{zone-data}

{zone-data:references}
* [Zym_Auth_Adapter_Chain|http://code.google.com/p/zym/source/browse/trunk/incubator/library/Zym/Auth/Adapter/Chain.php]
{zone-data}

{zone-data:requirements}
* This component *will* return the successful authenticated adapter
* This component *will* use no more memory than twice the size of all data it contains.
{zone-data}

{zone-data:dependencies}
* Zend_Auth_Result
* Zend_Auth_Adapter_Interface
{zone-data}

{zone-data:operation}
Authentication adapter used for chaining other auth adapters to authenticate from multiple sources
* Adapters are processed in FIFO order.
{zone-data}

{zone-data:milestones}
* Milestone 1: [DONE] Working prototype
* Milestone 2: Unit tests, Documentation
* Milestone 4: Unit tests exist, work, and are checked into SVN.
* Milestone 5: Initial documentation exists.
{zone-data}

{zone-data:class-list}
* Zend_Auth_Adapter_Chain
{zone-data}

{zone-data:use-cases}
||UC-01||

{code}
$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...
}
{code}
{zone-data}

{zone-data:skeletons}
{code}
<?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()
{

$adapters = $this->getAdapters();

$results = array();
$resultMessages = array();
foreach ($adapters as $adapter) {
// Validate adapter
if (!$adapter instanceof Zend_Auth_Adapter_Interface) {
/**
* @see Zym_Auth_Adapter_Exception
*/
require_once 'Zym/Auth/Adapter/Exception.php';
throw new Zym_Auth_Adapter_Exception(sprintf(
'Adapter "%s" is not an instance of Zend_Auth_Adapter_Interface',
get_class($adapter)));
}

$result = $adapter->authenticate();

// Success
if ($result->isValid()) {
$this->_lastSuccessfulAdapter = $adapter;

return $result;
}

// Failure
$results[] = $result;
$resultMessages[] = $result->getMessages();
}

$result = new Zend_Auth_Result(Zend_Auth_Result::FAILURE, null, $resultMessages);

return $result;

}

...

public function getAdapters()
{

return $this->_adapters;

}

...

public function addAdapter(Zend_Auth_Adapter_Interface $adapter)
{

$this->_adapters[] = $adapter;
return $this;

}

...

public function setAdapters(array $adapters)
{

$this->_adapters = $adapters;
return $this;

}

...

public function getLastSuccessfulAdapter()
{

if (!$this->_lastSuccessfulAdapter instanceof Zend_Auth_Adapter_Interface) {
/**
* @see Zend_Auth_Adapter_Exception
*/
require_once 'Zend/Auth/Adapter/Exception.php';
throw new Zend_Auth_Adapter_Exception(
'No adapters have successfully authenticated'
);
}

return $this->_lastSuccessfulAdapter;

}
}

...