muffin/footprint

CakePHP plugin to allow passing currently logged in user to model layer

Installs: 205 029

Dependents: 5

Suggesters: 0

Security: 0

Stars: 76

Watchers: 10

Forks: 20

Type:cakephp-plugin

2.0.0 2020-09-12 07:36 UTC

This package is auto-updated.

Last update: 2020-09-12 07:37:33 UTC


README

Build Status Coverage Total Downloads License

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

Usage

Trait

First, you will need to include the Muffin\Footprint\Auth\FootprintAwareTrait to your AppController:

use Muffin\Footprint\Auth\FootprintAwareTrait;

class AppController extends Controller
{
    use FootprintAwareTrait;

    // Specify the user model if required. Defaults to "Users".
    $this->_userModel = 'YourPlugin.Members';
}

This will attach the Muffin\Footprint\Event\FootprintListener to models which will inject the currently logged in user's instance on Model.beforeSave and Model.beforeFind in the _footprint key of $options.

Your controller needs to have either cakephp/authentication plugin's AuthenticationComponent or CakePHP core's deprecated AuthComponent loaded so that the user identity can be fetched.

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.

Warning

If you have the FootprintBehavior attached to a model do not load the model inside Controller::initialize() method directly or indirectly. If you do so the footprint (user entity) won't be set for the model and the behavior won't work as expected. You can load your model in Controller::beforeFilter() if needed.

This is because the FootprintListener which sets the user entity to the models is attached after Controller::initialize() is run.

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

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

License

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