2017 © Pedro Peláez
 

library activitylog

A very simple activity logger to monitor the users of your website or application

image

rajuez/activitylog

A very simple activity logger to monitor the users of your website or application

  • Wednesday, May 27, 2015
  • by RajuEz
  • Repository
  • 2 Watchers
  • 1 Stars
  • 50 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 75 Forks
  • 0 Open issues
  • 13 Versions
  • 0 % Grown

The README.md

Log the activity of your users - (Modified for Personnel use)

Latest Version Software License Build Status SensioLabsInsight Total Downloads, (*1)

This Laravel 5 package provides a very easy to use solution to log the activities of the users of your Laravel 5 app. All the activities will be logged in a db-table. Optionally the activities can also be logged against the default Laravel Log Handler., (*2)

Created by Freek Van der Herten (@freekmurze), (*3)

Note:

If you're using Laravel 4, take a look at version 0.3.0 of this package., (*4)

Installation

This package can be installed through Composer., (*5)

composer require spatie/activitylog

This service provider must be registered., (*6)

// config/app.php

'providers' => [
    '...',
    'Spatie\Activitylog\ActivitylogServiceProvider',
];

You'll also need to publish and run the migration in order to create the db-table., (*7)

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="migrations"
php artisan migrate

Activitylog also comes with a facade, which provides an easy way to call it., (*8)

// config/app.php

'aliases' => [
    ...
    'Activity' => 'Spatie\Activitylog\ActivitylogFacade',
];

Optionally you can publish the config file of this package., (*9)

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="config"

The configuration will be written to config/activitylog.php. The options provided are self explanatory., (*10)

Usage

Manual logging

Logging some activity is very simple., (*11)


/* 
  The log-function takes two parameters:
    - $text: the activity you wish to log.
    - $user: optional can be an user id or a user object. 
             if not proved the id of Auth::user() will be used

*/
Activity::log('Some activity that you wish to log');

The string you pass to function gets written in a db-table together with a timestamp, the ip address and the user agent of the user., (*12)

Log model events

This package can log the events from your models. To do so your model must use the LogsActivity-trait and implement LogsActivityInterface., (*13)

use Spatie\Activitylog\LogsActivityInterface;
use Spatie\Activitylog\LogsActivity;

class Article implements LogsActivityInterface {

   use LogsActivity;
...

The interface expects you to implement the getActivityDescriptionForEvent-function., (*14)

Here's an example of a possible implementation., (*15)

/**
 * Get the message that needs to be logged for the given event name.
 *
 * @param string $eventName
 * @return string
 */
public function getActivityDescriptionForEvent($eventName)
{
    if ($eventName == 'created')
    {
        return 'Article "' . $this->name . '" was created';
    }

    if ($eventName == 'updated')
    {
        return 'Article "' . $this->name . '" was deleted';
    }

    if ($eventName == 'deleted')
    {
        return 'Article "' . $this->name . '" was deleted';
    }

    return '';
}

The result of this function will be logged, unless the result is an empty string., (*16)

Retrieving logged entries

All events will be logged in the activity_log-table. This package provides an Eloquent model to work with the table. You can use all the normal Eloquent methods that you know and love. Here's how you can get the last 100 activities together with the associated users., (*17)

use Spatie\Activitylog\Models\Activity;

$latestActivities = Activity::with('user')->latest()->limit(100)->get();

Cleaning up the log

Over time your log will grow. To clean up the database table you can run this command:, (*18)

Activity::cleanLog();

By default records older than 2 months will be deleted. The number of months can be modified in the config-file of the package., (*19)

Contributing

Please see CONTRIBUTING for details., (*20)

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker., (*21)

Credits

License

The MIT License (MIT). Please see License File for more information., (*22)

The Versions

27/05 2015

dev-master

9999999-dev

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Freek Van der Herten

laravel log user activity

27/05 2015

2.0.4

2.0.4.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Freek Van der Herten

laravel log user activity

27/05 2015

2.0.3

2.0.3.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Freek Van der Herten

laravel log user activity

20/04 2015

2.0.2

2.0.2.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Freek Van der Herten

laravel log user activity

16/04 2015

2.0.1

2.0.1.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Freek Van der Herten

laravel log user activity

01/04 2015

2.0.0

2.0.0.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Freek Van der Herten

laravel log user activity

05/02 2015

1.0.1

1.0.1.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

by Freek Van der Herten

laravel log user activity

05/02 2015

1.0.0

1.0.0.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

by Freek Van der Herten

laravel log user activity

26/01 2015

0.3.0

0.3.0.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

by Freek Van der Herten

laravel log user activity

02/06 2014

0.2.1

0.2.1.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

by Freek Van der Herten

laravel log user activity

06/05 2014

0.2.0

0.2.0.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

by Freek Van der Herten

laravel log user activity

06/05 2014

0.1.0

0.1.0.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

by Freek Van der Herten

laravel log user activity

06/05 2014

0.1.1

0.1.1.0

A very simple activity logger to monitor the users of your website or application

  Sources   Download

MIT

The Requires

 

by Freek Van der Herten

laravel log user activity