exs/lander-tracking-awe-bundle

This bundle adds a new AWE's specific extracter and formatter for EXSLanderTrackingAWEBundle.

v1.1.3 2018-01-29 18:27 UTC

This package is auto-updated.

Last update: 2024-12-29 05:38:27 UTC


README

Build Status

What is this bundle doing ?

This bundle is not a standalone bundle and requires EXS-LanderTrackingHouseBundle.

It will add an extracter and a formatter to be added to EXS-LanderTrackingHouseBundle to manage AWE tracking parameter.

The extracter service searches for parameters :

  • prm[campaign_id] which contains {cmp}
  • subAffId which contains a string composed of {exid}~{visit}

The formatter service will add the parameters if :

  • prm[campaign_id] will contains {cmp}
  • subAffId will contains a string composed of {exid}~{visit}

Installation

Download the bundle using composer

$ composer require exs/lander-tracking-awe-bundle

Enable the bundle, and the EXS-LanderTrackingHouseBundle that is installed as a requirement.

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new EXS\LanderTrackingHouseBundle\EXSLanderTrackingHouseBundle(),
        new EXS\LanderTrackingAWEBundle\EXSLanderTrackingAWEBundle(),
        // ...
    );
}

Configuration

The cmp parameter has a default value configurable with this configuration key :

# Default values.
exs_lander_tracking_awe:
    default_cmp: 1

This default value will be used over EXS-LanderTrackingHouseBundle's cmp default value.

Usage

Example :

    <a href="{{ 'http://www.test.tld/' | appendTracking('awe') }}">Some link</a>
    <!-- Will generate : "http://www.test.tld/?prm[campaign_id]=123&subAffId=987654321~5" -->
    
    <a href="{{ 'http://www.test.tld/?foo=bar' | appendTracking('awe') }}">Some link</a>
    <!-- Will generate : "http://www.test.tld?foo=bar&prm[campaign_id]=123&subAffId=987654321~5" -->

See EXS-LanderTrackingHouseBundle's documentation for more information.