Merge pull request #2845 from elcapo/activity-contact-api

Create new API entity: ActivityContact (#CRM-14414)

diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php
new file mode 100644 (file)
index 0000000..c6ca5ae
--- /dev/null
+++ b/api/v3/ActivityContact.php
@@ -0,0 +1,91 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.4                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2013                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | 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
+ *
+ * @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
+ *
+ * @return array of newly created activity contact records.
+ * @access public
+ */
+function civicrm_api3_activity_contact_create($params) {
+  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+/**
+ * Adjust Metadata for Create action
+ *
+ * The metadata is used for setting defaults, documentation & validation
+ * @param array $params array or parameters determined by getfields
+ */
+function _civicrm_api3_activity_contact_create_spec(&$params) {
+  $params['contact_id']['api.required'] = 1;
+  $params['activity_id']['api.required'] = 1;
+}
+
+/**
+ * Deletes 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);
+}

diff --git a/tests/phpunit/api/v3/ActivityContactTest.php b/tests/phpunit/api/v3/ActivityContactTest.php
new file mode 100644 (file)
index 0000000..776c3ce
--- /dev/null
+++ b/tests/phpunit/api/v3/ActivityContactTest.php
@@ -0,0 +1,112 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.5                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+
+require_once 'CiviTest/CiviUnitTestCase.php';
+
+
+/**
+ *  Test APIv3 civicrm_activity_contact* functions
+ *
+ *  @package CiviCRM_APIv3
+ *  @subpackage API_Activity
+ */
+class api_v3_ActivityContactTest extends CiviUnitTestCase {
+  protected $_apiversion;
+  protected $_contactID;
+  protected $_activityID;
+  protected $_params;
+
+
+  function setUp() {
+    $this->_apiversion = 3;
+    parent::setUp();
+
+    $this->_contactID    = $this->organizationCreate();
+    $activity            = $this->activityCreate();
+    $this->_activityID   = $activity['id'];
+    CRM_Core_PseudoConstant::flush();
+    $this->quickCleanup(array('civicrm_activity_contact'));
+    $this->_params = array(
+      'contact_id' => $this->_contactID,
+      'activity_id' => $this->_activityID,
+      'record_type_id' => 2,
+    );
+  }
+
+  function tearDown() {
+    $params['activity_id'] = $this->_activityID;
+    $this->callAPISuccess('activity', 'delete', $params);
+    $this->contactDelete($this->_contactID);
+  }
+
+  public function testCreateActivityContact() {
+
+    $result = $this->callAPIAndDocument('activity_contact', 'create', $this->_params, __FUNCTION__, __FILE__);
+    $this->assertEquals(1, $result['count']);
+    $this->assertNotNull($result['values'][$result['id']]['id']);
+
+    $this->callAPISuccess('activity_contact', 'delete', array('id' => $result['id']));
+  }
+
+  public function testDeleteActivityContact() {
+    //create one
+    $create = $this->callAPISuccess('activity_contact', 'create', $this->_params);
+
+    $result = $this->callAPIAndDocument('activity_contact', 'delete', array('id' => $create['id'],), __FUNCTION__, __FILE__);
+    $this->assertEquals(1, $result['count']);
+    $get = $this->callAPISuccess('activity_contact', 'get', array(
+      'id' => $create['id'],
+    ));
+    $this->assertEquals(0, $get['count'], 'ActivityContact not successfully deleted');
+  }
+
+  public function testGetActivitiesByContact() {
+    $result = $this->callAPISuccess('ActivityContact', 'Get', array('contact_id' => $this->_contactID));
+  }
+
+  public function testGetPartitipantsByActivity() {
+    $result = $this->callAPISuccess('ActivityContact', 'Get', array('activity_id' => $this->_activityID));
+  }
+
+  /**
+   * Test civicrm_activity_contact_get with empty params.
+   */
+  public function testGetEmptyParams() {
+    $result = $this->callAPISuccess('ActivityContact', 'Get', array());
+  }
+
+  /**
+   * Test civicrm_activity_contact_get with wrong params.
+   */
+  public function testGetWrongParams() {
+    $this->callAPIFailure('ActivityContact', 'Get', array('contact_id' => 'abc'));
+    $this->callAPIFailure('ActivityContact', 'Get', array('activity_id' => 'abc'));
+    $this->callAPIFailure('ActivityContact', 'Get', array('record_type_id' => 'abc'));
+  }
+}
+