Update README.md

This commit is contained in:
Fred 2014-01-21 18:48:16 +01:00
parent 7aa902d986
commit e94803327f

View file

@ -12,6 +12,7 @@ Allgemeines
**Was muss ich beachten?** **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. * 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. * 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. :) 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() Station validieren - validate()
----------- -----------
**Wissenwertes** **Wissenwertes**
1. Es ist zu beachten, dass bei einem Aufruf mehrere Stationen zurückkommen können. 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. 2. Für den weiteren Vorgang wird ausschließlich der name („value“) benötigt.
**Parameter** **Parameter**
| Name | Typ | Beschreibung | Zwingend benötigt | | Name | Typ | Beschreibung | Zwingend benötigt |
| ---- | ------ | ---------------- | ----------------: | | ---- | ------ | ---------------- | ----------------: |
| name | string | Name der Station | Ja | | name | string | Name der Station | Ja |
**Rückgabewerte** **Rückgabewerte**
| Name | Typ | Beschreibung | Wird benötigt | | Name | Typ | Beschreibung | Wird benötigt |
@ -51,12 +58,16 @@ Station validieren - validate()
Verbindung suchen - get() Verbindung suchen - get()
----------- -----------
**Wissenwertes** **Wissenwertes**
1. Die Stations-Namen können leicht abgeändert eigegeben werden. Aus „St. Pölten“ wird „St.Pölten Hbf“ 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. 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. 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. 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** **Parameter**
| Name | Typ | Beschreibung | Zwingend benötigt | | Name | Typ | Beschreibung | Zwingend benötigt |
@ -91,12 +102,16 @@ Verbindung suchen - get()
Details einer Verbindung - getDetails Details einer Verbindung - getDetails
----------- -----------
**Wissenwertes** **Wissenwertes**
1. Von der Funktion „getDetails“ bekommen Sie die essenziellen Infos einer spezifischen Verbindung. 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. 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). 3. Funktioniert nur bei einer erfolgreich ausgeführten Suche (get).
**Parameter** **Parameter**
| Name | Typ | Beschreibung | Zwingend benötigt | | Name | Typ | Beschreibung | Zwingend benötigt |
@ -104,6 +119,7 @@ Details einer Verbindung - getDetails
| id | int | Index der spezifischen Verbindung. Siehe get | Ja | | id | int | Index der spezifischen Verbindung. Siehe get | Ja |
**Rückgabewerte** **Rückgabewerte**
| Array | Name | Typ | Beschreibung | Wird benötigt | | Array | Name | Typ | Beschreibung | Wird benötigt |
@ -130,6 +146,8 @@ Details einer Verbindung - getDetails
Koordinaten einer ganzen Verbindung - getCoords() Koordinaten einer ganzen Verbindung - getCoords()
----------- -----------
**Wissenwertes** **Wissenwertes**
1. Es muss erfolgreich die Funktion „ getDetails“ aufgerufen werden. 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. 3. Jede Verbindung ist in einem Array zurück.
**Parameter** **Parameter**
Sie müssen nur die Funktion „getDetails“ mit der jeweiligen Verwundung aufrufen, dann bekommen Sie die Koordinaten dieser Verbindung. Sie müssen nur die Funktion „getDetails“ mit der jeweiligen Verwundung aufrufen, dann bekommen Sie die Koordinaten dieser Verbindung.
**Rückgabewerte** **Rückgabewerte**
| Name | Typ | Beschreibung | Wird benötigt | | 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.** **Erstellt von Fred.**
[internetz2tb@gmail.com](mailto:internetz2tb@gmail.com) [internetz2tb@gmail.com](mailto:internetz2tb@gmail.com)
[http://twitter.com/InternetzTube](mailto:http://twitter.com/InternetzTube) [http://twitter.com/InternetzTube](mailto:http://twitter.com/InternetzTube)