Documentation

rex_form_base
in package

AbstractYes

Table of Contents

Properties

$applyUrl  : string|null
$debug  : bool
$elements  : array<string, array<int, rex_form_element>>
$errorMessages  : array<int, string>
$fieldset  : string
$formId  : string|null
$message  : string|null
$method  : string
$name  : string
$params  : array<string, string|int|bool>
$warning  : string|null

Methods

addCheckboxField()  : rex_form_checkbox_element
Fuegt dem Fomular ein Checkbox-Feld hinzu.
addContainerField()  : rex_form_container_element
Fuegt dem Formular ein Container-Feld hinzu.
addControlField()  : rex_form_control_element
Fuegt dem Fomualar ein Control-Feld hinzu.
addErrorMessage()  : void
Fuegt dem Formular eine Fehlermeldung hinzu.
addField()  : rex_form_element
Fuegt dem Formular ein Input-Feld hinzu.
addFieldset()  : void
Fuegt dem Formular ein Fieldset hinzu.
addHiddenField()  : rex_form_element
Fuegt dem Fomular ein Hidden-Feld hinzu.
addInputField()  : rex_form_element
Fuegt dem Formular ein Input-Feld mit dem Type $type hinzu.
addLinklistField()  : rex_form_widget_linklist_element
Fuegt dem Formular ein Feld hinzu mit dem die Struktur-Verwaltung angebunden werden kann.
addLinkmapField()  : rex_form_widget_linkmap_element
Fuegt dem Formular ein Feld hinzu mit dem die Struktur-Verwaltung angebunden werden kann.
addMediaField()  : rex_form_widget_media_element
Fuegt dem Formular ein Feld hinzu mit dem der Medienpool angebunden werden kann.
addMedialistField()  : rex_form_widget_medialist_element
Fuegt dem Formular ein Feld hinzu mit dem der Medienpool angebunden werden kann.
addParam()  : void
Fuegt dem Formular einen Parameter hinzu.
addRadioField()  : rex_form_radio_element
Fuegt dem Formular ein Radio-Feld hinzu.
addRawField()  : rex_form_raw_element
Fuegt dem Formular beliebiges HTML zu.
addReadOnlyField()  : rex_form_element
Fuegt dem Formular ein Read-Only-Feld hinzu.
addReadOnlyTextField()  : rex_form_element
Fuegt dem Formular ein Read-Only-Text-Feld hinzu.
addSelectField()  : rex_form_select_element
Fuegt dem Formular ein Select/Auswahl-Feld hinzu.
addTextAreaField()  : rex_form_element
Fuegt dem Formular ein Textarea-Feld hinzu.
addTextField()  : rex_form_element
Fuegt dem Formular ein Text-Feld hinzu.
createInput()  : rex_form_element
Erstellt ein Input-Element anhand des Strings $inputType.
elementPostValue()  : string|null
fieldsetPostValues()  : array<string|int, mixed>
get()  : string
getInputAttributes()  : array<string|int, mixed>
getInputClassName()  : rex_form_element>
getInputTagName()  : string
getMessage()  : string
getName()  : string
getParam()  : mixed
Gibt den Wert des Parameters $name zurueck, oder $default kein Parameter mit dem Namen exisitiert.
getParams()  : array<string, string|int|bool>
Gibt alle Parameter des Fomulars zurueck.
getUrl()  : string
Gibt eine Formular-Url zurück.
getWarning()  : string
init()  : void
Initialisiert das Formular.
setApplyUrl()  : void
Setzt die Url die bei der apply-action genutzt wird.
setFormAttribute()  : void
setFormId()  : void
setMessage()  : void
setWarning()  : void
show()  : void
__construct()  : mixed
Diese Konstruktor sollte nicht verwendet werden. Instanzen muessen ueber die factory() Methode erstellt werden!
addElement()  : rex_form_element
Allgemeine Bootleneck-Methode um Elemente in das Formular einzufuegen.
createElement()  : rex_form_element
Erstellt ein Input-Element anhand von $tag.
delete()  : bool|int
getControlElement()  : rex_form_control_element|null
getElement()  : rex_form_element|null
getFieldsetElements()  : array<string, array<int, rex_form_element>>
getFieldsetName()  : string
getFieldsets()  : array<int, string>
getFooterElements()  : array<int, rex_form_element>
getHeaderElements()  : array<int, rex_form_element>
getId()  : string
getSaveElements()  : array<string, array<int, rex_form_element>>
getValue()  : mixed
isControlElement()  : bool
isFooterElement()  : bool
isHeaderElement()  : bool
isRawElement()  : bool
loadBackendConfig()  : void
Laedt die Konfiguration die noetig ist um rex_form im REDAXO Backend zu verwenden.
preView()  : mixed
Callbackfunktion, damit in subklassen der Value noch beeinflusst werden kann wenn das Feld mit Datenbankwerten angezeigt wird.
processPostValues()  : void
Übernimmt die POST-Werte in die FormElemente.
redirect()  : never
save()  : bool|string|int
Saves the form.
validate()  : bool|string
Validiert die Eingaben.

Properties

$errorMessages

protected array<int, string> $errorMessages = []

$method

protected string $method

"get" or "post"

$params

protected array<string, string|int|bool> $params

Methods

addCheckboxField()

Fuegt dem Fomular ein Checkbox-Feld hinzu.

public addCheckboxField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_checkbox_element

Dies ermoeglicht die Mehrfach-Selektion aus einer vorgegeben Auswahl an Werten.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_checkbox_element

addContainerField()

Fuegt dem Formular ein Container-Feld hinzu.

public addContainerField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_container_element

Ein Container-Feld wiederrum kann weitere Felder enthalten.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_container_element

addControlField()

Fuegt dem Fomualar ein Control-Feld hinzu.

public 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 ]) : rex_form_control_element

Damit koennen versch. Aktionen mit dem Fomular durchgefuert werden.

Parameters
$saveElement : rex_form_element = null
$applyElement : rex_form_element = null
$deleteElement : rex_form_element = null
$resetElement : rex_form_element = null
$abortElement : rex_form_element = null
Return values
rex_form_control_element

addErrorMessage()

Fuegt dem Formular eine Fehlermeldung hinzu.

public addErrorMessage(int $errorCode, string $errorMessage) : void
Parameters
$errorCode : int
$errorMessage : string

addField()

Fuegt dem Formular ein Input-Feld hinzu.

public addField(string $tag, string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ][, bool $addElement = true ]) : rex_form_element
Parameters
$tag : string
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
$addElement : bool = true
Return values
rex_form_element

addFieldset()

Fuegt dem Formular ein Fieldset hinzu.

public addFieldset(string $fieldset[, array<string, int|string|array<int, string>> $attributes = [] ]) : void

Dieses dient dazu ein Formular in mehrere Abschnitte zu gliedern.

Parameters
$fieldset : string
$attributes : array<string, int|string|array<int, string>> = []

addHiddenField()

Fuegt dem Fomular ein Hidden-Feld hinzu.

public addHiddenField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_element
Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_element

addInputField()

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

public addInputField(string $type, string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ][, bool $addElement = true ]) : rex_form_element
Parameters
$type : string
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
$addElement : bool = true
Return values
rex_form_element

addLinklistField()

Fuegt dem Formular ein Feld hinzu mit dem die Struktur-Verwaltung angebunden werden kann.

public addLinklistField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_widget_linklist_element

Damit koennen mehrere Elemente aus der Struktur eingefuegt werden.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Tags
throws
rex_exception
Return values
rex_form_widget_linklist_element

addLinkmapField()

Fuegt dem Formular ein Feld hinzu mit dem die Struktur-Verwaltung angebunden werden kann.

public addLinkmapField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_widget_linkmap_element

Es kann nur ein Element aus der Struktur eingefuegt werden.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Tags
throws
rex_exception
Return values
rex_form_widget_linkmap_element

addMediaField()

Fuegt dem Formular ein Feld hinzu mit dem der Medienpool angebunden werden kann.

public addMediaField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_widget_media_element

Es kann nur ein Element aus dem Medienpool eingefuegt werden.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Tags
throws
rex_exception
Return values
rex_form_widget_media_element

addMedialistField()

Fuegt dem Formular ein Feld hinzu mit dem der Medienpool angebunden werden kann.

public addMedialistField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_widget_medialist_element

Damit koennen mehrere Elemente aus dem Medienpool eingefuegt werden.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Tags
throws
rex_exception
Return values
rex_form_widget_medialist_element

addParam()

Fuegt dem Formular einen Parameter hinzu.

public addParam(string $name, string|int|bool $value) : void

Diese an den Stellen eingefuegt, an denen das Fomular neue Requests erzeugt.

Parameters
$name : string
$value : string|int|bool

addRadioField()

Fuegt dem Formular ein Radio-Feld hinzu.

public addRadioField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_radio_element

Dies ermoeglicht eine Einfache-Selektion aus einer vorgegeben Auswahl an Werten.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_radio_element

addReadOnlyField()

Fuegt dem Formular ein Read-Only-Feld hinzu.

public addReadOnlyField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_element

Dazu wird ein span-Element verwendet.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_element

addReadOnlyTextField()

Fuegt dem Formular ein Read-Only-Text-Feld hinzu.

public addReadOnlyTextField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_element

Dazu wird ein input-Element verwendet.

Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_element

addSelectField()

Fuegt dem Formular ein Select/Auswahl-Feld hinzu.

public addSelectField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_select_element
Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_select_element

addTextAreaField()

Fuegt dem Formular ein Textarea-Feld hinzu.

public addTextAreaField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_element
Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_element

addTextField()

Fuegt dem Formular ein Text-Feld hinzu.

public addTextField(string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_element
Parameters
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_element

createInput()

Erstellt ein Input-Element anhand des Strings $inputType.

public createInput(string $inputType, string $name[, mixed $value = null ][, array<string|int, mixed> $attributes = [] ]) : rex_form_element
Parameters
$inputType : string
$name : string
$value : mixed = null
$attributes : array<string|int, mixed> = []
Return values
rex_form_element

elementPostValue()

public elementPostValue(string $fieldsetName, string $fieldName[, string|null $default = null ]) : string|null
Parameters
$fieldsetName : string
$fieldName : string
$default : string|null = null
Return values
string|null

fieldsetPostValues()

public fieldsetPostValues(string $fieldsetName) : array<string|int, mixed>
Parameters
$fieldsetName : string
Return values
array<string|int, mixed>

get()

public get() : string
Return values
string

getInputAttributes()

public static getInputAttributes(string $inputType) : array<string|int, mixed>
Parameters
$inputType : string
Return values
array<string|int, mixed>

getInputClassName()

public static getInputClassName(string $inputType) : rex_form_element>
Parameters
$inputType : string
Tags
throws
rex_exception
Return values
rex_form_element>

getInputTagName()

public static getInputTagName(string $inputType) : string
Parameters
$inputType : string
Return values
string

getMessage()

public getMessage() : string
Return values
string

getName()

public getName() : string
Return values
string

getParam()

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

public getParam(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string
$default : mixed = null

getParams()

Gibt alle Parameter des Fomulars zurueck.

public getParams() : array<string, string|int|bool>
Return values
array<string, string|int|bool>

getUrl()

Gibt eine Formular-Url zurück.

public getUrl([array<string|int, mixed> $params = [] ][, bool $escape = true ]) : string
Parameters
$params : array<string|int, mixed> = []
$escape : bool = true
Return values
string

getWarning()

public getWarning() : string
Return values
string

init()

Initialisiert das Formular.

public init() : void

setApplyUrl()

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

public setApplyUrl(string|array<string|int, mixed> $url) : void
Parameters
$url : string|array<string|int, mixed>

setFormAttribute()

public setFormAttribute(string $attributeName, string|null $attributeValue) : void
Parameters
$attributeName : string
$attributeValue : string|null

setFormId()

public setFormId(string|null $id) : void
Parameters
$id : string|null

setMessage()

public setMessage(string|null $message) : void
Parameters
$message : string|null

setWarning()

public setWarning(string|null $warning) : void
Parameters
$warning : string|null

__construct()

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

protected __construct(string|null $fieldset, string $name[, "post"|"get" $method = 'post' ][, bool $debug = false ]) : mixed
Parameters
$fieldset : string|null
$name : string
$method : "post"|"get" = 'post'
$debug : bool = false

createElement()

Erstellt ein Input-Element anhand von $tag.

protected createElement(string $tag, string $name, mixed $value[, array<string|int, mixed> $attributes = [] ]) : rex_form_element
Parameters
$tag : string
$name : string
$value : mixed
$attributes : array<string|int, mixed> = []
Return values
rex_form_element

delete()

protected delete() : bool|int
Return values
bool|int

getFieldsetName()

protected getFieldsetName() : string
Return values
string

getFieldsets()

protected getFieldsets() : array<int, string>
Return values
array<int, string>

getId()

protected getId(string $name) : string
Parameters
$name : string
Return values
string

getValue()

protected abstract getValue(string $name) : mixed
Parameters
$name : string

loadBackendConfig()

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

protected loadBackendConfig() : void

preView()

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

protected preView(string $fieldsetName, string $fieldName, mixed $fieldValue) : mixed
Parameters
$fieldsetName : string
$fieldName : string
$fieldValue : mixed

processPostValues()

Übernimmt die POST-Werte in die FormElemente.

protected processPostValues() : void

redirect()

protected redirect([string $listMessage = '' ][, string $listWarning = '' ][, array<string|int, mixed> $params = [] ]) : never
Parameters
$listMessage : string = ''
$listWarning : string = ''
$params : array<string|int, mixed> = []
Return values
never

save()

Saves the form.

protected abstract save() : bool|string|int
Return values
bool|string|int —

true on success, an error message or an error code otherwise

validate()

Validiert die Eingaben.

protected validate() : bool|string

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

Eingaben sind via $el = $this->getElement($fieldSetName, $fieldName); $val = $el->getValue(); erreichbar.

Return values
bool|string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results