Class yii\authclient\clients\GitHub

All Classes | Properties | Methods | Constants

Inheritance	yii\authclient\clients\GitHub » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component
Implements	yii\authclient\ClientInterface
Available since version	2.0

GitHub allows authentication via GitHub OAuth.

In order to use GitHub OAuth you must register your application at https://github.com/settings/applications/new.

Example application configuration:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'github' => [
                'class' => 'yii\authclient\clients\GitHub',
                'clientId' => 'github_client_id',
                'clientSecret' => 'github_client_secret',
            ],
        ],
    ]
    ...
]

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$apiBaseUrl	string	API base URL.	yii\authclient\clients\GitHub
$authUrl	string	Authorize URL.	yii\authclient\clients\GitHub
$autoRefreshAccessToken	boolean	Whether to automatically perform 'refresh access token' request on expired access token.	yii\authclient\BaseOAuth
$clientId	string	OAuth client ID.	yii\authclient\OAuth2
$clientSecret	string	OAuth client secret.	yii\authclient\OAuth2
$scope	string	Auth request scope.	yii\authclient\BaseOAuth
$tokenUrl	string	Token request URL endpoint.	yii\authclient\clients\GitHub
$version	string	Protocol version.	yii\authclient\BaseOAuth

Public Methods

Hide inherited methods

Method	Description	Defined By
api()	Performs request to the OAuth API.	yii\authclient\BaseOAuth
buildAuthUrl()	Composes user authorization URL.	yii\authclient\OAuth2
fetchAccessToken()	Fetches access token from authorization code.	yii\authclient\OAuth2
getAccessToken()		yii\authclient\BaseOAuth
getCurlOptions()		yii\authclient\BaseOAuth
getId()		yii\authclient\ClientInterface
getName()		yii\authclient\ClientInterface
getNormalizeUserAttributeMap()		yii\authclient\BaseClient
getReturnUrl()		yii\authclient\BaseOAuth
getSignatureMethod()		yii\authclient\BaseOAuth
getTitle()		yii\authclient\ClientInterface
getUserAttributes()		yii\authclient\ClientInterface
getViewOptions()		yii\authclient\ClientInterface
init()		yii\authclient\clients\GitHub
refreshAccessToken()	Gets new auth token to replace expired one.	yii\authclient\BaseOAuth
setAccessToken()		yii\authclient\BaseOAuth
setCurlOptions()		yii\authclient\BaseOAuth
setId()		yii\authclient\ClientInterface
setName()		yii\authclient\ClientInterface
setNormalizeUserAttributeMap()		yii\authclient\BaseClient
setReturnUrl()		yii\authclient\BaseOAuth
setSignatureMethod()		yii\authclient\BaseOAuth
setTitle()		yii\authclient\ClientInterface
setUserAttributes()		yii\authclient\BaseClient
setViewOptions()		yii\authclient\BaseClient

Protected Methods

Hide inherited methods

Method	Description	Defined By
apiInternal()	Performs request to the OAuth API.	yii\authclient\BaseOAuth
composeRequestCurlOptions()	Composes HTTP request CUrl options, which will be merged with the default ones.	yii\authclient\BaseOAuth
composeUrl()	Composes URL from base URL and GET params.	yii\authclient\BaseOAuth
convertXmlToArray()	Converts XML document to array.	yii\authclient\BaseOAuth
createSignatureMethod()	Creates signature method instance from its configuration.	yii\authclient\BaseOAuth
createToken()	Creates token from its configuration.	yii\authclient\BaseOAuth
defaultCurlOptions()	Returns default cURL options.	yii\authclient\BaseOAuth
defaultName()	Generates service name.	yii\authclient\clients\GitHub
defaultNormalizeUserAttributeMap()	Returns the default \yii\authclient\normalizeUserAttributeMap value.	yii\authclient\BaseClient
defaultReturnUrl()	Composes default \yii\authclient\returnUrl value.	yii\authclient\BaseOAuth
defaultTitle()	Generates service title.	yii\authclient\clients\GitHub
defaultViewOptions()	Returns the default \yii\authclient\viewOptions value.	yii\authclient\BaseClient
determineContentTypeByHeaders()	Attempts to determine HTTP request content type by headers.	yii\authclient\BaseOAuth
determineContentTypeByRaw()	Attempts to determine the content type from raw content.	yii\authclient\BaseOAuth
getState()	Returns persistent state value.	yii\authclient\BaseOAuth
getStateKeyPrefix()	Returns session key prefix, which is used to store internal states.	yii\authclient\BaseOAuth
initUserAttributes()	Initializes authenticated user attributes.	yii\authclient\clients\GitHub
mergeCurlOptions()	Merge CUrl options.	yii\authclient\BaseOAuth
normalizeUserAttributes()	Normalize given user attributes according to \yii\authclient\normalizeUserAttributeMap.	yii\authclient\BaseClient
processResponse()	Processes raw response converting it to actual data.	yii\authclient\BaseOAuth
removeState()	Removes persistent state value.	yii\authclient\BaseOAuth
restoreAccessToken()	Restores access token.	yii\authclient\BaseOAuth
saveAccessToken()	Saves token as persistent state.	yii\authclient\BaseOAuth
sendRequest()	Sends HTTP request.	yii\authclient\BaseOAuth
setState()	Sets persistent state.	yii\authclient\BaseOAuth

Constants

Hide inherited constants

Constant	Value	Defined By
CONTENT_TYPE_AUTO	'auto'	yii\authclient\BaseOAuth
CONTENT_TYPE_JSON	'json'	yii\authclient\BaseOAuth
CONTENT_TYPE_URLENCODED	'urlencoded'	yii\authclient\BaseOAuth
CONTENT_TYPE_XML	'xml'	yii\authclient\BaseOAuth

Property Details

$apiBaseUrl public property

API base URL.

public string $apiBaseUrl = 'https://api.github.com'

$authUrl public property

Authorize URL.

public string $authUrl = 'https://github.com/login/oauth/authorize'

$tokenUrl public property

Token request URL endpoint.

public string $tokenUrl = 'https://github.com/login/oauth/access_token'

Method Details

defaultName() protected method

Generates service name.

protected string defaultName ( )
return	string	Service name.

defaultTitle() protected method

Generates service title.

protected string defaultTitle ( )
return	string	Service title.

init() public method

public void init ( )

initUserAttributes() protected method

Initializes authenticated user attributes.

protected array initUserAttributes ( )
return	array	Auth user attributes.