Skip to content

Commit

Permalink
Update documention after refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
stephane-monnot committed Aug 15, 2016
1 parent 44a7b82 commit 94fd56f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,32 +102,50 @@ $user->getFriendship($recipient);

#### Get a list of all Friendships
```php
// (return a collection of friendships)
$user->getAllFriendships();
// or with the new method (return query builder):
$user->requests();
```

#### Get a list of pending Friendships
```php
// (return a collection of friendships)
$user->getPendingFriendships();
// or with the new method (return query builder):
$user->requests()->pending();
```

#### Get a list of accepted Friendships
```php
// (return a collection of friendships)
$user->getAcceptedFriendships();
// or with the new method (return query builder):
$user->requests()->accepted();
```

#### Get a list of denied Friendships
```php
// (return a collection of friendships)
$user->getDeniedFriendships();
// or with the new method (return query builder):
$user->requests()->denied();
```

#### Get a list of blocked Friendships
```php
// (return a collection of friendships)
$user->getBlockedFriendships();
// or with the new method (return query builder):
$user->requests()->blocked();
```

#### Get a list of pending Friend Requests
```php
// (return a collection of friendships)
$user->getFriendRequests();
// or with the new method (return query builder):
$user->requests(Direction::INCOMING)->pending();
```

#### Get the number of Friends
Expand All @@ -140,6 +158,8 @@ $user->getFriendsCount();
#### Get Friends
```php
$user->getFriends();
// or with the new method (return query builder):
$user->friendships();
```

#### Get Friends Paginated
Expand Down

0 comments on commit 94fd56f

Please sign in to comment.