aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-03-08 02:57:48 +0000
committerbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-03-08 02:57:48 +0000
commit1900eedee2f8d2fa729a01293238c2ad85fb4147 (patch)
tree2aa2909bff6a765b508b656990c024aebd7bbf22
parent4a2316cc0620839f2ffe99054b488716d59b92f0 (diff)
downloadelgg-1900eedee2f8d2fa729a01293238c2ad85fb4147.tar.gz
elgg-1900eedee2f8d2fa729a01293238c2ad85fb4147.tar.bz2
Added a bit more docs to ElggBatch.
git-svn-id: http://code.elgg.org/elgg/trunk@8625 36083f99-b078-4883-b0ff-0f9b5a30f544
-rw-r--r--engine/classes/ElggBatch.php2
1 files changed, 2 insertions, 0 deletions
diff --git a/engine/classes/ElggBatch.php b/engine/classes/ElggBatch.php
index 5c2172ae7..5b4132db4 100644
--- a/engine/classes/ElggBatch.php
+++ b/engine/classes/ElggBatch.php
@@ -11,6 +11,8 @@
* can be a string, an array, or a closure.
* {@link http://php.net/manual/en/language.pseudo-types.php}
*
+ * The callback function must accepts 3 arguments: an entity, the getter used, and the options used.
+ *
* Results from the callback are stored in callbackResult.
* If the callback returns only booleans callbackResults will be the combined
* result of all calls.