Cheetah
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Facebook\Authentication\AccessToken Class Reference

Public Member Functions

 __construct ($accessToken, $expiresAt=0)
 
 getAppSecretProof ($appSecret)
 
 getExpiresAt ()
 
 isAppAccessToken ()
 
 isLongLived ()
 
 isExpired ()
 
 getValue ()
 
 __toString ()
 

Protected Member Functions

 setExpiresAtFromTimeStamp ($timeStamp)
 

Protected Attributes

 $value = ''
 
 $expiresAt
 

Detailed Description

Definition at line 31 of file AccessToken.php.

Constructor & Destructor Documentation

◆ __construct()

Facebook\Authentication\AccessToken::__construct (   $accessToken,
  $expiresAt = 0 
)

Create a new access token entity.

Parameters
string$accessToken
int$expiresAt

Definition at line 53 of file AccessToken.php.

Member Function Documentation

◆ __toString()

Facebook\Authentication\AccessToken::__toString ( )

Returns the access token as a string.

Returns
string

Definition at line 144 of file AccessToken.php.

◆ getAppSecretProof()

Facebook\Authentication\AccessToken::getAppSecretProof (   $appSecret)

Generate an app secret proof to sign a request to Graph.

Parameters
string$appSecretThe app secret.
Returns
string

Definition at line 68 of file AccessToken.php.

◆ getExpiresAt()

Facebook\Authentication\AccessToken::getExpiresAt ( )

Getter for expiresAt.

Returns
\DateTime|null

Definition at line 78 of file AccessToken.php.

◆ getValue()

Facebook\Authentication\AccessToken::getValue ( )

Returns the access token as a string.

Returns
string

Definition at line 134 of file AccessToken.php.

◆ isAppAccessToken()

Facebook\Authentication\AccessToken::isAppAccessToken ( )

Determines whether or not this is an app access token.

Returns
bool

Definition at line 88 of file AccessToken.php.

◆ isExpired()

Facebook\Authentication\AccessToken::isExpired ( )

Checks the expiration of the access token.

Returns
boolean|null

Definition at line 116 of file AccessToken.php.

◆ isLongLived()

Facebook\Authentication\AccessToken::isLongLived ( )

Determines whether or not this is a long-lived token.

Returns
bool

Definition at line 98 of file AccessToken.php.

◆ setExpiresAtFromTimeStamp()

Facebook\Authentication\AccessToken::setExpiresAtFromTimeStamp (   $timeStamp)
protected

Setter for expires_at.

Parameters
int$timeStamp

Definition at line 154 of file AccessToken.php.

Member Data Documentation

◆ $expiresAt

Facebook\Authentication\AccessToken::$expiresAt
protected

Definition at line 45 of file AccessToken.php.

◆ $value

Facebook\Authentication\AccessToken::$value = ''
protected

Definition at line 38 of file AccessToken.php.


The documentation for this class was generated from the following file: