RuntimeMeter - Methode setResultFormat()
Mit dieser Methode ändern Sie die Attribute des Ausgabeformats der Methode getResult().
Name der Methode geändert: bis Version 1.0.4 hieß diese Methode setOutputFormat().
Neue Methode: diese Methode wurde mit Version 1.0.4 neu eingeführt.
Syntax
setResultFormat(int pAttribute, mixed pValue)
Rückgabewert
Diese Methode besitzt keinen Rückgabewert.
Parameter
int attribute - Eine Zahl, die angibt, welches Attribut des Ausgabeformats geändert werden soll. Für jedes mögliche Attribut existiert eine benannte Konstante, die verwendet werden sollte (siehe Tabelle).
mixed pValue - Der neue Wert, auf den das Attribut des Ausgabeformats gesetzt werden soll. Der Datentyp ist abhängig vom Attribut.
Attribute in Version 1.1
| Attribut | Beschreibung & mögliche Werte |
|---|---|
| FORMAT_DECIMAL_SEPARATOR | Das Dezimal-Trennzeichen. Vordefinierte Werte: siehe Attribut „FORMAT_THOUSANDS_SEPARATOR“ Standardwert: SEPARATOR_COMMA |
| FORMAT_DECIMALS | Die Anzahl der Nachkommastellen. Standardwert: 3 |
| FORMAT_SHOW_UNIT_SYMBOL | Ein Wahrheitswert, der festlegt, ob das Symbol für die verwendete Einheit mit ausgegeben wird. Standardwert: true |
| FORMAT_THOUSANDS_SEPARATOR | Das Tausender-Trennzeichen. Vordefinierte Werte: SEPARATOR_COMMA (Komma), SEPARATOR_DOT (punkt), SEPARATOR_SPACE (Leerzeichen), SEPARATOR_THINSPACE (schmales Leerzeichen), SEPARATOR_APOSTROPHE (Apostroph), SEPARATOR_NONE (kein Zeichen) Standardwert: SEPARATOR_SPACE |
| FORMAT_UNIT | Die Einheit, in der die Ausgabe erfolgen soll. Mögliche Werte: UNIT_SECONDS (Sekunden), UNIT_MILLISECONDS (Millisekunden), UNIT_MICROSECONDS Mikrosekunden Standardwert: UNIT_MILLISECONDS |
Attribute in Version 1.0
| Attribut | Beschreibung & mögliche Werte |
|---|---|
| decimal_separator | Das Dezimal-Trennzeichen. Vordefinierte Werte: siehe Attribut „thousands_separator“ Standardwert: comma |
| decimals | Die Anzahl der Nachkommastellen. Standardwert: 3 |
| show_unit_symbol | Ein Wahrheitswert, der festlegt, ob das Symbol für die verwendete Einheit mit ausgegeben wird. Standardwert: true |
| thousands_separator | Das Tausender-Trennzeichen. Vordefinierte Werte: comma (Komma), dot (punkt), space (Leerzeichen), thinspace (schmales Leerzeichen), apostrophe (Apostroph), none (kein Zeichen) Standardwert: space |
| unit | Die Einheit, in der die Ausgabe erfolgen soll. Mögliche Werte: seconds (Sekunden), milliseconds (Millisekunden), microseconds Mikrosekunden Standardwert: milliseconds |
Anwendungsbeispiel
$timer = new RuntimeMeter();
$timer->setOutputFormat(RuntimeMeter::unit, RuntimeMeter::seconds);
echo $timer->getResult();
Weitergehende Informationen
Als Dezimal-Trennzeichen wird im angelsächsischen Raum traditionell ein Punkt verwendet. Ansonsten ist wie im Deutschen ein Komma weltweit üblich.
Als Tausender-Trennzeichen soll weltweit ein Leerzeichen verwendet werden, um Verwechselungen mit dem Dezimal-Trennzeichen zu vermeiden. Damit die Zahl nicht zu sehr auseinander gerissen wirkt, empfiehlt sich das schmale Leerzeichen. Da dieses jedoch auf manchen älteren Browsern nicht korrekt dargestellt werden kann, verwendet diese Methode momentan noch das einfache Leerzeichen als Standard. Der Punkt, das Komma oder das Apostroph sind in den Handschriftsystemen verschiedener Länder üblich, sollten jedoch bei elektronischen Dokumenten möglichst nicht verwendet werden.