added documentation to new river views and improved handling of responses

diff --git a/views/default/river/elements/body.php b/views/default/river/elements/body.php
index 6199e086188dd7e5d7abbc7b052447e629717337..f7a9d242602994628d2a1bb11ef796b477f85105 100644 (file)
--- a/views/default/river/elements/body.php
+++ b/views/default/river/elements/body.php
@@ -2,7 +2,11 @@
 /**
  * Body of river item
  *
- * @uses $vars['item']
+ * @uses $vars['item']        ElggRiverItem
+ * @uses $vars['summary']     Alternate summary (the short text summary of action)
+ * @uses $vars['message']     Optional message (usually excerpt of text)
+ * @uses $vars['attachments'] Optional attachments (displaying icons or other non-text data)
+ * @uses $vars['responses']   Alternate respones (comments, replies, etc.)
  */
 
 $item = $vars['item'];
@@ -36,10 +40,7 @@ if ($attachments !== false) {
        $attachments = "<div class=\"elgg-river-attachments\">$attachments</div>";
 }
 
-$responses = elgg_extract('responses', $vars, false);
-if ($responses === false) {
-       $responses = elgg_view('river/elements/responses', $vars);
-}
+$responses = elgg_view('river/elements/responses', $vars);
 if ($responses) {
        $responses = "<div class=\"elgg-river-responses\">$responses</div>";
 }

diff --git a/views/default/river/elements/responses.php b/views/default/river/elements/responses.php
index f1e79f131f6a6e0b38d957f2111be331d684d040..8c5be6316e9e92305d5bbb3bb52bbf6f89b3228f 100644 (file)
--- a/views/default/river/elements/responses.php
+++ b/views/default/river/elements/responses.php
@@ -1,8 +1,18 @@
 <?php
 /**
  * River item footer
+ *
+ * @uses $vars['item'] ElggRiverItem
+ * @uses $vars['responses'] Alternate override for this item
  */
 
+// allow river views to override the response content
+$responses = elgg_extract('responses', $vars, false);
+if ($responses) {
+       echo $responses;
+       return true;
+}
+
 $item = $vars['item'];
 $object = $item->getObjectEntity();
 

diff --git a/views/default/river/elements/summary.php b/views/default/river/elements/summary.php
index eee8754e259c4a28db076eaac065e7afdcc72f38..4d80c29a69d448be3b3f7b8e9303f890ade09cfa 100644 (file)
--- a/views/default/river/elements/summary.php
+++ b/views/default/river/elements/summary.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Short summary of the action that occurred
+ *
+ * @vars['item'] ElggRiverItem
+ */
 
 $item = $vars['item'];