Summary
Provides information about collections of items.
Details
| Name: | Collection Supplier |
|---|---|
| Prefix: | collection (optional) |
| Supported Content: | Collections, such as lists, sets and arrays. |
| Provided By: | Reporting Plugin |
Keys Supported
The following are the list of keys which this supplier will return a value for.
| Key | Content Types | Return Type | Description |
|---|---|---|---|
| size | Collection | Number | The number of items in the collection. |
| is empty | Collection | Boolean | Test if the collection is empty. |
| first | Collection | Anything | (Since 2.0.0) Returns the first item in the collection, if anything is present. |
| last | Collection | Anything | (Since 2.0.0) Returns the last item in the collection, if anything is present. |
| [X] | Collection | Anything | (Since 2.0.0) Returns the X'th item in the collection, where X is a number between 1 and 'size'. |
| random | Collection | Anything | (Since 3.1.0) Returns a random item from the provided list of elements. |
| shuffle | Collection | Collection | (Since 3.1.0) Returns the collection of items but scrambles the order of the elements. |
| reverse | Collection | Collection | (Since 3.2.0) Returns the collection of items in reverse order. |
Discussions