PHP Class ZF\Apigility\Admin\Model\AuthenticationEntity

Show file Open project: zfcampus/zf-apigility-admin Class Usage Examples

Protected Properties

Property Type Description
$database string Database name for mongo connection
$digestDomains string Digest domains for HTTP digest authentication (space-separated list of paths)
$dsn string PDO DSN of database for use with zf-oauth2
$dsnType string DSN type (Mongo or PDO)
$htdigest string Path to file containing HTTP digest credentials
$htpasswd string Path to file containing HTTP basic credentials
$nonceTimeout integer Nonce timeout for HTTP digest authentication
$password string Database password for zf-oauth2
$realm string Realm to use with either HTTP basic or digest authentication
$routeMatch string Literal URI path to match for OAuth2 authentication endpoint
$type string Authentication type
$username string Database username for zf-oauth2

Public Methods

Method Description
__construct ( $type = self::TYPE_BASIC, $realmOrParams = 'api', array $params = [] )
exchangeArray ( array $array )
getArrayCopy ( )
getDsnType ( )
isBasic ( )
isDigest ( )
isOAuth2 ( )

Method Details

__construct() public method

public __construct ( $type = self::TYPE_BASIC, $realmOrParams = 'api', array $params = [] )
$params array

exchangeArray() public method

public exchangeArray ( array $array )
$array array

getArrayCopy() public method

public getArrayCopy ( )

getDsnType() public method

public getDsnType ( )

isBasic() public method

public isBasic ( )

isDigest() public method

public isDigest ( )

isOAuth2() public method

public isOAuth2 ( )

Property Details

$database protected property

Database name for mongo connection
protected string $database
return string

$digestDomains protected property

Digest domains for HTTP digest authentication (space-separated list of paths)
protected string $digestDomains
return string

$dsn protected property

PDO DSN of database for use with zf-oauth2
protected string $dsn
return string

$dsnType protected property

DSN type (Mongo or PDO)
protected string $dsnType
return string

$htdigest protected property

Path to file containing HTTP digest credentials
protected string $htdigest
return string

$htpasswd protected property

Path to file containing HTTP basic credentials
protected string $htpasswd
return string

$nonceTimeout protected property

Nonce timeout for HTTP digest authentication
protected int $nonceTimeout
return integer

$password protected property

Database password for zf-oauth2
protected string $password
return string

$realm protected property

Realm to use with either HTTP basic or digest authentication
protected string $realm
return string

$routeMatch protected property

Literal URI path to match for OAuth2 authentication endpoint
protected string $routeMatch
return string

$type protected property

Authentication type
protected string $type
return string

$username protected property

Database username for zf-oauth2
protected string $username
return string