Browse Source

Add docs for return false case.

Mark Story 8 years ago
parent
commit
f843df1831
1 changed files with 4 additions and 0 deletions
  1. 4 0
      src/ORM/Behavior/CounterCacheBehavior.php

+ 4 - 0
src/ORM/Behavior/CounterCacheBehavior.php

@@ -63,6 +63,7 @@ use RuntimeException;
  *
  * Counter cache using lambda function returning the count
  * This is equivalent to example #2
+ *
  * ```
  * [
  *     'Users' => [
@@ -77,6 +78,9 @@ use RuntimeException;
  * ]
  * ```
  *
+ * When using a lambda function you can return `false` to disable updating the counter value
+ * for the current operation.
+ *
  * Ignore updating the field if it is dirty
  * ```
  * [