Wiedervorlage Funktionen

Aus Limbas Wiki

Wechseln zu: Navigation, Suche

<-- zurück zu Admin-Dokumentation / <-- zurück zur Hauptseite

lmb_addReminder

function lmb_addReminder($gfrist,$gfrist_desc,$gtabid,$ID,$to=null,$category=0,$wfl_inst=null,$fielddesc=null,$message=null){ ... }

Die Funktion lmb_addReminder fügt eine Wiedervorlage in die Tabelle lmb_reminder ein. Es gibt dabei folgende Übergabeparameter:

  • timestamp $gfrist füllt das Datenbankfeld frist
  • varchar $gfrist_desc füllt das Datenbankfeld description
  • int2 $gtabid füllt das Datenbankfeld tabid
  • numeric $ID füllt das Datenbankfeld dat_id
  • string $to Default null; _u falls die Wiedervorlage einem einzelnen Benutzer zugeordnet wird, _g falls die Wiedervorlage für eine Gruppe ist
  • int2 $category Default 0; falls die Wiedervorlage für einen Kunden gesetzt wird gibt es die Möglichkeit die Kategorie "Aquise" = 1 oder "ohne" = 0 auszuwählen.
  • numeric $wfl_inst (workflow instance) Default null; Falls es sich um die Wiedervorlage für einen Kunden handelt und dabei die Kategorie "Aquise" ausgewählt wurde wird das Attribut $wfl_inst gesetzt, wenn der erste Punkt im Workflow gesetzt wird.
  • string $fielddesc Default null; Datenbankfeld content
  • boolean $message Default null; ob eine Nachricht per Mail gesendet weren soll.

Der Rückgabewert der Funktion ist $out[] (USER_ID falls die Wiedervorlage für einen user ist oder GROUP_ID falls sie für eine Gruppe ist)

Nachrichten Text

Bei senden einer Nachricht kann der Nachrichtentext über eine eigene Funktion angepasst werden. Der Funktionsname ist über die Widervorlageeinstellungen zu definieren.
Für die Standard-Wiedervorlage kann die Funktion über das Array $greminder[$gtabid]["message"][0] = 'myExt_functname' definiert werden.

Beispiel

function myExt_sendReminderMessage($userid,$gtabid,$ID,$categorie,$date,$description,$header,$wfl_inst){
   global $userdat, $session;

   hallo ".$userdat["bezeichnung"][$userid]."<br><br>
   ".$session['vorname']." ".$session['name']." send you a $header - reminder for:<br>
   <i><b><a href=\"".$umgvar['url']."/main.php?action=\"> $header </a></b></i><br><br><br>$description<br><br>";

   $message .="
   -------------------------------------------------------------------------------------<br>
   This is an automatically generated email, please do not reply!<br>
   -------------------------------------------------------------------------------------<br>
   ";
}

lmb_dropReminder

function lmb_dropReminder($rem_id,$gtabid=null,$category=null,$ID=null,$wfl_inst=null,$active=null,$extension=null){ ... }

Die Funktion lmb_dropReminder löscht eine Wiedervorlage aus der Tabelle lmb_reminder. Es gibt dabei folgende Übergabeparameter:

  • numeric $rem_id ID der Tabelle lmb_reminder
  • int2 $gtabid Datenbankfeld tabid
  • int2 $category Default 0; falls es sich um die Wiedervorlage für einen Kunden handelt gibt es die Möglichkeit die Kategorie "Aquise" = 1 oder "ohne" = 0 auszuwählen.
  • numeric $ID Datenbankfeld dat_id
  • numeric $wfl_inst (workflow instance) Default null; Falls es sich um die Wiedervorlage für einen Kunden handelt und dabei die Kategorie "Aquise" ausgewählt wurde ist das Attribut $wfl_inst gesetzt, wenn der erste Punkt im Workflow gesetzt wurde.
  • unknown_type $active Default null; Falls active nicht null ist wird eine Where-Bedingung gesetzt mit FRIST < timestamp
  • string $extension Default null; Falls die extension nicht null ist wird eine Where-Bedingung mit der Extension als Bedingung gesetzt sonst wird eine where-Bedingung ausgeführt, die überprüft ob der aktive Benutzer oder eine aktive Untergruppe gesetzt ist

Der Rückgabewert der Funktion ist true, falls die Wiedervorlage erfolgreich gelöscht wurde und false, falls während des Löschvorgangs ein Fehler aufgetreten ist.

lmb_changeReminder

function lmb_changeReminder($rem_id, $gfrist, $gfrist_desc){ ... }

Die Funktion lmb_changeReminder ändert das Datum und die Beschreibung einer Wiedervorlage aus der Tabelle lmb_reminder. Es gibt dabei folgende Übergabeparameter:

  • numeric $rem_id ID der Tabelle lmb_reminder
  • timestamp $gfrist füllt das Datenbankfeld frist
  • varchar $gfrist_desc füllt das Datenbankfeld description

Der Rückgabewert der Funktion ist true, falls die Wiedervorlage erfolgreich geändert wurde und false, falls während des Änderns ein Fehler aufgetreten ist.

lmb_getReminderAktive

function lmb_getReminderAktive($gtabid,$ID){ ... }

Die Funktion lmb_getReminderAktive gibt die derzeit aktive Wiedervorlage als Resultset zurück. Es gibt dabei folgende Übergabeparameter:

  • int2 $gtabid Datenbankfeld tabid
  • numeric $ID Datenbankfeld dat_id

Der Rückgabewert ist die aktive Wiedervorlage als Resultset.

lmb_getReminder

function lmb_getReminder( ... ){

Bei der Funktion lmb_getReminder handelt es sich um eine getter Funktion für eine Wiedervorlage Es gibt dabei folgende Übergabeparameter:

  • int2 $gtabid Datenbankfeld tabid
  • numeric $ID Datenbankfeld dat_id
  • int2 $category Default 0; falls es sich um die Wiedervorlage für einen Kunden handelt gibt es die Möglichkeit die Kategorie "Aquise" = 1 oder "ohne" = 0 auszuwählen.
  • numeric $wfl_inst (workflow instance) Default null; Falls es sich um die Wiedervorlage für einen Kunden handelt und dabei die Kategorie "Aquise" ausgewählt wurde ist das Attribut $wfl_inst gesetzt, wenn der erste Punkt im Workflow gesetzt wurde.
  • unknown_type $active Default null; Falls active nicht null ist wird eine Where-Bedingung gesetzt mit FRIST < timestamp
  • string $extension Default null; Falls die extension nicht null ist wird eine Where-Bedingung mit der Extension als Bedingung gesetzt sonst wird eine where-Bedingung ausgeführt, die überprüft ob der aktive Benutzer oder eine aktive Untergruppe gesetzt ist

Bei erfolgreicher Abfrage der Wiedervorlage wird diese zurückgegeben ansonsten false.