api/v3/Phone.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.3                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2013                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * File for the CiviCRM APIv3 phone functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Phone
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  * @version $Id: Phone.php 2011-03-16 ErikHommel $
  37  */
  38
  39 /**
  40  *  Add an Phone for a contact
  41  *
  42  * Allowed @params array keys are:
  43  * {@getfields phone_create}
  44  * @example PhoneCreate.php
  45  *
  46  * @return array of newly created phone property values.
  47  * @access public
  48  */
  49 function civicrm_api3_phone_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Adjust Metadata for Create action
  55  *
  56  * The metadata is used for setting defaults, documentation & validation
  57  * @param array $params array or parameters determined by getfields
  58  */
  59 function _civicrm_api3_phone_create_spec(&$params) {
  60   $params['contact_id']['api.required'] = 1;
  61   $params['phone']['api.required'] = 1;
  62   // hopefully change to use handleprimary
  63   $params['is_primary']['api.default'] = 0;
  64 }
  65
  66 /**
  67  * Deletes an existing Phone
  68  *
  69  * @param  array  $params
  70  *
  71  * @return array Api Result
  72  * {@getfields phone_delete}
  73  * @example PhoneDelete.php
  74  * @access public
  75  */
  76 function civicrm_api3_phone_delete($params) {
  77   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  78 }
  79
  80 /**
  81  *  civicrm_api('Phone','Get') to retrieve one or more phones is implemented by
  82  *  function civicrm_api3_phone_get ($params) into the file Phone/Get.php
  83  *  Could have been implemented here in this file too, but we moved it to illustrate the feature with a real usage.
  84  *
  85  */
  86