HumHub Documentation (unofficial)

OAuthToken extends BaseObject
in package

Token represents OAuth token.

Tags
author

Paul Klimov klimov.paul@gmail.com

since
2.0

Table of Contents

Properties

$createTimestamp  : int
$expireDuration  : int
$expireDurationParamKey  : string
$isExpired  : bool
$isValid  : bool
$params  : array<string|int, mixed>
$token  : string
$tokenParamKey  : string
$tokenSecret  : string
$tokenSecretParamKey  : string
$_expireDurationParamKey  : string
$_params  : array<string|int, mixed>

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
getExpireDuration()  : int
Returns the token expiration duration.
getExpireDurationParamKey()  : string
getIsExpired()  : bool
Checks if token has expired.
getIsValid()  : bool
Checks if token is valid.
getParam()  : mixed
Returns param by name.
getParams()  : array<string|int, mixed>
getToken()  : string
Returns token value.
getTokenSecret()  : string
Returns the token secret value.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
setExpireDuration()  : mixed
Sets token expire duration.
setExpireDurationParamKey()  : mixed
setParam()  : mixed
Sets param by name.
setParams()  : mixed
setToken()  : $this
Sets token value.
setTokenSecret()  : mixed
Sets the token secret value.
defaultExpireDurationParamKey()  : string
Fetches default expire duration param key.

Properties

$createTimestamp

public int $createTimestamp

object creation timestamp.

$expireDuration

public int $expireDuration

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

$expireDurationParamKey

public string $expireDurationParamKey

Expire duration param key.

$isExpired read-only

public bool $isExpired

Is token expired.

$isValid read-only

public bool $isValid

Is token valid.

$params read-only

public array<string|int, mixed> $params

$tokenParamKey

public string $tokenParamKey = 'oauth_token'

key in [[params]] array, which stores token key.

$tokenSecret

public string $tokenSecret

Token secret value.

$tokenSecretParamKey

public string $tokenSecretParamKey = 'oauth_token_secret'

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

$_expireDurationParamKey

private string $_expireDurationParamKey

key in [[params]] array, which stores token expiration duration. If not set will attempt to fetch its value automatically.

$_params

private array<string|int, mixed> $_params = []

token parameters.

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

getExpireDuration()

Returns the token expiration duration.

public getExpireDuration() : int
Return values
int —

token expiration duration.

getExpireDurationParamKey()

public getExpireDurationParamKey() : string
Return values
string —

expire duration param key.

getIsExpired()

Checks if token has expired.

public getIsExpired() : bool
Return values
bool —

is token expired.

getIsValid()

Checks if token is valid.

public getIsValid() : bool
Return values
bool —

is token valid.

getParam()

Returns param by name.

public getParam(string $name) : mixed
Parameters
$name : string

param name.

Return values
mixed —

param value.

getParams()

public getParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getToken()

Returns token value.

public getToken() : string
Return values
string —

token value.

getTokenSecret()

Returns the token secret value.

public getTokenSecret() : string
Return values
string —

token secret value.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

setExpireDuration()

Sets token expire duration.

public setExpireDuration(string $expireDuration) : mixed
Parameters
$expireDuration : string

token expiration duration.

setExpireDurationParamKey()

public setExpireDurationParamKey(string $expireDurationParamKey) : mixed
Parameters
$expireDurationParamKey : string

expire duration param key.

setParam()

Sets param by name.

public setParam(string $name, mixed $value) : mixed
Parameters
$name : string

param name.

$value : mixed

param value,

setParams()

public setParams(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

setToken()

Sets token value.

public setToken(string $token) : $this
Parameters
$token : string

token value.

Return values
$this —

the object itself

setTokenSecret()

Sets the token secret value.

public setTokenSecret(string $tokenSecret) : mixed
Parameters
$tokenSecret : string

token secret.

defaultExpireDurationParamKey()

Fetches default expire duration param key.

protected defaultExpireDurationParamKey() : string
Return values
string —

expire duration param key.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results