Plugin-Events

Details

Entwickler unter Euch wissen, dass es in Joomla verschiedene Plugin-Typen gibt, wie zum Beispiel Content-Plugins, User-Plugins oder System-Plugins.

Für diese Typen könnt ihr natürlich auch JoomGallery-bezogene Plugins schreiben, die zum Beispiel das Interface verwenden, wie es beim Content-Plugin 'JoomPlu' der Fall ist.

Die JoomGallery greift zusätzlich noch auf einen weiteren Plugin-Typ zu, der sich 'joomgallery' nennt.

Falls Ihr also ein Plugin entwickeln wollt, das die JoomGallery beeinflussen kann, würde das 'install'-Element der entsprechenden XML-Installationsdatei folgendermaßen aussehen:

<install version="3.0" type="plugin" group="joomgallery" method="upgrade" />

Für den allgemeinen Aufbau eines Plugins seht Ihr Euch am besten mal eines der Beispiel-Plugins an, die mit Joomla! mitgeliefert werden.

 

Liste mit allen derzeit in die JoomGallery eingebauten Plugin-Events:

Inhalts-Verwaltung

Anzeige (Rohdaten)

Anzeige (HTML-Ausgabe)

Nachrichten, Downloads und Sonstiges

 

 

onContentAfterDelete

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Element (Bild, Kategorie, Kommentar, Konfiguration) in der Datenbank gelöscht wurde.

 

Event:

onContentAfterDelete($context,$row)

 

Parameter Typisierung Inhalt
$context String

com_joomgallery.type

Wobei type je nach Element folgende Werte annimmt:

  • image (Element-Typ: Bild)
  • category (Element-Typ: Kategorie)
$row JTable Objekt-Abbild des gelöschten Eintrags der Datenbanktabelle.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomBeforeSave

 

Beschreibung:

Dieses Event wird ausgelöst, bevor ein Element (Bild, Kategorie, Kommentar, Konfiguration) im Speicherprozess an die JTable-Class gebunden wird.

 

Event:

onJoomBeforeSave($context,$row,$isNew,$data)

 

Parameter Typisierung Inhalt
$context String

com_joomgallery.type

Wobei type je nach Element folgende Werte annimmt:

  • image (Element-Typ: Bild)
  • category (Element-Typ: Kategorie)
$row JTable Objekt-Abbild des bereits vorhandenen, unveränderten Eintrags der Datenbanktabelle.
$isNew Boolean True, wenn ein neues Element erzeugt wird. False, wenn ein vorhandenes Element bearbeitet wird.
$data Array Liste aller POST-Variablen, welche die Formulardaten enthält.
Rückgabewert Typisierung Inhalt
Boolean Der Rückgabewert beeinflusst den Speichervorgang.
TRUE: Speichervorgang wird fortgesetzt.
FALSE: Speichervorgang wird abgebrochen.

onContentBeforeSave

 

Beschreibung:

Dieses Event wird ausgelöst, bevor ein Element (Bild, Kategorie, Kommentar, Konfiguration) in die Datenbank gespeichert wird.

 

Event:

onContentBeforeSave($context,&$row,$isNew,$data)

 

Parameter Typisierung Inhalt
$context String

com_joomgallery.type

Wobei type je nach Element folgende Werte annimmt:

  • image (Element-Typ: Bild)
  • category (Element-Typ: Kategorie)
$row JTable Objekt-Abbild des geänderten Eintrags der Datenbanktabelle. Das Objekt wird per Referenz übergeben und kann somit verändert werden.
$isNew Boolean True, wenn ein neues Element erzeugt wird. False, wenn ein vorhandenes Element bearbeitet wird.
$data Array Liste aller POST-Variablen, welche die Formulardaten enthält.
Rückgabewert Typisierung Inhalt
Boolean Der Rückgabewert beeinflusst den Speichervorgang.
TRUE: Speichervorgang wird fortgesetzt.
FALSE: Speichervorgang wird abgebrochen.

 

onContentAfterSave

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Element (Bild, Kategorie, Kommentar, Konfiguration) in der Datenbank gespeichert wurde.

 

Event:

onContentAfterSave($context,&$row,$isNew)

 

Parameter Typisierung Inhalt
$context String

com_joomgallery.type

Wobei type je nach Element folgende Werte annimmt:

  • image (Element-Typ: Bild)
  • category (Element-Typ: Kategorie)
$row JTable Objekt-Abbild des gespeicherten Eintrags der Datenbanktabelle. Das Objekt wird per Referenz übergeben und kann somit verändert werden, was jedoch keine Auswirkungen hat, da die Verarbeitung bereits abgeschlossen ist.
$isNew Boolean True, wenn ein neues Element erzeugt wird. False, wenn ein vorhandenes Element bearbeitet wird.
Rückgabewert Typisierung Inhalt
Void -

 

onContentChangeState

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem sich der Status eines Elements (Bild, Kommentar) geändert hat (z.B. von Veröffentlicht auf Versteckt).

 

Event:

onContentChangeState($context,$pks,$value)

 

Parameter Typisierung Inhalt
$context String

com_joomgallery.type

Wobei type je nach Element folgende Werte annimmt:

  • image (Element-Typ: Bild)
$pks Array Eine Liste von Primärschlüssel-IDs der Elemente, die ihren Status geändert haben.
$value Integer Ein Wert, welcher den neuen, geänderten Status des Bildes repräsentiert: 
0: umpublished
1: published
2: archived (not available)
3: not approved
4: approved
5: not featured
6: featured
Rückgabewert Typisierung Inhalt
Void -

 

onCategoryChangeState

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem sich der Status einer Kategorie geändert hat (z.B. von Veröffentlicht auf Versteckt).

 

Event:

onCategoryChangeState($context,$pks,$value)

 

Parameter Typisierung Inhalt
$context String

com_joomgallery.category
$pks Array Eine Liste von Primärschlüssel-IDs der Kategorien, die ihren Status geändert haben.
$value Integer Ein Wert, welcher den neuen, geänderten Status des Bildes repräsentiert: 
0: umpublished
1: published
2: archived (not available)
3: not approved
4: approved
5: not featured
6: featured
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterRecreate

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Bild neu generiert wurde.

 

Event:

onJoomAfterRecreate($files,$orig_exists,$autorot)

 

Parameter Typisierung Inhalt
$files Array Liste mit Dateipfaden der drei Bildtypen (Original, Detail, Thumbnail) 
array('original','detail','thumbnail')
$orig_exists Boolean TRUE, wenn Original-Bild vorhanden ist. Sonst FALSE.
$auto_rotation Array Liste mit Booleans der drei Bildtypen (Original, Detail, Thumbnail), je nachdem ob für den Bildtyp eine automatische Rotation gemäss EXIF-Ausrichtung durchgeführt wurde. 
array('original','detail','thumbnail')
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterRotate

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Bild rotiert wurde.

 

Event:

onJoomAfterRotate($files,$angle,$imgtypes)

 

Parameter Typisierung Inhalt
$files Array Liste mit Dateipfaden der drei Bildtypen (Original, Detail, Thumbnail) 
array('original','detail','thumbnail')
$angle Integer Rotationswinkel des Bildes in Grad (Gegenuhrzeigersinn)
$imgtypes Integer Wert der angiebt, welche Bildtypen gedreht werden sollen. 1: Thumbnail und Detail, 2: Original
Rückgabewert Typisierung Inhalt
Void -

 

onJoomBeforeComment

 

Beschreibung:

Dieses Event wird ausgelöst, bevor ein Kommentar in die Datenbank gespeichert wird.

 

Event:

onJoomBeforeComment(&$row)

 

Parameter Typisierung Inhalt
$row JTable Objekt-Abbild des geänderten Eintrags der Datenbanktabelle. Das Objekt wird per Referenz übergeben und kann somit verändert werden.
Rückgabewert Typisierung Inhalt
Boolean Der Rückgabewert beeinflusst den Speichervorgang.
TRUE: Speichervorgang wird fortgesetzt.
FALSE: Speichervorgang wird abgebrochen.

 

onJoomAfterComment

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Kommentar in der Datenbank gespeichert wurde.

 

Event:

onJoomAfterComment($row)

 

Parameter Typisierung Inhalt
$row JTable Objekt-Abbild des erstellten Eintrags der Datenbanktabelle.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomBeforeUpload

 

Beschreibung:

Dieses Event wird ausgelöst, bevor ein neues Bild über eine der Upload-Methoden hochgeladen wird.

 

Event:

onJoomBeforeUpload($filename)

 

Parameter Typisierung Inhalt
$filename String Kompletter Dateiname des hochgeladenen Bildes.
Rückgabewert Typisierung Inhalt
Boolean Der Rückgabewert beeinflusst den Uploadvorgang des aktuellen Bildes.
TRUE: Uploadvorgang wird fortgesetzt.
FALSE: Uploadvorgang wird abgebrochen.

 

onJoomAfterUpload

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein neues Bild über eine der Upload-Methoden hochgeladen wurde.

 

Event:

onJoomAfterUpload($row)

 

Parameter Typisierung Inhalt
$row JTable Objekt-Abbild des erstellten Bildes der Datenbanktabelle.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomBeforeVote

 

Beschreibung:

Dieses Event wird ausgelöst, bevor eine neue Bewertung in die Datenbank gespeichert wird.

 

Event:

onJoomBeforeVote(&$row,$vote)

 

Parameter Typisierung Inhalt
$row JTable Objekt-Abbild der erstellten Bewertung der Datenbanktabelle. Das Objekt wird per Referenz übergeben und kann somit verändert werden.
$vote Integer Punkte-Wert der abgegebenen Bewertung. (1:tiefster Wert, 5:bester Wert)
Rückgabewert Typisierung Inhalt
Boolean Der Rückgabewert beeinflusst den Speichervorgang der Bewertung.
TRUE: Speichervorgang wird fortgesetzt.
FALSE: Speichervorgang wird abgebrochen.

 

onJoomAfterVote

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem eine neue Bewertung in die Datenbank gespeichert wurde.

 

Event:

onJoomAfterVote($row, $vote)

 

Parameter Typisierung Inhalt
$row JTable Objekt-Abbild der erstellten Bewertung der Datenbanktabelle.
$vote Integer Punkte-Wert der abgegebenen Bewertung. (1:tiefster Wert, 5:bester Wert)
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterTag

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein neues Namensschild in die Datenbank gespeichert wurde.

 

Event:

onJoomAfterTag($row)

 

Parameter Typisierung Inhalt
$row JTable Objekt-Abbild des erstellten Namensschildes der Datenbanktabelle.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterAddFavourite

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Bild von einem Benutzer zu seinen Favoriten hinzugefügt wurde. (Nach abspeichern des entsprechenden Datenbank Eintrages)

 

Event:

onJoomAfterAddFavourite($id)

 

Parameter Typisierung Inhalt
$id Integer Primärschlüssel-ID des Bildes, welches als Favorit hinzugefügt wurde.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterRemoveFavourite

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Bild von einem Benutzer aus seinen Favoriten entfernt wurde. (Nach Löschung des entsprechenden Datenbank Eintrages)

 

Event:

onJoomAfterRemoveFavourite($id)

 

Parameter Typisierung Inhalt
$id Integer Primärschlüssel-ID des Bildes, welches aus den Favoriten entfernt wurde.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterClearFavourites

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Benutzer seine Favoritenliste geleert hat. (Nach Löschung des entsprechenden Datenbank Eintrages)

 

Event:

onJoomAfterClearFavourites()

 

Parameter Typisierung Inhalt
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterCheckImage

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem ein Bild im Wartungs-Manager überprüft wurde. Nach sämtlichen Checks.

 

Event:

onJoomAfterCheckImage($image,$corrupt,$id)

 

Parameter Typisierung Inhalt
$image JTable Objekt-Abbild des überprüften Bildes der Datenbanktabelle.
$corrupt Boolean TRUE, wenn das Bild als beschädigt erkannt wurde. FALSE, wenn mit dem Bild alles in Ordnung scheint.
$id Integer Primärschlüssel-ID des Datenbankeintrages der Waisen (beschädigten Bilder & Kategorien).
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterCheckCategory

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem eine Kategorie im Wartungs-Manager überprüft wurde. Nach sämtlichen Checks.

 

Event:

onJoomAfterCheckCategory($category,$corrupt,$id)

 

Parameter Typisierung Inhalt
$category JTable Objekt-Abbild der überprüften Kategorie der Datenbanktabelle.
$corrupt Boolean TRUE, wenn die Kategorie als beschädigt erkannt wurde. FALSE, wenn mit der Kategorie alles in Ordnung scheint.
$id Integer Primärschlüssel-ID des Datenbankeintrages der Waisen (beschädigten Bilder & Kategorien).
Rückgabewert Typisierung Inhalt
Void -

 

onContentPrepareData

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem die Daten für eine JForm geladen wurden. Wird meist zusammen mit onContentPrepareForm verwendet.

 

Event:

onContentPrepareData($context,&$row)

 

Parameter Typisierung Inhalt
$context String

com_joomgallery.type

Wobei type je nach Element folgende Werte annimmt:

  • image (Element-Typ: Bild)
  • category (Element-Typ: Kategorie)
$row JTable Objekt-Abbild des eintrages Eintrags der Datenbanktabelle. Das Objekt wird per Referenz übergeben und kann somit verändert werden.
Rückgabewert Typisierung Inhalt
Void -

 

onContentPrepareForm

 

Beschreibung:

Dieses Event wird ausgelöst, bevor eine JForm ausgegeben wird. Wird meist zusammen mit onContentPrepareData verwendet.

 

Event:

onContentPrepareForm($form,$data)

 

Parameter Typisierung Inhalt
$form JForm Joomla Formular-Objekt. Wird gebraucht zum Erstellen, Ausfüllen, Filtern und Validieren von Formularen.
$data JTable Objekt-Abbild des eintrages Eintrags der Datenbanktabelle. Enthält die Daten, welche mit dem onContentPrepareData ergänzt werden konnten.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomGetLastComments

 

Beschreibung:

Dieses Event wird ausgelöst, wenn nach einer bestimmten Anzahl zuletzt hinzugefügter Kommentare gefragt wird. Damit können Erweiterungen von Drittanbietern ihre Kommentare hinzufügen.

 

Event:

onJoomGetLastComments(&$comments,$nmb)

 

Parameter Typisierung Inhalt
$comments NULL Leere Variable, welche durch das Plugin gefüllt werden kann. Gefordert ist ein Array mit der angegebenen Anzahl Kommentar-Objekten.
$nmb Integer Anzahl Kommentare, welche durch das Plugin in $comments gefüllt werden soll.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomGetSmileys

 

Beschreibung:

Dieses Event wird ausgelöst, wenn nach allen verfügbaren Smileys gefragt wird. Es können beliebig Smileys ergänzt, ersetzt oder ignoriert werden.

 

Event:

onJoomGetSmileys(&$smileys)

 

Parameter Typisierung Inhalt
$smileys Array Array mit allen bereits geladenen Smileys. Das Array wird per Referenz übergeben und kann somit verändert werden.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterPrepareDisplayHTML

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem alle Daten für die Anzeige einer HTML-Ausgabe gesammelt, jedoch bevor das Ansichts-Template geladen wurde.

 

Event:

onJoomAfterPrepareDisplayHTML($viewItem, $itemID, &$additionalData)

 

Parameter Typisierung Inhalt
$viewItem String

view.item

Wobei view den Namen der geladenen Ansicht annimmt und item dem Element-Typ entspricht, für welchen zusätzliche Daten hinzugefügt werden sollen.

  • image (Element-Typ: Bild)
  • category (Element-Typ: Kategorie)
$itemID Integer

Primärschlüssel-ID des Elements.
$additionalData Array Liste, welche mit beliebigen Daten gefüllt werden kann. Diese Daten stehen später im zugehörigen Ansichts-Template für eine Ausgabe zur Verfügung.
Wie folgt kann im Template darauf zugegriffen werden: 
$item->additionalData['yourUsedKey']
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterDisplayThumb

 

Beschreibung:

Dieses Event wird ausgelöst, während die Daten für die Anzeige einer HTML-Ausgabe gesammelt werden. Der Rückgabewert wird nach einem Thumbnail eines Bildes ausgegeben.

 

Event:

onJoomAfterDisplayThumb($id)

 

Parameter Typisierung Inhalt
$id Integer Primärschlüssel-ID des Bildes zu welchem das Thumbnail gehört.
Rückgabewert Typisierung Inhalt
String HTML-Code mit Listeneinträgen (li-Elemente) für die Ausgabe in einer ungeordneten Liste (ul-Element) nach dem Bild-Thumbnail.

 

onJoomAfterDisplayCatThumb

 

Beschreibung:

Dieses Event wird ausgelöst, während die Daten für die Anzeige einer HTML-Ausgabe gesammelt werden. Der Rückgabewert wird nach einem Thumbnail einer Kategorie ausgegeben.

 

Event:

onJoomAfterDisplayCatThumb($id)

 

Parameter Typisierung Inhalt
$id Integer Primärschlüssel-ID der Kategorie zu welchem das Thumbnail gehört.
Rückgabewert Typisierung Inhalt
String HTML-Code mit Listeneinträgen (li-Elemente) für die Ausgabe in einer ungeordneten Liste (ul-Element) nach dem Kategorie-Thumbnail.

 

onJoomAfterDisplayDetailImage

 

Beschreibung:

Dieses Event wird ausgelöst, während die Daten für die Anzeige einer HTML-Ausgabe gesammelt werden. Der Rückgabewert wird innerhalb der Sektion mit den Bildinformationen in der Detailansicht ausgegeben.

 

Event:

onJoomAfterDisplayDetailImage($image)

 

Parameter Typisierung Inhalt
$image JTable Objekt-Abbild des Bildes der Datenbanktabelle.
Rückgabewert Typisierung Inhalt
String HTML-Code zur direkten Ausgabe der Informationen.

 

onJoomDisplayIcons

 

Beschreibung:

Dieses Event wird ausgelöst, während die Daten für die Anzeige einer HTML-Ausgabe gesammelt werden. Der Rückgabewert wird als zusätzliche Aktions-Icons ausgegeben.
Aktions-Icons: Stern(Favoriten), Download, Zoom, Report...

 

Event:

onJoomDisplayIcons($viewItem, $item)

 

Parameter Typisierung Inhalt
$viewItem String

view.item

Wobei view den Namen der geladenen Ansicht annimmt und item dem Element-Typ entspricht, bei welchem zusätzlice Icons (HTML-Code) ausgegeben werden soll.

  • image (Element-Typ: Bild)
  • category (Element-Typ: Kategorie)
$item JTable Objekt-Abbild des Element-Typs der Datenbanktabelle.
Rückgabewert Typisierung Inhalt
String HTML-Code zur direkten Ausgabe von Icons.

 

onJoomDisplayUser

 

Beschreibung:

Dieses Event wird ausgelöst, wenn nach Besitzer oder Benutzer gefragt wird. Falls ein Rückgabewert vorhanden, wird dieser statt dem Benutzernamen gemäss JoomGallery ausgegeben.

 

Event:

onJoomDisplayUser($userID, $realname, $context)

 

Parameter Typisierung Inhalt
$userID Integer Primärschlüssel-ID des Benutzer, welchem dieses Element gehört.
$realname Boolean TRUE, wenn der reale Namen angezeigt werden soll. FALSE, wenn der Benutzername angezeigt werden soll.
$context String

type

Wobei type je nach Element folgende Werte annimmt:

  • image (Element-Typ: Bild) (nicht Existent)
  • category (Element-Typ: Kategorie) (nicht Existent)
  • comment (Element-Typ: Kommentar) (nicht Existent)
  • config (Element-Typ: Konfiguration) (nicht Existent)
  • nametag (Element-Typ: Namensschild)
Rückgabewert Typisierung Inhalt
String HTML-Code zur direkten Ausgabe von Icons.

 

onJoomOpenImage

 

Beschreibung:

Dieses Event wird ausgelöst, während die Daten für die Anzeige einer HTML-Ausgabe gesammelt werden und in dieser HTML-Ausgabe ein Popup eines Bildes verfügbar sein soll. Erkennbar im Code durch die Zeile

JHTML::_('joomgallery.popup',...)

 

Wird zusammen mit onJoomOpenImageGetName in den OpenImage-Plugins verwendet.

 

Event:

onJoomOpenImage(&$link, $image, $url, $group, $type, $open)

 

Parameter Typisierung Inhalt
$link String HTML-Code mit einem a-Element, welches ein Link zum öffnen des Bildes enthält. Das Objekt wird per Referenz übergeben und kann somit verändert werden.
$image JTable Objekt-Abbild des Bildes der Datenbanktabelle.
$url String URL des Bildes für die Vollansicht. Sowas in der Art: 
index.php?option=com_joomgallery&view=image&format=raw&type=orig&id=5"
$group String Gruppenname, um mehrere Bilder miteinander zu Gruppieren. Standartwert: 
joomgallery
$type String Bildtyp zum welchem der Link führen soll. 
'thumb', 'img' oder 'orig'
$open String Titel der Methode, mit welcher das Bild geöffnet werden soll.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomOpenImageGetName

 

Beschreibung:

Dieses Event wird ausgelöst, wenn nach zusätzlicher Methoden zum öffnen eines Bildes verlangt wird. Wird zusammen mit onJoomOpenImage in den OpenImage-Plugins verwendet.

 

Event:

onJoomOpenImageGetName()

 

Parameter Typisierung Inhalt
Rückgabewert Typisierung Inhalt
String Titel der Methode, mit welcher das Bild geöffnet werden kann.

 

onJoomGetCaptcha

 

Beschreibung:

Dieses Event wird ausgelöst, wenn ein Captcha zum Schutz vor Spam angefordert wird.

 

Event:

onJoomGetCaptcha($view)

Parameter Typisierung Inhalt
$view String Name der Ansicht, in welcher das Captcha angefordert wird.
Rückgabewert Typisierung Inhalt
String HTML-Code des Captchas

 

onJoomAfterDisplayTabs

 

Beschreibung:

Dieses Event wird in Ansichten ausgelöst, welche über Tabs verfügen (z.B Konfigurations- und Wartungs-Manager). Der Rückgabewert wird an der Position nach dem letzten Tab ausgegeben.

 

Event:

onJoomAfterDisplayTabs($context, $tab)

 

Parameter Typisierung Inhalt
$context String

com_joomgallery.view

Wobei view den Namen der geladenen Ansicht annimmt.
$tab String Name des zur Zeit aktiven Tabs.
Rückgabewert Typisierung Inhalt
String HTML-Code des hinzuzufügenden Tabs.

JHtml::_('tabs.panel', 'Tab-Name', 'CSS-Klasse')
...
Inhalt des Tabs (HTML-Code)

 

onJoomBeforeDownload

 

Beschreibung:

Dieses Event wird ausgelöst, wenn ein Bild zum download angefordert wurde, kurz vor dessen Download.

 

Event:

onJoomBeforeDownload(&$image, &$path, &$type, &$watermark)

 

Parameter Typisierung Inhalt
$image JTable Objekt-Abbild des Bildes der Datenbanktabelle. Das Objekt wird per Referenz übergeben und kann somit verändert werden.
$path String Pfad zum Bild, das heruntergeladen werden soll. Das Objekt wird per Referenz übergeben und kann somit verändert werden.
$type String Bildtyp des Bildes zum Download. 
'thumb', 'img' oder 'orig'
Das Objekt wird per Referenz übergeben und kann somit verändert werden.
$watermark Boolean TRUE, wenn dem Bild zum Download ein Wasserzeichen hinzugefügt werden soll. Sonst FALSE.
Rückgabewert Typisierung Inhalt
Boolean Der Rückgabewert beeinflusst den Downloadvorgang.
TRUE: Downloadvorgang wird fortgesetzt.
FALSE: Downloadvorgang wird abgebrochen.

 

onJoomBeforeZipDownload

 

Beschreibung:

Dieses Event wird ausgelöst, bevor eine Liste von Bildern gezippt wird.

 

Event:

onJoomBeforeZipDownload($files)

 

Parameter Typisierung Inhalt
$files Array Liste mit allen Bildern, die gezippt werden sollen. 
array('imgid'=>array('name','data'))
Wobei der Key imgid der Primärschlüssel-ID des entsprechenden Bildes entspricht.
Rückgabewert Typisierung Inhalt
Boolean Der Rückgabewert beeinflusst den Zipvorgang.
TRUE: Zipvorgang wird gestartet.
FALSE: Zipvorgang wird abgebrochen.

 

onJoomBeforeSendMessage

 

Beschreibung:

Dieses Event wird ausgelöst, bevor eine System-Nachricht an einen bestimmten Benutzer versendet wird.

 

Event:

onJoomBeforeSendMessage($message)

 

Parameter Typisierung Inhalt
$message Array Liste mit allen Informationen der Nachricht. 
array('from','recipient','subject','text','mode','system')
  • from: Absender
  • recipient: Empfänger
  • subject: Betreff
  • text: Nachrichtentext
  • mode: Art der Nachricht
  • system: TRUE: Unbekannter Absender. Super User wird verwendet
Rückgabewert Typisierung Inhalt
Boolean Der Rückgabewert beeinflusst das versenden der Nachricht.
TRUE: Nachricht wird versendet.
FALSE: Nachricht wird nicht versendet.

 

onJoomAfterReport

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem die System-Nachricht "Meldung" zu einem Bild an dessen Besitzer versendet wurde.

 

Event:

onJoomAfterReport($message)

 

Parameter Typisierung Inhalt
$message Array Liste allen Informationen der Meldung. 
array('from','fromname','subject','body','mode')
  • from: Benutzer-ID oder E-Mail Adresse
  • fromname: Name des Benutzers
  • subject: Betreff
  • body: Nachrichtentext
  • mode: report
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterSend2Friend

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem eine Nachricht an einen Freund zu einem Bild versendet wurde.

 

Event:

onJoomAfterSend2Friend($message)

 

Parameter Typisierung Inhalt
$message Array Liste allen Informationen der Meldung. 
array('from','fromname','recipient','subject','body','mode')
  • from: E-Mail Adresse des Benutzers
  • fromname: Name des Benutzers
  • recipient: E-Mail Adresse des Empfängers
  • subject: Betreff
  • body: Nachrichtentext
  • mode: send2friend
Rückgabewert Typisierung Inhalt
Void -

 

onJoomAfterUnlockCat

 

Beschreibung:

Dieses Event wird ausgelöst, nachdem eine passwortgeschütze Kategorie erfolgreich freigeschaltet wurde.

 

Event:

onJoomAfterUnlockCat($catid)

 

Parameter Typisierung Inhalt
$catid Integer Primärschlüssel-ID der Kategorie, welche entsperrt wurde.
Rückgabewert Typisierung Inhalt
Void -

 

onJoomCheckCaptcha

 

Beschreibung:

Dieses Event wird ausgelöst, wenn eine Anfrage eine Verfizierung eines Captchas verlangt. Wird zusammen mit onJoomGetCaptcha in den Captcha-Plugins verwendet.

 

Event:

onJoomCheckCaptcha()

 

Parameter Typisierung Inhalt
Rückgabewert Typisierung Inhalt
Array Liste mit einem Schlüssel "valid". Dieser enthält einen Boolean. TRUE, wenn die Überprüfung erfolgreich war, FALSE wenn nicht erfolgreich.
Falls nicht Erfolgreich, kann ein Schlüssel "error" eine Fehlermeldung zur Ausgabe enthalten. 
array('valid','error')

 

onJoomSearch

 

Beschreibung:

Dieses Event wird ausgelöst, wenn etwas in der JoomGallery eigenen Suche gesucht wird. Der Rückgabewert wird verwendet, um das Query für die Datenbankabfrage zu erstellen. Wird zusammen mit onJoomSearchEngineGetName in den Such-Plugins verwendet.

 

Event:

onJoomSearch($searchstring,$aliases,$context)

 

Parameter Typisierung Inhalt
$searchstring String Sucheingabe, welche in das Suchfeld eigegeben wurde.
$aliases Array Liste mit allen Alias, welche für das DB-Query gebraucht werden. 
array('images','categories')
$context String com_joomgallery.task
Wobei task den Wert des auszuführenden Tasks annimmt.
Rückgabewert Typisierung Inhalt
Array Liste mit unterstützten Suchen und der SQL-Statements, die zum Bau des Querys verwendet werden. 
array('searchengines'=>array(),'images.select','images.leftjoin','images.where','images.where.or')
Der Eintrag 'searchengines' ist zwingend erforderlich, falls das Plugin (auch) andere als die JoomGallery interne Suche unterstützen soll. Liste die Namen aller unterstützten Suchen auf.

onJoomSearchEngineGetName

Beschreibung:

Dieses Event wird ausgelöst, wenn nach zusätzlichen Suchen zum durchsuchen von Bildern verlangt wird. Wird zusammen mit onJoomSearch in den Such-Plugins verwendet.

Event:

onJoomSearchEngineGetName()

Parameter Typisierung Inhalt
Rückgabewert Typisierung Inhalt
String Titel der Suche, mit welcher nach Bildern gesucht werden kann.