driver/search

Der driver/search wird dazu benutzt, eine Such-Maske zu bauen, die Eingabe-Felder enthält und die Anzeige der gefunden Objekte mittels des driver/result durchführt. Über cell/FUNCTION können Umschalter in die Suche eingebaut werden, um beispielsweise die Anzahl der Treffer, die Ansicht oder die Sortierung auswählbar zu machen.

Mask-Properties

array(
	 array('name' => 'Eingangsreihenfolge',
            'order' => 'id DESC'
      ),
     array('name' => "Pool-Name",
           'field' => "lk_pool_id",
           'table' => "pool",
           'order' => "pool.name"
      ),
      array('name' => "Künstler",
			'order' => ' (SELECT name FROM kuenstler WHERE kuenstler.id=(SELECT lk_kuenstler_id FROM bilder__kuenstler WHERE lk_bild_id=bilder.id ORDER BY id LIMIT 1)) ASC')
)

array(array('name' => "ID DESC", 'order => "%%%keep%%%"))

SQL callbacks

Der search driver erlaubt es, sich per PHP den automatisch von easydb zusammengebauten SELECT zu verändern. Dazu kann an beliebiger Stelle die Funktion search_register_sql_callback benutzt werden.

search_register_sql_callback(<functionname>, <parameter>);

// <functionname>: Name der Funktion
// <parameter>: Parameter der übergeben wird

Diese Funktion wird dann automatisch aufgerufen, nachdem easydb den SELECT zusammengebaut hat. Als erster Parameter wird $cid übergeben, als zweiter der registrierte <parameter>.

Folgende Variablen können Sie dann im PHP verändern:

$_SESSION[$cid]["sql"]; // das SQL welches ausgeführt wird, Achtung: ein Leerzeichen am Anfang
$_SESSION[$cid]["orderby"]; // das ORDER BY welches ausgeführt wird.

Beispielsweise kann eine Funktion ein Suchergebnis rekursiv erweitern:

function my_expand_select($cid, $parm) {
  // gibt "15" aus ( nur zum Test )
  echo $parms;

  // holen der sql clause
  $sql = $_SESSION[$cid]["sql"];

  $sql = " FROM item WHERE id IN (
    WITH selected_items AS (
        SELECT item.id ". $sql . "
    ) SELECT id FROM selected_items
    UNION
    SELECT lk_item_to FROM item__item WHERE lk_item_from IN (SELECT id FROM selected_items)
    UNION
    SELECT lk_item_from FROM item__item WHERE lk_item_to IN (SELECT id FROM selected_items)
   )";

   // zurückschreiben
   $_SESSION[$cid]["sql"] = $sql;
}

// registrieren des Callbacks
search_register_sql_callback("my_expand_select", 15);

Benutzen Sie Debug SQL, um Ihr SQL zu debuggen.

p.

cell/FUNCTION

Ein Such-Formular muss do_search, print_result, search_open_form und close_form benutzen!

do_search

Diese FUNCTION führt die eigentlich Suche aus. Sie gibt selbst kein HTML aus. do_search sollte vor search_open_form aufgerufen werden.

searchdef_group

Definiert eine Gruppe von Suchfeldern, die dann mit einem searchdef_modifier verknüpft werden können.

Achten Sie darauf, die Cell-IDs ohne Leerzeichen einzugeben!

searchdef_modifier

Gibt ein Pulldown mit AND, NOT und OR (optional) aus, um Suchfelder in einer Gruppe zu verknüpfen.

search_message

Diese Funktion ist seit Version 4.0.159 obsolet.

Gibt einen Error- oder Hinweis-Text aus der durch den Search-Driver intern gesetzt wurde.

Seit Version 4.0.159 gibt diese Funktion nichts mehr aus. Der Text wird jetzt automatisch bei close_form ausgegeben.

open_form

Diese FUNCTION öffnet das FORM (mit Methode GET) und gibt einiges an Verwaltungs-HTML aus.

Benutzen Sie ab sofort search_open_form. open_form funktioniert weiterhin wird aber nicht mehr empfohlen.

search_open_form

Diese FUNCTION öffnet das FORM und gibt einiges an Verwaltungs-HTML aus. do_search sollte vor search_open_form aufgerufen werden.

close_form

Schließt das FORM.

Seit Version 4.0.159 wird ggfs. ein Error- oder Hinweis-Text ausgegeben (in einer DIV mit der class="search_message").

view_select

Um die Ansicht zu wechseln gibt diese FUNCTION ein Pulldown mit verschiedenen Result-Mask aus.

get_current_result_id

Gibt die ID der aktuellen Result-Mask aus. ( Seit Version 4.0.168 )

get_orderby_select

Gibt den Namen der aktuellen Auswahl der Order-By-Pulldowns aus.

singlelink_thesaurus_children

Gibt eine Checkbox aus, die das Verhalten eines SINGELINKS so umstellt, dass die Suche einmal mit Kindern und einmal ohne Kinder sucht.

search_thesaurus_children

Gibt eine Checkbox aus, die das Verhalten der von normalen TEXT oder SINGLELINK-Searchdef-Suchen so verändert, das einmal die Kinder von gefundenen Treffern mit in die Suche einbezogen werden und einmal nicht.

Beispielsweise kann eine Suche in einer verlinkten Tabelle nach Europa zu genau einem Treffer führen. Wenn diese Checkbox gesetzt ist, werden alle Kinder und Kindeskinder von Europa mit in die Suche einbezogen. Im SINGLELINK-Fall werden alle Kinder und Kindeskinder einbezogen die mit keinem oder dem selben Ort bzw. den selben Orten verlinkt sind.

Die SINGLELINK-Variante funktioniert nur mit PostgreSQL-Datenbanken, nicht mit include_fathers und nur für die n-m- und normalen 1-n- Varianten. Diese Variante gibt es seit Version 4.0.241.

orderby_select

Gibt das Pulldown aus, um die Sortierung zu wählen. Die Sortierungen werden in den Mask-Properties festgelegt.

chunksize_select

Gibt das Pulldown aus, um die Anzahl der Treffer pro Seite zu wählen. Die möglichen Werte werden in den Mask-Properties festgelegt.

chunk_selector

Gibt Links mit Seitenzahlen für die Seiten-Navigation aus.

output_search_navigation

Gibt die Vor-/Zurück-Knöpfe für die Seiten-Navigation aus.

checkbox_search_within

Gibt eine Checkbox aus mit der, wenn gesetzt, innnerhalb des aktuellen Treffer gesucht werden kann.

print_result

Gibt das aktuelle Such-Ergebnis über Result-Mask aus. Die Standard-Result-Mask wird in den Mask-Properties festgelegt.

Die Option mode gibt es seit Version 4.0.168.
Die Option output_escaping gibt es seit Version 4.0.326.

Sie können lokale Dokumente auf dem easydb Web-Server in das Verzeichnis local legen. Die WELCOME_DIV wird als PHP geladen, nutzen Sie die Funktion current_language_code(), um die aktuelle System-Sprache auszulesen.

print_variable

Gibt aktuelle Werte zum Suchergebnis aus.

saved_search_list

Gespeicherte Suchen sind noch nicht in die easydb 4 portiert.

saved_search_new

Gespeicherte Suchen sind noch nicht in die easydb 4 portiert.

found_ids

Gibt die aktuell gefundene Anzahl von Treffern aus.

within_title

Gibt den aktuellen Text aus, der für eine search_within gesetzt wurde. Die Stringtool Variable dafür ist l10n.search.SearchWithinNHits.

Es kommt vor, dass within_title aus $_REQUEST[title] gesetzt wird, also z.B. aus der Sidebar von einer Arbeitsmappe oder Präsentation gesetzt wird.

current_sql

Gibt den aktuellen Select aus der zuletzt von dieser Search-Mask gesucht wurde.

first_call

Gibt 1 aus, wenn die Suche zum ersten Mal aufgerufen wird und noch nichts gesucht wurde.

grid/FUNCTION

header

Rendert die inneren Cols und Rows und setzt damit einen HTTP-Header. Es wird die PHP-Funktion header verwendet.

Diese FUNCTION kann mehrfach verwendet werden. Diese Funktion macht nur Sinn in Verbindung mit search/no_http_header.

Seit Version 4.0.xx

grid/LINK

nav_first

Gibt den LINK aus, um in der Navigation zur ersten Seite in der Trefferliste zu springen.

nav_prev

Gibt den LINK aus, um in der Navigation zur vorherigen Seite in der Trefferliste zu springen.

nav_next

Gibt den LINK aus, um in der Navigation zur nächsten Seite in der Trefferliste zu springen.

nav_last

Gibt den LINK aus, um in der Navigation zur letzten Seite in der Trefferliste zu springen.

form_reset

Gibt den LINK aus, um das Such-Formular zu resetten.

email_result

Seit Version 4.0.199

Erzeugt einen LINK der eine Email versendet.