promatur / sc-analytics
为基于PHP的网站提供的客户端和服务器端分析组合。
v1.1.5
2024-02-29 22:21 UTC
Requires
- php: ^7.3|^8.0
- ext-curl: *
- ext-json: *
- frontpack/composer-assets-plugin: ^0.11.0
- moneyphp/money: ^3.3
Requires (Dev)
- phpstan/phpstan: ^1.4
- phpunit/phpunit: ^9
- roave/security-advisories: dev-master
- sentry/sdk: ^3.1
Suggests
- sentry/sdk: Error handling
README
代码状态
描述
为基于PHP的网站提供的客户端和服务器端分析组合。此存储库基于现有的分析解决方案,并提供了对Matomo和Google Analytics的集成。已使用PHP 7.3
、7.4
和8.1
进行测试。
⠀
⠀
⠀
使用方法
建议使用composer来使用SC-Analytics,这是最简单的方法。只需将promatur/sc-analytics
添加到项目的需求中。
composer require promatur/sc-analytics
使用如下代码示例:
require_once 'vendor/autoload.php'; // - Configure your preferred analytics endpoint \ScAnalytics\Core\AnalyticsConfig::$matomoID = "1"; \ScAnalytics\Core\AnalyticsConfig::$matomoEndpoint = "https://analytics.example.com/"; // - Initialize the analytics system \ScAnalytics\Analytics::init(); // - Get your Analytics Handler $analytics = Analytics::get(); // - Load the Client-Side JavaScript code and initialize the page view $pageData = new \ScAnalytics\Core\PageData("Help Page", ["Support", "Help Page Overview"]) // Put this anywhere you want to load the JavaScript code echo $analytics->loadJS($pageData);
在Wiki中了解更多信息。
资源
SC-Analytics还提供JavaScript资源。如果您想使用服务器端和客户端分析的组合,请在您的composer.json
中配置资源的位置。
{ "extra": { "assets-dir": "assets", "assets-strategy": "copy" } }
如果您想使用其他文件夹作为资源文件夹,请在配置中进行配置。
\ScAnalytics\Core\AnalyticsConfig::$assets = "my-directory";
在Composer Assets Plugin中了解更多。
错误处理
此包集成了Sentry,可选使用。错误将由Sentry自动处理,并添加额外信息。
贡献
使用库
这是一个在LGPL v3或更高版本许可下的免费/开源库。
欢迎您的pull请求和/或反馈!
贡献者
由Jan-Nicklas Adler创建。
我期待您的贡献和pull请求!