Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Friendable Interface Reference
Inheritance diagram for Friendable:
ElggGroup ElggUser

Public Member Functions

 addFriend ($friend_guid)
 Adds a user as a friend. More...
 
 removeFriend ($friend_guid)
 Removes a user as a friend. More...
 
 isFriend ()
 Determines whether or not the current user is a friend of this entity. More...
 
 isFriendsWith ($user_guid)
 Determines whether or not this entity is friends with a particular entity. More...
 
 isFriendOf ($user_guid)
 Determines whether or not a foreign entity has made this one a friend. More...
 
 getFriends ($subtype="", $limit=10, $offset=0)
 Returns this entity's friends. More...
 
 getFriendsOf ($subtype="", $limit=10, $offset=0)
 Returns entities that have made this entity a friend. More...
 
 getObjects ($subtype="", $limit=10, $offset=0)
 Returns objects in this entity's container. More...
 
 getFriendsObjects ($subtype="", $limit=10, $offset=0)
 Returns objects in the containers of this entity's friends. More...
 
 countObjects ($subtype="")
 Returns the number of object entities in this entity's container. More...
 

Detailed Description

Definition at line 8 of file Friendable.php.

Member Function Documentation

Friendable::addFriend (   $friend_guid)

Adds a user as a friend.

Parameters
int$friend_guidThe GUID of the user to add
Returns
bool

Implemented in ElggGroup.

Friendable::countObjects (   $subtype = "")

Returns the number of object entities in this entity's container.

Parameters
string$subtypeThe subtype of entity to count
Returns
int

Implemented in ElggUser, and ElggGroup.

Friendable::getFriends (   $subtype = "",
  $limit = 10,
  $offset = 0 
)

Returns this entity's friends.

Parameters
string$subtypeThe subtype of entity to return
int$limitThe number of entities to return
int$offsetIndexing offset
Returns
array|false

Implemented in ElggUser, and ElggGroup.

Friendable::getFriendsObjects (   $subtype = "",
  $limit = 10,
  $offset = 0 
)

Returns objects in the containers of this entity's friends.

Parameters
string$subtypeThe subtype of entity to return
int$limitThe number of entities to return
int$offsetIndexing offset
Returns
array|false

Implemented in ElggUser, and ElggGroup.

Friendable::getFriendsOf (   $subtype = "",
  $limit = 10,
  $offset = 0 
)

Returns entities that have made this entity a friend.

Parameters
string$subtypeThe subtype of entity to return
int$limitThe number of entities to return
int$offsetIndexing offset
Returns
array|false

Implemented in ElggUser, and ElggGroup.

Friendable::getObjects (   $subtype = "",
  $limit = 10,
  $offset = 0 
)

Returns objects in this entity's container.

Parameters
string$subtypeThe subtype of entity to return
int$limitThe number of entities to return
int$offsetIndexing offset
Returns
array|false

Implemented in ElggUser, and ElggGroup.

Friendable::isFriend ( )

Determines whether or not the current user is a friend of this entity.

Returns
bool

Implemented in ElggUser, and ElggGroup.

Friendable::isFriendOf (   $user_guid)

Determines whether or not a foreign entity has made this one a friend.

Parameters
int$user_guidThe GUID of the foreign entity
Returns
bool

Implemented in ElggUser, and ElggGroup.

Friendable::isFriendsWith (   $user_guid)

Determines whether or not this entity is friends with a particular entity.

Parameters
int$user_guidThe GUID of the entity this entity may or may not be friends with
Returns
bool

Implemented in ElggUser, and ElggGroup.

Friendable::removeFriend (   $friend_guid)

Removes a user as a friend.

Parameters
int$friend_guidThe GUID of the user to remove
Returns
bool

Implemented in ElggUser, and ElggGroup.


The documentation for this interface was generated from the following file: