Log Additional HABTM data #110
Conversation
Feature discussion ref: robwilkerson#109 Added: * additinal config settings - ``ignoreDeep``: boolean; used to ignore specified properties in `ignore` array from HABTM and join table data - ``deepLog``: boolean/Array; used to log all/specified properties of HABTM and join table data Edited: * _getModelData() function - manipulate log data according to config new settings * afterSave() function - `json_encode()` new/old values of a property if deepLog is configured
| @@ -115,7 +115,9 @@ This will create the `audits` and `audit_deltas` tables that will store each obj | |||
| 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. | |||
| - ``ignoreDeep`` Boolean `true`/`false` to ignore the above array of property names in **HABTM** and **join table** when records are created in deltas table. Defaults to false. If a property name exists in `ignore` as well as `deepLog`, it will still be ignored. | |||
There was a problem hiding this comment.
I don't think we need that.
The whole HABTM thing is already an edge case use and two (or better said three) configuration settings for just that is too much.
There was a problem hiding this comment.
Yeah, I know. It is not used unless explicitly set to true. Just thought it would matter if you are desperate to limit the size of logged HABTM data, like I do. It seems I just overthought this, I could easily use deepLog to control it anyway (except that it will not ignore any properties of join table, which was my target here).
| // Grab just the ID values and sort those. | ||
| $habtmIds = array_values($habtmIds); | ||
| sort($habtmIds); | ||
| // Grab just the ID values and sort those. |
There was a problem hiding this comment.
Too much indentation for the next three lines.
| - ``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. | ||
| - ``deepLog`` Boolean or Array of property names. Defaults to false. `true` will log all properties of **HABTM** and **join table**. Array form can be used like ``array('habtmField1', 'habtmField2', 'habtmField3', 'joinTableClassName')``, this is especially useful when you want to log detailed HABTM association with `unique` key set to `true`/`keepExisting` (check [docs](http://book.cakephp.org/2.0/en/models/associations-linking-models-together.html#hasandbelongstomany-habtm)) |
| @@ -146,7 +148,9 @@ class AnotherModel extends AppModel { | |||
| public $actsAs = array( | |||
| 'AuditLog.Auditable' => array( | |||
| 'ignore' => array('active', 'name', 'updated'), | |||
| 'ignoreDeep' => true, | |||
There was a problem hiding this comment.
See above about ignoreDeep.
| } | ||
| } | ||
|
|
||
| if ($this->settings[$Model->alias]['ignoreDeep']) { |
There was a problem hiding this comment.
See below about ignoreDeep.
| '{n}.id', | ||
| '{n}.id' | ||
| ); | ||
| if (isset($this->settings[$Model->alias]['deepLog']) && $this->settings[$Model->alias]['deepLog']) { |
There was a problem hiding this comment.
Can we extract that part into a protected method, something with "deepLog"? Methods are already way too long.
| if (isset($this->settings[$Model->alias]['deepLog']) && $this->settings[$Model->alias]['deepLog']) { | ||
| $habtmData = $data[$habtmModel]; | ||
| if (is_array($this->settings[$Model->alias]['deepLog']) && !empty($this->settings[$Model->alias]['deepLog'])) { | ||
| // keep selected HABTM fields only |
There was a problem hiding this comment.
Nitpicking: Upper Case for the first letter after //
There was a problem hiding this comment.
Started sounding like a mod on http://english.stackexchange.com 😆 Will look into your recommendations.
|
|
||
| $auditData[$Model->alias][$habtmModel] = implode(',', $habtmIds); | ||
| $auditData[$Model->alias][$habtmModel] = implode(',', $habtmIds); |
Feature discussion ref: #109
Added:
additinal config settings
ignoreDeep: boolean; used to ignore specified properties inignorearray from HABTM and join table datadeepLog: boolean/Array; used to log all/specified properties of HABTM and join table dataEdited:
_getModelData()functionafterSave()functionjson_encode()new/old values of a property if deepLog is configured