chaseconey/laravel-activity

A simple Laravel model activity recording mechanism

1.0.0 2015-04-17 15:37 UTC

This package is auto-updated.

Last update: 2022-06-13 09:04:35 UTC


README

StyleCI Latest Stable Version Total Downloads Latest Unstable Version License

A very simple activity logger build specifically for laravel that tracks actions performed by users based on model events.

Inspired by a Laracasts Lesson

Quikstart

  1. Add package to composer.json
"require": {
    "laravel/framework": "5.0.*",
    "chaseconey/laravel-activity": "dev-master"
  }
  1. Add Service Provider to app.php config
'Chaseconey\ActivityRecorder\ActivityProvider'
  1. composer update
  2. Publish the database migration for Activity table
php artisan vendor:publish --provider="Chaseconey\ActivityRecorder\ActivityProvider" --tag="migrations"
  1. php artisan migrate
  2. Add the trait to any model and enjoy!
use Chaseconey\ActivityRecorder\RecordsActivity;

Class Tweet extends Model
{
  use RecordsActivity;
}

Details

This package is supposed to be a sort of drop-in addition to your code base for tracking when a user is performing any model events you want. The information is stored in a table, activities, and an Activity model is also provided for accessing that information.

Customizing Processed Events

By default, created, updated, and deleted events are persisted to the table. You can change which events are processed by adding a static property to the model you have added the trait to:

    
	Class Tweet extends Model
    {
        use RecordsActivity;
        
        /**
		 * Which events to record for the auth'd user.
		 *
		 * @var array
		 */
        protected static $recordEvents = ['created'];
    }