brycematheson / laravel_ab_test
Laravel 10 AB 测试包
Requires
- php: ^8.0
- jaybizzle/crawler-detect: ^1.2
- laravel/framework: ^8.0 || ^9.0 || ^10.0 || ^11.0
Requires (Dev)
- mockery/mockery: ^1.0
- orchestra/testbench: 3.9.*
- phpunit/phpunit: ^8.0 | ^9.0
This package is auto-updated.
Last update: 2024-09-18 23:06:28 UTC
README
此包可以帮助您找到哪些内容在您的网站上有效,哪些无效。
它允许您创建实验和目标。访问者将随机接收下一个实验,您可以根据该实验定制您的网站。视图和目标转换将被跟踪,您可以在报告中查看结果。
安装
此包是 ben182/laravel-ab 的克隆版,但已升级以支持 Laravel v10 和 11。
您可以通过 composer 安装此包
composer require brycematheson/laravel_ab_test
配置
安装后发布配置文件
php artisan vendor:publish --provider="Brycematheson\Abtest\AbtestServiceProvider"
您可以在其中定义您的实验和目标。
最后,运行新添加的迁移
php artisan migrate
应该添加两个新迁移。
用法
实验
@if (Abtest::isExperiment('logo-big')) <div class="logo-big"></div> @elseif (Abtest::isExperiment('logo-grayscale')) <div class="logo-greyscale"></div> @elseif (Abtest::isExperiment('brand-name')) <h1>Brand name</h1> @endif
这是包最基本的用法。您不需要初始化任何东西。如果您调用 isExperiment
,则包会为您处理一切。
或者,您可以使用自定义的 blade if 语句
@ab('logo-big') <div class="logo-big"></div> @elseab('logo-grayscale') <div class="logo-greyscale"></div> @elseab('brand-name') <h1>Brand name</h1> @endab
这将完全相同地工作。
如果您不想进行任何持续的渲染,您可以调用
Abtest::pageView()
直接触发带有随机实验的新页面视图。此函数也将由 isExperiment
调用。
在底层,一个新会话项会跟踪当前实验。会话只会得到一个实验,只会触发一个页面视图。
您可以使用以下方法获取当前实验
// get the underlying model Abtest::getExperiment() // get the experiment name Abtest::getExperiment()->name // get the visitor count Abtest::getExperiment()->visitors
或者,还有一个请求助手供您使用
public function index(Request $request) { // the same as 'Abtest::getExperiment()' $request->abExperiment() }
目标
要完成一个目标,只需调用
Abtest::completeGoal('signup')
此函数将增加分配给活动实验的目标的转换。如果没有为会话运行活动实验,将创建一个。您在每个会话中只能触发一次目标转换。这将通过另一个会话项来防止。该函数返回底层的目标模型。
要获取当前会话中所有完成的目标
Abtest::getCompletedGoals()
机器人和服务爬虫
此包可以尝试忽略机器人和爬虫注册页面视图。只需在配置中启用 ignore_crawlers
选项即可。
报告
要获取页面视图、完成的目标和转换的报告,请调用报告命令
php artisan ab:report
这将打印类似以下内容
+---------------+----------+-------------+
| Experiment | Visitors | Goal signup |
+---------------+----------+-------------+
| big-logo | 2 | 1 (50%) |
| small-buttons | 1 | 0 (0%) |
+---------------+----------+-------------+
重置
要重置所有访问者和目标完成,请调用重置命令
php artisan ab:reset
事件
此外,您还可以挂钩到两个事件
ExperimentNewVisitor
会在实验分配给新访问者时触发一次。您可以将实验作为事件的属性获取。GoalCompleted
会在目标完成时触发一次。您可以将目标作为事件的属性获取。
测试
composer test
变更日志
有关最近更改的更多信息,请参阅 CHANGELOG
贡献
有关详细信息,请参阅 CONTRIBUTING
安全
如果您发现任何与安全相关的问题,请通过电子邮件 moin@benjaminbortels.de 而不是使用问题跟踪器。
致谢
许可
MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件
Laravel 包模板
本软件包使用Laravel 包模板生成。