api/v3/Exception.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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  * Get a Dedupe Exception.
  30  *
  31  * @param array $params
  32  *   Array per getfields metadata.
  33  *
  34  * @return array
  35  *   Array of all found dedupe exception object property values.
  36  */
  37 function civicrm_api3_exception_get($params) {
  38   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  39 }
  40
  41 /**
  42  * Create or update an dedupe exception.
  43  *
  44  * @param array $params
  45  *          Array per getfields metadata.
  46  *
  47  * @return array api result array
  48  */
  49 function civicrm_api3_exception_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Exception');
  51 }
  52
  53 /**
  54  * Delete an existing Exception.
  55  *
  56  * This method is used to delete any existing Exception given its id.
  57  *
  58  * @param array $params
  59  *          [id]
  60  *
  61  * @return array api result array
  62  */
  63 function civicrm_api3_exception_delete($params) {
  64   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  65 }