Http/Resolver/Interface.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Auth
0017  * @subpackage Zend_Auth_Adapter_Http
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022
0023
0024 /**
0025  * Auth HTTP Resolver Interface
0026  *
0027  * Defines an interace to resolve a username/realm combination into a shared
0028  * secret usable by HTTP Authentication.
0029  *
0030  * @category   Zend
0031  * @package    Zend_Auth
0032  * @subpackage Zend_Auth_Adapter_Http
0033  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0034  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0035  */
0036 interface Zend_Auth_Adapter_Http_Resolver_Interface
0037 {
0038     /**
0039      * Resolve username/realm to password/hash/etc.
0040      *
0041      * @param  string $username Username
0042      * @param  string $realm    Authentication Realm
0043      * @return string|false User's shared secret, if the user is found in the
0044      *         realm, false otherwise.
0045      */
0046     public function resolve($username, $realm);
0047 }