Function __global->render_download_box
Definitions
sources/downloads.php
- Get Tempcode for a download 'feature box' for the given row.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $row | array | required parameter | N/A | N/A | The database field row of this download |
| $pic | boolean | True | N/A | N/A | Whether to show a picture |
| $include_breadcrumbs | boolean | True | N/A | N/A | Whether to show breadcrumbs |
| $zone | ?ID_TEXT | Null | N/A | N/A | The zone the download module we're using is in (null: find it) |
| $text_summary | ?Tempcode | Null | N/A | N/A | Text summary for result (e.g. highlighted portion of actual file from search result) (null: none) |
| $give_context | boolean | True | N/A | N/A | Whether to include context (i.e. say WHAT this is, not just show the actual content) |
| $root | ?AUTO_LINK | Null | N/A | N/A | The virtual root (null: read from environment) |
| $guid | ID_TEXT | Blank (empty string) | N/A | N/A | Overridden GUID to send to templates (blank: none) |
Return
- A box for this download, linking to the full download page
- Type: Tempcode
- Set: N/A
- Range: N/A