wMessagecenter::createTodo

Erstellt eine Aufgabe

Funktionsaufruf

Boolean createTodo(String pathMessageObject, String receiver, String text, Array data = array())

Parameter

pathMessageObject

Pfad des Objektes, an das die Aufgabe gebunden ist (z.B. /de oder /de/aktuelles/index.php)

receiver

Empfänger der Aufgabe (z.B. admin, user1)

text

Inhalt der Aufgabe

data

Zusätzliche Daten

isImportant - [|1]: Falls die Aufgabe wichtig ist
sender: Optional kann hier ein Benuzter als Absender angegeben werden, bei dem die Aufgabe dann ebenfalls erscheint.
senderMail: Optional kann hier ein Absenderadresse angegeben werden.
inform - [|no]: Falls weder beim Anlegen noch beim Erledigen eine Mail generiert werden soll
buttons
: Zusätzliche Schaltflächen, um dem Benutzer vorgefertigte Aktionen anbieten zu können. Beispiel: array(array('action' => 'wShowDocument()'), array('action' => 'wShowDocumentInFilemanager()'))

Beispiel: Erstellt eine Aufgabe

Quelltext

<?php

  $pathMessageObject = '/de/aktuelles/meldungen/klimaresonanzfenster.php';
  $receiver          = 'mustermann';
  $messageText       = 'Bitte Übersetzung zur Datei vornehmen.';
  $options           = array('isImportant' => '');
  
  wMessagecenter::createToDo($pathMessageObject, $receiver, $messageText, $options);

?>

Hinweis
Beim Einsatz von Framework-Funktionen in eigenen Skripten beachten Sie bitte den Artikel "So verwenden Sie das PHP-Framework in eigenen Scripten".
Wenn Sie eine Funktion innerhalb einer Weblication® Seite z.B. über das PHP-Quelltext Element oder in einem XSL-Template über wsl:php einbinden, muss das Framework über die grid.php nicht mehr referenziert werden.

FAQs

Wie erstellt man mit wMessagecenter::createTodo eine Aufgabe?: Mit <code class="codeInline">wMessagecenter::createTodo(pathMessageObject, receiver, text, data)</code> wird eine neue Aufgabe angelegt. Dabei werden das gebundene Objekt (Pfad), der Empfänger, der Aufgabentext und optionale Zusatzdaten übergeben.
Welche Parameter benötigt wMessagecenter::createTodo?: Benötigt werden mindestens: - <code class="codeInline">pathMessageObject</code>: Pfad des Objektes, an das die Aufgabe gebunden ist (z.B. <code class="codeInline">/de</code> oder <code class="codeInline">/de/aktuelles/index.php</code>). - <code class="codeInline">receiver</code>: Empfänger der Aufgabe (z.B. <code class="codeInline">admin</code>, <code class="codeInline">user1</code>). - <code class="codeInline">text</code>: Inhalt der Aufgabe. Optional ist <code class="codeInline">data</code> (zusätzliche Daten; Standard: leeres Array).
Wofür steht der Parameter pathMessageObject?: <code class="codeInline">pathMessageObject</code> ist der Pfad des Objektes, an das die Aufgabe gebunden wird. Beispiel: <code class="codeInline">/de</code> oder <code class="codeInline">/de/aktuelles/index.php</code>.
Wofür steht der Parameter receiver?: <code class="codeInline">receiver</code> bestimmt, wer die Aufgabe erhält. Typische Werte sind z.B. <code class="codeInline">admin</code> oder <code class="codeInline">user1</code>.
Was kann im Parameter data (Array) übergeben werden?: Im Parameter <code class="codeInline">data</code> können zusätzliche Daten übergeben werden, z.B. <code class="codeInline">isImportant</code> für die Kennzeichnung, dass die Aufgabe wichtig ist. Außerdem können weitere Optionen/Schaltflächen über das Array bereitgestellt werden (siehe auch Hinweis zu zusätzlichen Schaltflächen).
Wie kann man eine Aufgabe als wichtig kennzeichnen?: Über <code class="codeInline">data</code> kann z.B. <code class="codeInline">isImportant</code> gesetzt werden. Beispiel im Dokument: <code class="codeInline">$options = array('isImportant' => '');</code> und dann <code class="codeInline">wMessagecenter::createToDo(..., $options);</code>.
Was ist sender und senderMail bei wMessagecenter::createTodo?: <code class="codeInline">sender</code> ist optional und erlaubt es, einen Benutzer als Absender anzugeben. Dann erscheint die Aufgabe auch bei diesem Absender. <code class="codeInline">senderMail</code> ist optional und kann eine Absenderadresse angeben.
Was bedeutet inform - [|no]?: <code class="codeInline">inform</code> steuert, ob beim Anlegen und/oder Erledigen eine Mail generiert werden soll. In der Doku steht <code class="codeInline">inform - [|no]</code>, d.h. standardmäßig erfolgt offenbar keine Mailgenerierung, sofern nicht anders konfiguriert.
Wie kann man zusätzliche Schaltflächen/Actions für den Benutzer bereitstellen?: Über <code class="codeInline">data</code> können zusätzliche Schaltflächen bzw. vorgefertigte Aktionen übergeben werden. Beispielhaft wird genannt, dass man z.B. <code class="codeInline">array(array('action' => 'wShowDocument()'), array('action' => 'wShowDocumentInFilemanager()'))</code> als zusätzliche Aktionen einrichten kann.
Gibt es ein Beispiel für den Aufruf von createTodo?: Ja. Beispiel: <pre><code class="codeBlock" style="color: #000000">php $pathMessageObject = '/de/aktuelles/meldungen/klimaresonanzfenster.php'; $receiver = 'mustermann'; $messageText = 'Bitte Übersetzung zur Datei vornehmen.'; $options = array('isImportant' => ''); wMessagecenter::createToDo($pathMessageObject, $receiver, $messageText, $options); </code></pre>
Muss man das Framework in eigenen Skripten bei Verwendung von Framework-Funktionen referenzieren?: Nein, wenn Framework-Funktionen innerhalb einer Weblication®-Seite eingebunden werden (z.B. per PHP-Quelltext-Element oder in einem XSL-Template über <code class="codeInline">wsl:php</code>). Dann muss das Framework über die <code class="codeInline">grid.php</code> nicht mehr referenziert werden. Zusätzlich wird empfohlen, den entsprechenden Artikel zum Einsatz von Framework-Funktionen zu beachten.