Download the PHP package filipe07/laravel-ab without Composer
On this page you can find all versions of the php package filipe07/laravel-ab. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download filipe07/laravel-ab
More information about filipe07/laravel-ab
Files in filipe07/laravel-ab
Package laravel-ab
Short Description Laravel A/B experiment testing tool
License MIT
Homepage https://github.com/filipe07/laravel-ab
Informations about the package laravel-ab
This package helps you to find out which content works on your site and which doesn't.
It allows you to create experiments and goals. The visitor will receive randomly the next experiment and you can customize your site to that experiment. The view and the goal conversion will be tracked and you can view the results in a report.
This package is very inspired and a mix of two other packages:
Installation
This package can be used in Laravel 8 or higher.
You can install the package via composer:
Config
After installation publish the config file:
You can define your experiments and goals in there.
Finally, run the newly added migration
Two new migrations should be added.
Usage
Variants
That's the most basic usage of the package. You don't have to initialize anything. The package handles everything for you if you call isVariant
Alternatively you can use a custom blade if statement:
This will work exactly the same way.
If you don't want to make any continual rendering you can call
directly and trigger a new page view with a random variant. This function will also be called from isVarian
.
Under the hood a new session item will keep track of the current variant. A session will only get one variant and only trigger one page view.
You can grab the current variant with:
Alternatively there is a request helper for you:
Goals
To complete a goal simply call:
The function will increment the conversion of the goal assigned to the active variant. If there isn't an active variant running for the session one will be created. You can only trigger a goal conversion once per session. This will be prevented with another session item. The function returns the underlying goal model.
To get all completed goals for the current session:
Persisting visitor data
When used in the above way the visitor data is stored in session data attached to the user. In some cases you might want to trigger a goal completion in an asynchronous way and the users session won't be available. To avoid getting bad data by registering the goal completion under a new variant you can persist the visitor data in the database.
To do this you pass a user identifier to the pageview function.
In your asynchronous request you can then provide the same idenfier to the completeGoals function.
Report
To get a report of the page views, completed goals and conversion call the report command:
This prints something like this:
Reset
To reset all your visitors and goal completions call the reset command:
Events
In addition you can hook into two events:
VariantNewVisitor
gets triggered once an variant gets assigned to a new visitor. You can grab the variant and visitor instance as properties of the event.GoalCompleted
gets triggered once a goal is completed. You can grab the goal as a property of the event.
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Benjamin Bortels
- Martin Fjordvald
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.
All versions of laravel-ab with dependencies
illuminate/support Version ^7.0 | ^8.0 | ^9.0 | ^10.0
jaybizzle/crawler-detect Version ^1.2