uecode/segment-io-php

A PHP library for reporting events to the Segment.io API

Segment PHP Client

, _(*1)

This library provides a Web Service Client for the Segment.io HTTP API using Guzzle v5., _(*2)

Installation

Installation, _(*3)

Install the latest version with:, _(*4)

$ composer require uecode/segment-io-php ~1.1

Basic Usage

use SegmentIO\Client;

$client = new Client(['write_key' => $writeKey]);

// Identify the user - assuming, below, that you
// have a $user object from your database
$client->identify([
    'userId' => $user->getId(),
    'traits' => [
        'name' => $user->getName(),
        'email' => $user->getEmail()
    ]
]);

// Track an event (userId or anonymousId is required for all events!)
$client->track([
    'userId' => $user->getId(),
    'event'  => 'Some Event Happened',
    'properties' => [
        'foo' => 'bar'
    ]
]);

Configuration Options

The client accepts an array of configuration options:, _(*5)

Using Batching

By default, this client will attempt to queue all calls to the API and send them out over a single batch request. Because of the blocking nature of PHP, this method reduces the amount of time the Client has to wait for requests to the API., _(*6)

Batching does not apply to the import() method on the client., _(*7)

There are two methods of Batching Available:, _(*8)

Request Batching

Note: This is enabled by default., _(*9)

When making calls to the API, the events will be placed into a queue and will be flushed under one of two cases: when / if the max_queue_size is reached or at the end of the PHP Request., _(*10)

Changing the Client options for max_queue_size and batch_size will affect how often the Client attempts to flush events., _(*11)

File Batching

The file batching is a more performant method for making requests to Segment.io., _(*12)

Each time a track or identify call is made, it will record that call to a log file. The log file is then uploaded “out of band” by running the included parse command., _(*13)

You can change the location of the log file by using the log_file Client configuration option. If a log_file is not specified, it will default to: /tmp/segment-io.log., _(*14)

To upload the Events from the log file to Segment.io, run the included parse command:, _(*15)

./parse YOUR_WRITE_KEY --file /tmp/segment-io.log

Tracking HTTP API Documentation

Documentation is available for the Tracking HTTP API at segment.io/docs/tracking-api/., _(*16)

License

This software is released under the MIT License. See the license file for details., _(*17)