You are here

Home » API reference » Views Argument Substitutions 7

README.txt in Views Argument Substitutions 7 

CONTENTS OF THIS FILE
---------------------

  * Introduction
  * Examples
  * Installation
  * Known Issues/Shortcomings
  * Maintainers


INTRODUCTION
------------
Contextual Filters allow a View to be filtered based on arguments passed via URL
or other embedded method (e.g. the View Reference module), but contextual
filters are inflexible compared with normal filters (which allow for "contains,"
"begins with," "ends with," etc.).

This module allows contextual filter arguments to be used as replacement tokens
in filters and table arguments, so that passed-in arguments (such as from URLs
or View Reference fields) can be used as values in normal View filters.


EXAMPLES
--------
To search for a node by title containing some keywords:
  1. Create a new node-based ("Content") View: Go to admin/structure/views/add
     and under "Show", choose "Content".
  2. Add a "Global: Null" Contextual Filter (this step is required to allow the
     view to receive at least 1 argument).
  3. Add a "Content: Title" Filter: Under "Filter Criteria," click "Add."
     Choose "Content: Title," set the "Operator" to "Contains", and set the
     "Value" to "***!1***" (without the quotes). Click "Apply."
  4. Done! Any value passed as the first Contextual Filter argument will be used
     as the value for the Content: Title filter.

To search for nodes containing the same title as a specified node:
  1. Start by completing the example "to search for a node by title containing
     some keywords," as given above.
  2. Edit the "Global: Null" Contextual Filter: Enable "Specify validation
     criteria," and set "Validator" to "Content."
  3. Edit the "Content: Title (contains ***!1***)" filter: Change the "Value"
     from "***!1***" to "***%1***".
  4. Done!  If you pass in a valid NID as the first Contextual Filter argument,
     its title will be used as the search value for the Content: Title filter.

INSTALLATION
------------
Activate the module, then administer a desired View.  Add as many Contextual
Filters as you need filter values (using "Global: Null", if appropriate), then
insert corresponding tokens ("***!1***" for the first value, "***!2***" for the
second, etc.) as filter values.  Additionally, "***%1***" may be used to insert
the title for the first argument (for example, if the argument is a node), and
so on.


KNOWN ISSUES/SHORTCOMINGS
-------------------------
None, so far.


MAINTAINERS
-----------
- jay.dansand (Jay Dansand)

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.   * Introduction

  5.   * Examples

  6.   * Installation

  7.   * Known Issues/Shortcomings

  8.   * Maintainers

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. Contextual Filters allow a View to be filtered based on arguments passed via URL

  14. or other embedded method (e.g. the View Reference module), but contextual

  15. filters are inflexible compared with normal filters (which allow for "contains,"

  16. "begins with," "ends with," etc.).

  17. 

  18. This module allows contextual filter arguments to be used as replacement tokens

  19. in filters and table arguments, so that passed-in arguments (such as from URLs

  20. or View Reference fields) can be used as values in normal View filters.

  21. 

  22. 

  23. EXAMPLES

  24. --------

  25. To search for a node by title containing some keywords:

  26.   1. Create a new node-based ("Content") View: Go to admin/structure/views/add

  27.      and under "Show", choose "Content".

  28.   2. Add a "Global: Null" Contextual Filter (this step is required to allow the

  29.      view to receive at least 1 argument).

  30.   3. Add a "Content: Title" Filter: Under "Filter Criteria," click "Add."

  31.      Choose "Content: Title," set the "Operator" to "Contains", and set the

  32.      "Value" to "***!1***" (without the quotes). Click "Apply."

  33.   4. Done! Any value passed as the first Contextual Filter argument will be used

  34.      as the value for the Content: Title filter.

  35. 

  36. To search for nodes containing the same title as a specified node:

  37.   1. Start by completing the example "to search for a node by title containing

  38.      some keywords," as given above.

  39.   2. Edit the "Global: Null" Contextual Filter: Enable "Specify validation

  40.      criteria," and set "Validator" to "Content."

  41.   3. Edit the "Content: Title (contains ***!1***)" filter: Change the "Value"

  42.      from "***!1***" to "***%1***".

  43.   4. Done!  If you pass in a valid NID as the first Contextual Filter argument,

  44.      its title will be used as the search value for the Content: Title filter.

  45. 

  46. INSTALLATION

  47. ------------

  48. Activate the module, then administer a desired View.  Add as many Contextual

  49. Filters as you need filter values (using "Global: Null", if appropriate), then

  50. insert corresponding tokens ("***!1***" for the first value, "***!2***" for the

  51. second, etc.) as filter values.  Additionally, "***%1***" may be used to insert

  52. the title for the first argument (for example, if the argument is a node), and

  53. so on.

  54. 

  55. 

  56. KNOWN ISSUES/SHORTCOMINGS

  57. -------------------------

  58. None, so far.

  59. 

  60. 

  61. MAINTAINERS

  62. -----------

  63. - jay.dansand (Jay Dansand)