Download the PHP package ufutx/laravel-favorite without Composer
On this page you can find all versions of the php package ufutx/laravel-favorite. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ufutx/laravel-favorite
More information about ufutx/laravel-favorite
Files in ufutx/laravel-favorite
Package laravel-favorite
Short Description Allows Laravel Eloquent models to implement a 'favorite' or 'remember' or 'follow' feature.
License MIT
Homepage https://github.com/glore/laravel-favorite
Informations about the package laravel-favorite
Laravel Favorite (Laravel 5 Package, forked from Ufutx/laravel-favorite)
Allows Laravel Eloquent models to implement a 'favorite' or 'remember' or 'follow' feature.
Index
- Installation
- Models
- Usage
- Testing
- Change log
- Contributions
- Pull Requests
- Security
- Credits
- License
Installation
1) Install the package via Composer
2) Update config/app.php
by adding an entry for the service provider.
3) Migrate the database from the command line:
Models
Your User model should import the Traits/Favoriteability.php
trait and use it, that trait allows the user to favorite the models.
(see an example below):
Your models should import the Traits/Favoriteable.php
trait and use it, that trait have the methods that you'll use to allow the model be favoriteable.
In all the examples I will use the Post model as the model that is 'Favoriteable', thats for example propuses only.
(see an example below):
That's it ... your model is now "favoriteable"! Now the User can favorite models that have the favoriteable trait.
Usage
The models can be favorited with and without an authenticated user (see examples below):
Add to favorites and remove from favorites:
If no param is passed in the favorite method, then the model will asume the auth user.
If a param is passed in the favorite method, then the model will asume the user with that id.
The user model can also add to favorites and remove from favrites:
Return the favorite objects for the user:
A user can return the objects he marked as favorite.
You just need to pass the class in the favorite()
method in the User
model.
Return the favorites count from an object:
You can return the favorites count from an object, you just need to return the favoritesCount
attribute from the model
Return the users who marked this object as favorite
You can return the users who marked this object, you just need to call the favoritedBy()
method in the object
Testing
The package have integrated testing, so everytime you make a pull request your code will be tested.
Change log
Please see CHANGELOG for more information on what has changed recently.
Contributions
Contributions are welcome and will be fully credited. We accept contributions via Pull Requests on Github.
Pull Requests
-
PSR-2 Coding Standard - Check the code style with
$ composer check-style
and fix it with$ composer fix-style
. -
Add tests! - Your patch won't be accepted if it doesn't have tests.
-
Document any change in behaviour - Make sure the
README.md
and any other relevant documentation are kept up-to-date. -
Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
-
Create feature branches - Don't ask us to pull from your master branch.
-
One pull request per feature - If you want to do more than one thing, send multiple pull requests.
- Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
Security
Please report any issue you find in the issues page.
Pull requests are welcome.
Credits
- Christian Kuri
- All Contributors
License
The MIT License (MIT). Please see License File for more information.