From c5aee9bc64b6ac2ce3b4d8e4ad53e0fdf355a4e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Monnot=20St=C3=A9phane?= Date: Thu, 18 Aug 2016 01:57:08 +0200 Subject: [PATCH] Add documentation for mutual friends feature --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 4e257ef..ac99077 100644 --- a/README.md +++ b/README.md @@ -175,6 +175,11 @@ $user->getFriendsCount(); $user->getFriendsCount($group_name); ``` +#### Get the number of mutual Friends with another user +```php +$user->getMutualFriendsCount($otherUser); +``` + ### To get a collection of friend models (ex. User) use the following methods: #### Get Friends ```php @@ -195,3 +200,7 @@ $user->getFriends($perPage = 20); ```php $user->getFriendsOfFriends($perPage = 20); ``` + +#### Get mutual Friends with another user +```php +$user->getMutualFriends($otherUser, $perPage = 20); \ No newline at end of file