Class ForumWatchesHandler

Description

Located in /web/mod/mod.forum.watches.php (line 30)


	
			
Method Summary
boolean CheckWatches (string $TargetType, integer $TargetID, string $Action, array $AdditionalData)
boolean DeleteWatchesOnID (string $WatchType, integer $OnID)
boolean DeleteWatchesOnThreads (array $ThreadIDs)
boolean IsWatching (string $Type, integer $ID)
Methods
CheckWatches (line 44)

CheckWatches() veranlasst das Senden von Benachrichtigungen, dass sich etwas geändet hat.

  • return: true, wenn die Benachrichtigung erfolgreich war, false, wenn keine Watches vorhanden sind oder ein Fehler aufgetreten ist
boolean CheckWatches (string $TargetType, integer $TargetID, string $Action, array $AdditionalData)
  • string $TargetType: Der Typ des veränderten Objekts (thread, forum)
  • integer $TargetID: Die ID des Ziels
  • string $Action: Die ausgeführte Aktion (add, delete, move, delall ...)
  • array $AdditionalData: Zusätzliche Daten, die schon voher bekannt sind, um unnötige Datenbankabfragen zu vermeiden
DeleteWatchesOnID (line 187)

DeleteWatchesOnID() löscht alle Foren- oder Thread-Watches die zu einem bestimmten

Objekt gehören mittels der ID des Objekts

  • return: true, falls der Vorgang geklappt hat, sonst false
boolean DeleteWatchesOnID (string $WatchType, integer $OnID)
  • string $WatchType: Der Typ der Watches (thread oder forum)
  • integer $OnID: Die ID des Ziels des Watches
DeleteWatchesOnThreads (line 201)

DeleteWatchesOnThreads() löscht alle Thread-Watches, deren Watch-Ziel im

eindimensionalen Array $ThreadIDs enthalten ist Objekt gehören mittels der ID des Objekts

  • return: true, falls der Vorgang geklappt hat, sonst false
boolean DeleteWatchesOnThreads (array $ThreadIDs)
  • array $ThreadIDs: Ein eindimensionales Array, das die IDs der Threads enthält
IsWatching (line 213)

IsWatching() teilt mit, ob man ein bestimmtes Element im Forum beobachtet

  • return: true, falls der Vorgang geklappt hat, sonst false
boolean IsWatching (string $Type, integer $ID)
  • string $Type: Typ des zu prüfenden Elements (forum oder thread)
  • integer $ID: Die ID der Elements

Documentation generated on Mon, 22 Oct 2007 17:17:24 +0200 by phpDocumentor 1.3.1