3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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 * Test APIv3 civicrm_create_custom_group
34 class api_v3_CustomFieldTest
extends CiviUnitTestCase
{
35 protected $_apiversion;
37 public function setUp() {
38 $this->_apiversion
= 3;
42 public function tearDown() {
43 $tablesToTruncate = array(
46 'civicrm_entity_file',
48 // true tells quickCleanup to drop custom_value tables that might have been created in the test
49 $this->quickCleanup($tablesToTruncate, TRUE);
53 * Check with no array.
55 public function testCustomFieldCreateNoArray() {
58 $customField = $this->callAPIFailure('custom_field', 'create', $fieldParams);
59 $this->assertEquals($customField['error_message'], 'Input variable `params` is not an array');
63 * Check with no label.
65 public function testCustomFieldCreateWithoutLabel() {
66 $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'text_test_group'));
68 'custom_group_id' => $customGroup['id'],
69 'name' => 'test_textfield2',
70 'html_type' => 'Text',
71 'data_type' => 'String',
72 'default_value' => 'abc',
79 $customField = $this->callAPIFailure('custom_field', 'create', $params);
80 $this->assertEquals($customField['error_message'], 'Mandatory key(s) missing from params array: label');
86 public function testCustomFieldCreateWithEdit() {
87 $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'text_test_group'));
89 'custom_group_id' => $customGroup['id'],
90 'name' => 'test_textfield2',
92 'html_type' => 'Text',
93 'data_type' => 'String',
94 'default_value' => 'abc',
101 $customField = $this->callAPIAndDocument('custom_field', 'create', $params, __FUNCTION__
, __FILE__
);
102 $params['id'] = $customField['id'];
103 $customField = $this->callAPISuccess('custom_field', 'create', $params);
105 $this->assertNotNull($customField['id']);
109 * Check without groupId.
111 public function testCustomFieldCreateWithoutGroupID() {
112 $fieldParams = array(
113 'name' => 'test_textfield1',
115 'html_type' => 'Text',
116 'data_type' => 'String',
117 'default_value' => 'abc',
120 'is_searchable' => 0,
125 $customField = $this->callAPIFailure('custom_field', 'create', $fieldParams);
126 $this->assertEquals($customField['error_message'], 'Mandatory key(s) missing from params array: custom_group_id');
130 * Check for Each data type: loop through available form input types
132 public function testCustomFieldCreateAllAvailableFormInputs() {
133 $gid = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'testAllFormInputs'));
135 $dtype = CRM_Core_BAO_CustomField
::dataType();
136 $htype = CRM_Core_BAO_CustomField
::dataToHtml();
139 foreach ($dtype as $dkey => $dvalue) {
140 foreach ($htype[$n] as $hkey => $hvalue) {
141 //echo $dkey."][".$hvalue."\n";
142 $this->_loopingCustomFieldCreateTest($this->_buildParams($gid['id'], $hvalue, $dkey));
148 * Can't figure out the point of this?
151 * @param array $params
153 public function _loopingCustomFieldCreateTest($params) {
154 $customField = $this->callAPISuccess('custom_field', 'create', $params);
155 $this->assertNotNull($customField['id']);
156 $this->getAndCheck($params, $customField['id'], 'CustomField');
166 public function _buildParams($gid, $htype, $dtype) {
167 $params = $this->_buildBasicParams($gid, $htype, $dtype);
168 /* //Not Working for any type. Maybe redundant with testCustomFieldCreateWithOptionValues()
169 if ($htype == 'Multi-Select')
170 $params = array_merge($params, array(
171 'option_label' => array( 'Label1','Label2'),
172 'option_value' => array( 'val1', 'val2' ),
173 'option_weight' => array( 1, 2),
174 'option_status' => array( 1, 1),
188 public function _buildBasicParams($gid, $htype, $dtype) {
190 'custom_group_id' => $gid,
191 'label' => $dtype . $htype,
192 'html_type' => $htype,
193 'data_type' => $dtype,
196 'is_searchable' => 0,
203 * Test using example code.
205 /*function testCustomFieldCreateExample( )
208 $customGroup = $this->customGroupCreate('Individual','date_test_group',3);
209 require_once 'api/v3/examples/CustomField/Create.php';
210 $result = custom_field_create_example();
211 $expectedResult = custom_field_create_expectedresult();
212 $this->assertEquals($result,$expectedResult);
216 * Check with data type - Options with option_values
218 public function testCustomFieldCreateWithEmptyOptionGroup() {
219 $customGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'select_test_group'));
221 'custom_group_id' => $customGroup['id'],
222 'label' => 'Country',
223 'html_type' => 'Select',
224 'data_type' => 'String',
227 'is_searchable' => 0,
231 $customField = $this->callAPISuccess('custom_field', 'create', $params);
232 $this->assertNotNull($customField['id']);
233 $optionGroupID = $this->callAPISuccess('custom_field', 'getvalue', array(
234 'id' => $customField['id'],
235 'return' => 'option_group_id',
238 $this->assertTrue(is_numeric($optionGroupID) && ($optionGroupID > 0));
239 $optionGroup = $this->callAPISuccess('option_group', 'getsingle', array(
240 'id' => $optionGroupID,
242 $this->assertEquals($optionGroup['title'], 'Country');
243 $optionValueCount = $this->callAPISuccess('option_value', 'getcount', array(
244 'option_group_id' => $optionGroupID,
246 $this->assertEquals(0, $optionValueCount);
250 * Test custom field with existing option group.
252 public function testCustomFieldExistingOptionGroup() {
253 $customGroup = $this->customGroupCreate(array('extends' => 'Organization', 'title' => 'test_group'));
255 'custom_group_id' => $customGroup['id'],
256 // Just to say something:
257 'label' => 'Organization Gender',
258 'html_type' => 'Select',
259 'data_type' => 'Int',
262 'is_searchable' => 0,
264 // Option group id 3: gender
265 'option_group_id' => 3,
268 $customField = $this->callAPISuccess('custom_field', 'create', $params);
269 $this->assertNotNull($customField['id']);
270 $optionGroupID = $this->callAPISuccess('custom_field', 'getvalue', array(
271 'id' => $customField['id'],
272 'return' => 'option_group_id',
275 $this->assertEquals($optionGroupID, 3);
279 * Test custom field get works & return param works
281 public function testCustomFieldGetReturnOptions() {
282 $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group'));
283 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id']));
285 $result = $this->callAPISuccess('custom_field', 'getsingle', array(
286 'id' => $customField['id'],
287 'return' => 'data_type',
289 $this->assertTrue(array_key_exists('data_type', $result));
290 $this->assertFalse(array_key_exists('custom_group_id', $result));
294 * Test custom field get works & return param works
296 public function testCustomFieldGetReturnArray() {
297 $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group'));
298 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id']));
300 $result = $this->callAPISuccess('custom_field', 'getsingle', array(
301 'id' => $customField['id'],
302 'return' => array('data_type'),
304 $this->assertTrue(array_key_exists('data_type', $result));
305 $this->assertFalse(array_key_exists('custom_group_id', $result));
309 * Test custom field get works & return param works
311 public function testCustomFieldGetReturnTwoOptions() {
312 $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'test_group'));
313 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id']));
315 $result = $this->callAPISuccess('custom_field', 'getsingle', array(
316 'id' => $customField['id'],
317 'return' => 'data_type, custom_group_id',
319 $this->assertTrue(array_key_exists('data_type', $result));
320 $this->assertTrue(array_key_exists('custom_group_id', $result));
321 $this->assertFalse(array_key_exists('label', $result));
324 public function testCustomFieldCreateWithOptionValues() {
325 $customGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'select_test_group'));
327 $option_values = array(
343 'custom_group_id' => $customGroup['id'],
344 'label' => 'Our special field',
345 'html_type' => 'Select',
346 'data_type' => 'String',
349 'is_searchable' => 0,
351 'option_values' => $option_values,
355 $customField = $this->callAPISuccess('custom_field', 'create', $params);
357 $this->assertAPISuccess($customField);
358 $this->assertNotNull($customField['id']);
359 $getFieldsParams = array(
360 'options' => array('get_options' => 'custom_' . $customField['id']),
361 'action' => 'create',
363 $description = "Demonstrates retrieving metadata with custom field options.";
364 $subfile = "GetFieldsOptions";
365 $fields = $this->callAPIAndDocument('contact', 'getfields', $getFieldsParams, __FUNCTION__
, 'ContactTest.php', $description, $subfile);
366 $this->assertArrayHasKey('options', $fields['values']['custom_' . $customField['id']]);
367 $this->assertEquals('Label1', $fields['values']['custom_' . $customField['id']]['options'][1]);
368 $getOptionsArray = array(
369 'field' => 'custom_' . $customField['id'],
371 $description = "Demonstrates retrieving options for a custom field.";
372 $subfile = "GetOptions";
373 $result = $this->callAPIAndDocument('contact', 'getoptions', $getOptionsArray, __FUNCTION__
, 'ContactTest.php', $description, '');
374 $this->assertEquals('Label1', $result['values'][1]);
377 ///////////////// civicrm_custom_field_delete methods
380 * Check with no array.
382 public function testCustomFieldDeleteNoArray() {
384 $customField = $this->callAPIFailure('custom_field', 'delete', $params);
385 $this->assertEquals($customField['error_message'], 'Input variable `params` is not an array');
389 * Check without Field ID.
391 public function testCustomFieldDeleteWithoutFieldID() {
393 $customField = $this->callAPIFailure('custom_field', 'delete', $params,
394 'Mandatory key(s) missing from params array: id');
398 * Check without valid array.
400 public function testCustomFieldDelete() {
401 $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group'));
402 $customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id']));
403 $this->assertNotNull($customField['id']);
406 'id' => $customField['id'],
408 $result = $this->callAPIAndDocument('custom_field', 'delete', $params, __FUNCTION__
, __FILE__
);
410 $this->assertAPISuccess($result);
414 * Check for Option Value.
416 public function testCustomFieldOptionValueDelete() {
417 $customGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'ABC'));
418 $customOptionValueFields = $this->customFieldOptionValueCreate($customGroup, 'fieldABC');
420 'id' => $customOptionValueFields,
423 $customField = $this->callAPISuccess('custom_field', 'delete', $customOptionValueFields);
427 * If there's one custom group for "Contact" and one for "Activity", then "Contact.getfields"
428 * and "Activity.getfields" should return only their respective fields (not the other's fields),
429 * and unrelated entities should return no custom fields.
431 public function testGetfields_CrossEntityPollution() {
432 $auxEntities = array('Email', 'Address', 'LocBlock', 'Membership', 'ContributionPage', 'ReportInstance');
433 $allEntities = array_merge(array('Contact', 'Activity'), $auxEntities);
435 // Baseline - getfields doesn't reporting any customfields for any entities
436 foreach ($allEntities as $entity) {
439 $this->getCustomFieldKeys($this->callAPISuccess($entity, 'getfields', array())),
440 "Baseline custom fields for $entity should be empty"
445 $contactGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'test_group_c'));
446 $contactField = $this->customFieldCreate(array(
447 'custom_group_id' => $contactGroup['id'],
448 'label' => 'For Contacts',
450 $indivGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group_i'));
451 $indivField = $this->customFieldCreate(array('custom_group_id' => $indivGroup['id'], 'label' => 'For Individuals'));
452 $activityGroup = $this->customGroupCreate(array('extends' => 'Activity', 'title' => 'test_group_a'));
453 $activityField = $this->customFieldCreate(array(
454 'custom_group_id' => $activityGroup['id'],
455 'label' => 'For Activities',
460 array('custom_' . $contactField['id'], 'custom_' . $indivField['id']),
461 $this->getCustomFieldKeys($this->callAPISuccess('Contact', 'getfields', array())),
462 'Contact custom fields'
465 array('custom_' . $contactField['id'], 'custom_' . $indivField['id']),
466 $this->getCustomFieldKeys($this->callAPISuccess('Individual', 'getfields', array())),
467 'Individual custom fields'
470 array('custom_' . $contactField['id']),
471 $this->getCustomFieldKeys($this->callAPISuccess('Organization', 'getfields', array())),
472 'Organization custom fields'
475 array('custom_' . $activityField['id']),
476 $this->getCustomFieldKeys($this->callAPISuccess('Activity', 'getfields', array())),
477 'Activity custom fields'
479 foreach ($auxEntities as $entity) {
482 $this->getCustomFieldKeys($this->callAPISuccess($entity, 'getfields', array())),
483 "Custom fields for $entity should be empty"
489 * Test setting and getting a custom file field value.
491 * Uses the "attachment" api for setting value.
493 public function testCustomFileField() {
494 $customGroup = $this->customGroupCreate(array('title' => 'attachment_test_group'));
496 'custom_group_id' => $customGroup['id'],
497 'name' => 'test_file_attachment',
498 'label' => 'test_file_attachment',
499 'html_type' => 'File',
500 'data_type' => 'File',
503 $customField = $this->callAPISuccess('custom_field', 'create', $params);
504 $cfId = 'custom_' . $customField['id'];
506 $cid = $this->individualCreate();
508 $attachment = $this->callAPISuccess('attachment', 'create', array(
509 'name' => CRM_Utils_String
::createRandom(5, CRM_Utils_String
::ALPHANUMERIC
) . '_testCustomFileField.txt',
510 'mime_type' => 'text/plain',
511 'content' => 'My test content',
512 'field_name' => $cfId,
515 $this->assertAttachmentExistence(TRUE, $attachment);
517 $result = $this->callAPISuccess('contact', 'getsingle', array(
522 $this->assertEquals($attachment['id'], $result[$cfId]);
526 * @param $getFieldsResult
530 public function getCustomFieldKeys($getFieldsResult) {
531 $isCustom = function ($key) {
532 return preg_match('/^custom_/', $key);
534 $r = array_values(array_filter(array_keys($getFieldsResult['values']), $isCustom));