Download the PHP package famdirksen/laravel-referral without Composer
On this page you can find all versions of the php package famdirksen/laravel-referral. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download famdirksen/laravel-referral
More information about famdirksen/laravel-referral
Files in famdirksen/laravel-referral
Package laravel-referral
Short Description A package for Laravel to register referrals with ease.
License MIT
Homepage https://github.com/famdirksen/laravel-referral
Informations about the package laravel-referral
A package for Laravel to register referrals
With this package you can easily register referrals for your users/models.
Installation
You can install the package via composer:
Usage
This example shows an users (App\Models\User
) who can have multiple referralAccounts
. Based on orders (App\Models\Order
) made in the system it will register the referral for the referral account.
Add the CanReferralContract
& CanReferralTrait
in App\Models\User
;
Add the HandleReferralContract
& HandleReferralTrait
in App\Models\Order
;
Last, you need to register the middleware that's keeping track of the referrals.
Add the CheckReferralMiddleware
to App\Http\Kernel
:
Usage
-
Create a referral account for the user
-
Get all referral accounts, referral link, and referrals for a referral account
- When
Order
model hits thecreated
event, it will register the referral for the referral account based on thereferral
cookie.
Configuration
Key | Description |
---|---|
overwrite_previous_referral |
When a user is redirected multiple times, overwrite the previous referral. |
code_length |
The length in random characters a referral token needs to be. |
clear_cookie_on_referral |
Remove the cookie, so it's handled only once. |
cookie_name |
The name that will be used in the referral cookie registration. |
cookie_duration |
Needs to be an instance of Famdirksen\LaravelReferral\Contracts\ReferralCookieDurationContract . |
cookie_domains |
Optional, define on which domains a cookie needs to be set. |
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
- Robin Dirksen
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-referral with dependencies
illuminate/database Version ^5.8|^6.0|^7.0|^8.0|^9.0
illuminate/http Version ^5.8|^6.0|^7.0|^8.0|^9.0