3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 require_once 'CiviTest/CiviUnitTestCase.php';
30 require_once 'api/Wrapper.php';
33 * Test class for API functions
35 * @package CiviCRM_APIv3
37 class api_v3_APIWrapperTest
extends CiviUnitTestCase
{
38 public $DBResetRequired = FALSE;
41 protected $_apiversion = 3;
44 * Sets up the fixture, for example, opens a network connection.
45 * This method is called before a test is executed.
47 protected function setUp() {
49 $this->useTransaction(TRUE);
50 CRM_Utils_Hook_UnitTests
::singleton()->setHook('civicrm_apiWrappers', array($this, 'onApiWrappers'));
54 * Tears down the fixture, for example, closes a network connection.
55 * This method is called after a test is executed.
57 protected function tearDown() {
65 public function onApiWrappers(&$apiWrappers, $apiRequest) {
66 $this->assertTrue(is_string($apiRequest['entity']) && !empty($apiRequest['entity']));
67 $this->assertTrue(is_string($apiRequest['action']) && !empty($apiRequest['action']));
68 $this->assertTrue(is_array($apiRequest['params']) && !empty($apiRequest['params']));
70 $apiWrappers[] = new api_v3_APIWrapperTest_Impl();
73 public function testWrapperHook() {
74 // Note: this API call would fail due to missing contact_type, but
75 // the wrapper intervenes (fromApiInput)
76 // Note: The output would define "display_name", but the wrapper
77 // intervenes (toApiOutput) and replaces with "display_name_munged".
78 $result = $this->callAPISuccess('contact', 'create', array(
79 'contact_type' => 'Invalid',
80 'first_name' => 'First',
81 'last_name' => 'Last',
83 $this->assertEquals('First', $result['values'][$result['id']]['first_name']);
84 $this->assertEquals('MUNGE! First Last', $result['values'][$result['id']]['display_name_munged']);
90 * Class api_v3_APIWrapperTest_Impl
92 class api_v3_APIWrapperTest_Impl
implements API_Wrapper
{
96 public function fromApiInput($apiRequest) {
97 if ($apiRequest['entity'] == 'Contact' && $apiRequest['action'] == 'create') {
98 if ('Invalid' == CRM_Utils_Array
::value('contact_type', $apiRequest['params'])) {
99 $apiRequest['params']['contact_type'] = 'Individual';
108 public function toApiOutput($apiRequest, $result) {
109 if ($apiRequest['entity'] == 'Contact' && $apiRequest['action'] == 'create') {
110 if (isset($result['id'], $result['values'][$result['id']]['display_name'])) {
111 $result['values'][$result['id']]['display_name_munged'] = 'MUNGE! ' . $result['values'][$result['id']]['display_name'];
112 unset($result['values'][$result['id']]['display_name']);