Referenz > Ereignis-Handler

array OnSearch($query)

Wird aufgerufen, wenn ein Benutzer die Such-Funktion in seinem Account verwendet. In $query wird der Suchbegriff übergeben.

Die Funktion muss ein Array mit Such-Kategorien und enthaltenen Ergebnissen zurückliefern, dass folgendes Format aufweist:

Quellcode
Darstellung:
  1. Array
  2. (
  3.     [0] => Array
  4.         (
  5.             [title] => Kategorie-Titel
  6.        [name] => Bezeichner/Name der Kategorie (wie auch in GetSearchCategories() verwendet)
  7.             [icon] => Kategorie-Symbol im images/li/-Verzeichnis (.png wird automatisch angehängt)
  8.             [results] => Array
  9.                 (
  10.                     [0] => Array
  11.                         (
  12.                             [icon] => Ergebnis-Symbol im images/li/-Verzeichnis (.png wird automatisch angehängt)
  13.                             [title] => Ergebnis-Titel
  14.                             [link] => Ergebnis-Link (&sid=[session-id] wird automatisch angehängt)
  15.                             [date] => Datum des Ergebnisses, falls sinnvoll
  16.                             [size] => Größe des Ergebnisses, falls sinnvoll
  17.                             [id] => ID des Ergebnisses (wird z.B. an HandleSearchMassAction() übergeben)
  18.                             [bold] => true, wenn Ergebnis fett dargestellt werden soll
  19.                             [strike] => true, wenn Ergebnis durchgestrichen werden soll
  20.                         ) 
  21.                     ...
  22.                 )
  23.             [massActions] => Array
  24.                 (
  25.                     [aktionname] => Aktion-Titel, z.B.:
  26.                     [delete] => Löschen
  27.                     ...
  28.                 )
  29.  
  30.         ) 
  31.     ...
  32. )

Blau dargestellte Elemente wurden in b1gMail 7.2 eingeführt und werden von älteren Versionen ignoriert.

Falls kein Datum (date) oder keine Größe (size) oder keine ID (id) zu einem Eintrag angegeben werden können (z.B. weil eine solche Angabe für den Ergebnistyp nicht sinnvoll ist), wird der entsprechende Wert im Array einfach nicht gesetzt.

Wird kein Ergebnis erzielt, muss ein leeres Array zurückgegeben werden.