3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
28 require_once 'CiviTest/CiviUnitTestCase.php';
31 * Tests for pseudoconstant retrieval
33 class CRM_Core_PseudoConstantTest
extends CiviUnitTestCase
{
39 'name' => 'PseudoConstant',
40 'description' => 'Tests for pseudoconstant option values',
48 $this->loadAllFixtures();
50 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCase');
51 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCampaign');
55 * Assure CRM_Core_PseudoConstant::get() is working properly for a range of
56 * DAO fields having a <pseudoconstant> tag in the XML schema.
58 function testOptionValues() {
60 // Create a custom field group for testing.
61 $custom_group_name = md5(microtime());
63 'title' => $custom_group_name,
64 'extends' => 'Individual',
67 $result = civicrm_api3('customGroup', 'create', $api_params);
69 // Add a custom field to the above field group.
72 'custom_group_id' => $result['id'],
73 'label' => $custom_group_name,
74 'html_type' => 'Select',
75 'data_type' => 'String',
77 'option_values' => array(array(
84 $result = civicrm_api3('custom_field', 'create', $api_params);
85 $customFieldId = $result['id'];
87 // Create a Contact Group for testing.
88 $group_name = md5(microtime());
90 'title' => $group_name,
93 $result = civicrm_api3('group', 'create', $api_params);
95 // Create a PaymentProcessor for testing.
96 $pp_name = md5(microtime());
99 'payment_processor_type_id' => 10,
101 'user_name' => $pp_name,
102 'class_name' => 'Payment_Dummy',
103 'url_site' => 'https://test.com/',
104 'url_recur' => 'https://test.com/',
107 $result = civicrm_api3('payment_processor', 'create', $api_params);
109 // Create a Campaign for testing.
110 $campaign_name = md5(microtime());
112 'title' => $campaign_name,
116 $result = civicrm_api3('campaign', 'create', $api_params);
118 // Create a membership type for testing.
119 $membership_type = md5(microtime());
121 'name' => $membership_type,
123 'financial_type_id' => 1,
125 'member_of_contact_id' => 1,
126 'duration_unit' => 'day',
127 'duration_interval' => 1,
129 $result = civicrm_api3('membership_type', 'create', $api_params);
131 // Create a contribution page for testing.
132 $contribution_page = md5(microtime());
134 'title' => $contribution_page,
136 'financial_type_id' => 1,
138 $result = civicrm_api3('contribution_page', 'create', $api_params);
141 * daoName/field combinations to test
142 * Format: array[DAO Name] = $properties, where properties is an array whose
143 * named members can be:
144 * - fieldName: the SQL column name within the DAO table.
145 * - sample: Any one value which is expected in the list of option values.
146 * - exclude: Any one value which should not be in the list.
147 * - max: integer (default = 20) maximum number of option values expected.
150 'CRM_ACL_DAO_ACL' => array(
152 'fieldName' => 'operation',
156 'CRM_Contact_DAO_Group' => array(
158 'fieldName' => 'visibility',
159 'sample' => 'Public Pages',
162 'CRM_Contact_DAO_GroupContact' => array(
164 'fieldName' => 'group_id',
165 'sample' => $group_name,
168 'fieldName' => 'status',
172 'CRM_Contact_DAO_GroupContactCache' => array(
174 'fieldName' => 'group_id',
175 'sample' => $group_name,
178 'CRM_Contact_DAO_GroupOrganization' => array(
180 'fieldName' => 'group_id',
181 'sample' => $group_name,
184 'CRM_Contact_DAO_SubscriptionHistory' => array(
186 'fieldName' => 'group_id',
187 'sample' => $group_name,
190 'fieldName' => 'method',
194 'fieldName' => 'status',
198 'CRM_Core_DAO_Cache' => array(
200 'fieldName' => 'component_id',
201 'sample' => 'CiviMail',
204 'CRM_Contact_DAO_ACLContactCache' => array(
206 'fieldName' => 'operation',
210 'CRM_Core_DAO_Setting' => array(
212 'fieldName' => 'component_id',
213 'sample' => 'CiviMail',
216 'CRM_Core_DAO_ActionSchedule' => array(
218 'fieldName' => 'group_id',
219 'sample' => $group_name,
222 'fieldName' => 'start_action_unit',
226 'fieldName' => 'repetition_frequency_unit',
230 'fieldName' => 'end_frequency_unit',
234 'fieldName' => 'mode',
238 'CRM_Dedupe_DAO_RuleGroup' => array(
240 'fieldName' => 'contact_type',
241 'sample' => 'Individual',
244 'fieldName' => 'used',
245 'sample' => 'Unsupervised',
248 'CRM_Mailing_Event_DAO_Subscribe' => array(
250 'fieldName' => 'group_id',
251 'sample' => $group_name,
254 'CRM_Activity_DAO_Activity' => array(
256 'fieldName' => 'activity_type_id',
261 'fieldName' => 'status_id',
262 'sample' => 'Scheduled',
265 'fieldName' => 'priority_id',
266 'sample' => 'Urgent',
269 'fieldName' => 'engagement_level',
273 'fieldName' => 'medium_id',
277 'fieldName' => 'campaign_id',
278 'sample' => $campaign_name,
281 'CRM_Campaign_DAO_Campaign' => array(
283 'fieldName' => 'campaign_type_id',
284 'sample' => 'Constituent Engagement',
288 'fieldName' => 'status_id',
289 'sample' => 'Completed',
293 'CRM_Campaign_DAO_Survey' => array(
295 'fieldName' => 'campaign_id',
296 'sample' => $campaign_name,
299 'fieldName' => 'activity_type_id',
300 'sample' => 'Phone Call',
304 'CRM_Campaign_DAO_CampaignGroup' => array(
306 'fieldName' => 'campaign_id',
307 'sample' => $campaign_name,
310 'fieldName' => 'group_type',
311 'sample' => 'Include',
314 'CRM_Contact_DAO_RelationshipType' => array(
316 'fieldName' => 'contact_type_a',
317 'sample' => 'Individual',
320 'fieldName' => 'contact_type_b',
321 'sample' => 'Organization',
324 'CRM_Event_DAO_ParticipantStatusType' => array(
326 'fieldName' => 'class',
327 'sample' => 'Waiting',
330 'fieldName' => 'visibility_id',
331 'sample' => 'Public',
334 'CRM_Price_DAO_LineItem' => array(
336 'fieldName' => 'financial_type_id',
337 'sample' => 'Donation',
340 'CRM_Price_DAO_PriceField' => array(
342 'fieldName' => 'html_type',
343 'sample' => 'Select',
346 'fieldName' => 'visibility_id',
347 'sample' => 'Public',
350 'CRM_Price_DAO_PriceFieldValue' => array(
352 'fieldName' => 'financial_type_id',
353 'sample' => 'Donation',
356 'CRM_Price_DAO_PriceSet' => array(
358 'fieldName' => 'domain_id',
359 'sample' => 'Default Domain Name',
362 'fieldName' => 'extends',
363 'sample' => 'CiviEvent',
366 'fieldName' => 'financial_type_id',
367 'sample' => 'Donation',
370 'CRM_Financial_DAO_EntityFinancialAccount' => array(
372 'fieldName' => 'financial_account_id',
373 'sample' => 'Member Dues',
376 'fieldName' => 'account_relationship',
377 'sample' => 'Income Account is',
380 'CRM_Financial_DAO_FinancialItem' => array(
382 'fieldName' => 'status_id',
383 'sample' => 'Partially paid',
386 'fieldName' => 'financial_account_id',
387 'sample' => 'Accounts Receivable',
390 'fieldName' => 'currency',
391 'sample' => array('USD' => 'US Dollar'),
395 'CRM_Financial_DAO_FinancialTrxn' => array(
397 'fieldName' => 'from_financial_account_id',
398 'sample' => 'Accounts Receivable',
401 'fieldName' => 'to_financial_account_id',
402 'sample' => 'Accounts Receivable',
405 'fieldName' => 'currency',
406 'sample' => array('USD' => 'US Dollar'),
410 'fieldName' => 'payment_instrument_id',
414 'CRM_Financial_DAO_FinancialAccount' => array(
416 'fieldName' => 'financial_account_type_id',
417 'sample' => 'Cost of Sales',
420 'CRM_Financial_DAO_PaymentProcessor' => array(
422 'fieldName' => 'domain_id',
423 'sample' => 'Default Domain Name',
426 'CRM_Financial_BAO_PaymentProcessorType' => array(
428 'fieldName' => 'billing_mode',
432 'CRM_Core_DAO_UFField' => array(
434 'fieldName' => 'uf_group_id',
435 'sample' => 'Name and Address',
438 'fieldName' => 'visibility',
439 'sample' => 'Public Pages',
442 'CRM_Core_DAO_UFJoin' => array(
444 'fieldName' => 'uf_group_id',
445 'sample' => 'Name and Address',
448 'CRM_Core_DAO_UFMatch' => array(
450 'fieldName' => 'domain_id',
451 'sample' => 'Default Domain Name',
454 'CRM_Core_DAO_Job' => array(
456 'fieldName' => 'domain_id',
457 'sample' => 'Default Domain Name',
460 'fieldName' => 'run_frequency',
464 'CRM_Core_DAO_JobLog' => array(
466 'fieldName' => 'domain_id',
467 'sample' => 'Default Domain Name',
470 'CRM_Contribute_DAO_ContributionSoft' => array(
472 'fieldName' => 'currency',
473 'sample' => array('USD' => 'US Dollar'),
477 'fieldName' => 'soft_credit_type_id',
478 'sample' => 'In Honor of',
481 'CRM_Contribute_DAO_Product' => array(
483 'fieldName' => 'currency',
484 'sample' => array('USD' => 'US Dollar'),
488 'fieldName' => 'financial_type_id',
489 'sample' => 'Donation',
492 'fieldName' => 'period_type',
493 'sample' => 'Rolling',
496 'fieldName' => 'duration_unit',
500 'fieldName' => 'frequency_unit',
504 'CRM_Contribute_DAO_ContributionProduct' => array(
506 'fieldName' => 'financial_type_id',
507 'sample' => 'Donation',
510 'CRM_Contribute_DAO_ContributionRecur' => array(
512 'fieldName' => 'currency',
513 'sample' => array('USD' => 'US Dollar'),
517 'fieldName' => 'frequency_unit',
521 'fieldName' => 'contribution_status_id',
522 'sample' => 'Completed',
525 'fieldName' => 'financial_type_id',
526 'sample' => 'Donation',
529 'fieldName' => 'payment_instrument_id',
533 'fieldName' => 'campaign_id',
534 'sample' => $campaign_name,
537 'CRM_Pledge_DAO_PledgePayment' => array(
539 'fieldName' => 'currency',
540 'sample' => array('USD' => 'US Dollar'),
544 'CRM_Pledge_DAO_Pledge' => array(
546 'fieldName' => 'currency',
547 'sample' => array('USD' => 'US Dollar'),
551 'fieldName' => 'financial_type_id',
552 'sample' => 'Donation',
555 'fieldName' => 'frequency_unit',
559 'fieldName' => 'campaign_id',
560 'sample' => $campaign_name,
563 'CRM_PCP_DAO_PCP' => array(
565 'fieldName' => 'currency',
566 'sample' => array('USD' => 'US Dollar'),
570 'fieldName' => 'status_id',
571 'sample' => 'Approved',
574 'CRM_Core_DAO_CustomField' => array(
576 'fieldName' => 'custom_group_id',
577 'sample' => $custom_group_name,
580 'fieldName' => 'data_type',
581 'sample' => 'Alphanumeric',
584 'fieldName' => 'html_type',
585 'sample' => 'Select Date',
588 'CRM_Core_DAO_CustomGroup' => array(
590 'fieldName' => 'style',
591 'sample' => 'Inline',
594 'CRM_Core_DAO_Dashboard' => array(
596 'fieldName' => 'domain_id',
597 'sample' => 'Default Domain Name',
600 'CRM_Core_DAO_Tag' => array(
602 'fieldName' => 'used_for',
603 'sample' => 'Contacts',
606 'CRM_Core_DAO_EntityTag' => array(
608 'fieldName' => 'tag_id',
609 'sample' => 'Government Entity',
612 'CRM_Core_DAO_Extension' => array(
614 'fieldName' => 'type',
615 'sample' => 'Module',
618 'CRM_Core_DAO_OptionValue' => array(
620 'fieldName' => 'option_group_id',
621 'sample' => 'gender',
625 'fieldName' => 'component_id',
626 'sample' => 'CiviContribute',
629 'fieldName' => 'domain_id',
630 'sample' => 'Default Domain Name',
633 'CRM_Core_DAO_MailSettings' => array(
635 'fieldName' => 'domain_id',
636 'sample' => 'Default Domain Name',
639 'fieldName' => 'protocol',
640 'sample' => 'Localdir',
643 'CRM_Core_DAO_Managed' => array(
645 'fieldName' => 'cleanup',
646 'sample' => 'Always',
649 'CRM_Core_DAO_Mapping' => array(
651 'fieldName' => 'mapping_type_id',
652 'sample' => 'Search Builder',
655 'CRM_Core_DAO_Navigation' => array(
657 'fieldName' => 'domain_id',
658 'sample' => 'Default Domain Name',
661 'CRM_Core_DAO_Phone' => array(
663 'fieldName' => 'phone_type_id',
667 'fieldName' => 'location_type_id',
671 'CRM_Core_DAO_PrintLabel' => array(
673 'fieldName' => 'label_format_name',
674 'sample' => 'Avery 5395',
677 'fieldName' => 'label_type_id',
678 'sample' => 'Event Badge',
681 'CRM_Core_DAO_Email' => array(
683 'fieldName' => 'location_type_id',
687 'CRM_Core_DAO_Address' => array(
689 'fieldName' => 'location_type_id',
693 'CRM_Core_DAO_Website' => array(
695 'fieldName' => 'website_type_id',
696 'sample' => 'Facebook',
699 'CRM_Core_DAO_WordReplacement' => array(
701 'fieldName' => 'match_type',
702 'sample' => 'Exact Match',
705 'fieldName' => 'domain_id',
706 'sample' => 'Default Domain Name',
709 'CRM_Core_DAO_MappingField' => array(
711 'fieldName' => 'contact_type',
712 'sample' => 'Individual',
715 'fieldName' => 'website_type_id',
716 'sample' => 'Facebook',
719 'fieldName' => 'im_provider_id',
723 'fieldName' => 'operator',
727 'CRM_Contact_DAO_Contact' => array(
729 'fieldName' => 'prefix_id',
733 'fieldName' => 'suffix_id',
737 'fieldName' => 'gender_id',
741 'fieldName' => 'preferred_communication_method',
742 'sample' => 'Postal Mail',
745 'fieldName' => 'contact_type',
746 'sample' => 'Individual',
750 'fieldName' => 'contact_sub_type',
752 'exclude' => 'Individual',
755 'fieldName' => 'preferred_language',
756 'sample' => array('en_US' => 'English (United States)'),
760 'fieldName' => 'preferred_mail_format',
764 'fieldName' => 'communication_style_id',
765 'sample' => 'Formal',
768 'fieldName' => "custom_$customFieldId",
769 'sample' => array('foo' => 'Foo'),
773 'CRM_Batch_DAO_Batch' => array(
775 'fieldName' => 'type_id',
776 'sample' => 'Membership',
779 'fieldName' => 'status_id',
780 'sample' => 'Reopened',
783 'fieldName' => 'mode_id',
784 'sample' => 'Automatic Batch',
787 'fieldName' => 'payment_instrument_id',
791 'CRM_Core_DAO_IM' => array(
793 'fieldName' => 'provider_id',
797 'fieldName' => 'location_type_id',
801 'CRM_Event_DAO_Participant' => array(
803 'fieldName' => 'status_id',
804 'sample' => 'Registered',
807 'fieldName' => 'role_id',
808 'sample' => 'Speaker',
811 'fieldName' => 'fee_currency',
812 'sample' => array('USD' => 'US Dollar'),
816 'fieldName' => 'campaign_id',
817 'sample' => $campaign_name,
820 'CRM_Event_DAO_Event' => array(
822 'fieldName' => 'event_type_id',
823 'sample' => 'Fundraiser',
826 'fieldName' => 'participant_listing_id',
827 'sample' => 'Name and Email',
830 'fieldName' => 'payment_processor',
831 'sample' => $pp_name,
834 'fieldName' => 'financial_type_id',
835 'sample' => 'Donation',
838 'fieldName' => 'default_role_id',
839 'sample' => 'Attendee',
842 'fieldName' => 'currency',
843 'sample' => array('USD' => 'US Dollar'),
847 'fieldName' => 'campaign_id',
848 'sample' => $campaign_name,
851 'CRM_Core_DAO_Menu' => array(
853 'fieldName' => 'domain_id',
854 'sample' => 'Default Domain Name',
857 'fieldName' => 'component_id',
858 'sample' => 'CiviMember',
861 'CRM_Member_DAO_Membership' => array(
863 'fieldName' => 'membership_type_id',
864 'sample' => $membership_type,
867 'fieldName' => 'status_id',
871 'fieldName' => 'campaign_id',
872 'sample' => $campaign_name,
875 'CRM_Member_DAO_MembershipStatus' => array(
877 'fieldName' => 'start_event',
878 'sample' => 'start date',
881 'fieldName' => 'end_event',
882 'sample' => 'member since',
885 'fieldName' => 'start_event_adjust_unit',
889 'fieldName' => 'end_event_adjust_unit',
893 'CRM_Member_DAO_MembershipType' => array(
895 'fieldName' => 'visibility',
896 'sample' => 'Public',
899 'fieldName' => 'domain_id',
900 'sample' => 'Default Domain Name',
903 'fieldName' => 'financial_type_id',
904 'sample' => 'Donation',
907 'fieldName' => 'duration_unit',
908 'sample' => 'lifetime',
911 'fieldName' => 'period_type',
912 'sample' => 'Rolling',
915 'CRM_Mailing_DAO_Mailing' => array(
917 'fieldName' => 'approval_status_id',
918 'sample' => 'Approved',
921 'fieldName' => 'domain_id',
922 'sample' => 'Default Domain Name',
925 'fieldName' => 'visibility',
926 'sample' => 'Public Pages',
929 'fieldName' => 'campaign_id',
930 'sample' => $campaign_name,
933 'CRM_Mailing_DAO_Component' => array(
935 'fieldName' => 'component_type',
936 'sample' => 'Header',
939 'CRM_Mailing_DAO_MailingGroup' => array(
941 'fieldName' => 'group_type',
942 'sample' => 'Include',
945 'CRM_Mailing_DAO_MailingJob' => array(
947 'fieldName' => 'status',
948 'sample' => 'Scheduled',
951 'CRM_Mailing_Event_DAO_Bounce' => array(
953 'fieldName' => 'bounce_type_id',
954 'sample' => 'Invalid',
957 'CRM_Mailing_Event_DAO_Subscribe' => array(
959 'fieldName' => 'group_id',
960 'sample' => $group_name,
963 'CRM_Grant_DAO_Grant' => array(
965 'fieldName' => 'status_id',
966 'sample' => 'Approved for Payment',
969 'fieldName' => 'grant_type_id',
970 'sample' => 'Emergency',
973 'fieldName' => 'currency',
974 'sample' => array('USD' => 'US Dollar'),
978 'fieldName' => 'financial_type_id',
979 'sample' => 'Donation',
982 'CRM_Contribute_DAO_Contribution' => array(
984 'fieldName' => 'payment_instrument_id',
985 'sample' => 'Credit Card',
988 'fieldName' => 'financial_type_id',
989 'sample' => 'Donation',
992 'fieldName' => 'currency',
993 'sample' => array('USD' => 'US Dollar'),
997 'fieldName' => 'contribution_status_id',
998 'sample' => 'Completed',
1001 'fieldName' => 'contribution_page_id',
1002 'sample' => $contribution_page,
1005 'fieldName' => 'campaign_id',
1006 'sample' => $campaign_name,
1009 'CRM_Contribute_DAO_PremiumsProduct' => array(
1011 'fieldName' => 'financial_type_id',
1012 'sample' => 'Donation',
1015 'CRM_Contribute_DAO_ContributionPage' => array(
1017 'fieldName' => 'payment_processor',
1018 'sample' => $pp_name,
1021 'fieldName' => 'financial_type_id',
1022 'sample' => 'Donation',
1025 'fieldName' => 'currency',
1026 'sample' => array('USD' => 'US Dollar'),
1030 'fieldName' => 'campaign_id',
1031 'sample' => $campaign_name,
1034 'CRM_Case_DAO_Case' => array(
1036 'fieldName' => 'status_id',
1037 'sample' => 'Ongoing',
1040 'fieldName' => 'case_type_id',
1041 'sample' => 'Housing Support',
1044 'CRM_Report_DAO_ReportInstance' => array(
1046 'fieldName' => 'domain_id',
1047 'sample' => 'Default Domain Name',
1052 foreach ($fields as $daoName => $daoFields) {
1053 foreach ($daoFields as $field) {
1054 $message = "DAO name: '{$daoName}', field: '{$field['fieldName']}'";
1056 $optionValues = $daoName::buildOptions($field['fieldName']);
1057 $this->assertNotEmpty($optionValues, $message);
1059 // Ensure sample value is contained in the returned optionValues.
1060 if (!is_array($field['sample'])) {
1061 $this->assertContains($field['sample'], $optionValues, $message);
1063 // If sample is an array, we check keys and values
1065 foreach ($field['sample'] as $key => $value) {
1066 $this->assertArrayHasKey($key, $optionValues, $message);
1067 $this->assertEquals(CRM_Utils_Array
::value($key, $optionValues), $value, $message);
1071 // Ensure exclude value is not contained in the optionValues
1072 if (!empty($field['exclude'])) {
1073 $this->assertNotContains($field['exclude'], $optionValues, $message);
1076 // Ensure count of optionValues is not extraordinarily high.
1077 $max = CRM_Utils_Array
::value('max', $field, 20);
1078 $this->assertLessThanOrEqual($max, count($optionValues), $message);
1083 function testContactTypes() {
1085 'Individual' => 'Individual',
1086 'Household' => 'Household',
1087 'Organization' => 'Organization',
1092 3 => 'Organization',
1094 // By default this should return an array keyed by name
1095 $result = CRM_Contact_DAO_Contact
::buildOptions('contact_type');
1096 $this->assertEquals($byName, $result);
1097 // But we can also fetch by ID
1098 $result = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'contact_type', array('keyColumn' => 'id', 'labelColumn' => 'name'));
1099 $this->assertEquals($byId, $result);
1100 // Make sure flip param works
1101 $result = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'contact_type', array('keyColumn' => 'id', 'labelColumn' => 'name', 'flip' => TRUE));
1102 $this->assertEquals(array_flip($byId), $result);