Function Module_cms_catalogues->get_form_fields
Definitions
cms/pages/modules/cms_catalogues.php
- Get Tempcode for a catalogue entry adding/editing form.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $catalogue_name | ?ID_TEXT | No | No | Null | N/A | N/A | The catalogue for the entry (null: detect) |
| $category_id | ?AUTO_LINK | No | No | Null | N/A | N/A | The category for the entry (null: first) |
| $validated | BINARY | No | No | 1 | N/A | N/A | Whether the entry is validated |
| $validation_time | ?TIME | No | No | Null | N/A | N/A | The time on which this content should be validated (null: do not schedule) |
| $notes | LONG_TEXT | No | No | Blank (empty string) | N/A | N/A | Staff notes |
| $allow_rating | ?BINARY | No | No | Null | N/A | N/A | Whether rating is allowed (null: decide statistically, based on existing choices) |
| $allow_comments | ?SHORT_INTEGER | No | No | Null | N/A | N/A | Whether comments are allowed (0=no, 1=yes, 2=review style) (null: decide statistically, based on existing choices) |
| $allow_trackbacks | ?BINARY | No | No | Null | N/A | N/A | Whether trackbacks are allowed (null: decide statistically, based on existing choices) |
| $id | ?AUTO_LINK | No | No | Null | N/A | N/A | The ID of the entry (null: not yet added) |
Returns
- Either Tempcode; or a tuple of: (fields, hidden-fields[, delete-fields][, edit-text][, whether all delete fields are specified][, posting form text, more fields][, parsed WYSIWYG editable text])
- Type: mixed
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get Tempcode for a catalogue entry adding/editing form.
*
* @param ?ID_TEXT $catalogue_name The catalogue for the entry (null: detect)
* @param ?AUTO_LINK $category_id The category for the entry (null: first)
* @param BINARY $validated Whether the entry is validated
* @param ?TIME $validation_time The time on which this content should be validated (null: do not schedule)
* @param LONG_TEXT $notes Staff notes
* @param ?BINARY $allow_rating Whether rating is allowed (null: decide statistically, based on existing choices)
* @param ?SHORT_INTEGER $allow_comments Whether comments are allowed (0=no, 1=yes, 2=review style) (null: decide statistically, based on existing choices)
* @param ?BINARY $allow_trackbacks Whether trackbacks are allowed (null: decide statistically, based on existing choices)
* @param ?AUTO_LINK $id The ID of the entry (null: not yet added)
* @return mixed Either Tempcode; or a tuple of: (fields, hidden-fields[, delete-fields][, edit-text][, whether all delete fields are specified][, posting form text, more fields][, parsed WYSIWYG editable text])
*/
public function get_form_fields(?string $catalogue_name = null, ?int $category_id = null, int $validated = 1, ?int $validation_time = null, string $notes = '', ?int $allow_rating = null, ?int $allow_comments = null, ?int $allow_trackbacks = null, ?int $id = null)
* Get Tempcode for a catalogue entry adding/editing form.
*
* @param ?ID_TEXT $catalogue_name The catalogue for the entry (null: detect)
* @param ?AUTO_LINK $category_id The category for the entry (null: first)
* @param BINARY $validated Whether the entry is validated
* @param ?TIME $validation_time The time on which this content should be validated (null: do not schedule)
* @param LONG_TEXT $notes Staff notes
* @param ?BINARY $allow_rating Whether rating is allowed (null: decide statistically, based on existing choices)
* @param ?SHORT_INTEGER $allow_comments Whether comments are allowed (0=no, 1=yes, 2=review style) (null: decide statistically, based on existing choices)
* @param ?BINARY $allow_trackbacks Whether trackbacks are allowed (null: decide statistically, based on existing choices)
* @param ?AUTO_LINK $id The ID of the entry (null: not yet added)
* @return mixed Either Tempcode; or a tuple of: (fields, hidden-fields[, delete-fields][, edit-text][, whether all delete fields are specified][, posting form text, more fields][, parsed WYSIWYG editable text])
*/
public function get_form_fields(?string $catalogue_name = null, ?int $category_id = null, int $validated = 1, ?int $validation_time = null, string $notes = '', ?int $allow_rating = null, ?int $allow_comments = null, ?int $allow_trackbacks = null, ?int $id = null)
