batuhan/laravel-flaggable

Trait for Laravel Eloquent models to allow easy implementation of a 'flag' feature.

1.0.0 2015-04-23 22:04 UTC

This package is not auto-updated.

Last update: 2023-01-21 09:12:05 UTC


README

Build Status Latest Stable Version License

Trait for Laravel Eloquent models to allow easy implementation of a "flag" feature. Only tested with Laravel 5.

Composer Install (for Laravel 5)

composer require batuhan/laravel-flagable "~1.0.0"

Install and then run the migrations

'providers' => array(
	'Conner\Likeable\LikeableServiceProvider',
);
php artisan vendor:publish --provider="Conner\Likeable\LikeableServiceProvider"
php artisan migrate

Setup your models

class Article extends \Illuminate\Database\Eloquent\Model {
	use Conner\Likeable\LikeableTrait;
}

Sample Usage

$article->flag(); // like the article for current user
$article->flag($myUserId); // pass in your own user id
$article->flag(0); // just add flags to the count, and don't track by user

$article->unflag(); // remove flag from the article
$article->unflag($myUserId); // pass in your own user id
$article->unflag(0); // remove flags from the count -- does not check for user

$article->flagCount; // get count of flags

$article->flags; // Iterable Illuminate\Database\Eloquent\Collection of existing flags 

$article->flaged(); // check if currently logged in user flaged the article
$article->flaged($myUserId);

Article::whereflaged($myUserId) // find only articles where user flaged them
	->with('flagCounter') // highly suggested to allow eager load
	->get();

Credits