Ego_Progress Klassenreferenz

Öffentliche Methoden
	__construct ($name, $reset=true, $create=true)
	hasFinished ()
	hasEnded ()
	getValue ()
	getValueByKey ($key)
	setLimit ($limit)
	setMessage ($message='')
	setData ($data=array())
	setContinue ($data)
	clearContinue ()
	getContinue ($clear=true)
	increase ($message='', $data=array(), $amount=1)
	start ($message='', $data=array())
	end ($message='', $data=array())
	error ($message='', $data=array())
	clear ()
	exists ()
	stillExists ()

Ausführliche Beschreibung

Die Ego_Progress Klasse ermöglicht es Aufgaben im Hintergrund auszuführen und den Status jederzeit abzufragen.

Autor

dg

Definiert in Zeile 7 der Datei Ego_Progress.php.

Beschreibung der Konstruktoren und Destruktoren

__construct()

__construct	(		$name,
			$reset = true,
			$create = true
	)

Konstruktor

Parameter

string	$name	Eindeutige Bezeichnung des Fortschritts
boolean	$reset	Fortschritt zurücksetzen
boolean	$create	Fortschritt anlegen, wenn er nicht existiert

Definiert in Zeile 36 der Datei Ego_Progress.php.

Benutzt clear(), Ego_System\file_exists(), Ego_System\file_get_contents() und Ego_System\mkdir().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Elementfunktionen

clear()

clear

(

)

Logdatei löschen

Rückgabe

void

Definiert in Zeile 275 der Datei Ego_Progress.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

clearContinue()

clearContinue

(

)

Gemerkten Fortschritt löschen

Rückgabe

void

Definiert in Zeile 178 der Datei Ego_Progress.php.

Wird benutzt von getContinue().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

end()

end	(		$message = '',
			$data = array()
	)

Ende des Fortschritts festlegen

Parameter

string	$message
array	$data

Rückgabe

void

Definiert in Zeile 246 der Datei Ego_Progress.php.

Wird benutzt von error().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

error()

error	(		$message = '',
			$data = array()
	)

Fortschritt mit einem Fehler beenden

Parameter

string	$message
array	$data

Rückgabe

void

Definiert in Zeile 265 der Datei Ego_Progress.php.

Benutzt end().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

exists()

exists

(

)

Prüfen, ob der Fortschritt bereits existiert

Rückgabe

boolean

Definiert in Zeile 284 der Datei Ego_Progress.php.

getContinue()

getContinue

(

$clear = true

)

Abgebrochenen Fortschritt ermitteln

Parameter

boolean

$clear

Rückgabe

array

Definiert in Zeile 191 der Datei Ego_Progress.php.

Benutzt clearContinue().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

getValue()

getValue

(

)

Daten des Fortschritts ermitteln

Rückgabe

array

Definiert in Zeile 102 der Datei Ego_Progress.php.

getValueByKey()

getValueByKey

(

$key

)

Einen bestimmten Wert des Fortschritts ermitteln

Parameter

string

$key

Rückgabe

mixed

Definiert in Zeile 112 der Datei Ego_Progress.php.

hasEnded()

hasEnded

(

)

Prüfen, ob der Fortschritt beendet wurde (nicht zwingend auch abgeschlossen)

Rückgabe

boolean

Definiert in Zeile 92 der Datei Ego_Progress.php.

hasFinished()

hasFinished

(

)

Prüfen, ob der Fortschritt abgeschlossen ist

Rückgabe

boolean

Definiert in Zeile 83 der Datei Ego_Progress.php.

increase()

increase	(		$message = '',
			$data = array(),
			$amount = 1
	)

Fortschritt erhöhen

Parameter

string	$message
array	$data
integer	$amount

Rückgabe

void

Definiert in Zeile 210 der Datei Ego_Progress.php.

setContinue()

setContinue

(

$data

)

Der Fortschritt wird abgebrochen um später fortgesetzt werden zu können

Parameter

array

$data

Rückgabe

void

Definiert in Zeile 167 der Datei Ego_Progress.php.

setData()

setData

(

$data = array()

)

Die letzten Informationen setzen

Parameter

array

$data

Rückgabe

void

Definiert in Zeile 156 der Datei Ego_Progress.php.

setLimit()

setLimit

(

$limit

)

Das Ende des Fortschritts festlegen

Parameter

integer

$limit

Rückgabe

void

Definiert in Zeile 134 der Datei Ego_Progress.php.

setMessage()

setMessage

(

$message = ''

)

Die letzte Nachricht setzen

Parameter

string

$message

Rückgabe

void

Definiert in Zeile 145 der Datei Ego_Progress.php.

start()

start	(		$message = '',
			$data = array()
	)

Start des Fortschritts festlegen

Parameter

string	$message
array	$data

Rückgabe

void

Definiert in Zeile 228 der Datei Ego_Progress.php.

stillExists()

stillExists

(

)

Prüfen, ob der Fortschritt noch existiert (falls er zwischenzeitlich abgebrochen wurde)

Rückgabe

boolean

Definiert in Zeile 293 der Datei Ego_Progress.php.

Benutzt Ego_System\file_exists().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /media/ssd/workspace/egocms/develop/lib/base/Ego_Progress.php