Aware for Laravel

Appearance

Root Namespace ​

php
use CharlGottschalk\LaravelAware

Tracker ​

Methods

make() ​

Arguments:

  • Illuminate\Database\Eloquent\Model $model
  • CharlGottschalk\LaravelAware\Enums\ChangeAction $action

Returns: CharlGottschalk\LaravelAware\Entities\ChangeData

Example:

php
$post = Post::find(1);
$post->title = 'New title';
$changes = Tracker::make($post, ChangeAction::UPDATE);

TIP

Read more about the ChangeData entity.

TIP

Read more about the ChangeAction enum.

Who ​

Methods

performed() ​

Arguments:

  • string $referenceClass
  • string|int $referenceId
  • CharlGottschalk\LaravelAware\Enums\ChangeAction $action

Returns: null|Illuminate\Support\Collection|Illuminate\Database\Eloquent\Model

Example:

php
$post = Post::find(1);
$user = Who::performed(Post::class, $post->id, ChangeAction::UPDATE);

TIP

Read more about the ChangeAction enum.

created() ​

Arguments:

  • string|Illuminate\Database\Eloquent\Model $reference
  • string|int|null $referenceId

Returns: null|Illuminate\Database\Eloquent\Model

Example:

php
$post = Post::find(1);
$user = Who::created(Post::class, $post->id);
// --or--
$users = Who::created($post);

updated() ​

Arguments:

  • string|Illuminate\Database\Eloquent\Model $reference
  • string|int|null $referenceId

Returns: null|Illuminate\Support\Collection

Example:

php
$post = Post::find(1);
$users = Who::updated(Post::class, $post->id);
// --or--
$users = Who::updated($post);

restored() ​

Arguments:

  • string|Illuminate\Database\Eloquent\Model $reference
  • string|int|null $referenceId

Returns: null|Illuminate\Support\Collection

Example:

php
$post = Post::find(1);
$users = Who::restored(Post::class, $post->id);
// --or--
$users = Who::restored($post);

deleted() ​

Arguments:

  • string $referenceClass
  • string|int $referenceId

Returns: null|Illuminate\Support\Collection

Example:

php
$users = Who::deleted(Post::class, $post->id);

forceDeleted() ​

Arguments:

  • string $referenceClass
  • string|int $referenceId

Returns: null|Illuminate\Support\Collection

Example:

php
$users = Who::forceDeleted(Post::class, $postId);