laravel-model-changes-history

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #golang #android #rust #nodejs #awesome #awesome-list #security #ios #open-source

laravel-model-changes-history

(★ 53)

Model changes history for laravel

파일 탐색기

최종 버전 다운로드 (.zip)

- - model_changes_history.php
- - StorageNotFoundException.php
- - ChangesHistory.php
  - HistoryStorage.php
- - HistoryStorageInterface.php
- - Change.php
- - ModelChangesHistoryObserver.php
- - ModelChangesHistoryServiceProvider.php
- - ChangesHistoryService.php
  - HistoryStorageService.php
- - DatabaseHistoryStorage.php
  - FileHistoryStorage.php
  - HistoryStorageRegistry.php
  - RedisHistoryStorage.php
- - HasChangesHistory.php
- - TestModel.php
- - ChangesHistoryServiceTest.php
  - HistoryStorageServiceTest.php
- TestCase.php
.gitignore
composer.json
phpunit.xml
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# antonrom00/laravel-model-changes-history

Records the changes history made to an eloquent model.

[![Total Downloads](https://img.shields.io/packagist/dt/antonrom00/laravel-model-changes-history.svg?style=flat-square)](https://packagist.org/packages/antonrom00/laravel-model-changes-history)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=P58FVTP9QTTEW&source=url)

## Quick start

**Your model must have an `id` field!**

```bash
composer require antonrom00/laravel-model-changes-history
```

```bash
php artisan vendor:publish --tag="model-changes-history"
```

```bash
php artisan migrate
```

**Note: this library use `database` storage as default.**

## Installation

```bash
composer require antonrom00/laravel-model-changes-history
```

The package is auto discovered.

To change the config, publish it using the following command:

```bash
php artisan vendor:publish --provider="Antonrom\ModelChangesHistory\Providers\ModelChangesHistoryServiceProvider" --tag="config"
```

You can use three ways for record changes: `'storage' => 'database', 'file' or 'redis'`

If you want to use `database` storage, you must publish the migration file, run the following artisan commands:

```bash
php artisan vendor:publish --provider="Antonrom\ModelChangesHistory\Providers\ModelChangesHistoryServiceProvider" --tag="migrations"
```

```bash
php artisan migrate
```

Use this environment to manage library:

```dotenv
# Global recorgin model changes history
RECORD_CHANGES_HISTORY=true

# Default storage for recorgin model changes history
MODEL_CHANGES_HISTORY_STORAGE=database
```

**Explore
the [config](https://github.com/Antonrom00/laravel-model-changes-history/blob/master/publishable/config/model_changes_history.php)
for more detailed library setup.**

## Usage

Add the trait to your model class you want to record changes history for:

```php
use Antonrom\ModelChangesHistory\Traits\HasChangesHistory;
use Illuminate\Database\Eloquent\Model;

class TestModel extends Model {
    use HasChangesHistory;

/**
     * The attributes that are mass assignable.
     * This will also be hidden for changes history.
     *
     * @var array
     */
    protected $hidden = ['password', 'remember_token'];
}

```

Your model now has a relation to all the changes made:

```php
$testModel->latestChange();

Antonrom\ModelChangesHistory\Models\Change {
    ...
    #attributes:  [
        "model_id" => 1
        "model_type" => "App\TestModel"
        "before_changes" => "{...}"
        "after_changes" => "{...}"
        "change_type" => "updated"
        "changes" => "{
            "title": {
                "before": "Some old title",  
                "after": "This is the new title"
            },
            "body": {
                "before": "Some old body",  
                "after": "This is the new body"
            },
            "password": {
                "before": "[hidden]",  
                "after": "[hidden]"
            }
        }"
        "changer_type" =>  "App\User"
        "changer_id" => 1
        "stack_trace" => "{...}"
        "created_at" => "2020-01-21 17:34:31"
    ]
    ...
}
```

#### Getting all changes history:

```php
$testModel->historyChanges();

Illuminate\Database\Eloquent\Collection {
  #items: array:3 [
    0 => Antonrom\ModelChangesHistory\Models\Change {...}
    1 => Antonrom\ModelChangesHistory\Models\Change {...}
    2 => Antonrom\ModelChangesHistory\Models\Change {...}
    ...
}
```

**If you use `database` storage you can also use morph relations to `Change` model:**

```php
$testModel->latestChangeMorph();
$testModel->historyChangesMorph();
```

#### Clearing changes history:

```php
$testModel->clearHistoryChanges();
```

#### Get an independent changes history:

```php
use Antonrom\ModelChangesHistory\Facades\HistoryStorage;
...

$latestChanges = HistoryStorage::getHistoryChanges(); // Return collection of all latest changes
$latestChanges = HistoryStorage::getHistoryChanges($testModel); // Return collection of all latest changes for model

$latestChange = HistoryStorage::getLatestChange(); // Return latest change
$latestChange = HistoryStorage::getLatestChange($testModel); // Return latest change for model

HistoryStorage::deleteHistoryChanges(); // This will delete all history changes
HistoryStorage::deleteHistoryChanges($testModel); // This will delete all history changes for model
```

#### Getting model changer:

```php
// Return Authenticatable `changer_type` using HasOne relation to changer_type and changer_id
$changer = $latestChange->changer; 
```

##### If you use `database` storage you can use `Change` model as:

```php
use Antonrom\ModelChangesHistory\Models\Change;

// Get the updates on the given model, by the given user, in the last 30 days:
Change::query()
    ->whereModel($testModel)
    ->whereChanger($user)
    ->whereType(Change::TYPE_UPDATED)
    ->whereCreatedBetween(now()->subDays(30), now())
    ->get();
```

#### Clearing changes history using console:

```bash
php artisan changes-history:clear
```

You can use it in `Kelner`:

```php
protected function schedule(Schedule $schedule)
{
    $schedule->command('changes-history:clear')->monthly();
}
```

## Donation

If this project help you reduce time to develop, you can buy me a cup of
coffee [![buy_me_a_coffee](https://cdn.buymeacoffee.com/buttons/bmc-new-btn-logo.svg)](https://www.buymeacoffee.com/antonrom)
=)

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=P58FVTP9QTTEW&source=url)

laravel-model-changes-history

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

laravel-model-changes-history

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README