mnapoli / piwik-twig-extension
This library integrates Matomo into Twig
Installs: 237 333
Dependents: 1
Suggesters: 0
Security: 0
Stars: 11
Watchers: 4
Forks: 3
Open Issues: 0
Requires
- php: >=7.0
- twig/twig: ~2.10|~3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.13
- php-coveralls/php-coveralls: ^2.0
- symfony/phpunit-bridge: ^5.0
This package is auto-updated.
Last update: 2024-10-28 13:52:30 UTC
README
This library integrates Matomo into Twig. Previously named PiwikTwigExtension.
Installation
composer require "mnapoli/piwik-twig-extension"
Usage
You have 2 ways to give the Matomo host and site ID:
-
When creating the extension (recommended)
$twig->addExtension(new MatomoTwigExtension('my-matomo-host.com', 123));
In the templates, you then just call
{{ matomo() }}
.This solution is appropriate in most cases.
-
When calling the Twig function
$twig->addExtension(new MatomoTwigExtension());
In the templates, you have to provide the host and site id:
{{ matomo('my-matomo-host.com', 123) }}
.This solution is perfect if you want to be able to customize the site id or Matomo host in the template.
Don't forget to add the tracker script at the end of the HTML document, for example:
<!DOCTYPE html> <html> <head> ... </head> <body> ... {{ matomo() }} </body> </html>
Development environment
In some environments, you want to disable Matomo's tracking (for example on your local machine).
That is easily possible by passing false
for the $enabled
parameter:
$twig->addExtension(new MatomoTwigExtension($host, $siteId, false));
License
This library is released under the MIT license.