JsonWebToken Class Reference

Public Member Functions
	__construct (KeyAbstract $key, $algorithm='HS256')
	setAlgorithm ($algorithm)
	decode ($jwtString, $assertClaims=array())
	create ($payload, $expirationOffset=0)

Protected Attributes
	$key
	$algorithm = 'HS256'
	$claims = array()

Constructor & Destructor Documentation

__construct()

__construct	(	KeyAbstract	$key,
			$algorithm = 'HS256'
	)

JsonWebToken constructor.

Parameters

KeyAbstract	$key	key for signing/validating
string	$algorithm	algorithm to use for signing/validating

Here is the call graph for this function:

Member Function Documentation

create()

create	(		$payload,
			$expirationOffset = 0
	)

Create a signed token string for a payload

Parameters

array | \ArrayObject	$payload	traversable set of claims, claim => value
int	$expirationOffset	seconds from now that token will expire. If not specified, an "exp" claim will not be added or updated

Returns

string encoded and signed jwt string

Exceptions

DomainException;

Exceptions

InvalidArgumentException;

Exceptions

UnexpectedValueException;

Here is the call graph for this function:

decode()

decode	(		$jwtString,
			$assertClaims = array()
	)

Decode a JWT string, validating signature and well defined registered claims, and optionally validate against a list of supplied claims

Parameters

string	$jwtString	string containing the JWT to decode
array | \Traversable	$assertClaims	associative array, claim => value, of claims to assert

Returns

object|false

Here is the call graph for this function:

setAlgorithm()

setAlgorithm

(

$algorithm

)

Parameters

string

$algorithm

algorithm to use for signing/validating

Returns

JsonWebToken

Exceptions

DomainException

Here is the caller graph for this function:

Field Documentation

$algorithm

$algorithm = 'HS256'

protected

$claims

$claims = array()

protected

$key

$key

protected

---

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

• C:/xoops2511b2/htdocs/class/libraries/vendor/xoops/xmf/src/Jwt/JsonWebToken.php