wBrowseEdit::createButtonCreateDocument

Erstellt eine Schaltfläche zur Erstellung eines neuen Dokumentes (einer neuen Seite)

Funktionsaufruf

String createButtonCreateDocument(String destDir = '', String icon = '', String caption = '', String title = '', Array options = array())

Parameter

destDir

Pfad des Verzeichnisses, in dem das neue Dokument erstellt werden soll

icon

Symbol der Schaltfläche

caption

Beschriftung der Schaltfläche

title

Titel der Schaltfläche

attributes

Weitere Attribute

id => String: ID der Schaltfläche
class => String: CSS Klasse
style => String: CSS Style
destName => String: Name der Zieldatei
createDirIfNotExisting => [0|1]: Falls ein nicht existierenden Zielverzeichnis angelegt werden soll
template => String: Zu verwendende Vorlage
editAfterCreate => String: Nach dem Erstellen wird die angelegte Seite sofort zum Bearbeiten geöffnet.
redirectEndEdit => String: Link auf den der Benutzer nach dem Speichern der Seite weitergeleitet wird falls editAfterCreate auf 1 steht. Falls der Werte auf $document steht, wird nach der Bearbeitung die angelegte Seite aufgerufen.
showInEditor => String: Falls die Schaltfläche auch im Editor angezeigt werden soll.

Beispiel: Button, um eine neue Datei zu erstellen

Quelltext

<?php

$destDir     = "/de/aktuelles/meldungen"; // Pfad des Verzeichnisses
$icon        = "add_file"; // Symbol der Schaltfläche
$caption     = "Neue Datei"; // Bezeichnung der Schaltfläche
$title       = "Klicken Sie hier, um eine Datei zu erstellen"; // Titel der Schaltfläche
$attributes  = ""; // Array
print wBrowseEdit::createButtonCreateDocument($destDir, $icon, $caption, $title; $attributes);

?>

Beispiel: Button, um eine neue Datei zu erstellen und nach Erstellen direkt die Bearbeitung zu öffnen

Quelltext

<?php

$destDir     = "/de/aktuelles/meldungen"; // Pfad des Verzeichnisses
$icon        = "add_file"; // Symbol der Schaltfläche
$caption     = "Neue Datei"; // Bezeichnung der Schaltfläche
$title       = "Klicken Sie hier, um eine Datei zu erstellen"; // Titel der Schaltfläche
$attributes  = array('editAfterCreate' => '1'); // Array
print wBrowseEdit::createButtonCreateDocument($destDir, $icon, $caption, $title, $attributes);

?>

Beispiel: Button mit eigenem Icon

Quelltext

<?php

print '<style>
         img   {width:48px;height:48px;}
      </style>
      <hr /><h4>Mit eigenem Icon:</h4>';
$destDir     = "/de/aktuelles/meldungen"; // Pfad des Verzeichnisses
$icon        = '/default-wGlobal/wGlobal/layout/images/links/next.svg';
$caption     = "Neue Datei"; // Bezeichnung der Schaltfläche
$title       = "Klicken Sie hier, um eine Datei zu erstellen"; // Titel der Schaltfläche
$attributes  = null; // Array
print wBrowseEdit::createButtonCreateDocument($destDir, $icon, $caption, $title, $attributes);

?>

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

Wofür ist wBrowseEdit::createButtonCreateDocument gedacht?: Die Funktion erstellt eine Schaltfläche, über die ein neues Dokument bzw. eine neue Seite erstellt werden kann (z. B. eine neue Datei im gewünschten Zielverzeichnis).
Welche Rolle spielt der Parameter destDir?: destDir gibt den Pfad des Verzeichnisses an, in dem das neue Dokument erstellt werden soll.
Welche Parameter steuern Aussehen und Beschriftung der Schaltfläche?: Mit icon wird das Symbol der Schaltfläche gesetzt, mit caption die Beschriftung (Anzeige-Text) und mit title der Titel (Tooltip/HTML-Titel je nach Kontext). Zusätzlich können weitere Attribute über attributes übergeben werden (z. B. id sowie CSS class/style).
Wie kann man zusätzliche HTML-/Framework-Attribute für die Schaltfläche setzen?: Über den Parameter attributes (als Array) können weitere Attribute als Key-Value-Paare übergeben werden, z. B. id (StringID), class (CSS Klasse) oder style (CSS Style).
Wie erstellt man eine neue Seite mit einer Basis-Konfiguration?: Beispiel: <pre><code class="codeBlock" style="color: #000000">php $destDir = "/de/aktuelles/meldungen"; $icon = "add_file"; $caption = "Neue Datei"; $title = "Klicken Sie hier, um eine Datei zu erstellen"; print wBrowseEdit::createButtonCreateDocument($destDir, $icon, $caption, $title, $attributes); </code></pre>
Wie öffnet man nach dem Erstellen direkt die Bearbeitung der neuen Seite?: Setze editAfterCreate auf 1, z. B.: <pre><code class="codeBlock" style="color: #000000">php $attributes = array('editAfterCreate' => '1'); print wBrowseEdit::createButtonCreateDocument($destDir, $icon, $caption, $title, $attributes); </code></pre>
Wohin wird der Benutzer nach dem Speichern weitergeleitet, wenn editAfterCreate aktiv ist?: Über redirectEndEdit kann ein Link angegeben werden, auf den nach dem Speichern weitergeleitet wird (falls editAfterCreate auf 1 steht). Steht der Wert auf $document, wird nach der Bearbeitung die angelegte Seite aufgerufen.
Kann man steuern, ob die Schaltfläche auch im Editor angezeigt wird?: Ja. Mit showInEditor kann festgelegt werden, ob die Schaltfläche zusätzlich im Editor angezeigt werden soll.
Wie kann man ein Zielverzeichnis automatisch anlegen lassen?: Mit createDirIfNotExisting (Werte [0|1]) kann gesteuert werden, ob ein nicht existierendes Zielverzeichnis angelegt werden soll.
Wie kann eine Vorlage (Template) für die neue Seite ausgewählt werden?: Über den Parameter template kann eine Zu verwendende Vorlage angegeben werden, die für die Erstellung der neuen Seite genutzt wird.
Wie kann man den Namen der neu zu erstellenden Zieldatei festlegen?: Mit destName kann der Name der Zieldatei vorgegeben werden.
Wie kann man ein eigenes Icon verwenden?: Statt eines vordefinierten Icons kann icon auf einen eigenen Icon-Pfad gesetzt werden, z. B.: <pre><code class="codeBlock" style="color: #000000">php $icon = '/default-wGlobal/wGlobal/layout/images/links/next.svg'; print wBrowseEdit::createButtonCreateDocument($destDir, $icon, $caption, $title, $attributes); </code></pre>
Gibt es Hinweise zur Nutzung von Framework-Funktionen in eigenen Skripten/Seiten?: Beim Einsatz von Framework-Funktionen in eigenen Skripten sollte der verlinkte Artikel beachtet werden. Wenn eine Funktion innerhalb einer Weblication®-Seite z. B. über ein PHP-Quelltext-Element oder in einem XSL-Template über wsl:php eingebunden wird, muss das Framework über die grid.php nicht mehr referenziert werden.