From 6d8487ecf2aed50ce93a3c6ec31d66894a5a2514 Mon Sep 17 00:00:00 2001 From: Alban Jubert Date: Tue, 11 Sep 2018 11:19:12 +0200 Subject: [PATCH] Updated Readme --- CHANGELOG.md | 1 + README.md | 14 +++++++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f367f8..ff5c3ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## [1.7.0] (unreleased) ### Added - Enh #42: Add the ability to retrieve old relations values +- Enh #43: Add the ability to retrieve and mark dirty relations ## [1.6.0] ### Fixed diff --git a/README.md b/README.md index d6c2d88..c2a9e07 100644 --- a/README.md +++ b/README.md @@ -287,10 +287,18 @@ Possible constants values are: Get old relations values ------------------------ -To retrieve relations value prior to there most recent modification until the model is saved, you can use: -* `getOldRelation($name)` method: Get a named relation old value. -* `getOldRelations()` method: Get an array of relations index by there name with there old values. +To retrieve relations value prior to there most recent modification until the model is saved, the following methods can be used: +* `getOldRelation($name)`: Get a named relation old value. +* `getOldRelations()`: Get an array of relations index by there name with there old values. > **Notes** > * If a relation has not been modified yet, its initial value will be returned > * Only relations defined in the behavior parameters will be returned + + +Get dirty relations +------------------- +To deal with dirty (modified) relations since the model was loaded, the following methods can be used: +* `getDirtyRelations()`: Get the relations that have been modified since they are loaded (name-value pairs) +* `markRelationDirty($name)`: Mark a relation as dirty even if it's not been modified. +