AdminPageFormSettingsApplicantSearch
extends AdminPageFormSettingsBase
in package
Table of Contents
- CUSTOM_LABELS = 'customlabels'
- DEFAULT_VALUES = 'defaultvalues'
- ENQUEUE_DATA_MERGE = 'merge'
- EXCLUDE_FIELD = 'exclude'
- FIELD_MODULE = 'fieldmodule'
- FIELD_MULTISELECT_EDIT_VALUES = 'field_multiselect_edit_values'
- FORM_RECORD_NAME = 'recordname'
- FORM_VIEW_FORM_SPECIFIC = 'viewformspecific'
- FORM_VIEW_GEOFIELDS = 'geofields'
- FORM_VIEW_LAYOUT_DESIGN = 'viewlayoutdesign'
- FORM_VIEW_PICTURE_TYPES = 'viewpicturetypes'
- FORM_VIEW_RECORDS_FILTER = 'viewrecordsfilter'
- FORM_VIEW_RECORDS_SORTING = 'viewrecordssorting'
- FORM_VIEW_SORTABLE_FIELDS_CONFIG = 'viewSortableFieldsConfig'
- GET_PARAM_TYPE = 'type'
- GET_PARAM_VIEWID = 'id'
- GET param for the view ID
- MODULE_LABELS = 'modulelabels'
- POST_RECORD_ID = 'record_id'
- caution: also needs to be set in Javascript
- VIEW_SAVE_FAIL_MESSAGE = 'view_save_fail_message'
- VIEW_SAVE_SUCCESSFUL_MESSAGE = 'view_save_success_message'
- $_formModels : array<string|int, FormModel>
- $_listViewId : int
- $_pageSlug : string
- $_pageTitle : string
- $_pContainer : Container
- $_pFormModelBuilder : FormModelBuilderDBForm
- $_showAddressFields : bool
- $_showEstateFields : bool
- $_showMessageInput : bool
- $_showSearchCriteriaFields : bool
- $_sortableFieldModules : array<string|int, mixed>
- $_type : string
- __construct() : mixed
- addAdminNoticeWrapper() : mixed
- rest will be added via js
- ajax_action() : mixed
- checkForms() : mixed
- doExtraEnqueues() : mixed
- place extra wp_enqueue_script() and wp_enqueue_style() only for this page
- generatePageMainTitle() : mixed
- getCurrentFormModules() : array<string|int, mixed>
- getEnqueueData() : array<string|int, mixed>
- getFormModelByGroupSlug() : FormModel
- getFormModels() : array<string|int, FormModel>
- getListViewId() : string
- getPageSlug() : string
- getShowMessageInput() : bool
- getType() : string
- handleAdminNotices() : mixed
- preOutput() : mixed
- render() : mixed
- renderContent() : mixed
- renders the page, but using `echo`
- save_form() : mixed
- Entry point for AJAX.
- setShowAddressFields() : mixed
- setShowEstateFields() : mixed
- setShowMessageInput() : mixed
- setShowSearchCriteriaFields() : mixed
- setType() : mixed
- transformPostValues() : array<string|int, mixed>
- addFieldConfigurationForMainModules() : mixed
- Call this in method `buildForms` of overriding class
- addFieldsConfiguration() : mixed
- addFormModel() : mixed
- addOrderValues() : array<string|int, mixed>
- addSortableFieldModule() : mixed
- addSortableFieldsList() : mixed
- buildForms() : mixed
- Call this first in overriding class
- checkFixedValues() : bool
- Check values here, throw \Exception if anything is wrong
- cleanPreviousBoxes() : mixed
- createMetaBoxByForm() : mixed
- generateAccordionBoxes() : mixed
- generateGroupSlugByModuleCategory() : string
- generateMetaBoxes() : mixed
- getContainer() : Container
- getFormModelBuilder() : FormModelBuilder
- getPageTitle() : string
- getResponseMessagekey() : string
- getSortableFieldModules() : array<string|int, mixed>
- prepareRelationValues() : array<string|int, mixed>
- prepareValues() : mixed
- Since checkbox are only being submitted if checked they need to be reorganized
- readFieldnamesByContent() : array<string|int, mixed>
- sanitizeShortcodeName() : string
- following characters are compatible across all platforms: Upper-case and lower-case letters: A-Z a-z (+ Umlaut) Digits: 0-9 Underscore: _
- setFixedValues() : array<string|int, mixed>
- setPageTitle() : mixed
- setRecordsPerPage() : array<string|int, mixed>
- updateValues() : mixed
- validate() : mixed
- addFieldConfigurationByModule() : mixed
- buildFieldsCollectionForCurrentForm() : FieldsCollection
- getFieldList() : array<string|int, mixed>
- getInstalledLanguages() : array<string|int, mixed>
- readCustomLabels() : array<string|int, mixed>
- readDefaultValues() : array<string|int, mixed>
- saveCustomLabels() : mixed
- saveDefaultValues() : mixed
Constants
CUSTOM_LABELS
public
mixed
CUSTOM_LABELS
= 'customlabels'
DEFAULT_VALUES
public
mixed
DEFAULT_VALUES
= 'defaultvalues'
ENQUEUE_DATA_MERGE
public
mixed
ENQUEUE_DATA_MERGE
= 'merge'
EXCLUDE_FIELD
public
mixed
EXCLUDE_FIELD
= 'exclude'
FIELD_MODULE
public
mixed
FIELD_MODULE
= 'fieldmodule'
FIELD_MULTISELECT_EDIT_VALUES
public
mixed
FIELD_MULTISELECT_EDIT_VALUES
= 'field_multiselect_edit_values'
FORM_RECORD_NAME
public
mixed
FORM_RECORD_NAME
= 'recordname'
FORM_VIEW_FORM_SPECIFIC
public
mixed
FORM_VIEW_FORM_SPECIFIC
= 'viewformspecific'
FORM_VIEW_GEOFIELDS
public
mixed
FORM_VIEW_GEOFIELDS
= 'geofields'
FORM_VIEW_LAYOUT_DESIGN
public
mixed
FORM_VIEW_LAYOUT_DESIGN
= 'viewlayoutdesign'
FORM_VIEW_PICTURE_TYPES
public
mixed
FORM_VIEW_PICTURE_TYPES
= 'viewpicturetypes'
FORM_VIEW_RECORDS_FILTER
public
mixed
FORM_VIEW_RECORDS_FILTER
= 'viewrecordsfilter'
FORM_VIEW_RECORDS_SORTING
public
mixed
FORM_VIEW_RECORDS_SORTING
= 'viewrecordssorting'
FORM_VIEW_SORTABLE_FIELDS_CONFIG
public
mixed
FORM_VIEW_SORTABLE_FIELDS_CONFIG
= 'viewSortableFieldsConfig'
GET_PARAM_TYPE
public
mixed
GET_PARAM_TYPE
= 'type'
GET_PARAM_VIEWID
GET param for the view ID
public
mixed
GET_PARAM_VIEWID
= 'id'
MODULE_LABELS
public
mixed
MODULE_LABELS
= 'modulelabels'
POST_RECORD_ID
caution: also needs to be set in Javascript
public
mixed
POST_RECORD_ID
= 'record_id'
VIEW_SAVE_FAIL_MESSAGE
public
mixed
VIEW_SAVE_FAIL_MESSAGE
= 'view_save_fail_message'
VIEW_SAVE_SUCCESSFUL_MESSAGE
public
mixed
VIEW_SAVE_SUCCESSFUL_MESSAGE
= 'view_save_success_message'
Properties
$_formModels
private
array<string|int, FormModel>
$_formModels
= array()
$_listViewId
private
int
$_listViewId
= null
$_pageSlug
private
string
$_pageSlug
= null
$_pageTitle
private
string
$_pageTitle
= null
$_pContainer
private
Container
$_pContainer
$_pFormModelBuilder
private
FormModelBuilderDBForm
$_pFormModelBuilder
= null
$_showAddressFields
private
bool
$_showAddressFields
= false
$_showEstateFields
private
bool
$_showEstateFields
= false
$_showMessageInput
private
bool
$_showMessageInput
= false
message field has no module
$_showSearchCriteriaFields
private
bool
$_showSearchCriteriaFields
= false
$_sortableFieldModules
private
array<string|int, mixed>
$_sortableFieldModules
= []
$_type
private
string
$_type
= null
Methods
__construct()
public
__construct(string $pageSlug) : mixed
Parameters
- $pageSlug : string
Tags
Return values
mixed —addAdminNoticeWrapper()
rest will be added via js
public
addAdminNoticeWrapper() : mixed
Return values
mixed —ajax_action()
public
ajax_action() : mixed
Return values
mixed —checkForms()
public
checkForms() : mixed
Return values
mixed —doExtraEnqueues()
place extra wp_enqueue_script() and wp_enqueue_style() only for this page
public
doExtraEnqueues() : mixed
Return values
mixed —generatePageMainTitle()
public
generatePageMainTitle(string $subTitle) : mixed
Parameters
- $subTitle : string
Return values
mixed —getCurrentFormModules()
public
getCurrentFormModules() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEnqueueData()
public
getEnqueueData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFormModelByGroupSlug()
public
getFormModelByGroupSlug(string $groupSlug) : FormModel
Parameters
- $groupSlug : string
Return values
FormModel —getFormModels()
public
getFormModels() : array<string|int, FormModel>
Return values
array<string|int, FormModel> —getListViewId()
public
getListViewId() : string
Return values
string —getPageSlug()
public
getPageSlug() : string
Return values
string —getShowMessageInput()
public
getShowMessageInput() : bool
Return values
bool —getType()
public
getType() : string
Return values
string —handleAdminNotices()
public
handleAdminNotices() : mixed
Return values
mixed —preOutput()
public
preOutput() : mixed
Return values
mixed —render()
public
render() : mixed
Return values
mixed —renderContent()
renders the page, but using `echo`
public
abstract renderContent() : mixed
Return values
mixed —save_form()
Entry point for AJAX.
public
abstract save_form() : mixed
Method should end with wp_die().
Tags
Return values
mixed —setShowAddressFields()
public
setShowAddressFields(bool $showAddressFields) : mixed
Parameters
- $showAddressFields : bool
Return values
mixed —setShowEstateFields()
public
setShowEstateFields(bool $showEstateFields) : mixed
Parameters
- $showEstateFields : bool
Return values
mixed —setShowMessageInput()
public
setShowMessageInput(bool $showMessageInput) : mixed
Parameters
- $showMessageInput : bool
Return values
mixed —setShowSearchCriteriaFields()
public
setShowSearchCriteriaFields(bool $showSearchCriteriaFields) : mixed
Parameters
- $showSearchCriteriaFields : bool
Return values
mixed —setType()
public
setType(string $type) : mixed
Parameters
- $type : string
Return values
mixed —transformPostValues()
public
transformPostValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —addFieldConfigurationForMainModules()
Call this in method `buildForms` of overriding class
protected
addFieldConfigurationForMainModules(FormModelBuilder $pFormModelBuilder) : mixed
Don't forget to call
$this->addSortableFieldsList($this->getSortableFieldModules(), $pFormModelBuilder,
InputModelBase::HTML_TYPE_COMPLEX_SORTABLE_DETAIL_LIST_FORM);
afterwards.
Parameters
- $pFormModelBuilder : FormModelBuilder
Tags
Return values
mixed —addFieldsConfiguration()
protected
addFieldsConfiguration(string|null $module, FormModelBuilder $pFormModelBuilder, array<string|int, mixed> $fieldNames[, bool $addModule = false ]) : mixed
Parameters
- $module : string|null
- $pFormModelBuilder : FormModelBuilder
- $fieldNames : array<string|int, mixed>
- $addModule : bool = false
Return values
mixed —addFormModel()
protected
addFormModel(FormModel $pFormModel) : mixed
Parameters
- $pFormModel : FormModel
Return values
mixed —addOrderValues()
protected
addOrderValues(array<string|int, mixed> $row, string $table) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>
- $table : string
Return values
array<string|int, mixed> —addSortableFieldModule()
protected
addSortableFieldModule(string $module) : mixed
Parameters
- $module : string
Return values
mixed —addSortableFieldsList()
protected
addSortableFieldsList(array<string|int, mixed> $modules, FormModelBuilder $pFormModelBuilder[, string $htmlType = InputModelBase::HTML_TYPE_COMPLEX_SORTABLE_DETAIL_LIST ]) : mixed
Parameters
- $modules : array<string|int, mixed>
- $pFormModelBuilder : FormModelBuilder
- $htmlType : string = InputModelBase::HTML_TYPE_COMPLEX_SORTABLE_DETAIL_LIST
Return values
mixed —buildForms()
Call this first in overriding class
protected
buildForms() : mixed
Return values
mixed —checkFixedValues()
Check values here, throw \Exception if anything is wrong
protected
checkFixedValues(array<string|int, mixed> $row) : bool
Parameters
- $row : array<string|int, mixed>
Return values
bool —cleanPreviousBoxes()
protected
final cleanPreviousBoxes() : mixed
Tags
Return values
mixed —createMetaBoxByForm()
protected
createMetaBoxByForm(FormModel $pFormModel[, string $position = 'left' ]) : mixed
Parameters
- $pFormModel : FormModel
- $position : string = 'left'
Return values
mixed —generateAccordionBoxes()
protected
generateAccordionBoxes() : mixed
Return values
mixed —generateGroupSlugByModuleCategory()
protected
generateGroupSlugByModuleCategory(string $module, string $category) : string
Parameters
- $module : string
- $category : string
Return values
string —generateMetaBoxes()
protected
generateMetaBoxes() : mixed
Return values
mixed —getContainer()
protected
getContainer() : Container
Return values
Container —getFormModelBuilder()
protected
getFormModelBuilder() : FormModelBuilder
Return values
FormModelBuilder —getPageTitle()
protected
getPageTitle() : string
Return values
string —getResponseMessagekey()
protected
getResponseMessagekey(bool $result) : string
Parameters
- $result : bool
Return values
string —getSortableFieldModules()
protected
getSortableFieldModules() : array<string|int, mixed>
Return values
array<string|int, mixed> —prepareRelationValues()
protected
prepareRelationValues(string $table, string $column, array<string|int, mixed> $values, int $recordId) : array<string|int, mixed>
Parameters
- $table : string
- $column : string
- $values : array<string|int, mixed>
- $recordId : int
Return values
array<string|int, mixed> —prepareValues()
Since checkbox are only being submitted if checked they need to be reorganized
protected
prepareValues(stdClass $pValues) : mixed
Parameters
- $pValues : stdClass
Return values
mixed —readFieldnamesByContent()
protected
readFieldnamesByContent(string $module[, FieldModuleCollection $pFieldsCollection = null ]) : array<string|int, mixed>
Parameters
- $module : string
- $pFieldsCollection : FieldModuleCollection = null
Tags
Return values
array<string|int, mixed> —sanitizeShortcodeName()
following characters are compatible across all platforms: Upper-case and lower-case letters: A-Z a-z (+ Umlaut) Digits: 0-9 Underscore: _
protected
sanitizeShortcodeName(string $name) : string
Parameters
- $name : string
Return values
string —setFixedValues()
protected
setFixedValues(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>
Return values
array<string|int, mixed> —setPageTitle()
protected
setPageTitle(string $pageTitle) : mixed
Parameters
- $pageTitle : string
Return values
mixed —setRecordsPerPage()
protected
setRecordsPerPage(array<string|int, mixed> $row, string $mainTableName) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>
- $mainTableName : string
Return values
array<string|int, mixed> —updateValues()
protected
abstract updateValues(array<string|int, mixed> $row, stdClass $pResult[, int $recordId = null ]) : mixed
Parameters
- $row : array<string|int, mixed>
- $pResult : stdClass
-
having the properties
resultandrecord_id - $recordId : int = null
Return values
mixed —validate()
protected
abstract validate([mixed $recordId = null ]) : mixed
Parameters
- $recordId : mixed = null
Tags
Return values
mixed —addFieldConfigurationByModule()
private
addFieldConfigurationByModule(FormModelBuilder $pFormModelBuilder, FieldsCollection $pFieldsCollection, string $module) : mixed
Parameters
- $pFormModelBuilder : FormModelBuilder
- $pFieldsCollection : FieldsCollection
- $module : string
Return values
mixed —buildFieldsCollectionForCurrentForm()
private
buildFieldsCollectionForCurrentForm() : FieldsCollection
Tags
Return values
FieldsCollection —getFieldList()
private
getFieldList() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getInstalledLanguages()
private
getInstalledLanguages() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —readCustomLabels()
private
readCustomLabels() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —readDefaultValues()
private
readDefaultValues() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —saveCustomLabels()
private
saveCustomLabels(int $recordId, array<string|int, mixed> $row) : mixed
Parameters
- $recordId : int
- $row : array<string|int, mixed>
Tags
Return values
mixed —saveDefaultValues()
private
saveDefaultValues(int $recordId, array<string|int, mixed> $row) : mixed
Parameters
- $recordId : int
- $row : array<string|int, mixed>