PHP Class Lcobucci\JWT\Builder

Since: 0.1.0
Author: Luís Otávio Cobucci Oblonczyk ([email protected])
Afficher le fichier Open project: lcobucci/jwt Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( Lcobucci\Jose\Parsing\Encoder $encoder, Factory $claimFactory ) Initializes a new builder
canOnlyBeUsedAfter ( integer $notBefore, boolean $addHeader = false ) : Builder Configures the time before which the token cannot be accepted
canOnlyBeUsedBy ( string $audience, boolean $addHeader = false ) : Builder Configures the audience
expiresAt ( integer $expiration, boolean $addHeader = false ) : Builder Configures the expiration time
getToken ( ) : Token Returns the resultant token
identifiedBy ( string $id, boolean $addHeader = false ) : Builder Configures the token id
issuedAt ( integer $issuedAt, boolean $addHeader = false ) : Builder Configures the time that the token was issued
issuedBy ( string $issuer, boolean $addHeader = false ) : Builder Configures the issuer
relatedTo ( string $subject, boolean $addHeader = false ) : Builder Configures the subject
sign ( Lcobucci\JWT\Signer $signer, Lcobucci\JWT\Signer\Key $key ) : Builder Signs the data
unsign ( ) : Builder Removes the signature from the builder
with ( string $name, mixed $value ) : Builder Configures a claim item
withHeader ( string $name, mixed $value ) : Builder Configures a header item

Méthodes protégées

Méthode Description
setRegisteredClaim ( string $name, mixed $value, boolean $addHeader ) : Builder Configures a registed claim

Method Details

__construct() public méthode

Initializes a new builder
public __construct ( Lcobucci\Jose\Parsing\Encoder $encoder, Factory $claimFactory )
$encoder Lcobucci\Jose\Parsing\Encoder
$claimFactory Lcobucci\JWT\Claim\Factory

canOnlyBeUsedAfter() public méthode

Configures the time before which the token cannot be accepted
public canOnlyBeUsedAfter ( integer $notBefore, boolean $addHeader = false ) : Builder
$notBefore integer
$addHeader boolean
Résultat Builder

canOnlyBeUsedBy() public méthode

Configures the audience
public canOnlyBeUsedBy ( string $audience, boolean $addHeader = false ) : Builder
$audience string
$addHeader boolean
Résultat Builder

expiresAt() public méthode

Configures the expiration time
public expiresAt ( integer $expiration, boolean $addHeader = false ) : Builder
$expiration integer
$addHeader boolean
Résultat Builder

getToken() public méthode

Returns the resultant token
public getToken ( ) : Token
Résultat Token

identifiedBy() public méthode

Configures the token id
public identifiedBy ( string $id, boolean $addHeader = false ) : Builder
$id string
$addHeader boolean
Résultat Builder

issuedAt() public méthode

Configures the time that the token was issued
public issuedAt ( integer $issuedAt, boolean $addHeader = false ) : Builder
$issuedAt integer
$addHeader boolean
Résultat Builder

issuedBy() public méthode

Configures the issuer
public issuedBy ( string $issuer, boolean $addHeader = false ) : Builder
$issuer string
$addHeader boolean
Résultat Builder

relatedTo() public méthode

Configures the subject
public relatedTo ( string $subject, boolean $addHeader = false ) : Builder
$subject string
$addHeader boolean
Résultat Builder

setRegisteredClaim() protected méthode

Configures a registed claim
protected setRegisteredClaim ( string $name, mixed $value, boolean $addHeader ) : Builder
$name string
$value mixed
$addHeader boolean
Résultat Builder

sign() public méthode

Signs the data
public sign ( Lcobucci\JWT\Signer $signer, Lcobucci\JWT\Signer\Key $key ) : Builder
$signer Lcobucci\JWT\Signer
$key Lcobucci\JWT\Signer\Key
Résultat Builder

unsign() public méthode

Removes the signature from the builder
public unsign ( ) : Builder
Résultat Builder

with() public méthode

Configures a claim item
public with ( string $name, mixed $value ) : Builder
$name string
$value mixed
Résultat Builder

withHeader() public méthode

Configures a header item
public withHeader ( string $name, mixed $value ) : Builder
$name string
$value mixed
Résultat Builder