1. Fabrik 3.5.2 is now available to download. Read the blog for highlights about this release.

    As always, please back up your site prior to updating and if possible test in a dev environment first.

    Also, our 3.5.1 package file was hacked, the effected dates were 1/15/2017 - 1/17/2017. If during those days you downloaded the 3.5.1 package file from the JED or our site download page, please re-install the package with a fresh copy or upgrade to Fabrik 3.5.2. Github downloads were not effected.

Filtering lists/tables

Oct 19, 2016
Filtering lists/tables
  • Filters can be applied to a Fabrik table via the following means:
    • Querystrings
    • Pre-filters
    • Element filters
    • The table search all filter
    • Filter form
    Regardless of which method is used the filters are stored in the session (which means that their results are 'sticky' and will be applied each time the table is viewed


    Filtering via the URL (top)


    NOTE - when using complex query string filters, like specifying 'group_to_previous' or 'join', this will often not play well with existing element filters on the list. So when using complex URL filtering, you should remove any element filtering (typically by copying your list and removing any element filters from the copy) to avoid unpredictable conflicts. This is because we simply have no way of knowing how the boolean logic of your initial query string filters should interact with the element filters.

    The simplest way to filter is to append "&tablename___elmentname=value" to the URL.

    URL date filters accept times that can be converted using PHP's strtotime function (see http://php.net/strtotime)

    If you want to match upcoming records for the next 2 weeks you can do this:
    Code (Text):
    ?tablename___time_date[value][]=now&tablename___time_date[value][]=%2B2 week&tablename___time_date[condition]=BETWEEN
    Note the "%2B" in the second date value is the url encoded version of '+'

    If you want to match the records from last week you can do this:
    Code (Text):
    ?tablename___time_date[value][]=-1 week&tablename___time_date[value][]=now&tablename___time_date[condition]=BETWEEN
    If you want to filter on a series of values for the same element do this:
    Code (Text):
    ?&tablename___elementname[value][]=64&tablename___elementname[value][]=126&tablename___elementname[value][]=127&tablename___elementname[join]=OR
    If you want to filter on a value 'foo' in either element 'A' or 'B' then do this:
    Code (Text):
    ?tablename___A[value]=foo&tablename___A[join]=OR&tablename___B[value]=foo&tablename___B[join]=OR
    The available 'conditions' are:
    • BETWEEN
    • BEGINS WITH
    • CONTAINS
    • ENDS WITH
    • >
    • <
    • <>

    Grouping multiple sub queries(top)

    Say we want to create this where statement:
    Code (Text):

    WHERE (user_town = 'La Rochelle' OR user_town = 'Paris') AND (user_age = 20 OR user_age = 30)
     
    we would need to create a URL filter :
    Code (Text):

    http://site.com/mypage?
    user_town[value][]=La Rochlle
    &user_town[value][]=Paris
    &user_town[join]=AND
    &user_town[join]=OR
    &user_town[grouped_to_previous][]=0
    &user_town[grouped_to_previous][]=1
    &user_age[value][]=20
    &user_age[value][]=30
    &user_age[join]=AND
    &user_age[join]=OR
    &user_age[grouped_to_previous]=0
     

    Grouping sub queries - Another example(top)

    Say we want to create this where statement:
    Code (Text):

    WHERE (player_a_id = 100 OR player_b_id = 100 OR player_x_id = 100 OR player_y_id = 100) AND yr = 2016
     
    we would need to create a URL filter:
    Code (Text):

    http://site.com/mypage?index.php?option=com_fabrik&view=list&listid=36&&resetfilters=1&
    player_a_id[value][]=100&player_a_id[join][]=OR&
    player_b_id[value][]=100&fab_matches___player_b_id[join][]=OR&
    player_b_id[grouped_to_previous][]=1&player_x_id[value][]=100&player_x_id[join][]=OR&
    player_x_id[grouped_to_previous][]=1&player_y_id[value][]=100&player_y_id[join][]=OR&
    player_y_id[grouped_to_previous][]=1&yr[value][]=2016
     

    URL filtering Across All Fields (top)

    There are two variables you can use to filter data across all of the table's fields:

    Fabrik 2.x:
    • fabrik_table_filter_all - This defines the value to search for
    • search-mode-advanced - If your table has its 'advanced search mode' turned on, then Fabrik will use boolean full text matchingThis has the additional option to specify how to search the data:
      • all - search for all the words
      • any - search for any of the words
      • exact - search for the exact phrase
      • none - search for all records which don't contain the value
    e.g. to find all records which don't contain '666' then add this to your table's url:
    Code (Text):
    ?fabrik_table_filter_all=666&search-mode-advanced=none
    Fabrik 3.x:
    • fabrik_list_filter_all_X_com_fabrik_X (X is the list ID)
    e.g to find all records which contain 'abc' then add this to your list's url:
    Code (Text):
    &fabrik_list_filter_all_22_com_fabrik_22=abc

    Element Filters (top)

    For each element you have the option to add a filter to the List view, allowing your users to filter the table data. For information about the individual element filter settings see here.

    Clearing Element Filters (top)

    You can clear the filters by pressing the 'clear' button at the top of the List. This will remove all the users filters from their session, but will still apply the table's prefilters.

    In addition you can pass in variables via the querystring to clear and/or reset filters:
    • clearfilters=1 will clear the previous filters and not apply any other filters except prefilters (has the same behaviour as the 'clear' button)
    • resetfilters=1 will clear previous filters and apply any current querystring filters and prefilters
    • clearorder=1 will clear any ordering that has been applied to the table view.

    Ordering list data via the querystring (top)


    For ordering data via the querystring please see sorting list data
AlainR, rackem, sn00ze and 1 other person like this.