extract
Summary
Returns a portion of the input array.Usage
input|extract( offset [, length ] )
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| offset | integer | The offset to start at. | Yes. |
| length | integer | The number of elements that should be extracted. | No. |
Returns
An array containing the extracted elements.Description
This operator will return a portion of the input array. The desired portion must be defined by the "offset" and "length" parameters. If the "length" parameter is omitted, the rest of the array (from offset) will be returned.
Examples
Example 1
{array( 1, 2, 3, 4, 5, 6, 7 )|extract( 2 )}
The following array will be returned: ( 3, 4, 5, 6, 7 ).
Example 2
{array( 1, 2, 3, 4, 5, 6, 7 )|extract( 3, 3 )}
The following array will be returned: ( 4, 5, 6 ).
Balazs Halasy (05/02/2004 9:31 am)
Balazs Halasy (04/05/2005 1:29 pm)
Comments
There are no comments.