Метод | Описание | |
---|---|---|
createRequest ( ) : |
Creates HTTP request instance. | |
getHttpClient ( ) : |
Returns HTTP client. | |
getId ( ) : string | ||
getName ( ) : string | ||
getNormalizeUserAttributeMap ( ) : array | ||
getRequestOptions ( ) : array | ||
getStateStorage ( ) : yii\authclient\StateStorageInterface | ||
getTitle ( ) : string | ||
getUserAttributes ( ) : array | ||
getViewOptions ( ) : array | ||
setHttpClient ( array | |
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 ) : |
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. |
protected createHttpClient ( string | array $reference ) : |
||
$reference | string | array | component name or array configuration. |
Результат | HTTP client instance. |
public createRequest ( ) : |
||
Результат | HTTP request instance. |
protected defaultName ( ) : string | ||
Результат | string | service name. |
protected defaultNormalizeUserAttributeMap ( ) : array | ||
Результат | array | normalize attribute map. |
protected defaultRequestOptions ( ) : array | ||
Результат | array | HTTP request options. |
protected defaultTitle ( ) : string | ||
Результат | string | service title. |
protected defaultViewOptions ( ) : array | ||
Результат | array | list of default [[viewOptions]] |
public getHttpClient ( ) : |
||
Результат | internal HTTP client. |
public getNormalizeUserAttributeMap ( ) : array | ||
Результат | array | normalize user attribute map. |
public getRequestOptions ( ) : array | ||
Результат | array | HTTP request options. |
protected getStateKeyPrefix ( ) : string | ||
Результат | string | session key prefix. |
public getStateStorage ( ) : yii\authclient\StateStorageInterface | ||
Результат | yii\authclient\StateStorageInterface | stage storage. |
public getUserAttributes ( ) : array | ||
Результат | array | list of user attributes |
public getViewOptions ( ) : array | ||
Результат | array | view options in format: optionName => optionValue |
abstract protected initUserAttributes ( ) : array | ||
Результат | array | auth user attributes. |
protected normalizeUserAttributes ( array $attributes ) : array | ||
$attributes | array | raw attributes. |
Результат | array | normalized attributes. |
protected removeState ( string $key ) : boolean | ||
$key | string | state key. |
Результат | boolean | success. |
public setHttpClient ( array | |
||
$httpClient | array | |
internal HTTP client. |
public setNormalizeUserAttributeMap ( array $normalizeUserAttributeMap ) | ||
$normalizeUserAttributeMap | array | normalize user attribute map. |
public setRequestOptions ( array $options ) | ||
$options | array | HTTP request options. |
public setStateStorage ( yii\authclient\StateStorageInterface | array | string $stateStorage ) | ||
$stateStorage | yii\authclient\StateStorageInterface | array | string | stage storage to be used. |
public setUserAttributes ( array $userAttributes ) | ||
$userAttributes | array | list of user attributes |
public setViewOptions ( array $viewOptions ) | ||
$viewOptions | array | view options in format: optionName => optionValue |