PHP Класс ZF\Apigility\Admin\Model\AuthenticationModel

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$globalConfig ZF\Configuration\ConfigResource
$localConfig ZF\Configuration\ConfigResource
$modules ModuleModel

Открытые методы

Метод Описание
__construct ( ZF\Configuration\ConfigResource $globalConfig, ZF\Configuration\ConfigResource $localConfig, ModuleModel $modules )
arrayDiffRecursive ( mixed $a, mixed $b ) : integer Perform a recursive array diff
create ( array $authenticationConfig ) : AuthenticationEntity Create authentication configuration
createAuthenticationAdapter ( array $adapter ) : array Create authentication adapter for version 2
fetch ( ) : AuthenticationEntity | false Fetch configuration details for authentication
fetchAllAuthenticationAdapter ( ) : array Fetch configuration details for auth adapters
fetchAuthenticationAdapter ( string $name ) : array | false Fetch configuration details for specific auth adapter name
fromOAuth2RegexToArray ( array $config ) : array Return the OAuth2 urls as array from the regex string
getAuthenticationMap ( string $module, integer | false $version = false ) : string | false Get the authentication map specified by $module and $version
remove ( ) : true Remove authentication
removeAuthenticationAdapter ( string $name ) : boolean Remove the authentication adapter specified
removeAuthenticationMap ( string $module, integer $version = null ) : boolean Remove the authentication Map for a specific $module and $version
removeOldAuthentication ( ) : true Remove authentication
saveAuthenticationMap ( string $auth, string $module, integer $version = null ) : boolean Save the authentication Map for a specific $module and $version
transformAuthPerApis ( ) : boolean | string This function transform the old authentication system to the new one based on APIs defined. It reads the old configuration and generates an authentication mapping for each API and version.
update ( array $authenticationConfig ) : AuthenticationEntity Update authentication configuration
updateAuthenticationAdapter ( string $name, array $adapter ) : array Update authentication adapter data

Защищенные методы

Метод Описание
checkAuthenticationAdapterData ( array $adapter ) : array Check and return the input data for version 2
createAuthenticationEntityFromConfig ( array $config ) : AuthenticationEntity Create an AuthenticationEntity based on the configuration given
createMongoDSN ( $dsn ) : MongoClient
createPdoDSN ( $dsn, $username, $password ) : PDO
fetchHttpAuthConfiguration ( array $config ) : array | false Fetch HTTP Authentication configuration
fetchOAuth2Configuration ( array $config ) : array | false Fetch all OAuth2 configuration from global and local files
loadAuthenticationAdapterFromConfig ( string $name, array $config ) : array Load authentication data from configuration version 2 Since Apigility 1.1
patchHttpAuthConfig ( AuthenticationEntity $entity, array $global, array $local ) Patch the HTTP Authentication configuration
patchOAuth2Config ( AuthenticationEntity $entity, array $global, array $local ) : void Patch the OAuth2 configuration
removeOAuth2Route ( string $url ) : boolean Remove a url from OAuth2 route
removeSensitiveConfig ( array $config ) : array Remove sensitive information from the configuration
saveAuthenticationAdapter ( array $adapter ) : true Add a new authentication adapter in local config
updateOAuth2Route ( string $url ) : void Update the OAuth2 route
validateDsn ( string $dsn, string $username = null, string $password = null, string $dsnType = AuthenticationEntity::DSN_PDO ) : boolean Validate a DSN

Описание методов

__construct() публичный Метод

public __construct ( ZF\Configuration\ConfigResource $globalConfig, ZF\Configuration\ConfigResource $localConfig, ModuleModel $modules )
$globalConfig ZF\Configuration\ConfigResource
$localConfig ZF\Configuration\ConfigResource
$modules ModuleModel

arrayDiffRecursive() публичный статический Метод

Necessary starting in PHP 5.4; see https://bugs.php.net/bug.php?id=60278
public static arrayDiffRecursive ( mixed $a, mixed $b ) : integer
$a mixed
$b mixed
Результат integer

checkAuthenticationAdapterData() защищенный Метод

Check and return the input data for version 2
protected checkAuthenticationAdapterData ( array $adapter ) : array
$adapter array
Результат array

create() публичный Метод

Create authentication configuration
public create ( array $authenticationConfig ) : AuthenticationEntity
$authenticationConfig array
Результат AuthenticationEntity

createAuthenticationAdapter() публичный Метод

Since Apigility 1.1
public createAuthenticationAdapter ( array $adapter ) : array
$adapter array
Результат array

createAuthenticationEntityFromConfig() защищенный Метод

Create an AuthenticationEntity based on the configuration given
protected createAuthenticationEntityFromConfig ( array $config ) : AuthenticationEntity
$config array
Результат AuthenticationEntity

createMongoDSN() защищенный Метод

protected createMongoDSN ( $dsn ) : MongoClient
$dsn
Результат MongoClient

createPdoDSN() защищенный Метод

protected createPdoDSN ( $dsn, $username, $password ) : PDO
$dsn
$username
$password
Результат PDO

fetch() публичный Метод

Fetch configuration details for authentication
public fetch ( ) : AuthenticationEntity | false
Результат AuthenticationEntity | false

fetchAllAuthenticationAdapter() публичный Метод

Used since Apigility 1.1
public fetchAllAuthenticationAdapter ( ) : array
Результат array

fetchAuthenticationAdapter() публичный Метод

Used since Apigility 1.1
public fetchAuthenticationAdapter ( string $name ) : array | false
$name string
Результат array | false

fetchHttpAuthConfiguration() защищенный Метод

Fetch HTTP Authentication configuration
protected fetchHttpAuthConfiguration ( array $config ) : array | false
$config array
Результат array | false

fetchOAuth2Configuration() защищенный Метод

Fetch all OAuth2 configuration from global and local files
protected fetchOAuth2Configuration ( array $config ) : array | false
$config array
Результат array | false

fromOAuth2RegexToArray() публичный Метод

Since Apigility 1.1
public fromOAuth2RegexToArray ( array $config ) : array
$config array
Результат array

getAuthenticationMap() публичный Метод

Used since Apigility 1.1
public getAuthenticationMap ( string $module, integer | false $version = false ) : string | false
$module string
$version integer | false
Результат string | false

loadAuthenticationAdapterFromConfig() защищенный Метод

Load authentication data from configuration version 2 Since Apigility 1.1
protected loadAuthenticationAdapterFromConfig ( string $name, array $config ) : array
$name string
$config array
Результат array

patchHttpAuthConfig() защищенный Метод

Patch the HTTP Authentication configuration
protected patchHttpAuthConfig ( AuthenticationEntity $entity, array $global, array $local )
$entity AuthenticationEntity
$global array
$local array

patchOAuth2Config() защищенный Метод

Patch the OAuth2 configuration
protected patchOAuth2Config ( AuthenticationEntity $entity, array $global, array $local ) : void
$entity AuthenticationEntity
$global array
$local array
Результат void

remove() публичный Метод

Remove authentication
public remove ( ) : true
Результат true

removeAuthenticationAdapter() публичный Метод

Since Apigility 1.1
public removeAuthenticationAdapter ( string $name ) : boolean
$name string
Результат boolean

removeAuthenticationMap() публичный Метод

Used since Apigility 1.1
public removeAuthenticationMap ( string $module, integer $version = null ) : boolean
$module string
$version integer
Результат boolean

removeOAuth2Route() защищенный Метод

Since Apigility 1.1
protected removeOAuth2Route ( string $url ) : boolean
$url string
Результат boolean

removeOldAuthentication() публичный Метод

Remove authentication
public removeOldAuthentication ( ) : true
Результат true

removeSensitiveConfig() защищенный Метод

Currently only "htpasswd" and "htdigest" entries are stripped.
protected removeSensitiveConfig ( array $config ) : array
$config array
Результат array

saveAuthenticationAdapter() защищенный Метод

Add a new authentication adapter in local config
protected saveAuthenticationAdapter ( array $adapter ) : true
$adapter array
Результат true

saveAuthenticationMap() публичный Метод

Used since Apigility 1.1
public saveAuthenticationMap ( string $auth, string $module, integer $version = null ) : boolean
$auth string
$module string
$version integer
Результат boolean

transformAuthPerApis() публичный Метод

This function transform the old authentication system to the new one based on APIs defined. It reads the old configuration and generates an authentication mapping for each API and version.
public transformAuthPerApis ( ) : boolean | string
Результат boolean | string Boolean false if nothing was performed; string adapter name otherwise.

update() публичный Метод

Update authentication configuration
public update ( array $authenticationConfig ) : AuthenticationEntity
$authenticationConfig array
Результат AuthenticationEntity

updateAuthenticationAdapter() публичный Метод

Since Apigility 1.1
public updateAuthenticationAdapter ( string $name, array $adapter ) : array
$name string
$adapter array
Результат array

updateOAuth2Route() защищенный Метод

Since Apigility 1.1
protected updateOAuth2Route ( string $url ) : void
$url string
Результат void

validateDsn() защищенный Метод

Validate a DSN
protected validateDsn ( string $dsn, string $username = null, string $password = null, string $dsnType = AuthenticationEntity::DSN_PDO ) : boolean
$dsn string
$username string
$password string
$dsnType string
Результат boolean

Описание свойств

$globalConfig защищенное свойство

protected ConfigResource,ZF\Configuration $globalConfig
Результат ZF\Configuration\ConfigResource

$localConfig защищенное свойство

protected ConfigResource,ZF\Configuration $localConfig
Результат ZF\Configuration\ConfigResource

$modules защищенное свойство

protected ModuleModel,ZF\Apigility\Admin\Model $modules
Результат ModuleModel