PHP Class yii\authclient\OAuthToken

Since: 2.0
Author: Paul Klimov (klimov.paul@gmail.com)
Inheritance: extends yii\base\Object
Datei anzeigen Open project: yiisoft/yii2-authclient Class Usage Examples

Public Properties

Property Type Description
$createTimestamp object creation timestamp.
$tokenParamKey key in [[params]] array, which stores token key.
$tokenSecretParamKey key in [[params]] array, which stores token secret key.

Public Methods

Method Description
getExpireDuration ( ) : integer Returns the token expiration duration.
getExpireDurationParamKey ( ) : string
getIsExpired ( ) : boolean Checks if token has expired.
getIsValid ( ) : boolean Checks if token is valid.
getParam ( string $name ) : mixed Returns param by name.
getParams ( ) : array
getToken ( ) : string Returns token value.
getTokenSecret ( ) : string Returns the token secret value.
init ( )
setExpireDuration ( string $expireDuration ) Sets token expire duration.
setExpireDurationParamKey ( string $expireDurationParamKey )
setParam ( string $name, mixed $value ) Sets param by name.
setParams ( array $params )
setToken ( string $token ) Sets token value.
setTokenSecret ( string $tokenSecret ) Sets the token secret value.

Protected Methods

Method Description
defaultExpireDurationParamKey ( ) : string Fetches default expire duration param key.

Method Details

defaultExpireDurationParamKey() protected method

Fetches default expire duration param key.
protected defaultExpireDurationParamKey ( ) : string
return string expire duration param key.

getExpireDuration() public method

Returns the token expiration duration.
public getExpireDuration ( ) : integer
return integer token expiration duration.

getExpireDurationParamKey() public method

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

getIsExpired() public method

Checks if token has expired.
public getIsExpired ( ) : boolean
return boolean is token expired.

getIsValid() public method

Checks if token is valid.
public getIsValid ( ) : boolean
return boolean is token valid.

getParam() public method

Returns param by name.
public getParam ( string $name ) : mixed
$name string param name.
return mixed param value.

getParams() public method

public getParams ( ) : array
return array

getToken() public method

Returns token value.
public getToken ( ) : string
return string token value.

getTokenSecret() public method

Returns the token secret value.
public getTokenSecret ( ) : string
return string token secret value.

init() public method

public init ( )

setExpireDuration() public method

Sets token expire duration.
public setExpireDuration ( string $expireDuration )
$expireDuration string token expiration duration.

setExpireDurationParamKey() public method

public setExpireDurationParamKey ( string $expireDurationParamKey )
$expireDurationParamKey string expire duration param key.

setParam() public method

Sets param by name.
public setParam ( string $name, mixed $value )
$name string param name.
$value mixed param value,

setParams() public method

public setParams ( array $params )
$params array

setToken() public method

Sets token value.
public setToken ( string $token )
$token string token value.

setTokenSecret() public method

Sets the token secret value.
public setTokenSecret ( string $tokenSecret )
$tokenSecret string token secret.

Property Details

$createTimestamp public_oe property

object creation timestamp.
public $createTimestamp

$tokenParamKey public_oe property

key in [[params]] array, which stores token key.
public $tokenParamKey

$tokenSecretParamKey public_oe property

key in [[params]] array, which stores token secret key.
public $tokenSecretParamKey