https://github.com/UseMuffin/Footprint
CakePHP plugin to allow passing currently logged in user to model layer.
https://github.com/UseMuffin/Footprint
cakephp cakephp-plugin php
Last synced: 7 days ago
JSON representation
CakePHP plugin to allow passing currently logged in user to model layer.
- Host: GitHub
- URL: https://github.com/UseMuffin/Footprint
- Owner: UseMuffin
- License: mit
- Created: 2015-04-25T14:14:03.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-11-18T14:46:18.000Z (over 1 year ago)
- Last Synced: 2025-04-12T13:18:40.302Z (25 days ago)
- Topics: cakephp, cakephp-plugin, php
- Language: PHP
- Homepage:
- Size: 154 KB
- Stars: 95
- Watchers: 8
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cakephp - Muffin/Footprint plugin - Plugin to allow passing currently logged in user to model layer. (Auditing / Logging)
README
# Footprint
[](https://github.com/UseMuffin/Footprint/actions?query=workflow%3ACI+branch%3Amaster)
[](https://codecov.io/github/UseMuffin/Footprint)
[](https://packagist.org/packages/muffin/footprint)
[](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]:
```bash
composer require muffin/footprint
```
You then need to load the plugin by running console command:
```bash
bin/cake plugin load Muffin/Footprint
```
The Footprint plugin must be loaded **before** the [Authentication](https://github.com/cakephp/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:
```php
$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](#adding-middleware-via-event).
### 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:
```php
$this->addBehavior('Muffin/Footprint.Footprint');
```
You can customize that like so:
```php
$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:
```php
$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`
```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
http://github.com/usemuffin/footprint/issues
## License
Copyright (c) 2015-Present, [Use Muffin][muffin] and licensed under [The MIT License][mit].
[cakephp]:http://cakephp.org
[composer]:http://getcomposer.org
[mit]:http://www.opensource.org/licenses/mit-license.php
[muffin]:http://usemuffin.com