Skip to content
This repository was archived by the owner on Dec 2, 2024. It is now read-only.

Commit 3db46e3

Browse files
committed
Add no longer maintained status
1 parent f8c1f57 commit 3db46e3

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
Laravel Encryptable Trait
22
=========================
33

4-
[![Build Status](https://github.com/hihaho/laravel-encryptable-trait/actions/workflows/run-tests.yml/badge.svg?branch=master)](https://github.com/hihaho/laravel-encryptable-trait)
5-
[![Latest Stable Version](https://poser.pugx.org/hihaho/laravel-encryptable-trait/v/stable)](https://packagist.org/packages/hihaho/laravel-encryptable-trait)
6-
[![Total Downloads](https://poser.pugx.org/hihaho/laravel-encryptable-trait/downloads)](https://packagist.org/packages/hihaho/laravel-encryptable-trait)
7-
[![Latest Unstable Version](https://poser.pugx.org/hihaho/laravel-encryptable-trait/v/unstable)](https://packagist.org/packages/hihaho/laravel-encryptable-trait)
84
[![License](https://poser.pugx.org/hihaho/laravel-encryptable-trait/license)](https://packagist.org/packages/hihaho/laravel-encryptable-trait)
9-
[![Dependency Status](https://www.versioneye.com/user/projects/59b7c7150fb24f0032e40d4e/badge.svg?style=flat)](https://www.versioneye.com/user/projects/59b7c7150fb24f0032e40d4e)
105

11-
This trait encrypts all your fields (defined in $this->encryptable) before saving it to the database.
12-
It makes it extremely easy to treat certain fields as encryptable by automatically encrypting and decrypting the values.
6+
> [!WARNING]
7+
># No longer maintained
8+
>We no longer use this package and will not maintain it. Please feel free to fork it and maintain it yourself.
9+
>
10+
>Consider migrating to Laravel encryption features which we added since this package was created.
11+
>
12+
>This package uses serialized encryption, while the Laravel encryption casts unserialized encryption.
13+
>You can upgrade uses of this package to custom casts, e.g. by implementing `Illuminate\Contracts\Database\Eloquent\Castable` on a data object used as cast.
1314
14-
# Photoware
15+
-----
1516

16-
This package is free to use, but inspired by [Spaties' Poscardware](https://spatie.be/en/opensource/postcards) we'd love to see where
17-
where this package is being developed. A photo of an important landmark in your area would be highly appreciated.
17+
### Introduction
1818

19-
Our email address is [[email protected]](mailto:[email protected])
19+
This trait encrypts all your fields (defined in `$this->encryptable`) before saving it to the database.
20+
It makes it extremely easy to treat certain fields as encryptable by automatically encrypting and decrypting the values.
2021

21-
# Install
22+
### Install
2223

2324
Simply add the following line to your ```composer.json``` and run ```composer update```
2425
```
@@ -29,11 +30,11 @@ Or use composer to add it with the following command
2930
composer require hihaho/laravel-encryptable-trait
3031
```
3132

32-
## Requirements
33+
#### Requirements
3334
- illuminate/encryption ^10.0 or ^11.0
3435
- PHP 8.1, 8.2 or 8.3
3536

36-
# Usage
37+
### Usage
3738
Simply add the trait to your models and set the ```$encryptable``` to an array of values that need to be encrypted.
3839

3940
```php
@@ -54,7 +55,7 @@ class Phone extends Eloquent
5455
}
5556
```
5657

57-
## DecryptException
58+
#### DecryptException
5859
This package will throw a DecryptException (the default Laravel one: ```Illuminate\Contracts\Encryption\DecryptException```).
5960
You can however set ```$dontThrowDecryptException``` to true to ignore the exception.
6061
If the value can't be decrypted it will just return null.
@@ -86,7 +87,7 @@ $phone = Phone::find(1);
8687
$phone->imei; //Will return null
8788
````
8889

89-
# Contributors
90+
### Contributors
9091
- [Robert Boes](https://github.com/robertboes)
9192
- [Mart de Graaf](https://github.com/martdegraaf)
9293
- [Sander Muller](https://github.com/SanderMuller)

0 commit comments

Comments
 (0)