api/v3/Phone.php

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