cybercog/laravel-likeable

Make Laravel Eloquent models Likeable & Dislikeable in a minutes!

Laravel Likeable

, _(*1)

, _(*2)

Attention

This package is abandoned and no longer maintained. Development moved to Laravel Love package!, _(*3)

If you already have installed version of Laravel Likeable you can use Laravel Love Migration Guide., _(*4)

Introduction

Laravel Likeable simplify management of Eloquent model's likes & dislikes. Make any model likeable & dislikeable in a minutes!, _(*5)

Contents

• Features
• Installation
• Usage
  • Prepare likeable model
  • Available methods
  • Scopes
  • Events
  • Console commands
• Extending
• Change log
• Contributing
• Testing
• Security
• Contributors
• Alternatives
• License
• About CyberCog

Features

• Designed to work with Laravel Eloquent models.
• Using contracts to keep high customization capabilities.
• Using traits to get functionality out of the box.
• Most part of the the logic is handled by the LikeableService.
• Has Artisan command likeable:recount {model?} {type?} to re-fetch likes counters.
• Likeable model can has Likes and Dislikes.
• Likes and Dislikes for one model are mutually exclusive.
• Get Likeable models ordered by likes count.
• Events for like, unlike, dislike, undislike methods.
• Following PHP Standard Recommendations:
  • PSR-1 (Basic Coding Standard).
  • PSR-2 (Coding Style Guide).
  • PSR-4 (Autoloading Standard).
• Covered with unit tests.

Installation

First, pull in the package through Composer., _(*6)

$ composer require cybercog/laravel-likeable

If you are using Laravel 5.5 you can skip register package part., _(*7)

Register package on Laravel 5.4 and lower

Include the service provider within app/config/app.php., _(*8)

'providers' => [
    Cog\Likeable\Providers\LikeableServiceProvider::class,
],

Perform Database Migration

At last you need to publish and run database migrations., _(*9)

$ php artisan vendor:publish --provider="Cog\Likeable\Providers\LikeableServiceProvider" --tag=migrations
$ php artisan migrate

Usage

Prepare likeable model

Use Likeable contract in model which will get likes behavior and implement it or just use Likeable trait., _(*10)

use Cog\Likeable\Contracts\Likeable as LikeableContract;
use Cog\Likeable\Traits\Likeable;
use Illuminate\Database\Eloquent\Model;

class Article extends Model implements LikeableContract
{
    use Likeable;
}

Available methods

Likes

Like model

$article->like(); // current user
$article->like($user->id);

Remove like mark from model

$article->unlike(); // current user
$article->unlike($user->id);

Toggle like mark of model

$article->likeToggle(); // current user
$article->likeToggle($user->id);

Get model likes count

$article->likesCount;

Get model likes counter

$article->likesCounter;

Get likes relation

$article->likes();

Get iterable Illuminate\Database\Eloquent\Collection of existing model likes

$article->likes;

Boolean check if user liked model

$article->liked; // current user
$article->liked(); // current user
$article->liked($user->id);

Checks in eager loaded relations likes & likesAndDislikes first., _(*11)

Get collection of users who liked model

$article->collectLikers();

Delete all likes for model

$article->removeLikes();

Dislikes

Dislike model

$article->dislike(); // current user
$article->dislike($user->id);

Remove dislike mark from model

$article->undislike(); // current user
$article->undislike($user->id);

Toggle dislike mark of model

$article->dislikeToggle(); // current user
$article->dislikeToggle($user->id);

Get model dislikes count

$article->dislikesCount;

Get model dislikes counter

$article->dislikesCounter;

Get dislikes relation

$article->dislikes();

Get iterable Illuminate\Database\Eloquent\Collection of existing model dislikes

$article->dislikes;

Boolean check if user disliked model

$article->disliked; // current user
$article->disliked(); // current user
$article->disliked($user->id);

Checks in eager loaded relations dislikes & likesAndDislikes first., _(*12)

Get collection of users who disliked model

$article->collectDislikers();

Delete all dislikes for model

$article->removeDislikes();

Likes and Dislikes

Get difference between likes and dislikes

$article->likesDiffDislikesCount;

Get likes and dislikes relation

$article->likesAndDislikes();

Get iterable Illuminate\Database\Eloquent\Collection of existing model likes and dislikes

$article->likesAndDislikes;

Scopes

Find all articles liked by user

Article::whereLikedBy($user->id)
    ->with('likesCounter') // Allow eager load (optional)
    ->get();

Find all articles disliked by user

Article::whereDislikedBy($user->id)
    ->with('dislikesCounter') // Allow eager load (optional)
    ->get();

Fetch Likeable models by likes count

$sortedArticles = Article::orderByLikesCount()->get();
$sortedArticles = Article::orderByLikesCount('asc')->get();

Uses desc as default order direction., _(*13)

Fetch Likeable models by dislikes count

$sortedArticles = Article::orderByDislikesCount()->get();
$sortedArticles = Article::orderByDislikesCount('asc')->get();

Uses desc as default order direction., _(*14)

Events

On each like added \Cog\Likeable\Events\ModelWasLiked event is fired., _(*15)

On each like removed \Cog\Likeable\Events\ModelWasUnliked event is fired., _(*16)

On each dislike added \Cog\Likeable\Events\ModelWasDisliked event is fired., _(*17)

On each dislike removed \Cog\Likeable\Events\ModelWasUndisliked event is fired., _(*18)

Console commands

Recount likes and dislikes of all model types

$ likeable:recount

Recount likes and dislikes of concrete model type (using morph map alias)

$ likeable:recount --model="article"

Recount likes and dislikes of concrete model type (using fully qualified class name)

$ likeable:recount --model="App\Models\Article"

Recount only likes of all model types

$ likeable:recount --type="like"

Recount only likes of concrete model type (using morph map alias)

$ likeable:recount --model="article" --type="like"

Recount only likes of concrete model type (using fully qualified class name)

$ likeable:recount --model="App\Models\Article" --type="like"

Recount only dislikes of all model types

$ likeable:recount --type="dislike"

Recount only dislikes of concrete model type (using morph map alias)

$ likeable:recount --model="article" --type="dislike"

Recount only dislikes of concrete model type (using fully qualified class name)

$ likeable:recount --model="App\Models\Article" --type="dislike"

Extending

You can override core classes of package with your own implementations:, _(*19)

• Models\Like
• Models\LikeCounter
• Services\LikeableService

Note: Don't forget that all custom models must implement original models interfaces., _(*20)

To make it you should use container binding interfaces to implementations in your application service providers., _(*21)

Use model class own implementation

$this->app->bind(
    \Cog\Likeable\Contracts\Like::class,
    \App\Models\CustomLike::class
);

Use service class own implementation

$this->app->singleton(
    \Cog\Likeable\Contracts\LikeableService::class,
    \App\Services\CustomService::class
);

After that your CustomLike and CustomService classes will be instantiable with helper method app()., _(*22)

$model = app(\Cog\Likeable\Contracts\Like::class);
$service = app(\Cog\Likeable\Contracts\LikeableService::class);

Change log

Please see CHANGELOG for more information on what has changed recently., _(*23)

Contributing

Please see CONTRIBUTING for details., _(*24)

Testing

You can run the tests with:, _(*25)

$ vendor/bin/phpunit

Security

If you discover any security related issues, please email open@cybercog.su instead of using the issue tracker., _(*26)

Contributors

Anton Komarev	Kevin Olson

Laravel Likeable contributors list, _(*27)

Alternatives

• cybercog/laravel-love
• rtconner/laravel-likeable
• faustbrian/laravel-likeable
• sukohi/evaluation
• zvermafia/lavoter

Feel free to add more alternatives as Pull Request., _(*28)

License

• Laravel Likeable package is open-sourced software licensed under the MIT license by Anton Komarev.

About CyberCog

CyberCog is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion., _(*29)

• Follow us on Twitter
• Read our articles on Medium

, _(*30)