Also die Fehler in der Doku habe sogar ich gefunden
Wobei wir wieder beim Thema wären. Ich würde gerne eine DB anlegen und mir ist nicht klar, welche Parameter erwartet werden.
PHP:
sites_database_add($session_id, $client_id, $params);
Description:
Adds a new database.
Input Variables:
$session_id, $client_id, $params
Parameters (in $params):
server_id (klar)
type (klar) //Welche Optionen gibt es hier?
database_name (klar)
database_user_id (int(11)) //muss man da erst einen db-user anlegen?
database_ro_user_id (int(11)) //ka was das ist
database_password (klar)
database_charset (varchar(64)) // Darf man hier DB-DEFAULT angeben?
remote_access (klar)
remote_ips (klar)
backup_interval (varchar(255)) //Angabe in Minuten? Was ist bei 0?
backup_copies (int(11)) //Anzahl der Kopien, bis diese überschrieben werden?
active (klar)
Output:
Returns the ID of the newly added database.
Die Doku ist schon fortschrittlicher als viele anderen, die ich je gelesen habe. Aber dennoch ist da soooo viel Platz für Verbesserungen.
Als Beispiel wird in dem example.sites_database_add nur 11 von 12 Parametern angegeben. Eines der wichtigsten fehlt. Und zwar das Passwort. Das wirft gleich mehrere Fragen auf.
1. Muss man nicht alle Parameter angeben? Wenn man nicht alle angeben muss, welche dürfen fehlen? Was ist der Default für die fehlenden Paramter?
2. Wie muss das Passwort übergeben werden? Soll es ein einfaches MD5 sein oder soll ich dafür crypt verwenden oder oder oder.
Durch google und einlesen ist mir klar, wie das Passwort übergeben werden muss.
Aber
a.) für ein Beispiel ist das echt schlecht, wenn etwas fehlt
b.) für eine Doku fehlen so viele wichtige Informationen.
Ein weiterer Punkt ist z.B. die Eingabe. Muss ich vor dem Absenden die Eingabe auf Gültigkeit prüfen, wenn ja, wie genau muss das gemacht werden.
z.B. bei Passwörtern. Was ist mit unerlaubten Zeichen? Zu kurz, zu lange? Überhaupt angegeben? Ich arbeite häufig mit API´s, daher weiß ich, wie eine gute Doku aussieht und was eine sch*** Doku ist. Die Doku von ISPConfig ist gut in der Mitte. Würde mich aber sehr freuen, wenn da noch was passiert.
