Erweiterungen

Wiedervorlage Funktionen

Geschätzte Lektüre: 5 Minuten

GUI Element (Javascript)

limbasDivShowReminder

limbasDivShowReminder(evt,el,add,remove,changeView,change,defaults,gtabid,ID)
  • evt – event [event]
  • el – js element [this]
  • add – hinzufügen [1]
  • remove – löschen [reminder ID]
  • change – ändern [reminder ID]
  • defaults – Defaultwerte [array]
  • gtabid – table ID [gtabid]
  • ID – dataset ID [ID]
defaults using in formular parameter:

    * datetime => string | e.g. '16.03.2016 22:44'
    * usergroups => string | e.g. '33_u;22_g;55_u' or  for the current user
    * remark => string
    * mail => 0 or 1
    * category => int | id of category to use, 0 for default
    * hidecurrent => 1 to hide
    * gtabid
    * ID
   /*

   $gtabid = 1;
   ID = 23;
   return array(
       'datetime' => '10.03.2017 22:55',
       'usergroups' => '1_u',
       'remark' => 'testtttt',
       'mail' => 0,
       'category' => 2,
       'hidecurrent' => 1
   );

PHP Funktionen

lmb_addReminder

function lmb_addReminder($gfrist,$gfrist_desc,$gtabid,$ID,$to=null,$category=0,$wfl_inst=null,$fielddesc=null,$sendmail=null,$form_id=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; Entscheidet in welche Wiedervorlagengruppe die neue Wiedervorlage hinzugefügt werden soll.
  • 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 $sendmail Default null; ob eine Nachricht per Mail gesendet weren soll.
  • int2 $form_id Default null; Welches Formular sich beim Anklicken der Wiedervorlage öffnet.

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,$valid=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; Wählt die gewünschte Wiedervorlagengruppe aus.
  • 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 $valid Default null; Falls active nicht null ist wird eine Where-Bedingung gesetzt mit FRIST < timestamp
  • string $extension Default null; Momentan nicht in Benutzung.

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_getReminder

function lmb_getReminder($gtabid=null,$ID=null,$category=null,$wfl_inst=null,$valid=null){ ... }

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; Bestimmt aus welcher Wiedervorlagengruppe die Wiedervorlage ausgewählt werden soll.
  • 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 $valid Default null; Falls valid nicht null ist wird eine Where-Bedingung gesetzt mit FRIST < timestamp

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

lmb_getReminderCount

function lmb_getReminderCount($category){ ... }

Die Funktion lmb_getReminderCount bietet eine einfache Möglichkeit die Anzahl der aktiven Wiedervorlagen zu erhalten. Es gibt dabei folgende Übergabeparameter:

  • int2 $category Default 0; Wählt aus aus welcher Gruppe die Wiedervorlagen gezählt werden sollen.

Der Rückgabewert ist die Anzahl an gefundenen Wiedervorlagen.

Share this Doc

Wiedervorlage Funktionen

Or copy link

CONTENTS