readme

README.md

@@ -4,17 +4,20 @@ For The DataTank (TDT) see next chapter. We created a module upon our own generi
 
 What this module can do:
  * It handles data from:
-    * NMBS
-    * NS
-    * De Lijn
-    * MIVB
-    * All kinds of GTFS
-    * ... more to come
+
+  - NMBS
+  - NS
+  - De Lijn
+  - MIVB
+  - All kinds of GTFS
+  - ... more to come
+
  * It creates a RESTful API for
-    * Liveboard: live departure and arrival times
-    * Connections: a route from A to B
-    * Vehicle: realtime information about a certain vehicle
-    * Stations: station information
+
+  - Liveboard: live departure and arrival times
+  - Connections: a route from A to B
+  - Vehicle: realtime information about a certain vehicle
+  - Stations: station information
 
 # The DataTank
 

modules/DL/methods.php

@@ -8,8 +8,7 @@
 
 class DL{
      public static $methods = array (
-	  "Stations",
-	  "Liveboard"
+
 	  );
 }
 ?>

modules/MIVB/methods.php

@@ -7,14 +7,13 @@
  */
 class MIVB{
      public static $methods = array (
-	  "Stations",
-	  "Liveboard"
 	  );
+
 }
 
 
 //alias
-class STIB{
+class STIB extends MIVB{
 
 }
 

modules/NMBS/Liveboard.class.php

@@ -1,29 +1,25 @@
 <?php
-/* Copyright (C) 2011 by iRail vzw/asbl
+/**
+ * Copyright (C) 2011 by iRail vzw/asbl
  *
- * Author: Jan Vansteenlandt <jan aŧ iRail.be>
- * Author: Pieter Colpaert <pieter aŧ iRail.be>
- * License: AGPLv3
+ * @author Jan Vansteenlandt <jan aŧ iRail.be>
+ * @author Pieter Colpaert <pieter aŧ iRail.be>
+ * @license AGPLv3
  *
- * This file is currently being used for testpurposes. It returns some testdata we use for our analysis tool. (stats.php)
  */
+include_once("modules/NMBS/Stations.class.php");
+include_once("modules/iRailTools.class.php");
 
-include_once("modules/AMethod.php");
-include_once("modules/iRail/Stations.class.php");
-include_once("modules/iRail/iRailTools.class.php");
-
-class Liveboard extends AMethod{
+class Liveboard extends AResource{
 
      private $lang;
      private $system;
      private $time;
      private $direction;
      private $date;
-     private $station;
-
+     private $station;     
 
      public function __construct(){
-	  parent::__construct("Liveboard");
 	  $this->time = date("H:i");	  
 	  $this->direction = "departures";
      }
@@ -77,11 +73,12 @@ public function call(){
 	  }
 
 	  $request = TDT::HttpRequest($url);
-	  //var_dump($request);
-      error_log('The Data: ' . $request->data);
+          if(isset($request->error)){
+              throw new HttpOutTDTException($url);
+          }
+
 	  $object = simplexml_load_string($request->data);
 
-
 	  return $object;
 
 
@@ -101,7 +98,6 @@ public function call(){
      }
 
 /**
- * Small algorithm I wrote:
  * It will remove the duplicates from an array the php way. Since a PHP array will need to recopy everything to be reindexed, I figured this would go faster if we did the deleting when copying.
  */
      private static function removeDuplicates($nodes){
@@ -131,5 +127,4 @@ public static function getDoc(){
      }
 }
 
-
 ?>

modules/NMBS/Stations.class.php

@@ -1,59 +1,52 @@
 <?php
-/* Copyright (C) 2011 by iRail vzw/asbl
- *
- * Author: Pieter Colpaert <pieter aŧ iRail.be>
- * License: AGPLv3
+/**
+ * @copyright (C) 2011 by iRail vzw/asbl
+ * @author  Pieter Colpaert <pieter aŧ iRail.be>
+ * @license  AGPLv3
  *
  * Lists all stations for a certain system
  */
 
-include_once("modules/AMethod.php");
-
-class Stations extends AMethod{
-
-     private $lang,$system = "NMBS";
-
-     public function __construct(){
-	  parent::__construct("Stations");
-     }
-
-     public static function getParameters(){
-	  return array("lang" => "Language for the stations",
-		       "system" => "The name of the public transport company: for instance De Lijn, or NMBS"
-	       );
-     }
-
-     public static function getRequiredParameters(){
-	  return array();
-     }
-
-     public function setParameter($key,$val){
-	  if($key == "lang"){
-	       $this->lang = $val;
-	  }
-
-	  if($key == "system"){
-	       if(in_array($val,iRailTools::ALLOWED_SYSTEMS)){
-		    $this->system = $val;
-	       }
-	  }
-     }
-
-     public function call(){
-	  $o = new StdClass();
-
-	  $o->stations[] 
-	  return $o;
-     }
-
-     public static function getAllowedPrintMethods(){
-	  return array("xml","json","php", "jsonp","html");
-     }
-
-
-     public static function getDoc(){
-	  return "Stations will return a list of all known stops of a system";
-     }
+class Stations extends AResource{
+
+    private $lang = "EN";
+
+    /**
+     * If language has not been given, just return the english ones
+     */
+    public static function getParameters(){
+	return array("lang" => "Language for the stations");
+    }
+
+    /**
+     * No required parameters for the stations resource
+     */
+    public static function getRequiredParameters(){
+	return array();
+    }
+
+    public function setParameter($key,$val){
+	if($key == "lang"){
+	    $this->lang = $val;
+	}
+    }
+
+    /**
+     * This function should get all stations from the NMBS/SNCB and return them.
+     * Can't we get all information from DBPedia?
+     * Does Open Street Map has a SPARQL end-point?
+     */
+    public function call(){
+        return new StdClass();
+    }
+
+    public static function getAllowedPrintMethods(){
+	return array("xml","json","php", "jsonp","html", "kml");
+    }
+
+    public static function getDoc(){
+	return "Stations will return a list of all known stops of a system";
+    }
 }
 
 ?>

modules/NMBS/tools.php

@@ -1,8 +1,10 @@
 <?php
-  /** Copyright (C) 2011 by iRail vzw/asbl
+  /** 
+   *
    * This is a class with static tools for you to use on the NMBS scraper. It contains stuff that is needed by all other classes
    *
-   * @package data/NMBS
+   * @copyright (C) 2011 by iRail vzw/asbl
+   * @package modules/NMBS
    */
 
 class tools{
@@ -61,6 +63,6 @@ public static function addQuarter($time){
 	  }
 	  return $hours. ":" . $minutes;	  
      } 
-  }
+}
 
 ?>

modules/NS/methods.php

@@ -7,8 +7,6 @@
  */
 class NS{
      public static $methods = array (
-	  "Stations",
-	  "Liveboard"
 	  );
 }