Update test examples.
authoreileen <emcnaughton@wikimedia.org>
Tue, 24 Jan 2017 08:16:04 +0000 (21:16 +1300)
committereileen <emcnaughton@wikimedia.org>
Tue, 24 Jan 2017 08:53:26 +0000 (21:53 +1300)
This is not an exhaustive update. It covers a good chunk of the common changes but a lot of copy & paste means the examples are being overwritten by other tests. I have removed some of that

181 files changed:
api/v3/examples/Activity/ContactRefCustomField.php
api/v3/examples/Activity/ContactRefCustomFieldGet.php
api/v3/examples/Activity/Create.php
api/v3/examples/Activity/DateTimeHigh.php
api/v3/examples/Activity/DateTimeLow.php
api/v3/examples/Activity/Delete.php
api/v3/examples/Activity/Get.php
api/v3/examples/Activity/GetFields.php
api/v3/examples/Activity/GetTargetandAssignee.php
api/v3/examples/Activity/GetTargetandAssigneeName.php
api/v3/examples/Activity/ReturnAssigneeContact.php
api/v3/examples/ActivityContact/Create.php
api/v3/examples/ActivityContact/Delete.php
api/v3/examples/ActivityType/Create.php
api/v3/examples/ActivityType/Get.php
api/v3/examples/Address/AddressLike.php
api/v3/examples/Address/AddressParse.php
api/v3/examples/Address/AddressSort.php
api/v3/examples/Address/Create.php
api/v3/examples/Address/Delete.php
api/v3/examples/Address/Get.php
api/v3/examples/Address/GetOptions.php
api/v3/examples/Batch/Create.php
api/v3/examples/Batch/Delete.php
api/v3/examples/Batch/Get.php
api/v3/examples/Campaign/Create.php
api/v3/examples/Campaign/Delete.php
api/v3/examples/Campaign/Get.php
api/v3/examples/Case/Create.php
api/v3/examples/CaseContact/Get.php [new file with mode: 0644]
api/v3/examples/Constant/Get.php
api/v3/examples/Contact/APIChainedArray.php
api/v3/examples/Contact/APIChainedArrayFormats.php
api/v3/examples/Contact/APIChainedArrayMultipleCustom.php
api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.php
api/v3/examples/Contact/ChainTwoWebsites.php
api/v3/examples/Contact/ChainTwoWebsitesSyntax2.php
api/v3/examples/Contact/Create.php
api/v3/examples/Contact/CustomFieldGet.php
api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.php
api/v3/examples/Contact/Delete.php
api/v3/examples/Contact/FormatIsSuccess_Fail.php
api/v3/examples/Contact/FormatIsSuccess_True.php
api/v3/examples/Contact/FormatOnlyID.php
api/v3/examples/Contact/FormatSingleValue.php
api/v3/examples/Contact/Get.php
api/v3/examples/Contact/GetActions.php
api/v3/examples/Contact/GetCountContact.php
api/v3/examples/Contact/GetFieldsOptions.php
api/v3/examples/Contact/GetOptions.php
api/v3/examples/Contact/GetSingleContact.php
api/v3/examples/Contact/GroupFilterUsingContactAPI.php
api/v3/examples/Contact/NestedReplaceEmail.php
api/v3/examples/ContributionPage/Create.php
api/v3/examples/ContributionPage/Delete.php
api/v3/examples/ContributionPage/Get.php
api/v3/examples/ContributionPage/Submit.php
api/v3/examples/ContributionRecur/Create.php
api/v3/examples/ContributionRecur/Delete.php
api/v3/examples/ContributionRecur/Get.php
api/v3/examples/ContributionSoft/Create.php
api/v3/examples/ContributionSoft/Delete.php
api/v3/examples/ContributionSoft/Get.php
api/v3/examples/Country/Create.php
api/v3/examples/Country/Delete.php
api/v3/examples/Country/Get.php
api/v3/examples/CustomField/Create.php
api/v3/examples/CustomField/Delete.php
api/v3/examples/CustomGroup/Create.php
api/v3/examples/CustomGroup/Delete.php
api/v3/examples/CustomGroup/Get.php
api/v3/examples/Domain/Create.php
api/v3/examples/Domain/Get.php
api/v3/examples/Email/Create.php
api/v3/examples/Email/Delete.php
api/v3/examples/Email/Replace.php
api/v3/examples/EntityBatch/Create.php [new file with mode: 0644]
api/v3/examples/EntityBatch/Delete.php [new file with mode: 0644]
api/v3/examples/EntityBatch/Get.php [new file with mode: 0644]
api/v3/examples/EntityTag/Delete.php
api/v3/examples/EntityTag/Get.php
api/v3/examples/Event/ContactRefCustomField.php [new file with mode: 0644]
api/v3/examples/Event/Create.php
api/v3/examples/Event/Delete.php
api/v3/examples/Event/Get.php
api/v3/examples/Event/IsCurrentOption.php
api/v3/examples/Event/IsFullOption.php
api/v3/examples/Grant/Create.php
api/v3/examples/Grant/Delete.php
api/v3/examples/Grant/Get.php
api/v3/examples/Group/Get.php
api/v3/examples/Group/GetFields.php
api/v3/examples/GroupContact/Create.php
api/v3/examples/GroupContact/Delete.php
api/v3/examples/GroupContact/Get.php
api/v3/examples/GroupContact/GetWithGroupID.php
api/v3/examples/GroupNesting/Create.php
api/v3/examples/GroupNesting/Delete.php
api/v3/examples/GroupNesting/Get.php
api/v3/examples/GroupOrganization/Create.php
api/v3/examples/GroupOrganization/Delete.php
api/v3/examples/GroupOrganization/Get.php
api/v3/examples/Im/Create.php
api/v3/examples/Im/Delete.php
api/v3/examples/Im/Get.php
api/v3/examples/Job/Create.php
api/v3/examples/Job/Delete.php
api/v3/examples/LineItem/Create.php
api/v3/examples/LineItem/Delete.php
api/v3/examples/LineItem/Get.php
api/v3/examples/LocBlock/Create.php
api/v3/examples/LocBlock/CreateEntities.php
api/v3/examples/LocBlock/Get.php
api/v3/examples/Logging/Get.php
api/v3/examples/Logging/Revert.php
api/v3/examples/MailSettings/ChainedGetDelete.php
api/v3/examples/MailSettings/Create.php
api/v3/examples/MailSettings/Delete.php
api/v3/examples/MailSettings/Get.php
api/v3/examples/MailSettings/GetOptions.php
api/v3/examples/Mailing/Clone.php [new file with mode: 0644]
api/v3/examples/Mailing/Create.php
api/v3/examples/Mailing/Delete.php
api/v3/examples/Mailing/GetTokens.php
api/v3/examples/Mailing/Submit.php
api/v3/examples/MailingAB/Create.php
api/v3/examples/MailingEventSubscribe/Create.php [new file with mode: 0644]
api/v3/examples/Mapping/Create.php [new file with mode: 0644]
api/v3/examples/Mapping/Delete.php [new file with mode: 0644]
api/v3/examples/Mapping/Get.php [new file with mode: 0644]
api/v3/examples/MappingField/Create.php [new file with mode: 0644]
api/v3/examples/MappingField/Delete.php [new file with mode: 0644]
api/v3/examples/MappingField/Get.php [new file with mode: 0644]
api/v3/examples/Membership/Create.php
api/v3/examples/Membership/CreateWithCustomData.php
api/v3/examples/Membership/Delete.php
api/v3/examples/Membership/FilterIsCurrent.php
api/v3/examples/Membership/Get.php
api/v3/examples/Membership/SearchWithCustomData.php [new file with mode: 0644]
api/v3/examples/Membership/UpdateCustomData.php
api/v3/examples/MembershipPayment/Create.php
api/v3/examples/MembershipPayment/Get.php
api/v3/examples/MembershipStatus/Create.php
api/v3/examples/MembershipStatus/Get.php
api/v3/examples/MembershipType/Create.php
api/v3/examples/MembershipType/Delete.php
api/v3/examples/MembershipType/Get.php
api/v3/examples/MessageTemplate/Create.php
api/v3/examples/MessageTemplate/Delete.php
api/v3/examples/MessageTemplate/Get.php
api/v3/examples/Note/Create.php
api/v3/examples/Note/Delete.php
api/v3/examples/Note/Get.php
api/v3/examples/OpenID/Create.php [new file with mode: 0644]
api/v3/examples/OpenID/Delete.php [new file with mode: 0644]
api/v3/examples/OpenID/Get.php [new file with mode: 0644]
api/v3/examples/OptionGroup/Create.php
api/v3/examples/OptionGroup/Delete.php
api/v3/examples/OptionGroup/Get.php
api/v3/examples/OptionValue/Get.php
api/v3/examples/OptionValue/SortOption.php
api/v3/examples/Order/Cancel.php
api/v3/examples/Order/Create.php
api/v3/examples/Order/CreateOrderParticipant.php
api/v3/examples/Order/Delete.php
api/v3/examples/Order/Get.php
api/v3/examples/Participant/Create.php
api/v3/examples/Participant/Get.php
api/v3/examples/Participant/NestedDelete.php
api/v3/examples/Participant/NestedEventGet.php
api/v3/examples/ParticipantPayment/Create.php
api/v3/examples/ParticipantPayment/Delete.php
api/v3/examples/ParticipantPayment/Get.php
api/v3/examples/ParticipantStatusType/Create.php
api/v3/examples/ParticipantStatusType/Delete.php
api/v3/examples/ParticipantStatusType/Get.php
api/v3/examples/PaymentProcessor/Create.php
api/v3/examples/Phone/GetOptions.php
tests/phpunit/api/v3/ContributionPageTest.php
tests/phpunit/api/v3/ContributionTest.php
tests/phpunit/api/v3/FinancialTypeACLTest.php

index 6d9fba5541e0e3b759b2e050fde476466cdba148..adf4230f1357246e34874a2e519e38f1b2f8259c 100644 (file)
@@ -30,7 +30,8 @@ function activity_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -78,6 +79,7 @@ function activity_create_expectedresult() {
         'campaign_id' => '',
         'engagement_level' => '',
         'weight' => '',
+        'is_star' => '',
       ),
     ),
   );
index ec99659ff6a963d7fc8761968b1d937a29f458fb..6cd8188ccb393c55a17101bc108da5ca80653dd7 100644 (file)
@@ -22,7 +22,8 @@ function activity_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index eacee7ed30d70e731adbd3c705fb8a124c7ebcdc..6615362918b295414621933769e8d94e5811f78c 100644 (file)
@@ -28,7 +28,8 @@ function activity_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 2c9a0b4c3ed99022b8f70f6120cde1a12641dff6..4833a1885bf38bed171fe692169aa549e6696420 100644 (file)
@@ -23,7 +23,8 @@ function activity_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -60,6 +61,7 @@ function activity_get_expectedresult() {
         'is_auto' => 0,
         'is_current_revision' => '1',
         'is_deleted' => 0,
+        'is_star' => 0,
         'source_contact_id' => '1',
       ),
     ),
index eeb99152c94aeabb8d652b1c3b8b2f6d2b5e5f09..f7052bc2aaf522bcfcfb72769808c733a8f59c97 100644 (file)
@@ -22,7 +22,8 @@ function activity_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -59,6 +60,7 @@ function activity_get_expectedresult() {
         'is_auto' => 0,
         'is_current_revision' => '1',
         'is_deleted' => 0,
+        'is_star' => 0,
         'source_contact_id' => '1',
       ),
     ),
index f8c5be72ba5854ae560d2f4dec74d78d81c9e9c9..f2e9bbfa5772a191742552a0e80c8a326f3a4626 100644 (file)
@@ -19,7 +19,8 @@ function activity_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 343a07b19dc8df4a8fd465a71ad08f0bb619c1e6..ac52fab2604d9ab8efdcc7057f377262d7ac40d0 100644 (file)
@@ -22,7 +22,8 @@ function activity_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 746daa6e407689ddfbf87c676c56f5191d06dfe9..a6269d125a82742fe69910bd8cfd96fa8015de5c 100644 (file)
@@ -19,7 +19,8 @@ function activity_getfields_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -39,17 +40,19 @@ function activity_getfields_expectedresult() {
   $expectedResult = array(
     'is_error' => 0,
     'version' => 3,
-    'count' => 27,
+    'count' => 29,
     'values' => array(
       'source_record_id' => array(
         'name' => 'source_record_id',
         'type' => 1,
         'title' => 'Source Record',
+        'description' => 'Artificial FK to original transaction (e.g. contribution) IF it is not an Activity. Table can be figured out through activity_type_id, and further through component registry.',
       ),
       'activity_type_id' => array(
         'name' => 'activity_type_id',
         'type' => 1,
         'title' => 'Activity Type ID',
+        'description' => 'FK to civicrm_option_value.id, that has to be valid, registered activity type.',
         'required' => TRUE,
         'import' => TRUE,
         'where' => 'civicrm_activity.activity_type_id',
@@ -58,15 +61,19 @@ function activity_getfields_expectedresult() {
         'default' => '1',
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'activity_type',
+          'optionEditPath' => 'civicrm/admin/options/activity_type',
         ),
       ),
       'activity_date_time' => array(
         'name' => 'activity_date_time',
         'type' => 12,
         'title' => 'Activity Date',
+        'description' => 'Date and time this activity is scheduled to occur. Formerly named scheduled_date_time.',
         'import' => TRUE,
         'where' => 'civicrm_activity.activity_date_time',
         'headerPattern' => '/(activity.)?date(.time$)?/i',
@@ -79,9 +86,12 @@ function activity_getfields_expectedresult() {
         'name' => 'phone_id',
         'type' => 1,
         'title' => 'Phone (called) ID',
+        'description' => 'Phone ID of the number called (optional - used if an existing phone number is selected).',
         'FKClassName' => 'CRM_Core_DAO_Phone',
         'html' => array(
-          'type' => 'Autocomplete-Select',
+          'type' => 'EntityRef',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'FKApiName' => 'Phone',
       ),
@@ -89,27 +99,35 @@ function activity_getfields_expectedresult() {
         'name' => 'phone_number',
         'type' => 2,
         'title' => 'Phone (called) Number',
+        'description' => 'Phone number in case the number does not exist in the civicrm_phone table.',
         'maxlength' => 64,
         'size' => 30,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 64,
+          'size' => 30,
         ),
       ),
       'priority_id' => array(
         'name' => 'priority_id',
         'type' => 1,
         'title' => 'Priority',
+        'description' => 'ID of the priority given to this activity. Foreign key to civicrm_option_value.',
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'priority',
+          'optionEditPath' => 'civicrm/admin/options/priority',
         ),
       ),
       'parent_id' => array(
         'name' => 'parent_id',
         'type' => 1,
         'title' => 'Parent Activity Id',
+        'description' => 'Parent meeting ID (if this is a follow-up item). This is not currently implemented',
         'FKClassName' => 'CRM_Activity_DAO_Activity',
         'FKApiName' => 'Activity',
       ),
@@ -122,6 +140,7 @@ function activity_getfields_expectedresult() {
         'name' => 'relationship_id',
         'type' => 1,
         'title' => 'Relationship Id',
+        'description' => 'FK to Relationship ID',
         'default' => 'NULL',
         'FKClassName' => 'CRM_Contact_DAO_Relationship',
         'FKApiName' => 'Relationship',
@@ -143,6 +162,7 @@ function activity_getfields_expectedresult() {
         'name' => 'original_id',
         'type' => 1,
         'title' => 'Original Activity ID ',
+        'description' => 'Activity ID of the first activity record in versioning chain.',
         'FKClassName' => 'CRM_Activity_DAO_Activity',
         'FKApiName' => 'Activity',
       ),
@@ -152,12 +172,25 @@ function activity_getfields_expectedresult() {
         'title' => 'Order',
         'html' => array(
           'type' => 'Text',
+          'size' => 6,
+          'maxlength' => 14,
         ),
       ),
+      'is_star' => array(
+        'name' => 'is_star',
+        'type' => 16,
+        'title' => 'Is Starred',
+        'description' => 'Activity marked as favorite.',
+        'import' => TRUE,
+        'where' => 'civicrm_activity.is_star',
+        'headerPattern' => '/(activity.)?(star|favorite)/i',
+        'export' => TRUE,
+      ),
       'id' => array(
         'name' => 'id',
         'type' => 1,
         'title' => 'Activity ID',
+        'description' => 'Unique  Other Activity ID',
         'required' => TRUE,
         'import' => TRUE,
         'where' => 'civicrm_activity.id',
@@ -171,6 +204,7 @@ function activity_getfields_expectedresult() {
         'name' => 'subject',
         'type' => 2,
         'title' => 'Subject',
+        'description' => 'The subject/purpose/short description of the activity.',
         'maxlength' => 255,
         'size' => 45,
         'import' => TRUE,
@@ -179,6 +213,8 @@ function activity_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 45,
         ),
         'uniqueName' => 'activity_subject',
       ),
@@ -186,12 +222,15 @@ function activity_getfields_expectedresult() {
         'name' => 'duration',
         'type' => 1,
         'title' => 'Duration',
+        'description' => 'Planned or actual duration of activity expressed in minutes. Conglomerate of former duration_hours and duration_minutes.',
         'import' => TRUE,
         'where' => 'civicrm_activity.duration',
         'headerPattern' => '/(activity.)?duration(s)?$/i',
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'uniqueName' => 'activity_duration',
       ),
@@ -199,6 +238,7 @@ function activity_getfields_expectedresult() {
         'name' => 'location',
         'type' => 2,
         'title' => 'Location',
+        'description' => 'Location of the activity (optional, open text).',
         'maxlength' => 255,
         'size' => 45,
         'import' => TRUE,
@@ -207,6 +247,8 @@ function activity_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 45,
         ),
         'uniqueName' => 'activity_location',
       ),
@@ -214,14 +256,15 @@ function activity_getfields_expectedresult() {
         'name' => 'details',
         'type' => 32,
         'title' => 'Details',
-        'rows' => 8,
-        'cols' => 60,
+        'description' => 'Details about the activity (agenda, notes, etc).',
         'import' => TRUE,
         'where' => 'civicrm_activity.details',
         'headerPattern' => '/(activity.)?detail(s)?$/i',
         'export' => TRUE,
         'html' => array(
           'type' => 'RichTextEditor',
+          'rows' => 2,
+          'cols' => 80,
         ),
         'uniqueName' => 'activity_details',
       ),
@@ -229,14 +272,18 @@ function activity_getfields_expectedresult() {
         'name' => 'status_id',
         'type' => 1,
         'title' => 'Activity Status',
+        'description' => 'ID of the status this activity is currently in. Foreign key to civicrm_option_value.',
         'import' => TRUE,
         'where' => 'civicrm_activity.status_id',
         'headerPattern' => '/(activity.)?status(.label$)?/i',
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'activity_status',
+          'optionEditPath' => 'civicrm/admin/options/activity_status',
         ),
         'uniqueName' => 'activity_status_id',
         'api.aliases' => array(
@@ -260,12 +307,16 @@ function activity_getfields_expectedresult() {
         'name' => 'medium_id',
         'type' => 1,
         'title' => 'Activity Medium',
+        'description' => 'Activity Medium, Implicit FK to civicrm_option_value where option_group = encounter_medium.',
         'default' => 'NULL',
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'encounter_medium',
+          'optionEditPath' => 'civicrm/admin/options/encounter_medium',
         ),
         'uniqueName' => 'activity_medium_id',
       ),
@@ -273,10 +324,13 @@ function activity_getfields_expectedresult() {
         'name' => 'result',
         'type' => 2,
         'title' => 'Result',
+        'description' => 'Currently being used to store result id for survey activity, FK to option value.',
         'maxlength' => 255,
         'size' => 45,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 45,
         ),
         'uniqueName' => 'activity_result',
       ),
@@ -297,12 +351,15 @@ function activity_getfields_expectedresult() {
         'name' => 'campaign_id',
         'type' => 1,
         'title' => 'Campaign',
+        'description' => 'The campaign for which this activity has been triggered.',
         'import' => TRUE,
         'where' => 'civicrm_activity.campaign_id',
         'export' => TRUE,
         'FKClassName' => 'CRM_Campaign_DAO_Campaign',
         'html' => array(
           'type' => 'CheckBox',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'table' => 'civicrm_campaign',
@@ -316,35 +373,53 @@ function activity_getfields_expectedresult() {
         'name' => 'engagement_level',
         'type' => 1,
         'title' => 'Engagement Index',
+        'description' => 'Assign a specific level of engagement to this activity. Used for tracking constituents in ladder of engagement.',
         'import' => TRUE,
         'where' => 'civicrm_activity.engagement_level',
         'export' => TRUE,
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'engagement_index',
+          'optionEditPath' => 'civicrm/admin/options/engagement_index',
         ),
         'uniqueName' => 'activity_engagement_level',
       ),
       'source_contact_id' => array(
         'name' => 'source_contact_id',
         'title' => 'Activity Source Contact',
+        'description' => 'Person who created this activity. Defaults to current user.',
         'type' => 1,
-        'FKClassName' => 'CRM_Activity_DAO_ActivityContact',
+        'FKClassName' => 'CRM_Contact_DAO_Contact',
         'api.default' => 'user_contact_id',
+        'FKApiName' => 'Contact',
       ),
       'assignee_contact_id' => array(
         'name' => 'assignee_id',
-        'title' => 'assigned to',
+        'title' => 'Activity Assignee',
+        'description' => 'Contact(s) assigned to this activity.',
         'type' => 1,
-        'FKClassName' => 'CRM_Activity_DAO_ActivityContact',
+        'FKClassName' => 'CRM_Contact_DAO_Contact',
+        'FKApiName' => 'Contact',
       ),
       'target_contact_id' => array(
         'name' => 'target_id',
         'title' => 'Activity Target',
+        'description' => 'Contact(s) participating in this activity.',
+        'type' => 1,
+        'FKClassName' => 'CRM_Contact_DAO_Contact',
+        'FKApiName' => 'Contact',
+      ),
+      'case_id' => array(
+        'name' => 'case_id',
+        'title' => 'Case ID',
+        'description' => 'For creating an activity as part of a case.',
         'type' => 1,
-        'FKClassName' => 'CRM_Activity_DAO_ActivityContact',
+        'FKClassName' => 'CRM_Case_DAO_Case',
+        'FKApiName' => 'Case',
       ),
     ),
   );
index 924922bb68b71a6d858854fb44ff94228bb2933e..c225c8d38e6afefb6e4b925bcfc7bc631de898f2 100644 (file)
@@ -31,7 +31,8 @@ function activity_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -79,6 +80,7 @@ function activity_create_expectedresult() {
         'campaign_id' => '',
         'engagement_level' => '',
         'weight' => '',
+        'is_star' => '',
       ),
     ),
   );
index 8601802533af841bd3d5b2b433e75ea103f35b52..77b45f7bbbce1204e447491bc1bdc0a560e41c5c 100644 (file)
@@ -11,10 +11,10 @@ function activity_getsingle_example() {
   $params = array(
     'id' => 1,
     'return' => array(
-      'subject',
-      'source_contact_name',
-      'target_contact_name',
-      'assignee_contact_name',
+      '0' => 'source_contact_name',
+      '1' => 'target_contact_name',
+      '2' => 'assignee_contact_name',
+      '3' => 'subject',
     ),
   );
 
index 545793076c86c0996a92ffb464ee6fe1bfaf961b..574a34a7b27cbf6859706b4e56e45f831e50920c 100644 (file)
@@ -26,7 +26,8 @@ function activity_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -63,6 +64,7 @@ function activity_get_expectedresult() {
         'is_auto' => 0,
         'is_current_revision' => '1',
         'is_deleted' => 0,
+        'is_star' => 0,
         'assignee_contact_id' => array(
           '0' => '3',
         ),
index 5a0a7cb64a74e063973c6cdc5960103d91b7b01c..f01e72a52181c7a301fffb15ad78fe800657d89d 100644 (file)
@@ -21,7 +21,8 @@ function activity_contact_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 7920498221c31f6a90e42f6322cdc53d47d98cc2..d627dcac85413d74a223752e81b2d137620e829b 100644 (file)
@@ -19,7 +19,8 @@ function activity_contact_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 3fb68a21a6befe230295d06b532660a709f715d1..ac5da5ced8f491528a8f30fffd2034132ef297ef 100644 (file)
@@ -27,7 +27,8 @@ function activity_type_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index b6e93f75a9e553fe1d847b75280d4a36425f732a..a2158500c1a15e8560c2107d1af44ecdc46117bd 100644 (file)
@@ -20,7 +20,8 @@ function activity_type_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -63,7 +64,7 @@ function activity_type_get_expectedresult() {
       '19' => 'Bulk Email',
       '20' => 'Assign Case Role',
       '21' => 'Remove Case Role',
-      '22' => 'Print PDF Letter',
+      '22' => 'Print/Merge Document',
       '23' => 'Merge Case',
       '24' => 'Reassigned Case',
       '25' => 'Link Cases',
@@ -92,6 +93,10 @@ function activity_type_get_expectedresult() {
       '48' => 'Change Registration',
       '49' => 'Downloaded Invoice',
       '50' => 'Emailed Invoice',
+      '51' => 'Contact Merged',
+      '52' => 'Contact Deleted by Merge',
+      '53' => 'Failed Payment',
+      '54' => 'Close Accounting Period',
     ),
     'deprecated' => 'The ActivityType api is deprecated. Please use the OptionValue api instead.',
   );
index 87d490a69b8cf02dbad02b28da58a0f2515c3d70..74d0da4545e46e2d10a8ed86a4512320be175c94 100644 (file)
@@ -24,7 +24,8 @@ function address_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 4fb7dabc7c93f2433e58ffb73884be3acbeda727..329f7c071da63ea3c28d720173979d1e84148c09 100644 (file)
@@ -24,7 +24,8 @@ function address_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index f8f82481d3ddd8829222c22b920a8b5b13a1eec1..de36d5b903f57a688a3580acecdb8fde1ac3f837 100644 (file)
@@ -25,7 +25,8 @@ function address_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 222a81ca509b8af20c640405374a867e6f1736f6..cabd73c7be8b026575fadb53aab244abf2f86203 100644 (file)
@@ -27,7 +27,8 @@ function address_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 993b11f91f8d2596bdba2f50ec0f4b372a870966..09e586766976700983dda9fd6b39882b64c54cff 100644 (file)
@@ -19,7 +19,8 @@ function address_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function address_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index a06342e1440fb4004d3b271495168504ce111758..f19315e08536129f62193d83e50116f0e2e2460e 100644 (file)
@@ -20,7 +20,8 @@ function address_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index cfa88f405241a5f0916fdf2faf54890b8ec63ecd..436b1e475a7c89c79109180d2cf52eca15124851 100644 (file)
@@ -19,7 +19,8 @@ function address_getoptions_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index c5d8f447af8972a4ca1e7fc70e04dc5342aed57d..6b4c9f19910b7d87337cb2fb3f02ba220bfb10eb 100644 (file)
@@ -24,7 +24,8 @@ function batch_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index b97d5573b65dec5d8b01fa0095b864247051ae4f..bed04ab9bdb5cf787c120d8a304815a352290f69 100644 (file)
@@ -19,7 +19,8 @@ function batch_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index a0548bcaac1a1befed0b14ee896b1cbf25d878b5..9deff39a48664ef73c0eb72d6e42237444f3eb61 100644 (file)
@@ -19,7 +19,8 @@ function batch_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index ce04e6da89705aecac98ba2fdea5bcf96e467e84..86f1df29d11342da66dc56d709d3b6426f4dcae2 100644 (file)
@@ -24,7 +24,8 @@ function campaign_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index cff0043eb3469d1619967dff77cf542af0c8fdba..d6b5fd5eaea09b71089f8d7a227ffbb1c31aae8a 100644 (file)
@@ -19,7 +19,8 @@ function campaign_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function campaign_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index bfb051e1ba11f7b5a0120447db7e81d939e00e5b..afad3b080a156bb9dd26a9f9218c3c5e2d1ad2ea 100644 (file)
@@ -21,7 +21,8 @@ function campaign_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 6bdab33e37a849e92b3a9f73fd5776a8a7b3c95e..bfffed40bb9672fd2725074f64366e75ba7e1ac9 100644 (file)
@@ -21,7 +21,8 @@ function case_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
diff --git a/api/v3/examples/CaseContact/Get.php b/api/v3/examples/CaseContact/Get.php
new file mode 100644 (file)
index 0000000..b4070df
--- /dev/null
@@ -0,0 +1,77 @@
+<?php
+/**
+ * Test Generated example demonstrating the CaseContact.get API.
+ *
+ * @return array
+ *   API result array
+ */
+function case_contact_get_example() {
+  $params = array(
+    'contact_id' => 19,
+  );
+
+  try{
+    $result = civicrm_api3('CaseContact', 'get', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function case_contact_get_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 2,
+    'values' => array(
+      '2' => array(
+        'id' => '2',
+        'case_id' => '2',
+        'contact_id' => '19',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCaseContactGet"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CaseContactTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
index 8655d1aad7bf6f68399ebaa56ad107339304ebf7..a6c11087a0d3d0422064ff1c45469894c85443d5 100644 (file)
@@ -22,7 +22,8 @@ function constant_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -58,7 +59,7 @@ function constant_get_expectedresult() {
       '12' => 'Inbound Email',
       '17' => 'Membership Renewal Reminder',
       '19' => 'Bulk Email',
-      '22' => 'Print PDF Letter',
+      '22' => 'Print/Merge Document',
       '34' => 'Mass SMS',
       '35' => 'Change Membership Status',
       '36' => 'Change Membership Type',
@@ -76,6 +77,10 @@ function constant_get_expectedresult() {
       '48' => 'Change Registration',
       '49' => 'Downloaded Invoice',
       '50' => 'Emailed Invoice',
+      '51' => 'Contact Merged',
+      '52' => 'Contact Deleted by Merge',
+      '53' => 'Failed Payment',
+      '54' => 'Close Accounting Period',
     ),
     'deprecated' => 'The Constant api is deprecated as of CiviCRM 4.4. Please use the getoptions api action instead.',
   );
index fe8e67a331905c077e577e045a42f40791d0c9ac..839b99005e172748227e91375573100ec4d88a9b 100644 (file)
@@ -28,7 +28,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 38792cba7c4582dc316097645ce43d2479351580..c79c27a426c837154073ac7659f748591ba201cd 100644 (file)
@@ -29,7 +29,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 92ca2e0a00d990170bf4f0cb01dd4188092e0a1d..c484a896c663c5a18fdc8d37e9f48211d126c4de 100644 (file)
@@ -26,7 +26,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 55a690da3153db64d7501f7b3ac62bb71ebb945f..a1b3a68db3a1721f2dca340b08e04a156e4bff21 100644 (file)
@@ -31,7 +31,8 @@ function contact_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -66,7 +67,7 @@ function contact_create_expectedresult() {
         'is_opt_out' => 0,
         'legal_identifier' => '',
         'external_identifier' => '',
-        'sort_name' => '',
+        'sort_name' => 'batman',
         'display_name' => 'batman',
         'nick_name' => '',
         'legal_name' => '',
index e2153adfd5973303a9235e38b87fc2e0b1653d6f..8d2a4d3ff54de1e53f0e156b03063f5d053680a9 100644 (file)
@@ -43,7 +43,8 @@ function contact_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -151,6 +152,7 @@ function contact_create_expectedresult() {
               'campaign_id' => '',
               'creditnote_id' => '',
               'tax_amount' => '',
+              'revenue_recognition_date' => '',
               'contribution_type_id' => '1',
             ),
           ),
index f17f204a2cfe4bf7d607e1fc8ec1924d89ef91ba..99e6a75588898ffd55ad09393087a6c2518043a6 100644 (file)
@@ -46,7 +46,8 @@ function contact_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -154,6 +155,7 @@ function contact_create_expectedresult() {
               'campaign_id' => '',
               'creditnote_id' => '',
               'tax_amount' => '',
+              'revenue_recognition_date' => '',
               'contribution_type_id' => '1',
             ),
           ),
index 5720faef5542269eac2d251732575c324d6594a3..9e0392a4dcdb1eecd8c33bce6f21231fd5814f54 100644 (file)
@@ -24,7 +24,8 @@ function contact_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 6dc057cffdf355ce185199c8d76ae8c51074789c..ac3e7b3ab680e3b414474c874456e90bda1c4a96 100644 (file)
@@ -22,7 +22,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 3e2ac2ee3a831fbec60fc945107735d90df6b9d9..d5ac755842aa09050b34466c93581fc091e805cd 100644 (file)
@@ -22,7 +22,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 47571b5dda14e1d952952e9ccadac3274d8c18ea..bfb4f9976e7ee61789f5316fa1b3d39138ec0f44 100644 (file)
@@ -19,7 +19,8 @@ function contact_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 6f342d00ed8d96dac0182b85c983b336d2a821e3..add6872f4b45d646e1365b51fb272edf898ea0a3 100644 (file)
@@ -23,7 +23,8 @@ function contact_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 09a9febca027252f1a5dd35ae87298bdaf632c00..9f46af903faf70d2429e118210937560d612844b 100644 (file)
@@ -23,7 +23,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index fa74cbafd61689f04894f992ca15830004c87d05..e208faeddb88d9c5d656e4072543b98202cd9d07 100644 (file)
@@ -24,7 +24,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 5dea4811170e4ef8c7e82aae20d637bd713758cf..49d52becc1b09f9dd70fffe023c5acdf0d55441a 100644 (file)
@@ -24,7 +24,8 @@ function contact_getvalue_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 79be6cea475214bb6026c5583cfbb17e6783aabe..fb2556c9f48cc35b58d955ab7eaa89bbfbecb95b 100644 (file)
@@ -19,7 +19,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 12012f6949561078daff496d4ebf1d5f543b0717..d2c85713ed1ceecc4735db3475a133f495667b2a 100644 (file)
@@ -19,7 +19,8 @@ function contact_getactions_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -39,31 +40,33 @@ function contact_getactions_expectedresult() {
   $expectedResult = array(
     'is_error' => 0,
     'version' => 3,
-    'count' => 23,
+    'count' => 25,
     'values' => array(
       '0' => 'create',
       '1' => 'delete',
-      '2' => 'example_action1',
-      '3' => 'example_action2',
-      '4' => 'get',
-      '5' => 'getactions',
-      '6' => 'getcount',
-      '7' => 'getfields',
-      '8' => 'getlist',
-      '9' => 'getoptions',
-      '10' => 'getquick',
-      '11' => 'getrefcount',
-      '12' => 'getsingle',
-      '13' => 'getstat',
-      '14' => 'getvalue',
-      '15' => 'merge',
-      '16' => 'proximity',
-      '17' => 'replace',
-      '18' => 'setvalue',
-      '19' => 'type_create',
-      '20' => 'type_delete',
-      '21' => 'type_get',
-      '22' => 'update',
+      '2' => 'duplicatecheck',
+      '3' => 'example_action1',
+      '4' => 'example_action2',
+      '5' => 'get',
+      '6' => 'getactions',
+      '7' => 'getcount',
+      '8' => 'getfield',
+      '9' => 'getfields',
+      '10' => 'getlist',
+      '11' => 'getoptions',
+      '12' => 'getquick',
+      '13' => 'getrefcount',
+      '14' => 'getsingle',
+      '15' => 'getvalue',
+      '16' => 'merge',
+      '17' => 'proximity',
+      '18' => 'replace',
+      '19' => 'setvalue',
+      '20' => 'type_create',
+      '21' => 'type_delete',
+      '22' => 'type_get',
+      '23' => 'update',
+      '24' => 'validate',
     ),
     'deprecated' => array(
       'getquick' => 'The "getquick" action is deprecated in favor of "getlist".',
index 724616b3e58532675a86e7dca30d8c7c9fed1076..7a775e80f202e06768ba46ebbb40d838e1ff2784 100644 (file)
@@ -22,7 +22,8 @@ function contact_getcount_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 2b10ae16bfb1621b2864ba0b12d50386a2e56457..a366b409581927430b2af1fc223f863acd32e78b 100644 (file)
@@ -24,7 +24,8 @@ function contact_getfields_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -49,7 +50,8 @@ function contact_getfields_expectedresult() {
       'id' => array(
         'name' => 'id',
         'type' => 1,
-        'title' => 'Internal Contact ID',
+        'title' => 'Contact ID',
+        'description' => 'Unique Contact ID',
         'required' => TRUE,
         'import' => TRUE,
         'where' => 'civicrm_contact.id',
@@ -63,12 +65,15 @@ function contact_getfields_expectedresult() {
         'name' => 'contact_type',
         'type' => 2,
         'title' => 'Contact Type',
+        'description' => 'Type of Contact.',
         'maxlength' => 64,
         'size' => 30,
         'export' => TRUE,
         'where' => 'civicrm_contact.contact_type',
         'html' => array(
           'type' => 'Select',
+          'maxlength' => 64,
+          'size' => 30,
         ),
         'pseudoconstant' => array(
           'table' => 'civicrm_contact_type',
@@ -82,6 +87,7 @@ function contact_getfields_expectedresult() {
         'name' => 'contact_sub_type',
         'type' => 2,
         'title' => 'Contact Subtype',
+        'description' => 'May be used to over-ride contact view and edit templates.',
         'maxlength' => 255,
         'size' => 45,
         'import' => TRUE,
@@ -89,7 +95,9 @@ function contact_getfields_expectedresult() {
         'headerPattern' => '/C(ontact )?(subtype|sub-type|sub type)/i',
         'export' => TRUE,
         'html' => array(
-          'type' => 'Multi-Select',
+          'type' => 'Select',
+          'maxlength' => 255,
+          'size' => 45,
         ),
         'pseudoconstant' => array(
           'table' => 'civicrm_contact_type',
@@ -167,6 +175,7 @@ function contact_getfields_expectedresult() {
         'name' => 'is_opt_out',
         'type' => 16,
         'title' => 'No Bulk Emails (User Opt Out)',
+        'description' => 'Has the contact opted out from receiving all bulk email from the organization or site domain?',
         'required' => TRUE,
         'import' => TRUE,
         'where' => 'civicrm_contact.is_opt_out',
@@ -179,6 +188,8 @@ function contact_getfields_expectedresult() {
         'name' => 'legal_identifier',
         'type' => 2,
         'title' => 'Legal Identifier',
+        'description' => 'May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID.
+    ',
         'maxlength' => 32,
         'size' => 20,
         'import' => TRUE,
@@ -188,12 +199,15 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 32,
+          'size' => 20,
         ),
       ),
       'external_identifier' => array(
         'name' => 'external_identifier',
         'type' => 2,
         'title' => 'External Identifier',
+        'description' => 'Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations.',
         'maxlength' => 64,
         'size' => 8,
         'import' => TRUE,
@@ -203,36 +217,45 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 64,
+          'size' => 8,
         ),
       ),
       'sort_name' => array(
         'name' => 'sort_name',
         'type' => 2,
         'title' => 'Sort Name',
+        'description' => 'Name used for sorting different contact types',
         'maxlength' => 128,
         'size' => 30,
         'export' => TRUE,
         'where' => 'civicrm_contact.sort_name',
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 30,
         ),
       ),
       'display_name' => array(
         'name' => 'display_name',
         'type' => 2,
         'title' => 'Display Name',
+        'description' => 'Formatted name representing preferred format for display/print/other output.',
         'maxlength' => 128,
         'size' => 30,
         'export' => TRUE,
         'where' => 'civicrm_contact.display_name',
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 30,
         ),
       ),
       'nick_name' => array(
         'name' => 'nick_name',
         'type' => 2,
         'title' => 'Nickname',
+        'description' => 'Nickname.',
         'maxlength' => 128,
         'size' => 30,
         'import' => TRUE,
@@ -242,12 +265,15 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 30,
         ),
       ),
       'legal_name' => array(
         'name' => 'legal_name',
         'type' => 2,
         'title' => 'Legal Name',
+        'description' => 'Legal Name.',
         'maxlength' => 128,
         'size' => 30,
         'import' => TRUE,
@@ -256,25 +282,29 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 30,
         ),
       ),
       'image_URL' => array(
         'name' => 'image_URL',
-        'type' => 2,
+        'type' => 32,
         'title' => 'Image Url',
-        'maxlength' => 255,
-        'size' => 45,
+        'description' => 'optional URL for preferred image (photo, logo, etc.) to display for this contact.',
         'import' => TRUE,
         'where' => 'civicrm_contact.image_URL',
         'export' => TRUE,
         'html' => array(
-          'type' => 'Text',
+          'type' => 'File',
+          'rows' => 2,
+          'cols' => 80,
         ),
       ),
       'preferred_communication_method' => array(
         'name' => 'preferred_communication_method',
         'type' => 2,
         'title' => 'Preferred Communication Method',
+        'description' => 'What is the preferred mode of communication.',
         'maxlength' => 255,
         'size' => 45,
         'import' => TRUE,
@@ -284,15 +314,19 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Select',
+          'maxlength' => 255,
+          'size' => 45,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'preferred_communication_method',
+          'optionEditPath' => 'civicrm/admin/options/preferred_communication_method',
         ),
       ),
       'preferred_language' => array(
         'name' => 'preferred_language',
         'type' => 2,
         'title' => 'Preferred Language',
+        'description' => 'Which language is preferred for communication. FK to languages in civicrm_option_value.',
         'maxlength' => 5,
         'size' => 6,
         'import' => TRUE,
@@ -301,16 +335,20 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Select',
+          'maxlength' => 5,
+          'size' => 6,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'languages',
           'keyColumn' => 'name',
+          'optionEditPath' => 'civicrm/admin/options/languages',
         ),
       ),
       'preferred_mail_format' => array(
         'name' => 'preferred_mail_format',
         'type' => 2,
         'title' => 'Preferred Mail Format',
+        'description' => 'What is the preferred mode of sending an email.',
         'maxlength' => 8,
         'size' => 8,
         'import' => TRUE,
@@ -320,6 +358,8 @@ function contact_getfields_expectedresult() {
         'default' => 'Both',
         'html' => array(
           'type' => 'Select',
+          'maxlength' => 8,
+          'size' => 8,
         ),
         'pseudoconstant' => array(
           'callback' => 'CRM_Core_SelectValues::pmf',
@@ -329,6 +369,7 @@ function contact_getfields_expectedresult() {
         'name' => 'hash',
         'type' => 2,
         'title' => 'Contact Hash',
+        'description' => 'Key for validating requests related to this contact.',
         'maxlength' => 32,
         'size' => 20,
         'export' => TRUE,
@@ -338,6 +379,7 @@ function contact_getfields_expectedresult() {
         'name' => 'api_key',
         'type' => 2,
         'title' => 'Api Key',
+        'description' => 'API Key for validating requests related to this contact.',
         'maxlength' => 32,
         'size' => 20,
       ),
@@ -345,6 +387,7 @@ function contact_getfields_expectedresult() {
         'name' => 'first_name',
         'type' => 2,
         'title' => 'First Name',
+        'description' => 'First Name.',
         'maxlength' => 64,
         'size' => 30,
         'import' => TRUE,
@@ -354,14 +397,17 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 64,
+          'size' => 30,
         ),
       ),
       'middle_name' => array(
         'name' => 'middle_name',
         'type' => 2,
         'title' => 'Middle Name',
+        'description' => 'Middle Name.',
         'maxlength' => 64,
-        'size' => 20,
+        'size' => 30,
         'import' => TRUE,
         'where' => 'civicrm_contact.middle_name',
         'headerPattern' => '/^middle|(m(iddle\\s)?name)$/i',
@@ -369,12 +415,15 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 64,
+          'size' => 30,
         ),
       ),
       'last_name' => array(
         'name' => 'last_name',
         'type' => 2,
         'title' => 'Last Name',
+        'description' => 'Last Name.',
         'maxlength' => 64,
         'size' => 30,
         'import' => TRUE,
@@ -384,12 +433,15 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 64,
+          'size' => 30,
         ),
       ),
       'prefix_id' => array(
         'name' => 'prefix_id',
         'type' => 1,
         'title' => 'Individual Prefix',
+        'description' => 'Prefix or Title for name (Ms, Mr...). FK to prefix ID',
         'import' => TRUE,
         'where' => 'civicrm_contact.prefix_id',
         'headerPattern' => '/^(prefix|title)/i',
@@ -397,9 +449,12 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'individual_prefix',
+          'optionEditPath' => 'civicrm/admin/options/individual_prefix',
         ),
         'api.aliases' => array(
           '0' => 'individual_prefix',
@@ -410,6 +465,7 @@ function contact_getfields_expectedresult() {
         'name' => 'suffix_id',
         'type' => 1,
         'title' => 'Individual Suffix',
+        'description' => 'Suffix for name (Jr, Sr...). FK to suffix ID',
         'import' => TRUE,
         'where' => 'civicrm_contact.suffix_id',
         'headerPattern' => '/^suffix$/i',
@@ -417,9 +473,12 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'individual_suffix',
+          'optionEditPath' => 'civicrm/admin/options/individual_suffix',
         ),
         'api.aliases' => array(
           '0' => 'individual_suffix',
@@ -430,113 +489,150 @@ function contact_getfields_expectedresult() {
         'name' => 'formal_title',
         'type' => 2,
         'title' => 'Formal Title',
+        'description' => 'Formal (academic or similar) title in front of name. (Prof., Dr. etc.)',
         'maxlength' => 64,
         'size' => 30,
         'import' => TRUE,
         'where' => 'civicrm_contact.formal_title',
         'headerPattern' => '/^title/i',
         'export' => TRUE,
+        'html' => array(
+          'type' => 'Text',
+          'maxlength' => 64,
+          'size' => 30,
+        ),
       ),
       'communication_style_id' => array(
         'name' => 'communication_style_id',
         'type' => 1,
         'title' => 'Communication Style',
+        'description' => 'Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value.',
         'export' => TRUE,
         'where' => 'civicrm_contact.communication_style_id',
+        'html' => array(
+          'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
+        ),
         'pseudoconstant' => array(
           'optionGroupName' => 'communication_style',
+          'optionEditPath' => 'civicrm/admin/options/communication_style',
         ),
       ),
       'email_greeting_id' => array(
         'name' => 'email_greeting_id',
         'type' => 1,
         'title' => 'Email Greeting ID',
+        'description' => 'FK to civicrm_option_value.id, that has to be valid registered Email Greeting.',
       ),
       'email_greeting_custom' => array(
         'name' => 'email_greeting_custom',
         'type' => 2,
         'title' => 'Email Greeting Custom',
+        'description' => 'Custom Email Greeting.',
         'maxlength' => 128,
         'size' => 45,
         'import' => TRUE,
         'where' => 'civicrm_contact.email_greeting_custom',
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 45,
         ),
       ),
       'email_greeting_display' => array(
         'name' => 'email_greeting_display',
         'type' => 2,
         'title' => 'Email Greeting',
+        'description' => 'Cache Email Greeting.',
         'maxlength' => 255,
         'size' => 45,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 45,
         ),
       ),
       'postal_greeting_id' => array(
         'name' => 'postal_greeting_id',
         'type' => 1,
         'title' => 'Postal Greeting ID',
+        'description' => 'FK to civicrm_option_value.id, that has to be valid registered Postal Greeting.',
         'html' => array(
           'type' => 'Text',
+          'size' => 6,
+          'maxlength' => 14,
         ),
       ),
       'postal_greeting_custom' => array(
         'name' => 'postal_greeting_custom',
         'type' => 2,
         'title' => 'Postal Greeting Custom',
+        'description' => 'Custom Postal greeting.',
         'maxlength' => 128,
         'size' => 45,
         'import' => TRUE,
         'where' => 'civicrm_contact.postal_greeting_custom',
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 45,
         ),
       ),
       'postal_greeting_display' => array(
         'name' => 'postal_greeting_display',
         'type' => 2,
         'title' => 'Postal Greeting',
+        'description' => 'Cache Postal greeting.',
         'maxlength' => 255,
         'size' => 45,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 45,
         ),
       ),
       'addressee_id' => array(
         'name' => 'addressee_id',
         'type' => 1,
         'title' => 'Addressee ID',
+        'description' => 'FK to civicrm_option_value.id, that has to be valid registered Addressee.',
       ),
       'addressee_custom' => array(
         'name' => 'addressee_custom',
         'type' => 2,
         'title' => 'Addressee Custom',
+        'description' => 'Custom Addressee.',
         'maxlength' => 128,
         'size' => 45,
         'import' => TRUE,
         'where' => 'civicrm_contact.addressee_custom',
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 45,
         ),
       ),
       'addressee_display' => array(
         'name' => 'addressee_display',
         'type' => 2,
         'title' => 'Addressee',
+        'description' => 'Cache Addressee.',
         'maxlength' => 255,
         'size' => 45,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 45,
         ),
       ),
       'job_title' => array(
         'name' => 'job_title',
         'type' => 2,
         'title' => 'Job Title',
+        'description' => 'Job Title',
         'maxlength' => 255,
-        'size' => 20,
+        'size' => 30,
         'import' => TRUE,
         'where' => 'civicrm_contact.job_title',
         'headerPattern' => '/^job|(j(ob\\s)?title)$/i',
@@ -544,27 +640,37 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 30,
         ),
       ),
       'gender_id' => array(
         'name' => 'gender_id',
         'type' => 1,
         'title' => 'Gender',
+        'description' => 'FK to gender ID',
         'import' => TRUE,
         'where' => 'civicrm_contact.gender_id',
         'headerPattern' => '/^gender$/i',
         'export' => TRUE,
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'pseudoconstant' => array(
           'optionGroupName' => 'gender',
+          'optionEditPath' => 'civicrm/admin/options/gender',
+        ),
+        'api.aliases' => array(
+          '0' => 'gender',
         ),
       ),
       'birth_date' => array(
         'name' => 'birth_date',
         'type' => 4,
         'title' => 'Birth Date',
+        'description' => 'Date of birth',
         'import' => TRUE,
         'where' => 'civicrm_contact.birth_date',
         'headerPattern' => '/^birth|(b(irth\\s)?date)|D(\\W*)O(\\W*)B(\\W*)$/i',
@@ -590,6 +696,7 @@ function contact_getfields_expectedresult() {
         'name' => 'deceased_date',
         'type' => 4,
         'title' => 'Deceased Date',
+        'description' => 'Date of deceased',
         'import' => TRUE,
         'where' => 'civicrm_contact.deceased_date',
         'headerPattern' => '/^deceased|(d(eceased\\s)?date)$/i',
@@ -602,6 +709,7 @@ function contact_getfields_expectedresult() {
         'name' => 'household_name',
         'type' => 2,
         'title' => 'Household Name',
+        'description' => 'Household Name.',
         'maxlength' => 128,
         'size' => 30,
         'import' => TRUE,
@@ -611,15 +719,20 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 30,
         ),
       ),
       'primary_contact_id' => array(
         'name' => 'primary_contact_id',
         'type' => 1,
         'title' => 'Household Primary Contact ID',
+        'description' => 'Optional FK to Primary Contact for this household.',
         'FKClassName' => 'CRM_Contact_DAO_Contact',
         'html' => array(
           'type' => 'Select',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'FKApiName' => 'Contact',
       ),
@@ -627,6 +740,7 @@ function contact_getfields_expectedresult() {
         'name' => 'organization_name',
         'type' => 2,
         'title' => 'Organization Name',
+        'description' => 'Organization Name.',
         'maxlength' => 128,
         'size' => 30,
         'import' => TRUE,
@@ -636,12 +750,15 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 128,
+          'size' => 30,
         ),
       ),
       'sic_code' => array(
         'name' => 'sic_code',
         'type' => 2,
         'title' => 'Sic Code',
+        'description' => 'Standard Industry Classification Code.',
         'maxlength' => 8,
         'size' => 8,
         'import' => TRUE,
@@ -650,12 +767,15 @@ function contact_getfields_expectedresult() {
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 8,
+          'size' => 8,
         ),
       ),
       'user_unique_id' => array(
         'name' => 'user_unique_id',
         'type' => 2,
         'title' => 'Unique ID (OpenID)',
+        'description' => 'the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM',
         'maxlength' => 255,
         'size' => 45,
         'import' => TRUE,
@@ -666,12 +786,15 @@ function contact_getfields_expectedresult() {
         'rule' => 'url',
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 45,
         ),
       ),
       'created_date' => array(
         'name' => 'created_date',
         'type' => 256,
         'title' => 'Created Date',
+        'description' => 'When was the contact was created.',
         'required' => '',
         'export' => TRUE,
         'where' => 'civicrm_contact.created_date',
@@ -681,6 +804,7 @@ function contact_getfields_expectedresult() {
         'name' => 'modified_date',
         'type' => 256,
         'title' => 'Modified Date',
+        'description' => 'When was the contact (or closely related entity) was created or modified or deleted.',
         'required' => '',
         'export' => TRUE,
         'where' => 'civicrm_contact.modified_date',
@@ -690,26 +814,32 @@ function contact_getfields_expectedresult() {
         'name' => 'source',
         'type' => 2,
         'title' => 'Contact Source',
+        'description' => 'where contact come from, e.g. import, donate module insert...',
         'maxlength' => 255,
         'size' => 30,
         'import' => TRUE,
         'where' => 'civicrm_contact.source',
-        'headerPattern' => '/(S(ource\\s)?o(f\\s)?C(ontact\\s)?Data)$/i',
+        'headerPattern' => '/(C(ontact\\s)?Source)$/i',
         'export' => TRUE,
         'html' => array(
           'type' => 'Text',
+          'maxlength' => 255,
+          'size' => 30,
         ),
         'uniqueName' => 'contact_source',
       ),
       'employer_id' => array(
         'name' => 'employer_id',
         'type' => 1,
-        'title' => 'Current Employer ID',
+        'title' => 'Current Employer',
+        'description' => 'OPTIONAL FK to civicrm_contact record.',
         'export' => TRUE,
         'where' => 'civicrm_contact.employer_id',
         'FKClassName' => 'CRM_Contact_DAO_Contact',
         'html' => array(
-          'type' => 'Autocomplete-Select',
+          'type' => 'EntityRef',
+          'size' => 6,
+          'maxlength' => 14,
         ),
         'uniqueName' => 'current_employer_id',
         'FKApiName' => 'Contact',
@@ -741,10 +871,16 @@ function contact_getfields_expectedresult() {
         'extends_entity_column_id' => '',
         'is_view' => 0,
         'is_multiple' => 0,
-        'option_group_id' => '106',
+        'option_group_id' => '105',
         'date_format' => '',
         'time_format' => '',
         'is_required' => '1',
+        'table_name' => 'civicrm_value_select_test_g_1',
+        'column_name' => 'our_special_field_1',
+        'pseudoconstant' => array(
+          'optionGroupName' => 'our_special_field_20170124082923',
+          'optionEditPath' => 'civicrm/admin/options/our_special_field_20170124082923',
+        ),
         'name' => 'custom_1',
         'title' => 'Our special field',
         'type' => 2,
@@ -762,6 +898,7 @@ function contact_getfields_expectedresult() {
       'dupe_check' => array(
         'title' => 'Check for Duplicates',
         'description' => 'Throw error if contact create matches dedupe rule',
+        'type' => 16,
         'name' => 'dupe_check',
       ),
     ),
index f485f5a400f61302587bf19637f59b7678608646..454f7a78aab8a84480809231796b9f3c88adc65d 100644 (file)
@@ -21,7 +21,8 @@ function contact_getoptions_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 1c202ab54ecb332e1c04b71a82e9e4d460714efa..8df5d1e5af8b817191163576db757f3325f47c2c 100644 (file)
@@ -23,7 +23,8 @@ function contact_getsingle_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index f821db1fc03cc30991c4753208670f5f2fd38547..67fadede7a07462b5e25dedd741c532a5745e1a2 100644 (file)
@@ -25,7 +25,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 549c40bd52ba485c1080c4523c4c122cc2c1321a..47d9fb29d180f5bebda4ecb043dc04da1dad9c3e 100644 (file)
@@ -50,7 +50,8 @@ function contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 3da279757f7ce3d03d77b84461c04f3cbedc7230..bff46b83dedcecba07fae741c0264d5eefd665a7 100644 (file)
@@ -24,7 +24,8 @@ function contribution_page_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -60,6 +61,7 @@ function contribution_page_create_expectedresult() {
         'recur_frequency_unit' => '',
         'is_recur_interval' => '',
         'is_recur_installments' => '',
+        'adjust_recur_start_date' => '',
         'is_pay_later' => '1',
         'pay_later_text' => '',
         'pay_later_receipt' => '',
index d151e916c9ba816ceab59a187a656869e9c88396..b0ffc33052430e6206b92717f63ebe84f75b6ae2 100644 (file)
@@ -19,7 +19,8 @@ function contribution_page_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index fb11aac0f5eee60d1fcf84b7cdd99ca1607af6e2..cc7cd888b2ee99f03f3f9c2184316e9dded66cef 100644 (file)
@@ -21,7 +21,8 @@ function contribution_page_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index c26b197384bd2f1bb1b4749d48fea8de2f6929fb..db56853f5d57ec3f0709b0b2b6aaca621ed5b237 100644 (file)
@@ -41,7 +41,8 @@ function contribution_page_submit_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index be1c2685587a8a790fdafbe1f67840321fbaeda5..fdfac34b8d6d5f96e4fadd77195444241fc966a5 100644 (file)
@@ -26,7 +26,8 @@ function contribution_recur_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -59,10 +60,11 @@ function contribution_recur_create_expectedresult() {
         'installments' => '12',
         'start_date' => '2013-07-29 00:00:00',
         'create_date' => '20120130621222105',
-        'modified_date' => '',
+        'modified_date' => '2012-11-14 16:02:35',
         'cancel_date' => '',
         'end_date' => '',
         'processor_id' => '',
+        'payment_token_id' => '',
         'trxn_id' => '',
         'invoice_id' => '',
         'contribution_status_id' => '1',
index 872109876597ba043700c59bd8c105092a6b6de8..f5b732f6f0f57ee27a320d0aac9214e46cc896a4 100644 (file)
@@ -19,7 +19,8 @@ function contribution_recur_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index df8b9ff1a0d85bf1cf12177ea61cb82e0046cfe6..44defa9acebc329c25359bbe3fc5bd3081c787b3 100644 (file)
@@ -19,7 +19,8 @@ function contribution_recur_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -52,6 +53,7 @@ function contribution_recur_get_expectedresult() {
         'installments' => '12',
         'start_date' => '2013-07-29 00:00:00',
         'create_date' => '20120130621222105',
+        'modified_date' => '2012-11-14 16:02:35',
         'contribution_status_id' => '1',
         'is_test' => 0,
         'cycle_day' => '1',
index d88953f94f17cf8631fbd93f19491134d92028b3..8450990dfc2409e9301cd7079452d8f08f44465b 100644 (file)
@@ -23,7 +23,8 @@ function contribution_soft_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 64dd7b371bd465cfb47deb79e6125d55162a2c73..0a6ccc5508f8a698ca5da3cf291237ed76720813 100644 (file)
@@ -19,7 +19,8 @@ function contribution_soft_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 1cf28d1bf184436f200e41bd120b9b91558091ff..91f49635faf3e6fd11ceeeedb31cb1547ae38343 100644 (file)
@@ -19,7 +19,8 @@ function contribution_soft_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index eb9feefeaec8989f2f89dda16da17df9c26c6688..091baaa5ef9e651c16e848bbc006597c4fc6093a 100644 (file)
@@ -21,7 +21,8 @@ function country_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 5482903bb8c7796cbd671fe3d0bc886a7e5c14b0..a631c34a07baf68d8ab5dd5f2f3a172bd9890482 100644 (file)
@@ -19,7 +19,8 @@ function country_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 5b72473981b7255eaf79303049c4fa69b2b8be65..d1cf00f99cdb3e26c33bc496fb6e63879eadc8de 100644 (file)
@@ -19,7 +19,8 @@ function country_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 3e98f5c8b00d1c00541e49164144898a7773707d..5316d37f6174fc275fa55bf718d61b89908fb945 100644 (file)
@@ -28,7 +28,8 @@ function custom_field_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index df553d692930f4a42360d3ab0effe552a4655d2d..ed130904d7dd57a609e165af3f2bc8dd508ab1a5 100644 (file)
@@ -19,7 +19,8 @@ function custom_field_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index fe3b7e950d48fc140180ddbda01b66b8c2a9ec7d..5a29551feb58b5305612854c46328191138fe97f 100644 (file)
@@ -29,7 +29,8 @@ function custom_group_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 429be45180909d76ca0903b2abfaa57fcc15cb55..db517f083f96f755aeb3080129b7b9eec9c81b55 100644 (file)
@@ -19,7 +19,8 @@ function custom_group_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 6477dd985f247bdadf02b34e0475184f84560d9d..3a8a90a800263c565fd2263108d7b537276c28c9 100644 (file)
@@ -17,7 +17,8 @@ function custom_group_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 0ab3c81451cea484378b5956625c161dfd76f9ce..71fc08495cabf4570c1eb3b0e66ca18a34e14a84 100644 (file)
@@ -22,7 +22,8 @@ function domain_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -50,10 +51,10 @@ function domain_create_expectedresult() {
         'name' => 'A-team domain',
         'description' => 'domain of chaos',
         'config_backend' => '',
-        'version' => '4.2',
         'contact_id' => '6',
         'locales' => '',
         'locale_custom_strings' => '',
+        'domain_version' => '4.2',
       ),
     ),
   );
index f1f753f57d0aec0ed814f199544703292958bc65..00aca938d5a73a973b0e38d54478f753f67d7aea 100644 (file)
@@ -19,7 +19,8 @@ function domain_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -44,8 +45,7 @@ function domain_get_expectedresult() {
       '0' => array(
         'id' => '1',
         'name' => 'Default Domain Name',
-        'config_backend' => 'a:82:{s:18:\"fatalErrorTemplate\";s:20:\"CRM/common/fatal.tpl\";s:15:\"civiRelativeURL\";s:13:\"/index.php?q=\";s:11:\"civiVersion\";s:10:\"4.6.alpha7\";s:11:\"empoweredBy\";b:1;s:10:\"userSystem\";O:26:\"CRM_Utils_System_UnitTests\":5:{s:9:\"is_drupal\";b:0;s:9:\"is_joomla\";b:0;s:12:\"is_wordpress\";b:0;s:19:\"supports_UF_Logging\";b:0;s:24:\"supports_form_extensions\";b:0;}s:11:\"initialized\";i:0;s:15:\"DAOFactoryClass\";s:23:\"CRM_Contact_DAO_Factory\";s:17:\"componentRegistry\";O:18:\"CRM_Core_Component\":0:{}s:9:\"inCiviCRM\";b:0;s:18:\"recaptchaPublicKey\";N;s:5:\"debug\";i:0;s:9:\"backtrace\";i:0;s:12:\"resourceBase\";N;s:13:\"extensionsURL\";N;s:12:\"countryLimit\";a:1:{i:0;s:4:\"1228\";}s:27:\"defaultContactStateProvince\";N;s:13:\"provinceLimit\";a:1:{i:0;s:4:\"1228\";}s:21:\"defaultContactCountry\";s:4:\"1228\";s:15:\"defaultCurrency\";s:3:\"USD\";s:10:\"lcMessages\";s:5:\"en_US\";s:18:\"dateformatDatetime\";s:20:\"%B %E%f, %Y %l:%M %P\";s:14:\"dateformatFull\";s:11:\"%B %E%f, %Y\";s:17:\"dateformatPartial\";s:5:\"%B %Y\";s:14:\"dateformatYear\";s:2:\"%Y\";s:14:\"dateformatTime\";s:8:\"%l:%M %P\";s:15:\"timeInputFormat\";i:1;s:15:\"dateInputFormat\";s:8:\"mm/dd/yy\";s:15:\"fiscalYearStart\";a:2:{s:1:\"M\";i:1;s:1:\"d\";i:1;}s:11:\"moneyformat\";s:5:\"%c %a\";s:16:\"moneyvalueformat\";s:3:\"%!i\";s:15:\"currencySymbols\";s:0:\"\";s:21:\"defaultCurrencySymbol\";s:1:\"$\";s:20:\"monetaryDecimalPoint\";s:1:\".\";s:25:\"monetaryThousandSeparator\";s:1:\",\";s:14:\"gettextCodeset\";s:5:\"utf-8\";s:13:\"gettextDomain\";s:7:\"civicrm\";s:27:\"userFrameworkUsersTableName\";s:5:\"users\";s:21:\"userFrameworkFrontend\";b:0;s:20:\"userFrameworkLogging\";b:0;s:17:\"maxImportFileSize\";i:2097152;s:11:\"maxFileSize\";i:2;s:11:\"mapProvider\";N;s:9:\"mapAPIKey\";N;s:11:\"geoProvider\";N;s:9:\"geoAPIKey\";N;s:13:\"geocodeMethod\";s:0:\"\";s:12:\"mapGeoCoding\";i:1;s:7:\"logging\";b:0;s:16:\"enableComponents\";a:6:{i:0;s:14:\"CiviContribute\";i:1;s:10:\"CiviPledge\";i:2;s:10:\"CiviMember\";i:3;s:9:\"CiviEvent\";i:4;s:8:\"CiviMail\";i:5;s:10:\"CiviReport\";}s:18:\"enableComponentIDs\";a:6:{i:0;i:1;i:1;i:6;i:2;i:2;i:3;i:3;i:4;i:4;i:5;i:8;}s:9:\"enableSSL\";b:0;s:17:\"fatalErrorHandler\";N;s:14:\"legacyEncoding\";s:12:\"Windows-1252\";s:14:\"fieldSeparator\";s:1:\",\";s:17:\"maxLocationBlocks\";i:2;s:15:\"captchaFontPath\";s:25:\"/usr/X11R6/lib/X11/fonts/\";s:11:\"captchaFont\";s:17:\"HelveticaBold.ttf\";s:21:\"includeWildCardInName\";i:1;s:18:\"includeEmailInName\";i:1;s:21:\"includeNickNameInName\";i:0;s:22:\"smartGroupCacheTimeout\";i:5;s:22:\"defaultSearchProfileID\";N;s:21:\"dashboardCacheTimeout\";i:1440;s:15:\"doNotResetCache\";i:0;s:24:\"includeAlphabeticalPager\";i:1;s:20:\"includeOrderByClause\";i:1;s:13:\"oldInputStyle\";i:1;s:14:\"formKeyDisable\";b:0;s:21:\"doNotAttachPDFReceipt\";b:0;s:15:\"wkhtmltopdfPath\";b:0;s:23:\"secondDegRelPermissions\";b:0;s:10:\"wpBasePage\";N;s:9:\"groupTree\";b:0;s:11:\"revampPages\";a:0:{}s:13:\"verpSeparator\";s:1:\".\";s:12:\"mailerPeriod\";i:180;s:16:\"mailerSpoolLimit\";i:0;s:16:\"mailerBatchLimit\";i:0;s:13:\"mailerJobSize\";i:0;s:13:\"mailerJobsMax\";i:0;s:16:\"mailThrottleTime\";i:0;s:12:\"customCSSURL\";N;}',
-        'version' => '3',
+        'version' => '4.6.alpha1',
         'contact_id' => '3',
         'locale_custom_strings' => 'a:1:{s:5:\"en_US\";a:0:{}}',
         'domain_email' => 'my@email.com',
@@ -66,11 +66,11 @@ function domain_get_expectedresult() {
         ),
         'from_email' => 'info@EXAMPLE.ORG',
         'from_name' => 'FIXME',
+        'domain_version' => '4.6.alpha1',
       ),
       '1' => array(
         'id' => '2',
         'name' => 'Second Domain',
-        'config_backend' => 'a:82:{s:18:\"fatalErrorTemplate\";s:20:\"CRM/common/fatal.tpl\";s:15:\"civiRelativeURL\";s:13:\"/index.php?q=\";s:11:\"civiVersion\";s:10:\"4.6.alpha7\";s:11:\"empoweredBy\";b:1;s:10:\"userSystem\";O:26:\"CRM_Utils_System_UnitTests\":5:{s:9:\"is_drupal\";b:0;s:9:\"is_joomla\";b:0;s:12:\"is_wordpress\";b:0;s:19:\"supports_UF_Logging\";b:0;s:24:\"supports_form_extensions\";b:0;}s:11:\"initialized\";i:0;s:15:\"DAOFactoryClass\";s:23:\"CRM_Contact_DAO_Factory\";s:17:\"componentRegistry\";O:18:\"CRM_Core_Component\":0:{}s:9:\"inCiviCRM\";b:0;s:18:\"recaptchaPublicKey\";N;s:5:\"debug\";i:0;s:9:\"backtrace\";i:0;s:12:\"resourceBase\";N;s:13:\"extensionsURL\";N;s:12:\"countryLimit\";a:1:{i:0;s:4:\"1228\";}s:27:\"defaultContactStateProvince\";N;s:13:\"provinceLimit\";a:1:{i:0;s:4:\"1228\";}s:21:\"defaultContactCountry\";s:4:\"1228\";s:15:\"defaultCurrency\";s:3:\"USD\";s:10:\"lcMessages\";s:5:\"en_US\";s:18:\"dateformatDatetime\";s:20:\"%B %E%f, %Y %l:%M %P\";s:14:\"dateformatFull\";s:11:\"%B %E%f, %Y\";s:17:\"dateformatPartial\";s:5:\"%B %Y\";s:14:\"dateformatYear\";s:2:\"%Y\";s:14:\"dateformatTime\";s:8:\"%l:%M %P\";s:15:\"timeInputFormat\";i:1;s:15:\"dateInputFormat\";s:8:\"mm/dd/yy\";s:15:\"fiscalYearStart\";a:2:{s:1:\"M\";i:1;s:1:\"d\";i:1;}s:11:\"moneyformat\";s:5:\"%c %a\";s:16:\"moneyvalueformat\";s:3:\"%!i\";s:15:\"currencySymbols\";s:0:\"\";s:21:\"defaultCurrencySymbol\";s:1:\"$\";s:20:\"monetaryDecimalPoint\";s:1:\".\";s:25:\"monetaryThousandSeparator\";s:1:\",\";s:14:\"gettextCodeset\";s:5:\"utf-8\";s:13:\"gettextDomain\";s:7:\"civicrm\";s:27:\"userFrameworkUsersTableName\";s:5:\"users\";s:21:\"userFrameworkFrontend\";b:0;s:20:\"userFrameworkLogging\";b:0;s:17:\"maxImportFileSize\";i:2097152;s:11:\"maxFileSize\";i:2;s:11:\"mapProvider\";N;s:9:\"mapAPIKey\";N;s:11:\"geoProvider\";N;s:9:\"geoAPIKey\";N;s:13:\"geocodeMethod\";s:0:\"\";s:12:\"mapGeoCoding\";i:1;s:7:\"logging\";b:0;s:16:\"enableComponents\";a:6:{i:0;s:14:\"CiviContribute\";i:1;s:10:\"CiviPledge\";i:2;s:10:\"CiviMember\";i:3;s:9:\"CiviEvent\";i:4;s:8:\"CiviMail\";i:5;s:10:\"CiviReport\";}s:18:\"enableComponentIDs\";a:6:{i:0;i:1;i:1;i:6;i:2;i:2;i:3;i:3;i:4;i:4;i:5;i:8;}s:9:\"enableSSL\";b:0;s:17:\"fatalErrorHandler\";N;s:14:\"legacyEncoding\";s:12:\"Windows-1252\";s:14:\"fieldSeparator\";s:1:\",\";s:17:\"maxLocationBlocks\";i:2;s:15:\"captchaFontPath\";s:25:\"/usr/X11R6/lib/X11/fonts/\";s:11:\"captchaFont\";s:17:\"HelveticaBold.ttf\";s:21:\"includeWildCardInName\";i:1;s:18:\"includeEmailInName\";i:1;s:21:\"includeNickNameInName\";i:0;s:22:\"smartGroupCacheTimeout\";i:5;s:22:\"defaultSearchProfileID\";N;s:21:\"dashboardCacheTimeout\";i:1440;s:15:\"doNotResetCache\";i:0;s:24:\"includeAlphabeticalPager\";i:1;s:20:\"includeOrderByClause\";i:1;s:13:\"oldInputStyle\";i:1;s:14:\"formKeyDisable\";b:0;s:21:\"doNotAttachPDFReceipt\";b:0;s:15:\"wkhtmltopdfPath\";b:0;s:23:\"secondDegRelPermissions\";b:0;s:10:\"wpBasePage\";N;s:9:\"groupTree\";b:0;s:11:\"revampPages\";a:0:{}s:13:\"verpSeparator\";s:1:\".\";s:12:\"mailerPeriod\";i:180;s:16:\"mailerSpoolLimit\";i:0;s:16:\"mailerBatchLimit\";i:0;s:13:\"mailerJobSize\";i:0;s:13:\"mailerJobsMax\";i:0;s:16:\"mailThrottleTime\";i:0;s:12:\"customCSSURL\";N;}',
         'version' => '4.6.alpha1',
         'contact_id' => '2',
         'domain_email' => '\"Domain Email\" <domainemail2@example.org>',
@@ -91,6 +91,7 @@ function domain_get_expectedresult() {
         ),
         'from_email' => 'info@EXAMPLE.ORG',
         'from_name' => 'FIXME',
+        'domain_version' => '4.6.alpha1',
       ),
     ),
   );
index 71e56b9ab47c3e7f2c3e9b05ed3ad30ef4b3dd57..aa7b3f24e729c469dda9b5f6f1e9e7ebe42acb92 100644 (file)
@@ -22,7 +22,8 @@ function email_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 2c2b3e2b582dee5d3969ba863a7e271eee3be5d0..fa65dd94ae25cc01b4fff50b0c7fbf1590553c84 100644 (file)
@@ -19,7 +19,8 @@ function email_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function email_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index 74654ade260be09a9bf7d2e3122adc150b262985..650709d46f00d768c12f04f8c8d363f514d594c2 100644 (file)
@@ -46,7 +46,8 @@ function email_replace_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
diff --git a/api/v3/examples/EntityBatch/Create.php b/api/v3/examples/EntityBatch/Create.php
new file mode 100644 (file)
index 0000000..85486c6
--- /dev/null
@@ -0,0 +1,80 @@
+<?php
+/**
+ * Test Generated example demonstrating the EntityBatch.create API.
+ *
+ * @return array
+ *   API result array
+ */
+function entity_batch_create_example() {
+  $params = array(
+    'entity_id' => 1,
+    'batch_id' => 1,
+    'entity_table' => 'civicrm_financial_trxn',
+  );
+
+  try{
+    $result = civicrm_api3('EntityBatch', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function entity_batch_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1,
+    'values' => array(
+      '1' => array(
+        'id' => '1',
+        'entity_table' => 'civicrm_financial_trxn',
+        'entity_id' => '1',
+        'batch_id' => '1',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCreateEntityBatch"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityBatchTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/EntityBatch/Delete.php b/api/v3/examples/EntityBatch/Delete.php
new file mode 100644 (file)
index 0000000..ed94376
--- /dev/null
@@ -0,0 +1,70 @@
+<?php
+/**
+ * Test Generated example demonstrating the EntityBatch.delete API.
+ *
+ * @return array
+ *   API result array
+ */
+function entity_batch_delete_example() {
+  $params = array(
+    'id' => 3,
+  );
+
+  try{
+    $result = civicrm_api3('EntityBatch', 'delete', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function entity_batch_delete_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'values' => 1,
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testDeleteEntityBatch"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityBatchTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/EntityBatch/Get.php b/api/v3/examples/EntityBatch/Get.php
new file mode 100644 (file)
index 0000000..d1aa10a
--- /dev/null
@@ -0,0 +1,80 @@
+<?php
+/**
+ * Test Generated example demonstrating the EntityBatch.get API.
+ *
+ * @return array
+ *   API result array
+ */
+function entity_batch_get_example() {
+  $params = array(
+    'entity_id' => 2,
+    'batch_id' => 2,
+    'entity_table' => 'civicrm_financial_trxn',
+  );
+
+  try{
+    $result = civicrm_api3('EntityBatch', 'get', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function entity_batch_get_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 2,
+    'values' => array(
+      '2' => array(
+        'id' => '2',
+        'entity_table' => 'civicrm_financial_trxn',
+        'entity_id' => '2',
+        'batch_id' => '2',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetEntityBatch"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityBatchTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
index faecc36c6d600bfba4894872a43bc89093a8529e..9d117d4b9bb7b911880be192a9f27d7b3bba1ec0 100644 (file)
@@ -20,7 +20,8 @@ function entity_tag_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index aeb29807723f4c2e06082336a55d31942cd2a921..a51e13c015f974d6953fe9861b3c6f97246e9548 100644 (file)
@@ -19,7 +19,8 @@ function entity_tag_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
diff --git a/api/v3/examples/Event/ContactRefCustomField.php b/api/v3/examples/Event/ContactRefCustomField.php
new file mode 100644 (file)
index 0000000..77adb0b
--- /dev/null
@@ -0,0 +1,109 @@
+<?php
+/**
+ * Test Generated example demonstrating the Event.get API.
+ *
+ * Demonstrates get with Contact Reference Custom Field.
+ *
+ * @return array
+ *   API result array
+ */
+function event_get_example() {
+  $params = array(
+    'return.custom_2' => 1,
+    'custom_2' => 4,
+  );
+
+  try{
+    $result = civicrm_api3('Event', 'get', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function event_get_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 3,
+    'values' => array(
+      '3' => array(
+        'id' => '3',
+        'title' => 'My test event.',
+        'event_title' => 'My test event.',
+        'event_description' => '',
+        'event_type_id' => '1',
+        'participant_listing_id' => 0,
+        'is_public' => '1',
+        'start_date' => '2013-07-29 00:00:00',
+        'event_start_date' => '2013-07-29 00:00:00',
+        'event_end_date' => '',
+        'is_online_registration' => 0,
+        'is_monetary' => 0,
+        'is_map' => 0,
+        'is_active' => '1',
+        'is_show_location' => '1',
+        'default_role_id' => '1',
+        'is_email_confirm' => 0,
+        'is_pay_later' => 0,
+        'is_partial_payment' => 0,
+        'is_multiple_registrations' => 0,
+        'max_additional_participants' => 0,
+        'allow_same_participant_emails' => 0,
+        'allow_selfcancelxfer' => 0,
+        'selfcancelxfer_time' => 0,
+        'is_template' => 0,
+        'created_date' => '2013-07-28 08:49:19',
+        'is_share' => '1',
+        'is_confirm_enabled' => '1',
+        'is_billing_required' => 0,
+        'custom_1' => 'defaultValue',
+        'custom_2_id' => '4',
+        'custom_2' => 'Contact, Test',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testEventGetCustomContactRefFieldCRM16036"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EventTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
index 2b0363e88de9f31524284a5b618b1a531c1717f1..d5f0bb942af270f541376385fe0b4e6bb0ad0b71 100644 (file)
@@ -33,7 +33,8 @@ function event_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -105,10 +106,13 @@ function event_create_expectedresult() {
         'initial_amount_help_text' => '',
         'min_initial_amount' => '',
         'is_multiple_registrations' => '',
+        'max_additional_participants' => '',
         'allow_same_participant_emails' => '',
         'has_waitlist' => '',
         'requires_approval' => '',
         'expiration_time' => '',
+        'allow_selfcancelxfer' => '',
+        'selfcancelxfer_time' => '',
         'waitlist_text' => '',
         'approval_req_text' => '',
         'is_template' => 0,
index e3706afb641ffbeb6d81f0f8d42d1af19a31b7d0..9f12de13c0d6cbabd87364166d0e62d234f26307 100644 (file)
@@ -19,7 +19,8 @@ function event_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 5892efb6362174b4faffd6fa0aa06ae96187c38f..68637fc4c97a6afab1319b4bb0eeb9adce2fcea1 100644 (file)
@@ -20,7 +20,8 @@ function event_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -47,11 +48,13 @@ function event_get_expectedresult() {
         'id' => '1',
         'title' => 'Annual CiviCRM meet',
         'event_title' => 'Annual CiviCRM meet',
+        'event_description' => '',
         'event_type_id' => '1',
         'participant_listing_id' => 0,
         'is_public' => '1',
         'start_date' => '2013-07-29 00:00:00',
         'event_start_date' => '2013-07-29 00:00:00',
+        'event_end_date' => '',
         'is_online_registration' => 0,
         'is_monetary' => 0,
         'is_map' => 0,
@@ -62,7 +65,10 @@ function event_get_expectedresult() {
         'is_pay_later' => 0,
         'is_partial_payment' => 0,
         'is_multiple_registrations' => 0,
+        'max_additional_participants' => 0,
         'allow_same_participant_emails' => 0,
+        'allow_selfcancelxfer' => 0,
+        'selfcancelxfer_time' => 0,
         'is_template' => 0,
         'created_date' => '2013-07-28 08:49:19',
         'is_share' => '1',
index 159c6c28520b9c2b276ecf5f46153c18d0923bda..9d60d43064f5cd9b3587397f0da1a9d532296b6e 100644 (file)
@@ -21,7 +21,8 @@ function event_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -72,7 +73,10 @@ function event_get_expectedresult() {
         'is_pay_later' => 0,
         'is_partial_payment' => 0,
         'is_multiple_registrations' => 0,
+        'max_additional_participants' => 0,
         'allow_same_participant_emails' => 0,
+        'allow_selfcancelxfer' => 0,
+        'selfcancelxfer_time' => 0,
         'is_template' => 0,
         'created_date' => '2013-07-28 08:49:19',
         'is_share' => '1',
index 9545de0bd8718ec562861679e6658464e95de438..0eca96b971e40db0a5204481437fd7bc909e4960 100644 (file)
@@ -22,7 +22,8 @@ function event_getsingle_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -43,11 +44,13 @@ function event_getsingle_expectedresult() {
     'id' => '1',
     'title' => 'Annual CiviCRM meet',
     'event_title' => 'Annual CiviCRM meet',
+    'event_description' => '',
     'event_type_id' => '1',
     'participant_listing_id' => 0,
     'is_public' => '1',
     'start_date' => '2008-10-21 00:00:00',
     'event_start_date' => '2008-10-21 00:00:00',
+    'event_end_date' => '',
     'is_online_registration' => 0,
     'max_participants' => '1',
     'is_monetary' => 0,
@@ -59,9 +62,12 @@ function event_getsingle_expectedresult() {
     'is_pay_later' => 0,
     'is_partial_payment' => 0,
     'is_multiple_registrations' => 0,
+    'max_additional_participants' => 0,
     'allow_same_participant_emails' => 0,
+    'allow_selfcancelxfer' => 0,
+    'selfcancelxfer_time' => 0,
     'is_template' => 0,
-    'created_date' => '2015-02-22 23:13:11',
+    'created_date' => '2017-01-24 08:34:25',
     'is_share' => '1',
     'is_confirm_enabled' => '1',
     'is_billing_required' => 0,
index 519c097937311b975580b051316c2525cdffcd32..f968d9a2a4018a51c1998ef154a839a2d29a5b51 100644 (file)
@@ -26,7 +26,8 @@ function grant_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index f4323382edeb66ecd54e534b50cb721d65cb97b1..de116031e3d27719e0312262152dda0257fdb2b3 100644 (file)
@@ -19,7 +19,8 @@ function grant_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function grant_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index ca51ac066070eb624b236015fb5f9248d091cd4b..78920988712cee08e22a443486be3dcad4b509bb 100644 (file)
@@ -19,7 +19,8 @@ function grant_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index c2137ffa8a6d9ba00e356f5b9254dc4dbc26d495..ca31ca89fc0363df06608eab281b634258ac1221 100644 (file)
@@ -19,7 +19,8 @@ function group_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -49,9 +50,9 @@ function group_get_expectedresult() {
         'description' => 'New Test Group Created',
         'is_active' => '1',
         'visibility' => 'Public Pages',
-        'where_clause' => ' ( `civicrm_group_contact-4`.group_id IN ( 4 ) AND `civicrm_group_contact-4`.status IN (\"Added\") ) ',
-        'select_tables' => 'a:8:{s:15:\"civicrm_contact\";i:1;s:15:\"civicrm_address\";i:1;s:15:\"civicrm_country\";i:1;s:13:\"civicrm_email\";i:1;s:13:\"civicrm_phone\";i:1;s:10:\"civicrm_im\";i:1;s:19:\"civicrm_worldregion\";i:1;s:25:\"`civicrm_group_contact-4`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-4` ON ( contact_a.id = `civicrm_group_contact-4`.contact_id AND `civicrm_group_contact-4`.group_id IN ( 4 ) )\";}',
-        'where_tables' => 'a:2:{s:15:\"civicrm_contact\";i:1;s:25:\"`civicrm_group_contact-4`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-4` ON ( contact_a.id = `civicrm_group_contact-4`.contact_id AND `civicrm_group_contact-4`.group_id IN ( 4 ) )\";}',
+        'where_clause' => ' ( `civicrm_group_contact-4`.group_id IN ( 4 )   ) ',
+        'select_tables' => 'a:8:{s:15:\"civicrm_contact\";i:1;s:15:\"civicrm_address\";i:1;s:15:\"civicrm_country\";i:1;s:13:\"civicrm_email\";i:1;s:13:\"civicrm_phone\";i:1;s:10:\"civicrm_im\";i:1;s:19:\"civicrm_worldregion\";i:1;s:25:\"`civicrm_group_contact-4`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-4` ON (contact_a.id = `civicrm_group_contact-4`.contact_id AND `civicrm_group_contact-4`.status IN (\'Added\'))\";}',
+        'where_tables' => 'a:2:{s:15:\"civicrm_contact\";i:1;s:25:\"`civicrm_group_contact-4`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-4` ON (contact_a.id = `civicrm_group_contact-4`.contact_id AND `civicrm_group_contact-4`.status IN (\'Added\'))\";}',
         'group_type' => array(
           '0' => '1',
           '1' => '2',
index 5f4962e5e361804bfbe6b4cba57bc1bd6b85169b..22dfe5250c23be010671e1fe4ea2990769caa02a 100644 (file)
@@ -21,7 +21,8 @@ function group_getfields_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -47,6 +48,7 @@ function group_getfields_expectedresult() {
         'name' => 'id',
         'type' => 1,
         'title' => 'Group ID',
+        'description' => 'Group ID',
         'required' => TRUE,
         'api.aliases' => array(
           '0' => 'group_id',
@@ -56,6 +58,7 @@ function group_getfields_expectedresult() {
         'name' => 'name',
         'type' => 2,
         'title' => 'Group Name',
+        'description' => 'Internal name of Group.',
         'maxlength' => 64,
         'size' => 30,
       ),
@@ -63,6 +66,7 @@ function group_getfields_expectedresult() {
         'name' => 'title',
         'type' => 2,
         'title' => 'Group Title',
+        'description' => 'Name of Group.',
         'maxlength' => 64,
         'size' => 30,
         'api.required' => 1,
@@ -71,16 +75,20 @@ function group_getfields_expectedresult() {
         'name' => 'description',
         'type' => 32,
         'title' => 'Group Description',
+        'description' => 'Optional verbose description of the group.',
         'rows' => 2,
         'cols' => 60,
         'html' => array(
           'type' => 'TextArea',
+          'rows' => 2,
+          'cols' => 60,
         ),
       ),
       'source' => array(
         'name' => 'source',
         'type' => 2,
         'title' => 'Group Source',
+        'description' => 'Module or process which created this group.',
         'maxlength' => 64,
         'size' => 30,
       ),
@@ -88,6 +96,7 @@ function group_getfields_expectedresult() {
         'name' => 'saved_search_id',
         'type' => 1,
         'title' => 'Saved Search ID',
+        'description' => 'FK to saved search table.',
         'FKClassName' => 'CRM_Contact_DAO_SavedSearch',
         'FKApiName' => 'SavedSearch',
       ),
@@ -95,17 +104,21 @@ function group_getfields_expectedresult() {
         'name' => 'is_active',
         'type' => 16,
         'title' => 'Group Enabled',
+        'description' => 'Is this entry active?',
         'api.default' => 1,
       ),
       'visibility' => array(
         'name' => 'visibility',
         'type' => 2,
         'title' => 'Group Visibility Setting',
+        'description' => 'In what context(s) is this field visible.',
         'maxlength' => 24,
         'size' => 20,
         'default' => 'User and User Admin Only',
         'html' => array(
           'type' => 'Select',
+          'maxlength' => 24,
+          'size' => 20,
         ),
         'pseudoconstant' => array(
           'callback' => 'CRM_Core_SelectValues::groupVisibility',
@@ -115,48 +128,63 @@ function group_getfields_expectedresult() {
         'name' => 'where_clause',
         'type' => 32,
         'title' => 'Group Where Clause',
+        'description' => 'the sql where clause if a saved search acl',
       ),
       'select_tables' => array(
         'name' => 'select_tables',
         'type' => 32,
         'title' => 'Tables For Select Clause',
+        'description' => 'the tables to be included in a select data',
       ),
       'where_tables' => array(
         'name' => 'where_tables',
         'type' => 32,
         'title' => 'Tables For Where Clause',
+        'description' => 'the tables to be included in the count statement',
       ),
       'group_type' => array(
         'name' => 'group_type',
         'type' => 2,
         'title' => 'Group Type',
+        'description' => 'FK to group type',
         'maxlength' => 128,
         'size' => 45,
+        'pseudoconstant' => array(
+          'optionGroupName' => 'group_type',
+          'optionEditPath' => 'civicrm/admin/options/group_type',
+        ),
       ),
       'cache_date' => array(
         'name' => 'cache_date',
-        'type' => 12,
+        'type' => 256,
         'title' => 'Group Cache Date',
+        'description' => 'Date when we created the cache for a smart group',
+        'required' => '',
       ),
       'refresh_date' => array(
         'name' => 'refresh_date',
-        'type' => 12,
+        'type' => 256,
         'title' => 'Next Group Refresh Time',
+        'description' => 'Date and time when we need to refresh the cache next.',
+        'required' => '',
       ),
       'parents' => array(
         'name' => 'parents',
         'type' => 32,
         'title' => 'Group Parents',
+        'description' => 'IDs of the parent(s)',
       ),
       'children' => array(
         'name' => 'children',
         'type' => 32,
         'title' => 'Group Children',
+        'description' => 'IDs of the child(ren)',
       ),
       'is_hidden' => array(
         'name' => 'is_hidden',
         'type' => 16,
         'title' => 'Group is Hidden',
+        'description' => 'Is this group hidden?',
       ),
       'is_reserved' => array(
         'name' => 'is_reserved',
@@ -167,6 +195,7 @@ function group_getfields_expectedresult() {
         'name' => 'created_id',
         'type' => 1,
         'title' => 'Group Created By',
+        'description' => 'FK to contact table.',
         'FKClassName' => 'CRM_Contact_DAO_Contact',
         'FKApiName' => 'Contact',
       ),
@@ -174,6 +203,7 @@ function group_getfields_expectedresult() {
         'name' => 'modified_id',
         'type' => 1,
         'title' => 'Group Modified By',
+        'description' => 'FK to contact table.',
         'FKClassName' => 'CRM_Contact_DAO_Contact',
         'FKApiName' => 'Contact',
       ),
index 6c0b3ec50a2fbbd79ecb291b6374cb10fd4655fe..515848316a08d06c7661f22d2a63144fae919c8c 100644 (file)
@@ -21,7 +21,8 @@ function group_contact_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index cb091b88bb1b1d548838e58ba1933f399c649eab..f0118e15e9d185eadf7c82d675938fa1c70643f1 100644 (file)
@@ -20,7 +20,8 @@ function group_contact_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index da5d396a5063b0bfb085647f1ff3baf196633a31..47511c3dead24bb0b5b38bb65c886ed8df7097da 100644 (file)
@@ -19,7 +19,8 @@ function group_contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 304ce81c25b99d3c89164188af469b2a6af2aa89..3fa9f14035ed5458ba9cb0b4af079c463578b7c8 100644 (file)
@@ -23,7 +23,8 @@ function group_contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -64,9 +65,9 @@ function group_contact_get_expectedresult() {
               'description' => 'New Test Group Created',
               'is_active' => '1',
               'visibility' => 'Public Pages',
-              'where_clause' => ' ( `civicrm_group_contact-3`.group_id IN ( 3 ) AND `civicrm_group_contact-3`.status IN (\"Added\") ) ',
-              'select_tables' => 'a:8:{s:15:\"civicrm_contact\";i:1;s:15:\"civicrm_address\";i:1;s:15:\"civicrm_country\";i:1;s:13:\"civicrm_email\";i:1;s:13:\"civicrm_phone\";i:1;s:10:\"civicrm_im\";i:1;s:19:\"civicrm_worldregion\";i:1;s:25:\"`civicrm_group_contact-3`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-3` ON ( contact_a.id = `civicrm_group_contact-3`.contact_id AND `civicrm_group_contact-3`.group_id IN ( 3 ) )\";}',
-              'where_tables' => 'a:2:{s:15:\"civicrm_contact\";i:1;s:25:\"`civicrm_group_contact-3`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-3` ON ( contact_a.id = `civicrm_group_contact-3`.contact_id AND `civicrm_group_contact-3`.group_id IN ( 3 ) )\";}',
+              'where_clause' => ' ( `civicrm_group_contact-3`.group_id IN ( 3 )   ) ',
+              'select_tables' => 'a:8:{s:15:\"civicrm_contact\";i:1;s:15:\"civicrm_address\";i:1;s:15:\"civicrm_country\";i:1;s:13:\"civicrm_email\";i:1;s:13:\"civicrm_phone\";i:1;s:10:\"civicrm_im\";i:1;s:19:\"civicrm_worldregion\";i:1;s:25:\"`civicrm_group_contact-3`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-3` ON (contact_a.id = `civicrm_group_contact-3`.contact_id AND `civicrm_group_contact-3`.status IN (\'Added\'))\";}',
+              'where_tables' => 'a:2:{s:15:\"civicrm_contact\";i:1;s:25:\"`civicrm_group_contact-3`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-3` ON (contact_a.id = `civicrm_group_contact-3`.contact_id AND `civicrm_group_contact-3`.status IN (\'Added\'))\";}',
               'group_type' => array(
                 '0' => '1',
                 '1' => '2',
index cec9d0c5072cdfd34f1ee5790bcff853d1240686..149dd02864e45186f98c7d19d3ada3c8beda32b8 100644 (file)
@@ -20,7 +20,8 @@ function group_nesting_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 6868d07231f1abcb434e24c34d724bed9b1cd88e..7a8ab837aea4ecd2c93b560d42f4a43adc85354f 100644 (file)
@@ -19,7 +19,8 @@ function group_nesting_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index cfb8d6dc3e0bcd2408181ff6b867990e8aec5ca3..3683dad770294e5970f9926e459e5f6da533e363 100644 (file)
@@ -20,7 +20,8 @@ function group_nesting_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 445603ea39be6e9ca2ede3e04ecf6e64dc0ea038..4ebee078ed3f39cbe444fc158ccaae0231034ee7 100644 (file)
@@ -20,7 +20,8 @@ function group_organization_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 295faa72d781b4e0a605d1f58dcb0a7ba8f43a6c..ad41dc6cad6f4eb77fc0bef55380398a3657ef38 100644 (file)
@@ -19,7 +19,8 @@ function group_organization_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 94a1edb33032f57fbb39e841fc42e7d468333b40..696179d9a7382cc8c5199b8bbd750fb72defea05 100644 (file)
@@ -19,7 +19,8 @@ function group_organization_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index e37267c400791bb7f39e870b408d2afb92a76aff..440e89a0af4c1327169bd2f63d909674ea4f2d73 100644 (file)
@@ -22,7 +22,8 @@ function im_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index cbf48c075d58676255065c3fb9e27e9f02794d75..c1d2e2b091f1fdcf4249f6cd8dd7aa07864b4766 100644 (file)
@@ -19,7 +19,8 @@ function im_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function im_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index 1d1afb45ec5b6bc6226f9a7ec976069b3675d06f..b1daaeaee2d29c26205f2aa51a7f5f7c78fbf6af 100644 (file)
@@ -22,7 +22,8 @@ function im_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 12a35425ac76bf7140e4d890670bd486fb8e6a3c..5c8514e02f5a6128e219c1f9ecc91c859ad995a5 100644 (file)
@@ -26,7 +26,8 @@ function job_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index c7aefcbdff3c2f9bdb1b5911739721862249d89d..fe854b3d274c35c704303403f3ba821ae0f18947 100644 (file)
@@ -19,7 +19,8 @@ function job_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 42085b693cbb7c54fc2981e32f62ebe442445041..761cd1c2642e4a2646c047ff7aa7462415f1f236 100644 (file)
@@ -26,7 +26,8 @@ function line_item_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -62,7 +63,7 @@ function line_item_create_expectedresult() {
         'participant_count' => '',
         'price_field_value_id' => '1',
         'financial_type_id' => '',
-        'deductible_amount' => '',
+        'non_deductible_amount' => '',
         'tax_amount' => '',
       ),
     ),
index 62b9de0384c7b17bf0fda93edecd4645d7b8a9a6..98c0496723a8949d2c9025a96427862621a8857a 100644 (file)
@@ -19,7 +19,8 @@ function line_item_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 4972579c3d4006a288247f77e788d61df9bfe3ec..f1f8756091d8775b020855bb8817b5fbb3bc47fb 100644 (file)
@@ -19,7 +19,8 @@ function line_item_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -54,7 +55,8 @@ function line_item_get_expectedresult() {
         'line_total' => '100.00',
         'price_field_value_id' => '1',
         'financial_type_id' => '1',
-        'deductible_amount' => '0.00',
+        'non_deductible_amount' => '0.00',
+        'contribution_type_id' => '1',
       ),
     ),
   );
index 7c1410f0ec5b924321c98dbbd52978d0e2a522aa..328cec565fddc0371313feabc9fcd63b1a63218d 100644 (file)
@@ -23,7 +23,8 @@ function loc_block_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index f6f33f935585031fdc552046a598d65aa1f185bc..4af4802789748ee28a6302eb8add3b9cf3da9177 100644 (file)
@@ -36,7 +36,8 @@ function loc_block_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index d0f3868a0a7f5f744158566fe1574373dd51fee1..c323e43fb7ec3291b10e38fb38050c7f3bdbd382 100644 (file)
@@ -22,7 +22,8 @@ function loc_block_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 6e904dee4d38b457ad22fcb9b322df179e79c630..2f9a4dae9b6470febb0135cbe08bba472f86a8bb 100644 (file)
@@ -19,7 +19,8 @@ function logging_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 88a5514e237f2013f72dc288697c31f4efc4781f..1dad9943445b7c93a56ad417bd1b11557af4e4ec 100644 (file)
@@ -20,7 +20,8 @@ function logging_revert_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 2c1e69bbab5491243ba035ad2e32dfc9b6d47313..39840638f095e6cb1edda24285a06d8f1b551423 100644 (file)
@@ -22,7 +22,8 @@ function mail_settings_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index f271945d8ca05253a975eeb8ed6a71f9f98bed97..1542f116dd2bc130a020c653f3b651592089b7d1 100644 (file)
@@ -26,7 +26,8 @@ function mail_settings_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 14cf3ba324e46e3406bb7bbe21c342d011e5ef1c..ffd138fc2d31f5f77a4fcc0b235f570f0a9d641f 100644 (file)
@@ -19,7 +19,8 @@ function mail_settings_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 025ba20a82f452bda729b1eecff906beeb3ec885..53c8b81cb6b09baa73ef4a49cceae55455ea1813 100644 (file)
@@ -26,7 +26,8 @@ function mail_settings_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index d63fe02d8f43810c76e45b154b049d70c860a70e..ae99328f23206478310579c0df8211b4c852e815 100644 (file)
@@ -19,7 +19,8 @@ function mail_settings_getoptions_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
diff --git a/api/v3/examples/Mailing/Clone.php b/api/v3/examples/Mailing/Clone.php
new file mode 100644 (file)
index 0000000..c91b477
--- /dev/null
@@ -0,0 +1,118 @@
+<?php
+/**
+ * Test Generated example demonstrating the Mailing.clone API.
+ *
+ * @return array
+ *   API result array
+ */
+function mailing_clone_example() {
+  $params = array(
+    'id' => 21,
+  );
+
+  try{
+    $result = civicrm_api3('Mailing', 'clone', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function mailing_clone_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 22,
+    'values' => array(
+      '22' => array(
+        'id' => '22',
+        'domain_id' => '1',
+        'header_id' => '1',
+        'footer_id' => '2',
+        'reply_id' => '8',
+        'unsubscribe_id' => '5',
+        'resubscribe_id' => '6',
+        'optout_id' => '7',
+        'name' => 'mailing name',
+        'mailing_type' => 'standalone',
+        'from_name' => 'FIXME',
+        'from_email' => 'info@EXAMPLE.ORG',
+        'replyto_email' => 'info@EXAMPLE.ORG',
+        'template_type' => 'traditional',
+        'template_options' => '',
+        'subject' => 'Hello {contact.display_name}',
+        'body_text' => 'This is {contact.display_name}.
+https://civicrm.org
+{domain.address}{action.optOutUrl}',
+        'body_html' => '<p>This is {contact.display_name}.</p><p><a href=\'https://civicrm.org/\'>CiviCRM.org</a></p><p>{domain.address}{action.optOutUrl}</p>',
+        'url_tracking' => '1',
+        'forward_replies' => 0,
+        'auto_responder' => 0,
+        'open_tracking' => '1',
+        'is_completed' => '',
+        'msg_template_id' => '',
+        'override_verp' => '1',
+        'created_id' => '147',
+        'created_date' => '2013-07-28 08:49:19',
+        'scheduled_id' => '',
+        'scheduled_date' => '',
+        'approver_id' => '',
+        'approval_date' => '',
+        'approval_status_id' => '',
+        'approval_note' => '',
+        'is_archived' => '',
+        'visibility' => 'Public Pages',
+        'campaign_id' => '',
+        'dedupe_email' => '1',
+        'sms_provider_id' => '',
+        'hash' => '',
+        'location_type_id' => '',
+        'email_selection_method' => 'automatic',
+        'language' => '',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testClone"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
index 5772aa62015844c965c39361592c94e462f40441..0c5410ce6f86a532e6f12dc53112ee19765640c8 100644 (file)
@@ -51,7 +51,8 @@ function mailing_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -84,13 +85,17 @@ function mailing_create_expectedresult() {
         'resubscribe_id' => '6',
         'optout_id' => '7',
         'name' => 'mailing name',
+        'mailing_type' => 'standalone',
         'from_name' => 'FIXME',
         'from_email' => 'info@EXAMPLE.ORG',
         'replyto_email' => 'info@EXAMPLE.ORG',
+        'template_type' => '',
+        'template_options' => '',
         'subject' => 'Hello {contact.display_name}',
         'body_text' => 'This is {contact.display_name}.
+https://civińcrm.org
 {domain.address}{action.optOutUrl}',
-        'body_html' => '<p>This is {contact.display_name}.</p><p>{domain.address}{action.optOutUrl}</p>',
+        'body_html' => '<p>This is {contact.display_name}.</p><p><a href=\'https://civiÅ„crm.org/\'>CiviCRM.org</a></p><p>{domain.address}{action.optOutUrl}</p>',
         'url_tracking' => '1',
         'forward_replies' => '',
         'auto_responder' => '',
index 4f60cc881c00ce7bfe4694ac78fd6cf89dc9df02..d274d8c82503f39b76bdb42f071652fcd678afff 100644 (file)
@@ -19,7 +19,8 @@ function mailing_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function mailing_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index 6ef6552673d7dbceea4a27d88a6941a95c722336..e5a7be5d2a125a0ef566f80c9fee00d2a886066f 100644 (file)
@@ -25,7 +25,8 @@ function mailing_gettokens_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index fbf518322be9383b8692c2943a14662cd53d419f..1b328b7e6cc0688af2524f5e37643c3f7c55d15f 100644 (file)
@@ -21,7 +21,8 @@ function mailing_submit_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 674ea54bf9db95ac18893a94a95c8d4c745165fa..e1189215f1a97f26cf2975f6e908676f5fd34bb5 100644 (file)
@@ -25,7 +25,8 @@ function mailing_a_b_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
diff --git a/api/v3/examples/MailingEventSubscribe/Create.php b/api/v3/examples/MailingEventSubscribe/Create.php
new file mode 100644 (file)
index 0000000..0af6130
--- /dev/null
@@ -0,0 +1,81 @@
+<?php
+/**
+ * Test Generated example demonstrating the MailingEventSubscribe.create API.
+ *
+ * @return array
+ *   API result array
+ */
+function mailing_event_subscribe_create_example() {
+  $params = array(
+    'email' => 'test@test.test',
+    'group_id' => 2,
+    'contact_id' => 3,
+    'hash' => 'b15de8b64e2cec34',
+    'time_stamp' => '20101212121212',
+  );
+
+  try{
+    $result = civicrm_api3('MailingEventSubscribe', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function mailing_event_subscribe_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1,
+    'values' => array(
+      '1' => array(
+        'contact_id' => '3',
+        'subscribe_id' => '1',
+        'hash' => '67eac7789eaee00',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testMailerGroupSubscribeGivenContactId"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingGroupTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/Mapping/Create.php b/api/v3/examples/Mapping/Create.php
new file mode 100644 (file)
index 0000000..50459e1
--- /dev/null
@@ -0,0 +1,80 @@
+<?php
+/**
+ * Test Generated example demonstrating the Mapping.create API.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_create_example() {
+  $params = array(
+    'name' => 'Mapping name',
+    'description' => 'Mapping description',
+    'mapping_type_id' => 7,
+  );
+
+  try{
+    $result = civicrm_api3('Mapping', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1,
+    'values' => array(
+      '1' => array(
+        'id' => '1',
+        'name' => 'Mapping name',
+        'description' => 'Mapping description',
+        'mapping_type_id' => '7',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCreateMapping"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/Mapping/Delete.php b/api/v3/examples/Mapping/Delete.php
new file mode 100644 (file)
index 0000000..cf598f7
--- /dev/null
@@ -0,0 +1,70 @@
+<?php
+/**
+ * Test Generated example demonstrating the Mapping.delete API.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_delete_example() {
+  $params = array(
+    'id' => 3,
+  );
+
+  try{
+    $result = civicrm_api3('Mapping', 'delete', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_delete_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'values' => 1,
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testDeleteMapping"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/Mapping/Get.php b/api/v3/examples/Mapping/Get.php
new file mode 100644 (file)
index 0000000..f338822
--- /dev/null
@@ -0,0 +1,80 @@
+<?php
+/**
+ * Test Generated example demonstrating the Mapping.get API.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_get_example() {
+  $params = array(
+    'name' => 'Mapping name',
+    'description' => 'Mapping description',
+    'mapping_type_id' => 7,
+  );
+
+  try{
+    $result = civicrm_api3('Mapping', 'get', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_get_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 2,
+    'values' => array(
+      '2' => array(
+        'id' => '2',
+        'name' => 'Mapping name',
+        'description' => 'Mapping description',
+        'mapping_type_id' => '7',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetMapping"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/MappingField/Create.php b/api/v3/examples/MappingField/Create.php
new file mode 100644 (file)
index 0000000..9b80b27
--- /dev/null
@@ -0,0 +1,92 @@
+<?php
+/**
+ * Test Generated example demonstrating the MappingField.create API.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_field_create_example() {
+  $params = array(
+    'mapping_id' => 1,
+    'name' => 'last_name',
+    'contact_type' => 'Individual',
+    'column_number' => 2,
+    'grouping' => 1,
+  );
+
+  try{
+    $result = civicrm_api3('MappingField', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_field_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1,
+    'values' => array(
+      '1' => array(
+        'id' => '1',
+        'mapping_id' => '1',
+        'name' => 'last_name',
+        'contact_type' => 'Individual',
+        'column_number' => '2',
+        'location_type_id' => '',
+        'phone_type_id' => '',
+        'im_provider_id' => '',
+        'website_type_id' => '',
+        'relationship_type_id' => '',
+        'relationship_direction' => '',
+        'grouping' => '1',
+        'operator' => '',
+        'value' => '',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCreateMappingField"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingFieldTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/MappingField/Delete.php b/api/v3/examples/MappingField/Delete.php
new file mode 100644 (file)
index 0000000..ef27c0f
--- /dev/null
@@ -0,0 +1,70 @@
+<?php
+/**
+ * Test Generated example demonstrating the MappingField.delete API.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_field_delete_example() {
+  $params = array(
+    'id' => 3,
+  );
+
+  try{
+    $result = civicrm_api3('MappingField', 'delete', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_field_delete_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'values' => 1,
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testDeleteMappingField"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingFieldTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/MappingField/Get.php b/api/v3/examples/MappingField/Get.php
new file mode 100644 (file)
index 0000000..09d1f7d
--- /dev/null
@@ -0,0 +1,84 @@
+<?php
+/**
+ * Test Generated example demonstrating the MappingField.get API.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_field_get_example() {
+  $params = array(
+    'mapping_id' => 2,
+    'name' => 'last_name',
+    'contact_type' => 'Individual',
+    'column_number' => 2,
+    'grouping' => 1,
+  );
+
+  try{
+    $result = civicrm_api3('MappingField', 'get', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function mapping_field_get_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 2,
+    'values' => array(
+      '2' => array(
+        'id' => '2',
+        'mapping_id' => '2',
+        'name' => 'last_name',
+        'contact_type' => 'Individual',
+        'column_number' => '2',
+        'grouping' => '1',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetMappingField"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingFieldTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
index 0821f6b1dbe35ab301c11ee7844664e7dffeb704..5f765f3f796f87b73edda0a14af46475ae68bc63 100644 (file)
@@ -26,7 +26,8 @@ function membership_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 79ecdb73256578a2389ada3708ebee4b98528c2e..fe9516e6632a3abe5cf44e2516942f2d63cfcf3a 100644 (file)
@@ -27,7 +27,8 @@ function membership_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 8ed8df71ce9252d0f18d483f8ba6f77aa67e8bd3..953ecbffe636c4feee633297eb049cd212b13233 100644 (file)
@@ -8,6 +8,7 @@
 function membership_delete_example() {
   $params = array(
     'id' => 1,
+    'preserve_contribution' => 1,
   );
 
   try{
@@ -19,7 +20,8 @@ function membership_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -48,7 +50,7 @@ function membership_delete_expectedresult() {
 
 /*
 * This example has been generated from the API test suite.
-* The test that created it is called "testMembershipDelete"
+* The test that created it is called "testMembershipDeletePreserveContribution"
 * and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php
 *
index 23d4ff64260fc59b58d9bda1b38b8903b8690600..13dc628132c6f3fbb64e456896bb5338c7fe0bbe 100644 (file)
@@ -24,7 +24,8 @@ function membership_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index e09a1a50e024d9211f661790dd3d49ed1d7be6d9..20f24d537d40fe27041bcc23d82640229d588547 100644 (file)
@@ -19,7 +19,8 @@ function membership_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
diff --git a/api/v3/examples/Membership/SearchWithCustomData.php b/api/v3/examples/Membership/SearchWithCustomData.php
new file mode 100644 (file)
index 0000000..79ebb5a
--- /dev/null
@@ -0,0 +1,96 @@
+<?php
+/**
+ * Test Generated example demonstrating the Membership.create API.
+ *
+ * @return array
+ *   API result array
+ */
+function membership_create_example() {
+  $params = array(
+    'contact_id' => 94,
+    'membership_type_id' => 57,
+    'join_date' => '2009-01-21',
+    'start_date' => '2009-01-21',
+    'end_date' => '2009-12-21',
+    'source' => 'Payment',
+    'is_override' => 1,
+    'status_id' => 35,
+  );
+
+  try{
+    $result = civicrm_api3('Membership', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function membership_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1,
+    'values' => array(
+      '1' => array(
+        'id' => '1',
+        'contact_id' => '94',
+        'membership_type_id' => '57',
+        'join_date' => '20090121000000',
+        'start_date' => '2013-07-29 00:00:00',
+        'end_date' => '2013-08-04 00:00:00',
+        'source' => 'Payment',
+        'status_id' => '35',
+        'is_override' => '1',
+        'owner_membership_id' => '',
+        'max_related' => '',
+        'is_test' => 0,
+        'is_pay_later' => '',
+        'contribution_recur_id' => '',
+        'campaign_id' => '',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testSearchWithCustomDataCRM16036"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
index 49e3b4b5cac75f574ff26415d862cfe0e03dadb9..1b593b34c2807d1b835b91db3a497b82cd65aca8 100644 (file)
@@ -27,7 +27,8 @@ function membership_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 3550d327ebaf70a9ec5e82e0890a23d42e280d38..15f17ed82d2532d2cd1cab4f04df93a10bf03314 100644 (file)
@@ -20,7 +20,8 @@ function membership_payment_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index b42b1d07eb228306d701628908bf4dc49e8879a7..b93156fd3d77ba42ea8cb117179e568e34642b3a 100644 (file)
@@ -20,7 +20,8 @@ function membership_payment_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 56b0ed00590c6ba4e99832214c67471650618290..1bfd08c1e71aaa6b7cde3a4039c293f61b5223fd 100644 (file)
@@ -19,7 +19,8 @@ function membership_status_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index f3b8b20430e16528b750c22d3905becc77d248ff..0291fdb620c2bcfbe6eeb00db3b6abc4af99f406 100644 (file)
@@ -19,7 +19,8 @@ function membership_status_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index ad4dd238e069999f823b72b8cf1c5769dd859e63..81cff6e5aeb07bdb70575a1c8396a569b4fa8294 100644 (file)
@@ -28,7 +28,8 @@ function membership_type_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -72,7 +73,7 @@ function membership_type_create_expectedresult() {
         'receipt_text_signup' => '',
         'receipt_text_renewal' => '',
         'auto_renew' => '',
-        'is_active' => '',
+        'is_active' => '1',
         'contribution_type_id' => '1',
       ),
     ),
index 6a12a8a1e2330d72dd3d4b9c223a401001f70cdc..2c08431368b02b849f6c284d3c43349006fba56a 100644 (file)
@@ -19,7 +19,8 @@ function membership_type_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function membership_type_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index e3d8fa2a57939393c76276a7982426b6e3cd4ae3..f111b04bd406f1dab1d610ada06e05d6965b2db8 100644 (file)
@@ -19,7 +19,8 @@ function membership_type_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index af72d924c6d88d30a1172a958f96d3d117e17109..094118233901e9664e5cc2f2249446a30327f012 100644 (file)
@@ -25,7 +25,8 @@ function message_template_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index c18d9b93f05ed58e7fb8e61ca2059b54dfe747d2..1d47b6f0c8e06a03f58e8cc7ed94c61431d9600a 100644 (file)
@@ -19,7 +19,8 @@ function message_template_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function message_template_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index af55e83b253e33992d69f1e9bd429ad6e8452996..d3ab1005bcfc1e85262625fbf33ecbc99e8664f6 100644 (file)
@@ -25,7 +25,8 @@ function message_template_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 55c838ba45e202ec6f06a0db047811f767249ee9..949de282481db2eda70a8ced2fd7e08ce800115e 100644 (file)
@@ -24,7 +24,8 @@ function note_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 7f1e6c76577786e893e77ef077d23e7a02b4aa6f..43d8b4f7f1e00ea6a301f77dcee4a391f1f4da1d 100644 (file)
@@ -19,7 +19,8 @@ function note_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index a794862afadb1cc860eef308349d34b70347d1fe..8fea36b90b536f88f4271cf7bdf8b770808d6038 100644 (file)
@@ -20,7 +20,8 @@ function note_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
diff --git a/api/v3/examples/OpenID/Create.php b/api/v3/examples/OpenID/Create.php
new file mode 100644 (file)
index 0000000..aeba330
--- /dev/null
@@ -0,0 +1,82 @@
+<?php
+/**
+ * Test Generated example demonstrating the OpenID.create API.
+ *
+ * @return array
+ *   API result array
+ */
+function open_i_d_create_example() {
+  $params = array(
+    'contact_id' => 3,
+    'openid' => 'My OpenID handle',
+    'location_type_id' => 1,
+  );
+
+  try{
+    $result = civicrm_api3('OpenID', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function open_i_d_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1,
+    'values' => array(
+      '1' => array(
+        'id' => '1',
+        'contact_id' => '3',
+        'location_type_id' => '1',
+        'openid' => 'My OpenID handle',
+        'allowed_to_login' => '',
+        'is_primary' => '',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCreateOpenID"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OpenIDTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/OpenID/Delete.php b/api/v3/examples/OpenID/Delete.php
new file mode 100644 (file)
index 0000000..9f6d1ce
--- /dev/null
@@ -0,0 +1,70 @@
+<?php
+/**
+ * Test Generated example demonstrating the OpenID.delete API.
+ *
+ * @return array
+ *   API result array
+ */
+function open_i_d_delete_example() {
+  $params = array(
+    'id' => 3,
+  );
+
+  try{
+    $result = civicrm_api3('OpenID', 'delete', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function open_i_d_delete_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'values' => 1,
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testDeleteOpenID"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OpenIDTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/OpenID/Get.php b/api/v3/examples/OpenID/Get.php
new file mode 100644 (file)
index 0000000..ec8eb8c
--- /dev/null
@@ -0,0 +1,82 @@
+<?php
+/**
+ * Test Generated example demonstrating the OpenID.get API.
+ *
+ * @return array
+ *   API result array
+ */
+function open_i_d_get_example() {
+  $params = array(
+    'contact_id' => 4,
+    'openid' => 'My OpenID handle',
+    'location_type_id' => 1,
+  );
+
+  try{
+    $result = civicrm_api3('OpenID', 'get', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function open_i_d_get_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 2,
+    'values' => array(
+      '2' => array(
+        'id' => '2',
+        'contact_id' => '4',
+        'location_type_id' => '1',
+        'openid' => 'My OpenID handle',
+        'allowed_to_login' => 0,
+        'is_primary' => 0,
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetOpenID"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OpenIDTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
index d6749ef81e58fefac00e6703ba8a9aada732441d..7220e3db6ea71a31d785426ce260f916b5feedbc 100644 (file)
@@ -29,7 +29,8 @@ function option_group_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 4c8490e38c9953651ffebc8f9c1b997057aabcdc..cdf194ec7527ee0f8756bc13f8eb29673b4fafa7 100644 (file)
@@ -19,7 +19,8 @@ function option_group_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -40,7 +41,7 @@ function option_group_delete_expectedresult() {
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
+    'values' => 1,
   );
 
   return $expectedResult;
index 8351caf8501b3734036d7c9af74b11863baae5bb..0b24c9013e596b742141abfdf97e2ed4a1cb8fc5 100644 (file)
@@ -19,7 +19,8 @@ function option_group_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 7a291319f1ae802b6ba8bbcb0d20e59ce4c01f58..964c41ffdc82f961e356c5b98bd94e404c497198 100644 (file)
@@ -19,7 +19,8 @@ function option_value_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -46,6 +47,7 @@ function option_value_get_expectedresult() {
         'option_group_id' => '1',
         'label' => 'Phone',
         'value' => '1',
+        'name' => 'Phone',
         'filter' => 0,
         'weight' => '1',
         'is_optgroup' => 0,
@@ -57,6 +59,7 @@ function option_value_get_expectedresult() {
         'option_group_id' => '1',
         'label' => 'Email',
         'value' => '2',
+        'name' => 'Email',
         'filter' => 0,
         'weight' => '2',
         'is_optgroup' => 0,
@@ -68,6 +71,7 @@ function option_value_get_expectedresult() {
         'option_group_id' => '1',
         'label' => 'Postal Mail',
         'value' => '3',
+        'name' => 'Postal Mail',
         'filter' => 0,
         'weight' => '3',
         'is_optgroup' => 0,
@@ -79,6 +83,7 @@ function option_value_get_expectedresult() {
         'option_group_id' => '1',
         'label' => 'SMS',
         'value' => '4',
+        'name' => 'SMS',
         'filter' => 0,
         'weight' => '4',
         'is_optgroup' => 0,
@@ -90,6 +95,7 @@ function option_value_get_expectedresult() {
         'option_group_id' => '1',
         'label' => 'Fax',
         'value' => '5',
+        'name' => 'Fax',
         'filter' => 0,
         'weight' => '5',
         'is_optgroup' => 0,
index b0ed2bdaf49bbfb30f1e8ca6e14788f58397bb1e..b7253c8ef48f76442844ff8d94b220732ae4a94c 100644 (file)
@@ -25,7 +25,8 @@ function option_value_getsingle_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -47,6 +48,7 @@ function option_value_getsingle_expectedresult() {
     'option_group_id' => '1',
     'label' => 'SMS',
     'value' => '4',
+    'name' => 'SMS',
     'filter' => 0,
     'weight' => '4',
     'is_optgroup' => 0,
index 4333e1f11686cf6099f67f88d90e54f683e29619..30f5aad2c53ffe79b61dcce9a420ecee6e8d279c 100644 (file)
@@ -19,7 +19,8 @@ function order_cancel_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -71,6 +72,7 @@ function order_cancel_expectedresult() {
         'campaign_id' => '',
         'creditnote_id' => 'CN_1',
         'tax_amount' => '',
+        'revenue_recognition_date' => '',
         'contribution_type_id' => '1',
       ),
     ),
index 6dfbae5ea6ba6fcfe6ca4c62a055298db55a32ee..45ea551fcd2a78d96e0535395ff2216895e22ed7 100644 (file)
@@ -51,7 +51,8 @@ function order_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -103,6 +104,7 @@ function order_create_expectedresult() {
         'campaign_id' => '',
         'creditnote_id' => '',
         'tax_amount' => '',
+        'revenue_recognition_date' => '',
         'contribution_type_id' => '1',
       ),
     ),
index 6737b8d3daf159fc87a16b06ca31fbf27865ce4f..aa65ab5fd04560d92027c7d2ad6f677facfbb21e 100644 (file)
@@ -61,7 +61,8 @@ function order_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -113,6 +114,7 @@ function order_create_expectedresult() {
         'campaign_id' => '',
         'creditnote_id' => '',
         'tax_amount' => '',
+        'revenue_recognition_date' => '',
         'contribution_type_id' => '1',
       ),
     ),
@@ -123,7 +125,7 @@ function order_create_expectedresult() {
 
 /*
 * This example has been generated from the API test suite.
-* The test that created it is called "testAddOrderForPariticipant"
+* The test that created it is called "testAddOrderForParticipant"
 * and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php
 *
index bb771e1349d4e51d4a3ad63aef6a44c6b595a79e..9021a479a806fea5a7e0bdd4e0a50c40b6169aab 100644 (file)
@@ -19,7 +19,8 @@ function order_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 7f3dace4c9763738b93f44bc2c6d890fff636b29..10a3c2c84954c4e90795eb29f5e0ef4af09d7443 100644 (file)
@@ -19,7 +19,8 @@ function order_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 54bf5c55b2252fa4bcc2770e0808f5cfc9c4c736..8ab8b98dda950c82bda0a3f0fae1b59e7bb4c044 100644 (file)
@@ -25,7 +25,8 @@ function participant_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -67,6 +68,7 @@ function participant_create_expectedresult() {
         'discount_amount' => '',
         'cart_id' => '',
         'must_wait' => '',
+        'transferred_to_contact_id' => '',
       ),
     ),
   );
index 5c1fb35e05b0ef1ea373ac29651d2408bcec70de..1e06e9540ed7b8de60e0c117102f16cf86b12c17 100644 (file)
@@ -19,7 +19,8 @@ function participant_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 48277c28b441db8ac9622a3da3163a32cc083c1a..b9429731c749fa0fe120084bb693aecef60d73b3 100644 (file)
@@ -22,7 +22,8 @@ function participant_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 8d989c25334abedb39b858a6a0a9290b8d2c05a2..78f22366da83a4cf709b7f16674315fef2214902 100644 (file)
@@ -22,7 +22,8 @@ function participant_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -107,7 +108,10 @@ function participant_get_expectedresult() {
               'is_pay_later' => 0,
               'is_partial_payment' => 0,
               'is_multiple_registrations' => 0,
+              'max_additional_participants' => 0,
               'allow_same_participant_emails' => 0,
+              'allow_selfcancelxfer' => 0,
+              'selfcancelxfer_time' => 0,
               'is_template' => 0,
               'created_date' => '2013-07-28 08:49:19',
               'is_share' => '1',
index 00d52347b76c52e7a77e443c2f3b3881d3a8986f..5dca9fe9f3263a1000c3fcbc9deb1b77693dc07e 100644 (file)
@@ -20,7 +20,8 @@ function participant_payment_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 7088a0d18e8807ce7bae36d16b96097f0f913f19..c7e48e4eef9f62da5f2123d5e5682f719d3475b1 100644 (file)
@@ -19,7 +19,8 @@ function participant_payment_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index c119289a666da66820ecbf38aebfad2d0dc47981..eaf18755b83e3af0c7efe31188ec55c339db379e 100644 (file)
@@ -20,7 +20,8 @@ function participant_payment_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index ed6ab392e5c83d188d54f4c83996d319217ce5c0..96a4481c51cb8c3ca24a787418518aae2fb4d7eb 100644 (file)
@@ -26,7 +26,8 @@ function participant_status_type_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 7b2a442791ba8eeb5c9f2c6fe7ffc2e7a99ce42c..258aa4af10e59e57fbae27bbf6b09d532a7481a7 100644 (file)
@@ -19,7 +19,8 @@ function participant_status_type_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 38c57c57fb17b502b7ece8f08ed6b9abc2b41bc5..318d9b5e794231de9768bec671e9dbd1c5b5ee5f 100644 (file)
@@ -26,7 +26,8 @@ function participant_status_type_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 8ca5613c926b1a4fe537ccd8a2970b31e9fc676d..7d911e279af55eaaf77a4baa58610b3edc190579 100644 (file)
@@ -23,7 +23,8 @@ function payment_processor_create_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index 3b236b659f28e21ff11c6cd7278271e187cb2bed..777f4a7ada90aef5f7b24ee54f4eb471729f66b7 100644 (file)
@@ -19,7 +19,8 @@ function phone_getoptions_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
index d652063920d306513b8ff4311a88e7381f0818b3..2b76a3add9491daa1baba2d577cee0cf1f6e85ba 100644 (file)
@@ -115,7 +115,7 @@ class api_v3_ContributionPageTest extends CiviUnitTestCase {
       'currency' => 'NZD',
       'financial_type_id' => 1,
     );
-    $getResult = $this->callAPIAndDocument($this->_entity, 'get', $getParams, __FUNCTION__, __FILE__);
+    $getResult = $this->callAPISuccess($this->_entity, 'get', $getParams);
     $this->assertEquals(1, $getResult['count']);
   }
 
@@ -337,7 +337,7 @@ class api_v3_ContributionPageTest extends CiviUnitTestCase {
       'cvv2' => 123,
     );
 
-    $this->callAPIAndDocument('contribution_page', 'submit', $submitParams, __FUNCTION__, __FILE__, 'submit contribution page', NULL);
+    $this->callAPISuccess('contribution_page', 'submit', $submitParams);
     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('contribution_page_id' => $this->_ids['contribution_page']));
     $this->callAPISuccess('membership_payment', 'getsingle', array('contribution_id' => $contribution['id']));
     $mut->checkMailLog(array(
@@ -367,7 +367,7 @@ class api_v3_ContributionPageTest extends CiviUnitTestCase {
       'email-Primary' => 'billy-goat@the-new-bridge.net',
     );
 
-    $this->callAPIAndDocument('contribution_page', 'submit', $submitParams, __FUNCTION__, __FILE__, 'submit contribution page', NULL);
+    $this->callAPISuccess('contribution_page', 'submit', $submitParams);
     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('contribution_page_id' => $this->_ids['contribution_page']));
     $this->callAPISuccess('membership_payment', 'getsingle', array('contribution_id' => $contribution['id']));
     $mut->checkMailLog(array(
@@ -398,7 +398,7 @@ class api_v3_ContributionPageTest extends CiviUnitTestCase {
       'selectMembership' => $this->_ids['membership_type'],
     );
 
-    $this->callAPIAndDocument('contribution_page', 'submit', $submitParams, __FUNCTION__, __FILE__, 'submit contribution page', NULL);
+    $this->callAPISuccess('contribution_page', 'submit', $submitParams);
     $contributions = $this->callAPISuccess('contribution', 'get', array('contribution_page_id' => $this->_ids['contribution_page']));
     $this->assertCount(2, $contributions['values']);
     $lines = $this->callAPISuccess('LineItem', 'get', array('sequential' => 1));
@@ -433,7 +433,7 @@ class api_v3_ContributionPageTest extends CiviUnitTestCase {
       'cvv2' => 123,
     );
 
-    $this->callAPIAndDocument('contribution_page', 'submit', $submitParams, __FUNCTION__, __FILE__, 'submit contribution page', NULL);
+    $this->callAPISuccess('contribution_page', 'submit', $submitParams);
     $contributions = $this->callAPISuccess('contribution', 'get', array('contribution_page_id' => $this->_ids['contribution_page']));
     $this->assertCount(2, $contributions['values']);
     $membershipPayment = $this->callAPISuccess('membership_payment', 'getsingle', array());
index 2d7b1db8ca1dd9360cbad6fca1d4680a7816501d..556dab2760aa7f8345999c73400b14b8a8f9dd2f 100644 (file)
@@ -295,7 +295,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase {
     $params = array(
       'contribution_id' => $this->_contribution['id'],
     );
-    $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
+    $contribution = $this->callAPISuccess('contribution', 'get', $params);
     $financialParams['id'] = $this->_financialTypeId;
     $default = NULL;
     CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
@@ -495,7 +495,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase {
       'contribution_status_id' => 1,
     );
 
-    $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
+    $contribution = $this->callAPISuccess('contribution', 'create', $params);
     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
@@ -869,7 +869,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase {
       'contribution_status_id' => 1,
     );
 
-    $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
+    $contribution = $this->callAPISuccess('contribution', 'create', $params);
     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 50.00);
@@ -922,7 +922,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase {
 
     );
 
-    $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
+    $contribution = $this->callAPISuccess('contribution', 'create', $params);
     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
@@ -1015,7 +1015,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase {
       'contribution_status_id' => 2,
     );
 
-    $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
+    $contribution = $this->callAPISuccess('contribution', 'create', $params);
     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
index cd986906f2085e8e98b32f9b811fa028220c5eb6..e2dea8467c144639e87f054cbea7ca10e74cc3f5 100644 (file)
@@ -251,9 +251,7 @@ class api_v3_FinancialTypeACLTest extends CiviUnitTestCase {
       ),
     );
 
-    $description = "Create Contribution with Nested Line Items.";
-    $subfile = "CreateWithNestedLineItems";
-    $config = &CRM_Core_Config::singleton();
+    $config = CRM_Core_Config::singleton();
     $config->userPermissionClass->permissions = array(
       'access CiviCRM',
       'access CiviContribute',
@@ -262,7 +260,7 @@ class api_v3_FinancialTypeACLTest extends CiviUnitTestCase {
       'add contributions of type Donation',
       'delete contributions of type Donation',
     );
-    $contribution = $this->callAPIFailure('contribution', 'create', $params, 'Error in call to LineItem_create : You do not have permission to create this line item');
+    $this->callAPIFailure('contribution', 'create', $params, 'Error in call to LineItem_create : You do not have permission to create this line item');
 
     // Check that the entire contribution has rolled back.
     $contribution = $this->callAPISuccess('contribution', 'get', array());
@@ -270,14 +268,14 @@ class api_v3_FinancialTypeACLTest extends CiviUnitTestCase {
 
     CRM_Financial_BAO_FinancialType::$_availableFinancialTypes = NULL;
 
-    $config = &CRM_Core_Config::singleton();
+    $config = CRM_Core_Config::singleton();
     $config->userPermissionClass->permissions = array_merge($config->userPermissionClass->permissions, array(
       'add contributions of type Member Dues',
       'view contributions of type Donation',
       'view contributions of type Member Dues',
       'delete contributions of type Member Dues',
     ));
-    $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
+    $contribution = $this->callAPISuccess('contribution', 'create', $params);
 
     $lineItemParams = array(
       'contribution_id' => $contribution['id'],
@@ -309,14 +307,14 @@ class api_v3_FinancialTypeACLTest extends CiviUnitTestCase {
       'check_permissions' => TRUE,
       'total_amount' => 200.00,
     );
-    $config = &CRM_Core_Config::singleton();
+    $config = CRM_Core_Config::singleton();
     $config->userPermissionClass->permissions = array(
       'access CiviCRM',
       'access CiviContribute',
       'edit contributions',
       'view contributions of type Donation',
     );
-    $contribution = $this->callAPIFailure('Contribution', 'create', $params);
+    $this->callAPIFailure('Contribution', 'create', $params);
 
     $config->userPermissionClass->permissions[] = 'edit contributions of type Donation';
     $contribution = $this->callAPISuccess('Contribution', 'create', $params);
@@ -329,7 +327,7 @@ class api_v3_FinancialTypeACLTest extends CiviUnitTestCase {
    */
   public function testDeleteACLContribution() {
     $this->setACL();
-    $config = &CRM_Core_Config::singleton();
+    $config = CRM_Core_Config::singleton();
     $config->userPermissionClass->permissions = array(
       'access CiviCRM',
       'access CiviContribute',
@@ -343,7 +341,7 @@ class api_v3_FinancialTypeACLTest extends CiviUnitTestCase {
       'check_permissions' => TRUE,
     );
     $config->userPermissionClass->permissions[3] = 'delete in CiviContribute';
-    $contribution = $this->callAPIFailure('Contribution', 'delete', $params);
+    $this->callAPIFailure('Contribution', 'delete', $params);
 
     $config->userPermissionClass->permissions[] = 'delete contributions of type Donation';
     $contribution = $this->callAPISuccess('Contribution', 'delete', $params);