api/v3/Rule.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM (dedupe) rules.
  30  *
  31  * Rules dedupe critieria assigned to RuleGroups.
  32  *
  33  * @package CiviCRM_APIv3
  34  */
  35
  36 /**
  37  * Create or update a rule.
  38  *
  39  * @param array $params
  40  *   Array per getfields metadata.
  41  *
  42  * @return array
  43  *   API result array
  44  */
  45 function civicrm_api3_rule_create($params) {
  46   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Rule');
  47 }
  48
  49 /**
  50  * Specify Meta data for create.
  51  *
  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.
  54  *
  55  * @param array $params
  56  */
  57 function _civicrm_api3_rule_create_spec(&$params) {
  58   $params['dedupe_rule_group_id']['api.required'] = TRUE;
  59   $params['rule_table']['api.default'] = 'civicrm_contact';
  60   $params['rule_field']['api.required'] = TRUE;
  61   $params['rule_weight']['api.required'] = TRUE;
  62 }
  63
  64 /**
  65  * Delete an existing Rule.
  66  *
  67  * @param array $params
  68  *
  69  * @return array
  70  *   API result array
  71  */
  72 function civicrm_api3_rule_delete($params) {
  73   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  74 }
  75
  76 /**
  77  * Get a Rule.
  78  *
  79  * @param array $params
  80  *   Array per getfields metadata.
  81  *
  82  * @return array
  83  *   API result array
  84  */
  85 function civicrm_api3_rule_get($params) {
  86   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Rule');
  87 }