gregoryduckworth/friendable

Add the possibility of friends quickly with the use of this trait.

Friendable

, _(*1)

Add the possibility of friends quickly with the use of this trait., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require gregoryduckworth/friendable, <sub>(*4)</sub>

And then include the service providero within `config/app.php`

```php
'providers' => [
    ...
    GregoryDuckworth\Friendable\FriendableServiceProvider::class,
    ...
];

At lastly you need to publish and run the migration., <sub>(*5)</sub>

php artisan vendor:publish && php artisan migrate

Usage

Add the Trait to the User Model

use GregoryDuckworth\Friendable\Traits\Friendable;

class User extends Model
{
    use Friendable;
    ...
}

Examples

List all the users confirmed friends

    $user->confirmedFriends();

List all the users pending friends

    $user->pendingFriends();

List all the friends waiting to approve the user

    $user->awaitingApproval();

Request the friendship of another user

    $user->requestFriendship(Model $friend);

Confirm the friendship

    $user->confirmFriendship(Model $friend);

Remove the friendship

    $user->removeFriendship(Model $friend);

Todo

• Add tests (inc travis builds)
• Ability to block friends

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*6)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*7)</sub>