Differences

This shows you the differences between two versions of the page.

--- en:create:functions:urnstatus [14.12.2014 12:47] – created alexander.ritter
+++ en:create:functions:urnstatus [14.12.2014 13:04] – [Example] alexander.ritter
@@ Line 1: / Line 1: @@
 ====== urnStatus() ======
-''array **urnStatus**(string //UrnenKennung//)''
+''array **urnStatus**(string //urnIDs//)''
-Die Funktion ''urnStatus()'' liefert Informationen zum aktuellen Füllstand der angegeben Urne.
+The function ''urnStatus()'' returns information concerning the status of the specified urns.
-  * //UrnenKennung//\\ Die Kennung der Urne, deren Status abgefragt werden soll.
+  * //urnIDs//\\ The urn IDs whose status are to be retrieved.
-===== Rückgabewert =====
+===== Return Value =====
-Im Fehlerfall, z.B. wenn es keine Urne mit der angegebenen Kennung gibt, gibt die Funktion ''false'' zurück. Ansonten wird ein Array mit den folgenden Schlüsseln zurückgegeben:
+When an error occurs, for example, if there is no urn with the ID specified, the function returns ''false''. Otherwise, an array is returned with the following keys:
-^Index^Bedeutung^
+^Index^Meaning^
-|elements|Anzahl der Zettel (Elemente) in der Urne|
+|elements|Number of ballots (elements) in the urn|
-|drawn|Anzahl der bisher insgesamt entnommenen und abgelegten Zettel|
+|drawn|Number of overall ballots already drawn and stored|
-|round|Angabe, zum wievielten Mal die Urne gerade geleert wird (beginnt mit 1), entsprechend dem Rückgabewert von ''urnDraw()''|
+|round|Number of time the urn has been emptied (begins with 1), corresponding to the return value of ''urnDraw()''|
-|done|Anzahl der Zettel, die __in der aktuellen Runde__ bereits gezogen wurden. Wenn alle Zettel aus der Urne gezogen wurden, beginnt die nächste Runde und die Anzahl der gezogenen Zettel wird auf 0 zurückgesetzt.|
+|done|Numer of ballots already drawn __in the current round__. If all ballots have been drawn from the urn, the next round commences and the number of ballots drawn is reset to 0|
-|togo|Anzahl der Zettel, die __in der aktuellen Runde__ noch zur Ziehung bereit stehen. Wenn diese Zahl den Wert 0 erreicht, beginnt eine neue Runde und der Wert wird auf die Anzahl der Zettel zurückgesetzt|
+|togo|Number of ballots __in the current round__ that can still be drawn. If this number reaches 0, a new round begins and the value is reset to the number of ballots|
-===== Beispiel =====
+===== Example =====
 <code php>
-$info = urnStatus('urne1');
+$info = urnStatus('urn1');
-html('<p>Noch '.$info['togo'].' von '.$info['elements'].' Gewinncodes verfügbar.</p>');
+html('<p>Still '.$info['togo'].' out of '.$info['elements'].' prize codes available.</p>');
 </code>