kumi/oebb
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Fred 2014-01-21 18:48:16 +01:00
parent 7aa902d986
commit e94803327f
1 changed files with 22 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -12,6 +12,7 @@ Allgemeines
**Was muss ich beachten?**
* Der Code bzw. die API ist nicht von einem Profi, sondern von einem Lehrling im ersten Lehrjahr programmiert worden. Deswegen bitte ich um ausschließlich konstruktive Kritik.
* Zu jeder Funktion gibt es auch ein Beispiel. Siehe PDF.
@ -23,23 +24,29 @@ Allgemeines
Wenn Sie etwas für einen Lehrling in ersten Lehrjahr spenden möchten, dann können Sie das über diese Links tun. :)
[Flattr](https://flattr.com/profile/internetztube)[PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TKFLMZMXM3Z64)
[Flattr](https://flattr.com/profile/internetztube) [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TKFLMZMXM3Z64)
Station validieren - validate()
-----------
**Wissenwertes**
1. Es ist zu beachten, dass bei einem Aufruf mehrere Stationen zurückkommen können.
2. Für den weiteren Vorgang wird ausschließlich der name („value“) benötigt.
**Parameter**
| Name | Typ | Beschreibung | Zwingend benötigt |
| ---- | ------ | ---------------- | ----------------: |
| name | string | Name der Station | Ja |
**Rückgabewerte**
| Name | Typ | Beschreibung | Wird benötigt |
@ -51,12 +58,16 @@ Station validieren - validate()
Verbindung suchen - get()
-----------
**Wissenwertes**
1. Die Stations-Namen können leicht abgeändert eigegeben werden. Aus „St. Pölten“ wird „St.Pölten Hbf“
2. Wenn die Parameter „date“, „time“ nicht verwendet oder mit NULL angegeben werden, wird automatisch das aktuelle Datum bzw. Zeit verwendet.
3. Die „id“ ist für die Verwendung der Funktionen „getDetails“ und in Folge „getCoords“ essenziell.
4. Wenn Sie drei Verbindungen in der Vergangenheit (relativ zur ersten Verbindung) möchten, dann verwenden Sie „earlier“ als Anfangszeit und fügen Sie zu „amount“ drei dazu.
Wenn Sie drei Verbindungen weiter in der Zukunft möchten, dann lassen die Anfangszeit gleich und erhöhen Sie einfach „amount“ um 3.
**Parameter**
| Name | Typ | Beschreibung | Zwingend benötigt |
@ -91,12 +102,16 @@ Verbindung suchen - get()
Details einer Verbindung - getDetails
-----------
**Wissenwertes**
1. Von der Funktion „getDetails“ bekommen Sie die essenziellen Infos einer spezifischen Verbindung.
2. Für den Aufruf benötigen Sie lediglich die „id“ der Verbindung. Diese „id“ bekommen Sie von der Funktion „get“ zurück.
3. Funktioniert nur bei einer erfolgreich ausgeführten Suche (get).
**Parameter**
| Name | Typ | Beschreibung | Zwingend benötigt |
@ -104,6 +119,7 @@ Details einer Verbindung - getDetails
| id | int | Index der spezifischen Verbindung. Siehe get | Ja |
**Rückgabewerte**
| Array | Name | Typ | Beschreibung | Wird benötigt |
@ -130,6 +146,8 @@ Details einer Verbindung - getDetails
Koordinaten einer ganzen Verbindung - getCoords()
-----------
**Wissenwertes**
1. Es muss erfolgreich die Funktion „ getDetails“ aufgerufen werden.
@ -137,11 +155,13 @@ Koordinaten einer ganzen Verbindung - getCoords()
3. Jede Verbindung ist in einem Array zurück.
**Parameter**
Sie müssen nur die Funktion „getDetails“ mit der jeweiligen Verwundung aufrufen, dann bekommen Sie die Koordinaten dieser Verbindung.
**Rückgabewerte**
| Name | Typ | Beschreibung | Wird benötigt |
@ -159,6 +179,7 @@ Sie müssen nur die Funktion „getDetails“ mit der jeweiligen Verwundung aufr
**Erstellt von Fred.**
[internetz2tb@gmail.com](mailto:internetz2tb@gmail.com)
[http://twitter.com/InternetzTube](mailto:http://twitter.com/InternetzTube)