Download the PHP package asciisd/referrals-laravel without Composer
On this page you can find all versions of the php package asciisd/referrals-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download asciisd/referrals-laravel
More information about asciisd/referrals-laravel
Files in asciisd/referrals-laravel
Package referrals-laravel
Short Description Adding referrals feature to your laravel project
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package referrals-laravel
Referrals package for laravel
Compatible with laravel >= 8.0
Installation:
To install the package in your project you need to require it with composer.
Configs:
First, you need to set the package configurations by publishing the config file to your project config directory.
To publish the referrals.php config file use the publish command:
and from the providers list choose the ReferralsLaravelServiceProvider.
Next, inside your .env file, add the route you want the invited user to be redirected to.
By default, the invited user will be redirected to the registration page with route register.
If you plan to use cookies to save the referral token, by default, the cookie life-time is set to 24 hours. You can customize
the cookie life-time by setting the referral_token_cookie_lifetime inside your .env file.
Usage:
To use the package in your project, simply use the Referrable trait in your users model.
Next, use php artisan migrate to migrate the database file. This migration wll create new table referrals. A one-to-many relationship
is created with the users table.
The referrer_id is the id of the user who sent the invitation link.
Saving the referral token to a cookie:
For further usage of the referral token, you can use ReferralsLaravel middleware inside your Kernel.php file.
You can set and alias to your middleware to use it with specific routes:
Or you can set it to any of your middleware groups:
Retrieving Referral Data:
To get all user referrals user referrer relationship property along with user object.
To get user referral details from the referrals table use the property referrals.
To check if the user is invited by another user, use the isReferred() method on the user object.
To check of the user has referral token or not use the hasReferralToken() method.
To generate user referral token, use the generateReferalToken() method. The method
checks if the user has referral token or not, then it generated the referrals token.
To get the referral link you can either add referral_link attribute to the $append array inside
User model and use it as user attribute,
Or, you can use the getReferralLink() method with the user object.
To get user referral token you can either add referral_token attribute to the $append array
inside the User model and use it as attribute,
Or, you can use the getReferralToken() method with the user object.
Register with Nova
Add nova resource Referral will be automatically published during publishing the service provider, to use
the package with Nova just add the Referral resource to NovaServiceProvider file to register it inside your nova.
