jenkins-bot has submitted this change and it was merged.
Change subject: Add clarification comment about PostRevision recursive vars
......................................................................
Add clarification comment about PostRevision recursive vars
Change-Id: I806f1a8e69868c31381a407e95f452c0d20b7245
---
M includes/Model/PostRevision.php
1 file changed, 15 insertions(+), 1 deletion(-)
Approvals:
EBernhardson: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/Model/PostRevision.php b/includes/Model/PostRevision.php
index e04e697..01cc800 100644
--- a/includes/Model/PostRevision.php
+++ b/includes/Model/PostRevision.php
@@ -22,7 +22,21 @@
protected $depth;
/**
- * Variables callback functions & their results will be saved to.
+ * Variables to which callback functions and their results will be
saved.
+ *
+ * We have some functionality to defer recursive processing through the
post
+ * tree up until the moment we actually need to. This makes it possible
to
+ * register multiple callback functions that need to be run
recursively, and
+ * execute them all one once, so we only have to go recursive once.
+ *
+ * Callbacks & initial result value will be saved when calling
+ * $this->registerRecursive(), final result will be saved after calling
+ * $this->descendRecursive().
+ * $this->getRecursiveResult() will return the result in
$recursiveResults.
+ *
+ * @see PostRevision::registerRecursive()
+ * @see PostRevision::getRecursiveResult()
+ * @see PostRevision::descendRecursive()
*
* @var array
*/
--
To view, visit https://gerrit.wikimedia.org/r/108034
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I806f1a8e69868c31381a407e95f452c0d20b7245
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Flow
Gerrit-Branch: master
Gerrit-Owner: Matthias Mullie <[email protected]>
Gerrit-Reviewer: EBernhardson <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
