https://github.com/voocx/laravel-rally
A followers system for laravel 5, Trait for Laravel Eloquent models to allow easy implementation of a "follow" or "like" or "favorite" or "remember" or "subscribe" feature.
https://github.com/voocx/laravel-rally
favorite follow like remember subscribe
Last synced: about 2 months ago
JSON representation
A followers system for laravel 5, Trait for Laravel Eloquent models to allow easy implementation of a "follow" or "like" or "favorite" or "remember" or "subscribe" feature.
- Host: GitHub
- URL: https://github.com/voocx/laravel-rally
- Owner: questocat
- License: mit
- Created: 2017-09-30T04:26:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-26T15:16:42.000Z (over 7 years ago)
- Last Synced: 2023-11-19T21:23:06.454Z (almost 2 years ago)
- Topics: favorite, follow, like, remember, subscribe
- Language: PHP
- Homepage:
- Size: 27.3 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# laravel-rally
A followers system for laravel 5, Trait for Laravel Eloquent models to allow easy implementation of a "follow" or "like" or "favorite" or "remember" or "subscribe" feature.
[](https://styleci.io/repos/105341654)
[](https://scrutinizer-ci.com/g/questocat/laravel-rally/?branch=master)
[](https://travis-ci.org/questocat/laravel-rally)
[](https://packagist.org/packages/questocat/laravel-rally)
## Installation
Via [Composer](https://getcomposer.org) to add the package to your project's dependencies:
```bash
$ composer require questocat/laravel-rally
```
First add service providers into the config/app.php
```php
\Questocat\Rally\RallyServiceProvider::class,
```
Publish the migrations
```bash
$ php artisan vendor:publish --provider="Questocat\Rally\RallyServiceProvider" --tag="migrations"
```
Publish the config
```bash
$ php artisan vendor:publish --provider="Questocat\Rally\RallyServiceProvider" --tag="config"
```
## Setup the model
Add CanFollow Traits to your User model.
```php
use Questocat\Rally\Traits\CanFollow
class User extends Model
{
use CanFollow;
}
```
Add CanBeFollowed Trait to your Post model or Video model and more.
```php
use Questocat\Rally\Traits\CanBeFollowed
class Post extends Model
{
use CanBeFollowed;
}
```
Add CanFollow and CanBeFollowed feature trait into your User model:
```php
use Questocat\Rally\Traits\Followable
class User extends Model
{
use Followable;
}
```
## Usage
##### CanFollow
Follow and Unfollow users
```php
$user->follow(1); // App\User:class
$user->follow($user1);
$user->follow([1, 3]);
$user->follow(1, Post::class);
$user->unfollow(1); // App\User:class
$user->unfollow($user1);
$user->unfollow([1, 2]);
$user->unfollow(1, Post::class);
```
Check if being followed by someone
```php
$user->isFollowing(1);
$user->isFollowing($user2);
$user->isFollowing(2, Post::class);
$user->isFollowing($post, Post::class);
```
Toggle follow
```php
$user->toggleFollow(1);
$user->toggleFollow($user2);
$user->toggleFollow([2, 4]);
$user->toggleFollow([2, 4], Post::class);
```
Following
```php
$user->following;
$user->following()->get(); // It's the same thing as this
$user->following()->count(); // Get the total following
```
##### CanBeFollowed
Check if following by someone
```php
$user->isFollowedBy(3);
$user->isFollowedBy($user2);
```
Followers
```php
$user->followers;
$user->followers()->get(); // It's the same thing as this
$user->followers()->count(); // Get the total followers
```
##### Followable
Check if it is mutual follow
```php
$user->isMutualFollow(1);
$user->isMutualFollow($user2);
```
## Inspiration
* [Rally](https://github.com/fenos/Rally)
## License
Licensed under the [MIT license](https://github.com/questocat/laravel-rally/blob/master/LICENSE).