README

此模块在您的页面底部包含 Piwik 分析 JavaScript。

可通过配置 API 进行配置，您可以通过覆盖 Piwik.ss 模板来更改包含的 JavaScript。

需求

• Silverstripe > 4.0

要使用 SS3 兼容版本，请使用版本 0.2。

安装

最佳安装方式是通过 composer。您也可以克隆仓库或下载 zip 文件，但是您应该找到一个名为 "silverstripe-piwik" 的目录，其中包含所有文件在 vendor/wernerkrauss/ 中。

使用 Composer

composer require wernerkrauss/silverstripe-piwik ^0.4.0

功能

• 将 Piwik 追踪代码包含到您的页面中。您可以通过在模板中调用 $Piwik 来配置是否自动或手动包含
• 默认情况下，仅在前端页面中包含
• 默认情况下，仅在实时模式下包含

配置

Netwerkstatt\Piwik\Extensions\PiwikExtension:
  piwik_server: '//logs.example.com/' #domain without protocol an trailing slash
  piwik_site_id: 123 #the id defined by your piwik install
  show_on_dev: false #default: don't show in dev mode
  show_on_test: false #default: don't show in test mode
  show_on_live: true #default: show in live mode
  auto_include: true #default: include automatically
  include_in_backend: false #default: don't include in backend

与子站模块的使用

当您使用子站时，您可以在 SiteConfig 中添加每个子站/域的 PIWIK 站点 ID。为此，您必须添加一个扩展

SilverStripe\SiteConfig\SiteConfig:
  extensions:
    - Netwerkstatt\Piwik\Extensions\PiwikSiteConfigExtension

您还必须调整用于跟踪代码的模板。将默认的 Piwik.ss 文件复制到您的主题的 /templates/ 文件夹或 /mysite/templates/，并调整设置如下

_paq.push(["setSiteId", "$SiteConfig.PiwikSiteID"]);

排除某些控制器

您可以使用 PiwikExtension.excluded_controllers 配置变量来微调 Piwik 不应包含的控制器。默认情况下，该模块在 dev/build 上禁用。

与子站和可翻译一起使用

当您使用子站与可翻译时，您必须确保将其添加到每个翻译的 SiteConfig 中。一种可能的解决方案是，如果您不将 Piwik SiteID 的值放在 SiteConfig 中，而是直接放在 Subsites DataObject 中。

然后不要扩展 SiteConfig，而是 Subsite

Silverstripe\Subsites\Model\Subsite:
  extensions:
    - Netwerkstatt\Piwik\Extensions\PiwikSiteConfigExtension

并更改您的模板以反映更改

_paq.push(["setSiteId", "$SiteConfig.Subsite.PiwikSiteID"]);