ironshark / laravel-deliverable
Trait for Laravel Eloquent models to allow easy implementation of delivering feature.
v1.0.1
2015-08-26 14:39 UTC
Requires
- php: >=5.3.0
Requires (Dev)
- phpunit/phpunit: ~4.0
This package is not auto-updated.
Last update: 2024-10-26 19:10:34 UTC
README
Trait for Laravel Eloquent models to allow easy implementation of a "deliverable" feature. Can be used for reading lists or shipments.
Composer Install
composer require ironshark/laravel-deliverable
php artisan vendor:publish --provider="IronShark\Deliverable\DeliverableServiceProvider"
php artisan migrate
Setup your models
class Article extends \Illuminate\Database\Eloquent\Model { use IronShark\Deliverable\DeliverableTrait; }
Sample Usage
$file = File::create(['name' => 'filename']); $admin = \App\User::where('name', 'admin')->first(); $file->deliver(\App\User::all()); // deliver file to all users $file->deliver(1, 5); // deliver files to user with id `1`, priority = `5` $file->setDelivered(); // mark file as deliverd to logged in user $file->setDelivered(true, $admin); // mark file as deliverd to admin user $file->isDelivered(); // check whether current item was delivered to current user (`true`|`false`) $file->isDelivered($admin); // check whether current item was delivered to admin $file->cancelDelivery(); // remove delivery tasks for current user $file->cancelDelivery($admin); // remove delivery tasks for admin $file->cancelDelivery([1,5,9,8]); // remove delivery tasks for specified user ids