Function Module_cms_catalogues->get_set_field_map
Definitions
cms/pages/modules/cms_catalogues.php
- Get a entry-id=>value map of what a submitted catalogue entry form has set.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $catalogue_name | ID_TEXT | No | No | required parameter | N/A | N/A | The name of the catalogue that was used |
| $submitter | MEMBER | No | No | required parameter | N/A | N/A | The entry submitter |
| $editing_id | ?AUTO_LINK | No | No | Null | N/A | N/A | ID of entry being edited (null: not being edited) |
Returns
- The map
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a entry-id=>value map of what a submitted catalogue entry form has set.
*
* @param ID_TEXT $catalogue_name The name of the catalogue that was used
* @param MEMBER $submitter The entry submitter
* @param ?AUTO_LINK $editing_id ID of entry being edited (null: not being edited)
* @return array The map
*/
public function get_set_field_map(string $catalogue_name, int $submitter, ?int $editing_id = null) : array
* Get a entry-id=>value map of what a submitted catalogue entry form has set.
*
* @param ID_TEXT $catalogue_name The name of the catalogue that was used
* @param MEMBER $submitter The entry submitter
* @param ?AUTO_LINK $editing_id ID of entry being edited (null: not being edited)
* @return array The map
*/
public function get_set_field_map(string $catalogue_name, int $submitter, ?int $editing_id = null) : array
