edofre/laravel-ns-api

Laravel wrapper for the NS API

V1.0.0 2017-02-04 15:13 UTC

This package is not auto-updated.

Last update: 2024-10-27 01:40:56 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License composer.lock

Installation

The preferred way to install this extension is through composer.

To install, either run

$ php composer.phar require edofre/laravel-ns-api

or add

"edofre/laravel-ns-api": "v1.0.0"

to the require section of your composer.json file.

Configuration

Publish assets and configuration files

php artisan vendor:publish --tag=config

In the above configuration file you will need to enter your NS API username and password

Example

Get all the stations

$api = new NsApi();
$stations = $api->getStations();

Get all the departing trains from a station

$api = new NsApi();
$station = new Station('UT', '','','','','','','','','');
$departing_trains = $api->getDepartures($station);

Get all the disturbances from a station

$api = new NsApi();
$station = new Station('ut', '', '', '', '', '', '', '', '', '');
// We want the actual disturbances and not the unplanned disturbances
$disturbances = $api->getDisturbances($station, true , false);

Get the prices for a route

$api = new NsApi();
$from_station = new Station('ZL', '', '', '', '', '', '', '', '', '');
$via_station = new Station('DH', '', '', '', '', '', '', '', '', '');
$to_station = new Station('HT', '', '', '', '', '', '', '', '', '');
$prices = $api->getPrices($from_station, $to_station, $via_station);