faustbrian/laravel-inviteable

Inviteable Polymorphic Eloquent Models for Laravel 5

2.2.0 2018-11-10 06:51 UTC

README

Build Status PHP from Packagist Latest Version License

Installation

Require this package, with Composer, in the root directory of your project.

$ composer require faustbrian/laravel-inviteable

To get started, you'll need to publish the vendor assets and migrate:

php artisan vendor:publish --provider="BrianFaust\Inviteable\InviteableServiceProvider" && php artisan migrate

Usage

Setup a Model

<?php

namespace App;

use BrianFaust\Inviteable\HasInvites;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasInvites;
}

Examples

Generate a new invitation code

Invite::getNewCode([
    'email' => 'test@test.io',
]);

Find an invitation by code

Invite::getInviteByCode($invite->code);

Find a valid invitation by code

Invite::getValidInviteByCode($invite->code);

Claim an invitation

$invite->claim($user);

Check if an invitiation has already been claimed

if ($invite->claimed()) {
    dd('This invite has already been claimed.');
}

Access the model that claimed the invite

dump($invite->claimer);

Access the invite that has been claimed by a model

dump($user->invite);

Testing

$ phpunit

Security

If you discover a security vulnerability within this package, please send an e-mail to hello@brianfaust.me. All security vulnerabilities will be promptly addressed.

Credits

License

MIT © Brian Faust