Dsao_Model_Scroll_Scroll Klassenreferenz

Modell des Schriftrollen-Controllers. Mehr ...

Klassendiagramm für Dsao_Model_Scroll_Scroll:

Aufstellung aller Elemente

Öffentliche Methoden
	insertScroll (Dsao_Scroll $scroll)
	Einfügen einer neuen Schriftrolle.
Geschützte Methoden
	_checkScrollData (Dsao_Scroll $scroll)
	Prueft uebergebene Daten und gibt ein Array der Ergebnisse zurueck.
	_sendScrollNotificationMail (Dsao_User $user, Dsao_Scroll $scroll)
	Schickt einem Benutzer eine Benachrichtigung ueber eine erhaltene Schriftrolle.

---

Ausführliche Beschreibung

Modell des Schriftrollen-Controllers.

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_Model_Scroll_Scroll::_checkScrollData

(

Dsao_Scroll $

scroll

)

[protected]

Prueft uebergebene Daten und gibt ein Array der Ergebnisse zurueck.

Parameter:

$scroll

Dsao_Scroll, Schriftrolle

Rückgabe:

array, Ergebnisse der Pruefung

Definiert in Zeile 17 der Datei Scroll.php.

Benutzt Dsao_Model_Abstract::_getObject(), Dsao_Model_Abstract::_getTable(), Dsao_Registry::get(), Dsao_Scroll::getOtherUser(), Dsao_Model_Scroll_Abstract::isParticipated() und Dsao_DataHandler_Abstract::setValid().

Wird benutzt von insertScroll().

  {
    $filter = $this->_getObject('Dsao_Filter_Texts');

    // Ob Fehler aufgetreten sind
    $flagError = false;

    // Betreff
    $scroll->subject = $filter->filterInput($scroll->subject, 50);

    // Falls kein Betreff uebergeben
    if (!$scroll->subject)
    {
      $scroll->subject = false;

      $flagError = true;
    }

    // Inhalt
    $scroll->content = $filter->filterInput
      ($scroll->content,
        Dsao_Registry::get('config')->modules->scroll->contentLength, false);

    // Falls Inhalt zu gross oder zu klein
    if (!$scroll->content)
    {
      $scroll->content = false;

      $flagError = true;
    }


    // Thread
    $idUser = Dsao_Registry::get('user')->getId();
    $username = Dsao_Registry::get('user')->username;

    // Falls Thread-ID ungleich 0 uebergeben wurde
    if ($scroll->idThread)
    {
      // Falls Zeile des Threads nicht gefunden wurde oder Benutzer nicht an
      // Thread beteiligt, abbrechen
      if ( !( $scrollThread = $this->isParticipated($idUser, $scroll->idThread)) )
      {
        $scroll->idThread = false;

        return $scroll;
      }

      // ID und Namen des Autors setzen
      $scroll->idAuthor   = $idUser;
      $scroll->nameAuthor = $username;

      // ID und Namen des Empfaengers
      $scroll->idRecipient = $scrollThread->getOtherUser($idUser)->getId();
      $scroll->nameRecipient = $scrollThread->getOtherUser($idUser)->username;

      $scroll->idThread = $scrollThread->id;

      // Falls kein Betreff uebergeben wurde, den des Thread setzen
      if (!$scroll->subject)
      {
        $scroll->subject = $scrollThread->subject;
      }

      // SR als fuer Einfuegen in Datenbank vorbereitet markieren
      $scroll->setValid();

      // Falls Thread von einem der Benutzer geloescht wurde, dies rueckgaengig
      // machen
      if ($scrollThread->deleted != 0)
      {
        $scrollThread->delete(0, false);
      }

      return $scroll;
    }

    // Empfaenger

    // Falls Name zu lang
    if (strlen($scroll->nameRecipient) > 20)
    {
      $scroll->idRecipient = false;

      $flagError = true;
    }

    // Pruefen, ob Empfaenger in der Datenbank vorhanden ist
    $rowRecipient = $this->_getTable('user_data')->select()
      ->where('username = ?', $scroll->nameRecipient)->fetchRow();

    // Falls Benutzer nicht vorhanden oder der Benutzer sich selbst eine SR
    // schicken will
    if ( !$rowRecipient || $rowRecipient->id == $idUser)
    {
      $scroll->idRecipient = false;

      $flagError = true;
    }
    else
    {
      // ID und Name des Empfaengers
      $scroll->idRecipient = $rowRecipient->id;
      $scroll->nameRecipient = $rowRecipient->username;

      // ID und Name des Autors
      $scroll->idAuthor   = $idUser;
      $scroll->nameAuthor = $username;
    }

    // Falls keine Fehler aufgetreten sind, Schriftrolle als geprueft markieren
    if (!$flagError)
    {
      $scroll->setValid();
    }

    return $scroll;
  }

Dsao_Model_Scroll_Scroll::_sendScrollNotificationMail	(	Dsao_User $	user,
		Dsao_Scroll $	scroll
	)			[protected]

Schickt einem Benutzer eine Benachrichtigung ueber eine erhaltene Schriftrolle.

Parameter:

	$user	Dsao_User, Benutzer
	$scroll	Dsao_Scroll, Schriftrolle

Rückgabe:

void

Definiert in Zeile 144 der Datei Scroll.php.

Benutzt Dsao_View_Smarty::sprintf().

Wird benutzt von insertScroll().

  {
    // int, ID des Threads
    $idThread = ($scroll->idThread == 0 ? $scroll->id : $scroll->idThread);

    // Inhalt der Benachrichtigungsmail
    $content = Dsao_View_Smarty::sprintf('scroll_scroll_send_mail_content',
      array
      (
        'nameAuthor'=> $scroll->nameAuthor,
        'subject'   => $scroll->subject
      ));

    // string, Betreff der Benachrichtigungsmail
    $subject = Dsao_View_Smarty::sprintf('scroll_scroll_send_mail_subject',
      array('nameAuthor'  => $scroll->nameAuthor));

    // Mail erstellen und verschicken
    $mail = new Dsao_Mail($user, $subject, $content);
    $mail->send();
  }

Dsao_Model_Scroll_Scroll::insertScroll

(

Dsao_Scroll $

scroll

)

Einfügen einer neuen Schriftrolle.

Fuegt eine Schriftrolle in die DB ein. Achtung: Keine Integritaetspruefung und Filterung!

Parameter:

$scroll

Dsao_Scroll, Schriftrolle

Rückgabe:

Dsao_Scroll, die einzufuegende Schriftrolle

Definiert in Zeile 175 der Datei Scroll.php.

Benutzt _checkScrollData(), _sendScrollNotificationMail(), Dsao_Scroll::insert() und Dsao_DataHandler_Abstract::isValid().

  {
    $this->_checkScrollData($scroll);

    // Falls keine Fehler aufgetreten sind, Schriftrolle einfuegen
    if ($scroll->isValid())
    {
      $scroll->insert()->setReadOnly();

      // Ggf. Empfaenger eine Mailbenachrichtigung schicken
      $recipient = new Dsao_User(array('id' => $scroll->idRecipient));
      $recipient->refresh();

      if ($recipient->scrollMailNotification)
      {
        $this->_sendScrollNotificationMail($recipient, $scroll);
      }
    }

    return $scroll;
  }

---

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

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