henhed / module-piwik
Requires
- php: ~7.0.0|~7.1.0|~7.2.0|~7.3.0
- magento/framework: ~101.0|~102.0
- magento/module-catalog: ~102.0|~103.0
- magento/module-catalog-search: ~100.0|~101.0
- magento/module-checkout: ~100.0
- magento/module-config: ~101.0
- magento/module-customer: ~101.0|~102.0
- magento/module-quote: ~101.0
- magento/module-sales: ~101.0|~102.0
- magento/module-search: ~100.0|~101.0
- magento/module-store: ~100.0|~101.0
This package is auto-updated.
Last update: 2021-04-24 17:35:46 UTC
README
Henhed_Piwik
Henhed_Piwik 是一个为 Piwik 的电子商务平台 Magento 2 提供的网页分析模块。Piwik 是一个可扩展的免费/开源分析工具,可以自托管,让你拥有完整的数据所有权。Henhed_Piwik 允许你将 Piwik 集成到你的 Magento 2 商店前端。
安装
要安装 Henhed_Piwik,下载并解压 master 压缩包,并将解压的文件夹移动到你的 Magento 2 安装目录下的 app/code/Henhed/Piwik。
unzip magento2-henhed-piwik-master.zip mkdir app/code/Henhed mv magento2-henhed-piwik-master app/code/Henhed/Piwik
或者,你可以将 Henhed_Piwik Git 仓库克隆到 app/code/Henhed/Piwik。
git clone https://github.com/henkelund/magento2-henhed-piwik.git app/code/Henhed/Piwik
或者,如果你愿意,可以使用 Composer 进行安装。
composer require henhed/module-piwik
最后,使用 Magento CLI 工具启用模块。
php bin/magento module:enable Henhed_Piwik --clear-static-content
注意:如果你使用的是 2.2 之前的 Magento 版本,你需要坚持使用 Henhed_Piwik 的 1.x 版本。对于手动安装,请查看 发布存档。对于使用 Composer 的安装,你可以使用 波浪号 或 caret 版本约束运算符(例如 ~1.3
或 ^1.3.1
)。
配置
安装完成后,配置选项可以在 Magento 2 管理面板的 商店/配置/销售/Piwik API 下找到。要开始跟踪,将 启用跟踪 设置为 是,输入你的 Piwik 安装的主机名,然后点击 保存配置。如果你在同一个 Piwik 安装中有多个网站,确保在 Magento 中配置的 站点 ID 是正确的。
定制
如果你需要将一些自定义信息发送到你的 Piwik 服务器,Henhed_Piwik 允许你使用事件观察者来完成。
要在每个页面上设置自定义数据,使用 piwik_track_page_view_before
事件。事件对象和追踪实例将传递给观察者的 execute
方法。
public function execute(\Magento\Framework\Event\Observer $observer) { $tracker = $observer->getEvent()->getTracker(); /** @var \Henhed\Piwik\Model\Tracker $tracker */ $tracker->setDocumentTitle('My Custom Title'); }
如果你只想在特定情况下添加数据,找到一个合适的事件并在观察者的构造函数中请求追踪单例。将追踪器存储在类成员变量中,以便在 execute
方法中稍后使用。
public function __construct(\Henhed\Piwik\Model\Tracker $piwikTracker) { $this->_piwikTracker = $piwikTracker; }
请注意,在服务器端跟踪用户特定信息可能会导致缓存问题。相反,使用 JavaScript 从 cookie、localStorage 或一些 Ajax 请求中检索用户数据,然后使用 Henhed_Piwik JS 组件 ...
require(['Henhed_Piwik/js/tracker'], function (trackerComponent) { trackerComponent.getTracker().done(function (tracker) { // Do something with tracker }); });
... 或者原生的 Piwik 方法将数据推送到 Piwik。
var _paq = _paq || []; _paq.push(['setDocumentTitle', 'My Custom Title']);
请参阅 Piwik 开发者文档 或 \Henhed\Piwik\Model\Tracker 的源代码,了解跟踪 API 中所有可用方法。
免责声明
Henhed_Piwik 被分发,希望它能是有用的,但没有任何保证;甚至没有关于商售性或适用于特定目的的暗示性保证。有关更多信息,请参阅GNU Affero 通用公共许可证。