Référence de la classe BaseSigner

Graphe d'héritage de BaseSigner:

Fonctions membres publiques
	modifyHeader (array &$headers)
	sign ($payload, $key)
	verify ($expected, $payload, $key)
	createHash ($payload, Key $key)
	doVerify ($expected, $payload, Key $key)
Fonctions membres publiques hérités de Signer
	getAlgorithmId ()

Fonctions membres privées
	getKey ($key)

Description détaillée

Base class for signers

Obsolète:

This class will be removed on v4

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

createHash()

createHash (   $payload, Key  $key  )

abstract

Creates a hash with the given data

Référencé par BaseSigner\sign().

doVerify()

doVerify (   $expected,   $payload, Key  $key  )

abstract

Performs the signature verification

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

getKey()

getKey (   $key )

private

Paramètres

Key | string

$key

Renvoie

Key

Références $key.

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

modifyHeader()

modifyHeader

(

array &

$headers

)

{Apply changes on headers according with algorithm

Paramètres

array

$headers

}

Implémente Signer.

Références Signer\getAlgorithmId().

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émente Signer.

Références $key, BaseSigner\createHash(), et BaseSigner\getKey().

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émente Signer.

Références $key, BaseSigner\doVerify(), et BaseSigner\getKey().

---

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

• BaseSigner.php