PHP Interface Swift_Signers_HeaderSigner, Halite

Author: Xavier De Cock ([email protected])
Inheritance: extends Swift_Signer, extends Swift_InputByteStream
Mostra file Open project: HaliteChallenge/Halite

Public Methods

Method Description
addSignature ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_HeaderSigner Add the header(s) to the headerSet.
endBody ( ) : Swift_Signers_HeaderSigner Give the signal that the body has finished streaming.
getAlteredHeaders ( ) : array Return the list of header a signer might tamper.
ignoreHeader ( string $header_name ) : Swift_Signers_HeaderSigner Exclude an header from the signed headers.
setHeaders ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_HeaderSigner Give the headers already given.
startBody ( ) : Swift_Signers_HeaderSigner Prepare the Signer to get a new Body.

Method Details

addSignature() public method

Add the header(s) to the headerSet.
public addSignature ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_HeaderSigner
$headers Swift_Mime_HeaderSet
return Swift_Signers_HeaderSigner

endBody() public method

Give the signal that the body has finished streaming.
public endBody ( ) : Swift_Signers_HeaderSigner
return Swift_Signers_HeaderSigner

getAlteredHeaders() public method

Return the list of header a signer might tamper.
public getAlteredHeaders ( ) : array
return array

ignoreHeader() public method

Exclude an header from the signed headers.
public ignoreHeader ( string $header_name ) : Swift_Signers_HeaderSigner
$header_name string
return Swift_Signers_HeaderSigner

setHeaders() public method

Give the headers already given.
public setHeaders ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_HeaderSigner
$headers Swift_Mime_HeaderSet
return Swift_Signers_HeaderSigner

startBody() public method

Prepare the Signer to get a new Body.
public startBody ( ) : Swift_Signers_HeaderSigner
return Swift_Signers_HeaderSigner