api/v3/ActivityContact.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 activity contact functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_ActivityContact
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: ActivityContact.php 2014-04-01 elcapo $
  37  */
  38
  39 /**
  40  *  Add a record relating a contact with an activity
  41  *
  42  * Allowed @params array keys are:
  43  *
  44  * @example ActivityContact.php
  45  *
  46  * @param array $params
  47  *
  48  * @return array
  49  *   of newly created activity contact records.
  50  * @access public
  51  */
  52 function civicrm_api3_activity_contact_create($params) {
  53   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  54 }
  55
  56 /**
  57  * Adjust Metadata for Create action
  58  *
  59  * The metadata is used for setting defaults, documentation & validation
  60  * @param array $params
  61  *   Array or parameters determined by getfields.
  62  */
  63 function _civicrm_api3_activity_contact_create_spec(&$params) {
  64   $params['contact_id']['api.required'] = 1;
  65   $params['activity_id']['api.required'] = 1;
  66 }
  67
  68 /**
  69  * Deletes an existing ActivityContact record
  70  *
  71  * @param array $params
  72  *
  73  * @return array
  74  *   Api Result
  75  *
  76  * @example ActivityContact.php
  77  * @access public
  78  */
  79 function civicrm_api3_activity_contact_delete($params) {
  80   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  81 }
  82
  83 /**
  84  * Get a ActivityContact.
  85  *
  86  * @example ActivityContact.php
  87  *
  88  * @param array $params
  89  *   An associative array of name/value pairs.
  90  *
  91  * @return array
  92  *   details of found tags else error
  93  *
  94  * @access public
  95  */
  96 function civicrm_api3_activity_contact_get($params) {
  97   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  98 }