PHP Класс yii\authclient\BaseClient

См. также: ClientInterface
С версии: 2.0
Автор: Paul Klimov ([email protected])
Наследование: extends yii\base\Component, implements yii\authclient\ClientInterface
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
createRequest ( ) : Request Creates HTTP request instance.
getHttpClient ( ) : Client Returns HTTP client.
getId ( ) : string
getName ( ) : string
getNormalizeUserAttributeMap ( ) : array
getRequestOptions ( ) : array
getStateStorage ( ) : yii\authclient\StateStorageInterface
getTitle ( ) : string
getUserAttributes ( ) : array
getViewOptions ( ) : array
setHttpClient ( array | Client $httpClient ) Sets HTTP client to be used.
setId ( string $id )
setName ( string $name )
setNormalizeUserAttributeMap ( array $normalizeUserAttributeMap )
setRequestOptions ( array $options )
setStateStorage ( yii\authclient\StateStorageInterface | array | string $stateStorage )
setTitle ( string $title )
setUserAttributes ( array $userAttributes )
setViewOptions ( array $viewOptions )

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

Метод Описание
createHttpClient ( string | array $reference ) : Client Creates HTTP client instance from reference or configuration.
defaultName ( ) : string Generates service name.
defaultNormalizeUserAttributeMap ( ) : array Returns the default [[normalizeUserAttributeMap]] value.
defaultRequestOptions ( ) : array Returns default HTTP request options.
defaultTitle ( ) : string Generates service title.
defaultViewOptions ( ) : array Returns the default [[viewOptions]] value.
getState ( string $key ) : mixed Returns persistent state value.
getStateKeyPrefix ( ) : string Returns session key prefix, which is used to store internal states.
initUserAttributes ( ) : array Initializes authenticated user attributes.
normalizeUserAttributes ( array $attributes ) : array Normalize given user attributes according to [[normalizeUserAttributeMap]].
removeState ( string $key ) : boolean Removes persistent state value.
setState ( string $key, mixed $value ) Sets persistent state.

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

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

Creates HTTP client instance from reference or configuration.
С версии: 2.1
protected createHttpClient ( string | array $reference ) : Client
$reference string | array component name or array configuration.
Результат yii\httpclient\Client HTTP client instance.

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

Creates HTTP request instance.
С версии: 2.1
public createRequest ( ) : Request
Результат yii\httpclient\Request HTTP request instance.

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

Generates service name.
protected defaultName ( ) : string
Результат string service name.

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

Particular client may override this method in order to provide specific default map.
protected defaultNormalizeUserAttributeMap ( ) : array
Результат array normalize attribute map.

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

Returns default HTTP request options.
С версии: 2.1
protected defaultRequestOptions ( ) : array
Результат array HTTP request options.

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

Generates service title.
protected defaultTitle ( ) : string
Результат string service title.

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

Particular client may override this method in order to provide specific default view options.
protected defaultViewOptions ( ) : array
Результат array list of default [[viewOptions]]

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

Returns HTTP client.
С версии: 2.1
public getHttpClient ( ) : Client
Результат yii\httpclient\Client internal HTTP client.

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

public getId ( ) : string
Результат string service id

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

public getName ( ) : string
Результат string service name.

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

public getNormalizeUserAttributeMap ( ) : array
Результат array normalize user attribute map.

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

С версии: 2.1
public getRequestOptions ( ) : array
Результат array HTTP request options.

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

Returns persistent state value.
protected getState ( string $key ) : mixed
$key string state key.
Результат mixed state value.

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

Returns session key prefix, which is used to store internal states.
protected getStateKeyPrefix ( ) : string
Результат string session key prefix.

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

public getStateStorage ( ) : yii\authclient\StateStorageInterface
Результат yii\authclient\StateStorageInterface stage storage.

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

public getTitle ( ) : string
Результат string service title.

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

public getUserAttributes ( ) : array
Результат array list of user attributes

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

public getViewOptions ( ) : array
Результат array view options in format: optionName => optionValue

initUserAttributes() абстрактный защищенный Метод

Initializes authenticated user attributes.
abstract protected initUserAttributes ( ) : array
Результат array auth user attributes.

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

Normalize given user attributes according to [[normalizeUserAttributeMap]].
protected normalizeUserAttributes ( array $attributes ) : array
$attributes array raw attributes.
Результат array normalized attributes.

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

Removes persistent state value.
protected removeState ( string $key ) : boolean
$key string state key.
Результат boolean success.

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

Sets HTTP client to be used.
С версии: 2.1
public setHttpClient ( array | Client $httpClient )
$httpClient array | yii\httpclient\Client internal HTTP client.

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

public setId ( string $id )
$id string service id.

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

public setName ( string $name )
$name string service name.

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

public setNormalizeUserAttributeMap ( array $normalizeUserAttributeMap )
$normalizeUserAttributeMap array normalize user attribute map.

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

С версии: 2.1
public setRequestOptions ( array $options )
$options array HTTP request options.

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

Sets persistent state.
protected setState ( string $key, mixed $value )
$key string state key.
$value mixed state value

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

public setStateStorage ( yii\authclient\StateStorageInterface | array | string $stateStorage )
$stateStorage yii\authclient\StateStorageInterface | array | string stage storage to be used.

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

public setTitle ( string $title )
$title string service title.

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

public setUserAttributes ( array $userAttributes )
$userAttributes array list of user attributes

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

public setViewOptions ( array $viewOptions )
$viewOptions array view options in format: optionName => optionValue