Friendable Interface Reference

Inheritance diagram for Friendable:

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

addFriend()

Friendable::addFriend

(

$friend_guid

)

Adds a user as a friend.

Parameters

int

$friend_guid

The GUID of the user to add

Returns

bool

Implemented in ElggGroup.

countObjects()

Friendable::countObjects

(

$subtype = ""

)

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

Parameters

string

$subtype

The subtype of entity to count

Returns

int

Implemented in ElggUser, and ElggGroup.

getFriends()

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

Returns this entity's friends.

Parameters

string	$subtype	The subtype of entity to return
int	$limit	The number of entities to return
int	$offset	Indexing offset

Returns

array|false

Implemented in ElggGroup, and ElggUser.

getFriendsObjects()

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

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

Parameters

string	$subtype	The subtype of entity to return
int	$limit	The number of entities to return
int	$offset	Indexing offset

Returns

array|false

Implemented in ElggGroup, and ElggUser.

getFriendsOf()

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

Returns entities that have made this entity a friend.

Parameters

string	$subtype	The subtype of entity to return
int	$limit	The number of entities to return
int	$offset	Indexing offset

Returns

array|false

Implemented in ElggGroup, and ElggUser.

getObjects()

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

Returns objects in this entity's container.

Parameters

string	$subtype	The subtype of entity to return
int	$limit	The number of entities to return
int	$offset	Indexing offset

Returns

array|false

Implemented in ElggGroup, and ElggUser.

isFriend()

Friendable::isFriend

(

)

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

Returns

bool

Implemented in ElggUser, and ElggGroup.

isFriendOf()

Friendable::isFriendOf

(

$user_guid

)

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

Parameters

int

$user_guid

The GUID of the foreign entity

Returns

bool

Implemented in ElggUser, and ElggGroup.

isFriendsWith()

Friendable::isFriendsWith

(

$user_guid

)

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

Parameters

int

$user_guid

The GUID of the entity this entity may or may not be friends with

Returns

bool

Implemented in ElggUser, and ElggGroup.

removeFriend()

Friendable::removeFriend

(

$friend_guid

)

Removes a user as a friend.

Parameters

int

$friend_guid

The GUID of the user to remove

Returns

bool

Implemented in ElggUser, and ElggGroup.

---

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

• engine/classes/Friendable.php