Interface yii\authclient\ClientInterface

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\Oauth2Client, yii\authclient\clients\Twitter, yii\authclient\clients\TwitterOAuth2, yii\authclient\clients\VKontakte, yii\authclient\clients\Yandex
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-authclient/blob/master/src/ClientInterface.php

ClientInterface declares basic interface all Auth clients should follow.

Method Details

Hide inherited methods

getId() public abstract method

public abstract string getId ( )
return string

Service id

 public function getId();  
getName() public abstract method

public abstract string getName ( )
return string

Service name.

 public function getName();  
getTitle() public abstract method

public abstract string getTitle ( )
return string

Service title.

 public function getTitle();  
getUserAttributes() public abstract method

public abstract array getUserAttributes ( )
return array

List of user attributes

 public function getUserAttributes();  
getViewOptions() public abstract method

public abstract array getViewOptions ( )
return array

View options in format: optionName => optionValue

 public function getViewOptions();  
setId() public abstract method

public abstract mixed setId ( string $id )
$id string

Service id.

 public function setId($id);  
setName() public abstract method

public abstract mixed setName ( string $name )
$name string

Service name.

 public function setName($name);  
setTitle() public abstract method

public abstract mixed setTitle ( string $title )
$title string

Service title.

 public function setTitle($title);