Simple logs

A simple system for handling logs with a templat system. The simplest log is action log. He has not any parms. The only one is that the user has refreshed the page.

Usage example

use Dframe\ActivityLog\Activity;
use Dframe\ActivityLog\Demo\Drivers\FileLog;

require_once __DIR__ . '/../../vendor/autoload.php';

$log = (new Activity(new FileLog()));
$log->log('Hello Word!')->entity(\Dframe\ActivityLog\Demo\Entity\Action::class)->push();

PSR-3 Adapter

use Dframe\ActivityLog\Activity;
use Dframe\ActivityLog\Demo\Drivers\PSR3FileLog;
use Dframe\ActivityLog\Helper\Psr3Adapter;
use Psr\Log\LogLevel;

require_once __DIR__ . '/../../vendor/autoload.php'; 

$log = new Activity(new PSR3FileLog());

$logger = new Psr3Adapter($log, 'System', \Dframe\ActivityLog\Entity\PSR3::class);
$logger->log(LogLevel::ERROR, 'This is {error}', ['error' => 'error #500']);

Template

First we need an interpreter, that we include in file app/Libs/Extensions/ActivityLog/Action.php

namespace Libs\Extensions\ActivityLog;

class Action
{

    /**
     * Action constructor.
     */
    public function __construct()
    {
        return $this;
    } 

}

Next, we can write first log.

$this->activity->log('Refresh Page')->entity('\Libs\Extensions\ActivityLog\Action'))->push();

Logs with parms

Now, try to make a log with some parms. However before begin, we have to have appropriate Interpreter.

namespace Libs\Extensions\ActivityLog;

class Change
{
    /**
     * @var array
     */
    public $interpreter;

    /**
     * @var array
     */
    public $changes;

    /**
     * @param $key
     *
     * @return mixed
     */
    public function interpreter($key)
    {
        $this->interpreter = [
            'users' => ['id', 'first_name', 'last_name']
        ];

        return $this->interpreter[$key];
    }

    /**
     * @param $before
     * @param $after
     *
     * @return $this
     * @throws \Exception
     */
    public function build($before, $after)
    {

        if (!empty(array_diff_key($before, $after))) {
            throw new \Exception("Keys in array MUST be same", 1);
        }

        foreach ($after as $key => $value) {
            if ($before[$key] == $value) {
                unset($before[$key]);
                unset($after[$key]);
            }
        }

        $this->changes = ['before' => $before, 'after' => $after];
        return $this;
    }

}

Foregoing interpreter is able to logs 3 parms (id, firstname and lastname). It is important to read if we want to log more informations, just put more parms.

$before = [
    'first_name' => 'Before Change'
];

$after = [
    'first_name' => 'After Change'
];

$dataId = '1';
$this->activity->log('Update Data')->entity('\Libs\Extensions\ActivityLog\Change', [$before, $after])->on('data.id',
   $dataId)->push();