risan/sl

HTTP client library for sl.se, Stockholm public transportation API.

Stockholm Pulic Transport

, _(*1)

PHP HTTP client library for communicating with sl.se—a Stockholm public transportation website., _(*2)

Table of Contents

• Dependencies
• Installation
• Basic Usage
• Search for Station
• Find Departures
  • Bus Departures
  • Train Departures
  • Metro Departures
  • Tram Departures
  • Light Rail Departures
  • Ship Departures

Dependencies

This package relies on the following libraries to work:, _(*3)

• Guzzle
• Illuminate Support

All above dependencies will be automatically downloaded if you are using Composer to install this package., _(*4)

Installation

To install this library using Composer, simply run the following command inside your project directory:, _(*5)

composer require risan/sl

Or you may also add risan\sl package into your composer.json file like so:, _(*6)

"require": {
  "risan/sl": "~1.1"
}

And don't forget to run the following composer command to install this library:, _(*7)

composer install

Basic Usage

Here is some basic example to use this library:, _(*8)

<?php
// Include autoloder file.
require 'vendor/autoload.php';

// Create a new instance Sl\Sl.
$sl = new Sl\Sl();

// Search for station.
// Will return Sl\Collections\StationColection.
$stations = $sl->searchStation('Central Station');

// Find for departures.
// Will return Sl\Collections\DepartureColection.
$departures = $sl->departuresFrom($stations->first());

Search for Station

To search for a station, you may use the searchStation() method:, _(*9)

$sl->searchStation(string $query);

For example, if you'd like to find all stations that match the central word, then your code will look like this:, _(*10)

$sl = new Sl\Sl();

$stations = $sl->searchStation('central');

print_r($stations->toArray());

The searchStation() method will automatically perform a HTTP request to sl.se to search for stations that match the given $query. This method will return an instance of Sl\Collections\StationCollection class, which contains a collection of Sl\Station instances., _(*11)

The StationCollection class itself is a subclass of Illuminate\Support\Collection, so you may leverage the powerful feature of Laravel's collection., _(*12)

Find Departures

You may also find departures from a specific station using departuresFrom() method:, _(*13)

$sl->departuresFrom(Sl\Station $station);

This method will perform a HTTP request to sl.se website in order to find a list of departures for a given $station. Note that this method requires an argument that must be instance of Sl\Station class., _(*14)

For example, if you need to find all departures from Slussen station, you can do the following:, _(*15)

$sl = new Sl\Sl();

$slussen = $sl->searchStation('slussen')->first();

$departures = $sl->departuresFrom($slussen);

print_r($departures->toArray());

The $departures will be an instance of Sl\Collections\DepartureCollection which hold a collection of Sl\Departure instances. The DepartureCollection is also a subclass of Illuminate\Support\Collection., _(*16)

Bus Departures

To filter only the bus departures, call busses method:, _(*17)

$sl->departuresFrom(Sl\Station $station)->busses();

Train Departures

To filter only the train (pendeltåg) departures, call trains() method:, _(*18)

$sl->departuresFrom(Sl\Station $station)->trains();

Metro Departures

To filter only the metro (tunnelbana) departures, call metros() method:, _(*19)

$sl->departuresFrom(Sl\Station $station)->metros();

Tram Departures

To filter only the tram (spårvagn) departures, call trams() method:, _(*20)

$sl->departuresFrom(Sl\Station $station)->metros();

Light Rail Departures

To filter only the light rail (lokalbana) departures, call lightRails() method:, _(*21)

$sl->departuresFrom(Sl\Station $station)->lightRails();

Ship Departures

To filter only the ship or boat departures, call ships() method:, _(*22)

$sl->departuresFrom(Sl\Station $station)->ships();