Form
in package
Table of Contents
- TYPE_APPLICANT_SEARCH = 'applicantsearch'
- applicant-search form
- TYPE_CONTACT = 'contact'
- contact form
- TYPE_INTEREST = 'interest'
- applicant form (with search criteria)
- TYPE_OWNER = 'owner'
- owner form
- $_countAbsoluteResults : int
- $_formNo : int
- $_genericSettings : array<string|int, mixed>
- $_pContainer : Container
- $_pFieldsCollection : FieldsCollection
- $_pFormData : FormData
- __construct() : mixed
- getCountAbsolutResults() : int
- getEstateContextLabel() : string
- getFieldLabel() : string
- getFieldType() : string
- getFieldValue() : string
- getFormId() : string
- getFormNo() : int
- getFormStatus() : string
- getGenericSetting() : string
- getInputFields() : array<string|int, mixed>
- getPermittedValues() : array<string|int, mixed>
- getRequiredFields() : array<string|int, mixed>
- getResponseFieldsValues() : array<string|int, mixed>
- getSearchcriteriaRangeInfos() : array<string|int, mixed>
- getSearchcriteriaRangeInfosForField() : array<string|int, mixed>
- getUmkreisFields() : array<string|int, mixed>
- inRangeSearchcriteriaInfos() : bool
- isMissingField() : bool
- isRequiredField() : bool
- isSearchcriteriaField() : bool
- needsReCaptcha() : bool
- setGenericSetting() : mixed
- buildContainer() : Container
- buildFieldsCollectionForForm() : FieldsCollection
- escapePermittedValues() : array<string|int, mixed>
- executeGeoPositionFix() : array<string|int, mixed>
- filterActiveInputFields() : array<string|int, mixed>
- getDataFormConfiguration() : DataFormConfiguration
- getDefaultValues() : array<string|int, mixed>
- getFormSpecificFields() : array<string|int, mixed>
- getModuleOfField() : string
- setCountAbsoluteResults() : mixed
Constants
TYPE_APPLICANT_SEARCH
applicant-search form
public
mixed
TYPE_APPLICANT_SEARCH
= 'applicantsearch'
TYPE_CONTACT
contact form
public
mixed
TYPE_CONTACT
= 'contact'
TYPE_INTEREST
applicant form (with search criteria)
public
mixed
TYPE_INTEREST
= 'interest'
TYPE_OWNER
owner form
public
mixed
TYPE_OWNER
= 'owner'
Properties
$_countAbsoluteResults
private
int
$_countAbsoluteResults
= 0
$_formNo
private
int
$_formNo
= null
$_genericSettings
private
array<string|int, mixed>
$_genericSettings
= []
$_pContainer
private
Container
$_pContainer
$_pFieldsCollection
private
FieldsCollection
$_pFieldsCollection
$_pFormData
private
FormData
$_pFormData
Methods
__construct()
public
__construct(string $formName, string $type[, Container|null $pContainer = null ]) : mixed
Parameters
- $formName : string
- $type : string
- $pContainer : Container|null = null
-
Manual instance creation possible
Tags
Return values
mixed —getCountAbsolutResults()
public
getCountAbsolutResults() : int
Return values
int —getEstateContextLabel()
public
getEstateContextLabel() : string
Return values
string —getFieldLabel()
public
getFieldLabel(string $field[, bool $raw = false ]) : string
Parameters
- $field : string
- $raw : bool = false
Return values
string —getFieldType()
public
getFieldType(string $field) : string
Parameters
- $field : string
Return values
string —getFieldValue()
public
getFieldValue(string $field[, bool $raw = false ]) : string
Parameters
- $field : string
- $raw : bool = false
Return values
string —getFormId()
public
getFormId() : string
Return values
string —getFormNo()
public
getFormNo() : int
Return values
int —getFormStatus()
public
getFormStatus() : string
Return values
string —getGenericSetting()
public
getGenericSetting(string $settingName) : string
Parameters
- $settingName : string
Return values
string —getInputFields()
public
getInputFields() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getPermittedValues()
public
getPermittedValues(string $field[, bool $raw = false ]) : array<string|int, mixed>
Parameters
- $field : string
- $raw : bool = false
Tags
Return values
array<string|int, mixed> —getRequiredFields()
public
getRequiredFields() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getResponseFieldsValues()
public
getResponseFieldsValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSearchcriteriaRangeInfos()
public
getSearchcriteriaRangeInfos() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSearchcriteriaRangeInfosForField()
public
getSearchcriteriaRangeInfosForField(string $field) : array<string|int, mixed>
Parameters
- $field : string
Return values
array<string|int, mixed> —getUmkreisFields()
public
getUmkreisFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —inRangeSearchcriteriaInfos()
public
inRangeSearchcriteriaInfos(string $field) : bool
Parameters
- $field : string
Return values
bool —isMissingField()
public
isMissingField(string $field) : bool
Parameters
- $field : string
Return values
bool —isRequiredField()
public
isRequiredField(string $field) : bool
Parameters
- $field : string
Tags
Return values
bool —isSearchcriteriaField()
public
isSearchcriteriaField(string $field) : bool
Parameters
- $field : string
Return values
bool —needsReCaptcha()
public
needsReCaptcha() : bool
Return values
bool —setGenericSetting()
public
setGenericSetting(string $settingName, string $value) : mixed
Parameters
- $settingName : string
- $value : string
Return values
mixed —buildContainer()
private
buildContainer() : Container
Tags
Return values
Container —buildFieldsCollectionForForm()
private
buildFieldsCollectionForForm(FieldsCollection $pFieldsCollection, string $type, DataFormConfiguration $pConfiguration) : FieldsCollection
Parameters
- $pFieldsCollection : FieldsCollection
- $type : string
- $pConfiguration : DataFormConfiguration
Tags
Return values
FieldsCollection —escapePermittedValues()
private
escapePermittedValues(array<string|int, mixed> $keyValues) : array<string|int, mixed>
Parameters
- $keyValues : array<string|int, mixed>
Return values
array<string|int, mixed> —executeGeoPositionFix()
private
executeGeoPositionFix(array<string|int, mixed> $requiredFields) : array<string|int, mixed>
Parameters
- $requiredFields : array<string|int, mixed>
Return values
array<string|int, mixed> —filterActiveInputFields()
private
filterActiveInputFields( $inputs) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —getDataFormConfiguration()
private
getDataFormConfiguration() : DataFormConfiguration
Return values
DataFormConfiguration —getDefaultValues()
private
getDefaultValues() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getFormSpecificFields()
private
getFormSpecificFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —getModuleOfField()
private
getModuleOfField(string $field) : string
Parameters
- $field : string
Tags
Return values
string —setCountAbsoluteResults()
private
setCountAbsoluteResults(int $countAbsolute) : mixed
Parameters
- $countAbsolute : int