aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorben <ben@36083f99-b078-4883-b0ff-0f9b5a30f544>2009-02-20 09:36:41 +0000
committerben <ben@36083f99-b078-4883-b0ff-0f9b5a30f544>2009-02-20 09:36:41 +0000
commit6af33c4fbb99561472ca5dd7a22b920fda73492c (patch)
treefdd27f44bfa40e345fdae778302f4f62a6c48b60
parent36183fdf69d248265ce249cfaf86c15240ccafcf (diff)
downloadelgg-6af33c4fbb99561472ca5dd7a22b920fda73492c.tar.gz
elgg-6af33c4fbb99561472ca5dd7a22b920fda73492c.tar.bz2
Added some documentation to the river functions.
git-svn-id: https://code.elgg.org/elgg/trunk@2839 36083f99-b078-4883-b0ff-0f9b5a30f544
-rw-r--r--engine/lib/river.php2
-rw-r--r--engine/lib/river2.php14
2 files changed, 16 insertions, 0 deletions
diff --git a/engine/lib/river.php b/engine/lib/river.php
index 4bd4ce8e4..43cf7b57d 100644
--- a/engine/lib/river.php
+++ b/engine/lib/river.php
@@ -2,6 +2,8 @@
/**
* Elgg river.
* Functions for listening for and generating the river out of the system log.
+ *
+ * These functions are no longer used in core Elgg.
*
* @package Elgg
* @subpackage Core
diff --git a/engine/lib/river2.php b/engine/lib/river2.php
index b529e6eff..a08e29dc8 100644
--- a/engine/lib/river2.php
+++ b/engine/lib/river2.php
@@ -224,6 +224,20 @@
return false;
}
+ /**
+ * Returns a human-readable version of the river.
+ *
+ * @param int|array $subject_guid Acting entity to restrict to. Default: all
+ * @param int|array $object_guid Entity being acted on to restrict to. Default: all
+ * @param string $subject_relationship If set to a relationship type, this will use $subject_guid as the starting point and set the subjects to be all users this entity has this relationship with (eg 'friend'). Default: blank
+ * @param string $type The type of entity to restrict to. Default: all
+ * @param string $subtype The subtype of entity to restrict to. Default: all
+ * @param string $action_type The type of river action to restrict to. Default: all
+ * @param int $limit The number of items to retrieve. Default: 20
+ * @param int $posted_min The minimum time period to look at. Default: none
+ * @param int $posted_max The maximum time period to look at. Default: none
+ * @return string Human-readable river.
+ */
function elgg_view_river_items($subject_guid = 0,
$object_guid = 0,
$subject_relationship = '',