help:array syntax

When searching by arrays, the following variations on search parameters can be used.

Whitespace separated lists

These parameter variations use whitespace (spaces, tabs, linebreaks) as a separator for the array, regardless of whether the individual items are numbers or text. This is the default and has no qualifier.

Array separated lists

These parameter variations use the URL array format to input the separate items. Is denoted with the qualifier "array".

Example:

search[parameter1_include_any_array][]=foo&search[parameter1_include_any_array][]=bar

The above sends the items as an array where it will end up as ["foo", "bar"].

Lowercase lists

These parameter variations apply a lowercase transformation to both the input and the record fields when making the comparisons. Is denoted with the qualifier "lower".

Includes any

Will return all records that include any of the items from the array. Is denoted with the qualifier "include_any".

Includes all

Will return all records that include all of the items from the array. Is denoted with the qualifier "include_all".

Count

Searches using the count of items in the array. Uses the same parameter format as numbers (see Help:Number syntax).

All parameter variations

For the following, NAME is the name of the record field being searched for.

  • NAME_include_any
  • NAME_include_all
  • NAME_include_any_array
  • NAME_include_all_array
  • NAME_include_any_lower
  • NAME_include_all_lower
  • NAME_include_any_lower_array
  • NAME_include_all_lower_array
  • NAME_count

See also