PHP Класс yii\authclient\OAuthToken

С версии: 2.0
Автор: Paul Klimov ([email protected])
Наследование: extends yii\base\Object
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$createTimestamp object creation timestamp.
$tokenParamKey key in [[params]] array, which stores token key.
$tokenSecretParamKey key in [[params]] array, which stores token secret key.

Открытые методы

Метод Описание
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.

Защищенные методы

Метод Описание
defaultExpireDurationParamKey ( ) : string Fetches default expire duration param key.

Описание методов

defaultExpireDurationParamKey() защищенный метод

Fetches default expire duration param key.
protected defaultExpireDurationParamKey ( ) : string
Результат string expire duration param key.

getExpireDuration() публичный метод

Returns the token expiration duration.
public getExpireDuration ( ) : integer
Результат integer token expiration duration.

getExpireDurationParamKey() публичный метод

public getExpireDurationParamKey ( ) : string
Результат string expire duration param key.

getIsExpired() публичный метод

Checks if token has expired.
public getIsExpired ( ) : boolean
Результат boolean is token expired.

getIsValid() публичный метод

Checks if token is valid.
public getIsValid ( ) : boolean
Результат boolean is token valid.

getParam() публичный метод

Returns param by name.
public getParam ( string $name ) : mixed
$name string param name.
Результат mixed param value.

getParams() публичный метод

public getParams ( ) : array
Результат array

getToken() публичный метод

Returns token value.
public getToken ( ) : string
Результат string token value.

getTokenSecret() публичный метод

Returns the token secret value.
public getTokenSecret ( ) : string
Результат string token secret value.

init() публичный метод

public init ( )

setExpireDuration() публичный метод

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

setExpireDurationParamKey() публичный метод

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

setParam() публичный метод

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

setParams() публичный метод

public setParams ( array $params )
$params array

setToken() публичный метод

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

setTokenSecret() публичный метод

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

Описание свойств

$createTimestamp публичное свойство

object creation timestamp.
public $createTimestamp

$tokenParamKey публичное свойство

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

$tokenSecretParamKey публичное свойство

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