meinfernbus/google-bundle

Fork of AntiMattr GoogleBundle. Static Google maps with caching, Adwords with remarketing & lots of other fixes.

v0.2.2 2020-12-24 11:12 UTC

Requires

• php: ^7.2
• symfony/config: ^3.4 || ^4.4 || ^5.0
• symfony/dependency-injection: ^3.4 || ^4.4 || ^5.0
• symfony/http-kernel: ^3.4 || ^4.4 || ^5.0

Requires (Dev)

• irstea/php-cs-fixer-shim: ^2.16
• phpunit/phpunit: ^8.5 || ^9.4
• symfony/browser-kit: ^3.4 || ^4.4 || ^5.0
• symfony/framework-bundle: ^3.4 || ^4.4 || ^5.0
• symfony/twig-bundle: ^3.4 || ^4.4 || ^5.0
• symfony/yaml: ^3.4 || ^4.4 || ^5.0

MIT

• antimattr
• EricReiche
• MeinFernbus

• analytics
• google
• adwords
• maps
• antimattr

README

GoogleBundle

The GoogleBundle adds the ability to add various google-related services to your application. These include Google Analytics, Adwords and Static Maps. This module was forked a long time ago from https://github.com/antimattr/GoogleBundle but is now maintained as a separate project.

Installation

Composer

composer require meinfernbus/google-bundle

Application Kernel

Add GoogleBundle to the registerBundles() method of your application kernel:

    public function registerBundles()
    {
        return array(
            new AntiMattr\GoogleBundle\GoogleBundle(),
        );
    }

Configuration

Google Analytics

Application config.yml

Enable loading of the Google Analytics service by adding the following to the application's config.yml file:

    google:
        analytics:
            trackers:
                default:
                    name:      MyJavaScriptCompatibleVariableNameWithNoSpaces
                    accountId: UA-xxxx-x
                    domain:    .mydomain.com
                    trackPageLoadTime: true
                    anonymizeIp: false

View

Include the Google Analytics Async template in the head tag or just before the </body> of your layout (The template will lazy load _gaq).

With twig:

    {% include "GoogleBundle:Analytics:async.html.twig" %}

Features

Logging a Default Page View

Requires no additional code

Sending a Custom Page View

    $this->container()->get('google.analytics')->setCustomPageView('/profile/'.$username);

Adding to Page View Queue

Note: Page View Queue is always executed before a Custom Page View

    $this->container()->get('google.analytics')->enqueuePageView('/my-first-page-view-in-queue');
    $this->container()->get('google.analytics')->enqueuePageView('/my-second-page-view-in-queue');

Ecommerce Tracking

    $transaction = new \AntiMattr\GoogleBundle\Analytics\Transaction();
    $transaction->setOrderNumber('xxxx');
    $transaction->setAffiliation('Store 777');
    $transaction->setTotal(100.00);
    $transaction->setTax(10.00);
    $transaction->setShipping(5.00);
    $transaction->setCity("NYC");
    $transaction->setState("NY");
    $transaction->setCountry("USA");
    $this->get('google.analytics')->setTransaction($transaction);

    $item = new \AntiMattr\GoogleBundle\Analytics\Item();
    $item->setOrderNumber('xxxx');
    $item->setSku('zzzz');
    $item->setName('Product X');
    $item->setCategory('Category A');
    $item->setPrice(50.00);
    $item->setQuantity(1);
    $this->get('google.analytics')->addItem($item);

    $item = new \AntiMattr\GoogleBundle\Analytics\Item();
    $item->setOrderNumber('bbbb');
    $item->setSku('jjjj');
    $item->setName('Product Y');
    $item->setCategory('Category B');
    $item->setPrice(25.00);
    $item->setQuantity(2);
    $this->get('google.analytics')->addItem($item);

Google Adwords

Application config.yml

Enable loading of the Google Adwords service by adding the following to the applications's config.yml file:

    google:
        adwords:
            conversions:
                account_create:
                    id:    111111
                    label: accountCreateLabel
                    value: 0
                    remarketing: false
                checkout_thanks:
                    id:    222222
                    label: checkoutThanksLabel
                    value: 0
                    remarketing: false
                remarketing:
                    id:    333333
                    label: "google-assigned-remarketing-label"
                    value: 0
                    remarketing: true

Controller

    $this->get('google.adwords')->activateConversionByKey('account_create');

View

Include the Google Adwords tracking template like this

    {% include "GoogleBundle:Adwords:track.html.twig" %}

Google Maps - Static Map

Application config.yml

Enable loading of the Google Maps Static service by adding the following to the applications's config.yml file:

google:
    maps:
        config:
            key: YOUR-API-KEY-FROM-GOOGLE
            host: YOUR-HOST // Host where the gmap image is served.
            (Optional, only needed if script is running from CLI. If not set $_SERVER is used)
            uploadDir: '%kernel.project_dir%/web/maps' // absolute path to directory where map files
            publicDir: '/maps' //http path where map files supposed to be publicly available
           

Get your key at https://code.google.com/apis/console/

Controller

    use AntiMattr\GoogleBundle\Maps\StaticMap;
    use AntiMattr\GoogleBundle\Maps\Marker;

    ...

    /** @var \AntiMattr\GoogleBundle\MapsManager $googleContainer */
    $googleContainer = $this->container->get('google.maps');
    $map = $googleContainer->createStaticMap();
    $map->setId("Paul");
    $map->setSize("512x512");
    $marker = new Marker();
    $marker->setLatitude(40.596631);
    $marker->setLongitude(-73.972359);
    $map->addMarker($marker);
    $googleContainer->addMap($map);

View

Include the Google Maps in your template like this:

    {% if google_maps.hasMaps() %}
		{% for map in google_maps.getMaps() %}
			{% autoescape false %}
				{{ map.render }}
			{% endautoescape %}
		{% endfor %}
	{% endif %}