rajtika/mongovity

Application activity log with mongodb

dev-master 2024-12-02 11:05 UTC

Requires

• jenssegers/mongodb: ^3

MIT

• Jewel Rana

README

Requirements

• jenssegers/laravel-mongodb
• php mongodb extension
• php7.4 or higher

Installation

• composer require rajtika/mongovity
• php artisan vendor:publish --provider="Rajtika\Mongovity\MongovityServiceProvider"

Implementation

• set your mongodb connection and give connection name in the mongovity.php config file
• If you want to log all model activity automatically follow the instructions below

//Add ActivityTrait in you model which you want to log
use Rajtika\Mongovity\Contracts\ActivityTrait;

//You can define specefic events to be logged by
protected $recordEvents = [
    'created',
    'updated',
    'deleted',
    'restored'
];
/** -----------OR--------- **/
protected $loggableEvents = [
    'created',
    'updated',
    'deleted',
    'restored'
];

//If you want to save your custom activity log
use Rajtika\Mongovity\Services\Mongovity; //Use this service

    app(Mongovity::class)
    ->by(Auth::user()) //Required *
    ->on(TestModel::find(1)) // optional
    ->event('created') // optional
    ->log('Your custom message');
    
    /** OR **/
    use Rajtika\Mongovity\Facades\Mongovity; // use this facade
    Mongovity::by(User::first())->log("Custom message");

//If your user table has first_name and last_name you have to use this method to log the user name
public function getNameAttribute()
{
    return $this->first_name . ' ' . $this->last_name;
}

//If your user table has column other than "mobile" you need to add this method
public function getMobileAttribute()
{
    return $this->mobile_number;
}

If you want to give permission to activity log to any user, you must assing role "admin" or assign permission "activity_logs" to that user