Dsao_Model_Game_Desk Klassenreferenz

Modell-Klasse des Spieltisches. Mehr ...

Klassendiagramm für Dsao_Model_Game_Desk:

Aufstellung aller Elemente

Öffentliche Methoden
	deleteEmptyRows ()
	Löschen leerer Tabellenzeilen.
	deleteText ($idUser, $idText)
	Löscht Text mit uebergebener ID.
	editText (Dsao_User $user, $idText, $content= '')
	Bearbeitung eines Textes.
	fetchGroupTexts ($idGroup, $since, $deleted=false)
	Lädt Texte einer bestimmten Gruppe.
	findTexts (array $ids)
	Laedt Texte anhand der IDs aus der Datenbank.
	hasChangePermission ($idUser, $idText)
	Prüft Berechtigung des Benutzers.
	insertText ($idGroup, $author, $content)
	Einfügen eines neuen Texts.
Geschützte Methoden
	_init ()
	Setzt Standardtabelle.

---

Ausführliche Beschreibung

Modell-Klasse des Spieltisches.

Autor:

DSAo-Md

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

Version:

SVN: $Id: Desk.php 506 2009-05-08 15:32:05Z saviola777 $

Definiert in Zeile 9 der Datei Desk.php.

---

Dokumentation der Elementfunktionen

Dsao_Model_Game_Desk::_init

(

)

[protected]

Setzt Standardtabelle.

Rückgabe:

void

Erneute Implementation von Dsao_Model_Abstract.

Definiert in Zeile 16 der Datei Desk.php.

Benutzt Dsao_Model_Abstract::_setDefaultTable().

  {
    // Standardtabelle
    $this->_setDefaultTable('game_text');
  }

Dsao_Model_Game_Desk::deleteEmptyRows

(

)

Löschen leerer Tabellenzeilen.

Loescht alle leeren (heisst inhaltslosen) Zeilen, die ein bestimmtes Alter haben, mit einer konfigurierbaren Wahrscheinlichkeit bei jedem Aufruf der Seite.

Rückgabe:

bool

Definiert in Zeile 31 der Datei Desk.php.

Benutzt Dsao_Model_Abstract::_getTable() und Dsao_Registry::get().

  {
    // int, Konfigurationsvariable, die angibt, ab welchem Alter leere Zeilen
    // gelöscht werden sollen
    $since = time()-Dsao_Registry::get('config')
            ->modules->game->desk->deleteEmpty->since;

    // WHERE-Klausel
    $sqlWhere = array
      (
        'content IS NULL',
        Dsao_Registry::get('db')
          ->quoteInto('timeLastEdited <= FROM_UNIXTIME(?)', $since),
      );

    // Loeschen
    $this->_getTable()->delete($sqlWhere);

    return true;
  }

Dsao_Model_Game_Desk::deleteText	(	$	idUser,
		$	idText
	)

Löscht Text mit uebergebener ID.

Löscht den Text mit der übergebenen ID, sofern der Benutzer mit übergebener ID dazu berechtigt ist.

Parameter:

	$idUser	int, Benutzer-ID
	$idText	int, Text-ID

Rückgabe:

bool, ob Löschen erfolgreich war

Definiert in Zeile 62 der Datei Desk.php.

Benutzt hasChangePermission().

Wird benutzt von editText().

  {
    // Falls Löschen erlaubt
    if ($row = $this->hasChangePermission($idUser, $idText))
    {
      $row->delete();

      return true;
    }

    return false;
  }

Dsao_Model_Game_Desk::editText	(	Dsao_User $	user,
		$	idText,
		$	content = ''
	)

Bearbeitung eines Textes.

Bearbeitet den Text mit übergebener ID und setzt einen neuen Inhalt.

Parameter:

	$user	Dsao_User, Benutzer
	$idText	int, Text-ID
	$content	string, Inhalt

Rückgabe:

bool, ob Bearbeitung erfolgreich war

Definiert in Zeile 85 der Datei Desk.php.

Benutzt deleteText() und hasChangePermission().

  {
    // Falls Bearbeitung erlaubt
    if ($row = $this->hasChangePermission($user->id, $idText))
    {
      // Falls kein Inhalt uebergeben wurde, Text loeschen
      if ('' === $content)
      {
        return $this->deleteText($user->id, $idText);
      }

      // Inhalt setzen und speichern
      $row->content = $content;
      $row->save($user);

      return true;
    }

    return false;
  }

Dsao_Model_Game_Desk::fetchGroupTexts	(	$	idGroup,
		$	since,
		$	deleted = false
	)

Lädt Texte einer bestimmten Gruppe.

Laedt die seit $since in die Datenbank eingetragenen Texte der Gruppe mit der ID $idGroup

Parameter:

	$idGroup	int, ID der Gruppe
	$since	int, ab welchem Zeitpunkt die Texte geladen werden sollen
	$deleted	bool, ob auch gelöschte Einträge ausgelesen werden sollen

Rückgabe:

Dsao_Table_GameTexts_Rowset, geladene Texte

Definiert in Zeile 117 der Datei Desk.php.

Benutzt Dsao_Model_Abstract::_getTable().

  {
    // Query erstellen
    $sqlSelect = $this->_getTable()->select()
      ->order('id DESC')
      ->where('idGroup = ?', $idGroup)
      ->where('timeCreated > FROM_UNIXTIME(?) OR timeLastEdited > FROM_UNIXTIME(?)', $since);

    // Falls gelöschte nicht ausgelesen werden sollen
    if (!$deleted)
    {
      $sqlSelect->where('content IS NOT NULL');
    }

    // Texte laden
    $rowsetTexts = $this->_getTable()->fetchAll($sqlSelect);

    return $rowsetTexts;
  }

Dsao_Model_Game_Desk::findTexts

(

array $

ids

)

Laedt Texte anhand der IDs aus der Datenbank.

Parameter:

$ids

array, IDs der Texte

Rückgabe:

Dsao_Table_GameTexts_Rowset, gefundene Zeilen

Definiert in Zeile 143 der Datei Desk.php.

Benutzt Dsao_Model_Abstract::_getTable().

  {
    return $this->_getTable()->find($ids);
  }

Dsao_Model_Game_Desk::hasChangePermission	(	$	idUser,
		$	idText
	)

Prüft Berechtigung des Benutzers.

Prueft, ob Benutzer das Recht hat, den Abenteuertext mit der uebergebenen ID zu bearbeiten / loeschen.

Parameter:

	$idUser	int, Benutzer-ID
	$idText	int, Text-ID

Rückgabe:

bool|row, Tabellenzeile des Texts oder false

Noch zu erledigen:

Prüfen, ob Benutzer Autor ist oder zum Staff gehört etc.

Definiert in Zeile 158 der Datei Desk.php.

Benutzt Dsao_Model_Abstract::_getTable().

Wird benutzt von deleteText() und editText().

  {
    // Falls ID nicht uebergeben oder nicht numerisch, abbrechen
    if (!$idText || !is_numeric($idText))
    {
      return false;
    }

    // Zunaechst nur pruefen, ob Text ueberhaupt existiert
    if ($row = $this->_getTable()->select()->where('id = ?', $idText)
      ->fetchRow())
    {
      return $row;
    }

    return false;
  }

Dsao_Model_Game_Desk::insertText	(	$	idGroup,
		$	author,
		$	content
	)

Einfügen eines neuen Texts.

Fügt einen neuen Datensatz in die Tabelle 'game_texts' ein.

Parameter:

	$idGroup	int, Gruppen-ID
	$author	string, Autor
	$content	string, Inhalt

Rückgabe:

bool|int, ID des neuen Datensatzes oder false bei Fehlern

Definiert in Zeile 189 der Datei Desk.php.

Benutzt Dsao_Model_Abstract::_getTable().

  {
    // Falls kein Autor oder Inhalt angegeben wurde
    if (!$author || !$content)
    {
      return false;
    }

    // Neuer Datenbankeintrag
    $dataNewText = array
      (
        'idGroup'=> $idGroup,
        'author'  => $author,
        'content' => $content,
      );

    // Neue Zeile einfuegen
    return $this->_getTable()->insert($dataNewText);
  }

---

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

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