elstc / cakephp-activity-logger
ActivityLogger plugin for CakePHP
Installs: 7 556
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 4
Forks: 4
Open Issues: 3
Type:cakephp-plugin
Requires
- php: >=8.1
- ext-json: *
- ext-pdo: *
- cakephp/cakephp: ^5.0
- psr/log: ^3.0
Requires (Dev)
- cakephp/authentication: ^3.0
- cakephp/cakephp-codesniffer: ^5.0
- cakephp/migrations: ^4.0
- phpunit/phpunit: ^10.1
This package is auto-updated.
Last update: 2024-11-06 03:13:54 UTC
README
Installation
You can install this plugin into your CakePHP application using composer.
The recommended way to install composer packages is:
composer require elstc/cakephp-activity-logger:^3.0
Load plugin
Load the plugin by adding the following statement in your project's src/Application.php
:
$this->addPlugin('Elastic/ActivityLogger');
Create activity_logs table
run migration command:
bin/cake migrations migrate -p Elastic/ActivityLogger
Usage
Attach to Table
class ArticlesTable extends Table { public function initialize(array $config): void { // ... $this->addBehavior('Elastic/ActivityLogger.Logger', [ 'scope' => [ 'Articles', 'Authors', ], ]); } }
Activity Logging Basis
logging on create
$artice = $this-Articles->newEnity([ /* ... */ ]); $this->Articles->save($artice); // saved log // [action='create', scope_model='Articles', scope_id=$article->id]
logging on update
$artice = $this-Articles->patchEnity(artice, [ /* ... */ ]); $this->Articles->save($artice); // saved log // [action='update', scope_model='Articles', scope_id=$article->id]
logging on delete
$artice = $this-Articles->get($id); $this->Articles->delete($artice); // saved log // [action='delete', scope_model='Articles', scope_id=$article->id]
Activity Logging with Issuer
$this->Articles->setLogIssuer($author); // Set issuer $artice = $this-Articles->newEnity([ /* ... */ ]); $this->Articles->save($artice); // saved log // [action='create', scope_model='Articles', scope_id=$article->id, ...] // and // [action='create', scope_model='Auhtors', scope_id=$author->id, ...]
AutoIssuerComponent
If you using Authorization
plugin or AuthComponent
, the AutoIssuerComponent
will help set issuer to Tables.
// In AppController class AppController extends Controller { public function initialize(): void { // ... $this->loadComponent('Elastic/ActivityLogger.AutoIssuer', [ 'userModel' => 'Users', ]); // ... } }
If there is load to any Table class before the execution of Controller.startup
event,
please describe initializedTables
option.
eg:
// In AppController class AppController extends Controller { public function initialize(): void { $this->loadModel('Articles'); $this->loadModel('Awesome.Favorites'); // ... $this->loadComponent('Elastic/ActivityLogger.AutoIssuer', [ 'userModel' => 'Users', 'initializedTables' => [ 'Articles', 'Awesome.Favorites', ], ]); // ... } }
Activity Logging with Scope
class CommentsTable extends Table { public function initialize(array $config): void { // ... $this->addBehavior('Elastic/ActivityLogger.Logger', [ 'scope' => [ 'Articles', 'Authors', 'Users', ], ]); } }
$this->Comments->setLogScope([$user, $article]); // Set scope $comment = $this-Comments->newEnity([ /* ... */ ]); $this->Comments->save($comment); // saved log // [action='create', scope_model='Users', scope_id=$article->id, ...] // and // [action='create', scope_model='Articles', scope_id=$author->id, ...]
Activity Logging with message
use setLogMessageBuilder
method. You can generate any message for each action in the log.
class ArticlesTable extends Table { public function initialize(array $config): void { // ... $this->addBehavior('Elastic/ActivityLogger.Logger', [ 'scope' => [ 'Articles', 'Authors', ], ]); // ADD THIS $this->setLogMessageBuilder(static function (ActivityLog $log, array $context) { if ($log->message !== null) { return $log->message; } $message = ''; $object = $context['object'] ?: null; $issuer = $context['issuer'] ?: null; switch ($log->action) { case ActivityLog::ACTION_CREATE: $message = sprintf('%3$s created #%1$s: "%2$s"', $object->id, $object->title, $issuer->username); break; case ActivityLog::ACTION_UPDATE: $message = sprintf('%3$s updated #%1$s: "%2$s"', $object->id, $object->title, $issuer->username); break; case ActivityLog::ACTION_DELETE: $message = sprintf('%3$s deleted #%1$s: "%2$s"', $object->id, $object->title, $issuer->username); break; default: break; } return $message; }); } }
Or use setLogMessage
before save|delete action. You can set a log message.
$this->Articles->setLogMessage('Custom Message'); $this->Articles->save($entity); // saved log // [action='update', 'message' => 'Custom Messages', ...]
Save Custom Log
$this->Articles->activityLog(\Psr\Log\LogLevel::NOTICE, 'Custom Messages', [ 'action' => 'custom', 'object' => $artice, ]); // saved log // [action='custom', 'message' => 'Custom Messages', scope_model='Articles', scope_id=$article->id, ...]
Find Activity Logs
$logs = $this->Articles->find('activity', ['scope' => $article]);