Function __global->edit_aggregate_type_instance

Definitions

sources/aggregate_types.php

  • Edit an aggregate type instance.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id AUTO_LINK No No required parameter N/A N/A The ID
$aggregate_label SHORT_TEXT No No required parameter N/A N/A Label for instance
$aggregate_type ID_TEXT No No required parameter N/A N/A What the instance is of
$_other_parameters array No No required parameter N/A N/A Additional parameters
$uniqify boolean No No False N/A N/A Whether to force the name as unique, if there's a conflict
$add_time ?TIME No No Null N/A N/A Add time (null: don't change)
$edit_time ?TIME No No Null N/A N/A Edit time (null: now)

Preview

Code (PHP)

/**
 * Edit an aggregate type instance.
 *
 * @param  AUTO_LINK $id The ID
 * @param  SHORT_TEXT $aggregate_label Label for instance
 * @param  ID_TEXT $aggregate_type What the instance is of
 * @param  array $_other_parameters Additional parameters
 * @param  boolean $uniqify Whether to force the name as unique, if there's a conflict
 * @param  ?TIME $add_time Add time (null: don't change)
 * @param  ?TIME $edit_time Edit time (null: now)
 */
function edit_aggregate_type_instance(int $id, string $aggregate_label, string $aggregate_type, array $_other_parameters, bool $uniqify = false, ?int $add_time = null, ?int $edit_time = null)