Joomla! API

Download
Launch

CipherInterface

Joomla Framework Cipher interface.

since

1.0
package

Joomla Framework

Methods

decrypt

Method to decrypt a data string.

decrypt(string data, \Joomla\Crypt\Key key) : string
since

1.0
throws

\Joomla\Crypt\Exception\DecryptionExceptionif the data cannot be decrypted

\Joomla\Crypt\Exception\InvalidKeyTypeExceptionif the key is not valid for the cipher

\Joomla\Crypt\Exception\UnsupportedCipherExceptionif the cipher is not supported on the current environment

Arguments

data

stringThe encrypted string to decrypt.

key

\Joomla\Crypt\KeyThe key[/pair] object to use for decryption.

Response

stringThe decrypted data string.

encrypt

Method to encrypt a data string.

encrypt(string data, \Joomla\Crypt\Key key) : string
since

1.0
throws

\Joomla\Crypt\Exception\EncryptionExceptionif the data cannot be encrypted

\Joomla\Crypt\Exception\InvalidKeyTypeExceptionif the key is not valid for the cipher

\Joomla\Crypt\Exception\UnsupportedCipherExceptionif the cipher is not supported on the current environment

Arguments

data

stringThe data string to encrypt.

key

\Joomla\Crypt\KeyThe key[/pair] object to use for encryption.

Response

stringThe encrypted data string.

generateKey

Method to generate a new encryption key[/pair] object.

generateKey(array options = []) : \Joomla\Crypt\Key
since

1.0
throws

\Joomla\Crypt\Exception\InvalidKeyExceptionif the key cannot be generated

\Joomla\Crypt\Exception\UnsupportedCipherExceptionif the cipher is not supported on the current environment

Arguments

options

arrayKey generation options.

Response

\Joomla\Crypt\Key

isSupported

Check if the cipher is supported in this environment.

isSupported() : bool
static
since

2.0.0

Response

bool

  • \ Joomla
  • \ Crypt
  • \ CipherInterface