tatter/audits

Lightweight object logging for CodeIgniter 4

v1.0.3 2019-07-03 15:43 UTC

This package is auto-updated.

Last update: 2019-12-12 19:41:25 UTC


README

Lightweight object logging for CodeIgniter 4

Quick Start

  1. Install with Composer: > composer require tatter/audits
  2. Update the database: > php spark migrate -all
  3. Setup your models:
class JobModel extends Model
{
	use \Tatter\Audits\Traits\AuditsTrait;
	protected $afterInsert = ['auditInsert'];
	protected $afterUpdate = ['auditUpdate'];
	protected $afterDelete = ['auditDelete'];
  1. All done!

Features

Provides ready-to-use object logging for CodeIgniter 4

Installation

Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities and always be up-to-date:

  • > composer require tatter/audits

Or, install manually by downloading the source files and adding the directory to app/Config/Autoload.php.

Once the files are downloaded and included in the autoload, run any library migrations to ensure the database is setup correctly:

  • > php spark migrate -all

Pro Tip: You can add the spark command to your composer.json to ensure your database is always current with the latest release:

{
	...
    "scripts": {
        "post-update-cmd": [
            "composer dump-autoload",
            "php spark migrate -all"
        ]
    },
	...

Configuration (optional)

The library's default behavior can be altered by extending its config file. Copy bin/Audits.php to app/Config/Audits.php and follow the instructions in the comments. If no config file is found in app/Config the library will use its own.

Usage

Once the library is included all the resources are ready to go and you just need to specify which models and events to audit. Use AuditsTrait to add support to any models you would like tracked:

class JobModel extends Model
{
	use \Tatter\Audits\Traits\AuditsTrait;

Then specify which events you want audited by assigning the corresponding audit methods for those events:

	protected $afterInsert = ['auditInsert'];
	protected $afterUpdate = ['auditUpdate'];
	protected $afterDelete = ['auditDelete'];

The Audits library will create basic logs of each event in the audits table, for example:

| id | source | source_id | user_id | event  | summary  |          created_at |
+----+--------+-----------+---------+--------+----------+---------------------+
| 10 | sites  |        27 |       9 | create | 2 rows   | 2019-04-05 15:58:40 |
| 11 | jobs   |        10 |       9 | update | 5 rows   | 2019-04-05 16:01:35 |