Function __global->add_aggregate_type_instance
Definitions
sources/aggregate_types.php
- Add an aggregate type instance.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: int
Parameters
Name | Type | Default | Set | Range | Description |
---|---|---|---|---|---|
$aggregate_label | SHORT_TEXT | required parameter | N/A | N/A | Label for new instance |
$aggregate_type | ID_TEXT | required parameter | N/A | N/A | What the instance is of |
$_other_parameters | array | required parameter | N/A | N/A | Additional parameters |
$add_time | ?TIME | Null | N/A | N/A | Add time (null: now) |
$edit_time | ?TIME | Null | N/A | N/A | Edit time (null: not edited yet) |
$sync | boolean | True | N/A | N/A | Whether to activate it |
$uniqify | boolean | False | N/A | N/A | Whether to force the name as unique, if there's a conflict |
Return
- ID of the new instance
- Type: AUTO_LINK
- Set: N/A
- Range: N/A