Commit | Line | Data |
---|---|---|
3097a0d6 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
3097a0d6 | 5 | +--------------------------------------------------------------------+ |
06a1bc01 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
3097a0d6 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | ||
29 | require_once 'CiviTest/CiviUnitTestCase.php'; | |
30 | require_once 'api/Wrapper.php'; | |
31 | ||
32 | /** | |
33 | * Test class for API functions | |
34 | * | |
35 | * @package CiviCRM_APIv3 | |
36 | */ | |
37 | class api_v3_APIWrapperTest extends CiviUnitTestCase { | |
38 | public $DBResetRequired = FALSE; | |
b7c9bc4c | 39 | |
3097a0d6 TO |
40 | |
41 | protected $_apiversion = 3; | |
42 | ||
43 | /** | |
44 | * Sets up the fixture, for example, opens a network connection. | |
45 | * This method is called before a test is executed. | |
3097a0d6 TO |
46 | */ |
47 | protected function setUp() { | |
48 | parent::setUp(); | |
0ddcaf8a | 49 | $this->useTransaction(TRUE); |
3097a0d6 TO |
50 | CRM_Utils_Hook_UnitTests::singleton()->setHook('civicrm_apiWrappers', array($this, 'onApiWrappers')); |
51 | } | |
52 | ||
53 | /** | |
54 | * Tears down the fixture, for example, closes a network connection. | |
55 | * This method is called after a test is executed. | |
3097a0d6 TO |
56 | */ |
57 | protected function tearDown() { | |
58 | parent::tearDown(); | |
59 | } | |
60 | ||
4cbe18b8 EM |
61 | /** |
62 | * @param $apiWrappers | |
63 | * @param $apiRequest | |
64 | */ | |
00be9182 | 65 | public function onApiWrappers(&$apiWrappers, $apiRequest) { |
3097a0d6 TO |
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'])); | |
69 | ||
70 | $apiWrappers[] = new api_v3_APIWrapperTest_Impl(); | |
71 | } | |
72 | ||
00be9182 | 73 | public function testWrapperHook() { |
3097a0d6 TO |
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', | |
82 | )); | |
83 | $this->assertEquals('First', $result['values'][$result['id']]['first_name']); | |
84 | $this->assertEquals('MUNGE! First Last', $result['values'][$result['id']]['display_name_munged']); | |
85 | } | |
86 | } | |
87 | ||
4cbe18b8 EM |
88 | /** |
89 | * Class api_v3_APIWrapperTest_Impl | |
90 | */ | |
3097a0d6 TO |
91 | class api_v3_APIWrapperTest_Impl implements API_Wrapper { |
92 | /** | |
e7c15cb6 | 93 | * @inheritDoc |
3097a0d6 TO |
94 | */ |
95 | public function fromApiInput($apiRequest) { | |
96 | if ($apiRequest['entity'] == 'contact' && $apiRequest['action'] == 'create') { | |
97 | if ('Invalid' == CRM_Utils_Array::value('contact_type', $apiRequest['params'])) { | |
98 | $apiRequest['params']['contact_type'] = 'Individual'; | |
99 | } | |
100 | } | |
101 | return $apiRequest; | |
102 | } | |
103 | ||
104 | /** | |
e7c15cb6 | 105 | * @inheritDoc |
3097a0d6 TO |
106 | */ |
107 | public function toApiOutput($apiRequest, $result) { | |
108 | if ($apiRequest['entity'] == 'contact' && $apiRequest['action'] == 'create') { | |
109 | if (isset($result['id'], $result['values'][$result['id']]['display_name'])) { | |
110 | $result['values'][$result['id']]['display_name_munged'] = 'MUNGE! ' . $result['values'][$result['id']]['display_name']; | |
111 | unset($result['values'][$result['id']]['display_name']); | |
112 | } | |
113 | } | |
114 | return $result; | |
115 | } | |
116 | } |