mvpasarel / activity-log-saas
A clean and simple Laravel 4 activity logger for monitoring user activity on a SaaS application.
Requires
- php: >=5.3.0
- illuminate/database: 4.x
- illuminate/support: 4.x
This package is not auto-updated.
Last update: 2024-11-19 04:03:16 UTC
README
A clean and simple Laravel 4 activity logger for monitoring user activity on a website or web application adapted for multi tenacity.
Installation
Basic installation, service provider registration, and aliasing:
To install ActivityLog, make sure "mvpasarel/activity-log-saas" has been added to Laravel 4's composer.json file.
"require": {
"mvpasarel/activity-log-saas": "dev-master"
},
Then run php composer.phar update from the command line. Composer will install the ActivityLog package. Now, all you have to do is register the service provider, set up ActivityLog's alias in app/config/app.php, Add this to the providers array:
'Mvpasarel\ActivityLogSaaS\ActivityLogSaaSServiceProvider',
And add this to the aliases array:
'Activity' => 'Mvpasarel\ActivityLogSaaS\Activity',
Run the migrations and seed the database:
To run the database migrations (a single DB table), run the following from the command line:
php artisan migrate --package=mvpasarel/activity-log-saas
Publishing config file:
If you wish to customize the configuration of ActivityLog, you will need to publish the config file. Run this from the command line:
php artisan config:publish mvpasarel/activity-log-saas
You will now be able to edit the config file in app/config/packages/mvpasarel/activity-log-saas.
Basic Usage
Logging user activity:
Activity::log([
'userID' => Sentry::getUser()->id,
'contentID' => $userId,
'contentType' => 'User',
'action' => UserObserver::ACTION_LOGGEDIN,
'description' => UserObserver::ACTION_LOGGEDIN,
'details' => '',
'updated' => true,
]);
The above code will log an activity for the currently logged in user. The IP address will automatically be saved as well and the "developer" flag will be set if the user has a "developer" session variable set to true. This can be used to differentiate activities between the developer and the website administrator.