https://github.com/jobmetric/laravel-like
This is a likes management package for any object in Laravel that you can use in your projects.
https://github.com/jobmetric/laravel-like
laravel laravel-package like like-count likeable likes package
Last synced: 3 months ago
JSON representation
This is a likes management package for any object in Laravel that you can use in your projects.
- Host: GitHub
- URL: https://github.com/jobmetric/laravel-like
- Owner: jobmetric
- License: mit
- Created: 2024-02-27T21:55:16.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-25T18:49:52.000Z (about 1 year ago)
- Last Synced: 2024-11-14T20:22:44.113Z (11 months ago)
- Topics: laravel, laravel-package, like, like-count, likeable, likes, package
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[contributors-shield]: https://img.shields.io/github/contributors/jobmetric/laravel-like.svg?style=for-the-badge
[contributors-url]: https://github.com/jobmetric/laravel-like/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/jobmetric/laravel-like.svg?style=for-the-badge&label=Fork
[forks-url]: https://github.com/jobmetric/laravel-like/network/members
[stars-shield]: https://img.shields.io/github/stars/jobmetric/laravel-like.svg?style=for-the-badge
[stars-url]: https://github.com/jobmetric/laravel-like/stargazers
[license-shield]: https://img.shields.io/github/license/jobmetric/laravel-like.svg?style=for-the-badge
[license-url]: https://github.com/jobmetric/laravel-like/blob/master/LICENCE.md
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-blue.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/majidmohammadian
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
# Like for laravel
This is a like management package for Laravel that you can use in your projects.
## Install via composer
Run the following command to pull in the latest version:
```bash
composer require jobmetric/laravel-like
```
## Documentation
This package evolves every day under constant development and integrates a diverse set of features. It is a must-have asset for Laravel enthusiasts and provides a seamless way to coordinate your projects with like and dislike base models.
In this package, you can use it seamlessly with any model that requires likes and dislikes.
Now let's move on to the main function.
>#### Before doing anything, you must migrate after installing the package by composer.
```bash
php artisan migrate
```
Meet the `HasLike` class, meticulously designed for integration into your model. This class automates essential tasks, ensuring a streamlined process for:
In the first step, you need to connect this class to your main model.
```php
use JobMetric\Like\HasLike;
class Post extends Model
{
use HasLike;
}
```
## How is it used?
You can now use the `HasLike` class for your model. The following example shows how to create a new post with a like:
```php
$post = Post::create([
'status' => 'published',
]);
$user_id = 1;
$post->likeIt($user_id, $type = true);
```
> The `likeIt` function is used to like the post. The first parameter is the user id, and the second parameter is the type of like. If you want to dislike, you can set it to `false`.
### Now we go to the functions that we have added to our model.
#### likeOne
like has one relationship
#### likes
like has many relationships
#### likeTo
scope locale for select like relationship
#### dislikeTo
scope locale for select disLike relationship
#### likesTo
scope locale for select likes relationship
#### dislikesTo
scope locale for select disLikes relationship
#### likeIt
This function is very important and is used to store user's likes and dislikes.
```php
$post->likeIt($user_id, $type = true);
```
> The `likeIt` function is used to like the post. The first parameter is the user id, and the second parameter is the type of like. If you want to dislike, you can set it to `false`.
> user_id: user id
> type: like or dislike
#### likeCount
get count of likes
#### dislikeCount
get count of dislikes
#### loadLikeDislikeCount
This function helps to see the number of likes and dislikes of each object and loads it in the desired model.
```php
$post->loadLikeDislikeCount();
```
#### loadLikeDislike
load like or disLike after model loaded
> The `loadLikeDislike` function is used to load the likes and dislikes of the object after the model is loaded.
#### loadLikesDislikes
load likes or dislikes after model loaded
> The `loadLikesDislikes` function is used to load the likes and dislikes of the object after the model is loaded.
#### isLikedDislikedBy
is liked or disliked by user
```php
$type = $post->isLikedDislikedBy($user_id);
if(\JobMetric\Like\Enums\LikeTypeEnum::LIKE == $type) {
// liked
} else if(\JobMetric\Like\Enums\LikeTypeEnum::DISLIKE == $type) {
// disliked
} else {
// not liked or disliked
}
```
#### forgetLike
forget like or dislike
```php
$post->forgetLike($user_id);
```
#### forgetLikes
forget likes or dislikes
```php
$post->forgetLikes();
```
## Contributing
Thank you for considering contributing to the Laravel Like! The contribution guide can be found in the [CONTRIBUTING.md](https://github.com/jobmetric/laravel-like/blob/master/CONTRIBUTING.md).
## License
The MIT License (MIT). Please see [License File](https://github.com/jobmetric/laravel-like/blob/master/LICENCE.md) for more information.