Référence de l'interface Signer

Graphe d'héritage de Signer:

Fonctions membres publiques
	getAlgorithmId ()
	modifyHeader (array &$headers)
	sign ($payload, $key)
	verify ($expected, $payload, $key)

Description détaillée

Basic interface for token signers

Auteur

Luís Otávio Cobucci Oblonczyk lcobu.nosp@m.cci@.nosp@m.gmail.nosp@m..com

Depuis

0.1.0

Documentation des fonctions membres

getAlgorithmId()

getAlgorithmId

(

)

Returns the algorithm id

Renvoie

string

Implémenté dans Sha256, Sha384, Sha512, Sha256, Sha384, Sha512, Sha256, Sha384, Sha512, et None.

Référencé par BaseSigner\modifyHeader(), et Token\verify().

modifyHeader()

modifyHeader

(

array &

$headers

)

Apply changes on headers according with algorithm

Paramètres

array

$headers

Implémenté dans BaseSigner.

sign()

sign	(		$payload,
			$key
	)

Returns a signature for given data

Paramètres

string	$payload
Key | string	$key

Renvoie

Signature

Exceptions

InvalidArgumentException

When given key is invalid

Implémenté dans BaseSigner.

verify()

verify	(		$expected,
			$payload,
			$key
	)

Returns if the expected hash matches with the data and key

Paramètres

string	$expected
string	$payload
Key | string	$key

Renvoie

boolean

Exceptions

InvalidArgumentException

When given key is invalid

Implémenté dans BaseSigner.

Référencé par Signature\verify().

---

La documentation de cette interface a été générée à partir du fichier suivant :

• Signer.php