Class yii\authclient\clients\LinkedIn

All Classes | Properties | Methods | Constants

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

LinkedIn allows authentication via LinkedIn OAuth.

In order to use linkedIn OAuth you must register your application at https://www.linkedin.com/secure/developer.

Example application configuration:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'linkedin' => [
                'class' => 'yii\authclient\clients\LinkedIn',
                'clientId' => 'linkedin_client_id',
                'clientSecret' => 'linkedin_client_secret',
            ],
        ],
    ]
    ...
]

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$apiBaseUrl	string	API base URL.	yii\authclient\clients\LinkedIn
$attributeNames	array	List of attribute names, which should be requested from API to initialize user attributes.	yii\authclient\clients\LinkedIn
$authUrl	string	Authorize URL.	yii\authclient\clients\LinkedIn
$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\LinkedIn
$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\clients\LinkedIn
fetchAccessToken()	Fetches access token from authorization code.	yii\authclient\clients\LinkedIn
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\LinkedIn
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\clients\LinkedIn
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\LinkedIn
defaultNormalizeUserAttributeMap()	Returns the default \yii\authclient\clients\normalizeUserAttributeMap value.	yii\authclient\clients\LinkedIn
defaultReturnUrl()	Composes default \yii\authclient\clients\returnUrl value.	yii\authclient\clients\LinkedIn
defaultTitle()	Generates service title.	yii\authclient\clients\LinkedIn
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
generateAuthState()	Generates the auth state value.	yii\authclient\clients\LinkedIn
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\LinkedIn
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.linkedin.com/v1'

$attributeNames public property (available since version 2.0.4)

List of attribute names, which should be requested from API to initialize user attributes.

public array $attributeNames = ['id', 'email-address', 'first-name', 'last-name', 'public-profile-url']

$authUrl public property

Authorize URL.

public string $authUrl = 'https://www.linkedin.com/uas/oauth2/authorization'

$tokenUrl public property

Token request URL endpoint.

public string $tokenUrl = 'https://www.linkedin.com/uas/oauth2/accessToken'

Method Details

apiInternal() protected method

Performs request to the OAuth API.

protected array apiInternal ( $accessToken, $url, $method, array $params, array $headers )
$accessToken	yii\authclient\OAuthToken	Actual access token.
$url	string	Absolute API URL.
$method	string	Request method.
$params	array	Request parameters.
$headers	array	Additional request headers.
return	array	API response.
throws	\yii\base\Exception	on failure.

buildAuthUrl() public method

Composes user authorization URL.

public string buildAuthUrl ( array $params = [] )
$params	array	Additional auth GET params.
return	string	Authorization URL.

defaultName() protected method

Generates service name.

protected string defaultName ( )
return	string	Service name.

defaultNormalizeUserAttributeMap() protected method

Returns the default \yii\authclient\clients\normalizeUserAttributeMap value.

Particular client may override this method in order to provide specific default map.

protected array defaultNormalizeUserAttributeMap ( )
return	array	Normalize attribute map.

defaultReturnUrl() protected method

Composes default \yii\authclient\clients\returnUrl value.

protected string defaultReturnUrl ( )
return	string	Return URL.

defaultTitle() protected method

Generates service title.

protected string defaultTitle ( )
return	string	Service title.

fetchAccessToken() public method

Fetches access token from authorization code.

public yii\authclient\OAuthToken fetchAccessToken ( $authCode, array $params = [] )
$authCode	string	Authorization code, usually comes at $_GET['code'].
$params	array	Additional request params.
return	yii\authclient\OAuthToken	Access token.

generateAuthState() protected method

Generates the auth state value.

protected string generateAuthState ( )
return	string	Auth state value.

init() public method

public void init ( )

initUserAttributes() protected method

Initializes authenticated user attributes.

protected array initUserAttributes ( )
return	array	Auth user attributes.