Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Friendable.php
Go to the documentation of this file.
1 <?php
8 interface Friendable {
16  public function addFriend($friend_guid);
17 
25  public function removeFriend($friend_guid);
26 
32  public function isFriend();
33 
41  public function isFriendsWith($user_guid);
42 
50  public function isFriendOf($user_guid);
51 
61  public function getFriends($subtype = "", $limit = 10, $offset = 0);
62 
72  public function getFriendsOf($subtype = "", $limit = 10, $offset = 0);
73 
83  public function getObjects($subtype = "", $limit = 10, $offset = 0);
84 
94  public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0);
95 
103  public function countObjects($subtype = "");
104 }
isFriend()
Determines whether or not the current user is a friend of this entity.
getObjects($subtype="", $limit=10, $offset=0)
Returns objects in this entity's container.
removeFriend($friend_guid)
Removes a user as a friend.
getFriendsObjects($subtype="", $limit=10, $offset=0)
Returns objects in the containers of this entity's friends.
$subtype
Definition: delete.php:28
if(!$count) $offset
Definition: pagination.php:26
addFriend($friend_guid)
Adds a user as a friend.
isFriendsWith($user_guid)
Determines whether or not this entity is friends with a particular entity.
$limit
Definition: userpicker.php:38
getFriendsOf($subtype="", $limit=10, $offset=0)
Returns entities that have made this entity a friend.
$friend_guid
Definition: add.php:10
getFriends($subtype="", $limit=10, $offset=0)
Returns this entity's friends.
isFriendOf($user_guid)
Determines whether or not a foreign entity has made this one a friend.
countObjects($subtype="")
Returns the number of object entities in this entity's container.
$user_guid
Avatar remove action.
Definition: remove.php:6