kernel/private/rest/classes/models/ezprest_token.php

Show: inherited

• Classes
  • \ezpRestToken

Table of Contents

Copyright

Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  

License

eZ Business Use License Agreement Version 2.0  

Package

kernel  

Version

4.6.0  

\ezpRestToken

jump to top

Package: Default

Data class ezprest_tokens.

Class to be used with eZ Components PersistentObject.

Parent(s)

?\ezcPersistentObject

Properties

string  $client_id= ''

client_id

Details

Type

string

int  $expirytime= ''

expirytime

Details

Type

int

string  $id= ''

id

Details

Type

string

string  $refresh_token= ''

refresh_token

Details

Type

string

string  $scope= ''

scope

Details

Type

string

int  $user_id= ''

user_id

Details

Type

int

Methods

fetch( string $accessToken, bool $authCheck = true ) : \ezpRestToken

static

Fetches an ezpRestToken persistent object from an access token

Parameters

Name	Type	Description
$accessToken	string	Access token hash string
$authCheck	bool	If true, will also check if token corresponds to a client app authorized by its user

Returns

Type	Description
\ezpRestToken

generateToken(  $vary ) : string

static

Generates a random token.

Code is adopted from MvcAuthenticationTiein

Parameters

Name	Type	Description
$vary

Returns

Type	Description
string	The token.

getState( ) : \array(string=>mixed)

Get the PersistentObject state.

Returns

Type	Description
\array(string=>mixed)	The state of the object.

setState( \array(string=>mixed) $state ) : void

Set the PersistentObject state.

Parameters

Name	Type	Description
$state	\array(string=>mixed)	The state to set.