Class rex_form_base

Direct known subclasses

rex_config_form, rex_form

Abstract
Package: redaxo\core\form
Located at redaxo/src/core/lib/form/form_base.php

Methods summary

protected
# __construct( mixed $fieldset, mixed $name, mixed $method = 'post', mixed $debug = false )

Diese Konstruktor sollte nicht verwendet werden. Instanzen muessen ueber die facotry() Methode erstellt werden!

public
# init( )

Initialisiert das Formular.

protected
# loadBackendConfig( )

Laedt die Konfiguration die noetig ist um rex_form im REDAXO Backend zu verwenden.

public
# setFormId( mixed $id )
public string
# getUrl( array $params = [], boolean $escape = true )

Gibt eine Formular-Url zurück.

public
# addFieldset( mixed $fieldset )

Fuegt dem Formular ein Fieldset hinzu. Dieses dient dazu ein Formular in mehrere Abschnitte zu gliedern.

public rex_form_element
# addField( string $tag, string $name, mixed $value = null, array $attributes = [], boolean $addElement = true )

Fuegt dem Formular ein Input-Feld hinzu.

public rex_form_container_element
# addContainerField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Container-Feld hinzu.

public rex_form_element
# addInputField( string $type, string $name, mixed $value = null, array $attributes = [], boolean $addElement = true )

Fuegt dem Formular ein Input-Feld mit dem Type $type hinzu.

public rex_form_element
# addTextField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Text-Feld hinzu.

public rex_form_element
# addReadOnlyTextField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Read-Only-Text-Feld hinzu. Dazu wird ein input-Element verwendet.

public rex_form_element
# addReadOnlyField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Read-Only-Feld hinzu. Dazu wird ein span-Element verwendet.

public rex_form_element
# addHiddenField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Fomular ein Hidden-Feld hinzu.

public rex_form_checkbox_element
# addCheckboxField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Fomular ein Checkbox-Feld hinzu. Dies ermoeglicht die Mehrfach-Selektion aus einer vorgegeben Auswahl an Werten.

public rex_form_radio_element
# addRadioField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Radio-Feld hinzu. Dies ermoeglicht eine Einfache-Selektion aus einer vorgegeben Auswahl an Werten.

public rex_form_element
# addTextAreaField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Textarea-Feld hinzu.

public rex_form_select_element
# addSelectField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Select/Auswahl-Feld hinzu.

public rex_form_widget_media_element
# addMediaField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Feld hinzu mit dem der Medienpool angebunden werden kann. Es kann nur ein Element aus dem Medienpool eingefuegt werden.

public rex_form_widget_medialist_element
# addMedialistField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Feld hinzu mit dem der Medienpool angebunden werden kann. Damit koennen mehrere Elemente aus dem Medienpool eingefuegt werden.

public rex_form_widget_linkmap_element
# addLinkmapField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Feld hinzu mit dem die Struktur-Verwaltung angebunden werden kann. Es kann nur ein Element aus der Struktur eingefuegt werden.

public rex_form_widget_linklist_element
# addLinklistField( string $name, mixed $value = null, array $attributes = [] )

Fuegt dem Formular ein Feld hinzu mit dem die Struktur-Verwaltung angebunden werden kann. Damit koennen mehrere Elemente aus der Struktur eingefuegt werden.

public rex_form_control_element
# addControlField( rex_form_element $saveElement = null, rex_form_element $applyElement = null, rex_form_element $deleteElement = null, rex_form_element $resetElement = null, rex_form_element $abortElement = null )

Fuegt dem Fomualar ein Control-Feld hinzu. Damit koennen versch. Aktionen mit dem Fomular durchgefuert werden.

public rex_form_raw_element
# addRawField( string $html )

Fuegt dem Formular beliebiges HTML zu.

public
# addErrorMessage( mixed $errorCode, mixed $errorMessage )

Fuegt dem Formular eine Fehlermeldung hinzu.

public
# addParam( mixed $name, mixed $value )

Fuegt dem Formular einen Parameter hinzu. Diese an den Stellen eingefuegt, an denen das Fomular neue Requests erzeugt.

public array
# getParams( )

Gibt alle Parameter des Fomulars zurueck.

public string
# getParam( string $name, mixed $default = null )

Gibt den Wert des Parameters $name zurueck, oder $default kein Parameter mit dem Namen exisitiert.

protected rex_form_element
# addElement( rex_form_element $element )

Allgemeine Bootleneck-Methode um Elemente in das Formular einzufuegen.

public rex_form_element
# createInput( string $inputType, string $name, mixed $value = null, array $attributes = [] )

Erstellt ein Input-Element anhand des Strings $inputType.

protected rex_form_element
# createElement( string $tag, string $name, mixed $value, array $attributes = [] )

Erstellt ein Input-Element anhand von $tag.

protected
# getId( mixed $name )
abstract protected
# getValue( mixed $name )
public
# setApplyUrl( mixed $url )

Setzt die Url die bei der apply-action genutzt wird.

public static rex_form_element
# getInputClassName( string $inputType )
public static string
# getInputTagName( string $inputType )
public static array
# getInputAttributes( string $inputType )
protected boolean
# isHeaderElement( rex_form_element $element )
protected boolean
# isFooterElement( rex_form_element $element )
protected boolean
# isControlElement( rex_form_element $element )
protected boolean
# isRawElement( rex_form_element $element )
protected rex_form_element[]
# getHeaderElements( )
protected rex_form_element[]
# getFooterElements( )
protected string
# getFieldsetName( )
protected array
# getFieldsets( )
protected array
# getFieldsetElements( )
protected array
# getSaveElements( )
protected rex_form_control_element
# getControlElement( )
protected rex_form_element
# getElement( string $fieldsetName, string $elementName )
public string
# getName( )
public
# setWarning( mixed $warning )
public string
# getWarning( )
public
# setMessage( mixed $message )
public string
# getMessage( )
protected
# preView( mixed $fieldsetName, mixed $fieldName, mixed $fieldValue )

Callbackfunktion, damit in subklassen der Value noch beeinflusst werden kann wenn das Feld mit Datenbankwerten angezeigt wird.

public array
# fieldsetPostValues( string $fieldsetName )
public string
# elementPostValue( string $fieldsetName, string $fieldName, mixed $default = null )
protected boolean
# validate( )

Validiert die Eingaben. Gibt true zurück wenn alles ok war, false bei einem allgemeinen Fehler oder einen String mit einer Fehlermeldung.

protected
# processPostValues( )

Übernimmt die POST-Werte in die FormElemente.

abstract protected boolean|string|integer
# save( )

Saves the form.

protected boolean
# delete( )
protected
# redirect( mixed $listMessage = '', mixed $listWarning = '', array $params = [] )
public string
# get( )
public
# show( )

Properties summary

protected string $name
protected string $method

"get" or "post"

protected string $fieldset
protected array $elements
protected array $params
protected boolean $debug
protected null|string $applyUrl
protected null|string $message
protected array $errorMessages
protected string $warning
protected null|string $formId