Rule.php
This api exposes CiviCRM (dedupe) rules.
Rules dedupe critieria assigned to RuleGroups.
Table of Contents
Functions
- civicrm_api3_rule_create() : array<string|int, mixed>
- Create or update a rule.
- _civicrm_api3_rule_create_spec() : mixed
- Specify Meta data for create.
- civicrm_api3_rule_delete() : array<string|int, mixed>
- Delete an existing Rule.
- civicrm_api3_rule_get() : array<string|int, mixed>
- Get a Rule.
Functions
civicrm_api3_rule_create()
Create or update a rule.
civicrm_api3_rule_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —API result array
_civicrm_api3_rule_create_spec()
Specify Meta data for create.
_civicrm_api3_rule_create_spec(array<string|int, mixed> &$params) : mixed
Note that this data is retrievable via the getfields function and is used for pre-filling defaults and ensuring mandatory requirements are met.
Parameters
- $params : array<string|int, mixed>
civicrm_api3_rule_delete()
Delete an existing Rule.
civicrm_api3_rule_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
civicrm_api3_rule_get()
Get a Rule.
civicrm_api3_rule_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —API result array