hihaho/laravel-encryptable-trait

Laravel encryptable trait, easily make certain fields for eloquent models encryptable

v1.4.0 2021-02-11 17:58 UTC

This package is auto-updated.

Last update: 2022-05-11 20:25:23 UTC


README

Build Status StyleCI Code Climate Latest Stable Version Total Downloads Latest Unstable Version License Dependency Status

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": "^v1.3"

Or use composer to add it with the following command

composer require "hihaho/laravel-encryptable-trait:^v1.3"

Requirements

  • illuminate/encryption ^6.0, ^7.0 or ^8.0
  • PHP 7.2, 7.3, 7.4 or 8.0

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

Contributors