famdirksen/laravel-model-encryption

Laravel package to encrypt model attributes

dev-master / 1.0.x-dev 2018-05-14 11:49 UTC

Requires

• php: ~5.6|~7.0|~7.1|~7.2

Requires (Dev)

• phpunit/phpunit: >=5.4.3

MIT

• Robin Dirksen

• famdirksen

README

About

This package can be used by simply adding a trait to the model you want to encrypt.

Install

Via Composer

$ composer require famdirksen/laravel-model-encryption

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

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.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Robin Dirksen
• All Contributors

License

The MIT License (MIT). Please see License File for more information.