Абстрактный класс yii\authclient\BaseClient

public yii\httpclient\Client getHttpClient ( )
public void setHttpClient ( $httpClient )

public string getId ( )
public void setId ( $id )

public string getName ( )
public void setName ( $name )

public array getNormalizeUserAttributeMap ( )
public void setNormalizeUserAttributeMap ( $normalizeUserAttributeMap )

public array getRequestOptions ( )
public void setRequestOptions ( array $options )

public yii\authclient\StateStorageInterface getStateStorage ( )
public void setStateStorage ( $stateStorage )

public string getTitle ( )
public void setTitle ( $title )

public array getUserAttributes ( )
public void setUserAttributes ( $userAttributes )

public array getViewOptions ( )
public void setViewOptions ( $viewOptions )

createHttpClient() защищённый метод (доступен с версии 2.1)

Создаёт экземпляр HTTP клиента из ссылки или конфигурации.

защищённый yii\httpclient\Client createHttpClient ( $reference )
$reference	строка|массив	Имя компонента или конфигурация в виде массива.
return	yii\httpclient\Client	Экземпляр HTTP клиента.

createRequest() публичный метод (доступен с версии 2.1)

Создаёт экземпляр HTTP запроса.

публичный yii\httpclient\Request createRequest ( )
return	yii\httpclient\Request	Экземпляр HTTP запроса.

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

Генерирует имя сервиса.

защищённый строка defaultName ( )
return	строка	Имя сервиса.

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

Возвращает значение по умолчанию для $normalizeUserAttributeMap.

Конкретный клиент может переопределить этот метод для предоставления специфической карты по умолчанию.

защищённый массив defaultNormalizeUserAttributeMap ( )
return	массив	Карта нормализации атрибутов.

defaultRequestOptions() защищённый метод (доступен с версии 2.1)

Возвращает параметры HTTP запроса по умолчанию.

защищённый массив defaultRequestOptions ( )
return	массив	Параметры HTTP запроса.

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

Генерирует заголовок сервиса.

защищённый строка defaultTitle ( )
return	строка	Заголовок сервиса.

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

Возвращает значение по умолчанию для $viewOptions.

Конкретный клиент может переопределить этот метод для предоставления специфических параметров представления по умолчанию.

защищённый массив defaultViewOptions ( )
return	массив	Список параметров представления по умолчанию $viewOptions

getHttpClient() публичный метод (доступен с версии 2.1)

Возвращает HTTP клиент.

публичный yii\httpclient\Client getHttpClient ( )
return	yii\httpclient\Client	Внутренний HTTP клиент.

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

публичный строка getId ( )
return	строка	Идентификатор сервиса

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

публичный строка getName ( )
return	строка	Имя сервиса.

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

публичный массив getNormalizeUserAttributeMap ( )
return	массив	Карта нормализации атрибутов пользователя.

getRequestOptions() публичный метод (доступен с версии 2.1)

публичный массив getRequestOptions ( )
return	массив	Параметры HTTP запроса.

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

Возвращает значение состояния сохраняемого в памяти.

защищённый смешанный getState ( $key )
$key	строка	Ключ состояния.
return	смешанный	Значение состояния.

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

Возвращает префикс ключа сессии, используемый для хранения внутренних состояний.

защищённый строка getStateKeyPrefix ( )
return	строка	Префикс ключа сессии.

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

публичный yii\authclient\StateStorageInterface getStateStorage ( )
return	yii\authclient\StateStorageInterface	Хранилище состояния.

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

публичный строка getTitle ( )
return	строка	Заголовок сервиса.

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

публичный массив getUserAttributes ( )
return	массив	Список атрибутов пользователя

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

публичный массив getViewOptions ( )
return	массив	Параметры представления в формате: имяПараметра => значениеПараметра

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

Инициализирует атрибуты аутентифицированного пользователя.

защищённый абстрактный массив initUserAttributes ( )
return	массив	Атрибуты пользователя.

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

Нормализует заданные атрибуты пользователя согласно $normalizeUserAttributeMap.

защищённый массив normalizeUserAttributes ( $attributes )
$attributes	массив	Исходные атрибуты.
return	массив	Нормализованные атрибуты.
throws	yii\base\InvalidConfigException	при неверной карте нормализации атрибутов.

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

Удаляет значение состояния сохраняемого в памяти.

protected boolean removeState ( $key )
$key	string	Ключ состояния.
return	boolean	Успех.

setHttpClient() общедоступный метод (доступен с версии 2.1)

Устанавливает HTTP-клиент для использования.

public void setHttpClient ( $httpClient )
$httpClient	array|yii\httpclient\Client	Внутренний HTTP-клиент.

setId() общедоступный метод

public void setId ( $id )
$id	string	Идентификатор сервиса.

setName() общедоступный метод

public void setName ( $name )
$name	string	Название сервиса.

setNormalizeUserAttributeMap() общедоступный метод

public void setNormalizeUserAttributeMap ( $normalizeUserAttributeMap )
$normalizeUserAttributeMap	array	Карта атрибутов пользователя для нормализации.

setRequestOptions() общедоступный метод (доступен с версии 2.1)

public void setRequestOptions ( array $options )
$options	array	Параметры HTTP-запроса.

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

Устанавливает состояние для сохранения.

protected $this setState ( $key, $value )
$key	string	Ключ состояния.
$value	mixed	Значение состояния.
return	$this	Сам объект.

setStateStorage() общедоступный метод

public void setStateStorage ( $stateStorage )
$stateStorage	yii\authclient\StateStorageInterface|array|string	Хранилище состояния для использования.

setTitle() общедоступный метод

public void setTitle ( $title )
$title	string	Заголовок сервиса.

setUserAttributes() общедоступный метод

public void setUserAttributes ( $userAttributes )
$userAttributes	array	Список атрибутов пользователя.

setViewOptions() общедоступный метод

public void setViewOptions ( $viewOptions )
$viewOptions	array	Параметры представления в формате: имяПараметра => значениеПараметра