Interface yii\authclient\ClientInterface

All Classes | Methods
Implemented byyii\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\TwitterOAuth2, yii\authclient\clients\VKontakte, yii\authclient\clients\Yandex
Available since version2.0
Source Code https://github.com/yiisoft/yii2-authclient/blob/master/ClientInterface.php

ClientInterface declares basic interface all Auth clients should follow.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
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

Method Details

getId() public abstract method

public abstract string getId ( )
return string

Service id
getName() public abstract method

public abstract string getName ( )
return string

Service name.
getTitle() public abstract method

public abstract string getTitle ( )
return string

Service title.
getUserAttributes() public abstract method

public abstract array getUserAttributes ( )
return array

List of user attributes
getViewOptions() public abstract method

public abstract array getViewOptions ( )
return array

View options in format: optionName => optionValue
setId() public abstract method

public abstract void setId ( $id )
$id string

Service id.
setName() public abstract method

public abstract void setName ( $name )
$name string

Service name.
setTitle() public abstract method

public abstract void setTitle ( $title )
$title string

Service title.