Download the PHP package kesty/laravel-reactions without Composer
On this page you can find all versions of the php package kesty/laravel-reactions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-reactions
Laravel Reactions
Laravel Reactions is the package you need if you want to implement reactions for your Eloquent models, similarly you can see on Facebook.
Features
- easy to install, nothing to configure;
- ready-to-use traits;
- you can implement reactions for multiple entities, thanks to a polymorphic many to many relationship;
- you can implement reactions from multiple entities, thanks to some extra magic under the hood;
Disclaimer
This project is not associated with Facebook in any way. I've used the "reactions" just to give an idea of the concept. In case of legal issues, let me know using an email.
Install
Install the package with Composer.
Add the Service Provider to your config/app.php
file.
Run the migrations to create reactions
and reactables
tables.
You're good to go.
Usage
Add Traits to Models
To use the package you need to follow two steps:
- add the
Kesty\LaravelReactions\Traits\Reacts
trait to the entity that is going to react to something; - add the
Kesty\LaravelReactions\Traits\Reactable
trait to the entity that is going to "receive" reactions; - be sure that the entity that receives reactions also implements the
Kesty\LaravelReactions\Contracts\ReactableInterface
;
Let's make an example.
Imagine that you have some users in your application. You are building a blog, so you will have posts.
You want to let your user add reactions to your posts. Just like Facebook, you know.
Let's say we have two models: User
and Post
.
Following the steps, we first add the Kesty\LaravelReactions\Traits\Reacts
trait to our User
model.
Done! Now, to the Post
model!
Ta-dah! You're done.
By default, the package ships with a Reaction
model. This model has a single, simple property: its name
. You can create a new one easily, with
React!
Our models are ready. We can use them. How?
Easy, isn't it? The reactTo
method handles everything for you.
Get Reactions for a Model
Just like you can let one of your entities react to another one, you should be able to get all the reactions for an entity.
Let's see how to do it.
In $reactions
you will have a collection of Reaction
models, ready to be used.
Get a Reactions Summary
Probably you won't need everything about reactions to a specific entity everytime. So, I implemented a getReactionsSummary
for you.
In $reactionsSummary
you will find a collection of items, composed by two properties: name
and count
. Imagine that we do something like the following code in a controller:
Here's what we will get:
Accessing the "Responder"
When on Facebook, you can see "who" reacted in some way to a post. To get that who
you can use the getResponder
method. This works for every reaction you get using the reactions
relationship method, of course.
Let's assume that a User
named "Francesco" already reacted with the "love" reaction to a post.
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
Contributing
Please see CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Olubunmi Tosin
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-reactions with dependencies
illuminate/database Version ~5.5|~5.6|~5.7|~5.8|^6.0|^7.0|^8.0|^9.0
illuminate/support Version ~5.5|~5.6|~5.7|~5.8|^6.0|^7.0|^8.0|^9.0