Download the PHP package muffin/footprint without Composer
On this page you can find all versions of the php package muffin/footprint. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download muffin/footprint
More information about muffin/footprint
Files in muffin/footprint
Package footprint
Short Description CakePHP plugin to allow passing currently logged in user to model layer
License MIT
Homepage https://github.com/usemuffin/footprint
Informations about the package footprint
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:
You then need to load the plugin by running console command:
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:
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:
You can customize that like so:
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:
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
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.