W3cubDocs

/Laravel 5.4

Encrypter

class Encrypter implements Encrypter (View source)

Methods

void __construct(string $key, string $cipher = 'AES-128-CBC')

Create a new encrypter instance.
static bool supported(string $key, string $cipher)

Determine if the given key and cipher combination is valid.
string encrypt(string $value, bool $serialize = true)

Encrypt the given value.
string encryptString(string $value)

Encrypt a string without serialization.
string decrypt(string $payload, bool $unserialize = true)

Decrypt the given value.
string decryptString(string $payload)

Decrypt the given string without unserialization.
string getKey()

Get the encryption key.

Details

void __construct(string $key, string $cipher = 'AES-128-CBC')

Create a new encrypter instance.

Parameters

string $key
string $cipher

Return Value

void

Exceptions

RuntimeException

static bool supported(string $key, string $cipher)

Determine if the given key and cipher combination is valid.

Parameters

string $key
string $cipher

Return Value

bool

string encrypt(string $value, bool $serialize = true)

Encrypt the given value.

Parameters

string $value
bool $serialize

Return Value

string

Exceptions

EncryptException

string encryptString(string $value)

Encrypt a string without serialization.

Parameters

string $value

Return Value

string

string decrypt(string $payload, bool $unserialize = true)

Decrypt the given value.

Parameters

string $payload
bool $unserialize

Return Value

string

Exceptions

DecryptException

string decryptString(string $payload)

Decrypt the given string without unserialization.

Parameters

string $payload

Return Value

string

string getKey()

Get the encryption key.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Encryption/Encrypter.html