Dsao_Scroll Klassenreferenz

Repraesentiert eine Schriftrolle. Mehr ...

Klassendiagramm für Dsao_Scroll:

Aufstellung aller Elemente

Öffentliche Methoden
	delete ($idUser=0, $delete=true)
	Schriftrollen als geloescht markieren und ggf.
	getOtherUser ($idUser)
	Rueckgabe von ID, Namen des anderen beteiligten Benutzers.
	insert ()
	Fügt Daten des Objekts in Datenbank ein.
	isAuthor ($idUser)
	Prüft, ob der Benutzer mit übergebener ID Autor der SR ist.
	isDeleted ($idUser=null)
	Gibt zurück, ob die Schriftrollen von einem der Benutzer gelöscht wurde.
	isParticipated ($idUser)
	Prüft, ob der übergebene Benutzer an Schriftrolle beteiligt ist.
	isRead ()
	Rueckgabe, ob SR vom Empfaenger als gelesen markiert wurde.
	isRecipient ($idUser)
	Prüft, ob der Benutzer mit übergebener ID Empfänger der SR ist.
	markRead ($idUser=0, $read=true)
	Schriftrolle als vom Empfaenger gelesen / ungelesen markieren.
	refresh ($content=true)
	SR aktualisieren / Daten laden.
	toArrayDecoded ()
	Gibt Daten dekodiert als Array zurueck.
Geschützte Methoden
	_checkValidity ()
	Prüft Gültigkeit, indemie Identifizierer kontrolliert werden.
	_delete ()
	Loescht Schriftrolle aus der Datenbank.
Geschützte Attribute
	$_identifiers = array('id')
	Array mit Eigenschaften, die eine klare Identifizierung eines Datenbanksatzes zulassen.
	$_propertiesProtected = array('id')
	array, Geschützte Eigenschaften, können nicht über setData() gesetzt werden
	$_table = 'scroll_header'
	string, zunächst Name und später Objekt der (Haupt-)-Tabelle

---

Ausführliche Beschreibung

Repraesentiert eine Schriftrolle.

Autor:

DSAo-Md

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

Version:

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

Definiert in Zeile 9 der Datei Scroll.php.

---

Dokumentation der Elementfunktionen

Dsao_Scroll::_checkValidity

(

)

[protected]

Prüft Gültigkeit, indemie Identifizierer kontrolliert werden.

Rückgabe:

bool, Gültigkeit

Erneute Implementation von Dsao_Db_Table_DataHandler_Abstract.

Definiert in Zeile 17 der Datei Scroll.php.

  {
    return true;
  }

Dsao_Scroll::_delete

(

)

[protected]

Loescht Schriftrolle aus der Datenbank.

Rückgabe:

bool

Definiert in Zeile 27 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get() und Dsao_Db_Table_DataHandler_Abstract::getTable().

Wird benutzt von delete().

  {
    // Header-Zeile loeschen (Inhalt wird autmatisch geloescht)
    $this->getTable()->delete
      (array('id = '. (int) $this->__get('id')));
  }

Dsao_Scroll::delete	(	$	idUser = 0,
		$	delete = true
	)

Schriftrollen als geloescht markieren und ggf.

loeschen.

Markiert die Schriftrolle als vom Benutzer mit der ID $idUser geloescht, und loescht sie ggf. komplett.

Parameter:

	$idUser	int, Benutzer-ID
	$delete	bool, Ob geloescht oder loeschen rueckgaengig gemacht werden soll

Rückgabe:

Dsao_Scroll, fliessendes Interface

Definiert in Zeile 45 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get(), Dsao_DataHandler_Abstract::__set(), _delete(), Dsao_Db_Table_DataHandler_Abstract::delete() und Dsao_Db_Table_DataHandler_Abstract::getTable().

  {
    parent::delete();

    // Falls loeschen rueckgaengig gemacht werden soll
    if (!$delete)
    {
      $this->__set('deleted', 0);

      // Zeile aktualisieren
      $this->getTable()->update
        (array('deleted' => 0), 'id = '.(int) $this->__get('id'));

      return $this;
    }

    // Falls keine Benutzer-ID uebergeben wurde, direkt loeschen
    if (0 === $idUser && $delete)
    {
      $this->_delete();

      return $this;
    }

    // int, Zahl, die das Feld 'deleted' haben muss, wenn der andere Benutzer
    // die SR geloescht hat
    $intOther = 0;

    // int, Zahl, die das Feld 'deleted' haben muss, wenn der angemeldete
    // Benutzer die SR geloescht hat
    $intSelf = 0;


    // Falls Benutzer Autor
    if ($this->__get('idAuthor') == $idUser)
    {
      $intSelf = 1;
    }
    // Falls Benutzer Empfaenger
    else if ($this->__get('idRecipient') == $idUser)
    {
      $intSelf = 2;
    }
    // Benutzer hat nichts mit der SR am Hut, also abbrechen
    else
    {
      return $this;
    }

    // Zahl des anderen Benutzers in Abhängigkeit bestimmen
    $intOther = ($intSelf == 1 ? 2 : 1);

    // Falls anderer Spieler Nachricht bereits geloescht hat
    if ($intOther == $this->__get('deleted'))
    {
      $this->_delete();
    }
    else
    {
      $this->__set('deleted', $intSelf);

      // Zeile aktualisieren
      Dsao_Registry::getTable('scroll_header')->update
        (array('deleted' => $intSelf), 'id = '.(int) $this->__get('id'));
    }

    return $this;
  }

Dsao_Scroll::getOtherUser

(

$

idUser

)

Rueckgabe von ID, Namen des anderen beteiligten Benutzers.

Parameter:

$idUser

int, Benutzer-ID

Rückgabe:

Dsao_User, anderer Benutzer

Definiert in Zeile 120 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get() und isParticipated().

Wird benutzt von Dsao_Model_Scroll_Scroll::_checkScrollData().

  {
    $idUser = (int) $idUser;

    // Anderer Benutzer
    $userOther = new Dsao_User();

    // Falls übergebener Benutzer an Schriftrolle beteiligt
    if ($this->isParticipated($idUser))
    {
      // Falls Benutzer Autor
      if ($this->__get('idAuthor') == $idUser)
      {
        $idUserOther    = $this->__get('idRecipient');
        $usernameOther  = $this->__get('nameRecipient');
      }
      else
      {
        $idUserOther    = $this->__get('idAuthor');
        $usernameOther  = $this->__get('nameAuthor');
      }

      $userOther->setId($idUserOther);
      $userOther->username = $usernameOther;
      $userOther->setValid(true);
    }

    return $userOther;
  }

Dsao_Scroll::insert

(

)

Fügt Daten des Objekts in Datenbank ein.

Rückgabe:

Dsao_Db_Table_DataHandler_Abstract, fließendes Interface

Erneute Implementation von Dsao_Db_Table_DataHandler_Abstract.

Definiert in Zeile 150 der Datei Scroll.php.

Benutzt Dsao_Db_Table_DataHandler_Abstract::getTable(), Dsao_DataHandler_Abstract::setFromArray() und Dsao_Db_Table_DataHandler_Abstract::setSynchronous().

Wird benutzt von Dsao_Model_Scroll_Scroll::insertScroll().

  {
      // Tabellenzeilen erstellen
      $rowHeader = $this->getTable()
        ->createRow($this->_data);
      $rowContent = $this->getTable('scroll_content')
        ->createRow($this->_data);

      // Transaktion starten
      $this->getTable()->getAdapter()->beginTransaction();

      // Header einfuegen und ID der Inhaltstabelle zuweisen
      $rowContent->id = $rowHeader->save();

      // Inhalt einfuegen
      $rowContent->save();

      // Transaktion beenden
      $this->getTable()->getAdapter()->commit();

      // Daten neu setzen
      return $this->setFromArray($rowHeader->toArray() + $rowContent->toArray())
        ->setSynchronous();
  }

Dsao_Scroll::isAuthor

(

$

idUser

)

Prüft, ob der Benutzer mit übergebener ID Autor der SR ist.

Parameter:

$idUser

Benutzer-ID, descParam

Rückgabe:

bool, ob Benutzer Autor ist

Definiert in Zeile 181 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get().

Wird benutzt von isDeleted().

  {
    return ($idUser == $this->__get('idAuthor'));
  }

Dsao_Scroll::isDeleted

(

$

idUser = null

)

Gibt zurück, ob die Schriftrollen von einem der Benutzer gelöscht wurde.

Parameter:

$idUser

int, Benutzer-ID

Rückgabe:

bool|null, ob Schriftrolle gelöscht wurde

Definiert in Zeile 192 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get(), Dsao_DataHandler_Abstract::__isset(), isAuthor() und isParticipated().

  {
    // Falls Eigenschaft nicht gesetzt, null zurück geben
    if (!$this->__isset('deleted'))
    {
      return null;
    }

    // Falls keine ID übergeben wurde, nur schauen, ob Schriftrollen von einem
    // der Beteiligten gelöscht wurde
    if (null === $idUser)
    {
      return ($this->__get('deleted') > 0);
    }

    // Falls Benutzer nicht an Schriftrolle beteiligt
    if (!$this->isParticipated($idUser))
    {
      return false;
    }

    return ($this->isAuthor($idUser) ?
      // Falls der Autor die Schriftrolle gelöscht hat
      ($this->__get('deleted') == 1) :
      // Falls der Empfänger die Schriftrolle gelöscht hat
      ($this->__get('deleted') == 2));
  }

Dsao_Scroll::isParticipated

(

$

idUser

)

Prüft, ob der übergebene Benutzer an Schriftrolle beteiligt ist.

Parameter:

$idUser

int, Benutzer-ID

Rückgabe:

bool, ob Benutzer beteiligt ist

Definiert in Zeile 226 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get().

Wird benutzt von getOtherUser() und isDeleted().

  {
    $idUser = (int) $idUser;

    return ($this->__get('idAuthor') == $idUser
      || $this->__get('idRecipient') == $idUser);
  }

Dsao_Scroll::isRead

(

)

Rueckgabe, ob SR vom Empfaenger als gelesen markiert wurde.

Rückgabe:

bool

Definiert in Zeile 239 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get() und Dsao_DataHandler_Abstract::__isset().

  {
    return ($this->__isset('read') ? (bool) $this->__get('read') : false);
  }

Dsao_Scroll::isRecipient

(

$

idUser

)

Prüft, ob der Benutzer mit übergebener ID Empfänger der SR ist.

Parameter:

$idUser

Benutzer-ID, descParam

Rückgabe:

bool, ob Benutzer Empfänger ist

Definiert in Zeile 250 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get().

  {
    return ($idUser == $this->__get('idRecipient'));
  }

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

Schriftrolle als vom Empfaenger gelesen / ungelesen markieren.

Parameter:

	$idUser	int
	$read	bool, Ob die SR als gelesen oder ungelesen markiert werden soll

Rückgabe:

Dsao_Scroll Fliessendes Interface

Definiert in Zeile 262 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get(), Dsao_DataHandler_Abstract::__set(), Dsao_Db_Table_DataHandler_Abstract::getTable(), Dsao_DataHandler_Abstract::isReadOnly(), Dsao_Db_Table_DataHandler_Abstract::isSynchronous() und Dsao_DataHandler_Abstract::isValid().

  {
    // Schreibschutz, Gültigkeit und Synchronität prüfen / sicherstellen
    $this->isReadOnly(true);
    $this->isValid(true);
    $this->isSynchronous(true);

    // Erst nach boolean und dann nach int umwandeln, um sicher zu stellen,
    // dass nur 0 oder 1 als Wert heraus kommt
    $read = (int) (bool) $read;

    // Falls Wert sich geaendert hat und der Benutzer daran beteiligt ist
    if (($read != $this->__get('read'))
        && (!$idUser || $idUser == $this->__get('idRecipient')))
    {
      $sqlWhere = 'id = '. (int) $this->__get('id');

      $this->getTable()->update(array('read' => $read), $sqlWhere);

      $this->__set('read', $read);
    }

    return $this;
  }

Dsao_Scroll::refresh

(

$

content = true

)

SR aktualisieren / Daten laden.

Parameter:

$content

bool, Ob auch der Inhalt geladen werden soll

Rückgabe:

Dsao_Scroll Fliessendes Interface

Definiert in Zeile 293 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get(), Dsao_Db_Table_DataHandler_Abstract::_parseResult(), Dsao_Db_Table_DataHandler_Abstract::getTable(), Dsao_Db_Table_DataHandler_Abstract::refresh() und Dsao_DataHandler_Abstract::setValid().

  {
    parent::refresh();

    $userData = null;

    // Falls Inhalt geladen werden soll
    if ($content)
    {
      // Tabellenzeilen laden
      $select = $this->getTable()->getAdapter()->select()
        ->from('scroll_header')
        ->joinUsing('scroll_content', 'id')
        ->where('`user_data`.id = ?', $this->__get('id'));

      $data = $this->getTable()->getAdapter()->fetchAll($select);

      $this->_parseResult(array_pop($data));
    }
    else
    {
      // Tabellenzeilen laden
      $row = $this->getTable()->select()
        ->where('id = ?', $this->__get('id'))->fetchRow();

      $this->_parseResult($row, false);

      $this->setValid();
    }

    return $this;
  }

Dsao_Scroll::toArrayDecoded

(

)

Gibt Daten dekodiert als Array zurueck.

Rückgabe:

array

Definiert in Zeile 331 der Datei Scroll.php.

Benutzt Dsao_DataHandler_Abstract::__get() und Dsao_DataHandler_Abstract::__isset().

  {
    // Daten kopieren
    $data = $this->_data;

    // Falls Inhalt vorhanden
    if ($this->__isset('content'))
    {
      $filter = new Dsao_Filter_Texts();

      // Inhalt dekodieren
      $data['content'] = $filter->filter($this->__get('content'));
    }

    // Falls Zeit vorhanden
    if ($this->__isset('date'))
    {
      $date = new Dsao_Time($this->__get('date'));

      // Timestamp
      $data['timestamp'] = strtotime($data['date'], 0);

      // Zeit formatieren
      $data['date'] = $date->format();
    }

    return $data;
  }

---

Dokumentation der Datenelemente

Dsao_Scroll::$_identifiers = array('id') [protected]

Array mit Eigenschaften, die eine klare Identifizierung eines Datenbanksatzes zulassen.

Der Primary-Key muss hier nicht festgehalten werden, nur weitere Unique-Spalten oder Kombinationen. Über Unterarrays können Spaltenkombinationen festgehalten werden.

Erneute Implementation von Dsao_Db_Table_DataHandler_Abstract.

Definiert in Zeile 11 der Datei Scroll.php.

---

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

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