Function Module_cms_catalogues_alt->get_form_fields
Definitions
cms/pages/modules/cms_catalogues.php
- Get Tempcode for a catalogue adding/editing form.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $name | ID_TEXT | No | No | Blank (empty string) | N/A | N/A | The name of the catalogue |
| $title | SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | The human readable name/title of the catalogue |
| $description | LONG_TEXT | No | No | Blank (empty string) | N/A | N/A | The description |
| $display_type | SHORT_INTEGER | No | No | 0 | N/A | N/A | The display type |
| $is_tree | BINARY | No | No | 1 | N/A | N/A | Whether the catalogue uses a hierarchy |
| $notes | LONG_TEXT | No | No | Blank (empty string) | N/A | N/A | Admin notes |
| $submit_points | integer | No | No | 0 | N/A | N/A | How many points are given to a member that submits to the catalogue |
| $ecommerce | BINARY | No | No | 0 | N/A | N/A | Whether the catalogue is an eCommerce catalogue |
| $categories_sort_order | SHORT_TEXT | No | No | title ASC | "title ASC" "recent ASC" "recent DESC" | N/A | Category sort order |
| $send_view_reports | ID_TEXT | No | No | never | never daily weekly monthly quarterly | N/A | How to send view reports |
| $default_review_freq | ?integer | No | No | Null | N/A | N/A | Default review frequency for catalogue entries (null: none) |
Returns
- A tuple: The input fields, Hidden fields, ...
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get Tempcode for a catalogue adding/editing form.
*
* @param ID_TEXT $name The name of the catalogue
* @param SHORT_TEXT $title The human readable name/title of the catalogue
* @param LONG_TEXT $description The description
* @param SHORT_INTEGER $display_type The display type
* @param BINARY $is_tree Whether the catalogue uses a hierarchy
* @param LONG_TEXT $notes Admin notes
* @param integer $submit_points How many points are given to a member that submits to the catalogue
* @param BINARY $ecommerce Whether the catalogue is an eCommerce catalogue
* @param SHORT_TEXT $categories_sort_order Category sort order
* @set "title ASC" "recent ASC" "recent DESC"
* @param ID_TEXT $send_view_reports How to send view reports
* @set never daily weekly monthly quarterly
* @param ?integer $default_review_freq Default review frequency for catalogue entries (null: none)
* @return array A tuple: The input fields, Hidden fields, ...
*/
public function get_form_fields(string $name = '', string $title = '', string $description = '', int $display_type = 0, int $is_tree = 1, string $notes = '', int $submit_points = 0, int $ecommerce = 0, string $categories_sort_order = 'title ASC', string $send_view_reports = 'never', ?int $default_review_freq = null) : array
* Get Tempcode for a catalogue adding/editing form.
*
* @param ID_TEXT $name The name of the catalogue
* @param SHORT_TEXT $title The human readable name/title of the catalogue
* @param LONG_TEXT $description The description
* @param SHORT_INTEGER $display_type The display type
* @param BINARY $is_tree Whether the catalogue uses a hierarchy
* @param LONG_TEXT $notes Admin notes
* @param integer $submit_points How many points are given to a member that submits to the catalogue
* @param BINARY $ecommerce Whether the catalogue is an eCommerce catalogue
* @param SHORT_TEXT $categories_sort_order Category sort order
* @set "title ASC" "recent ASC" "recent DESC"
* @param ID_TEXT $send_view_reports How to send view reports
* @set never daily weekly monthly quarterly
* @param ?integer $default_review_freq Default review frequency for catalogue entries (null: none)
* @return array A tuple: The input fields, Hidden fields, ...
*/
public function get_form_fields(string $name = '', string $title = '', string $description = '', int $display_type = 0, int $is_tree = 1, string $notes = '', int $submit_points = 0, int $ecommerce = 0, string $categories_sort_order = 'title ASC', string $send_view_reports = 'never', ?int $default_review_freq = null) : array
