mnapoli/piwik-twig-extension

This library integrates Matomo into Twig

Maintainers

Details

github.com/mnapoli/MatomoTwigExtension

Source

Issues

Installs: 234 200

Dependents: 1

Suggesters: 0

Security: 0

Stars: 11

Watchers: 4

Forks: 3

Open Issues: 0

3.0.0 2020-04-24 14:45 UTC

Requires

Requires (Dev)

MIT 472fd49157d64e78081b7a626095ea989cae8471

This package is auto-updated.

Last update: 2024-10-28 13:52:30 UTC

README

Build Status

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.