FacetedFilter

UIComponent constructor.

No description

Adds $value to category with $categoryKey. Overwrites existing value.

Adds Choice category with manually defined items

Adds a choice category, with options based on a model property.

An OptionList can be provided as label list. Otherwise, the foreign property relation will be resolved to build an OptionList.

Adds date range filter.

If no callback is given, the default filterByDateRange() function will be used on the collection.

Callbacks have to use the default function signature of the Collections' filterByDateRange method: Closures have to use the signature: function(Collection $collection, ?DateTime $start, ?DateTime $end): Collection

Adds a MultipleChoice category with manually defined items

Adds a multiple choice category, with options based on a model property.

An OptionList can be provided as label list. Otherwise, the foreign property relation will be resolved to build an OptionList.

Adds search field filter.

If no callback is given, the default filterBySearchQuery() function will be used on the collection. Callbacks have to use the default function signature of the Collections' filterBySearchQuery method. Closures have to use the signature: function(Collection $collection, string $searchQuery): Collection

Adds toogle category. Either all items are displayed, or only items with given active item condition.

Link a container that will also be reloaded, if an ajax link has the current container as target.

Adds a custom css class to the root element of this component.

Add an UIAjaxComponent object and register it under a certain name.

this component will use that name to retrieve the object in order to interact with it.

If reloadOnUpdate is set, the dependent container will be reloaded after the update of the current container. !Beware: The reload url of the dependency container will be the one set in its data attribute and not a possible "new url" used to update the current container. If you want to reload multiple containers at once when the current container is an ajax link target, use $this->addLinkedContainer()

Adds a parameter to url parameter list.

Applies scopes of active facets to $collection. Scope of $excludeCategoryKey will not be applied.

If $collection is not passed, a clone of the previously set $this->collection will be used

Enables the periodical update via ajax.

The ajax calls will be execute after an interval of seconds passed by parameter one.

Get Variable / Option

Returns the active value(s) for the $categoryKey

No description

No description

getter

No description

Returns the current active filters based on the GPVars (e.g.: ['category' => ['1' => true], 'date' => ['start' => $start, 'end' => $end]])

Returns if there is an active filter

No description

getter

Place

Returns a dependent object in order to interact with it

Generates a unique dom id, dependent on the provided UID, as well as the current context.

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

put your comment there.

..

Returns true, if the category has been explicitly set to empty

No description

No description

No description

No description

No description

Process all parameters

Optional processing method.

This method is called when invoke the process method or automatically before the render method is called.

Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI

No description

Render XUI Object

restores original content of marker_content

Set Variable / Option

No description

Sets the main collection

Set true to load the content deferred. Displays a placeholder while loading the content. Optional you can pass a message which will replace the default loading message.

No description

Sets the maximum amount of facet elements.

Setting Placeholder Content will automatically enable deferred loading

Set Display to horizontal mode (aka "chips")

Set Display to classic mode (aka "sidebar")

Set Variable / Option for an array

No description

sets marker_content to passed data -> restore original content with reset_marker_content()

Set link to owning module

Sets options. This options will be used in the JS element of this XUI class.

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

No description

Sets the url parameter that is used for component loading.

No description