api/v3/Phone.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 phone records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add an Phone for a contact.
  36  *
  37  * @param array $params
  38  *   Array per getfields metadata.
  39  *
  40  * @return array
  41  */
  42 function civicrm_api3_phone_create($params) {
  43   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Phone');
  44 }
  45
  46 /**
  47  * Adjust Metadata for Create action.
  48  *
  49  * The metadata is used for setting defaults, documentation & validation.
  50  *
  51  * @param array $params
  52  *   Array of parameters determined by getfields.
  53  */
  54 function _civicrm_api3_phone_create_spec(&$params) {
  55   $params['contact_id']['api.required'] = 1;
  56   $params['phone']['api.required'] = 1;
  57   // hopefully change to use handleprimary
  58   $params['is_primary']['api.default'] = 0;
  59   $defaultLocation = CRM_Core_BAO_LocationType::getDefault();
  60   if ($defaultLocation) {
  61     $params['location_type_id']['api.default'] = $defaultLocation->id;
  62   }
  63 }
  64
  65 /**
  66  * Delete an existing Phone.
  67  *
  68  * @param array $params
  69  *   Array per getfields metadata.
  70  *
  71  * @return array
  72  *   Api Result
  73  */
  74 function civicrm_api3_phone_delete($params) {
  75   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  76 }
  77
  78 /**
  79  *  civicrm_api('Phone','Get') to retrieve one or more phones is implemented by
  80  *  function civicrm_api3_phone_get ($params) into the file Phone/Get.php
  81  *  Could have been implemented here in this file too, but we moved it to illustrate the feature with a real usage.
  82  */