README

Important

Your bundle might not work any more after major changes to the master branch. To solve that problem, please update your composer.json and set your bundle version to ~1.0.0 :

    {
        "require": {
            "kairos/googleanalyticsserversidebundle": "~1.0.0"
        }
    }

This bundle has been updated to support universal analytics which is a far better solution than the php-ga library.

Summary :

Google Analytics Server Side Bundle is aimed at sending google analytics hits from a server. This can be very usefull for an app, or in case google analytics is blocked.

This bundle made originally use of the great project from UnitedPrototype : http://code.google.com/p/php-ga/ But now use the new google universal analytics which is more efficient and robust.

Requirements

Requires PHP 5.3 as namespaces and closures are used, Symfony 2 framework

Installation :

In your composer file file :

    {
        "require": {
            "kairos/googleanalyticsserversidebundle": "~2.0.0"
        }
    }

Update your composer :

    php composer.phar update kairos/googleanalyticsserversidebundle

Composer will install the bundle to your project's vendor/kairos directory.

Enable the bundle in the AppKernel file :

    <?php
    // app/AppKernel.php

    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Kairos\GoogleAnalyticsServerSideBundle\KairosGoogleAnalyticsServerSideBundle(),
        );
    }

In your config.yml

    kairos_google_analytics_server_side:
        account_id:  UA-XXXXXXXX-XX
        domain:     your.domain
        async: true|false       // use register shutdown function to send "async" hits to google analytics
        ssl: true|false
        localhost: true|false   // set to true if you want js code to push analytics on localhost
        timeout: 10             // value in seconds if you don't want your php script to block in case ga dos not respond
        connect_timeout: 2      // same thing as above

To enable js tracking

    twig:
        globals:
            gajs: "@ga_js_tracker"

How To use :

Universal analytics :

Super mega cool tip ! You can use both serverside and client side ! The session will be synched between your serverside and client side code so no doubles

Serverside usage :

You can use directly the documentation given by google at the address : https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters

    // Call tracker from container
    $this->container->get('ga_mp_tracker')->track('pageview',
        array(
            'dp' => 'your.address.com',
            'dt' => 'your title'
        )
    );

    // Track event
    $this->container->get('ga_mp_tracker')->track('event',
        array(
            'dp' => 'your.address.com',
            'dt' => 'your title',
            'ec' => 'event category',
            'ea' => 'event action',
            'el' => 'event label',
        )
    );

Client side usage :

To use ga.js on client side, you have to register the ga_js_tracker service in your twig config, then you'll be able to call it this way :

    {{ gajs.getGAjs()|raw }}

You can override trackingId and Domain by calling the function with these parameters :

    {{ gajs.getGAjs('trackingID','domain')|raw }}

Don't forget the raw if you don't want the tag to be escaped bu twig. Your ga.js session will be automatically synched with your server side session (client id is shared in the cookies).

With an old google analytics account :

Warning This is deprecated and not supported any more

    // Initilize GA Tracker
    $tracker = $this->get('google_analytics');
    
    // Assemble Visitor information (could also get unserialized from database)
    $visitor = new GoogleAnalytics\Visitor();
    $visitor->setIpAddress($_SERVER['REMOTE_ADDR']);
    $visitor->setUserAgent($_SERVER['HTTP_USER_AGENT']);
    $visitor->setScreenResolution('1024x768');
    
    // Assemble Session information (could also get unserialized from PHP session)
    $session = new GoogleAnalytics\Session();
    
    // Assemble Page information
    $page = new GoogleAnalytics\Page('/page.html');
    $page->setTitle('My Page');
    
    // Track page view
    $tracker->trackPageview($page, $session, $visitor);

Thanks

This package is directly based on this project from UnitedPrototype : http://code.google.com/p/php-ga/

kairos / googleanalyticsserversidebundle

Maintainers

Details