Function Module_cms_cns_groups->get_form_fields
Definitions
cms/pages/modules/cms_cns_groups.php
- Get Tempcode for a 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 |
|---|---|---|---|---|---|---|---|
| $id | ?GROUP | No | No | Null | N/A | N/A | The usergroup being edited (null: adding, not editing, and let's choose the current member) |
| $name | SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | The usergroup name |
| $group_leader | ?ID_TEXT | No | No | Null | N/A | N/A | The username of the usergroup leader (null: none picked yet) |
| $open_membership | BINARY | No | No | 1 | N/A | N/A | Whether members may join this usergroup without requiring any special permission |
Returns
- A pair: The input fields, Hidden fields
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get Tempcode for a adding/editing form.
*
* @param ?GROUP $id The usergroup being edited (null: adding, not editing, and let's choose the current member)
* @param SHORT_TEXT $name The usergroup name
* @param ?ID_TEXT $group_leader The username of the usergroup leader (null: none picked yet)
* @param BINARY $open_membership Whether members may join this usergroup without requiring any special permission
* @return array A pair: The input fields, Hidden fields
*/
public function get_form_fields(?int $id = null, string $name = '', ?string $group_leader = null, int $open_membership = 1) : array
* Get Tempcode for a adding/editing form.
*
* @param ?GROUP $id The usergroup being edited (null: adding, not editing, and let's choose the current member)
* @param SHORT_TEXT $name The usergroup name
* @param ?ID_TEXT $group_leader The username of the usergroup leader (null: none picked yet)
* @param BINARY $open_membership Whether members may join this usergroup without requiring any special permission
* @return array A pair: The input fields, Hidden fields
*/
public function get_form_fields(?int $id = null, string $name = '', ?string $group_leader = null, int $open_membership = 1) : array
