PHPackages iamthom/audit-log - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Logging & Monitoring](/categories/logging) 4. / 5. iamthom/audit-log ActiveCakephp-plugin[Logging & Monitoring](/categories/logging) iamthom/audit-log ================= Logging Plugin for CakePHP 02.9k↓33.3%1PHP Since Apr 7Pushed 9y ago1 watchersCompare [ Source](https://github.com/iamthom/Audit-Log)[ Packagist](https://packagist.org/packages/iamthom/audit-log)[ RSS](/packages/iamthom-audit-log/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) Audit Log Plugin ================ [](#audit-log-plugin) A logging plugin for [CakePHP](http://cakephp.org). The included `AuditableBehavior` creates an audit history for each instance of a model to which it's attached. The behavior tracks changes on two levels. It takes a snapshot of the fully hydrated object *after* a change is complete and it also records each individual change in the case of an update action. Features -------- [](#features) - Support for CakePHP 2.0. Thanks, @jasonsnider. - Tracks object snapshots as well as individual property changes. - Allows each revision record to be attached to a source -- usually a user -- of responsibility for the change. - Allows developers to ignore changes to specified properties. Properties named `created`, `updated` and `modified` are ignored by default, but these values can be overwritten. - Handles changes to HABTM associations. - Fully compatible with the [`PolymorphicBehavior`](http://bakery.cakephp.org/articles/view/polymorphic-behavior). - Does not require or rely on the existence of explicit models revisions (`AuditLog`) and deltas (`AuditLogDeltas`). Installation ------------ [](#installation) ### CakePHP >= 2.0 [](#cakephp--20) #### As an Archive [](#as-an-archive) 1. Click the big ol' **Downloads** button next to the project description. 2. Extract the archive to `app/Plugin/AuditLog`. #### As a Submodule [](#as-a-submodule) 1. `$ git submodule add git://github.com/robwilkerson/CakePHP-Audit-Log-Plugin.git /app/Plugin/AuditLog` 2. `$ git submodule init` 3. `$ git submodule update` To create tables you can use schema shell. To create tables execute: ``` cd /app/ chmod +x ./Console/cake ./Console/cake schema create -p AuditLog ``` ### CakePHP 1.3.x [](#cakephp-13x) For use with CakePHP 1.3.x, be sure to use code from the `1.3` branch and follow the instructions in that README file. ### Next Steps [](#next-steps) 1. Run the `install.sql` file on your CakePHP application database. This will create the `audits` and `audit_deltas` tables that will store each object's relevant change history. 2. Create a `currentUser()` method, if desired. The `AuditableBehavior` optionally allows each changeset to be "owned" by a "source" -- typically the user responsible for the change. Since user and authentication models vary widely, the behavior supports a callback method that should return the value to be stored as the source of the change, if any. The `currentUser()` method must be available to every model that cares to track a source of changes, so I recommend that a copy of CakePHP's `app_model.php` file be created and the method added there. Keep it DRY, right? Storing the changeset source can be a little tricky if the core `Auth` component is being used since user data isn't readily available at the model layer where behaviors lie. One option is to forward that data from the controller. One means of doing this is to include the following code in `AppController::beforeFilter()`: ``` if( !empty( $this->data ) && empty( $this->data[$this->Auth->userModel] ) ) { $this->data[$this->Auth->userModel] = $this->currentUser(); } ``` The behavior expects the `currentUser()` method to return an associative array with an `id` key. Continuing from the example above, the following code might appear in the `AppModel`: ``` protected function currentUser() { $user = $this->Auth->user(); return $user[$this->Auth->userModel]; # Return the complete user array } ``` 3. Attach the behavior to any desired model and configure. Usage ----- [](#usage) Applying the `AuditableBehavior` to a model is essentially the same as applying any other CakePHP behavior. The behavior does offer a few configuration options: `ignore` An array of property names to be ignored when records are created in the deltas table. `habtm` An array of models that have a HABTM relationship with the acting model and whose changes should be monitored with the model. If the HABTM model is auditable in its own right, don't include it here. This option is for related models whose changes are \_only\_ tracked relative to the acting model.### Syntax [](#syntax) ``` # Simple syntax accepting default options class Task extends AppModel { public $actsAs = array( 'AuditLog.Auditable' ); # # Additional model code. # } # Syntax with explicit options class Task extends AppModel { public $actsAs = array( 'AuditLog.Auditable' => array( 'ignore' => array( 'active', 'name', 'updated' ), 'habtm' => array( 'Type', 'Project' ) ) ); # # Additional model code. # } ``` Limitations ----------- [](#limitations) - The master branch is not backwards compatible with CakePHP <=1.3.x. If you need compatibility with these version please install the code from the `1.3` branch and follow the instructions in that README. License ------- [](#license) This code is licensed under the [MIT license](http://www.opensource.org/licenses/mit-license.php). Notes ----- [](#notes) Feel free to submit bug reports or suggest improvements in a ticket or fork this project and improve upon it yourself. Contributions welcome. ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity21 Limited adoption so far Community17 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/d6cf33276c0691b0c698000e4bd66867a7840ca64ad46049f487618fd00a6032?d=identicon)[iamthom](/maintainers/iamthom) --- Top Contributors [![ravage84](https://avatars.githubusercontent.com/u/625761?v=4)](https://github.com/ravage84 "ravage84 (62 commits)")[![robwilkerson](https://avatars.githubusercontent.com/u/7735?v=4)](https://github.com/robwilkerson "robwilkerson (42 commits)")[![jasonsnider](https://avatars.githubusercontent.com/u/209596?v=4)](https://github.com/jasonsnider "jasonsnider (14 commits)")[![iamthom](https://avatars.githubusercontent.com/u/5789364?v=4)](https://github.com/iamthom "iamthom (4 commits)")[![wuilliam321](https://avatars.githubusercontent.com/u/236566?v=4)](https://github.com/wuilliam321 "wuilliam321 (4 commits)")[![inigoflores](https://avatars.githubusercontent.com/u/5518087?v=4)](https://github.com/inigoflores "inigoflores (4 commits)")[![wewilkinson](https://avatars.githubusercontent.com/u/4845490?v=4)](https://github.com/wewilkinson "wewilkinson (2 commits)")[![paulleephp](https://avatars.githubusercontent.com/u/2199146?v=4)](https://github.com/paulleephp "paulleephp (1 commits)")[![CpuID](https://avatars.githubusercontent.com/u/916201?v=4)](https://github.com/CpuID "CpuID (1 commits)")[![jlpuder](https://avatars.githubusercontent.com/u/5078486?v=4)](https://github.com/jlpuder "jlpuder (1 commits)")[![chrisjohnson](https://avatars.githubusercontent.com/u/178144?v=4)](https://github.com/chrisjohnson "chrisjohnson (1 commits)")[![ptica](https://avatars.githubusercontent.com/u/169873?v=4)](https://github.com/ptica "ptica (1 commits)")[![rchavik](https://avatars.githubusercontent.com/u/39490?v=4)](https://github.com/rchavik "rchavik (1 commits)") ### Embed Badge ![Health badge](/badges/iamthom-audit-log/health.svg) ``` [![Health](https://phpackages.com/badges/iamthom-audit-log/health.svg)](https://phpackages.com/packages/iamthom-audit-log) ``` ### Alternatives [psr/log Common interface for logging libraries 10.4k1.2B9.2k](/packages/psr-log)[itsgoingd/clockwork php dev tools in your browser 5.9k27.6M94](/packages/itsgoingd-clockwork)[graylog2/gelf-php A php implementation to send log-messages to a GELF compatible backend like Graylog2. 41838.2M138](/packages/graylog2-gelf-php)[bugsnag/bugsnag-psr-logger Official Bugsnag PHP PSR Logger. 32132.5M2](/packages/bugsnag-bugsnag-psr-logger)[consolidation/log Improved Psr-3 / Psr\\Log logger based on Symfony Console components. 15462.2M7](/packages/consolidation-log)[datadog/php-datadogstatsd An extremely simple PHP datadogstatsd client 19124.6M15](/packages/datadog-php-datadogstatsd) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)