Slider
class Slider extends Field
Constants
| TYPE |
|
| MAX_FILTERS |
|
Methods
Serves an OptionList with selectable values from this field. If null is returned, this field is not supposed to act as a filter (Textarea for example doesn't make a good filter - self explanatory).
Adds a field to the faceted search by its specifications.
Adds the properties of the current field to the form editor passed to this method.
Adds field specific properties to the table, like callbacks, replaces and/or column formats.
Every field, that makes use of this method, will implement the field property 'is_unique', setting the field unique.
Fills the placeholders needed for workflows.
Formats the values before they will be inserted into the table at the ItemList component.
Helper method for pre-fetching the faceted filter items count, which ends up being more performant than letting the faceted filters calculate each item count in its own.
Gets a field from the faceted search.
Returns the label needed for the HTML generated email.
Returns the value needed for the HTML generated mail.
No description
No description
Modifies the list field fdl for custom fields.
Before the faceted filters are updated, prepare the values to be storage friendly and useful.
Processes the information on saving the list item.
Replaces the placeholders with the values of their fields.
No description
Validates the resources and their bookings.
Details
in
Field at line 372
OptionList|null
addDefaultFilterValue(ListsController $mod, ListProperties $list, array $fieldFdl)
Serves an OptionList with selectable values from this field. If null is returned, this field is not supposed to act as a filter (Textarea for example doesn't make a good filter - self explanatory).
in
Field at line 190
void
addFieldToFaceted(ListItemCollection $listItemCollection, FacetedFilter $faceted, string $fieldId, array $fieldFdl, ListProperties $list, string $facetedFieldId, string $viewMode, bool $isDefaultFilterField = false, string|null $defaultFilterValue = null)
Adds a field to the faceted search by its specifications.
in
Field at line 38
void
addFormEditorProperties(FormEditor $feditor, ListsController $mod, array $disabledFieldProperties)
Adds the properties of the current field to the form editor passed to this method.
Fills the array $disabledFieldProperties, passed as reference, with the values that are necessary for the field configuration. This array will be used later to disable the field properties by setting them 'hidden'.
in
Field at line 57
bool
addTableFieldProperties(string $fieldId, array $fieldFdl, Table $table, array $columnFormat, array $sortableFields, array $groupFields)
Adds field specific properties to the table, like callbacks, replaces and/or column formats.
By using this method, be aware that 3 (three) parameters are used as reference in order to modify multiple values at once. Usually, a table callback would be enough to get this working. However, setting a column format is allowed too, as well as setting sortable fields and group fields (if grouping is enabled by the fields). Although this uses reference parameters, the return type is boolean, since the value is used to make sure that this field really is displayed. Whenever this method returns FALSE, the field will be skipped and doesn't appear in the table.
in
Field at line 318
protected void
addUniqueProperty(FormEditor $formEditor, ListsController $mod)
Every field, that makes use of this method, will implement the field property 'is_unique', setting the field unique.
in
Field at line 109
void
addWorkflowPlaceholders(ListsController $mod, array $fieldFdl, ListItem|null $listItem, array $placeholders, bool $descriptive)
Fills the placeholders needed for workflows.
in
Field at line 360
void
formatValueForDisplay(array $fieldFdl, $fieldValue)
Formats the values before they will be inserted into the table at the ItemList component.
This should be used if some special formats need to be applied, e.g. numeric values and their decimals.
in
Field at line 241
protected array
getAnswersWithCounts(ListItemCollection $listItemCollection, string $facetedFieldId, array $conditions)
Helper method for pre-fetching the faceted filter items count, which ends up being more performant than letting the faceted filters calculate each item count in its own.
in
Field at line 286
void
getFacetedField(string $fieldId, array $facetedFields, int $counter, bool $ignoreLimit, bool $returnStatus)
Gets a field from the faceted search.
in
Field at line 144
string
getHTMLLabel(array $fdl, string $fieldId)
Returns the label needed for the HTML generated email.
in
Field at line 157
string|null
getHTMLValue(array $fdl, string $key, $data)
Returns the value needed for the HTML generated mail.
at line 38
bool
isMultipleDefaultFilter()
No description
in
Field at line 172
bool
isSelectable()
Adds the check for this field whether it is selectable or not.
This is important for fields available for calendar hooks. todo - check what is "selectable" why is a field not selectable?
at line 15
void
modifyFormFieldFdl(ListProperties $list, array $fieldFdl, string $showOnly, array $finishedFdl = [], bool $overwritable = false)
No description
in
Field at line 86
void
modifyListFieldFdl(ListItem $listItem, array $fieldFdl, bool $readonly, bool $setSavedValues)
Modifies the list field fdl for custom fields.
in
Field at line 335
null|mixed
prepareFilterValue(array $fieldFdl)
Before the faceted filters are updated, prepare the values to be storage friendly and useful.
in
Field at line 97
void
processSavingInformation(ListItem $listItem, array $formData, array $fieldFdl)
Processes the information on saving the list item.
Sets the list item properties, which will be saved later.
in
Field at line 132
mixed
replacePlaceholdersWithValues(array $placeholders, array $fieldFdl)
Replaces the placeholders with the values of their fields.
at line 30
bool
requiredValueFits(array $fieldFdl, string $fieldValue)
No description
in
Field at line 308
bool
validateResource(ListsController $mod, array $fieldFdl, bool $roomRequested, bool $ticketRequested, array $fieldErrors, bool $result)
Validates the resources and their bookings.