Auth/Adapter/Http/Resolver/File.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework
LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Auth  
Subpackage
Zend_Auth_Adapter_Http  
Version
$Id$  

\Zend_Auth_Adapter_Http_Resolver_File

Package: Zend_Auth\Zend_Auth_Adapter_Http
HTTP Authentication File Resolver
Implements
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_file
Path to credentials file
Details
Type
string

Methods

methodpublic__construct(string $path = '') : void

Constructor

Parameters
NameTypeDescription
$pathstring

Complete filename where the credentials are stored

methodpublicgetFile() : string

Returns the path to the credentials file

Returns
TypeDescription
string
methodpublicresolve(string $username, string $realm) : string | false

Resolve credentials

Only the first matching username/realm combination in the file is returned. If the file contains credentials for Digest authentication, the returned string is the password hash, or h(a1) from RFC 2617. The returned string is the plain-text password for Basic authentication. The expected format of the file is: username:realm:sharedSecret That is, each line consists of the user's username, the applicable authentication realm, and the password or hash, each delimited by colons.
Parameters
NameTypeDescription
$usernamestring

Username

$realmstring

Authentication Realm

Returns
TypeDescription
string | falseUser's shared secret, if the user is found in the realm, false otherwise.
Throws
ExceptionDescription
\Zend_Auth_Adapter_Http_Resolver_Exception
methodpublicsetFile(string $path) : \Zend_Auth_Adapter_Http_Resolver_File

Set the path to the credentials file

Parameters
NameTypeDescription
$pathstring
Returns
TypeDescription
\Zend_Auth_Adapter_Http_Resolver_FileProvides a fluent interface
Throws
ExceptionDescription
\Zend_Auth_Adapter_Http_Resolver_Exception
Documentation was generated by phpDocumentor 2.2.0 .