PHP Examples

From Open Rail Data Wiki
Revision as of 17:58, 9 July 2013 by Jonathon Hurley (talk | contribs) (Added categories)
Jump to navigation Jump to search

There are two ways to access the Network Rail data feeds from PHP: the PECL Stomp package or the Stomp library.

PECL Stomp Package

The PECL Stomp Package can be installed through the PECL command line tool; this is part of the PHP PEAR extensions package. Instructions for installing PEAR and PECL on different systems can be found by searching the web. Once PECL is installed, type pecl install stomp at the command line.

Documentation for the PECL Stomp package can be found on the PHP:Stomp Manual page.

Basic Example

This example connects to the Network Rail data feed via STOMP, subscribes to the TRAIN_MVT_ALL_TOC topic, and sets up a loop listening for new frames.

// Network Rail Stomp Handler example by ian13
$server = "tcp://";
$user = "username";
$password = "password";
$channel = "TRAIN_MVT_ALL_TOC";
$con = new Stomp($server, $user, $password);
if (!$con) {
   die('Connection failed: ' . stomp_connect_error());
$con->subscribe("/topic/" . $channel);
   if ($con->hasFrame()){
       $msg = $con->readFrame();
       foreach (json_decode($msg->body) as $event) {
         // do stuff with $event here
die('Connection lost: ' . time());

Durable Subscriptions

The example above will only receive messages while it is connected to the STOMP server. By specifying a client-id header in the connection, and an activemq.subscriptionName header in the subscription, messages that were sent while the client was offline will be received upon connection.

// Specify a client-id header in the connection
$con = new Stomp($server, $user, $password, array('client-id' => 'somename'));
// Specify an activemq.subscriptionName header in the subscription
$con->subscribe("/topic/" . $channel, array('activemq.subscriptionName' => 'somename'));

Stomp library

An alternative Stomp client is available from Fuse Source. It has some minor issues, such as injecting spaces in the username/password, and sleeping on message retrieval.

A fixed version can be obtained from here or here.

 $con = new Stomp('tcp://');
 $con->clientId = 'someclient';
 $con->connect($username, $password);
 $msg = $con->readFrame();
 if ($msg != null) {
   foreach (json_decode($msg->body) as $event) {
     // do stuff with $event here

Network Rail Open Data Feeds
Data Feeds About the Feeds Account States Durable Subscriptions Example Code ( PHP / C# / Java / Ruby / Node.js) • Advanced UsesFAQ Release Notes
Train Movements Train Movements Feed Train Activation Train Cancellation Train Movement Train Reinstatement Change of Origin Change of Identity Change of Location TSPEED Field Planned Cancellations Cancellation Codes
TD TD Feed C-Class Messages S-Class Messages Train Describers TD Berths
TSR TSR Feed Route Codes
SCHEDULE SCHEDULE Feed Schedule and Location Records Association Records CIF Codes How Scheduling Works Allowances
Reference Data Reference Data Feed TOC Codes CIF Codes Delay Attribution Codes Identifying Locations (STANOX, TIPLOC, NLC and 3-Alpha Codes) STANOX Geographical Areas Train Planning data