Export Loop
Export loop lists all defined exports.
{loop type="export" name="the-loop-name" [argument="value"], [...]}Important informations :
* : argument is required
** : at least one of ** marked argument is required
Global arguments
| Argument | Description |
|---|---|
| backend_context |
Determine if loop is use in backend context. default : false example : backend_context="on" |
| force_return |
force return result for i18n tables even if there is no record default : false example : force_return="on" |
| limit |
The maximum number of results to display. example : limit="10" |
| name * |
The loop name. This name must be unique and is used to reference this loop further in the page (see ifloop, elseloop or pageloop) |
| offset |
The first product to display offset. Will not be used if `page` argument is set. default : 0 example : offset="1" |
| page |
The page to display. example : page="2" |
Loop arguments
| Argument | Description |
|---|---|
| category |
A single or a list of export category ids. example : category="2", category="1,4" |
| id |
A single or a list of export ids. example : id="2", id="1,4,7" |
| order |
A list of values
Expected values :
default : manual example : order="alpha" |
|
ref
Thelia >= 2.4 |
A single or a list of export references. example : ref="thelia.export.customer", id="thelia.export.customer,thelia.export.orders" |
Global outputs
| Variable | Description |
|---|---|
| $LOOP_COUNT | the current results index, starting from 1 |
| $LOOP_TOTAL | the total number of results returned by the loop |
| $CREATE_DATE | The creation date of this Export |
| $UPDATE_DATE | The last modification date of this Export |
Loop outputs
| Variable | Description |
|---|---|
| $CATEGORY_ID | the export category id |
| $DESCRIPTION | the export description |
| $HANDLE_CLASS | The fully qualified name of the class which implements this export |
| $ID | the export id |
| $POSITION | the export position in the containing category |
| $REF >= 2.4 | The export reference, as defined in a config.xml file |
| $TITLE | The export title |
| $URL | the URL to start this export in the admin export page |