Dsao_Scrollset Klassenreferenz

Klasse repraesentiert eine Sammlung von Schriftrollen. Mehr ...

Aufstellung aller Elemente

Öffentliche Methoden
	__construct (array $scrolls=array())
	Initiailisiert Objekt.
	appendScroll (Dsao_Scroll $scroll)
	Haengt eine Schriftrolle an das Scrollset an.
	appendArray (array $scrolls)
	Haengt mehrere Schriftrollen an das Scrollset an.
	delete ($idUser=0)
	Loescht alle enthaltenen Schriftrollen.
	fetchScrolls (array $sqlWhere=array(), $loadContents=true, $reset=true)
	Laedt Schriftrollen anhand der uebergebenen WHERE-Kondition aus der DB.
	getScroll ($idScroll)
	Gibt die Schriftrolle mit der uebergebenen ID zurueck.
	getThreads ($toArrayDecoded=false)
	Gibt einen nach Threads geordneten Array aller Schriftrollen zurueck.
	isRead ()
	Gibt zurück, ob alle Schriftrollen gelesen sind.
	markRead ($idUser=0, $read=true)
	Markiert alle enthaltenen Schriftrollen als gelesen.
	refresh ($reset=true)
	Laedt Schriftrollen neu aus der Datenbank.
	toArrayDecoded ()
	Gibt Schriftrollen dekodiert als Array zurueck.
Öffentliche, statische Methoden
static	compareThreads ($thread1, $thread2)
	Vergleich von Threads.
Geschützte Attribute
	$_sqlSelect = null
	Zend_Db_Select, SQL-Select fuer das Laden der Schriftrollen.

---

Ausführliche Beschreibung

Klasse repraesentiert eine Sammlung von Schriftrollen.

Autor:

DSAo-Md

http://www.gnu.org/licenses/gpl-3.0.html GNU Public License

Version:

SVN: $Id: Scrollset.php 512 2009-06-19 08:11:48Z saviola777 $

Definiert in Zeile 9 der Datei Scrollset.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_Scrollset::__construct

(

array $

scrolls = array()

)

Initiailisiert Objekt.

Parameter:

$scrolls

array, Array von Objekten der Klasse Dsao_Scroll

Rückgabe:

void

Definiert in Zeile 22 der Datei Scrollset.php.

Benutzt appendArray().

  {
    // Uebergebene Daten anhaengen
    $this->appendArray($scrolls);
  }

---

Dokumentation der Elementfunktionen

Dsao_Scrollset::appendArray

(

array $

scrolls

)

Haengt mehrere Schriftrollen an das Scrollset an.

Parameter:

$scrolls

array, Array mit Objekten des Typs Dsao_Scroll

Rückgabe:

Dsao_Scrollset, Fliessendes Interface

Definiert in Zeile 51 der Datei Scrollset.php.

Benutzt appendScroll().

Wird benutzt von __construct().

  {
    foreach ($scrolls as $scroll)
    {
      $this->appendScroll($scroll);
    }

    return $this;
  }

Dsao_Scrollset::appendScroll

(

Dsao_Scroll $

scroll

)

Haengt eine Schriftrolle an das Scrollset an.

Parameter:

$scroll

Dsao_Scroll, Schriftrolle

Rückgabe:

Dsao_Scrollset, Fliessendes Interface

Definiert in Zeile 34 der Datei Scrollset.php.

Wird benutzt von appendArray().

  {
    // Falls eine ID vorhanden
    if ($scroll->id)
    {
      $this->offsetSet($scroll->id, $scroll);
    }

    return $this;
  }

static Dsao_Scrollset::compareThreads	(	$	thread1,
		$	thread2
	)			[static]

Vergleich von Threads.

Parameter:

	$thread1	mixed
	$thread2	mixed

Rückgabe:

Definiert in Zeile 68 der Datei Scrollset.php.

  {
    // array, Die letzten Schriftrollen der Threads
    $lastScroll1 = array_pop($thread1);
    $lastScroll2 = array_pop($thread2);

    // Erstellungszeit der letzten Schriftrollen vergleichen
    if ($lastScroll1['timestamp'] == $lastScroll2['timestamp'])
    {
      return 0;
    }

    return ($lastScroll1['timestamp'] > $lastScroll2['timestamp'] ? -1 : 1);
  }

Dsao_Scrollset::delete

(

$

idUser = 0

)

Loescht alle enthaltenen Schriftrollen.

Parameter:

$idUser

int

Rückgabe:

Dsao_Scrollset, Fliessendes Interface

Definiert in Zeile 89 der Datei Scrollset.php.

  {
    // Durchgehen und löschen
    foreach ($this->getIterator() as $scroll)
    {
      $scroll->delete($idUser);
    }

    return $this;
  }

Dsao_Scrollset::fetchScrolls	(	array $	sqlWhere = array(),
		$	loadContents = true,
		$	reset = true
	)

Laedt Schriftrollen anhand der uebergebenen WHERE-Kondition aus der DB.

Parameter:

	$sqlWhere	array, Array mit dem Format ('xyz = ?' => 5)
	$loadContents	bool, Ob auch Inhalte der SR geladen werden sollen
	$reset	bool, Ob vorhandene Scrolls geloescht werden sollen

Rückgabe:

Dsao_Scrollset, Fliessendes Interface

Definiert in Zeile 108 der Datei Scrollset.php.

Benutzt Dsao_Registry::get().

Wird benutzt von refresh().

  {
    // Falls Select-Statement noch nicht vorbereitet wurde
    if (null === $this->_sqlSelect)
    {
      $this->_sqlSelect = Dsao_Registry::get('db')->select()
        ->from('scroll_header');

      if ($loadContents)
      {
        $this->_sqlSelect->joinUsing('scroll_content', 'id', 'content');
      }
    }
    // WHERE-Klausel zuruecksetzen, falls neue uebergeben wurde
    else if (!empty($sqlWhere))
    {
      $this->_sqlSelect->reset('WHERE');
    }

    // WHERE-Klausel erzeugen
    foreach ($sqlWhere as $condition => $value)
    {
      // Falls kein assoziativer Array
      if (is_int($condition))
      {
        $this->_sqlSelect->where($value);
      }
      else
      {
        $this->_sqlSelect->where($condition, $value);
      }
    }

    // Ggf. bisherige Schriftrollen loeschen
    if ($reset)
    {
      // Daten zuruecksetzen
      $this->exchangeArray(array());
    }

    // Zeilen laden
    $scrolls = Dsao_Registry::get('db')->fetchAll($this->_sqlSelect);

    // Objekte mit Daten fuellen
    foreach ($scrolls as $scroll)
    {
      $this->offsetSet($scroll['id'], new Dsao_Scroll($scroll, false, true));
    }

    return $this;
  }

Dsao_Scrollset::getScroll

(

$

idScroll

)

Gibt die Schriftrolle mit der uebergebenen ID zurueck.

Parameter:

$idScroll

int, ID der Schriftrolle

Rückgabe:

Dsao_Scroll, Schriftrolle, ggf. leer

Definiert in Zeile 166 der Datei Scrollset.php.

  {
    // Falls Schriftrolle vorhanden
    if ($this->offsetExists($idScroll))
    {
      return $this->offsetGet($idScroll);
    }

    // Leere Schriftrolle zurueckgeben
    return new Dsao_Scroll(array('id' => $idScroll));
  }

Dsao_Scrollset::getThreads

(

$

toArrayDecoded = false

)

Gibt einen nach Threads geordneten Array aller Schriftrollen zurueck.

Parameter:

$toArrayDecoded

bool, Ob SR dekodiert und als Array zurueck gegeben werden sollen

Rückgabe:

array, Threads

Definiert in Zeile 185 der Datei Scrollset.php.

  {
    // array, Die enthaltenen Schriftrollen, nach Threads sortiert
    $threads = array();

    foreach ($this->getIterator() as $idScroll => $scroll)
    {
      // Falls dekodierte Arrays zurueck gegeben werden sollen
      if ($toArrayDecoded)
      {
        $scrollReturn = $scroll->toArrayDecoded();
      }
      else
      {
        $scrollReturn = $scroll;
      }

      // Falls die Thread-ID = 0 ist, ist dies die erste SR eines Threads
      if (0 == $scroll->idThread)
      {
        $threads[$scroll->id][0] = $scrollReturn;

        continue;
      }

      // Ansonsten ist dies keine Start-SR und es sollte eigentlich schon eine
      // Start-SR vorhanden sein, dies aber sicherheitshalber pruefen
      if (!isset($threads[$scroll->idThread]))
      {
        // Einfach das erste Feld leer lassen fuer die Start-SR
        $threads[$scroll->idThread][1] = $scrollReturn;
      }
      else
      {
        // Sonst einfach anhaengen
        $threads[$scroll->idThread][] = $scrollReturn;
      }
    }

    // Sortieren
    uasort($threads, 'Dsao_Scrollset::compareThreads');

    // Threads zurueckgeben
    return $threads;
  }

Dsao_Scrollset::isRead

(

)

Gibt zurück, ob alle Schriftrollen gelesen sind.

Rückgabe:

bool, ob alle Schriftrollen gelesen

Definiert in Zeile 236 der Datei Scrollset.php.

  {
    foreach ($this->getIterator() as $scroll)
    {
      // Falls Schriftrolle ungelesen
      if (!$scroll->isRead())
      {
        return false;
      }
    }

    return true;
  }

Dsao_Scrollset::markRead	(	$	idUser = 0,
		$	read = true
	)

Markiert alle enthaltenen Schriftrollen als gelesen.

Parameter:

	$idUser	int, Benutzer-ID
	$read	bool, Gelesen / Ungelesen

Rückgabe:

void

Definiert in Zeile 257 der Datei Scrollset.php.

  {
    foreach ($this->getIterator() as $scroll)
    {
      $scroll->markRead($idUser, $read);
    }
  }

Dsao_Scrollset::refresh

(

$

reset = true

)

Laedt Schriftrollen neu aus der Datenbank.

Parameter:

$reset

bool, Ob vorhandene Schriftrollen vorher geloescht werden sollen

Rückgabe:

Dsao_Scrollset Fliessendes Interface

Definiert in Zeile 272 der Datei Scrollset.php.

Benutzt fetchScrolls().

  {
    // Falls Schriftrollen vorher bereits ausgelesen wurden
    if (null != $this->_sqlSelect)
    {
      // Neu laden
      $this->fetchScrolls(array(), $reset);
    }

    return $this;
  }

Dsao_Scrollset::toArrayDecoded

(

)

Gibt Schriftrollen dekodiert als Array zurueck.

Rückgabe:

array, Schriftrollen

Definiert in Zeile 289 der Datei Scrollset.php.

  {
    $scrollsArray = array();

    foreach ($this as $scroll)
    {
      $scrollsArray[] = $scroll->toArrayDecoded();
    }

    return $scrollsArray;
  }

---

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

• /var/www/devel.dsao.eu/library/Dsao/Scrollset.php