<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
- * File for the CiviCRM APIv3 activity contact functions
+ * This api exposes the CiviCRM ActivityContact join table.
*
* @package CiviCRM_APIv3
- * @subpackage API_ActivityContact
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: ActivityContact.php 2014-04-01 elcapo $
*/
/**
- * Add a record relating a contact with an activity
- *
- * Allowed @params array keys are:
- *
- * @example ActivityContact.php
+ * Add a record relating a contact with an activity.
*
* @param array $params
*
* @return array
- * Array of newly created activity contact records.
- * @access public
+ * API result array.
*/
function civicrm_api3_activity_contact_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_activity_contact_create_spec(&$params) {
$params['contact_id']['api.required'] = 1;
}
/**
- * Deletes an existing ActivityContact record
+ * Delete an existing ActivityContact record.
*
* @param array $params
*
* @return array
* Api Result
- *
- * @example ActivityContact.php
- * @access public
*/
function civicrm_api3_activity_contact_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
/**
* Get a ActivityContact.
*
- * @example ActivityContact.php
- *
* @param array $params
* An associative array of name/value pairs.
*
* @return array
* details of found tags else error
- *
- * @access public
*/
function civicrm_api3_activity_contact_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);