Final Class Yiisoft\Yii\AuthClient\OAuthToken
| Inheritance | Yiisoft\Yii\AuthClient\OAuthToken |
|---|
Token represents OAuth token.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | Yiisoft\Yii\AuthClient\OAuthToken | |
| getExpireDuration() | Returns the token expiration duration. | Yiisoft\Yii\AuthClient\OAuthToken |
| getExpireDurationParamKey() | Yiisoft\Yii\AuthClient\OAuthToken | |
| getIsExpired() | Checks if token has expired. | Yiisoft\Yii\AuthClient\OAuthToken |
| getIsValid() | Checks if token is valid. | Yiisoft\Yii\AuthClient\OAuthToken |
| getParam() | Returns param by name. | Yiisoft\Yii\AuthClient\OAuthToken |
| getParams() | Yiisoft\Yii\AuthClient\OAuthToken | |
| getToken() | Returns token value. | Yiisoft\Yii\AuthClient\OAuthToken |
| getTokenSecret() | Returns the token secret value. | Yiisoft\Yii\AuthClient\OAuthToken |
| setExpireDuration() | Sets token expire duration. | Yiisoft\Yii\AuthClient\OAuthToken |
| setParam() | Sets param by name. | Yiisoft\Yii\AuthClient\OAuthToken |
| setParams() | Yiisoft\Yii\AuthClient\OAuthToken | |
| setToken() | Sets token value. | Yiisoft\Yii\AuthClient\OAuthToken |
| setTokenSecret() | Sets the token secret value. | Yiisoft\Yii\AuthClient\OAuthToken |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| defaultExpireDurationParamKey() | Fetches default expire duration param key. | Yiisoft\Yii\AuthClient\OAuthToken |
Method Details
Fetches default expire duration param key.
| protected string defaultExpireDurationParamKey ( ) | ||
| return | string |
Expire duration param key. |
|---|---|---|
protected function defaultExpireDurationParamKey(): string
{
$expireDurationParamKey = 'expires_in';
/**
* @var mixed $value
*/
foreach ($this->getParams() as $name => $value) {
if (!str_contains((string)$name, 'expir')) {
} else {
$expireDurationParamKey = (string)$name;
break;
}
}
return $expireDurationParamKey;
}
Returns the token expiration duration.
return mixed token expiration duration.
| public mixed getExpireDuration ( ) |
public function getExpireDuration(): mixed
{
return $this->getParam($this->getExpireDurationParamKey());
}
| public string getExpireDurationParamKey ( ) | ||
| return | string |
Expire duration param key. |
|---|---|---|
public function getExpireDurationParamKey(): string
{
if ($this->expireDurationParamKey === null) {
$this->expireDurationParamKey = $this->defaultExpireDurationParamKey();
}
return $this->expireDurationParamKey;
}
Checks if token has expired.
| public boolean getIsExpired ( ) | ||
| return | boolean |
Is token expired. |
|---|---|---|
public function getIsExpired(): bool
{
$expirationDuration = (int)$this->getExpireDuration();
return time() >= ($this->createTimestamp + $expirationDuration);
}
Checks if token is valid.
| public boolean getIsValid ( ) | ||
| return | boolean |
Is token valid. |
|---|---|---|
public function getIsValid(): bool
{
$token = $this->getToken();
return strlen($token ?? '') > 0 && !$this->getIsExpired();
}
Returns param by name.
| public mixed getParam ( string $name ) | ||
| $name | string |
Param name. |
| return | mixed |
Param value. |
|---|---|---|
public function getParam(string $name): mixed
{
return $this->params[$name] ?? null;
}
Returns token value.
| public string|null getToken ( ) |
public function getToken(): ?string
{
return $this->getParam($this->tokenParamKey);
}
Returns the token secret value.
| public string getTokenSecret ( ) | ||
| return | string |
Token secret value. |
|---|---|---|
public function getTokenSecret(): string
{
return $this->getParam($this->tokenSecretParamKey ?: 'oauth_token_secret');
}
Sets token expire duration.
| public void setExpireDuration ( integer $expireDuration ) | ||
| $expireDuration | integer |
Token expiration duration. |
public function setExpireDuration(int $expireDuration): void
{
$this->setParam($this->getExpireDurationParamKey(), $expireDuration);
}
Sets param by name.
| public void setParam ( string $name, mixed $value ) | ||
| $name | string |
Param name. |
| $value | mixed |
Param value, |
public function setParam(string $name, mixed $value): void
{
$this->params[$name] = $value;
}
| public void setParams ( array $params ) | ||
| $params | array | |
public function setParams(array $params): void
{
$this->params = $params;
}
Sets token value.
| public void setToken ( string $token ) | ||
| $token | string |
Token value. |
public function setToken(string $token): void
{
$this->setParam($this->tokenParamKey ?: 'oauth_token', $token);
}
Sets the token secret value.
| public void setTokenSecret ( string $tokenSecret ) | ||
| $tokenSecret | string |
Token secret. |
public function setTokenSecret(string $tokenSecret): void
{
$this->setParam($this->tokenSecretParamKey ?: 'oauth_token_secret', $tokenSecret);
}
Signup or Login in order to comment.