aztech/event-bus-extra-mixpanel

There is no license information available for the latest version (v1.0.2) of this package.

aztech/event-bus Mixpanel publisher provider

v1.0.2 2014-08-28 15:07 UTC

This package is not auto-updated.

Last update: 2024-05-06 23:35:16 UTC


README

Build status

Build Status Code Coverage Scrutinizer Quality Score Dependency Status HHVM Status

Stability

Latest Stable Version Latest Unstable Version

Installation

Via Composer

Composer is the only supported way of installing aztech/event-bus-extra-mixpanel . Don't know Composer yet ? Read more about it.

$ composer require "aztech/event-bus-extra-mixpanel":"~1"

Autoloading

Add the following code to your bootstrap file :

require_once 'vendor/autoload.php';

Dependencies

  • mixpanel/mixpanel-php : ~2

Supported elements :

  • Persistent publish

Configuration options & defaults

Parameter Default Description
project-token required Your Mixpanel project token.
always-flush false Whether to flush events after each Mixpanel publish.

The always-flush parameter is useful if you want to use the plugin in long running processes. By default, the Mixpanel API flushes sent events only at the end of the execution cycle. This is fine for most cases, but in long running processes, you can set this option to true to ensure an event is flushed by the API after each publish.

Initialization

require_once 'vendor/autoload.php';

use \Aztech\Events\Bus\Events;
use \Aztech\Events\Bus\Plugins\Mixpanel\Mixpanel;

Mixpanel::loadPlugin('mix');

// See options chart for actual parameters
$options = array('project-token' => 'YOUR_TOKEN');

$publisher = Events::createPublisher('mix', $options);
$event = Events::create('category', array('property' => 'value'));

$publisher->publish($event);
// ...