Function __global->get_order_field
Definitions
sources/content2.php
- Get an order inputter.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $entry_type | ID_TEXT | required parameter | N/A | N/A | The type of resource being ordered |
| $category_type | ?ID_TEXT | required parameter | N/A | N/A | The type of resource being ordered within (null: no categories involved) |
| $current_order | ?integer | required parameter | N/A | N/A | The current order (null: new, so add to end) |
| $max | ?integer | Null | N/A | N/A | Maximum order field (null: work out from content type metadata) |
| $total | ?integer | Null | N/A | N/A | Number of entries, alternative to supplying $max (null: work out from content type metadata) |
| $order_field | ID_TEXT | order | N/A | N/A | The POST field to save under |
| $description | ?Tempcode | Null | N/A | N/A | Description for field input (null: {!ORDER}) |
| $num_automated_now | ?integer | Null | N/A | N/A | The number of records that are currently automated (null: work out) |
Return
- Ordering field
- Type: Tempcode
- Set: N/A
- Range: N/A