Interface Friendable

An interface for objects that behave as elements within a social network that have a profile.

Direct known implementers

ElggGroup, ElggUser

Package: Elgg\Core\SocialModel\Friendable
Located at Friendable.php

Methods summary
`public boolean`	# `addFriend( integer $friend_guid )` Adds a user as a friend Adds a user as a friend Parameters `$friend_guid` `integer` $friend_guid The GUID of the user to add Returns `boolean`
`public boolean`	# `removeFriend( integer $friend_guid )` Removes a user as a friend Removes a user as a friend Parameters `$friend_guid` `integer` $friend_guid The GUID of the user to remove Returns `boolean`
`public boolean`	# `isFriend( )` Determines whether or not the current user is a friend of this entity Determines whether or not the current user is a friend of this entity Returns `boolean`
`public boolean`	# `isFriendsWith( integer $user_guid )` Determines whether or not this entity is friends with a particular entity Determines whether or not this entity is friends with a particular entity Parameters `$user_guid` `integer` $user_guid The GUID of the entity this entity may or may not be friends with Returns `boolean`
`public boolean`	# `isFriendOf( integer $user_guid )` Determines whether or not a foreign entity has made this one a friend Determines whether or not a foreign entity has made this one a friend Parameters `$user_guid` `integer` $user_guid The GUID of the foreign entity Returns `boolean`
`public array\|false`	# `getFriends( string $subtype = "", integer $limit = 10, integer $offset = 0 )` Returns this entity's friends Returns this entity's friends Parameters `$subtype` `string` $subtype The subtype of entity to return `$limit` `integer` $limit The number of entities to return `$offset` `integer` $offset Indexing offset Returns `array\|false`
`public array\|false`	# `getFriendsOf( string $subtype = "", integer $limit = 10, integer $offset = 0 )` Returns entities that have made this entity a friend Returns entities that have made this entity a friend Parameters `$subtype` `string` $subtype The subtype of entity to return `$limit` `integer` $limit The number of entities to return `$offset` `integer` $offset Indexing offset Returns `array\|false`
`public array\|false`	# `getObjects( string $subtype = "", integer $limit = 10, integer $offset = 0 )` Returns objects in this entity's container Returns objects in this entity's container Parameters `$subtype` `string` $subtype The subtype of entity to return `$limit` `integer` $limit The number of entities to return `$offset` `integer` $offset Indexing offset Returns `array\|false`
`public array\|false`	# `getFriendsObjects( string $subtype = "", integer $limit = 10, integer $offset = 0 )` Returns objects in the containers of this entity's friends Returns objects in the containers of this entity's friends Parameters `$subtype` `string` $subtype The subtype of entity to return `$limit` `integer` $limit The number of entities to return `$offset` `integer` $offset Indexing offset Returns `array\|false`
`public integer`	# `countObjects( string $subtype = "" )` Returns the number of object entities in this entity's container Returns the number of object entities in this entity's container Parameters `$subtype` `string` $subtype The subtype of entity to count Returns `integer`