interface/modules/zend_modules/library/Zend/Authentication/Adapter/Http/ResolverInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Authentication\Adapter\Http;
  11
  12 /**
  13  * Auth HTTP Resolver Interface
  14  *
  15  * Defines an interface to resolve a username/realm combination into a shared
  16  * secret usable by HTTP Authentication.
  17  */
  18 interface ResolverInterface
  19 {
  20     /**
  21      * Resolve username/realm to password/hash/etc.
  22      *
  23      * @param  string $username Username
  24      * @param  string $realm    Authentication Realm
  25      * @param  string $password Password (optional)
  26      * @return string|array|false User's shared secret as string if found in realm, or User's identity as array
  27      *         if resolved, false otherwise.
  28      */
  29     public function resolve($username, $realm, $password = null);
  30 }