php-open-rail-data

A PHP library to consume data from the Open Rail Data initiative., _(*1)

At present only Stomp (ActiveMQ) data for Network Rail is supported, but I will be adding support for Static Network Rail data (such as Schedule) and Stomp support for National Rail in the near future., _(*2)

Installation

This is done via composer (packagist). Add the following to your composer.json file:, _(*3)

{
  "require": {
     "neilmcgibbon/php-open-rail-data": "0.1.0"
  }
}

Currently supported data feeds:

Network Rail
- ActiveMQ realtime feeds (via Stomp)
  - RTPPM - Real Time Passenger Performance Measurements
  - VSTP - Very Short Term Planning
  - Train Movements - Cancellations, Activations, Reinstatements, etc.
  - TD - Train Describer events

Feeds not yet supported

Network Rail, _(*4)
- ActiveMQ realtime feeds (via Stomp)
  - TSR - Temporary Speed Restrictions
- Static feeds (via HTTP)
  - Schedule - Schedule data
  - Reference Data - Reference data
National Rail, _(*5)
- all feed types

Usage:

Stomp - Network Rail events

Events are processed via the observer / event dispatcher pattern, _(*6)

Example:

To listen for Real Time Passenger Performance Measurements (RTPPM events), and then dump out the number of late trains on the "National Page" level:, _(*7)

Create the event listener, _(*8)

class ExampleEventListener
{

  public function onEventReceived(RtppmEvent $event)
  {
    echo "Received event. National page late trains count: ";
    echo $event->getNationalPage()->getPerformance()->getLateCount() . PHP_EOL;
  }
}

Create the connection and start listening, _(*9)


$connection = new \OpenRailData\NetworkRail\Services\Stomp\Connection(
  "network_rail_username",
  "network_rail_password"
);

// Create the Topic.
$topic = new OpenRailData\NetworkRail\Services\Stomp\Topics\Rtppm\RtppmTopic();

// Add our event listener to the topic
$topic->addListener(new ExampleEventListener());

// Subscribe to the topic by adding the topic to the connection
$connection->addTopic($topic);

// Start listening for events, the rest is handled by our event listener :-)
$connection->listen();

And thats it!, _(*10)

More documentation and functionality to follow. Please also see the /examples dir for more examples., _(*11)