Class yii\authclient\OAuthToken

All Classes | Properties | Methods

Inheritance	yii\authclient\OAuthToken » yii\base\Object
Available since extension's version	2.0
Source Code	https://github.com/yiisoft/yii2-authclient/blob/master/OAuthToken.php

Token represents OAuth token.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$createTimestamp	integer	Object creation timestamp.	yii\authclient\OAuthToken
$expireDuration	integer	Token expiration duration.	yii\authclient\OAuthToken
$expireDurationParamKey	string	Expire duration param key.	yii\authclient\OAuthToken
$isExpired	boolean	Is token expired.	yii\authclient\OAuthToken
$isValid	boolean	Is token valid.	yii\authclient\OAuthToken
$params	array	This property is read-only.	yii\authclient\OAuthToken
$token	string	Token value.	yii\authclient\OAuthToken
$tokenParamKey	string	Key in $params array, which stores token key.	yii\authclient\OAuthToken
$tokenSecret	string	Token secret value.	yii\authclient\OAuthToken
$tokenSecretParamKey	string	Key in $params array, which stores token secret key.	yii\authclient\OAuthToken

Public Methods

Hide inherited methods

Method	Description	Defined By
getExpireDuration()	Returns the token expiration duration.	yii\authclient\OAuthToken
getExpireDurationParamKey()		yii\authclient\OAuthToken
getIsExpired()	Checks if token has expired.	yii\authclient\OAuthToken
getIsValid()	Checks if token is valid.	yii\authclient\OAuthToken
getParam()	Returns param by name.	yii\authclient\OAuthToken
getParams()		yii\authclient\OAuthToken
getToken()	Returns token value.	yii\authclient\OAuthToken
getTokenSecret()	Returns the token secret value.	yii\authclient\OAuthToken
init()		yii\authclient\OAuthToken
setExpireDuration()	Sets token expire duration.	yii\authclient\OAuthToken
setExpireDurationParamKey()		yii\authclient\OAuthToken
setParam()	Sets param by name.	yii\authclient\OAuthToken
setParams()		yii\authclient\OAuthToken
setToken()	Sets token value.	yii\authclient\OAuthToken
setTokenSecret()	Sets the token secret value.	yii\authclient\OAuthToken

Protected Methods

Hide inherited methods

Method	Description	Defined By
defaultExpireDurationParamKey()	Fetches default expire duration param key.	yii\authclient\OAuthToken

Property Details

Hide inherited properties

$createTimestamp public property

Object creation timestamp.

public integer $createTimestamp = null

$expireDuration public property

Token expiration duration. Note that the type of this property differs in getter and setter. See getExpireDuration() and setExpireDuration() for details.

public integer $expireDuration = null

$expireDurationParamKey public property

Expire duration param key.

public string $expireDurationParamKey = null

$isExpired public property

Is token expired. This property is read-only.

public boolean $isExpired = null

$isValid public property

Is token valid. This property is read-only.

public boolean $isValid = null

$params public property

This property is read-only.

public array $params = null

$token public property

Token value.

public string $token = null

$tokenParamKey public property

Key in $params array, which stores token key.

public string $tokenParamKey = 'oauth_token'

$tokenSecret public property

Token secret value.

public string $tokenSecret = null

$tokenSecretParamKey public property

Key in $params array, which stores token secret key.

public string $tokenSecretParamKey = 'oauth_token_secret'

Method Details

Hide inherited methods

defaultExpireDurationParamKey() protected method

Fetches default expire duration param key.

protected defaultExpireDurationParamKey( ): string
return	string	Expire duration param key.

Source code

                protected function defaultExpireDurationParamKey()
{
    $expireDurationParamKey = 'expires_in';
    foreach ($this->getParams() as $name => $value) {
        if (strpos($name, 'expir') !== false) {
            $expireDurationParamKey = $name;
            break;
        }
    }
    return $expireDurationParamKey;
}

getExpireDuration() public method

Returns the token expiration duration.

public getExpireDuration( ): integer
return	integer	Token expiration duration.

Source code

                public function getExpireDuration()
{
    return $this->getParam($this->getExpireDurationParamKey());
}

getExpireDurationParamKey() public method

public getExpireDurationParamKey( ): string
return	string	Expire duration param key.

Source code

                public function getExpireDurationParamKey()
{
    if ($this->_expireDurationParamKey === null) {
        $this->_expireDurationParamKey = $this->defaultExpireDurationParamKey();
    }
    return $this->_expireDurationParamKey;
}

getIsExpired() public method

Checks if token has expired.

public getIsExpired( ): boolean
return	boolean	Is token expired.

Source code

                public function getIsExpired()
{
    $expirationDuration = $this->getExpireDuration();
    if (empty($expirationDuration)) {
        return false;
    }
    return (time() >= ($this->createTimestamp + $expirationDuration));
}

getIsValid() public method

Checks if token is valid.

public getIsValid( ): boolean
return	boolean	Is token valid.

Source code

                public function getIsValid()
{
    $token = $this->getToken();
    return (!empty($token) && !$this->getIsExpired());
}

getParam() public method

Returns param by name.

public getParam( string $name ): mixed
$name	string	Param name.
return	mixed	Param value.

Source code

                public function getParam($name)
{
    return isset($this->_params[$name]) ? $this->_params[$name] : null;
}

getParams() public method

public getParams( ): array

Source code

                public function getParams()
{
    return $this->_params;
}

getToken() public method

Returns token value.

public getToken( ): string
return	string	Token value.

Source code

                public function getToken()
{
    return $this->getParam($this->tokenParamKey);
}

getTokenSecret() public method

Returns the token secret value.

public getTokenSecret( ): string
return	string	Token secret value.

Source code

                public function getTokenSecret()
{
    return $this->getParam($this->tokenSecretParamKey);
}

init() public method

public init( ):

Source code

                public function init()
{
    if ($this->createTimestamp === null) {
        $this->createTimestamp = time();
    }
}

setExpireDuration() public method

Sets token expire duration.

public setExpireDuration( string $expireDuration ): mixed
$expireDuration	string	Token expiration duration.

Source code

                public function setExpireDuration($expireDuration)
{
    $this->setParam($this->getExpireDurationParamKey(), $expireDuration);
}

setExpireDurationParamKey() public method

public setExpireDurationParamKey( string $expireDurationParamKey ): mixed
$expireDurationParamKey	string	Expire duration param key.

Source code

                public function setExpireDurationParamKey($expireDurationParamKey)
{
    $this->_expireDurationParamKey = $expireDurationParamKey;
}

setParam() public method

Sets param by name.

public setParam( string $name, mixed $value ): mixed
$name	string	Param name.
$value	mixed	Param value,

Source code

                public function setParam($name, $value)
{
    $this->_params[$name] = $value;
}

setParams() public method

public setParams( array $params ): mixed
$params	array

Source code

                public function setParams(array $params)
{
    $this->_params = $params;
}

setToken() public method

Sets token value.

public setToken( string $token ): $this
$token	string	Token value.
return	$this	The object itself

Source code

                public function setToken($token)
{
    $this->setParam($this->tokenParamKey, $token);
}

setTokenSecret() public method

Sets the token secret value.

public setTokenSecret( string $tokenSecret ): mixed
$tokenSecret	string	Token secret.

Source code

                public function setTokenSecret($tokenSecret)
{
    $this->setParam($this->tokenSecretParamKey, $tokenSecret);
}