Класс yii\authclient\OAuthToken

Все классы | Свойства | Методы

Наследование	yii\authclient\OAuthToken » yii\base\Object
Реализует	yii\base\Configurable
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2-authclient/blob/master/OAuthToken.php

Токен представляет токен OAuth.

Публичные свойства

Свойство	Тип	Описание	Определено в
$createTimestamp	целое число	Время создания объекта.	yii\authclient\OAuthToken
$expireDuration	строка	Срок действия токена.	yii\authclient\OAuthToken
$expireDurationParamKey	строка	Ключ параметра срока действия.	yii\authclient\OAuthToken
$isExpired	логическое	Истек срок действия токена.	yii\authclient\OAuthToken
$isValid	логическое	Токен действителен.	yii\authclient\OAuthToken
$params	массив		yii\authclient\OAuthToken
$token	строка	Значение токена.	yii\authclient\OAuthToken
$tokenParamKey	строка	Ключ в массиве $params, который хранит ключ токена.	yii\authclient\OAuthToken
$tokenSecret	строка	Секрет токена.	yii\authclient\OAuthToken
$tokenSecretParamKey	строка	Ключ в массиве $params, который хранит ключ секрета токена.	yii\authclient\OAuthToken

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в значение null.	yii\base\Object
canGetProperty()	Возвращает значение, указывающее, можно ли считать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное имя этого класса.	yii\base\Object
getExpireDuration()	Возвращает срок действия токена.	yii\authclient\OAuthToken
getExpireDurationParamKey()		yii\authclient\OAuthToken
getIsExpired()	Проверяет, истек ли срок действия токена.	yii\authclient\OAuthToken
getIsValid()	Проверяет, действителен ли токен.	yii\authclient\OAuthToken
getParam()	Возвращает параметр по имени.	yii\authclient\OAuthToken
getParams()		yii\authclient\OAuthToken
getToken()	Возвращает значение токена.	yii\authclient\OAuthToken
getTokenSecret()	Возвращает значение секрета токена.	yii\authclient\OAuthToken
hasMethod()	Возвращает значение, указывающее, определен ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\authclient\OAuthToken
setExpireDuration()	Устанавливает срок действия токена.	yii\authclient\OAuthToken
setExpireDurationParamKey()		yii\authclient\OAuthToken
setParam()	Устанавливает параметр по имени.	yii\authclient\OAuthToken
setParams()		yii\authclient\OAuthToken
setToken()	Устанавливает значение токена.	yii\authclient\OAuthToken
setTokenSecret()	Устанавливает значение секрета токена.	yii\authclient\OAuthToken

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

Метод	Описание	Определено в
defaultExpireDurationParamKey()	Получает значение по умолчанию ключа параметра срока действия.	yii\authclient\OAuthToken

Подробности о свойствах

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

Время создания объекта.

public integer $createTimestamp = null

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

Срок действия токена.

public integer getExpireDuration ( )
public void setExpireDuration ( $expireDuration )

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

Ключ параметра срока действия.

public string getExpireDurationParamKey ( )
public void setExpireDurationParamKey ( $expireDurationParamKey )

$isExpired публичное только для чтения свойство

Истек срок действия токена.

public boolean getIsExpired ( )

$isValid публичное только для чтения свойство

Действителен ли токен.

public boolean getIsValid ( )

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

public array getParams ( )
public void setParams ( array $params )

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

Значение токена.

public string getToken ( )
public $this setToken ( $token )

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

Ключ в массиве $params, который хранит ключ токена.

public string $tokenParamKey = 'oauth_token'

$tokenSecret общественное свойство

Секрет токена.

public string getTokenSecret ( )
public void setTokenSecret ( $tokenSecret )

$tokenSecretParamKey общественное свойство

Ключ в массиве $params, который хранит ключ секрета токена.

public string $tokenSecretParamKey = 'oauth_token_secret'

Подробное описание методов

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

Возвращает ключевое слово для параметра срока действия по умолчанию.

защищённый строка defaultExpireDurationParamKey ( )
возвращает	строка	Ключевое слово для параметра срока действия.

getExpireDuration() общественный метод

Возвращает срок действия токена.

общественный целое число getExpireDuration ( )
возвращает	целое число	Срок действия токена.

getExpireDurationParamKey() общественный метод

общественный строка getExpireDurationParamKey ( )
возвращает	строка	Ключевое слово для параметра срока действия.

getIsExpired() общественный метод

Проверяет, истек ли срок действия токена.

общественный булево getIsExpired ( )
возвращает	булево	Истек ли срок действия токена.

getIsValid() общественный метод

Проверяет, является ли токен валидным.

общественный булево getIsValid ( )
возвращает	булево	Является ли токен валидным.

getParam() общественный метод

Возвращает параметр по имени.

общественный смешанный getParam ( $name )
$name	строка	Имя параметра.
возвращает	смешанный	Значение параметра.

getParams() общественный метод

общественный массив getParams ( )

getToken() общественный метод

Возвращает значение токена.

общественный строка getToken ( )
возвращает	строка	Значение токена.

getTokenSecret() общественный метод

Возвращает значение секрета токена.

общественный строка getTokenSecret ( )
возвращает	строка	Значение секрета токена.

init() общественный метод

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

общественный void init ( )

setExpireDuration() общественный метод

Устанавливает срок действия токена.

общественный void setExpireDuration ( $expireDuration )
$expireDuration	строка	Срок действия токена.

setExpireDurationParamKey() общественный метод

общественный void setExpireDurationParamKey ( $expireDurationParamKey )
$expireDurationParamKey	строка	Ключевое слово для параметра срока действия.

setParam() общественный метод

Устанавливает параметр по имени.

общественный void setParam ( $name, $value )
$name	строка	Имя параметра.
$value	смешанный	Значение параметра.

setParams() общественный метод

общественный void setParams ( массив $params )
$params	массив

setToken() общественный метод

Устанавливает значение токена.

общественный $this setToken ( $token )
$token	строка	Значение токена.
возвращает	$this	Сам объект

setTokenSecret() общественный метод

Устанавливает значение секрета токена.

общественный void setTokenSecret ( $tokenSecret )
$tokenSecret	строка	Секрет токена.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-oauthtoken.html