Service

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).

No description

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'.

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.

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.

This should be used if some special formats need to be applied, e.g. numeric values and their decimals.

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.

Can the field be used with multiple values? Returning value is used as argument for FormChoice->setIsMultiple({$resultGoesHere}).

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?

Modifies the form field fdl for custom fields in order to display them properly.

It's important to know, that the field fdl AND the finished fdl are passed as reference parameters, which enables the method to modify both the current field fdl (is some information about the field may change) and the finished fdl (what will be added to the form after all - what might end in additional fields like those created by resource fields - _count - or by the timespan field - timespan_from, timespan_to, timespan_row.

No description

Before the faceted filters are updated, prepare the values to be storage friendly and useful.

Processes the information on saving the list item.

Sets the list item properties, which will be saved later.

Replaces the placeholders with the values of their fields.

When list items will be created or updated through the webservice API, this gets interesting as this determines whether a field has predefined values (like select-, and checkbox-fields, as these contain 'pop_data[]').

Upon calling this method on a certain field object, the data provided by a user is matched against the predefined values of that field. If they match, this method returns true, otherwise false.

Validates the resources and their bookings.