You are here

Home » API reference » Views Filter Harmonizer 1.0.x

README.txt in Views Filter Harmonizer 1.0.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
VIEWS FILTER HARMONIZER
=======================
This module solves an operational foible with the Views module regarding
filtering. It allows you to have a contextual filter (URL argument) apply only
when no regular (exposed) filter value has been submitted yet, i.e. on initial
page load.
Once the visitor changes the value for the exposed filter though, the module 
makes sure that the corresponding contextual filter does not interfere.

For intuitive visual feedback of the underlying process, the module will also
fill out the exposed filter form with the contextual filter value(s) used and
will adjust the URL accordingly when an exposed filter value is submitted.

Caveat: "Use AJAX" must be UNticked for the View display.

INSTALLATION & CONFIGURATION
----------------------------
Install and enable like any module. Use composer and/or drush if you wish.

When enabled visit admin/config/user-interface/filter_harmonizer to select the
Views you wish to harmonize.


MODULES WITH SPECIAL FILTERS
----------------------------
The Geofield module has non-standard contextual and regular filters. A special
plugin is enclosed with the Filter Harmonizer module to support Geofields.

Similarly, other modules with non-standard filters can be made to work with
Views Filter Harmonizer by implementing 3 hooks. 
The hookds are described in filter_harmonizer.api.php. 
See includes/filter_harmonizer_for_geofield.inc for a fully working example.


                                    * * *

File

README.txt
View source 
  1. 

  2. VIEWS FILTER HARMONIZER

  3. =======================

  4. This module solves an operational foible with the Views module regarding

  5. filtering. It allows you to have a contextual filter (URL argument) apply only

  6. when no regular (exposed) filter value has been submitted yet, i.e. on initial

  7. page load.

  8. Once the visitor changes the value for the exposed filter though, the module 

  9. makes sure that the corresponding contextual filter does not interfere.

  10. 

  11. For intuitive visual feedback of the underlying process, the module will also

  12. fill out the exposed filter form with the contextual filter value(s) used and

  13. will adjust the URL accordingly when an exposed filter value is submitted.

  14. 

  15. Caveat: "Use AJAX" must be UNticked for the View display.

  16. 

  17. INSTALLATION & CONFIGURATION

  18. ----------------------------

  19. Install and enable like any module. Use composer and/or drush if you wish.

  20. 

  21. When enabled visit admin/config/user-interface/filter_harmonizer to select the

  22. Views you wish to harmonize.

  23. 

  24. 

  25. MODULES WITH SPECIAL FILTERS

  26. ----------------------------

  27. The Geofield module has non-standard contextual and regular filters. A special

  28. plugin is enclosed with the Filter Harmonizer module to support Geofields.

  29. 

  30. Similarly, other modules with non-standard filters can be made to work with

  31. Views Filter Harmonizer by implementing 3 hooks. 

  32. The hookds are described in filter_harmonizer.api.php. 

  33. See includes/filter_harmonizer_for_geofield.inc for a fully working example.

  34. 

  35. 

  36.                                     * * *