FlatBox - Dokumentation

6. Funktionsreferenz

6.1 Ständig benötigte Funktionen (Core)

int Errorcode / string Errordescription get_error_description ( int Errorcode [, bool Return ] )

Diese Funktion liefert die Beschreibungen für einen Errorcode. Die Ausgabe der Funktion wird über die drei Konstanten PRINT_NOTICES, PRINT_WARNINGS und PRINT_FAILES gesteuert. Die Rückgabe der Funktion kann über den zweiten optionalen Parameter Return Description gesteuert werden. Standardmäßig liefert die Funktion den übergebenen Errorcode wieder zurück, wird dieser zweite Parameter jedoch auf true gesetzt, so wird anstatt des Errorcodes die Error-Description zurück geliefert.

float Microtime get_microtime ( void )

Diese Funktion liefert einen Timestamp zurück, der die aktuelle Zeit in Sekunden im UNIX Format angibt und noch 4 Nachkommastellen enthält, welche die Microsekunden angeben. Was in PHP5 durch ein einfaches microtime(true); erledigt werden könnte, kann in PHP4 nur mit einem Workaround erzielt werden.
Ein von dieser Funktion erzeugter Timestamp könnte z.B. so aussehen: 1121036766.6324

string Timestamp get_time_s ( void )

Wie auch get_microtime(), so erzeugt auch diese Funktion einen Timestamp, der Microsekunden mit angibt und somit deutlich genauer als ein normaler UNIX Timestamp ist.
Im Gegensatz zu get_microtime() liefert get_time_s() den Timestamp aber nicht als Float-Zahl, sondern als eine Aneinanderreihung der einzelnen Werte in der Reihenfolge Jahr, Monat, Tag, Stunde, Minute, Sekunde, Millisekunden.
Ein von dieser Funktion erzeugter Timestamp könnte z.B. so aussehen: 20050710170606.632489 - der Vorteil gegenüber get_microtime() ist, dass der Timestamp einerseits noch ein bisschen genauer ist und andererseits man die einzelnen Daten einfach per substr() lesen kann.

string / array Stripped-Data strip ( string / array Data )

Der Funktion strip() kann entweder ein einfacher String oder ein Array übergeben werden. strip() prüft, ob magic_quotes_gpc aktiviert ist und entfernt - wenn dem so ist - die Backslashes in Data. Ist Data ein Array, so wird dieses rekursiv durchgegangen. Als Rückgabe erhält man das von Backslashes gesäuberte Array bzw. den String.

bool Success flat_open_lock ( string Filename, int Lockmode )

Es wird versucht die Datei Filename zu öffnen und mit Lockmode zu sperren, im Erfolgsfall wird true zurück gegeben, ansonsten false.
Als Lockmode müssen die gleichen Zahlen verwendet werden, wie sie auch die PHP Funktion flock() erwartet, es können deshalb die Konstanten LOCK_SH und LOCK_EX verwendet werden. Der Lock-Prozess wird im Kapitel File-Locking beschrieben.