.. highlight:: php
.. index::
   pair: plugin; bsCorePlugin
.. _bsCorePlugin:

bsCorePlugin
*********************************************

Modules
=============================================

.. index::
   triple: module; bsCorePlugin; bsFilter

bsFilter module
---------------------------------------------

.. method:: bsFilterActions.executeFilterApply()

Is mapped to route `@filter_apply`. Processes filter values received from a form.

If the values as valid then the filter data stored in :ref:`filter_attribute_holder` are updated
and the action is redirected back to url specified in `redirect_to` request parameter.
If the route connected to this url is instance of bsStarRoute and `route_star_group_name` parameter is given
then the redirected url is updated to reflect current filter status.

If the values are not valid then the action connected to route corresponding to `redirect_to` request parameter is rendered.

.. method:: bsFilterComponents.executeShowFilterForm()

Displays filtering form. Required options are:

:param form_class: name of form class to render
:param filter_attribute_holder: name of filter attribute holder
:param redirect_to: url used for redirection when the filter is valid and updated

Optional options:

:param partial: name of partial used for form rendering. If empty then the default form rendering is used.
:param route_star_group_name: name of group in bsStarRoute. Parameters in this group will be updated in redirected url to reflect current filter status.