PHP Interface Jose\Object\JWEInterface

Inheritance: extends Jose\Object\JWTInterface

Datei anzeigen Open project: spomky-labs/jose Interface Usage Examples

Public Methods

Method	Description
addRecipientInformation ( Jose\Object\JWKInterface $recipient_key, array $recipient_headers = [] ) : Jose\Object\JWEInterface
addRecipientWithEncryptedKey ( string \| null $encrypted_key, array $recipient_headers ) : Jose\Object\JWEInterface
countRecipients ( ) : integer	Returns the number of recipients associated with the JWS.
getAAD ( ) : string \| null
getCiphertext ( ) : string \| null
getEncodedSharedProtectedHeaders ( ) : string \| null
getIV ( ) : string \| null
getRecipient ( integer $id ) : Jose\Object\RecipientInterface
getRecipients ( ) : Jose\Object\RecipientInterface[]	Returns the recipients associated with the JWS.
getSharedHeader ( string $key ) : mixed \| null
getSharedHeaders ( ) : array
getSharedProtectedHeader ( string $key ) : mixed \| null
getSharedProtectedHeaders ( ) : array
getTag ( ) : string \| null
hasSharedHeader ( string $key ) : boolean
hasSharedProtectedHeader ( string $key ) : boolean
isEncrypted ( ) : boolean
toCompactJSON ( integer $recipient ) : string
toFlattenedJSON ( integer $recipient ) : string
toJSON ( ) : string
withAAD ( string $aad ) : Jose\Object\JWEInterface
withCiphertext ( string $ciphertext ) : Jose\Object\JWEInterface
withEncodedSharedProtectedHeaders ( string $encoded_shared_protected_headers ) : Jose\Object\JWEInterface
withIV ( string $iv ) : Jose\Object\JWEInterface
withSharedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
withSharedHeaders ( array $shared_headers ) : Jose\Object\JWEInterface
withSharedProtectedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
withSharedProtectedHeaders ( array $shared_protected_headers ) : Jose\Object\JWEInterface
withTag ( string $tag ) : Jose\Object\JWEInterface

Method Details

addRecipientInformation() public method

public addRecipientInformation ( Jose\Object\JWKInterface $recipient_key, array $recipient_headers = [] ) : Jose\Object\JWEInterface
$recipient_key	Jose\Object\JWKInterface
$recipient_headers	array
return	Jose\Object\JWEInterface

addRecipientWithEncryptedKey() public method

public addRecipientWithEncryptedKey ( string \| null $encrypted_key, array $recipient_headers ) : Jose\Object\JWEInterface
$encrypted_key	string \| null
$recipient_headers	array
return	Jose\Object\JWEInterface

countRecipients() public method

Returns the number of recipients associated with the JWS.

public countRecipients ( ) : integer
return	integer

getAAD() public method

public getAAD ( ) : string \| null
return	string \| null

getCiphertext() public method

public getCiphertext ( ) : string \| null
return	string \| null	The cyphertext

getEncodedSharedProtectedHeaders() public method

public getEncodedSharedProtectedHeaders ( ) : string \| null
return	string \| null

getIV() public method

public getIV ( ) : string \| null
return	string \| null

getRecipient() public method

public getRecipient ( integer $id ) : Jose\Object\RecipientInterface
$id	integer
return	Jose\Object\RecipientInterface

getRecipients() public method

Returns the recipients associated with the JWS.

public getRecipients ( ) : Jose\Object\RecipientInterface[]
return	Jose\Object\RecipientInterface[]

getSharedHeader() public method

public getSharedHeader ( string $key ) : mixed \| null
$key	string	The key
return	mixed \| null	Header value

getSharedHeaders() public method

public getSharedHeaders ( ) : array
return	array

getSharedProtectedHeader() public method

public getSharedProtectedHeader ( string $key ) : mixed \| null
$key	string	The key
return	mixed \| null	Header value

getSharedProtectedHeaders() public method

public getSharedProtectedHeaders ( ) : array
return	array

getTag() public method

public getTag ( ) : string \| null
return	string \| null

hasSharedHeader() public method

public hasSharedHeader ( string $key ) : boolean
$key	string	The key
return	boolean

hasSharedProtectedHeader() public method

public hasSharedProtectedHeader ( string $key ) : boolean
$key	string	The key
return	boolean

isEncrypted() public method

public isEncrypted ( ) : boolean
return	boolean

toCompactJSON() public method

public toCompactJSON ( integer $recipient ) : string
$recipient	integer
return	string

toFlattenedJSON() public method

public toFlattenedJSON ( integer $recipient ) : string
$recipient	integer
return	string

toJSON() public method

public toJSON ( ) : string
return	string

withAAD() public method

public withAAD ( string $aad ) : Jose\Object\JWEInterface
$aad	string
return	Jose\Object\JWEInterface

withCiphertext() public method

public withCiphertext ( string $ciphertext ) : Jose\Object\JWEInterface
$ciphertext	string
return	Jose\Object\JWEInterface

withEncodedSharedProtectedHeaders() public method

public withEncodedSharedProtectedHeaders ( string $encoded_shared_protected_headers ) : Jose\Object\JWEInterface
$encoded_shared_protected_headers	string
return	Jose\Object\JWEInterface

withIV() public method

public withIV ( string $iv ) : Jose\Object\JWEInterface
$iv	string
return	Jose\Object\JWEInterface

withSharedHeader() public method

public withSharedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
$key	string
$value	mixed \| null
return	Jose\Object\JWEInterface

withSharedHeaders() public method

public withSharedHeaders ( array $shared_headers ) : Jose\Object\JWEInterface
$shared_headers	array
return	Jose\Object\JWEInterface

withSharedProtectedHeader() public method

public withSharedProtectedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
$key	string
$value	mixed \| null
return	Jose\Object\JWEInterface

withSharedProtectedHeaders() public method

public withSharedProtectedHeaders ( array $shared_protected_headers ) : Jose\Object\JWEInterface
$shared_protected_headers	array
return	Jose\Object\JWEInterface

withTag() public method

public withTag ( string $tag ) : Jose\Object\JWEInterface
$tag	string
return	Jose\Object\JWEInterface