Composr API documentation

Functions

Add an aggregate type instance.

add_aggregate_type_instance(\SHORT_TEXT $aggregate_label, \ID_TEXT $aggregate_type, array $_other_parameters, \?TIME $add_time = null, \?TIME $edit_time = null, boolean $sync = true, boolean $uniqify = false) : \AUTO_LINK

package	aggregate_types

Parameters

$aggregate_label

\SHORT_TEXT

Label for new instance

$aggregate_type

\ID_TEXT

What the instance is of

$_other_parameters

array

Additional parameters

$add_time

\?TIME

Add time (null: now)

$edit_time

\?TIME

Edit time (null: not edited yet)

$sync

boolean

Whether to activate it

$uniqify

boolean

Whether to force the name as unique, if there's a conflict

Returns

\AUTO_LINKID of the new instance

Delete an aggregate type instance.

delete_aggregate_type_instance(\AUTO_LINK $id, boolean $delete_matches = false)

package	aggregate_types

Parameters

$id

\AUTO_LINK

The ID

$delete_matches

boolean

Whether to delete all associated resources

Edit an aggregate type instance.

edit_aggregate_type_instance(\AUTO_LINK $id, \SHORT_TEXT $aggregate_label, \ID_TEXT $aggregate_type, array $_other_parameters, boolean $uniqify = false)

package	aggregate_types

Parameters

$id

\AUTO_LINK

The ID

$aggregate_label

\SHORT_TEXT

Label for instance

$aggregate_type

\ID_TEXT

What the instance is of

$_other_parameters

array

Additional parameters

$uniqify

boolean

Whether to force the name as unique, if there's a conflict

Find the parameters an aggregate type needs for instances.

find_aggregate_type_parameters(\ID_TEXT $aggregate_type) : array

package	aggregate_types

Parameters

$aggregate_type

\ID_TEXT

Aggregate type to find parameters for

Returns

arrayThe aggregate type parameters

Load the aggregate XML types structure.

parse_aggregate_xml(boolean $display_errors = false) : array

package	aggregate_types

Parameters

$display_errors

boolean

Whether errors should be displayed

Returns

arrayThe aggregate types

Re-sync all aggregate type instances.

resync_all_aggregate_type_instances(\?ID_TEXT $type = null)

package	aggregate_types

Parameters

$type

\?ID_TEXT

Restrict to this aggregate type (null: no restriction)

Sync an aggregate type instance.

sync_aggregate_type_instance(\AUTO_LINK $id, \?SHORT_TEXT $aggregate_label = null, \?SHORT_TEXT $old_aggregate_label = null, \?ID_TEXT $aggregate_type = null, \?array $other_parameters = null, \?array $old_parameters = null)

package	aggregate_types

Parameters

$id

\AUTO_LINK

The ID

$aggregate_label

\?SHORT_TEXT

Label for instance (null: lookup)

$old_aggregate_label

\?SHORT_TEXT

Old label for instance (null: lookup)

$aggregate_type

\?ID_TEXT

What the instance is of (null: lookup)

$other_parameters

\?array

Additional parameters (null: lookup)

$old_parameters

\?array

Old additional parameters (null: lookup)