Spec-Zone.ru › Yii 2.0

Интерфейс yii\authclient\ClientInterface

Все классы | Методы
Реализовано в yii\authclient\BaseClient, yii\authclient\BaseOAuth, yii\authclient\OAuth1, yii\authclient\OAuth2, yii\authclient\OpenId, yii\authclient\OpenIdConnect, yii\authclient\clients\Facebook, yii\authclient\clients\GitHub, yii\authclient\clients\Google, yii\authclient\clients\GoogleHybrid, yii\authclient\clients\LinkedIn, yii\authclient\clients\Live, yii\authclient\clients\Twitter, yii\authclient\clients\VKontakte, yii\authclient\clients\Yandex
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2-authclient/blob/master/ClientInterface.php

ClientInterface объявляет базовый интерфейс, которому должны следовать все клиенты авторизации.

Общедоступные методы

Метод Описание Определено в
getId() yii\authclient\ClientInterface
getName() yii\authclient\ClientInterface
getTitle() yii\authclient\ClientInterface
getUserAttributes() yii\authclient\ClientInterface
getViewOptions() yii\authclient\ClientInterface
setId() yii\authclient\ClientInterface
setName() yii\authclient\ClientInterface
setTitle() yii\authclient\ClientInterface

Подробное описание методов

getId() public abstract method

public abstract string getId ( )
return string

Идентификатор сервиса

getName() public abstract method

public abstract string getName ( )
return string

Название сервиса.

getTitle() public abstract method

public abstract string getTitle ( )
return string

Заголовок сервиса.

getUserAttributes() public abstract method

public abstract array getUserAttributes ( )
return array

Список атрибутов пользователя

getViewOptions() public abstract method

public abstract array getViewOptions ( )
return array

Параметры представления в формате: имяПараметра => значениеПараметра

setId() public abstract method

public abstract void setId ( $id )
$id string

Идентификатор сервиса.

setName() public abstract method

public abstract void setName ( $name )
$name string

Название сервиса.

setTitle() public abstract method

public abstract void setTitle ( $title )
$title string

Заголовок сервиса.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-clientinterface.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API