README

Bundle include segment.io library for analytics

include segmentio/analytics-php

Documentation

The bulk of the documentation is stored in the Resources/doc folder in this bundle

Installation

Installing the bundle via packagist is the quickest and simplest method of installing the bundle. Here are the steps:

Step 1: Composer require

$ php composer.phar require "farmatholin/segment-io-bundle":"^1.3" 

Step 2: Enable the bundle in the kernel (Symfony < 3.4)

<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Farmatholin\SegmentIoBundle\SegmentIoBundle(), // ... ); } 

That's it! You are ready to use Segment.io with symfony2.

Configuration

Required segment write key:

Symfony 4.X || 5.X || 6.X :

# config/packages/segment_io.yaml segment_io: write_key: "%env(SEGMENTIO_KEY)%" # add your key guest_id: "guest" # default guest. Guest id for annotation Track and Page env: prod #default prod. Can be prod (sending to segment) and dev (not sending) data_residency: Oregon #default Oregon. Can be Oregon, Dublin, Signapore or Sydney. Overwritten by host option options: consumer: socket #default debug: false #default ssl: false #default max_queue_size: 10000 #default flush_at: 100 #default timeout: 0.5 #default filename: null #default host: #default not set - uses segment default api

Symfony 2.X || 3.X

# app/config/config.yml segment_io: write_key: "%your_key%" #add your key guest_id: "guest" # default guest. Guest id for annotation Track and Page env: prod #default prod. Can be prod (sending to segment) and dev (not sending) data_residency: Oregon #default Oregon. Can be Oregon, Dublin, Signapore or Sydney. Overwritten by host option options: consumer: socket #default debug: false #default ssl: false #default max_queue_size: 10000 #default flush_at: 100 #default timeout: 0.5 #default filename: null #default host: #default not set - uses segment default api.

Data Residency

Segment allows the usage of regional infrastructure. If your Segment plan supports this, you can set the data_residency option to either Oregon, Dublin, Singapore or Sydney. If you set the option.host value, the data_residency setting is ignored and the host option is used.

Usage

Get segment_io.analytics service from the service container and start using it:

$analytics = $this->get('segment_io.analytics'); $analytics->page([]);

Or using Annotations (Page and Track)

User for annotations is getting from TokenStorage. If user doesn't exit, id set to guest or from configuration 'guest_id'

use Farmatholin\SegmentIoBundle\Configuration\Page; use Farmatholin\SegmentIoBundle\Configuration\Track; /**  * @Route("/", name="homepage")  *  * @Page(  * name="index",  * category="page",  * properties={"foo":"bar"}  * )  * @Track(  * event="visit homepage",  * properties={"bar":"foo"},  * useTimestamp=true,  * context={"aa":"bb"}  * )  */ public function indexAction(Request $request) { // your code }

Or using dependency injection:

use Farmatholin\SegmentIoBundle\Util\SegmentIoProvider; /**  * @Route("/", name="homepage", methods={"GET"})  *  * @param SegmentIoProvider $segmentIoProvider  */ public function index(SegmentIoProvider $segmentIoProvider) { $segmentIoProvider->track([ 'userId' => 123, // or 'guest' if not available 'event' => 'visit homepage', 'properties' => [ 'foo' => 'bar' ] ]); $segmentIoProvider->flush(); // your code }

Refer to Segment.io analytics-php library.