PHP Интерфейс Jose\Object\JWEInterface

Наследование: extends Jose\Object\JWTInterface

Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод	Описание
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

Описание методов

addRecipientInformation() публичный Метод

public addRecipientInformation ( Jose\Object\JWKInterface $recipient_key, array $recipient_headers = [] ) : Jose\Object\JWEInterface
$recipient_key	Jose\Object\JWKInterface
$recipient_headers	array
Результат	Jose\Object\JWEInterface

addRecipientWithEncryptedKey() публичный Метод

public addRecipientWithEncryptedKey ( string \| null $encrypted_key, array $recipient_headers ) : Jose\Object\JWEInterface
$encrypted_key	string \| null
$recipient_headers	array
Результат	Jose\Object\JWEInterface

countRecipients() публичный Метод

Returns the number of recipients associated with the JWS.

public countRecipients ( ) : integer
Результат	integer

getAAD() публичный Метод

public getAAD ( ) : string \| null
Результат	string \| null

getCiphertext() публичный Метод

public getCiphertext ( ) : string \| null
Результат	string \| null	The cyphertext

getEncodedSharedProtectedHeaders() публичный Метод

public getEncodedSharedProtectedHeaders ( ) : string \| null
Результат	string \| null

getIV() публичный Метод

public getIV ( ) : string \| null
Результат	string \| null

getRecipient() публичный Метод

public getRecipient ( integer $id ) : Jose\Object\RecipientInterface
$id	integer
Результат	Jose\Object\RecipientInterface

getRecipients() публичный Метод

Returns the recipients associated with the JWS.

public getRecipients ( ) : Jose\Object\RecipientInterface[]
Результат	Jose\Object\RecipientInterface[]

getSharedHeader() публичный Метод

public getSharedHeader ( string $key ) : mixed \| null
$key	string	The key
Результат	mixed \| null	Header value

getSharedHeaders() публичный Метод

public getSharedHeaders ( ) : array
Результат	array

getSharedProtectedHeader() публичный Метод

public getSharedProtectedHeader ( string $key ) : mixed \| null
$key	string	The key
Результат	mixed \| null	Header value

getSharedProtectedHeaders() публичный Метод

public getSharedProtectedHeaders ( ) : array
Результат	array

getTag() публичный Метод

public getTag ( ) : string \| null
Результат	string \| null

hasSharedHeader() публичный Метод

public hasSharedHeader ( string $key ) : boolean
$key	string	The key
Результат	boolean

hasSharedProtectedHeader() публичный Метод

public hasSharedProtectedHeader ( string $key ) : boolean
$key	string	The key
Результат	boolean

isEncrypted() публичный Метод

public isEncrypted ( ) : boolean
Результат	boolean

toCompactJSON() публичный Метод

public toCompactJSON ( integer $recipient ) : string
$recipient	integer
Результат	string

toFlattenedJSON() публичный Метод

public toFlattenedJSON ( integer $recipient ) : string
$recipient	integer
Результат	string

toJSON() публичный Метод

public toJSON ( ) : string
Результат	string

withAAD() публичный Метод

public withAAD ( string $aad ) : Jose\Object\JWEInterface
$aad	string
Результат	Jose\Object\JWEInterface

withCiphertext() публичный Метод

public withCiphertext ( string $ciphertext ) : Jose\Object\JWEInterface
$ciphertext	string
Результат	Jose\Object\JWEInterface

withEncodedSharedProtectedHeaders() публичный Метод

public withEncodedSharedProtectedHeaders ( string $encoded_shared_protected_headers ) : Jose\Object\JWEInterface
$encoded_shared_protected_headers	string
Результат	Jose\Object\JWEInterface

withIV() публичный Метод

public withIV ( string $iv ) : Jose\Object\JWEInterface
$iv	string
Результат	Jose\Object\JWEInterface

withSharedHeader() публичный Метод

public withSharedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
$key	string
$value	mixed \| null
Результат	Jose\Object\JWEInterface

withSharedHeaders() публичный Метод

public withSharedHeaders ( array $shared_headers ) : Jose\Object\JWEInterface
$shared_headers	array
Результат	Jose\Object\JWEInterface

withSharedProtectedHeader() публичный Метод

public withSharedProtectedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
$key	string
$value	mixed \| null
Результат	Jose\Object\JWEInterface

withSharedProtectedHeaders() публичный Метод

public withSharedProtectedHeaders ( array $shared_protected_headers ) : Jose\Object\JWEInterface
$shared_protected_headers	array
Результат	Jose\Object\JWEInterface

withTag() публичный Метод

public withTag ( string $tag ) : Jose\Object\JWEInterface
$tag	string
Результат	Jose\Object\JWEInterface