...
Function: forEach()
Iterates over an Array or Recordset and processes a script for each entry.
...
| Argument | Type | Description |
|---|---|---|
| $var | $-Variable | A $-Variable which will be set to each item in set in turn before script is processed. |
| set | Array or Recordset | The set of items which will be iterated over. |
| script | $-Variable | A comma separated list of Expressions which will be processed once for each entry in set. |
forEach() is like every other function in that it returns a value.
- Its Its return value is the last statement executed in the last iteration.
- All All the $-variables used in the call to forEach() keep their values between iterations.
- All the $-variables used in the call to forEach() will be available after it has returned.
...
- Assign the value of the customer type to the $-Variable $customerType.
- The first expression then increments the value of $total by 1 (i.e. counting the total number of types in the list).
- The second expression checks if the type is "Business" and if so calls continue() which causes forEach() to immediately skip to the next customer type in customers.type and starts again from the first expression (i.e. it does not reach the 3rd expression to increment the $-Variable $nonBusiness).
- If the type is not "Business" the third expression will be processed increment a count of the non-business types.
- The final expression is evaluated and the result added to the result Array of the forEach() function.
The forEach() function above therefore returns an Array of the first 6 characters of each non business customer type in the supplied list. The values of $total (a count of all customer types), $nonBusiness (a count of all non-business customer types) and $customerType (the last customer type processed) will be available to subsequent Attribute Expressions for the current Stream Item calculation.
Commonly, you might not want to return a list from forEach(), but calculate some values in the loop to use later. For example, if you had an attribute TotalCustNumber, you might create an attribute expression:
...
Then the next attribute might be NonBusinessCustNumber, and you could write the number of non-business customers calculated in the loop to this attribute simply using the expression:
$nonBusiness