Function __global->actual_add_catalogue
Definitions
sources/catalogues2.php
- Add a catalogue using all the specified values.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: string
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $name | ID_TEXT | required parameter | N/A | N/A | The codename of the catalogue |
| $title | mixed | required parameter | N/A | N/A | The title of the catalogue (either language string map or string) |
| $description | mixed | required parameter | N/A | N/A | A description (either language string map or string) |
| $display_type | SHORT_INTEGER | required parameter | N/A | N/A | The display type |
| $is_tree | BINARY | required parameter | N/A | N/A | Whether the catalogue uses a tree system (as opposed to mere categories in an index) |
| $notes | LONG_TEXT | required parameter | N/A | N/A | Hidden notes pertaining to this catalogue |
| $submit_points | integer | required parameter | N/A | N/A | How many points a member gets by submitting to this catalogue |
| $ecommerce | BINARY | 0 | N/A | N/A | Whether the catalogue is an eCommerce catalogue |
| $categories_sort_order | SHORT_TEXT | title ASC | N/A | N/A | Category sort order |
| $send_view_reports | ID_TEXT | never | N/A | N/A | How to send view reports |
| $default_review_freq | ?integer | Null | N/A | N/A | Default review frequency for catalogue entries (null: none) |
| $add_time | ?TIME | Null | N/A | N/A | The add time (null: now) |
| $uniqify | boolean | False | N/A | N/A | Whether to force the name as unique, if there's a conflict |
Return
- The name
- Type: ID_TEXT
- Set: N/A
- Range: N/A