famdirksen/laravel-model-encryption

Laravel package to encrypt model attributes

Laravel Model Encryption

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

About

This package can be used by simply adding a trait to the model you want to encrypt., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require famdirksen/laravel-model-encryption, <sub>(*4)</sub>

## Usage

To use this package in your own project, you need to add the `trait` to the model. In the following example we installed Larave 5.6 and ran `php artisan make:auth` to setup authentication.

You need to use the trait, `ModelEncryption` and add the `protected $encryptable` property to your User class, this way you'll enable model encryption on your user data.

app/User.php:
``` php
<?php

namespace App;

use Famdirksen\LaravelModelEncryption\ModelEncryption;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use Notifiable, ModelEncryption;

    protected $encryptable = [
        'name',
    ];

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];
}

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*5)</sub>

Testing

bash $ composer test, <sub>(*6)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*7)</sub>

Security

If you discover any security related issues, please email info@famdirksen.nl instead of using the issue tracker., <sub>(*8)</sub>

Credits

• Robin Dirksen
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*9)</sub>