Footprint

This plugin allows you to pass the currently logged in user info to the model layer of a CakePHP application.

It comes bundled with the FootprintBehavior to allow you control over columns such as user_id, created_by, company_id similar to the core's TimestampBehavior.

Install

Using Composer:

composer require muffin/footprint

You then need to load the plugin by running console command:

bin/cake plugin load Muffin/Footprint

The Footprint plugin must be loaded before the Authentication plugin, so you should updated your config/plugins.php or Application::bootstrap() accordingly.

Usage

Middleware

Add the FootprintMiddleware to the middleware queue in your Application::middleware() method:

$middleware->add('Muffin/Footprint.Footprint');

It must be added after AuthenticationMiddleware to ensure that it can read the identify info after authentication is done.

If you don't have direct access to the place where AuthenticationMiddleware is added then check here.

Behavior

To use the included behavior to automatically update the created_by and modified_by fields of a record for example, add the following to your table's initialize() method:

$this->addBehavior('Muffin/Footprint.Footprint');

You can customize that like so:

$this->addBehavior('Muffin/Footprint.Footprint', [
    'events' => [
        'Model.beforeSave' => [
            'user_id' => 'new',
            'company_id' => 'new',
            'modified_by' => 'always'
        ]
    ],
    'propertiesMap' => [
        'company_id' => '_footprint.company.id',
    ],
]);

This will insert the currently logged in user's primary key in user_id and modified_by fields when creating a record, on the modified_by field again when updating the record and it will use the associated user record's company id in the company_id field when creating a record.

You can also provide a closure that accepts an EntityInterface and returns a bool:

$this->addBehavior('Muffin/Footprint.Footprint', [
    'events' => [
        'Model.beforeSave' => [
            'user_id' => 'new',
            'company_id' => 'new',
            'modified_by' => 'always',
            'deleted_by' => function ($entity): bool {
                return $entity->deleted !== null;
            },
        ]
    ],
]);

Adding middleware via event

In some cases you don't have direct access to the place where the AuthenticationMiddleware is added. Then you will have to add this to your src/Application.php

use Authentication\Middleware\AuthenticationMiddleware;
use Cake\Event\EventInterface;
use Cake\Http\MiddlewareQueue;
use Muffin\Footprint\Middleware\FootprintMiddleware;

// inside the bootstrap() method
$this->getEventManager()->on(
    'Server.buildMiddleware',
    function (EventInterface $event, MiddlewareQueue $middleware) {
        $middleware->insertAfter(AuthenticationMiddleware::class, FootprintMiddleware::class);
    }
);

Patches & Features

• Fork
• Mod, fix
• Test - this is important, so it's not unintentionally broken
• Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
• Pull request - bonus point for topic branches

Bugs & Feedback

https://github.com/usemuffin/footprint/issues

License

Copyright (c) 2015-Present, Use Muffin and licensed under The MIT License.