3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM rule_groups.
31 * RuleGroups are used to group dedupe critieria.
33 * @package CiviCRM_APIv3
37 * Create or update a rule_group.
39 * @param array $params
40 * Array per getfields metadata.
45 function civicrm_api3_rule_group_create($params) {
46 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
50 * Specify Meta data for create.
52 * Note that this data is retrievable via the getfields function
53 * and is used for pre-filling defaults and ensuring mandatory requirements are met.
55 * @param array $params
57 function _civicrm_api3_rule_group_create_spec(&$params) {
58 $params['contact_type']['api.required'] = TRUE;
59 $params['threshold']['api.required'] = TRUE;
60 $params['used']['api.required'] = TRUE;
61 $params['name']['api.required'] = TRUE;
65 * Delete an existing RuleGroup.
67 * @param array $params
72 function civicrm_api3_rule_group_delete($params) {
73 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
79 * @param array $params
80 * Array per getfields metadata.
85 function civicrm_api3_rule_group_get($params) {
86 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);