Git Product home page Git Product logo

piwiktwigextension's Introduction

Piwik Twig integration

Build Status Coverage Status

This library integrates Piwik into Twig.

Installation

composer require "mnapoli/piwik-twig-extension"

Usage

You have 2 ways to give the Piwik host and site ID:

  • When creating the extension (recommended)
$twig->addExtension(new PiwikTwigExtension('my-piwik-host.com', 123));

In the templates, you then just call {{ piwik() }}.

This solution is appropriate in most cases.

  • When calling the Twig function
$twig->addExtension(new PiwikTwigExtension());

In the templates, you have to provide the host and site id: {{ piwik('mypiwik.host.com', 123) }}.

This solution is perfect if you want to be able to customize the site id or Piwik 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>
        ...

        {{ piwik() }}
    </body>
</html>

Development environment

In some environments, you want to disable Piwik's tracking (for example on your local machine). That is easily possible by passing false for the $enabled parameter:

$twig->addExtension(new PiwikTwigExtension($host, $siteId, false));

License

This library is released under the MIT license.

piwiktwigextension's People

Contributors

mnapoli avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.