danielweitenauer / mform

Spielend einfach umfangreiche Modul-Input-Formulare erzeugen.

MForm - REDAXO Addon für bessere Input-Formulare

MForm ist ein REDAXO Addon, welches das Erstellen von Modul-Eingabeformularen erheblich erleichtert. Dabei nutzt MForm Templates welche es dem Administrator ermöglichen den Modul-Style seinen Vorstellungen anzupassen. MForm stellt alle gängigen Modul-Input-Formular-Elemente und zusätzlice Widgets bereit welche sich einfach einbinden lassen. MForm eweitert auch YForm und rex_form um zusätzliche Widgets, z.B. ein Custom-Link-Feld und Image-List für Galerien.

Eine detailierte Beschreibung wie Modul-Input-Formulare mit beliebigen Elementen versehen werden können lässt sich im Doku-Plugin finden.

Hinweis

• Der MForm Formular-Builder ist ausschließlich dafür geeignet REDAXO Modul-Input-Formulare zu generieren!

Installation

1. Letzten release downloaden
2. Zip Archiv entpacken
3. Entpackten Folder in mform umbenennen
4. MForm Ordner in den REDAXO Addon Ordner redaxo/src/addons/ verschieben
5. In REDAXO einloggen und unter "AddOns" MForm installieren und aktivieren

Alternative Installationen

MForm kann auch direkt über den Redaxo-Installer Installiert werden. MForm Redaxo Addon Page

1. In REDAXO einloggen
2. Im Backend unter "Installer > Neue herunterladen" "MForm" suche und unter "Funktion" "ansehen" klicken
3. Bei der aktuelle Version in der Liste unter "Funktion" "herunterladen" klicken
4. Unter "AddOns" MForm installieren und aktivieren

Usage

MForm muss im Modul-Input eines REDAXO Moduls als PHP Code notiert werden.

Instanziierung

// instantiate
$MForm = new MForm();

Der MForm Classe kann im Konstruktor der Templatename übergeben werden. Dabei entspricht der Templatename dem Prefix des Templateordners.

// instantiate
$MForm = new MForm('table');

Formularelemente

Die wesentlichen Formularelemente die MForm bereitstellt werden durch Methoden hinzugefügt.

// add headline
$MForm->addHeadline("Headline");
    
// add text field
$MForm->addTextField(1, array('label'=>'Input', 'style'=>'width:200px'));

Alle MForm Methoden erwarten optional Attribute, Parameter und Optionen. Diese können auch durch Setter nachträglich dem Element zugewiesen werden.

// add text field
$MForm->addTextField(1);
$MForm->setLabel('Text Field');
$MForm->setAttributes(array('style'=>'width:200px', 'class'=>'test-field'));

Der REX_VALUE-Key muss jeder Formular-Input-Methode als Pflichtfeld übergeben werden. Informative Elemente benötigen keine ID.

Full JSON Value Support

MForm unterstützt REX_VALUE-ARRAYs wodurch es praktisch keine REX_VALUE-Limitierung mehr gibt. Zu beachten ist, dass jeder x.0 Key als Sting übergeben werden muss.

// add text field
$MForm->addTextField("1.0");
$MForm->addTextField(1.1);
$MForm->addTextField("1.2.Titel");

Formular erzeugen

Um das komponierte Formular erzeugen zu lassen muss muss die show Methode genutzt werden.

 // create output
echo $MForm->show();

Element-Methoden

MForm stellt folgende Element-Methoden bereit:

• Strukturelle-Elemente
  • addFieldset
  • closeFieldset (deprecated)
  • addTab
  • closeTab (deprecated)
• Text-Input- und Hidden-Elemente
  • addTextField
  • addHiddenField
  • addTextAreaField
  • addTextReadOnlyField
  • addTextAreaReadOnlyField
• Select-Elemente
  • addSelectField
  • addMultiSelectField
• Checkbox- und Radio-Elemente
  • addCheckboxField
  • addRadioField
• Informelle-Elemente
  • addHtml
  • addHeadline
  • addDescription
• System-Button-Elemente
  • addLinkField
  • addLinklistField
  • addMediaField
  • addMedialistField
• Custom-Elemente
  • addCustomLinkField
  • addImagelistField
  • addInputField
• Spezielle setter-Methoden
  • setLabel
  • setPlaceholder
  • setMultiple
  • setSize

Geplante Elemente

• Callback-Element
  • callback
• Strukturelle-Elemente
  • columns
• Informelle-Elemente
  • addInfo
  • addWarning
  • addError

Lizenz

MForm ist unter der MIT Lizenz lizensiert.