dmyers/laravel-activity

A simple activity feed package for Laravel 4.

Activity Package for Laravel 4

Activity is a activity/news feed system for Laravel 4 applications., _(*1)

Installation via Composer

Add this to you composer.json file, in the require object:, _(*2)

"dmyers/laravel-activity": "dev-master"

After that, run composer install to install Activity., _(*3)

Add the service provider to app/config/app.php, within the providers array., _(*4)

'providers' => array(
    // ...
    'Dmyers\Activity\ActivityServiceProvider',
)

Add a class alias to app/config/app.php, within the aliases array., _(*5)

'aliases' => array(
    // ...
    'Activity' => 'Dmyers\Activity\Activity',
)

Publish the package's model, migration, and view., _(*6)

php artisan model:publish dmyers/laravel-activity
php artisan migration:publish dmyers/laravel-activity
php artisan view:publish dmyers/laravel-activity

Finally, add the trait to the models you want to track activity on., _(*7)

use ActivityTrait;

protected $activity_item_field = 'id';

protected $activity_doer_field = 'user_id';

protected $activity_events = array('created', 'updated', 'deleted');

protected $activity_feed_type = 'user';

Usage

First get an instance of an item type (model):, _(*8)

$object = Model::find(1);

Fetch all the activity:, _(*9)

$object->activity(array(
    'id'        => $activity_id, // optional
    'doer_id'   => $doer_id, // optional
    'victim_id' => $victim_id, // optional
    'item_id'   => $item_id, // optional
    'item_type' => $item_type, // optional
    'feed_type' => $feed_type, // optional
));

Track an activity event:, _(*10)

$object->addActivity($item_type, $doer_id, $victim_id, $action);

Update an activity event:, _(*11)

$object->updateActivity($item_type, $doer_id, $victim_id, $action);

Delete an activity event:, _(*12)

$object->deleteActivity($item_type, $doer_id, $victim_id, $action);

Display an activity feed:, _(*13)

$object->renderActivityFeed($type, $doer_id, $victim_id);

Push a feed into another activity feed:, _(*14)

$object->pushActivityFeed($type, $doer_id, $victim_id);