Download the PHP package striderwhite/encryptable without Composer
On this page you can find all versions of the php package striderwhite/encryptable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download striderwhite/encryptable
More information about striderwhite/encryptable
Files in striderwhite/encryptable
Package encryptable
Short Description A Laravel trait for encrypting and decrypting model attributes using MySQL AES encryption.
License MIT
Informations about the package encryptable
🔒 Encryptable
A Laravel trait for automatically encrypting and decrypting model attributes using MySQL AES encryption.
✨ Features:
- Models attributes that are marked as
encryptable
will automatically be AES encrypted upon persisting to the database. - Attributes are automatically decrypted upon retrieval via Eloquent model attributes or when serializing to JSON/array.
- Provides query builder helper methods for searching on the fields using Eloquent, supports both full and partial searching.
🚀 Installation
Install the package via Composer:
📖 Usage
- Database Setup: Ensure the database column you wish to encrypt is of
binary
datatype. - Add the Trait: Add the
Encryptable
trait to your Eloquent model. -
Define Encryptable Fields: Define an
$encryptable
property in your model with the list of attributes to encrypt. - 💾 Persisting and Retrieving Data
Using the Encryptable
trait, you can persist and retrieve data just like normal Eloquent attributes. The encryption and decryption process is handled automatically.
Example
🔎 Searching Encrypted Fields
The package provides two query scopes for searching encrypted fields:
scopeWhereEncrypted
Use this scope to search for an exact match on an encrypted field:
scopeWhereEncryptedLike
Use this scope to perform a partial search on an encrypted field:
🙏 Credits
Developed and maintained by Strider White. If you find this package helpful, feel free to ⭐ the repository or contribute!
📜 License
This package is open-sourced software licensed under the MIT license.