Added a not explaining how to use the TreeIterator constants instead

cakephp · Apr 6, 2014 · abdb0c3 · abdb0c3
1 parent 4d100c3
commit abdb0c3
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/Collection/CollectionTrait.php b/src/Collection/CollectionTrait.php
@@ -876,6 +876,13 @@ public function compile($preserveKeys = true) {
  * Finally, you can specify to only get a collection with the leaf nodes in the
  * tree structure. You do so by passing 'leaves' in the first argument.
  *
+ * The possible values for the first argument are aliases for the following
+ * constants and it is valid to pass those instead of the alias:
+ *
+ * - desc: TreeIterator::SELF_FIRST
+ * - asc: TreeIterator::CHILD_FIRST
+ * - leaves: TreeIterator::LEAVES_ONLY
+ *
  * ### Example:
  *
  * {{{