amol/reactiveci4

Activity logger for Codeigniter 4

v1.0.2 2022-12-17 19:36 UTC

Requires (Dev)

• codeigniter4/devkit: dev-develop
• codeigniter4/framework: ^4.2.3

MIT

• amol

• log
• codeigniter
• activity
• reactive
• codeigniter4

README

The amol/reactiveci4 helps to log activities of user in your website easily. It stores all activities in database table activity. It helps to boost your work speed.

Features

1. Easy setup.
2. Use Codeigniter Models.
3. Easy to use.

Basic Example

helper('reactive');
reactive($user, "You updated the profile");

Advanced Example using Class

use Amol\ReactiveCi4\Reactive;

$userModel = model('App\Models\UserModel');
$user = $userModel->find(1);
$properties = [
    "ip" => "127.0.0.1"
];
$label = "profile review"

$record = new Reactive();
$record->log($user, "admin changed user's profile photo", $admin, $properties, $label);

Installation

you can install the package via composer.

composer require amol/reactiveci4

After installing. run spark command

php spark reactive:setup

it will create Reactive config and Activity model file. it also migrate activity table.

Documentation and Examples

Class Reactive

has function log

public function log(object $subject, string $text, object $causer=null,array $properties=[], string $label=null ): id|false

Helper

It also provides helper

function reactive(object $subject, string $text, object $causer=null,array $properties=[], string $label=null )

return id of activity instance or false on failure.

Activity Model

You can use model to retrieve data from activity table and also do crud operations with it. You can also customize the model.

Label

Label used to categories the record in different groups. You can change its default value using config file.

Full documentation and Examples

Coming soon

Bugs & Issues

If you find any bugs. Dont hesitate to create a issue.

Contributing

Please see CONTRIBUTING for details.