xynnn / googletagmanagerbundle Goto Github PK

View Code? Open in Web Editor NEW

26.0 3.0 16.0 93 KB

Google Tag Manager Bundle for Symfony 2

Home Page: https://github.com/xyNNN/GoogleTagManagerBundle

License: GNU Lesser General Public License v3.0

PHP 94.71% Twig 5.29%

symfony-bundle google google-tag-manager php

googletagmanagerbundle's Introduction

GoogleTagManagerBundle

The GoogleTagManagerBundle provides you an easy-to-use method to integrate the Google Tag Manager into your Symfony 2 application.

Note: This Bundle is still in development. Feel free to report encountered issues!

Requirements

2.x

PHP 5.3 and higher
Symfony 2.8 and higher

3.x

PHP 5.6 and higher
Symfony 2.8 and higher

Install

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

2.x

$ composer require xynnn/google-tag-manager-bundle "~2.0"

3.x

$ composer require xynnn/google-tag-manager-bundle "~3.0"

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding the following line in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new Xynnn\GoogleTagManagerBundle\GoogleTagManagerBundle(),
        );

        // ...
    }

    // ...
}

Step 3: Enable Google Tag Manager

Add the configuration to your yaml file. Please don't forget to adjust your Google Tag Manager Id.

Step 4: Insert the ViewHelper

Insert the ViewHelper into your layout file to enable the Google Tag Manager. Please be aware to insert into right after the HTML body tag!

<body>
{{ google_tag_manager_body() }}
...
</body>

And right after the HTML head tag:

<head>
{{ google_tag_manager_head() }}
...
</head>

And right before the closing BODY tag:

{{ google_tag_manager_body_end() }}
</body>

Or use the autoAppend setting to let a kernel reponse listener add them to your layout automatically.

Additional instructions: https://developers.google.com/tag-manager/quickstart

Step 5: Fill up the DataLayer from Google Tag Manager (Optional)

If you want to send some information to the Google Tag Manager, you can use the dataLayer.

/** @var GoogleTagManagerInterface $manager */
$manager = $this->get('google_tag_manager');
$manager->setData('example', 'value');

And if you want to add pushes at the end of the body (not in initial dataLayer):

/** @var GoogleTagManagerInterface $manager */
$manager = $this->get('google_tag_manager');
$manager->addPush(['test' => 123);

Configuration

google_tag_manager:
    enabled: true
    id: "GTM-XXXXXX"
    autoAppend: true|false

An optional paramater called additionalParamaters allows specifying URL parameters to add on to the tag manager URLs. This can be used to support custom environments in tag manager.

google_tag_manager:
    additionalParameters: gtm_auth=XXXXXXXXXXXXX&gtm_preview=env-30&gtm_cookies_win=x

Authors

Philipp Bräutigam

... and Contributors!

License

googletagmanagerbundle's People

Contributors

Stargazers

Watchers

Forkers

tmirks alltricks electrolutz invit stefandoorn gitter-badger kopeckyales vasike dnna conciergerie-numerique jkabat the-money-platform dsbe-ak tacman

googletagmanagerbundle's Issues

Play nice with Nelmio/ApiDocBundle

Affected versions: 1.x & 2.x

ApiDocBundle (2.13.2) embeds full jQuery lib as js payload directly into the <head> section.
This JS code contains following:

...
(f.support.boxModel?"<!doctype html>":"")+"<html><body>"),cl.close()
...

So GoogleTagManagerListener class (1.0.5 / 2.1.0) do not respect that and inject GTM into JS code, which is not real <body>.

Solution is to update regex from '/<body\b[^>]*>/' to '/<\/head>\s*<body\b[^>]*>/'.

Unfortunately could not provide PR right now, maybe later this week, if it won't be fixed earlier.

Release 3.1.2 contains breaking changes

Following the merge of #49, it looks like release 3.1.2 was tagged directly on master, thus including in that release every change made for 4.x

I'm unable to open a PR to fix this, as it involves creating a new branch :

git checkout tags/3.1.1 -b 3.x
git cherry-pick f477eee

...then tagging that as 3.1.x

Is this acceptable to you?

Support for multiple environments

It's a great extension, but missing one key thing that we need, the support for multiple tag manager environments. I'd like to allign these with our test/staging environments.

Essentially these environments are signalled by adding some parameters to the URLs in both the header and footer. I wonder if we could set these somehow in the config so that they can be passed from environment variables.

&gtm_auth=&gtm_preview=env-33&gtm_cookies_win=x

Perhaps just a section for additional URL parameters so that it isn't tied to the current implementation?

Move to modern directory structure, extend AbstractBundle

AbstractBundle simplifies the setup a lot, available with Symfony 6.1+

https://symfony.com/blog/new-in-symfony-6-1-simpler-bundle-extension-and-configuration

Also, things like templates and config have moved:

https://symfony.com/doc/current/bundles/best_practices.html

I always disliked looking in Resources/views for the templates!

So maybe a major update instead of minor with #52 ?

The "google_tag_manager" extension is not enabled.

I'm using Twig 2.4.3, Twig Extensions 1.5.1 and Symfony 3.8.3. When autoAppend is enabled, I run into the following error:

Twig_Error_Runtime:
The "google_tag_manager" extension is not enabled.

  at vendor/twig/twig/lib/Twig/ExtensionSet.php:92
  at Twig_ExtensionSet->getExtension('google_tag_manager')
     (vendor/twig/twig/lib/Twig/Environment.php:622)
  at Twig_Environment->getExtension('google_tag_manager')
     (vendor/xynnn/google-tag-manager-bundle/EventListener/GoogleTagManagerListener.php:49)
  at Xynnn\GoogleTagManagerBundle\EventListener\GoogleTagManagerListener->onKernelResponse(object(FilterResponseEvent), 'kernel.response', object(TraceableEventDispatcher))

Enable on error pages with autoAppend

Right now the GTM code seems not to appear on error pages when autoAppend=true. Would be good if it would.

Empty data when using ESI (not the main request)

Bundle version : 2.4.2
Since the kernel.reset is released i've got a big issue when displaying data.
I'm using esi_render to get the template who will be displaying the tagmanager data. But as it's an ESI this is not the main request, so at the end a the main request, all data is reseted and when i print it with the esi request the data is empty.
What is the good practice to avoid loss of data between main and esi request in this case ? i can't avoid using esi as all my pages are cached but the datalayer part must not be cached ?

Using the "Twig_Extension" class is deprecated since Twig version 2.7

any plan to update it?

solution:
Twig\Extension\AbstractExtension intsead of twig_extension
Twig\TwigFunction instead of Twig_SimpleFunction

create yaml file for config: google_tag_manager.yaml (this info is lack in docs)

Support Symfony 6

Hello there,

I was wondering if it would be possible to check that dependencies symfony/* version 6 are compatible with this package and, if so, upgrade the composer to allow them.

At least with symfony/dependency-injection, it doesn't seem that any breaking change has been added - https://github.com/symfony/dependency-injection/releases/tag/v6.0.0

Thanks already for your project.

Separate helpers for head/body

I'm just implementing GTM and their instructions are to put the JS part as high as possible inside the and the NOSCRIPT part directly inside the .

Currently all goes into the . I'm not sure how this affects performance, but I can imagine it does a bit. I haven't researched how easy it would be to split this up, but it might be a good add-on.

Latest instructions: https://developers.google.com/tag-manager/quickstart

BC breaks with Symfony 2.8 & GTM bundle 2.4

Running Symfony 2.8.27, updated to xyNNN/GoogleTagManagerBundle 2.4, received the error:

[InvalidArgumentException]
  The service "listener.google_tag_manager" must be public as event listeners are lazy-loaded.

when booting the application (even post-update cache:clear hook wouldn't complete). Rolled back to 2.3 and all is ok.

HTML append breaks BinaryFileResponse due to default null content type

The Symfony\Component\HttpFoundation\BinaryFileResponse(); on default instantiation has a null content type, this bundle intercepts those files and tries to inject the tag manager into the file, correctly Symfony does not allow this and throws a 500 error:

Uncaught PHP Exception LogicException: "The content cannot be set on a BinaryFileResponse instance."

Maybe the logic here could be reviewed to not try to inject when the content type is null?

// only append to HTML responses
if (!in_array($event->getResponse()->headers->get('content-type'), array('text/html', null))) {
    return false;
}