From 7ddd9521b3f3a397da3b0a6b56238d31414eb4be Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Thu, 28 Oct 2010 19:17:36 +0000
Subject: Standardized code in all of core, not including language files,
 tests, or core mods.

git-svn-id: http://code.elgg.org/elgg/trunk@7124 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/classes/Friendable.php | 39 ++++++++++++++++++++++++++++++---------
 1 file changed, 30 insertions(+), 9 deletions(-)

(limited to 'engine/classes/Friendable.php')

diff --git a/engine/classes/Friendable.php b/engine/classes/Friendable.php
index d400bd092..588f9ec5a 100644
--- a/engine/classes/Friendable.php
+++ b/engine/classes/Friendable.php
@@ -2,12 +2,16 @@
 /**
  * An interface for objects that behave as elements within a social network that have a profile.
  *
+ * @package    Elgg.Core
+ * @subpackage SocialModel.Friendable
  */
 interface Friendable {
 	/**
 	 * Adds a user as a friend
 	 *
 	 * @param int $friend_guid The GUID of the user to add
+	 *
+	 * @return bool
 	 */
 	public function addFriend($friend_guid);
 
@@ -15,12 +19,15 @@ interface Friendable {
 	 * Removes a user as a friend
 	 *
 	 * @param int $friend_guid The GUID of the user to remove
+	 *
+	 * @return bool
 	 */
 	public function removeFriend($friend_guid);
 
 	/**
 	 * Determines whether or not the current user is a friend of this entity
 	 *
+	 * @return bool
 	 */
 	public function isFriend();
 
@@ -28,6 +35,8 @@ interface Friendable {
 	 * Determines whether or not this entity is friends with a particular entity
 	 *
 	 * @param int $user_guid The GUID of the entity this entity may or may not be friends with
+	 *
+	 * @return bool
 	 */
 	public function isFriendsWith($user_guid);
 
@@ -35,6 +44,8 @@ interface Friendable {
 	 * Determines whether or not a foreign entity has made this one a friend
 	 *
 	 * @param int $user_guid The GUID of the foreign entity
+	 *
+	 * @return bool
 	 */
 	public function isFriendOf($user_guid);
 
@@ -42,8 +53,10 @@ interface Friendable {
 	 * Returns this entity's friends
 	 *
 	 * @param string $subtype The subtype of entity to return
-	 * @param int $limit The number of entities to return
-	 * @param int $offset Indexing offset
+	 * @param int    $limit   The number of entities to return
+	 * @param int    $offset  Indexing offset
+	 *
+	 * @return array|false
 	 */
 	public function getFriends($subtype = "", $limit = 10, $offset = 0);
 
@@ -51,8 +64,10 @@ interface Friendable {
 	 * Returns entities that have made this entity a friend
 	 *
 	 * @param string $subtype The subtype of entity to return
-	 * @param int $limit The number of entities to return
-	 * @param int $offset Indexing offset
+	 * @param int    $limit   The number of entities to return
+	 * @param int    $offset  Indexing offset
+	 *
+	 * @return array|false
 	 */
 	public function getFriendsOf($subtype = "", $limit = 10, $offset = 0);
 
@@ -60,17 +75,21 @@ interface Friendable {
 	 * Returns objects in this entity's container
 	 *
 	 * @param string $subtype The subtype of entity to return
-	 * @param int $limit The number of entities to return
-	 * @param int $offset Indexing offset
+	 * @param int    $limit   The number of entities to return
+	 * @param int    $offset  Indexing offset
+	 *
+	 * @return array|false
 	 */
-	public function getObjects($subtype="", $limit = 10, $offset = 0);
+	public function getObjects($subtype = "", $limit = 10, $offset = 0);
 
 	/**
 	 * Returns objects in the containers of this entity's friends
 	 *
 	 * @param string $subtype The subtype of entity to return
-	 * @param int $limit The number of entities to return
-	 * @param int $offset Indexing offset
+	 * @param int    $limit   The number of entities to return
+	 * @param int    $offset  Indexing offset
+	 *
+	 * @return array|false
 	 */
 	public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0);
 
@@ -78,6 +97,8 @@ interface Friendable {
 	 * Returns the number of object entities in this entity's container
 	 *
 	 * @param string $subtype The subtype of entity to count
+	 *
+	 * @return int
 	 */
 	public function countObjects($subtype = "");
 }
\ No newline at end of file
-- 
cgit v1.2.3