Download the PHP package rubik-llc/laravel-invite without Composer

Laravel invite

A simple invitation system for Eloquent models in your Laravel application. The package doesn't cover sending emails, views or routing.

Installation

You can install the package via composer:

You can publish and run the migrations with:

You can publish the config file with:

This is the contents of the published config file:

Usage

Registering the Referable Model

In order to let a model be able to make invitations, simply add the CanInvite trait to the class of that model.

Registering the Invitable Model

In order to let a model be able to receive invitations, add the RecivesInvitation trait to the class of that model.

Making invitations

There are two ways to make an invitation:

1. Making invitations using the Facade

2. Making invitations from a referer Model

Making an invitation from a model will automatically set in as the referer. Make sure the model class uses the CanInvite trait.

NOTE: An email is required in order to make an invitation.

Additionally, you can specify other parameters like:

Referer

You can associate a referer to an invitation using the referer method which accepts an eloquent model as a parameter.

or update the referer of an existing invitation.

Invitee

You can associate an invitee to an invitation using the invitee method. This method accepts an eloquent model or a model class name.

• Using Eloquent Model

This option should be used when the invitee is created before the invitation is sent.

or update the invitee of an existing invitation.

• Using class name

This option should be used when the invitee is created after the invitation is accepted, and you want to specify its model class.

Expiration

In addition to the config file, you can specify the expiration of a specific invitation using the expireAt or expireIn methods.

• Expire at

This method accepts a date as string or Carbon instance and sets the invitation expires_at property to the given date.

• Expire in

This method accepts two parameters, the value and unit.

Getting an invitation by its token

Accepting invitations

Declining invitations

Delete on decline

If delete_on_decline option in config/invite.php is set to true, whenever an invitation is declined it will automatically be deleted.

Auto delete expired invitations

Enabling expire.delete.auto option in config/invite.php, will run Rubik\LaravelInvite\Commands\DeleteExpiredInvitesCommand every hour that deletes all invitations the expiry date of which has surpassed the value given in expire.delete.after option in config/invite.php

Using a custom Invitation class

If you are using a custom invitation class make sure it extends the default Invitation class that is shipped with this package.

In addition to that, you need to set the invitation_model value in the config file to the path of your custom class.

`

Events

The package dispatches various events

• Rubik\LaravelInvite\Events\InvitationCreated

  This event dispatches whenever a new Invitation is created.

• Rubik\LaravelInvite\Events\InvitationAccepted

  This event dispatches whenever the accept method is called and successfully executed.

• Rubik\LaravelInvite\Events\InvitationDeclined

  This event dispatches whenever the decline method is called and successfully executed.

• Rubik\LaravelInvite\Events\InvitationDeleted

  This event dispatches whenever an Invitation is deleted.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Rron Nela
• Yllndrit Beka
• All Contributors

License

The MIT License (MIT). Please see License File for more information.