Page_Iterator Klassenreferenz

Klassendiagramm für Page_Iterator:

Zusammengehörigkeiten von Page_Iterator:

Öffentliche Methoden
	__construct ($site='', $db='')
	nextPage ()
	numRecords ()
	current ()
	next ()
	key ()
	valid ()
	rewind ()
	getDb ()
	setHaltId ($id)
	__toString ()
	count ()

Datenfelder
	$page

Ausführliche Beschreibung

Ein Page Iterator

Diese Klasse stellt für getPages, getChildren, ... einen Iterator zur Verfügung.

Autor

jan $Id$

Definiert in Zeile 21 der Datei Page_Iterator.php.

Beschreibung der Konstruktoren und Destruktoren

__construct()

__construct	(		$site = '',
			$db = ''
	)

Der Konstruktor

Parameter

$site	object Das Objekt der zugehoerigen Site.
$db	object Das Objekt der Datenbankabfrage. Falls $db nicht gesetzt wird, dann wird einen leerer Page_Iterator zurückgeliefert, d.h. nextPage ist gleich beim ersten Aufruf false.

Definiert in Zeile 37 der Datei Page_Iterator.php.

Dokumentation der Elementfunktionen

__toString()

__toString

(

)

wichtig für das error_log

Rückgabe

string

Definiert in Zeile 193 der Datei Page_Iterator.php.

count()

count

(

)

Definiert in Zeile 198 der Datei Page_Iterator.php.

Benutzt numRecords().

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

current()

current

(

)

Iterator: Aktuelles Element zurückgeben.

Rückgabe

Page

Definiert in Zeile 115 der Datei Page_Iterator.php.

Benutzt $page.

getDb()

getDb

(

)

Das Datenbankobjekt zurückgeben.

Rückgabe

Ego_Sql_Abstract das Db Objekt der Abfrage

Definiert in Zeile 173 der Datei Page_Iterator.php.

key()

key

(

)

Iterator: Aktuellen Schlüssel, hier Index der Ergbenisse, zurückgeben.

Rückgabe

integer

Definiert in Zeile 135 der Datei Page_Iterator.php.

next()

next

(

)

Iterator: Zum nächsten Element springen.

Rückgabe

boolean

Definiert in Zeile 125 der Datei Page_Iterator.php.

Benutzt nextPage().

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

nextPage()

nextPage

(

)

Liefert die nächste Seite zurück

Liefert die nächste Seite als Page Objekt zurück

$kinder = $page->getChildren();
while($kinder->nextPage())
{ // Die Kinder abarbeiten
  echo "ID: " . $kinder->page->Record["id"];
}

Rückgabe

Page|bool|null Die angefragte Page oder null

Definiert in Zeile 58 der Datei Page_Iterator.php.

Benutzt $page.

Wird benutzt von next() und rewind().

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

numRecords()

numRecords

(

)

Liefert die Anzahl der Ergebnisse zurück

Diese Funktion liefert die Anzahl der Ergebnisse einer SQL Abfrage durch Site::getPages() zurück. Rückgabe von 0 oder (void) bedeutet, dass keine Ergebnisse vorliegen.

$kinder = $page->getChildren();
if($kinder->numRecords())
{ // Es sind Kinder vorhanden
}

Rückgabe

int Anzahl der Ergebnisse

Definiert in Zeile 105 der Datei Page_Iterator.php.

Wird benutzt von count().

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

rewind()

rewind

(

)

Iterator: Zurücksetzen.

Definiert in Zeile 154 der Datei Page_Iterator.php.

Benutzt nextPage().

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

setHaltId()

setHaltId

(

$id

)

Page ID setzen, zu der vorgelaufen werden soll

Parameter

integer

$id

Rückgabe

void

Definiert in Zeile 184 der Datei Page_Iterator.php.

valid()

valid

(

)

Iterator: Ist in $page ein Ergebnis enthalten?

Definiert in Zeile 143 der Datei Page_Iterator.php.

Dokumentation der Felder

$page

$page

Page

Das Page Objekt

Definiert in Zeile 28 der Datei Page_Iterator.php.

Wird benutzt von current() und nextPage().

---

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

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