hihaho / laravel-encryptable-trait
Laravel encryptable trait, easily make certain fields for eloquent models encryptable
Installs: 57 975
Dependents: 0
Suggesters: 0
Security: 0
Stars: 10
Watchers: 3
Forks: 3
Open Issues: 0
Requires
- php: ^8.1
- illuminate/encryption: ^10.0|^11.0
Requires (Dev)
- mockery/mockery: ^1.5.1
- orchestra/testbench: ^8.0|^9.0
- phpunit/phpunit: ^10.0
- roave/security-advisories: dev-latest
README
This trait encrypts all your fields (defined in $this->encryptable) before saving it to the database. It makes it extremely easy to treat certain fields as encryptable by automatically encrypting and decrypting the values.
Photoware
This package is free to use, but inspired by Spaties' Poscardware we'd love to see where where this package is being developed. A photo of an important landmark in your area would be highly appreciated.
Our email address is photoware@hihaho.com
Install
Simply add the following line to your composer.json
and run composer update
"hihaho/laravel-encryptable-trait": "^v4.0"
Or use composer to add it with the following command
composer require hihaho/laravel-encryptable-trait
Requirements
- illuminate/encryption ^10.0 or ^11.0
- PHP 8.1, 8.2 or 8.3
Usage
Simply add the trait to your models and set the $encryptable
to an array of values that need to be encrypted.
<?php namespace app\Models; use Illuminate\Database\Eloquent\Model as Eloquent; use HiHaHo\EncryptableTrait\Encryptable; class Phone extends Eloquent { use Encryptable; protected $encryptable = [ 'imei', ]; }
DecryptException
This package will throw a DecryptException (the default Laravel one: Illuminate\Contracts\Encryption\DecryptException
).
You can however set $dontThrowDecryptException
to true to ignore the exception.
If the value can't be decrypted it will just return null.
<?php namespace app\Models; use Illuminate\Database\Eloquent\Model as Eloquent; use HiHaHo\EncryptableTrait\Encryptable; class Phone extends Eloquent { use Encryptable; protected $encryptable = [ 'imei', ]; protected $dontThrowDecryptException = true; }
If the database contains an invalid value, this will return null.
$phone = Phone::find(1); $phone->imei; //Will return null