FormPost
in package
Terminology used in this class:
- prefix: the prefix of the input form. Must be the name of a form
- form No.: Every input's name consists of the prefix + form no to make multiple forms on one page possible. The Form No must be incremented at every new form output.
Table of Contents
- MESSAGE_ERROR = 'error'
- MESSAGE_RECAPTCHA_SPAM = 'recaptchaSpam'
- MESSAGE_REQUIRED_FIELDS_MISSING = 'fieldmissing'
- MESSAGE_SUCCESS = 'success'
- $_absolutCountResults : int
- $_formDataInstances : array<string|int, mixed>
- $_formNo : int
- $_pCompoundFields : CompoundFieldsFilter
- $_pFieldsCollection : FieldsCollection
- $_pFieldsCollectionConfiguratorForm : FieldsCollectionConfiguratorForm
- $_pFormPostConfiguration : FormPostConfiguration
- $_pSearchcriteriaFields : SearchcriteriaFields
- __construct() : mixed
- getAbsolutCountResults() : int
- getFormDataInstance() : FormData
- getFormNo() : int
- incrementFormNo() : mixed
- initialCheck() : void
- setFormDataInstances() : mixed
- analyseFormContentByPrefix() : mixed
- expandFieldsCollection() : array<string|int, mixed>
- getAllowedPostVars() : array<string|int, string>
- getFieldsCollection() : FieldsCollection
- setAbsolutCountResults() : mixed
- setFieldsCollection() : mixed
- buildFormData() : FormData
- checkCaptcha() : bool
Constants
MESSAGE_ERROR
public
mixed
MESSAGE_ERROR
= 'error'
MESSAGE_RECAPTCHA_SPAM
public
mixed
MESSAGE_RECAPTCHA_SPAM
= 'recaptchaSpam'
MESSAGE_REQUIRED_FIELDS_MISSING
public
mixed
MESSAGE_REQUIRED_FIELDS_MISSING
= 'fieldmissing'
MESSAGE_SUCCESS
public
mixed
MESSAGE_SUCCESS
= 'success'
Properties
$_absolutCountResults
private
int
$_absolutCountResults
= 0
$_formDataInstances
private
array<string|int, mixed>
$_formDataInstances
= []
$_formNo
private
static int
$_formNo
= 0
$_pCompoundFields
private
CompoundFieldsFilter
$_pCompoundFields
= null
$_pFieldsCollection
private
FieldsCollection
$_pFieldsCollection
= null
$_pFieldsCollectionConfiguratorForm
private
FieldsCollectionConfiguratorForm
$_pFieldsCollectionConfiguratorForm
$_pFormPostConfiguration
private
FormPostConfiguration
$_pFormPostConfiguration
= null
$_pSearchcriteriaFields
private
SearchcriteriaFields
$_pSearchcriteriaFields
= null
Methods
__construct()
public
__construct(FormPostConfiguration $pFormPostConfiguration, SearchcriteriaFields $pSearchcriteriaFields, FieldsCollectionConfiguratorForm $pFieldsCollectionConfiguratorForm) : mixed
Parameters
- $pFormPostConfiguration : FormPostConfiguration
- $pSearchcriteriaFields : SearchcriteriaFields
- $pFieldsCollectionConfiguratorForm : FieldsCollectionConfiguratorForm
Return values
mixed —getAbsolutCountResults()
public
getAbsolutCountResults() : int
Return values
int —getFormDataInstance()
public
getFormDataInstance(string $prefix, int $formNo) : FormData
Parameters
- $prefix : string
- $formNo : int
Tags
Return values
FormData —getFormNo()
public
getFormNo() : int
Return values
int —incrementFormNo()
public
static incrementFormNo() : mixed
Return values
mixed —initialCheck()
public
initialCheck(DataFormConfiguration $pConfig, int $formNo) : void
Parameters
- $pConfig : DataFormConfiguration
- $formNo : int
Tags
Return values
void —setFormDataInstances()
public
setFormDataInstances(FormData $pFormData) : mixed
Parameters
- $pFormData : FormData
Return values
mixed —analyseFormContentByPrefix()
protected
abstract analyseFormContentByPrefix(FormData $pFormData) : mixed
Parameters
- $pFormData : FormData
Return values
mixed —expandFieldsCollection()
protected
expandFieldsCollection() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAllowedPostVars()
protected
getAllowedPostVars(DataFormConfiguration $pFormConfig) : array<string|int, string>
Parameters
- $pFormConfig : DataFormConfiguration
Return values
array<string|int, string> —getFieldsCollection()
protected
getFieldsCollection() : FieldsCollection
Return values
FieldsCollection —setAbsolutCountResults()
protected
setAbsolutCountResults(int $absolutCountResults) : mixed
Parameters
- $absolutCountResults : int
Return values
mixed —setFieldsCollection()
protected
setFieldsCollection(DataFormConfiguration $pFormConfig) : mixed
Parameters
- $pFormConfig : DataFormConfiguration
Tags
Return values
mixed —buildFormData()
private
buildFormData(DataFormConfiguration $pFormConfig, int $formNo) : FormData
Parameters
- $pFormConfig : DataFormConfiguration
- $formNo : int
Tags
Return values
FormData —checkCaptcha()
private
checkCaptcha(DataFormConfiguration $pConfig) : bool
Parameters
- $pConfig : DataFormConfiguration