From 5c49fee0464f5e057f4ff6f1ae974fe0dc6a7748 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Mon, 16 Feb 2015 13:11:31 -0500 Subject: [PATCH] Cleanup api generated example docblocks --- .../Activity/ContactRefCustomField.php | 2 +- api/v3/examples/Activity/Create.php | 1 - api/v3/examples/Activity/DateTimeHigh.php | 2 +- api/v3/examples/Activity/DateTimeLow.php | 2 +- api/v3/examples/Activity/Delete.php | 1 - api/v3/examples/Activity/Get.php | 1 - .../Activity/GetTargetandAssignee.php | 2 +- api/v3/examples/Activity/Getfields.php | 6 +- .../Activity/ReturnAssigneeContact.php | 2 +- api/v3/examples/ActivityContact/Create.php | 1 - api/v3/examples/ActivityContact/Delete.php | 1 - api/v3/examples/Address/AddressLike.php | 2 +- api/v3/examples/Address/AddressParse.php | 2 +- api/v3/examples/Address/AddressSort.php | 2 +- api/v3/examples/Address/Create.php | 1 - api/v3/examples/Address/Delete.php | 1 - api/v3/examples/Address/Get.php | 1 - api/v3/examples/Batch/Create.php | 1 - api/v3/examples/Batch/Delete.php | 1 - api/v3/examples/Batch/Get.php | 1 - api/v3/examples/Batch/Update.php | 1 - api/v3/examples/Campaign/Create.php | 3 +- api/v3/examples/Campaign/Delete.php | 1 - api/v3/examples/Campaign/Get.php | 1 - api/v3/examples/Case/Create.php | 1 - api/v3/examples/Contact/APIChainedArray.php | 3 +- .../Contact/APIChainedArrayFormats.php | 4 +- .../Contact/APIChainedArrayMultipleCustom.php | 2 +- ...IChainedArrayValuesFromSiblingFunction.php | 4 +- api/v3/examples/Contact/ChainTwoWebsites.php | 2 +- .../Contact/ChainTwoWebsitesSyntax2.php | 2 +- api/v3/examples/Contact/Create.php | 2 +- api/v3/examples/Contact/CustomFieldGet.php | 2 +- .../CustomFieldGetReturnSyntaxVariation.php | 2 +- api/v3/examples/Contact/Delete.php | 1 - .../examples/Contact/FormatIsSuccess_Fail.php | 2 +- .../examples/Contact/FormatIsSuccess_True.php | 2 +- api/v3/examples/Contact/FormatOnlyID.php | 6 +- api/v3/examples/Contact/FormatSingleValue.php | 4 +- api/v3/examples/Contact/Get.php | 1 - api/v3/examples/Contact/GetActions.php | 15 +-- api/v3/examples/Contact/GetCountContact.php | 3 +- api/v3/examples/Contact/GetFieldsOptions.php | 8 +- api/v3/examples/Contact/GetSingleContact.php | 6 +- api/v3/examples/Contact/Getoptions.php | 2 +- .../Contact/GroupFilterUsingContactAPI.php | 2 +- .../ContributionCreateWithHonoreeContact.php | 8 +- .../ContributionCreateWithNote.php | 6 +- .../ContributionCreateWithSoftCredit.php | 8 +- ...ntributionCreateWithSoftCreditDefaults.php | 8 +- api/v3/examples/Contribution/Create.php | 5 +- .../CreateWithNestedLineItems.php | 6 +- api/v3/examples/Contribution/Delete.php | 1 - api/v3/examples/Contribution/Get.php | 7 +- api/v3/examples/ContributionPage/Create.php | 1 - api/v3/examples/ContributionPage/Delete.php | 1 - api/v3/examples/ContributionPage/Get.php | 1 - api/v3/examples/ContributionRecur/Create.php | 1 - api/v3/examples/ContributionRecur/Delete.php | 1 - api/v3/examples/ContributionRecur/Get.php | 1 - api/v3/examples/ContributionSoft/Create.php | 1 - api/v3/examples/ContributionSoft/Delete.php | 1 - api/v3/examples/ContributionSoft/Get.php | 1 - api/v3/examples/Country/Create.php | 1 - api/v3/examples/Country/Delete.php | 1 - api/v3/examples/Country/Get.php | 1 - api/v3/examples/CustomField/Create.php | 1 - api/v3/examples/CustomField/Delete.php | 1 - api/v3/examples/CustomGroup/Create.php | 1 - api/v3/examples/CustomGroup/Delete.php | 1 - api/v3/examples/CustomGroup/Get.php | 1 - api/v3/examples/CustomValue/Create.php | 1 - api/v3/examples/CustomValue/Get.php | 2 +- api/v3/examples/Domain/Create.php | 1 - api/v3/examples/Domain/Get.php | 5 +- api/v3/examples/Email/Create.php | 1 - api/v3/examples/Email/Delete.php | 1 - api/v3/examples/Email/NestedReplaceEmail.php | 2 +- api/v3/examples/Email/Replace.php | 1 - api/v3/examples/EntityTag/Create.php | 1 - api/v3/examples/EntityTag/Delete.php | 1 - api/v3/examples/EntityTag/Get.php | 1 - api/v3/examples/Event/Create.php | 1 - api/v3/examples/Event/Delete.php | 1 - api/v3/examples/Event/Get.php | 1 - api/v3/examples/Event/IsCurrentOption.php | 2 +- api/v3/examples/Event/IsFullOption.php | 4 +- api/v3/examples/Grant/Create.php | 1 - api/v3/examples/Grant/Delete.php | 1 - api/v3/examples/Grant/Get.php | 1 - api/v3/examples/Group/Get.php | 1 - api/v3/examples/Group/getfields.php | 2 +- api/v3/examples/GroupContact/Create.php | 1 - api/v3/examples/GroupContact/Delete.php | 1 - api/v3/examples/GroupContact/Get.php | 1 - .../examples/GroupContact/GetWithGroupID.php | 2 +- api/v3/examples/GroupNesting/Create.php | 1 - api/v3/examples/GroupNesting/Delete.php | 1 - api/v3/examples/GroupNesting/Get.php | 1 - api/v3/examples/GroupOrganization/Create.php | 1 - api/v3/examples/GroupOrganization/Delete.php | 1 - api/v3/examples/GroupOrganization/Get.php | 1 - api/v3/examples/Im/Create.php | 1 - api/v3/examples/Im/Delete.php | 1 - api/v3/examples/Im/Get.php | 1 - api/v3/examples/Job/Create.php | 1 - api/v3/examples/Job/Delete.php | 1 - api/v3/examples/LineItem/Create.php | 1 - api/v3/examples/LineItem/Delete.php | 1 - api/v3/examples/LineItem/Get.php | 3 +- api/v3/examples/LocBlock/createEntities.php | 2 +- .../MailSettings/ChainedGetDelete.php | 2 +- api/v3/examples/MailSettings/Create.php | 1 - api/v3/examples/MailSettings/Delete.php | 1 - api/v3/examples/MailSettings/Get.php | 1 - api/v3/examples/Mailing/Create.php | 49 ++++------ api/v3/examples/Mailing/Delete.php | 3 +- api/v3/examples/Mailing/Submit.php | 20 ++-- api/v3/examples/MailingAB/Create.php | 92 +++++++++++++++++++ api/v3/examples/Membership/Create.php | 1 - api/v3/examples/Membership/Delete.php | 1 - api/v3/examples/Membership/Get.php | 1 - api/v3/examples/Membership/Update.php | 1 - .../examples/Membership/filterIsCurrent.php | 2 +- api/v3/examples/MembershipPayment/Create.php | 1 - api/v3/examples/MembershipPayment/Get.php | 1 - api/v3/examples/MembershipStatus/Create.php | 1 - api/v3/examples/MembershipStatus/Get.php | 1 - api/v3/examples/MembershipType/Create.php | 1 - api/v3/examples/MembershipType/Delete.php | 1 - api/v3/examples/MembershipType/Get.php | 1 - api/v3/examples/MessageTemplate/Create.php | 7 +- api/v3/examples/MessageTemplate/Delete.php | 3 +- api/v3/examples/MessageTemplate/Get.php | 7 +- api/v3/examples/Note/Create.php | 1 - api/v3/examples/Note/Delete.php | 1 - api/v3/examples/Note/Get.php | 1 - api/v3/examples/OptionGroup/Create.php | 7 +- api/v3/examples/OptionGroup/Delete.php | 3 +- api/v3/examples/OptionGroup/Get.php | 1 - api/v3/examples/OptionValue/Get.php | 1 - api/v3/examples/OptionValue/SortOption.php | 2 +- api/v3/examples/Participant/Create.php | 1 - .../Participant/CreateParticipantPayment.php | 4 +- api/v3/examples/Participant/Get.php | 1 - api/v3/examples/Participant/NestedDelete.php | 2 +- .../examples/Participant/NestedEventGet.php | 2 +- api/v3/examples/ParticipantPayment/Create.php | 1 - api/v3/examples/ParticipantPayment/Delete.php | 1 - api/v3/examples/ParticipantPayment/Get.php | 1 - .../examples/ParticipantStatusType/Create.php | 3 +- .../examples/ParticipantStatusType/Delete.php | 1 - api/v3/examples/ParticipantStatusType/Get.php | 3 +- api/v3/examples/PaymentProcessor/Create.php | 3 +- api/v3/examples/PaymentProcessor/Delete.php | 1 - .../examples/PaymentProcessorType/Create.php | 1 - .../examples/PaymentProcessorType/Delete.php | 1 - api/v3/examples/Phone/Create.php | 1 - api/v3/examples/Phone/Delete.php | 1 - api/v3/examples/Phone/Get.php | 1 - api/v3/examples/Pledge/Create.php | 7 +- api/v3/examples/Pledge/Delete.php | 1 - api/v3/examples/Pledge/Get.php | 5 +- api/v3/examples/Pledge/GetFilterHighDate.php | 4 +- api/v3/examples/PledgePayment/Create.php | 1 - api/v3/examples/PledgePayment/Delete.php | 1 - api/v3/examples/PledgePayment/Get.php | 1 - api/v3/examples/PledgePayment/Update.php | 1 - api/v3/examples/PriceField/Create.php | 1 - api/v3/examples/PriceField/Delete.php | 1 - api/v3/examples/PriceField/Get.php | 1 - api/v3/examples/PriceFieldValue/Create.php | 1 - api/v3/examples/PriceFieldValue/Delete.php | 1 - api/v3/examples/PriceFieldValue/Get.php | 1 - api/v3/examples/PriceSet/Create.php | 1 - api/v3/examples/PriceSet/Delete.php | 1 - api/v3/examples/PriceSet/Get.php | 1 - api/v3/examples/Profile/Apply.php | 1 - api/v3/examples/Profile/Get.php | 1 - api/v3/examples/Profile/GetFields.php | 1 + api/v3/examples/Profile/Submit.php | 1 - .../Relationship/BetweenRelationshipType.php | 2 +- api/v3/examples/Relationship/Create.php | 1 - api/v3/examples/Relationship/Delete.php | 1 - api/v3/examples/Relationship/Get.php | 1 - .../Relationship/INRelationshipType.php | 2 +- .../NotBetweenRelationshipType.php | 2 +- .../Relationship/NotInRelationshipType.php | 2 +- .../examples/Relationship/filterIsCurrent.php | 2 +- api/v3/examples/RelationshipType/Create.php | 1 - api/v3/examples/RelationshipType/Delete.php | 1 - api/v3/examples/ReportTemplate/Getrows.php | 2 +- .../examples/ReportTemplate/Getstatistics.php | 2 +- api/v3/examples/Setting/Create.php | 1 - api/v3/examples/Setting/CreateAllDomains.php | 2 +- .../Setting/CreateSettingCurrentDomain.php | 2 +- .../Setting/CreateSpecifiedDomains.php | 2 +- api/v3/examples/Setting/Get.php | 1 - api/v3/examples/Setting/GetAllDomains.php | 2 +- api/v3/examples/Setting/GetDefaults.php | 2 +- api/v3/examples/Setting/GetFields.php | 36 +++----- .../Setting/GetSettingCurrentDomain.php | 2 +- .../examples/Setting/GetSpecifiedDomains.php | 2 +- api/v3/examples/Setting/GetValue.php | 2 +- api/v3/examples/Setting/Revert.php | 2 +- api/v3/examples/Survey/ChainedGetDelete.php | 2 +- api/v3/examples/Survey/Create.php | 1 - api/v3/examples/Survey/Delete.php | 1 - api/v3/examples/Survey/Get.php | 1 - api/v3/examples/Tag/Create.php | 1 - api/v3/examples/Tag/Delete.php | 1 - api/v3/examples/Tag/Get.php | 1 - api/v3/examples/Tag/GetList.php | 2 +- api/v3/examples/Tag/Getfields.php | 2 +- api/v3/examples/Tag/getReturnArray.php | 2 +- .../examples/TaxContributionPage/Create.php | 1 - .../CreateWithNestedLineItems.php | 2 +- .../examples/TaxContributionPage/Delete.php | 1 - api/v3/examples/UFField/Create.php | 1 - api/v3/examples/UFField/Delete.php | 1 - api/v3/examples/UFField/Get.php | 1 - api/v3/examples/UFField/Replace.php | 1 - api/v3/examples/UFGroup/Create.php | 1 - api/v3/examples/UFGroup/Delete.php | 1 - api/v3/examples/UFGroup/Get.php | 1 - api/v3/examples/UFJoin/Create.php | 1 - api/v3/examples/UFJoin/Get.php | 1 - api/v3/examples/UFMatch/Get.php | 1 - api/v3/examples/Website/Create.php | 1 - api/v3/examples/Website/Delete.php | 1 - api/v3/examples/Website/Get.php | 1 - api/v3/examples/Website/GetFields.php | 1 - tests/phpunit/CiviTest/CiviUnitTestCase.php | 9 +- tests/phpunit/api/v3/ActivityTest.php | 13 ++- tests/phpunit/api/v3/AddressTest.php | 6 +- tests/phpunit/api/v3/CampaignTest.php | 3 +- tests/phpunit/api/v3/ContactTest.php | 42 ++++----- tests/phpunit/api/v3/ContributionTest.php | 10 +- tests/phpunit/api/v3/CustomFieldTest.php | 4 +- tests/phpunit/api/v3/CustomValueTest.php | 2 +- tests/phpunit/api/v3/EmailTest.php | 2 +- tests/phpunit/api/v3/EventTest.php | 12 +-- tests/phpunit/api/v3/GroupContactTest.php | 2 +- tests/phpunit/api/v3/GroupTest.php | 2 +- tests/phpunit/api/v3/LocBlockTest.php | 2 +- tests/phpunit/api/v3/MailSettingsTest.php | 2 +- tests/phpunit/api/v3/MembershipTest.php | 2 +- tests/phpunit/api/v3/OptionValueTest.php | 2 +- tests/phpunit/api/v3/ParticipantTest.php | 8 +- tests/phpunit/api/v3/RelationshipTest.php | 10 +- tests/phpunit/api/v3/ReportTemplateTest.php | 4 +- tests/phpunit/api/v3/SettingTest.php | 22 ++--- tests/phpunit/api/v3/SurveyTest.php | 2 +- tests/phpunit/api/v3/TagTest.php | 6 +- .../api/v3/TaxContributionPageTest.php | 2 +- tests/templates/documentFunction.tpl | 4 +- 256 files changed, 359 insertions(+), 436 deletions(-) create mode 100644 api/v3/examples/MailingAB/Create.php diff --git a/api/v3/examples/Activity/ContactRefCustomField.php b/api/v3/examples/Activity/ContactRefCustomField.php index 1744322fe2..667f35181f 100644 --- a/api/v3/examples/Activity/ContactRefCustomField.php +++ b/api/v3/examples/Activity/ContactRefCustomField.php @@ -2,7 +2,7 @@ /** * Test Generated example of using activity Create API. * - * demonstrates create with Contact Reference Custom Field + * Demonstrates create with Contact Reference Custom Field. * * @return array * API result array diff --git a/api/v3/examples/Activity/Create.php b/api/v3/examples/Activity/Create.php index 8659e8e06a..9fb931ea18 100644 --- a/api/v3/examples/Activity/Create.php +++ b/api/v3/examples/Activity/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using activity create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Activity/DateTimeHigh.php b/api/v3/examples/Activity/DateTimeHigh.php index 2eca4a3d6b..7865edbb35 100644 --- a/api/v3/examples/Activity/DateTimeHigh.php +++ b/api/v3/examples/Activity/DateTimeHigh.php @@ -2,7 +2,7 @@ /** * Test Generated example of using activity get API. * - * demonstrates _high filter (at time of writing doesn't work if contact_id is set + * Demonstrates _high filter (at time of writing doesn't work if contact_id is set. * * @return array * API result array diff --git a/api/v3/examples/Activity/DateTimeLow.php b/api/v3/examples/Activity/DateTimeLow.php index 13e2d8ecd2..1dd6ab34ee 100644 --- a/api/v3/examples/Activity/DateTimeLow.php +++ b/api/v3/examples/Activity/DateTimeLow.php @@ -2,7 +2,7 @@ /** * Test Generated example of using activity get API. * - * demonstrates _low filter (at time of writing doesn't work if contact_id is set + * Demonstrates _low filter (at time of writing doesn't work if contact_id is set. * * @return array * API result array diff --git a/api/v3/examples/Activity/Delete.php b/api/v3/examples/Activity/Delete.php index 37041124cf..9754a7adf0 100644 --- a/api/v3/examples/Activity/Delete.php +++ b/api/v3/examples/Activity/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using activity delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Activity/Get.php b/api/v3/examples/Activity/Get.php index 5b9f09f7b0..1c00faffa5 100644 --- a/api/v3/examples/Activity/Get.php +++ b/api/v3/examples/Activity/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using activity get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Activity/GetTargetandAssignee.php b/api/v3/examples/Activity/GetTargetandAssignee.php index 4185d41bee..caf94adc74 100644 --- a/api/v3/examples/Activity/GetTargetandAssignee.php +++ b/api/v3/examples/Activity/GetTargetandAssignee.php @@ -2,7 +2,7 @@ /** * Test Generated example of using activity API. * - * Example demonstrates setting & retrieving the target & source + * Demonstrates setting & retrieving activity target & source. * * @return array * API result array diff --git a/api/v3/examples/Activity/Getfields.php b/api/v3/examples/Activity/Getfields.php index 6e0f683871..1f4e915ada 100644 --- a/api/v3/examples/Activity/Getfields.php +++ b/api/v3/examples/Activity/Getfields.php @@ -2,7 +2,6 @@ /** * Test Generated example of using activity getfields API. * - * * @return array * API result array */ @@ -50,11 +49,12 @@ function activity_getfields_expectedresult() { 'activity_type_id' => array( 'name' => 'activity_type_id', 'type' => 1, - 'title' => 'Activity Type', + 'title' => 'Activity Type ID', 'required' => TRUE, 'import' => TRUE, 'where' => 'civicrm_activity.activity_type_id', 'headerPattern' => '/(activity.)?type(.id$)/i', + 'export' => TRUE, 'default' => '1', 'html' => array( 'type' => 'Select', @@ -149,7 +149,7 @@ function activity_getfields_expectedresult() { 'weight' => array( 'name' => 'weight', 'type' => 1, - 'title' => 'Weight', + 'title' => 'Order', 'html' => array( 'type' => 'Text', ), diff --git a/api/v3/examples/Activity/ReturnAssigneeContact.php b/api/v3/examples/Activity/ReturnAssigneeContact.php index d375cd9bbb..07ebf0479c 100644 --- a/api/v3/examples/Activity/ReturnAssigneeContact.php +++ b/api/v3/examples/Activity/ReturnAssigneeContact.php @@ -2,7 +2,7 @@ /** * Test Generated example of using activity get API. * - * Function demonstrates getting asignee_contact_id & using it to get the contact + * Demonstrates getting asignee_contact_id & using it to get the contact. * * @return array * API result array diff --git a/api/v3/examples/ActivityContact/Create.php b/api/v3/examples/ActivityContact/Create.php index 1fea66168e..bdf8db5033 100644 --- a/api/v3/examples/ActivityContact/Create.php +++ b/api/v3/examples/ActivityContact/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using activity_contact create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ActivityContact/Delete.php b/api/v3/examples/ActivityContact/Delete.php index 611e3dd77c..3ab9da06b8 100644 --- a/api/v3/examples/ActivityContact/Delete.php +++ b/api/v3/examples/ActivityContact/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using activity_contact delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Address/AddressLike.php b/api/v3/examples/Address/AddressLike.php index 718930c4f0..eb1a856458 100644 --- a/api/v3/examples/Address/AddressLike.php +++ b/api/v3/examples/Address/AddressLike.php @@ -2,7 +2,7 @@ /** * Test Generated example of using address get API. * - * Demonstrates Use of Like + * Demonstrates Use of Like. * * @return array * API result array diff --git a/api/v3/examples/Address/AddressParse.php b/api/v3/examples/Address/AddressParse.php index 8fab754f67..64ac88c20d 100644 --- a/api/v3/examples/Address/AddressParse.php +++ b/api/v3/examples/Address/AddressParse.php @@ -2,7 +2,7 @@ /** * Test Generated example of using address create API. * - * Demonstrates Use of address parsing param + * Demonstrates Use of address parsing param. * * @return array * API result array diff --git a/api/v3/examples/Address/AddressSort.php b/api/v3/examples/Address/AddressSort.php index 2dd0b23676..8194916378 100644 --- a/api/v3/examples/Address/AddressSort.php +++ b/api/v3/examples/Address/AddressSort.php @@ -2,7 +2,7 @@ /** * Test Generated example of using address get API. * - * Demonstrates Use of sort filter + * Demonstrates Use of sort filter. * * @return array * API result array diff --git a/api/v3/examples/Address/Create.php b/api/v3/examples/Address/Create.php index bf50db7a33..9c202a415a 100644 --- a/api/v3/examples/Address/Create.php +++ b/api/v3/examples/Address/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using address create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Address/Delete.php b/api/v3/examples/Address/Delete.php index cb8ebea86a..a2ea4376cd 100644 --- a/api/v3/examples/Address/Delete.php +++ b/api/v3/examples/Address/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using address delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Address/Get.php b/api/v3/examples/Address/Get.php index 21b0aead80..8238fe1897 100644 --- a/api/v3/examples/Address/Get.php +++ b/api/v3/examples/Address/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using address get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Batch/Create.php b/api/v3/examples/Batch/Create.php index 9685842819..213231bd9d 100644 --- a/api/v3/examples/Batch/Create.php +++ b/api/v3/examples/Batch/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using batch create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Batch/Delete.php b/api/v3/examples/Batch/Delete.php index 3d2a40e33e..c2cb472713 100644 --- a/api/v3/examples/Batch/Delete.php +++ b/api/v3/examples/Batch/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using batch delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Batch/Get.php b/api/v3/examples/Batch/Get.php index 2481be6e5e..7b22ce9ca2 100644 --- a/api/v3/examples/Batch/Get.php +++ b/api/v3/examples/Batch/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using batch get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Batch/Update.php b/api/v3/examples/Batch/Update.php index afce6012b1..df859472e4 100644 --- a/api/v3/examples/Batch/Update.php +++ b/api/v3/examples/Batch/Update.php @@ -2,7 +2,6 @@ /** * Test Generated example of using batch update API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Campaign/Create.php b/api/v3/examples/Campaign/Create.php index 0c5af7391b..c365be272f 100644 --- a/api/v3/examples/Campaign/Create.php +++ b/api/v3/examples/Campaign/Create.php @@ -2,7 +2,8 @@ /** * Test Generated example of using campaign create API. * - * Create a campaign - Note use of relative dates here http://www.php.net/manual/en/datetime.formats.relative.php + * Create a campaign - Note use of relative dates here: + * @link http://www.php.net/manual/en/datetime.formats.relative.php. * * @return array * API result array diff --git a/api/v3/examples/Campaign/Delete.php b/api/v3/examples/Campaign/Delete.php index 6e587b36cc..bd00bfa5aa 100644 --- a/api/v3/examples/Campaign/Delete.php +++ b/api/v3/examples/Campaign/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using campaign delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Campaign/Get.php b/api/v3/examples/Campaign/Get.php index a9593a77b4..417ff574df 100644 --- a/api/v3/examples/Campaign/Get.php +++ b/api/v3/examples/Campaign/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using campaign get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Case/Create.php b/api/v3/examples/Case/Create.php index 83cbe836aa..f5047d6cd9 100644 --- a/api/v3/examples/Case/Create.php +++ b/api/v3/examples/Case/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using case create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Contact/APIChainedArray.php b/api/v3/examples/Contact/APIChainedArray.php index 7c8538c064..5c78e3cb6a 100644 --- a/api/v3/examples/Contact/APIChainedArray.php +++ b/api/v3/examples/Contact/APIChainedArray.php @@ -2,7 +2,8 @@ /** * Test Generated example of using contact get API. * - * /*this demonstrates the usage of chained api functions. In this case no notes or custom fields have been created + * This demonstrates the usage of chained api functions. + * In this case no notes or custom fields have been created. * * @return array * API result array diff --git a/api/v3/examples/Contact/APIChainedArrayFormats.php b/api/v3/examples/Contact/APIChainedArrayFormats.php index 57080328ed..fcfd55808b 100644 --- a/api/v3/examples/Contact/APIChainedArrayFormats.php +++ b/api/v3/examples/Contact/APIChainedArrayFormats.php @@ -2,8 +2,8 @@ /** * Test Generated example of using contact get API. * - * /*this demonstrates the usage of chained api functions. A variety of return formats are used. Note that no notes - *custom fields or memberships exist + * This demonstrates the usage of chained api functions. + * In this case no notes or custom fields have been created. * * @return array * API result array diff --git a/api/v3/examples/Contact/APIChainedArrayMultipleCustom.php b/api/v3/examples/Contact/APIChainedArrayMultipleCustom.php index 42237b48ad..0b8778af6a 100644 --- a/api/v3/examples/Contact/APIChainedArrayMultipleCustom.php +++ b/api/v3/examples/Contact/APIChainedArrayMultipleCustom.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact get API. * - * /*this demonstrates the usage of chained api functions. A variety of techniques are used + * This demonstrates the usage of chained api functions with multiple custom fields. * * @return array * API result array diff --git a/api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.php b/api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.php index 99486a32ae..66d9ac6463 100644 --- a/api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.php +++ b/api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.php @@ -2,8 +2,8 @@ /** * Test Generated example of using contact create API. * - * /*this demonstrates the usage of chained api functions. Specifically it has one 'parent function' & - 2 child functions - one receives values from the parent (Contact) and the other child (Tag). + * This demonstrates the usage of chained api functions. Specifically it has one 'parent function' & + * 2 child functions - one receives values from the parent (Contact) and the other child (Tag). * * @return array * API result array diff --git a/api/v3/examples/Contact/ChainTwoWebsites.php b/api/v3/examples/Contact/ChainTwoWebsites.php index 9c419d20e2..b0da942567 100644 --- a/api/v3/examples/Contact/ChainTwoWebsites.php +++ b/api/v3/examples/Contact/ChainTwoWebsites.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact create API. * - * test demonstrates the syntax to create 2 chained entities + * This demonstrates the syntax to create 2 chained entities. * * @return array * API result array diff --git a/api/v3/examples/Contact/ChainTwoWebsitesSyntax2.php b/api/v3/examples/Contact/ChainTwoWebsitesSyntax2.php index 823aff7a5e..f9d8ba0bd3 100644 --- a/api/v3/examples/Contact/ChainTwoWebsitesSyntax2.php +++ b/api/v3/examples/Contact/ChainTwoWebsitesSyntax2.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact create API. * - * demonstrates creating two websites as an array + * Demonstrates creating two websites as an array. * * @return array * API result array diff --git a/api/v3/examples/Contact/Create.php b/api/v3/examples/Contact/Create.php index 8416af1ebc..19d637bbd5 100644 --- a/api/v3/examples/Contact/Create.php +++ b/api/v3/examples/Contact/Create.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact create API. * - * /*this demonstrates setting a custom field through the API + * This demonstrates setting a custom field through the API. * * @return array * API result array diff --git a/api/v3/examples/Contact/CustomFieldGet.php b/api/v3/examples/Contact/CustomFieldGet.php index 8b173904bc..7985aa8438 100644 --- a/api/v3/examples/Contact/CustomFieldGet.php +++ b/api/v3/examples/Contact/CustomFieldGet.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact get API. * - * /*this demonstrates setting a custom field through the API + * This demonstrates setting a custom field through the API. * * @return array * API result array diff --git a/api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.php b/api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.php index a8ed1e43bb..7538f64fa9 100644 --- a/api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.php +++ b/api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact get API. * - * /*this demonstrates setting a custom field through the API + * This demonstrates setting a custom field through the API. * * @return array * API result array diff --git a/api/v3/examples/Contact/Delete.php b/api/v3/examples/Contact/Delete.php index 72597cdf1b..bf63bac717 100644 --- a/api/v3/examples/Contact/Delete.php +++ b/api/v3/examples/Contact/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contact delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Contact/FormatIsSuccess_Fail.php b/api/v3/examples/Contact/FormatIsSuccess_Fail.php index 80c14c64de..48baa5f77d 100644 --- a/api/v3/examples/Contact/FormatIsSuccess_Fail.php +++ b/api/v3/examples/Contact/FormatIsSuccess_Fail.php @@ -3,7 +3,7 @@ * Test Generated example of using contact create API. * * This demonstrates use of the 'format.is_success' param. - This param causes only the success or otherwise of the function to be returned as BOOLEAN + * This param causes only the success or otherwise of the function to be returned as BOOLEAN * * @return array * API result array diff --git a/api/v3/examples/Contact/FormatIsSuccess_True.php b/api/v3/examples/Contact/FormatIsSuccess_True.php index 21041ad3dd..fa0c11fcd1 100644 --- a/api/v3/examples/Contact/FormatIsSuccess_True.php +++ b/api/v3/examples/Contact/FormatIsSuccess_True.php @@ -3,7 +3,7 @@ * Test Generated example of using contact get API. * * This demonstrates use of the 'format.is_success' param. - This param causes only the success or otherwise of the function to be returned as BOOLEAN + * This param causes only the success or otherwise of the function to be returned as BOOLEAN * * @return array * API result array diff --git a/api/v3/examples/Contact/FormatOnlyID.php b/api/v3/examples/Contact/FormatOnlyID.php index 635ce454e2..843055349c 100644 --- a/api/v3/examples/Contact/FormatOnlyID.php +++ b/api/v3/examples/Contact/FormatOnlyID.php @@ -3,8 +3,8 @@ * Test Generated example of using contact get API. * * This demonstrates use of the 'format.id_only' param. - /* This param causes the id of the only entity to be returned as an integer. - /* it will be ignored if there is not exactly 1 result + * This param causes the id of the only entity to be returned as an integer. + * It will be ignored if there is not exactly 1 result * * @return array * API result array @@ -49,7 +49,7 @@ function contact_get_expectedresult() { /** * This example has been generated from the API test suite. * The test that created it is called -* testContactGetFormatID_only +* testContactGetFormatIDOnly * and can be found in * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php * diff --git a/api/v3/examples/Contact/FormatSingleValue.php b/api/v3/examples/Contact/FormatSingleValue.php index 74374e870d..587b621c2f 100644 --- a/api/v3/examples/Contact/FormatSingleValue.php +++ b/api/v3/examples/Contact/FormatSingleValue.php @@ -3,8 +3,8 @@ * Test Generated example of using contact getvalue API. * * This demonstrates use of the 'format.single_value' param. - /* This param causes only a single value of the only entity to be returned as an string. - /* it will be ignored if there is not exactly 1 result + * This param causes only a single value of the only entity to be returned as an string. + * It will be ignored if there is not exactly 1 result * * @return array * API result array diff --git a/api/v3/examples/Contact/Get.php b/api/v3/examples/Contact/Get.php index f82ecbc041..7f18069ada 100644 --- a/api/v3/examples/Contact/Get.php +++ b/api/v3/examples/Contact/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contact get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Contact/GetActions.php b/api/v3/examples/Contact/GetActions.php index 2ad782f70f..e5bc1e9968 100644 --- a/api/v3/examples/Contact/GetActions.php +++ b/api/v3/examples/Contact/GetActions.php @@ -39,7 +39,7 @@ function contact_getactions_expectedresult() { $expectedResult = array( 'is_error' => 0, 'version' => 3, - 'count' => 17, + 'count' => 18, 'values' => array( '0' => 'create', '1' => 'delete', @@ -52,12 +52,13 @@ function contact_getactions_expectedresult() { '8' => 'getquick', '9' => 'getrefcount', '10' => 'getsingle', - '11' => 'getvalue', - '12' => 'merge', - '13' => 'proximity', - '14' => 'replace', - '15' => 'setvalue', - '16' => 'update', + '11' => 'getstat', + '12' => 'getvalue', + '13' => 'merge', + '14' => 'proximity', + '15' => 'replace', + '16' => 'setvalue', + '17' => 'update', ), 'deprecated' => array( 'getquick' => 'The "getquick" action is deprecated in favor of "getlist".', diff --git a/api/v3/examples/Contact/GetCountContact.php b/api/v3/examples/Contact/GetCountContact.php index 5386cc627d..17be29dd0c 100644 --- a/api/v3/examples/Contact/GetCountContact.php +++ b/api/v3/examples/Contact/GetCountContact.php @@ -3,7 +3,6 @@ * Test Generated example of using contact getcount API. * * This demonstrates use of the 'getCount' action. - * * This param causes the count of the only function to be returned as an integer. * * @return array @@ -48,7 +47,7 @@ function contact_getcount_expectedresult() { /** * This example has been generated from the API test suite. * The test that created it is called -* testContactGetFormatCount_only +* testContactGetFormatCountOnly * and can be found in * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php * diff --git a/api/v3/examples/Contact/GetFieldsOptions.php b/api/v3/examples/Contact/GetFieldsOptions.php index 92731d9f05..bbca0bac69 100644 --- a/api/v3/examples/Contact/GetFieldsOptions.php +++ b/api/v3/examples/Contact/GetFieldsOptions.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact GetFields API. * - * Demonstrate retrieving metadata with custom field options + * Demonstrates retrieving metadata with custom field options. * * @return array * API result array @@ -194,7 +194,7 @@ function contact_getfields_expectedresult() { 'name' => 'external_identifier', 'type' => 2, 'title' => 'External Identifier', - 'maxlength' => 32, + 'maxlength' => 64, 'size' => 8, 'import' => TRUE, 'where' => 'civicrm_contact.external_identifier', @@ -741,7 +741,7 @@ function contact_getfields_expectedresult() { 'extends_entity_column_id' => '', 'is_view' => 0, 'is_multiple' => 0, - 'option_group_id' => '105', + 'option_group_id' => '106', 'date_format' => '', 'time_format' => '', 'is_required' => '1', @@ -757,10 +757,12 @@ function contact_getfields_expectedresult() { 'title' => 'Current Employer', 'description' => 'Name of Current Employer', 'type' => 2, + 'name' => 'current_employer', ), 'dupe_check' => array( 'title' => 'Check for Duplicates', 'description' => 'Throw error if contact create matches dedupe rule', + 'name' => 'dupe_check', ), ), ); diff --git a/api/v3/examples/Contact/GetSingleContact.php b/api/v3/examples/Contact/GetSingleContact.php index 1b4a82b256..6642adce2d 100644 --- a/api/v3/examples/Contact/GetSingleContact.php +++ b/api/v3/examples/Contact/GetSingleContact.php @@ -3,8 +3,8 @@ * Test Generated example of using contact getsingle API. * * This demonstrates use of the 'format.single_entity_array' param. - /* This param causes the only contact to be returned as an array without the other levels. - /* it will be ignored if there is not exactly 1 result + * This param causes the only contact to be returned as an array without the other levels. + * It will be ignored if there is not exactly 1 result * * @return array * API result array @@ -115,7 +115,7 @@ function contact_getsingle_expectedresult() { /** * This example has been generated from the API test suite. * The test that created it is called -* testContactGetSingle_entity_array +* testContactGetSingleEntityArray * and can be found in * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php * diff --git a/api/v3/examples/Contact/Getoptions.php b/api/v3/examples/Contact/Getoptions.php index 761afdaec8..93ddaa1446 100644 --- a/api/v3/examples/Contact/Getoptions.php +++ b/api/v3/examples/Contact/Getoptions.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact getoptions API. * - * Demonstrates retrieving options for a custom field + * Demonstrates retrieving options for a custom field. * * @return array * API result array diff --git a/api/v3/examples/Contact/GroupFilterUsingContactAPI.php b/api/v3/examples/Contact/GroupFilterUsingContactAPI.php index ec1b49ae4b..3e721bc417 100644 --- a/api/v3/examples/Contact/GroupFilterUsingContactAPI.php +++ b/api/v3/examples/Contact/GroupFilterUsingContactAPI.php @@ -2,7 +2,7 @@ /** * Test Generated example of using contact get API. * - * Get all from group and display contacts + * Get all from group and display contacts. * * @return array * API result array diff --git a/api/v3/examples/Contribution/ContributionCreateWithHonoreeContact.php b/api/v3/examples/Contribution/ContributionCreateWithHonoreeContact.php index 7db6e5e1f6..c4c2f0ccde 100644 --- a/api/v3/examples/Contribution/ContributionCreateWithHonoreeContact.php +++ b/api/v3/examples/Contribution/ContributionCreateWithHonoreeContact.php @@ -2,14 +2,14 @@ /** * Test Generated example of using contribution create API. * - * Demonstrates creating contribution with Soft Credit by passing in honor_contact_id + * Demonstrates creating contribution with Soft Credit by passing in honor_contact_id. * * @return array * API result array */ function contribution_create_example() { $params = array( - 'contact_id' => 24, + 'contact_id' => 23, 'receive_date' => '20120511', 'total_amount' => '100', 'financial_type_id' => 1, @@ -18,7 +18,7 @@ function contribution_create_example() { 'net_amount' => '95', 'source' => 'SSF', 'contribution_status_id' => 1, - 'honor_contact_id' => 25, + 'honor_contact_id' => 24, ); try{ @@ -55,7 +55,7 @@ function contribution_create_expectedresult() { 'values' => array( '1' => array( 'id' => '1', - 'contact_id' => '24', + 'contact_id' => '23', 'financial_type_id' => '1', 'contribution_page_id' => '', 'payment_instrument_id' => '4', diff --git a/api/v3/examples/Contribution/ContributionCreateWithNote.php b/api/v3/examples/Contribution/ContributionCreateWithNote.php index d68597b415..ed1a02846d 100644 --- a/api/v3/examples/Contribution/ContributionCreateWithNote.php +++ b/api/v3/examples/Contribution/ContributionCreateWithNote.php @@ -2,14 +2,14 @@ /** * Test Generated example of using contribution create API. * - * Demonstrates creating contribution with Note Entity + * Demonstrates creating contribution with Note Entity. * * @return array * API result array */ function contribution_create_example() { $params = array( - 'contact_id' => 18, + 'contact_id' => 17, 'receive_date' => '2012-01-01', 'total_amount' => '100', 'financial_type_id' => 1, @@ -58,7 +58,7 @@ function contribution_create_expectedresult() { 'values' => array( '1' => array( 'id' => '1', - 'contact_id' => '18', + 'contact_id' => '17', 'financial_type_id' => '1', 'contribution_page_id' => '', 'payment_instrument_id' => '1', diff --git a/api/v3/examples/Contribution/ContributionCreateWithSoftCredit.php b/api/v3/examples/Contribution/ContributionCreateWithSoftCredit.php index 6151385148..eb0e94e79a 100644 --- a/api/v3/examples/Contribution/ContributionCreateWithSoftCredit.php +++ b/api/v3/examples/Contribution/ContributionCreateWithSoftCredit.php @@ -2,14 +2,14 @@ /** * Test Generated example of using contribution create API. * - * Demonstrates creating contribution with SoftCredit + * Demonstrates creating contribution with SoftCredit. * * @return array * API result array */ function contribution_create_example() { $params = array( - 'contact_id' => 20, + 'contact_id' => 19, 'receive_date' => '20120511', 'total_amount' => '100', 'financial_type_id' => 1, @@ -20,7 +20,7 @@ function contribution_create_example() { 'contribution_status_id' => 1, 'soft_credit' => array( '1' => array( - 'contact_id' => 21, + 'contact_id' => 20, 'amount' => 50, 'soft_credit_type_id' => 3, ), @@ -61,7 +61,7 @@ function contribution_create_expectedresult() { 'values' => array( '1' => array( 'id' => '1', - 'contact_id' => '20', + 'contact_id' => '19', 'financial_type_id' => '1', 'contribution_page_id' => '', 'payment_instrument_id' => '4', diff --git a/api/v3/examples/Contribution/ContributionCreateWithSoftCreditDefaults.php b/api/v3/examples/Contribution/ContributionCreateWithSoftCreditDefaults.php index 92b6fb984e..51f2acb6d3 100644 --- a/api/v3/examples/Contribution/ContributionCreateWithSoftCreditDefaults.php +++ b/api/v3/examples/Contribution/ContributionCreateWithSoftCreditDefaults.php @@ -2,14 +2,14 @@ /** * Test Generated example of using contribution create API. * - * Demonstrates creating contribution with Soft Credit defaults for amount and type + * Demonstrates creating contribution with Soft Credit defaults for amount and type. * * @return array * API result array */ function contribution_create_example() { $params = array( - 'contact_id' => 22, + 'contact_id' => 21, 'receive_date' => '20120511', 'total_amount' => '100', 'financial_type_id' => 1, @@ -18,7 +18,7 @@ function contribution_create_example() { 'net_amount' => '95', 'source' => 'SSF', 'contribution_status_id' => 1, - 'soft_credit_to' => 23, + 'soft_credit_to' => 22, ); try{ @@ -55,7 +55,7 @@ function contribution_create_expectedresult() { 'values' => array( '1' => array( 'id' => '1', - 'contact_id' => '22', + 'contact_id' => '21', 'financial_type_id' => '1', 'contribution_page_id' => '', 'payment_instrument_id' => '4', diff --git a/api/v3/examples/Contribution/Create.php b/api/v3/examples/Contribution/Create.php index 43e77cb4c4..065689de77 100644 --- a/api/v3/examples/Contribution/Create.php +++ b/api/v3/examples/Contribution/Create.php @@ -2,13 +2,12 @@ /** * Test Generated example of using contribution create API. * - * * @return array * API result array */ function contribution_create_example() { $params = array( - 'contact_id' => 1, + 'contact_id' => 31, 'receive_date' => '20120511', 'total_amount' => '100', 'financial_type_id' => 1, @@ -53,7 +52,7 @@ function contribution_create_expectedresult() { 'values' => array( '1' => array( 'id' => '1', - 'contact_id' => '1', + 'contact_id' => '31', 'financial_type_id' => '1', 'contribution_page_id' => '1', 'payment_instrument_id' => '4', diff --git a/api/v3/examples/Contribution/CreateWithNestedLineItems.php b/api/v3/examples/Contribution/CreateWithNestedLineItems.php index 2d495573c3..3056cfc1dc 100644 --- a/api/v3/examples/Contribution/CreateWithNestedLineItems.php +++ b/api/v3/examples/Contribution/CreateWithNestedLineItems.php @@ -2,14 +2,14 @@ /** * Test Generated example of using contribution create API. * - * Create Contribution with Nested Line Items + * Create Contribution with Nested Line Items. * * @return array * API result array */ function contribution_create_example() { $params = array( - 'contact_id' => 10, + 'contact_id' => 9, 'receive_date' => '20120511', 'total_amount' => '100', 'financial_type_id' => 1, @@ -72,7 +72,7 @@ function contribution_create_expectedresult() { 'values' => array( '1' => array( 'id' => '1', - 'contact_id' => '10', + 'contact_id' => '9', 'financial_type_id' => '1', 'contribution_page_id' => '', 'payment_instrument_id' => '1', diff --git a/api/v3/examples/Contribution/Delete.php b/api/v3/examples/Contribution/Delete.php index 309454a4a5..9617d619b2 100644 --- a/api/v3/examples/Contribution/Delete.php +++ b/api/v3/examples/Contribution/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Contribution/Get.php b/api/v3/examples/Contribution/Get.php index 269ec71c3d..d5abc40e06 100644 --- a/api/v3/examples/Contribution/Get.php +++ b/api/v3/examples/Contribution/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution get API. * - * * @return array * API result array */ @@ -71,8 +70,6 @@ function contribution_get_expectedresult() { 'contribution_campaign_id' => '', 'financial_type_id' => '1', 'financial_type' => 'Donation', - 'instrument_id' => '89', - 'payment_instrument' => 'Check', 'product_id' => '', 'product_name' => '', 'sku' => '', @@ -87,7 +84,9 @@ function contribution_get_expectedresult() { 'contribution_note' => '', 'contribution_batch' => '', 'contribution_status' => 'Completed', - 'contribution_payment_instrument' => 'Check', + 'payment_instrument' => 'Check', + 'payment_instrument_id' => '4', + 'instrument_id' => '4', 'contribution_check_number' => '', 'id' => '1', 'contribution_type_id' => '1', diff --git a/api/v3/examples/ContributionPage/Create.php b/api/v3/examples/ContributionPage/Create.php index 393987caf8..ff0ae575dc 100644 --- a/api/v3/examples/ContributionPage/Create.php +++ b/api/v3/examples/ContributionPage/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_page create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ContributionPage/Delete.php b/api/v3/examples/ContributionPage/Delete.php index c287cd06c7..699dc5f799 100644 --- a/api/v3/examples/ContributionPage/Delete.php +++ b/api/v3/examples/ContributionPage/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_page delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ContributionPage/Get.php b/api/v3/examples/ContributionPage/Get.php index ddb9259eea..e55154bdc6 100644 --- a/api/v3/examples/ContributionPage/Get.php +++ b/api/v3/examples/ContributionPage/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_page get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ContributionRecur/Create.php b/api/v3/examples/ContributionRecur/Create.php index 04c882b3be..90935966f9 100644 --- a/api/v3/examples/ContributionRecur/Create.php +++ b/api/v3/examples/ContributionRecur/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_recur create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ContributionRecur/Delete.php b/api/v3/examples/ContributionRecur/Delete.php index f77b50b5c2..7f18509c62 100644 --- a/api/v3/examples/ContributionRecur/Delete.php +++ b/api/v3/examples/ContributionRecur/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_recur delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ContributionRecur/Get.php b/api/v3/examples/ContributionRecur/Get.php index 55b3942c63..9c1f88b939 100644 --- a/api/v3/examples/ContributionRecur/Get.php +++ b/api/v3/examples/ContributionRecur/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_recur get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ContributionSoft/Create.php b/api/v3/examples/ContributionSoft/Create.php index 6ddb797728..74eb2d1268 100644 --- a/api/v3/examples/ContributionSoft/Create.php +++ b/api/v3/examples/ContributionSoft/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_soft create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ContributionSoft/Delete.php b/api/v3/examples/ContributionSoft/Delete.php index a89df984bd..ff180dcfd3 100644 --- a/api/v3/examples/ContributionSoft/Delete.php +++ b/api/v3/examples/ContributionSoft/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_soft delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ContributionSoft/Get.php b/api/v3/examples/ContributionSoft/Get.php index a9778ec5e1..4f202c5b00 100644 --- a/api/v3/examples/ContributionSoft/Get.php +++ b/api/v3/examples/ContributionSoft/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using contribution_soft get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Country/Create.php b/api/v3/examples/Country/Create.php index ff97b7a0eb..a5a3472ea7 100644 --- a/api/v3/examples/Country/Create.php +++ b/api/v3/examples/Country/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using country create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Country/Delete.php b/api/v3/examples/Country/Delete.php index 95fad2d618..9002447ea3 100644 --- a/api/v3/examples/Country/Delete.php +++ b/api/v3/examples/Country/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using country delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Country/Get.php b/api/v3/examples/Country/Get.php index 632b918afe..a3630300c6 100644 --- a/api/v3/examples/Country/Get.php +++ b/api/v3/examples/Country/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using country get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/CustomField/Create.php b/api/v3/examples/CustomField/Create.php index a822f23753..f8e91c0bfa 100644 --- a/api/v3/examples/CustomField/Create.php +++ b/api/v3/examples/CustomField/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using custom_field create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/CustomField/Delete.php b/api/v3/examples/CustomField/Delete.php index 6f69fed943..56486b4b40 100644 --- a/api/v3/examples/CustomField/Delete.php +++ b/api/v3/examples/CustomField/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using custom_field delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/CustomGroup/Create.php b/api/v3/examples/CustomGroup/Create.php index 5fafc7b8b1..aef2727f03 100644 --- a/api/v3/examples/CustomGroup/Create.php +++ b/api/v3/examples/CustomGroup/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using custom_group create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/CustomGroup/Delete.php b/api/v3/examples/CustomGroup/Delete.php index f087ff5375..48f15dce2d 100644 --- a/api/v3/examples/CustomGroup/Delete.php +++ b/api/v3/examples/CustomGroup/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using custom_group delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/CustomGroup/Get.php b/api/v3/examples/CustomGroup/Get.php index 498586ef3f..4c6557e97e 100644 --- a/api/v3/examples/CustomGroup/Get.php +++ b/api/v3/examples/CustomGroup/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using custom_group get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/CustomValue/Create.php b/api/v3/examples/CustomValue/Create.php index 6ebe2bda77..4a1a104574 100644 --- a/api/v3/examples/CustomValue/Create.php +++ b/api/v3/examples/CustomValue/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using custom_value create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/CustomValue/Get.php b/api/v3/examples/CustomValue/Get.php index 03cbdf5230..caa77d0a7a 100644 --- a/api/v3/examples/CustomValue/Get.php +++ b/api/v3/examples/CustomValue/Get.php @@ -2,7 +2,7 @@ /** * Test Generated example of using custom_value get API. * - * /*this demonstrates the use of CustomValue get + * This demonstrates the use of CustomValue get to fetch single and multi-valued custom data. * * @return array * API result array diff --git a/api/v3/examples/Domain/Create.php b/api/v3/examples/Domain/Create.php index e901a4b374..d200df72ba 100644 --- a/api/v3/examples/Domain/Create.php +++ b/api/v3/examples/Domain/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using domain create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Domain/Get.php b/api/v3/examples/Domain/Get.php index b1dbb5606f..2b59267aac 100644 --- a/api/v3/examples/Domain/Get.php +++ b/api/v3/examples/Domain/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using domain get API. * - * * @return array * API result array */ @@ -45,7 +44,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.alpha1\";s:11:\"empoweredBy\";b:1;s:10:\"userSystem\";O:26:\"CRM_Utils_System_UnitTests\":5:{s:19:\"supports_UF_Logging\";b:1;s:9:\"is_drupal\";b:0;s:9:\"is_joomla\";b:0;s:12:\"is_wordpress\";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;}', + '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', 'contact_id' => '3', 'locale_custom_strings' => 'a:1:{s:5:\"en_US\";a:0:{}}', @@ -71,7 +70,7 @@ function domain_get_expectedresult() { '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.alpha1\";s:11:\"empoweredBy\";b:1;s:10:\"userSystem\";O:26:\"CRM_Utils_System_UnitTests\":5:{s:19:\"supports_UF_Logging\";b:1;s:9:\"is_drupal\";b:0;s:9:\"is_joomla\";b:0;s:12:\"is_wordpress\";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;}', + '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\" ', diff --git a/api/v3/examples/Email/Create.php b/api/v3/examples/Email/Create.php index f5abf4089b..b346a069b1 100644 --- a/api/v3/examples/Email/Create.php +++ b/api/v3/examples/Email/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using email create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Email/Delete.php b/api/v3/examples/Email/Delete.php index c07ec3d040..41f84f9edc 100644 --- a/api/v3/examples/Email/Delete.php +++ b/api/v3/examples/Email/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using email delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Email/NestedReplaceEmail.php b/api/v3/examples/Email/NestedReplaceEmail.php index 8c41216860..d8a827d80d 100644 --- a/api/v3/examples/Email/NestedReplaceEmail.php +++ b/api/v3/examples/Email/NestedReplaceEmail.php @@ -2,7 +2,7 @@ /** * Test Generated example of using email replace API. * - * example demonstrates use of Replace in a nested API call + * Demonstrates use of Replace in a nested API call. * * @return array * API result array diff --git a/api/v3/examples/Email/Replace.php b/api/v3/examples/Email/Replace.php index 0521800d51..d031d33d7a 100644 --- a/api/v3/examples/Email/Replace.php +++ b/api/v3/examples/Email/Replace.php @@ -2,7 +2,6 @@ /** * Test Generated example of using email replace API. * - * * @return array * API result array */ diff --git a/api/v3/examples/EntityTag/Create.php b/api/v3/examples/EntityTag/Create.php index 627f4002d2..f0b4f12a73 100644 --- a/api/v3/examples/EntityTag/Create.php +++ b/api/v3/examples/EntityTag/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using entity_tag create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/EntityTag/Delete.php b/api/v3/examples/EntityTag/Delete.php index cca8743df7..d07a39b33b 100644 --- a/api/v3/examples/EntityTag/Delete.php +++ b/api/v3/examples/EntityTag/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using entity_tag delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/EntityTag/Get.php b/api/v3/examples/EntityTag/Get.php index 4b1357e48a..c2cdb70fa8 100644 --- a/api/v3/examples/EntityTag/Get.php +++ b/api/v3/examples/EntityTag/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using entity_tag get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Event/Create.php b/api/v3/examples/Event/Create.php index 17a6580653..c458ff6e27 100644 --- a/api/v3/examples/Event/Create.php +++ b/api/v3/examples/Event/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using event create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Event/Delete.php b/api/v3/examples/Event/Delete.php index 937c06e5ec..2bcacd9271 100644 --- a/api/v3/examples/Event/Delete.php +++ b/api/v3/examples/Event/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using event delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Event/Get.php b/api/v3/examples/Event/Get.php index 2cfc2942c6..a481009283 100644 --- a/api/v3/examples/Event/Get.php +++ b/api/v3/examples/Event/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using event get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Event/IsCurrentOption.php b/api/v3/examples/Event/IsCurrentOption.php index 05d8c5cd5e..eb0bf41169 100644 --- a/api/v3/examples/Event/IsCurrentOption.php +++ b/api/v3/examples/Event/IsCurrentOption.php @@ -2,7 +2,7 @@ /** * Test Generated example of using event get API. * - * demonstrates use of is.Current option + * Demonstrates use of is.Current option. * * @return array * API result array diff --git a/api/v3/examples/Event/IsFullOption.php b/api/v3/examples/Event/IsFullOption.php index 035592add5..42b33bf7a9 100644 --- a/api/v3/examples/Event/IsFullOption.php +++ b/api/v3/examples/Event/IsFullOption.php @@ -2,7 +2,7 @@ /** * Test Generated example of using event getsingle API. * - * demonstrates use of return is_full + * Demonstrates use of return is_full . * * @return array * API result array @@ -61,7 +61,7 @@ function event_getsingle_expectedresult() { 'is_multiple_registrations' => 0, 'allow_same_participant_emails' => 0, 'is_template' => 0, - 'created_date' => '2015-01-15 02:10:12', + 'created_date' => '2015-02-16 11:40:40', 'is_share' => '1', 'is_confirm_enabled' => '1', 'is_billing_required' => 0, diff --git a/api/v3/examples/Grant/Create.php b/api/v3/examples/Grant/Create.php index df6e36b5ef..2b69bde540 100644 --- a/api/v3/examples/Grant/Create.php +++ b/api/v3/examples/Grant/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using grant create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Grant/Delete.php b/api/v3/examples/Grant/Delete.php index d54ba93a8b..b2985153ea 100644 --- a/api/v3/examples/Grant/Delete.php +++ b/api/v3/examples/Grant/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using grant delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Grant/Get.php b/api/v3/examples/Grant/Get.php index d3e671c022..2cfa59c5e3 100644 --- a/api/v3/examples/Grant/Get.php +++ b/api/v3/examples/Grant/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using grant get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Group/Get.php b/api/v3/examples/Group/Get.php index 1a5b81d8af..c759a43882 100644 --- a/api/v3/examples/Group/Get.php +++ b/api/v3/examples/Group/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Group/getfields.php b/api/v3/examples/Group/getfields.php index e82e9fb7d8..eb102889c3 100644 --- a/api/v3/examples/Group/getfields.php +++ b/api/v3/examples/Group/getfields.php @@ -2,7 +2,7 @@ /** * Test Generated example of using group getfields API. * - * demonstrate use of getfields to interrogate api + * Demonstrate use of getfields to interrogate api. * * @return array * API result array diff --git a/api/v3/examples/GroupContact/Create.php b/api/v3/examples/GroupContact/Create.php index 6174308515..52ff8e03ae 100644 --- a/api/v3/examples/GroupContact/Create.php +++ b/api/v3/examples/GroupContact/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_contact create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/GroupContact/Delete.php b/api/v3/examples/GroupContact/Delete.php index 5606fb9c67..8fe66c2d59 100644 --- a/api/v3/examples/GroupContact/Delete.php +++ b/api/v3/examples/GroupContact/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_contact delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/GroupContact/Get.php b/api/v3/examples/GroupContact/Get.php index 154ac28c5c..643560005b 100644 --- a/api/v3/examples/GroupContact/Get.php +++ b/api/v3/examples/GroupContact/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_contact get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/GroupContact/GetWithGroupID.php b/api/v3/examples/GroupContact/GetWithGroupID.php index 33f66e27e9..02d1f10d5f 100644 --- a/api/v3/examples/GroupContact/GetWithGroupID.php +++ b/api/v3/examples/GroupContact/GetWithGroupID.php @@ -2,7 +2,7 @@ /** * Test Generated example of using group_contact get API. * - * Get all from group and display contacts + * Get all from group and display contacts. * * @return array * API result array diff --git a/api/v3/examples/GroupNesting/Create.php b/api/v3/examples/GroupNesting/Create.php index 92e25dc146..a4e3c8fc5c 100644 --- a/api/v3/examples/GroupNesting/Create.php +++ b/api/v3/examples/GroupNesting/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_nesting create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/GroupNesting/Delete.php b/api/v3/examples/GroupNesting/Delete.php index 567f9eb921..332e7bd4cf 100644 --- a/api/v3/examples/GroupNesting/Delete.php +++ b/api/v3/examples/GroupNesting/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_nesting delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/GroupNesting/Get.php b/api/v3/examples/GroupNesting/Get.php index c8763b9258..140e892b3e 100644 --- a/api/v3/examples/GroupNesting/Get.php +++ b/api/v3/examples/GroupNesting/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_nesting get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/GroupOrganization/Create.php b/api/v3/examples/GroupOrganization/Create.php index 9ab85fd7b2..18253e5a12 100644 --- a/api/v3/examples/GroupOrganization/Create.php +++ b/api/v3/examples/GroupOrganization/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_organization create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/GroupOrganization/Delete.php b/api/v3/examples/GroupOrganization/Delete.php index 15b6dbf195..7dbc6fcc0f 100644 --- a/api/v3/examples/GroupOrganization/Delete.php +++ b/api/v3/examples/GroupOrganization/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_organization delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/GroupOrganization/Get.php b/api/v3/examples/GroupOrganization/Get.php index 93944dd226..c211370870 100644 --- a/api/v3/examples/GroupOrganization/Get.php +++ b/api/v3/examples/GroupOrganization/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using group_organization get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Im/Create.php b/api/v3/examples/Im/Create.php index d6e1b6a8bd..996f6d6bed 100644 --- a/api/v3/examples/Im/Create.php +++ b/api/v3/examples/Im/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using im create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Im/Delete.php b/api/v3/examples/Im/Delete.php index 0f4b972bb0..489ec018e2 100644 --- a/api/v3/examples/Im/Delete.php +++ b/api/v3/examples/Im/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using im delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Im/Get.php b/api/v3/examples/Im/Get.php index 98a7132f07..c81f7c2259 100644 --- a/api/v3/examples/Im/Get.php +++ b/api/v3/examples/Im/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using im get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Job/Create.php b/api/v3/examples/Job/Create.php index e35e8f10e9..ff90bd441f 100644 --- a/api/v3/examples/Job/Create.php +++ b/api/v3/examples/Job/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using job create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Job/Delete.php b/api/v3/examples/Job/Delete.php index e7953faa22..707a6c2634 100644 --- a/api/v3/examples/Job/Delete.php +++ b/api/v3/examples/Job/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using job delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/LineItem/Create.php b/api/v3/examples/LineItem/Create.php index 4d646c4b56..497c58e3e7 100644 --- a/api/v3/examples/LineItem/Create.php +++ b/api/v3/examples/LineItem/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using line_item create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/LineItem/Delete.php b/api/v3/examples/LineItem/Delete.php index d362d96460..c66221f2d8 100644 --- a/api/v3/examples/LineItem/Delete.php +++ b/api/v3/examples/LineItem/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using line_item delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/LineItem/Get.php b/api/v3/examples/LineItem/Get.php index 9c0b0dbb11..349c37b3b2 100644 --- a/api/v3/examples/LineItem/Get.php +++ b/api/v3/examples/LineItem/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using line_item get API. * - * * @return array * API result array */ @@ -50,7 +49,7 @@ function line_item_get_expectedresult() { 'contribution_id' => '2', 'price_field_id' => '1', 'label' => 'Contribution Amount', - 'qty' => '1', + 'qty' => '1.00', 'unit_price' => '100.00', 'line_total' => '100.00', 'price_field_value_id' => '1', diff --git a/api/v3/examples/LocBlock/createEntities.php b/api/v3/examples/LocBlock/createEntities.php index 9c9e5d4b17..92e4755773 100644 --- a/api/v3/examples/LocBlock/createEntities.php +++ b/api/v3/examples/LocBlock/createEntities.php @@ -2,7 +2,7 @@ /** * Test Generated example of using loc_block create API. * - * Create entities and locBlock in 1 api call + * Create entities and locBlock in 1 api call. * * @return array * API result array diff --git a/api/v3/examples/MailSettings/ChainedGetDelete.php b/api/v3/examples/MailSettings/ChainedGetDelete.php index 9bf481403a..de33dee383 100644 --- a/api/v3/examples/MailSettings/ChainedGetDelete.php +++ b/api/v3/examples/MailSettings/ChainedGetDelete.php @@ -2,7 +2,7 @@ /** * Test Generated example of using mail_settings get API. * - * demonstrates get + delete in the same call + * Demonstrates get + delete in the same call. * * @return array * API result array diff --git a/api/v3/examples/MailSettings/Create.php b/api/v3/examples/MailSettings/Create.php index 1562471ef3..11b08b8e41 100644 --- a/api/v3/examples/MailSettings/Create.php +++ b/api/v3/examples/MailSettings/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using mail_settings create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MailSettings/Delete.php b/api/v3/examples/MailSettings/Delete.php index 7f74623ddf..7dbfae3d3a 100644 --- a/api/v3/examples/MailSettings/Delete.php +++ b/api/v3/examples/MailSettings/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using mail_settings delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MailSettings/Get.php b/api/v3/examples/MailSettings/Get.php index c650685e83..c91ed9f982 100644 --- a/api/v3/examples/MailSettings/Get.php +++ b/api/v3/examples/MailSettings/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using mail_settings get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Mailing/Create.php b/api/v3/examples/Mailing/Create.php index 733b436762..98feb8fd41 100644 --- a/api/v3/examples/Mailing/Create.php +++ b/api/v3/examples/Mailing/Create.php @@ -2,17 +2,20 @@ /** * Test Generated example of using mailing create API. * - * * @return array * API result array */ function mailing_create_example() { $params = array( 'subject' => 'Hello {contact.display_name}', - 'body_text' => 'This is {contact.display_name}', - 'body_html' => '

This is {contact.display_name}

', + 'body_text' => 'This is {contact.display_name}. +{domain.address}{action.optOutUrl}', + 'body_html' => '

This is {contact.display_name}.

{domain.address}{action.optOutUrl}

', 'name' => 'mailing name', 'created_id' => 3, + 'header_id' => '', + 'footer_id' => '', + 'scheduled_date' => 'now', ); try{ @@ -52,20 +55,21 @@ function mailing_create_expectedresult() { 'domain_id' => '1', 'header_id' => '', 'footer_id' => '', - 'reply_id' => '', - 'unsubscribe_id' => '', - 'resubscribe_id' => '', - 'optout_id' => '', + 'reply_id' => '8', + 'unsubscribe_id' => '5', + 'resubscribe_id' => '6', + 'optout_id' => '7', 'name' => 'mailing name', 'from_name' => 'FIXME', 'from_email' => 'info@EXAMPLE.ORG', 'replyto_email' => 'info@EXAMPLE.ORG', 'subject' => 'Hello {contact.display_name}', - 'body_text' => 'This is {contact.display_name}', - 'body_html' => '

This is {contact.display_name}

', + 'body_text' => 'This is {contact.display_name}. +{domain.address}{action.optOutUrl}', + 'body_html' => '

This is {contact.display_name}.

{domain.address}{action.optOutUrl}

', 'url_tracking' => '1', 'forward_replies' => '', - 'auto_responder' => 0, + 'auto_responder' => '', 'open_tracking' => '1', 'is_completed' => '', 'msg_template_id' => '', @@ -73,7 +77,7 @@ function mailing_create_expectedresult() { 'created_id' => '3', 'created_date' => '2013-07-28 08:49:19', 'scheduled_id' => '', - 'scheduled_date' => '', + 'scheduled_date' => '20130728085413', 'approver_id' => '', 'approval_date' => '', 'approval_status_id' => '', @@ -81,32 +85,11 @@ function mailing_create_expectedresult() { 'is_archived' => '', 'visibility' => 'Public Pages', 'campaign_id' => '', - 'dedupe_email' => '', + 'dedupe_email' => '1', 'sms_provider_id' => '', 'hash' => '', 'location_type_id' => '', 'email_selection_method' => '', - 'api.mailing_job.create' => array( - 'is_error' => 0, - 'version' => 3, - 'count' => 1, - 'id' => 1, - 'values' => array( - '0' => array( - 'id' => '1', - 'mailing_id' => '1', - 'scheduled_date' => '20130728085413', - 'start_date' => '', - 'end_date' => '', - 'status' => 'Scheduled', - 'is_test' => 0, - 'job_type' => '', - 'parent_id' => '', - 'job_offset' => '', - 'job_limit' => '', - ), - ), - ), ), ), ); diff --git a/api/v3/examples/Mailing/Delete.php b/api/v3/examples/Mailing/Delete.php index 8c7460d030..f7caaba88d 100644 --- a/api/v3/examples/Mailing/Delete.php +++ b/api/v3/examples/Mailing/Delete.php @@ -2,13 +2,12 @@ /** * Test Generated example of using mailing delete API. * - * * @return array * API result array */ function mailing_delete_example() { $params = array( - 'id' => 12, + 'id' => 16, ); try{ diff --git a/api/v3/examples/Mailing/Submit.php b/api/v3/examples/Mailing/Submit.php index fca99e1eb2..4f6b8b5f22 100644 --- a/api/v3/examples/Mailing/Submit.php +++ b/api/v3/examples/Mailing/Submit.php @@ -2,7 +2,6 @@ /** * Test Generated example of using mailing submit API. * - * * @return array * API result array */ @@ -49,17 +48,18 @@ function mailing_submit_expectedresult() { 'domain_id' => '1', 'header_id' => '', 'footer_id' => '', - 'reply_id' => '', - 'unsubscribe_id' => '', - 'resubscribe_id' => '', - 'optout_id' => '', + 'reply_id' => '8', + 'unsubscribe_id' => '5', + 'resubscribe_id' => '6', + 'optout_id' => '7', 'name' => 'mailing name', 'from_name' => 'FIXME', 'from_email' => 'info@EXAMPLE.ORG', 'replyto_email' => 'info@EXAMPLE.ORG', 'subject' => 'Hello {contact.display_name}', - 'body_text' => 'This is {contact.display_name}', - 'body_html' => '

This is {contact.display_name}

', + 'body_text' => 'This is {contact.display_name}. +{domain.address}{action.optOutUrl}', + 'body_html' => '

This is {contact.display_name}.

{domain.address}{action.optOutUrl}

', 'url_tracking' => '1', 'forward_replies' => 0, 'auto_responder' => 0, @@ -78,11 +78,11 @@ function mailing_submit_expectedresult() { 'is_archived' => 0, 'visibility' => 'Public Pages', 'campaign_id' => '', - 'dedupe_email' => 0, + 'dedupe_email' => '1', 'sms_provider_id' => '', 'hash' => '67eac7789eaee00', - 'location_type_id' => '', - 'email_selection_method' => '', + 'location_type_id' => 0, + 'email_selection_method' => 'automatic', ), ), ); diff --git a/api/v3/examples/MailingAB/Create.php b/api/v3/examples/MailingAB/Create.php new file mode 100644 index 0000000000..a211808822 --- /dev/null +++ b/api/v3/examples/MailingAB/Create.php @@ -0,0 +1,92 @@ + 1, + 'mailing_id_b' => 2, + 'mailing_id_c' => 3, + 'testing_criteria_id' => 1, + 'winner_criteria_id' => 1, + 'declare_winning_time' => '+2 days', + 'group_percentage' => 10, + ); + + try{ + $result = civicrm_api3('mailing_a_b', 'create', $params); + } + catch (CiviCRM_API3_Exception $e) { + // Handle error here. + $errorMessage = $e->getMessage(); + $errorCode = $e->getErrorCode(); + $errorData = $e->getExtraParams(); + return array( + 'error' => $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_a_b_create_expectedresult() { + + $expectedResult = array( + 'is_error' => 0, + 'version' => 3, + 'count' => 1, + 'id' => 1, + 'values' => array( + '1' => array( + 'id' => '1', + 'name' => '', + 'status' => '', + 'mailing_id_a' => '1', + 'mailing_id_b' => '2', + 'mailing_id_c' => '3', + 'domain_id' => '1', + 'testing_criteria_id' => '1', + 'winner_criteria_id' => '1', + 'specific_url' => '', + 'declare_winning_time' => '20150218114218', + 'group_percentage' => '10', + ), + ), + ); + + return $expectedResult; +} + +/** +* This example has been generated from the API test suite. +* The test that created it is called +* testMailingABCreateSuccess +* and can be found in +* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingABTest.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/Membership/Create.php b/api/v3/examples/Membership/Create.php index b0db6230bb..b6ac9d7804 100644 --- a/api/v3/examples/Membership/Create.php +++ b/api/v3/examples/Membership/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Membership/Delete.php b/api/v3/examples/Membership/Delete.php index e6ee47fd3d..29ef67b90b 100644 --- a/api/v3/examples/Membership/Delete.php +++ b/api/v3/examples/Membership/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Membership/Get.php b/api/v3/examples/Membership/Get.php index 773ef1a6c2..abde2a591c 100644 --- a/api/v3/examples/Membership/Get.php +++ b/api/v3/examples/Membership/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Membership/Update.php b/api/v3/examples/Membership/Update.php index ac331dc0b9..c50a2ead27 100644 --- a/api/v3/examples/Membership/Update.php +++ b/api/v3/examples/Membership/Update.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership update API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Membership/filterIsCurrent.php b/api/v3/examples/Membership/filterIsCurrent.php index d5f4f42fee..506dd3365d 100644 --- a/api/v3/examples/Membership/filterIsCurrent.php +++ b/api/v3/examples/Membership/filterIsCurrent.php @@ -2,7 +2,7 @@ /** * Test Generated example of using membership get API. * - * Demonstrates use of 'filter' active_only' param + * Demonstrates use of 'filter' active_only' param. * * @return array * API result array diff --git a/api/v3/examples/MembershipPayment/Create.php b/api/v3/examples/MembershipPayment/Create.php index 10c762a13b..149fc257de 100644 --- a/api/v3/examples/MembershipPayment/Create.php +++ b/api/v3/examples/MembershipPayment/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership_payment create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MembershipPayment/Get.php b/api/v3/examples/MembershipPayment/Get.php index 913fab083c..4f7bfe3a0b 100644 --- a/api/v3/examples/MembershipPayment/Get.php +++ b/api/v3/examples/MembershipPayment/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership_payment get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MembershipStatus/Create.php b/api/v3/examples/MembershipStatus/Create.php index 30d7031df1..d57ae4c7d6 100644 --- a/api/v3/examples/MembershipStatus/Create.php +++ b/api/v3/examples/MembershipStatus/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership_status create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MembershipStatus/Get.php b/api/v3/examples/MembershipStatus/Get.php index 5bef6833c2..255ab6afa5 100644 --- a/api/v3/examples/MembershipStatus/Get.php +++ b/api/v3/examples/MembershipStatus/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership_status get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MembershipType/Create.php b/api/v3/examples/MembershipType/Create.php index f649ac57ce..2b7ac831c6 100644 --- a/api/v3/examples/MembershipType/Create.php +++ b/api/v3/examples/MembershipType/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership_type create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MembershipType/Delete.php b/api/v3/examples/MembershipType/Delete.php index 27ff7dda2d..c30d8b3283 100644 --- a/api/v3/examples/MembershipType/Delete.php +++ b/api/v3/examples/MembershipType/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership_type delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MembershipType/Get.php b/api/v3/examples/MembershipType/Get.php index f8c2f2aec7..15078ea995 100644 --- a/api/v3/examples/MembershipType/Get.php +++ b/api/v3/examples/MembershipType/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using membership_type get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/MessageTemplate/Create.php b/api/v3/examples/MessageTemplate/Create.php index 14109867ea..0cea862673 100644 --- a/api/v3/examples/MessageTemplate/Create.php +++ b/api/v3/examples/MessageTemplate/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using message_template create API. * - * * @return array * API result array */ @@ -47,10 +46,10 @@ function message_template_create_expectedresult() { 'is_error' => 0, 'version' => 3, 'count' => 1, - 'id' => 65, + 'id' => 67, 'values' => array( - '65' => array( - 'id' => '65', + '67' => array( + 'id' => '67', 'msg_title' => 'msg_title_165', 'msg_subject' => 'msg_subject_165', 'msg_text' => 'msg_text_165', diff --git a/api/v3/examples/MessageTemplate/Delete.php b/api/v3/examples/MessageTemplate/Delete.php index 8c18277065..ed5353a097 100644 --- a/api/v3/examples/MessageTemplate/Delete.php +++ b/api/v3/examples/MessageTemplate/Delete.php @@ -2,13 +2,12 @@ /** * Test Generated example of using message_template delete API. * - * * @return array * API result array */ function message_template_delete_example() { $params = array( - 'id' => 68, + 'id' => 70, ); try{ diff --git a/api/v3/examples/MessageTemplate/Get.php b/api/v3/examples/MessageTemplate/Get.php index 845056bcb5..300eb9c383 100644 --- a/api/v3/examples/MessageTemplate/Get.php +++ b/api/v3/examples/MessageTemplate/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using message_template get API. * - * * @return array * API result array */ @@ -47,10 +46,10 @@ function message_template_get_expectedresult() { 'is_error' => 0, 'version' => 3, 'count' => 1, - 'id' => 66, + 'id' => 68, 'values' => array( - '66' => array( - 'id' => '66', + '68' => array( + 'id' => '68', 'msg_title' => 'msg_title_166', 'msg_subject' => 'msg_subject_166', 'msg_text' => 'msg_text_166', diff --git a/api/v3/examples/Note/Create.php b/api/v3/examples/Note/Create.php index 9c52057c39..6e51ea80f2 100644 --- a/api/v3/examples/Note/Create.php +++ b/api/v3/examples/Note/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using note create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Note/Delete.php b/api/v3/examples/Note/Delete.php index 8a6418d538..6fc6497699 100644 --- a/api/v3/examples/Note/Delete.php +++ b/api/v3/examples/Note/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using note delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Note/Get.php b/api/v3/examples/Note/Get.php index a4f121d2a8..04d4ecd41f 100644 --- a/api/v3/examples/Note/Get.php +++ b/api/v3/examples/Note/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using note get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/OptionGroup/Create.php b/api/v3/examples/OptionGroup/Create.php index 3475f44eb5..20e0ace162 100644 --- a/api/v3/examples/OptionGroup/Create.php +++ b/api/v3/examples/OptionGroup/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using option_group create API. * - * * @return array * API result array */ @@ -51,17 +50,17 @@ function option_group_create_expectedresult() { 'is_error' => 0, 'version' => 3, 'count' => 1, - 'id' => 92, + 'id' => 93, 'values' => array( '0' => array( - 'id' => '92', + 'id' => '93', 'name' => 'civicrm_event.amount.560', 'title' => '', 'description' => '', 'is_reserved' => '1', 'is_active' => '1', 'is_locked' => '', - 'api.OptionValue.create' => 780, + 'api.OptionValue.create' => 784, ), ), ); diff --git a/api/v3/examples/OptionGroup/Delete.php b/api/v3/examples/OptionGroup/Delete.php index ea30c13761..3d86b04aab 100644 --- a/api/v3/examples/OptionGroup/Delete.php +++ b/api/v3/examples/OptionGroup/Delete.php @@ -2,13 +2,12 @@ /** * Test Generated example of using option_group delete API. * - * * @return array * API result array */ function option_group_delete_example() { $params = array( - 'id' => 97, + 'id' => 98, ); try{ diff --git a/api/v3/examples/OptionGroup/Get.php b/api/v3/examples/OptionGroup/Get.php index 6ece219c66..26f5aadfd6 100644 --- a/api/v3/examples/OptionGroup/Get.php +++ b/api/v3/examples/OptionGroup/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using option_group get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/OptionValue/Get.php b/api/v3/examples/OptionValue/Get.php index ae7fcda634..e7f0b43104 100644 --- a/api/v3/examples/OptionValue/Get.php +++ b/api/v3/examples/OptionValue/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using option_value get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/OptionValue/SortOption.php b/api/v3/examples/OptionValue/SortOption.php index ffdf730e7c..9af05eb48d 100644 --- a/api/v3/examples/OptionValue/SortOption.php +++ b/api/v3/examples/OptionValue/SortOption.php @@ -2,7 +2,7 @@ /** * Test Generated example of using option_value getsingle API. * - * demonstrates use of Sort param (available in many api functions). Also, getsingle + * Demonstrates use of Sort param (available in many api functions). Also, getsingle. * * @return array * API result array diff --git a/api/v3/examples/Participant/Create.php b/api/v3/examples/Participant/Create.php index 0ad7495013..ec0758c01f 100644 --- a/api/v3/examples/Participant/Create.php +++ b/api/v3/examples/Participant/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using participant create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Participant/CreateParticipantPayment.php b/api/v3/examples/Participant/CreateParticipantPayment.php index feb191fea4..d59db26a90 100644 --- a/api/v3/examples/Participant/CreateParticipantPayment.php +++ b/api/v3/examples/Participant/CreateParticipantPayment.php @@ -2,8 +2,8 @@ /** * Test Generated example of using participant create API. * - * single function to create contact w partipation & contribution. Note that in the - case of 'contribution' the 'create' is implied (api.contribution.create) + * Single function to create contact with partipation & contribution. + * Note that in the case of 'contribution' the 'create' is implied (api.contribution.create) * * @return array * API result array diff --git a/api/v3/examples/Participant/Get.php b/api/v3/examples/Participant/Get.php index fc23c7dc97..f43eacece9 100644 --- a/api/v3/examples/Participant/Get.php +++ b/api/v3/examples/Participant/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using participant get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Participant/NestedDelete.php b/api/v3/examples/Participant/NestedDelete.php index 9b470b112e..2e95fc7559 100644 --- a/api/v3/examples/Participant/NestedDelete.php +++ b/api/v3/examples/Participant/NestedDelete.php @@ -2,7 +2,7 @@ /** * Test Generated example of using participant Get API. * - * Criteria delete by nesting a GET & a DELETE + * Criteria delete by nesting a GET & a DELETE. * * @return array * API result array diff --git a/api/v3/examples/Participant/NestedEventGet.php b/api/v3/examples/Participant/NestedEventGet.php index ef2bc87e3c..4998e2570b 100644 --- a/api/v3/examples/Participant/NestedEventGet.php +++ b/api/v3/examples/Participant/NestedEventGet.php @@ -2,7 +2,7 @@ /** * Test Generated example of using participant get API. * - * use nested get to get an event + * Demonstrates use of nested get to fetch event data with participant records. * * @return array * API result array diff --git a/api/v3/examples/ParticipantPayment/Create.php b/api/v3/examples/ParticipantPayment/Create.php index 988c2d5325..f504ad29aa 100644 --- a/api/v3/examples/ParticipantPayment/Create.php +++ b/api/v3/examples/ParticipantPayment/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using participant_payment create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ParticipantPayment/Delete.php b/api/v3/examples/ParticipantPayment/Delete.php index 26341e1d52..7c7d08d155 100644 --- a/api/v3/examples/ParticipantPayment/Delete.php +++ b/api/v3/examples/ParticipantPayment/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using participant_payment delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ParticipantPayment/Get.php b/api/v3/examples/ParticipantPayment/Get.php index 98a14491b7..7b919f5934 100644 --- a/api/v3/examples/ParticipantPayment/Get.php +++ b/api/v3/examples/ParticipantPayment/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using participant_payment get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ParticipantStatusType/Create.php b/api/v3/examples/ParticipantStatusType/Create.php index e0cbaa3dac..5c317da656 100644 --- a/api/v3/examples/ParticipantStatusType/Create.php +++ b/api/v3/examples/ParticipantStatusType/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using participant_status_type create API. * - * * @return array * API result array */ @@ -54,7 +53,7 @@ function participant_status_type_create_expectedresult() { 'id' => '16', 'name' => 'test status', 'label' => 'I am a test', - 'class' => '14', + 'class' => 'Positive', 'is_reserved' => 0, 'is_active' => '1', 'is_counted' => '1', diff --git a/api/v3/examples/ParticipantStatusType/Delete.php b/api/v3/examples/ParticipantStatusType/Delete.php index 0cb2d18c12..15d5c8b9ce 100644 --- a/api/v3/examples/ParticipantStatusType/Delete.php +++ b/api/v3/examples/ParticipantStatusType/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using participant_status_type delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ParticipantStatusType/Get.php b/api/v3/examples/ParticipantStatusType/Get.php index bdb40d6579..461d54ae6f 100644 --- a/api/v3/examples/ParticipantStatusType/Get.php +++ b/api/v3/examples/ParticipantStatusType/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using participant_status_type get API. * - * * @return array * API result array */ @@ -54,7 +53,7 @@ function participant_status_type_get_expectedresult() { 'id' => '17', 'name' => 'test status', 'label' => 'I am a test', - 'class' => '14', + 'class' => 'Positive', 'is_reserved' => 0, 'is_active' => '1', 'is_counted' => '1', diff --git a/api/v3/examples/PaymentProcessor/Create.php b/api/v3/examples/PaymentProcessor/Create.php index 76fb3c8eb4..74860e178d 100644 --- a/api/v3/examples/PaymentProcessor/Create.php +++ b/api/v3/examples/PaymentProcessor/Create.php @@ -2,14 +2,13 @@ /** * Test Generated example of using payment_processor create API. * - * * @return array * API result array */ function payment_processor_create_example() { $params = array( 'name' => 'API Test PP', - 'payment_processor_type_id' => 1, + 'payment_processor_type_id' => 18, 'class_name' => 'CRM_Core_Payment_APITest', 'is_recur' => 0, 'domain_id' => 1, diff --git a/api/v3/examples/PaymentProcessor/Delete.php b/api/v3/examples/PaymentProcessor/Delete.php index 048ef64382..e979277b45 100644 --- a/api/v3/examples/PaymentProcessor/Delete.php +++ b/api/v3/examples/PaymentProcessor/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using payment_processor delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PaymentProcessorType/Create.php b/api/v3/examples/PaymentProcessorType/Create.php index 2eb39db127..fd2c0662fa 100644 --- a/api/v3/examples/PaymentProcessorType/Create.php +++ b/api/v3/examples/PaymentProcessorType/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using payment_processor_type create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PaymentProcessorType/Delete.php b/api/v3/examples/PaymentProcessorType/Delete.php index 99177cf116..31049b6070 100644 --- a/api/v3/examples/PaymentProcessorType/Delete.php +++ b/api/v3/examples/PaymentProcessorType/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using payment_processor_type delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Phone/Create.php b/api/v3/examples/Phone/Create.php index f3740b7de8..d3c6c68896 100644 --- a/api/v3/examples/Phone/Create.php +++ b/api/v3/examples/Phone/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using phone create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Phone/Delete.php b/api/v3/examples/Phone/Delete.php index ea22e2cb43..faf6a5a27f 100644 --- a/api/v3/examples/Phone/Delete.php +++ b/api/v3/examples/Phone/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using phone delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Phone/Get.php b/api/v3/examples/Phone/Get.php index 556dd1d09b..0771ab25cf 100644 --- a/api/v3/examples/Phone/Get.php +++ b/api/v3/examples/Phone/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using phone get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Pledge/Create.php b/api/v3/examples/Pledge/Create.php index ee6196a9ed..bf5e17d311 100644 --- a/api/v3/examples/Pledge/Create.php +++ b/api/v3/examples/Pledge/Create.php @@ -2,16 +2,15 @@ /** * Test Generated example of using pledge create API. * - * * @return array * API result array */ function pledge_create_example() { $params = array( 'contact_id' => 11, - 'pledge_create_date' => '20150115', - 'start_date' => '20150115', - 'scheduled_date' => '20150117', + 'pledge_create_date' => '20150216', + 'start_date' => '20150216', + 'scheduled_date' => '20150218', 'amount' => '100', 'pledge_status_id' => '2', 'pledge_financial_type_id' => '1', diff --git a/api/v3/examples/Pledge/Delete.php b/api/v3/examples/Pledge/Delete.php index 465e0021dd..9ea54b0972 100644 --- a/api/v3/examples/Pledge/Delete.php +++ b/api/v3/examples/Pledge/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using pledge delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Pledge/Get.php b/api/v3/examples/Pledge/Get.php index 1d870082cd..47f1131da2 100644 --- a/api/v3/examples/Pledge/Get.php +++ b/api/v3/examples/Pledge/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using pledge get API. * - * * @return array * API result array */ @@ -51,10 +50,10 @@ function pledge_get_expectedresult() { 'display_name' => 'Mr. Anthony Anderson II', 'pledge_id' => '1', 'pledge_amount' => '100.00', - 'pledge_create_date' => '2015-01-15 00:00:00', + 'pledge_create_date' => '2015-02-16 00:00:00', 'pledge_status' => 'Pending', 'pledge_total_paid' => '', - 'pledge_next_pay_date' => '2015-01-17 00:00:00', + 'pledge_next_pay_date' => '2015-02-18 00:00:00', 'pledge_next_pay_amount' => '20.00', 'pledge_outstanding_amount' => '', 'pledge_financial_type' => 'Donation', diff --git a/api/v3/examples/Pledge/GetFilterHighDate.php b/api/v3/examples/Pledge/GetFilterHighDate.php index 51644d759c..ee4847a390 100644 --- a/api/v3/examples/Pledge/GetFilterHighDate.php +++ b/api/v3/examples/Pledge/GetFilterHighDate.php @@ -9,7 +9,7 @@ */ function pledge_get_example() { $params = array( - 'pledge_start_date_high' => '20150113034845', + 'pledge_start_date_high' => '20150214114707', ); try{ @@ -52,7 +52,7 @@ function pledge_get_expectedresult() { 'display_name' => 'Mr. Anthony Anderson II', 'pledge_id' => '2', 'pledge_amount' => '100.00', - 'pledge_create_date' => '2015-01-15 00:00:00', + 'pledge_create_date' => '2015-02-16 00:00:00', 'pledge_status' => 'Overdue', 'pledge_total_paid' => '', 'pledge_next_pay_date' => '2014-03-07 00:00:00', diff --git a/api/v3/examples/PledgePayment/Create.php b/api/v3/examples/PledgePayment/Create.php index 2bab71f703..82212aa938 100644 --- a/api/v3/examples/PledgePayment/Create.php +++ b/api/v3/examples/PledgePayment/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using pledge_payment create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PledgePayment/Delete.php b/api/v3/examples/PledgePayment/Delete.php index d2d67af3e4..8a2eb816af 100644 --- a/api/v3/examples/PledgePayment/Delete.php +++ b/api/v3/examples/PledgePayment/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using pledge_payment delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PledgePayment/Get.php b/api/v3/examples/PledgePayment/Get.php index d936c9b54c..babc04bab7 100644 --- a/api/v3/examples/PledgePayment/Get.php +++ b/api/v3/examples/PledgePayment/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using pledge_payment get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PledgePayment/Update.php b/api/v3/examples/PledgePayment/Update.php index 0e4337579f..079796c35c 100644 --- a/api/v3/examples/PledgePayment/Update.php +++ b/api/v3/examples/PledgePayment/Update.php @@ -2,7 +2,6 @@ /** * Test Generated example of using pledge_payment update API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceField/Create.php b/api/v3/examples/PriceField/Create.php index 6f58e55f36..5b12fd3417 100644 --- a/api/v3/examples/PriceField/Create.php +++ b/api/v3/examples/PriceField/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_field create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceField/Delete.php b/api/v3/examples/PriceField/Delete.php index 011e0e34bc..931d43e066 100644 --- a/api/v3/examples/PriceField/Delete.php +++ b/api/v3/examples/PriceField/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_field delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceField/Get.php b/api/v3/examples/PriceField/Get.php index a91ee5bfde..69150e8461 100644 --- a/api/v3/examples/PriceField/Get.php +++ b/api/v3/examples/PriceField/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_field get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceFieldValue/Create.php b/api/v3/examples/PriceFieldValue/Create.php index 5f30c992aa..cd48bda29d 100644 --- a/api/v3/examples/PriceFieldValue/Create.php +++ b/api/v3/examples/PriceFieldValue/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_field_value create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceFieldValue/Delete.php b/api/v3/examples/PriceFieldValue/Delete.php index 97149b7ef6..0bb3980569 100644 --- a/api/v3/examples/PriceFieldValue/Delete.php +++ b/api/v3/examples/PriceFieldValue/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_field_value delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceFieldValue/Get.php b/api/v3/examples/PriceFieldValue/Get.php index d66f8b5c21..73c9b13d18 100644 --- a/api/v3/examples/PriceFieldValue/Get.php +++ b/api/v3/examples/PriceFieldValue/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_field_value get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceSet/Create.php b/api/v3/examples/PriceSet/Create.php index f8e8c112af..4fd0398f89 100644 --- a/api/v3/examples/PriceSet/Create.php +++ b/api/v3/examples/PriceSet/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_set create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceSet/Delete.php b/api/v3/examples/PriceSet/Delete.php index 1323c829e2..efe0a03815 100644 --- a/api/v3/examples/PriceSet/Delete.php +++ b/api/v3/examples/PriceSet/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_set delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/PriceSet/Get.php b/api/v3/examples/PriceSet/Get.php index b22dbdf4af..e6004c7d45 100644 --- a/api/v3/examples/PriceSet/Get.php +++ b/api/v3/examples/PriceSet/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using price_set get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Profile/Apply.php b/api/v3/examples/Profile/Apply.php index baecf5f7d7..0d1359c663 100644 --- a/api/v3/examples/Profile/Apply.php +++ b/api/v3/examples/Profile/Apply.php @@ -2,7 +2,6 @@ /** * Test Generated example of using profile apply API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Profile/Get.php b/api/v3/examples/Profile/Get.php index 14c5a1e441..dbcb37e76b 100644 --- a/api/v3/examples/Profile/Get.php +++ b/api/v3/examples/Profile/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using profile get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Profile/GetFields.php b/api/v3/examples/Profile/GetFields.php index c7ce75549d..7a4eccdfe5 100644 --- a/api/v3/examples/Profile/GetFields.php +++ b/api/v3/examples/Profile/GetFields.php @@ -221,6 +221,7 @@ function profile_getfields_expectedresult() { 'profile_id' => array( 'api.required' => TRUE, 'title' => 'Profile ID', + 'name' => 'profile_id', ), ), ); diff --git a/api/v3/examples/Profile/Submit.php b/api/v3/examples/Profile/Submit.php index a33148e0ee..c5db62a72a 100644 --- a/api/v3/examples/Profile/Submit.php +++ b/api/v3/examples/Profile/Submit.php @@ -2,7 +2,6 @@ /** * Test Generated example of using profile submit API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Relationship/BetweenRelationshipType.php b/api/v3/examples/Relationship/BetweenRelationshipType.php index 306c64fba0..434d531482 100644 --- a/api/v3/examples/Relationship/BetweenRelationshipType.php +++ b/api/v3/examples/Relationship/BetweenRelationshipType.php @@ -2,7 +2,7 @@ /** * Test Generated example of using relationship get API. * - * demonstrates use of BETWEEN filter + * Demonstrates use of BETWEEN filter. * * @return array * API result array diff --git a/api/v3/examples/Relationship/Create.php b/api/v3/examples/Relationship/Create.php index 63f8cca51b..bcdf527463 100644 --- a/api/v3/examples/Relationship/Create.php +++ b/api/v3/examples/Relationship/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using relationship create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Relationship/Delete.php b/api/v3/examples/Relationship/Delete.php index 750193e0a7..54d222ee15 100644 --- a/api/v3/examples/Relationship/Delete.php +++ b/api/v3/examples/Relationship/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using relationship delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Relationship/Get.php b/api/v3/examples/Relationship/Get.php index e8e5d73d13..26bde30348 100644 --- a/api/v3/examples/Relationship/Get.php +++ b/api/v3/examples/Relationship/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using relationship get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Relationship/INRelationshipType.php b/api/v3/examples/Relationship/INRelationshipType.php index c552cf0a51..c7f25e3915 100644 --- a/api/v3/examples/Relationship/INRelationshipType.php +++ b/api/v3/examples/Relationship/INRelationshipType.php @@ -2,7 +2,7 @@ /** * Test Generated example of using relationship get API. * - * demonstrates use of IN filter + * Demonstrates use of IN filter. * * @return array * API result array diff --git a/api/v3/examples/Relationship/NotBetweenRelationshipType.php b/api/v3/examples/Relationship/NotBetweenRelationshipType.php index 22d2980d0f..e6a2fea178 100644 --- a/api/v3/examples/Relationship/NotBetweenRelationshipType.php +++ b/api/v3/examples/Relationship/NotBetweenRelationshipType.php @@ -2,7 +2,7 @@ /** * Test Generated example of using relationship get API. * - * demonstrates use of Not BETWEEN filter + * Demonstrates use of Not BETWEEN filter. * * @return array * API result array diff --git a/api/v3/examples/Relationship/NotInRelationshipType.php b/api/v3/examples/Relationship/NotInRelationshipType.php index 15c63683be..bed39cd065 100644 --- a/api/v3/examples/Relationship/NotInRelationshipType.php +++ b/api/v3/examples/Relationship/NotInRelationshipType.php @@ -2,7 +2,7 @@ /** * Test Generated example of using relationship get API. * - * demonstrates use of NOT IN filter + * Demonstrates use of NOT IN filter. * * @return array * API result array diff --git a/api/v3/examples/Relationship/filterIsCurrent.php b/api/v3/examples/Relationship/filterIsCurrent.php index f8a17bae0b..3a145bad34 100644 --- a/api/v3/examples/Relationship/filterIsCurrent.php +++ b/api/v3/examples/Relationship/filterIsCurrent.php @@ -2,7 +2,7 @@ /** * Test Generated example of using relationship get API. * - * demonstrates is_current filter + * Demonstrates is_current filter. * * @return array * API result array diff --git a/api/v3/examples/RelationshipType/Create.php b/api/v3/examples/RelationshipType/Create.php index 95a88246d4..cbb9eff07f 100644 --- a/api/v3/examples/RelationshipType/Create.php +++ b/api/v3/examples/RelationshipType/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using relationship_type create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/RelationshipType/Delete.php b/api/v3/examples/RelationshipType/Delete.php index f017582f3b..e418077a65 100644 --- a/api/v3/examples/RelationshipType/Delete.php +++ b/api/v3/examples/RelationshipType/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using relationship_type delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/ReportTemplate/Getrows.php b/api/v3/examples/ReportTemplate/Getrows.php index e4c01c7995..660a3fe23a 100644 --- a/api/v3/examples/ReportTemplate/Getrows.php +++ b/api/v3/examples/ReportTemplate/Getrows.php @@ -2,7 +2,7 @@ /** * Test Generated example of using report_template getrows API. * - * Retrieve rows from a report template (optionally providing the instance_id) + * Retrieve rows from a report template (optionally providing the instance_id). * * @return array * API result array diff --git a/api/v3/examples/ReportTemplate/Getstatistics.php b/api/v3/examples/ReportTemplate/Getstatistics.php index ad5193eb32..eb62f9938a 100644 --- a/api/v3/examples/ReportTemplate/Getstatistics.php +++ b/api/v3/examples/ReportTemplate/Getstatistics.php @@ -2,7 +2,7 @@ /** * Test Generated example of using report_template getstatistics API. * - * Get Statistics from a report (note there isn't much data to get in the test DB :-( + * Get Statistics from a report (note there isn't much data to get in the test DB). * * @return array * API result array diff --git a/api/v3/examples/Setting/Create.php b/api/v3/examples/Setting/Create.php index e43d35b4ae..6436b6f8dc 100644 --- a/api/v3/examples/Setting/Create.php +++ b/api/v3/examples/Setting/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using setting create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Setting/CreateAllDomains.php b/api/v3/examples/Setting/CreateAllDomains.php index 494a1e3858..2e54b93bf2 100644 --- a/api/v3/examples/Setting/CreateAllDomains.php +++ b/api/v3/examples/Setting/CreateAllDomains.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting create API. * - * shows setting a variable for all domains + * Shows setting a variable for all domains. * * @return array * API result array diff --git a/api/v3/examples/Setting/CreateSettingCurrentDomain.php b/api/v3/examples/Setting/CreateSettingCurrentDomain.php index 505827c157..1188945550 100644 --- a/api/v3/examples/Setting/CreateSettingCurrentDomain.php +++ b/api/v3/examples/Setting/CreateSettingCurrentDomain.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting create API. * - * shows setting a variable for a current domain + * Shows setting a variable for a current domain. * * @return array * API result array diff --git a/api/v3/examples/Setting/CreateSpecifiedDomains.php b/api/v3/examples/Setting/CreateSpecifiedDomains.php index 4312b6ea0b..2a859c38dd 100644 --- a/api/v3/examples/Setting/CreateSpecifiedDomains.php +++ b/api/v3/examples/Setting/CreateSpecifiedDomains.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting create API. * - * shows setting a variable for specified domains + * Shows setting a variable for specified domains. * * @return array * API result array diff --git a/api/v3/examples/Setting/Get.php b/api/v3/examples/Setting/Get.php index 0b304b919a..4111d4a8e9 100644 --- a/api/v3/examples/Setting/Get.php +++ b/api/v3/examples/Setting/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using setting get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Setting/GetAllDomains.php b/api/v3/examples/Setting/GetAllDomains.php index 6a97968b92..045e9de61c 100644 --- a/api/v3/examples/Setting/GetAllDomains.php +++ b/api/v3/examples/Setting/GetAllDomains.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting Get API. * - * shows getting a variable for all domains + * Shows getting a variable for all domains. * * @return array * API result array diff --git a/api/v3/examples/Setting/GetDefaults.php b/api/v3/examples/Setting/GetDefaults.php index aa88b40231..98931bb9c5 100644 --- a/api/v3/examples/Setting/GetDefaults.php +++ b/api/v3/examples/Setting/GetDefaults.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting getdefaults API. * - * gets defaults setting a variable for a given domain - if no domain is set current is assumed + * Gets defaults setting a variable for a given domain - if no domain is set current is assumed. * * @return array * API result array diff --git a/api/v3/examples/Setting/GetFields.php b/api/v3/examples/Setting/GetFields.php index c2fbc5d524..b08a94cacd 100644 --- a/api/v3/examples/Setting/GetFields.php +++ b/api/v3/examples/Setting/GetFields.php @@ -639,11 +639,11 @@ function setting_getfields_expectedresult() { 'config_only' => 1, 'type' => 'String', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 64, 'maxlength' => 256, ), + 'html_type' => 'Text', 'default' => '', 'add' => '4.3', 'title' => 'Path to wkhtmltopdf executable', @@ -660,11 +660,11 @@ function setting_getfields_expectedresult() { 'config_only' => 1, 'type' => 'String', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 64, 'maxlength' => 64, ), + 'html_type' => 'Text', 'default' => '', 'add' => '4.3', 'title' => 'Recaptcha Public Key', @@ -681,11 +681,11 @@ function setting_getfields_expectedresult() { 'config_only' => 1, 'type' => 'String', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 64, 'maxlength' => 64, ), + 'html_type' => 'Text', 'default' => '', 'add' => '4.3', 'title' => 'Recaptcha Private Key', @@ -702,11 +702,11 @@ function setting_getfields_expectedresult() { 'config_only' => 1, 'type' => 'Integer', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 3, 'maxlength' => 5, ), + 'html_type' => 'Text', 'default' => '', 'add' => '4.3', 'title' => 'Dashboard cache timeout', @@ -722,11 +722,11 @@ function setting_getfields_expectedresult() { 'prefetch' => 1, 'type' => 'Integer', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 2, 'maxlength' => 8, ), + 'html_type' => 'Text', 'default' => 7, 'add' => '4.3', 'title' => 'Checksum Lifespan', @@ -742,11 +742,11 @@ function setting_getfields_expectedresult() { 'prefetch' => 0, 'type' => 'String', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 64, 'maxlength' => 128, ), + 'html_type' => 'Text', 'default' => '*default*', 'add' => '4.3', 'title' => 'Blog Feed URL', @@ -762,11 +762,11 @@ function setting_getfields_expectedresult() { 'prefetch' => 0, 'type' => 'String', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 64, 'maxlength' => 128, ), + 'html_type' => 'Text', 'default' => '*default*', 'add' => '4.3', 'title' => 'Community Messages URL', @@ -783,11 +783,11 @@ function setting_getfields_expectedresult() { 'config_only' => 1, 'type' => 'String', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 16, 'maxlength' => 16, ), + 'html_type' => 'Text', 'default' => '', 'add' => '4.3', 'title' => 'Resource Cache Code', @@ -868,14 +868,9 @@ function setting_getfields_expectedresult() { 'description' => '', 'help_text' => '', 'on_change' => array( - '0' => array( - '0' => 'CRM_Case_Info', - '1' => 'onToggleComponents', - ), - '1' => array( - '0' => 'CRM_Core_Component', - '1' => 'flushEnabledComponents', - ), + '0' => 'CRM_Case_Info::onToggleComponents', + '1' => 'CRM_Core_Component::flushEnabledComponents', + '2' => 'call://resources/resetCacheCode', ), ), 'disable_core_css' => array( @@ -936,8 +931,7 @@ function setting_getfields_expectedresult() { 'is_contact' => 0, 'description' => 'Set this value to Yes if you want CiviCRM error/debugging messages to also appear in Drupal error logs', 'prefetch' => 1, - 'help_text' => 'Set this value to Yes if you want CiviCRM error/debugging messages the appear in your CMS\' error log. -In the case of Drupal, this will cause all CiviCRM error messages to appear in the watchdog (assuming you have Drupal\'s watchdog enabled)', + 'help_text' => 'Set this value to Yes if you want CiviCRM error/debugging messages the appear in your CMS\' error log. In the case of Drupal, this will cause all CiviCRM error messages to appear in the watchdog (assuming you have Drupal\'s watchdog enabled)', ), 'backtrace' => array( 'group_name' => 'Developer Preferences', @@ -1343,10 +1337,10 @@ In the case of Drupal, this will cause all CiviCRM error messages to appear in t 'html_type' => 'checkbox', 'default' => 0, 'add' => '4.1', - 'title' => 'Enable Double Opt-in for Profile Group(s) field', + 'title' => 'Track replies using VERP in Reply-To header', 'is_domain' => 1, 'is_contact' => 0, - 'description' => 'When CiviMail is enabled, users who \"subscribe\" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.', + 'description' => 'If checked, mailings will default to tracking replies using VERP-ed Reply-To. ', 'help_text' => '', 'validate_callback' => 'CRM_Core_BAO_Setting::validateBoolSetting', ), @@ -1565,11 +1559,11 @@ In the case of Drupal, this will cause all CiviCRM error messages to appear in t 'prefetch' => 0, 'type' => 'String', 'quick_form_type' => 'Element', - 'html_type' => 'Text', 'html_attributes' => array( 'size' => 64, 'maxlength' => 64, ), + 'html_type' => 'Text', 'default' => 'simple', 'add' => '4.5', 'title' => 'How to handle full-tet queries', diff --git a/api/v3/examples/Setting/GetSettingCurrentDomain.php b/api/v3/examples/Setting/GetSettingCurrentDomain.php index ce7b044a30..8901b319ba 100644 --- a/api/v3/examples/Setting/GetSettingCurrentDomain.php +++ b/api/v3/examples/Setting/GetSettingCurrentDomain.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting get API. * - * shows getting a variable for a current domain + * Shows getting a variable for a current domain. * * @return array * API result array diff --git a/api/v3/examples/Setting/GetSpecifiedDomains.php b/api/v3/examples/Setting/GetSpecifiedDomains.php index e2d811b358..989831e277 100644 --- a/api/v3/examples/Setting/GetSpecifiedDomains.php +++ b/api/v3/examples/Setting/GetSpecifiedDomains.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting Get API. * - * shows getting a variable for specified domains + * Shows getting a variable for specified domains. * * @return array * API result array diff --git a/api/v3/examples/Setting/GetValue.php b/api/v3/examples/Setting/GetValue.php index 632e0a8b45..9f0a5b33a2 100644 --- a/api/v3/examples/Setting/GetValue.php +++ b/api/v3/examples/Setting/GetValue.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting getvalue API. * - * Demonstrates getvalue action - intended for runtime use as better caching than get + * Demonstrates getvalue action - intended for runtime use as better caching than get. * * @return array * API result array diff --git a/api/v3/examples/Setting/Revert.php b/api/v3/examples/Setting/Revert.php index 8814472dde..2dedceea2f 100644 --- a/api/v3/examples/Setting/Revert.php +++ b/api/v3/examples/Setting/Revert.php @@ -2,7 +2,7 @@ /** * Test Generated example of using setting revert API. * - * Demonstrates reverting a parameter to default value + * Demonstrates reverting a parameter to default value. * * @return array * API result array diff --git a/api/v3/examples/Survey/ChainedGetDelete.php b/api/v3/examples/Survey/ChainedGetDelete.php index 62f904cd14..eecfd4a1bb 100644 --- a/api/v3/examples/Survey/ChainedGetDelete.php +++ b/api/v3/examples/Survey/ChainedGetDelete.php @@ -2,7 +2,7 @@ /** * Test Generated example of using survey get API. * - * demonstrates get + delete in the same call + * Demonstrates get + delete in the same call. * * @return array * API result array diff --git a/api/v3/examples/Survey/Create.php b/api/v3/examples/Survey/Create.php index df8a691983..8c4a3415f4 100644 --- a/api/v3/examples/Survey/Create.php +++ b/api/v3/examples/Survey/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using survey create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Survey/Delete.php b/api/v3/examples/Survey/Delete.php index 657c9ab801..bccd1adf5a 100644 --- a/api/v3/examples/Survey/Delete.php +++ b/api/v3/examples/Survey/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using survey delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Survey/Get.php b/api/v3/examples/Survey/Get.php index aa1f53a9ea..f61a6c90bb 100644 --- a/api/v3/examples/Survey/Get.php +++ b/api/v3/examples/Survey/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using survey get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Tag/Create.php b/api/v3/examples/Tag/Create.php index b6a8774fdc..01c2ece535 100644 --- a/api/v3/examples/Tag/Create.php +++ b/api/v3/examples/Tag/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using tag create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Tag/Delete.php b/api/v3/examples/Tag/Delete.php index 282e34ffa6..ef41b0cc5c 100644 --- a/api/v3/examples/Tag/Delete.php +++ b/api/v3/examples/Tag/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using tag delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Tag/Get.php b/api/v3/examples/Tag/Get.php index 646f64ff10..248f35fcc3 100644 --- a/api/v3/examples/Tag/Get.php +++ b/api/v3/examples/Tag/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using tag get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Tag/GetList.php b/api/v3/examples/Tag/GetList.php index d7d4694f72..f0f4f28a29 100644 --- a/api/v3/examples/Tag/GetList.php +++ b/api/v3/examples/Tag/GetList.php @@ -2,7 +2,7 @@ /** * Test Generated example of using tag getlist API. * - * Demonstrates use of api.getlist for autocomplete and quicksearch applications + * Demonstrates use of api.getlist for autocomplete and quicksearch applications. * * @return array * API result array diff --git a/api/v3/examples/Tag/Getfields.php b/api/v3/examples/Tag/Getfields.php index 07ad2fcc76..367e755465 100644 --- a/api/v3/examples/Tag/Getfields.php +++ b/api/v3/examples/Tag/Getfields.php @@ -2,7 +2,7 @@ /** * Test Generated example of using tag getfields API. * - * demonstrate use of getfields to interrogate api + * Demonstrate use of getfields to interrogate api. * * @return array * API result array diff --git a/api/v3/examples/Tag/getReturnArray.php b/api/v3/examples/Tag/getReturnArray.php index be82d8770a..d49a8ba189 100644 --- a/api/v3/examples/Tag/getReturnArray.php +++ b/api/v3/examples/Tag/getReturnArray.php @@ -2,7 +2,7 @@ /** * Test Generated example of using tag get API. * - * demonstrates use of Return as an array + * Demonstrates use of Return as an array. * * @return array * API result array diff --git a/api/v3/examples/TaxContributionPage/Create.php b/api/v3/examples/TaxContributionPage/Create.php index ed6fe3af53..e3b7172661 100644 --- a/api/v3/examples/TaxContributionPage/Create.php +++ b/api/v3/examples/TaxContributionPage/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using tax_contribution_page create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/TaxContributionPage/CreateWithNestedLineItems.php b/api/v3/examples/TaxContributionPage/CreateWithNestedLineItems.php index 8dd40f5473..749a06df20 100644 --- a/api/v3/examples/TaxContributionPage/CreateWithNestedLineItems.php +++ b/api/v3/examples/TaxContributionPage/CreateWithNestedLineItems.php @@ -2,7 +2,7 @@ /** * Test Generated example of using tax_contribution_page create API. * - * Create Contribution with Nested Line Items + * Create Contribution with Nested Line Items. * * @return array * API result array diff --git a/api/v3/examples/TaxContributionPage/Delete.php b/api/v3/examples/TaxContributionPage/Delete.php index 0a73589505..1047ae0a97 100644 --- a/api/v3/examples/TaxContributionPage/Delete.php +++ b/api/v3/examples/TaxContributionPage/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using tax_contribution_page delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFField/Create.php b/api/v3/examples/UFField/Create.php index 2cc1157dd4..8e8feac1a3 100644 --- a/api/v3/examples/UFField/Create.php +++ b/api/v3/examples/UFField/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_field create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFField/Delete.php b/api/v3/examples/UFField/Delete.php index 48de888223..6e6d90b46a 100644 --- a/api/v3/examples/UFField/Delete.php +++ b/api/v3/examples/UFField/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_field delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFField/Get.php b/api/v3/examples/UFField/Get.php index 81979bace2..72a9f23f89 100644 --- a/api/v3/examples/UFField/Get.php +++ b/api/v3/examples/UFField/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_field get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFField/Replace.php b/api/v3/examples/UFField/Replace.php index 141fdcf3e0..70451d9a95 100644 --- a/api/v3/examples/UFField/Replace.php +++ b/api/v3/examples/UFField/Replace.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_field replace API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFGroup/Create.php b/api/v3/examples/UFGroup/Create.php index 4926d27142..5798664754 100644 --- a/api/v3/examples/UFGroup/Create.php +++ b/api/v3/examples/UFGroup/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_group create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFGroup/Delete.php b/api/v3/examples/UFGroup/Delete.php index 3968fb0ea5..bafd44f5bd 100644 --- a/api/v3/examples/UFGroup/Delete.php +++ b/api/v3/examples/UFGroup/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_group delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFGroup/Get.php b/api/v3/examples/UFGroup/Get.php index fc4b2aacec..87103511b9 100644 --- a/api/v3/examples/UFGroup/Get.php +++ b/api/v3/examples/UFGroup/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_group get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFJoin/Create.php b/api/v3/examples/UFJoin/Create.php index e76fc634ca..bbfcee5e1c 100644 --- a/api/v3/examples/UFJoin/Create.php +++ b/api/v3/examples/UFJoin/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_join create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFJoin/Get.php b/api/v3/examples/UFJoin/Get.php index a1880ff1a7..5de96a06f9 100644 --- a/api/v3/examples/UFJoin/Get.php +++ b/api/v3/examples/UFJoin/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_join get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/UFMatch/Get.php b/api/v3/examples/UFMatch/Get.php index 7b97b740ce..71cabba8e1 100644 --- a/api/v3/examples/UFMatch/Get.php +++ b/api/v3/examples/UFMatch/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using uf_match get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Website/Create.php b/api/v3/examples/Website/Create.php index da6052f468..b3bfcd55dd 100644 --- a/api/v3/examples/Website/Create.php +++ b/api/v3/examples/Website/Create.php @@ -2,7 +2,6 @@ /** * Test Generated example of using website create API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Website/Delete.php b/api/v3/examples/Website/Delete.php index ce5b88f44c..379c1bc707 100644 --- a/api/v3/examples/Website/Delete.php +++ b/api/v3/examples/Website/Delete.php @@ -2,7 +2,6 @@ /** * Test Generated example of using website delete API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Website/Get.php b/api/v3/examples/Website/Get.php index 8b536a0335..7f42cf6c2e 100644 --- a/api/v3/examples/Website/Get.php +++ b/api/v3/examples/Website/Get.php @@ -2,7 +2,6 @@ /** * Test Generated example of using website get API. * - * * @return array * API result array */ diff --git a/api/v3/examples/Website/GetFields.php b/api/v3/examples/Website/GetFields.php index 5c8e1d7aba..2cc7c13115 100644 --- a/api/v3/examples/Website/GetFields.php +++ b/api/v3/examples/Website/GetFields.php @@ -2,7 +2,6 @@ /** * Test Generated example of using website getfields API. * - * * @return array * API result array */ diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index 48d9874df6..61324b78eb 100755 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -2343,6 +2343,13 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { else { $fnPrefix = strtolower(preg_replace('/(?assign('testfunction', $function); $function = $fnPrefix . "_" . strtolower($action); @@ -2351,7 +2358,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { $smarty->assign('params', $params); $smarty->assign('entity', $entity); $smarty->assign('filename', basename($filename)); - $smarty->assign('description', $description); + $smarty->assign('description', $desc); $smarty->assign('result', $result); $smarty->assign('action', $action); diff --git a/tests/phpunit/api/v3/ActivityTest.php b/tests/phpunit/api/v3/ActivityTest.php index 078cb9884c..e8aafa0b63 100644 --- a/tests/phpunit/api/v3/ActivityTest.php +++ b/tests/phpunit/api/v3/ActivityTest.php @@ -331,7 +331,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { */ public function testActivityReturnTargetAssignee() { - $description = "Example demonstrates setting & retrieving the target & source"; + $description = "Demonstrates setting & retrieving activity target & source."; $subfile = "GetTargetandAssignee"; $params = array( 'source_contact_id' => $this->_contactID, @@ -394,7 +394,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { $this->callAPISuccess('contact', 'create', array('id' => $this->_contactID, 'sort_name' => 'Contact, Test')); $subfile = 'ContactRefCustomField'; - $description = "demonstrates create with Contact Reference Custom Field"; + $description = "Demonstrates create with Contact Reference Custom Field."; $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); $params = array( 'custom_group_id' => $ids['custom_group_id'], @@ -500,9 +500,8 @@ class api_v3_ActivityTest extends CiviUnitTestCase { * Test civicrm_activity_get() with a good activity ID */ public function testActivityGetGoodID1() { - // Insert rows in civicrm_activity creating activities 4 and - // 13 - $description = "Function demonstrates getting asignee_contact_id & using it to get the contact"; + // Insert rows in civicrm_activity creating activities 4 and 13 + $description = "Demonstrates getting asignee_contact_id & using it to get the contact."; $subfile = 'ReturnAssigneeContact'; $activity = $this->callAPISuccess('activity', 'create', $this->_params); @@ -665,7 +664,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { $result = $this->callAPISuccess('Activity', 'Get', array( 'version' => 3, )); - $description = "demonstrates _low filter (at time of writing doesn't work if contact_id is set"; + $description = "Demonstrates _low filter (at time of writing doesn't work if contact_id is set."; $subfile = "DateTimeLow"; $this->assertEquals(2, $result['count']); $params = array( @@ -675,7 +674,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { ); $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); $this->assertEquals(1, $result['count']); - $description = "demonstrates _high filter (at time of writing doesn't work if contact_id is set"; + $description = "Demonstrates _high filter (at time of writing doesn't work if contact_id is set."; $subfile = "DateTimeHigh"; $this->assertEquals('2012-02-16 00:00:00', $result['values'][0]['activity_date_time']); $params = array( diff --git a/tests/phpunit/api/v3/AddressTest.php b/tests/phpunit/api/v3/AddressTest.php index b8f1b0baba..bad5899275 100644 --- a/tests/phpunit/api/v3/AddressTest.php +++ b/tests/phpunit/api/v3/AddressTest.php @@ -87,7 +87,7 @@ class api_v3_AddressTest extends CiviUnitTestCase { 'contact_id' => $this->_contactID, ); $subfile = "AddressParse"; - $description = "Demonstrates Use of address parsing param"; + $description = "Demonstrates Use of address parsing param."; $result = $this->callAPIAndDocument('address', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile); $this->assertEquals(54, $result['values'][$result['id']]['street_number'], 'In line ' . __LINE__); $this->assertEquals('A', $result['values'][$result['id']]['street_number_suffix'], 'In line ' . __LINE__); @@ -255,7 +255,7 @@ class api_v3_AddressTest extends CiviUnitTestCase { $create = $this->callAPISuccess('address', 'create', $this->_params); $this->callAPISuccess('address', 'create', array_merge($this->_params, array('street_address' => 'yzy'))); $subfile = "AddressSort"; - $description = "Demonstrates Use of sort filter"; + $description = "Demonstrates Use of sort filter."; $params = array( 'options' => array( 'sort' => 'street_address DESC', @@ -275,7 +275,7 @@ class api_v3_AddressTest extends CiviUnitTestCase { public function testGetAddressLikeSuccess() { $this->callAPISuccess('address', 'create', $this->_params); $subfile = "AddressLike"; - $description = "Demonstrates Use of Like"; + $description = "Demonstrates Use of Like."; $params = array( 'street_address' => array('LIKE' => '%mb%'), 'sequential' => 1, diff --git a/tests/phpunit/api/v3/CampaignTest.php b/tests/phpunit/api/v3/CampaignTest.php index ed1a7194cd..26c1154894 100644 --- a/tests/phpunit/api/v3/CampaignTest.php +++ b/tests/phpunit/api/v3/CampaignTest.php @@ -50,7 +50,8 @@ class api_v3_CampaignTest extends CiviUnitTestCase { } public function testCreateCampaign() { - $description = "Create a campaign - Note use of relative dates here http://www.php.net/manual/en/datetime.formats.relative.php"; + $description = "Create a campaign - Note use of relative dates here: + @link http://www.php.net/manual/en/datetime.formats.relative.php."; $result = $this->callAPIAndDocument('campaign', 'create', $this->params, __FUNCTION__, __FILE__, $description); $this->assertEquals(1, $result['count'], 'In line ' . __LINE__); $this->assertNotNull($result['values'][$result['id']]['id'], 'In line ' . __LINE__); diff --git a/tests/phpunit/api/v3/ContactTest.php b/tests/phpunit/api/v3/ContactTest.php index 1725264fc6..f9d97e9394 100644 --- a/tests/phpunit/api/v3/ContactTest.php +++ b/tests/phpunit/api/v3/ContactTest.php @@ -332,7 +332,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $params = $this->_params; $params['custom_' . $ids['custom_field_id']] = "custom string"; - $description = "/*this demonstrates setting a custom field through the API "; + $description = "This demonstrates setting a custom field through the API."; $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__, $description); $check = $this->callAPISuccess($this->_entity, 'get', array( @@ -586,7 +586,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $params = $this->_params; $params['custom_' . $ids['custom_field_id']] = "custom string"; - $description = "/*this demonstrates setting a custom field through the API "; + $description = "This demonstrates setting a custom field through the API."; $subfile = "CustomFieldGet"; $result = $this->callAPISuccess($this->_entity, 'create', $params); @@ -614,7 +614,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $params = $this->_params; $params['custom_' . $ids['custom_field_id']] = "custom string"; - $description = "/*this demonstrates setting a custom field through the API "; + $description = "This demonstrates setting a custom field through the API."; $subfile = "CustomFieldGetReturnSyntaxVariation"; $result = $this->callAPISuccess($this->_entity, 'create', $params); $params = array('return' => 'custom_' . $ids['custom_field_id'], 'id' => $result['id']); @@ -647,7 +647,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { public function testGetGroupIDFromContact() { $groupId = $this->groupCreate(); - $description = "Get all from group and display contacts"; + $description = "Get all from group and display contacts."; $subFile = "GroupFilterUsingContactAPI"; $params = array( 'email' => 'man2@yahoo.com', @@ -709,7 +709,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { * Verify that attempt to create individual contact with two chained websites succeeds. */ public function testCreateIndividualWithContributionDottedSyntax() { - $description = "test demonstrates the syntax to create 2 chained entities"; + $description = "This demonstrates the syntax to create 2 chained entities."; $subFile = "ChainTwoWebsites"; $params = array( 'first_name' => 'abc3', @@ -782,7 +782,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { ), ); - $description = "demonstrates creating two websites as an array"; + $description = "Demonstrates creating two websites as an array."; $subfile = "ChainTwoWebsitesSyntax2"; $result = $this->callAPIAndDocument('Contact', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile); @@ -1419,7 +1419,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $params['custom_' . $ids['custom_field_id']] = "custom string"; $moreIDs = $this->CustomGroupMultipleCreateWithFields(); - $description = "/*this demonstrates the usage of chained api functions. In this case no notes or custom fields have been created "; + $description = "This demonstrates the usage of chained api functions.\nIn this case no notes or custom fields have been created."; $subfile = "APIChainedArray"; $params = array( 'first_name' => 'abc3', @@ -1480,8 +1480,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } public function testGetIndividualWithChainedArraysFormats() { - $description = "/*this demonstrates the usage of chained api functions. A variety of return formats are used. Note that no notes - *custom fields or memberships exist"; + $description = "This demonstrates the usage of chained api functions.\nIn this case no notes or custom fields have been created."; $subfile = "APIChainedArrayFormats"; $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); $params['custom_' . $ids['custom_field_id']] = "custom string"; @@ -1552,7 +1551,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { 'title' => "another group", 'name' => 'another name', )); - $description = "/*this demonstrates the usage of chained api functions. A variety of techniques are used"; + $description = "This demonstrates the usage of chained api functions with multiple custom fields."; $subfile = "APIChainedArrayMultipleCustom"; $params = array( 'first_name' => 'abc3', @@ -1626,8 +1625,8 @@ class api_v3_ContactTest extends CiviUnitTestCase { * Test checks usage of $values to pick & choose inputs. */ public function testChainingValuesCreate() { - $description = "/*this demonstrates the usage of chained api functions. Specifically it has one 'parent function' & - 2 child functions - one receives values from the parent (Contact) and the other child (Tag). "; + $description = "This demonstrates the usage of chained api functions. Specifically it has one 'parent function' & + 2 child functions - one receives values from the parent (Contact) and the other child (Tag)."; $subfile = "APIChainedArrayValuesFromSiblingFunction"; $params = array( 'display_name' => 'batman', @@ -1680,8 +1679,8 @@ class api_v3_ContactTest extends CiviUnitTestCase { public function testContactGetSingleEntityArray() { $this->createContactFromXML(); $description = "This demonstrates use of the 'format.single_entity_array' param. - /* This param causes the only contact to be returned as an array without the other levels. - /* it will be ignored if there is not exactly 1 result"; + This param causes the only contact to be returned as an array without the other levels. + It will be ignored if there is not exactly 1 result"; $subfile = "GetSingleContact"; $params = array('id' => 17); $result = $this->callAPIAndDocument('Contact', 'GetSingle', $params, __FUNCTION__, __FILE__, $description, $subfile); @@ -1694,9 +1693,8 @@ class api_v3_ContactTest extends CiviUnitTestCase { */ public function testContactGetFormatCountOnly() { $this->createContactFromXML(); - $description = "This demonstrates use of the 'getCount' action.\n" - . " *\n" - . " * This param causes the count of the only function to be returned as an integer."; + $description = "This demonstrates use of the 'getCount' action. + This param causes the count of the only function to be returned as an integer."; $subfile = "GetCountContact"; $params = array('id' => 17); $result = $this->callAPIAndDocument('Contact', 'GetCount', $params, __FUNCTION__, __FILE__, $description, @@ -1710,9 +1708,9 @@ class api_v3_ContactTest extends CiviUnitTestCase { */ public function testContactGetFormatIDOnly() { $this->createContactFromXML(); - $description = "This demonstrates use of the 'format.id_only' param.\n" . - " /* This param causes the id of the only entity to be returned as an integer." . - " /* it will be ignored if there is not exactly 1 result"; + $description = "This demonstrates use of the 'format.id_only' param. + This param causes the id of the only entity to be returned as an integer. + It will be ignored if there is not exactly 1 result"; $subfile = "FormatOnlyID"; $params = array('id' => 17, 'format.only_id' => 1); $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); @@ -1726,8 +1724,8 @@ class api_v3_ContactTest extends CiviUnitTestCase { public function testContactGetFormatSingleValue() { $this->createContactFromXML(); $description = "This demonstrates use of the 'format.single_value' param. - /* This param causes only a single value of the only entity to be returned as an string. - /* it will be ignored if there is not exactly 1 result"; + This param causes only a single value of the only entity to be returned as an string. + It will be ignored if there is not exactly 1 result"; $subFile = "FormatSingleValue"; $params = array('id' => 17, 'return' => 'display_name'); $result = $this->callAPIAndDocument('Contact', 'getvalue', $params, __FUNCTION__, __FILE__, $description, $subFile, 'getvalue'); diff --git a/tests/phpunit/api/v3/ContributionTest.php b/tests/phpunit/api/v3/ContributionTest.php index c35994f60a..9ee82f1aed 100644 --- a/tests/phpunit/api/v3/ContributionTest.php +++ b/tests/phpunit/api/v3/ContributionTest.php @@ -378,7 +378,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { ), ); - $description = "Create Contribution with Nested Line Items"; + $description = "Create Contribution with Nested Line Items."; $subfile = "CreateWithNestedLineItems"; $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile); @@ -574,7 +574,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { * Test note created correctly. */ public function testCreateContributionWithNote() { - $description = "Demonstrates creating contribution with Note Entity"; + $description = "Demonstrates creating contribution with Note Entity."; $subfile = "ContributionCreateWithNote"; $params = array( 'contact_id' => $this->_individualId, @@ -633,7 +633,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { * This is the test for creating soft credits. */ public function testCreateContributionWithSoftCredit() { - $description = "Demonstrates creating contribution with SoftCredit"; + $description = "Demonstrates creating contribution with SoftCredit."; $subfile = "ContributionCreateWithSoftCredit"; $contact2 = $this->callAPISuccess('Contact', 'create', array( 'display_name' => 'superman', @@ -658,7 +658,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } public function testCreateContributionWithSoftCreditDefaults() { - $description = "Demonstrates creating contribution with Soft Credit defaults for amount and type"; + $description = "Demonstrates creating contribution with Soft Credit defaults for amount and type."; $subfile = "ContributionCreateWithSoftCreditDefaults"; $contact2 = $this->callAPISuccess('Contact', 'create', array( 'display_name' => 'superman', @@ -680,7 +680,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { } public function testCreateContributionWithHonoreeContact() { - $description = "Demonstrates creating contribution with Soft Credit by passing in honor_contact_id"; + $description = "Demonstrates creating contribution with Soft Credit by passing in honor_contact_id."; $subfile = "ContributionCreateWithHonoreeContact"; $contact2 = $this->callAPISuccess('Contact', 'create', array( 'display_name' => 'superman', diff --git a/tests/phpunit/api/v3/CustomFieldTest.php b/tests/phpunit/api/v3/CustomFieldTest.php index 0252bd18a6..96dba20f96 100644 --- a/tests/phpunit/api/v3/CustomFieldTest.php +++ b/tests/phpunit/api/v3/CustomFieldTest.php @@ -367,7 +367,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { 'options' => array('get_options' => 'custom_' . $customField['id']), 'action' => 'create', ); - $description = "Demonstrate retrieving metadata with custom field options"; + $description = "Demonstrates retrieving metadata with custom field options."; $subfile = "GetFieldsOptions"; $fields = $this->callAPIAndDocument('contact', 'getfields', $getFieldsParams, __FUNCTION__, 'ContactTest.php', $description, $subfile, 'GetFields'); $this->assertArrayHasKey('options', $fields['values']['custom_' . $customField['id']]); @@ -375,7 +375,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { $getOptionsArray = array( 'field' => 'custom_' . $customField['id'], ); - $description = "Demonstrates retrieving options for a custom field"; + $description = "Demonstrates retrieving options for a custom field."; $subfile = "GetOptions"; $result = $this->callAPIAndDocument('contact', 'getoptions', $getOptionsArray, __FUNCTION__, 'ContactTest.php', $description, '', 'getoptions'); $this->assertEquals('Label1', $result['values'][1]); diff --git a/tests/phpunit/api/v3/CustomValueTest.php b/tests/phpunit/api/v3/CustomValueTest.php index ae837aae68..95d0437275 100644 --- a/tests/phpunit/api/v3/CustomValueTest.php +++ b/tests/phpunit/api/v3/CustomValueTest.php @@ -73,7 +73,7 @@ class api_v3_CustomValueTest extends CiviUnitTestCase { public function testGetMultipleCustomValues() { - $description = "/*this demonstrates the use of CustomValue get"; + $description = "This demonstrates the use of CustomValue get to fetch single and multi-valued custom data."; $params = array( 'first_name' => 'abc3', diff --git a/tests/phpunit/api/v3/EmailTest.php b/tests/phpunit/api/v3/EmailTest.php index 6c4e62e647..f6932d080f 100644 --- a/tests/phpunit/api/v3/EmailTest.php +++ b/tests/phpunit/api/v3/EmailTest.php @@ -249,7 +249,7 @@ class api_v3_EmailTest extends CiviUnitTestCase { )); $this->assertAPISuccess($get, 'In line ' . __LINE__); $this->assertEquals(0, $get['count'], 'email already exists ' . __LINE__); - $description = "example demonstrates use of Replace in a nested API call"; + $description = "Demonstrates use of Replace in a nested API call."; $subfile = "NestedReplaceEmail"; // initialize email list with three emails at loc #1 and two emails at loc #2 $getReplace1Params = array( diff --git a/tests/phpunit/api/v3/EventTest.php b/tests/phpunit/api/v3/EventTest.php index 2da71c446c..05094f7a6e 100644 --- a/tests/phpunit/api/v3/EventTest.php +++ b/tests/phpunit/api/v3/EventTest.php @@ -197,7 +197,7 @@ class api_v3_EventTest extends CiviUnitTestCase { ); $currentEventParams = array_merge($this->_params[1], $currentEventParams); $currentEvent = $this->callAPISuccess('Event', 'Create', $currentEventParams); - $description = "demonstrates use of is.Current option"; + $description = "Demonstrates use of is.Current option."; $subfile = "IsCurrentOption"; $result = $this->callAPIAndDocument('Event', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); $allEvents = $this->callAPISuccess('Event', 'Get', array()); @@ -245,7 +245,7 @@ class api_v3_EventTest extends CiviUnitTestCase { ); $currentEvent = $this->callAPISuccess('Event', 'getsingle', $getEventParams); - $description = "demonstrates use of return is_full "; + $description = "Demonstrates use of return is_full ."; $subfile = "IsFullOption"; $this->assertEquals(0, $currentEvent['is_full'], ' is full is set in line ' . __LINE__); $this->assertEquals(1, $currentEvent['available_places'], 'available places is set in line ' . __LINE__); @@ -529,7 +529,7 @@ class api_v3_EventTest extends CiviUnitTestCase { } public function testgetfields() { - $description = "demonstrate use of getfields to interrogate api"; + $description = "Demonstrate use of getfields to interrogate api."; $params = array('action' => 'create'); $result = $this->callAPISuccess('event', 'getfields', $params); $this->assertEquals(1, $result['values']['title']['api.required'], 'in line ' . __LINE__); @@ -539,21 +539,21 @@ class api_v3_EventTest extends CiviUnitTestCase { * Test api_action param also works. */ public function testgetfieldsRest() { - $description = "demonstrate use of getfields to interrogate api"; + $description = "Demonstrate use of getfields to interrogate api."; $params = array('api_action' => 'create'); $result = $this->callAPISuccess('event', 'getfields', $params); $this->assertEquals(1, $result['values']['title']['api.required'], 'in line ' . __LINE__); } public function testgetfieldsGet() { - $description = "demonstrate use of getfields to interrogate api"; + $description = "Demonstrate use of getfields to interrogate api."; $params = array('action' => 'get'); $result = $this->callAPISuccess('event', 'getfields', $params); $this->assertEquals('title', $result['values']['event_title']['name'], 'in line ' . __LINE__); } public function testgetfieldsDelete() { - $description = "demonstrate use of getfields to interrogate api"; + $description = "Demonstrate use of getfields to interrogate api."; $params = array('action' => 'delete'); $result = $this->callAPISuccess('event', 'getfields', $params); $this->assertEquals(1, $result['values']['id']['api.required']); diff --git a/tests/phpunit/api/v3/GroupContactTest.php b/tests/phpunit/api/v3/GroupContactTest.php index b4868aa04d..84e46648a6 100644 --- a/tests/phpunit/api/v3/GroupContactTest.php +++ b/tests/phpunit/api/v3/GroupContactTest.php @@ -100,7 +100,7 @@ class api_v3_GroupContactTest extends CiviUnitTestCase { } public function testGetGroupID() { - $description = "Get all from group and display contacts"; + $description = "Get all from group and display contacts."; $subfile = "GetWithGroupID"; $params = array( 'group_id' => $this->_groupId1, diff --git a/tests/phpunit/api/v3/GroupTest.php b/tests/phpunit/api/v3/GroupTest.php index 8e9f1484f8..15a5db8ba8 100644 --- a/tests/phpunit/api/v3/GroupTest.php +++ b/tests/phpunit/api/v3/GroupTest.php @@ -140,7 +140,7 @@ class api_v3_GroupTest extends CiviUnitTestCase { } public function testgetfields() { - $description = "demonstrate use of getfields to interrogate api"; + $description = "Demonstrate use of getfields to interrogate api."; $params = array('action' => 'create'); $result = $this->callAPIAndDocument('group', 'getfields', $params, __FUNCTION__, __FILE__, $description, 'getfields', 'getfields'); $this->assertEquals(1, $result['values']['is_active']['api.default']); diff --git a/tests/phpunit/api/v3/LocBlockTest.php b/tests/phpunit/api/v3/LocBlockTest.php index baf8446be5..793e23ed98 100644 --- a/tests/phpunit/api/v3/LocBlockTest.php +++ b/tests/phpunit/api/v3/LocBlockTest.php @@ -95,7 +95,7 @@ class api_v3_LocBlockTest extends CiviUnitTestCase { 'street_address' => '987654321', ), ); - $description = "Create entities and locBlock in 1 api call"; + $description = "Create entities and locBlock in 1 api call."; $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__, $description, 'createEntities'); $id = $result['id']; $this->assertEquals(1, $result['count']); diff --git a/tests/phpunit/api/v3/MailSettingsTest.php b/tests/phpunit/api/v3/MailSettingsTest.php index e62c0ca2df..c66858ae48 100644 --- a/tests/phpunit/api/v3/MailSettingsTest.php +++ b/tests/phpunit/api/v3/MailSettingsTest.php @@ -100,7 +100,7 @@ class api_v3_MailSettingsTest extends CiviUnitTestCase { * Test chained delete. */ public function testGetMailSettingsChainDelete() { - $description = "demonstrates get + delete in the same call"; + $description = "Demonstrates get + delete in the same call."; $subFile = 'ChainedGetDelete'; $params = array( 'title' => "MailSettings title", diff --git a/tests/phpunit/api/v3/MembershipTest.php b/tests/phpunit/api/v3/MembershipTest.php index e3aadd43ea..d415239529 100644 --- a/tests/phpunit/api/v3/MembershipTest.php +++ b/tests/phpunit/api/v3/MembershipTest.php @@ -338,7 +338,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { * Memberships expected. */ public function testGetOnlyActive() { - $description = "Demonstrates use of 'filter' active_only' param"; + $description = "Demonstrates use of 'filter' active_only' param."; $this->_membershipID = $this->contactMembershipCreate($this->_params); $subfile = 'filterIsCurrent'; $params = array( diff --git a/tests/phpunit/api/v3/OptionValueTest.php b/tests/phpunit/api/v3/OptionValueTest.php index c94512e282..01cb8d67fa 100644 --- a/tests/phpunit/api/v3/OptionValueTest.php +++ b/tests/phpunit/api/v3/OptionValueTest.php @@ -88,7 +88,7 @@ class api_v3_OptionValueTest extends CiviUnitTestCase { * Test offset param. */ public function testGetSingleValueOptionValueSort() { - $description = "demonstrates use of Sort param (available in many api functions). Also, getsingle"; + $description = "Demonstrates use of Sort param (available in many api functions). Also, getsingle."; $subfile = 'SortOption'; $result = $this->callAPISuccess('option_value', 'getsingle', array( 'option_group_id' => 1, diff --git a/tests/phpunit/api/v3/ParticipantTest.php b/tests/phpunit/api/v3/ParticipantTest.php index 370c3bf27d..dd0ac6166a 100644 --- a/tests/phpunit/api/v3/ParticipantTest.php +++ b/tests/phpunit/api/v3/ParticipantTest.php @@ -193,7 +193,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { 'contact_id' => $this->_contactID, )); - $description = "use nested get to get an event"; + $description = "Demonstrates use of nested get to fetch event data with participant records."; $subfile = "NestedEventGet"; $params = array( 'id' => $this->_participantID, @@ -688,7 +688,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { * Delete with a get - a 'criteria delete' */ public function testNestedDelete() { - $description = "Criteria delete by nesting a GET & a DELETE"; + $description = "Criteria delete by nesting a GET & a DELETE."; $subfile = "NestedDelete"; $participants = $this->callAPISuccess('Participant', 'Get', array()); $this->assertEquals($participants['count'], 3); @@ -702,8 +702,8 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { * Test creation of a participant with an associated contribution. */ public function testCreateParticipantWithPayment() { - $description = "single function to create contact w partipation & contribution. Note that in the - case of 'contribution' the 'create' is implied (api.contribution.create)"; + $description = "Single function to create contact with partipation & contribution. + Note that in the case of 'contribution' the 'create' is implied (api.contribution.create)"; $subfile = "CreateParticipantPayment"; $params = array( 'contact_type' => 'Individual', diff --git a/tests/phpunit/api/v3/RelationshipTest.php b/tests/phpunit/api/v3/RelationshipTest.php index b35878ceae..00525d563e 100644 --- a/tests/phpunit/api/v3/RelationshipTest.php +++ b/tests/phpunit/api/v3/RelationshipTest.php @@ -695,7 +695,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { $getParams = array( 'filters' => array('is_current' => 1), ); - $description = "demonstrates is_current filter"; + $description = "Demonstrates is_current filter."; $subfile = 'filterIsCurrent'; //no relationship has been created $result = $this->callAPIAndDocument('relationship', 'get', $getParams, __FUNCTION__, __FILE__, $description, $subfile); @@ -765,14 +765,14 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { 'relationship_type_id' => array('IN' => array($relationType2, $relationType3)), ); - $description = "demonstrates use of IN filter"; + $description = "Demonstrates use of IN filter."; $subfile = 'INRelationshipType'; $result = $this->callAPIAndDocument('relationship', 'get', $getParams, __FUNCTION__, __FILE__, $description, $subfile); $this->assertEquals($result['count'], 2); $this->AssertEquals(array($rel2['id'], $rel3['id']), array_keys($result['values'])); - $description = "demonstrates use of NOT IN filter"; + $description = "Demonstrates use of NOT IN filter."; $subfile = 'NotInRelationshipType'; $getParams = array( 'relationship_type_id' => array('NOT IN' => array($relationType2, $relationType3)), @@ -781,7 +781,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { $this->assertEquals($result['count'], 2); $this->AssertEquals(array($rel1['id'], $rel4['id']), array_keys($result['values'])); - $description = "demonstrates use of BETWEEN filter"; + $description = "Demonstrates use of BETWEEN filter."; $subfile = 'BetweenRelationshipType'; $getParams = array( 'relationship_type_id' => array('BETWEEN' => array($relationType2, $relationType4)), @@ -790,7 +790,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { $this->assertEquals($result['count'], 3); $this->AssertEquals(array($rel2['id'], $rel3['id'], $rel4['id']), array_keys($result['values'])); - $description = "demonstrates use of Not BETWEEN filter"; + $description = "Demonstrates use of Not BETWEEN filter."; $subfile = 'NotBetweenRelationshipType'; $getParams = array( 'relationship_type_id' => array('NOT BETWEEN' => array($relationType2, $relationType4)), diff --git a/tests/phpunit/api/v3/ReportTemplateTest.php b/tests/phpunit/api/v3/ReportTemplateTest.php index 973900ca41..ef73aee6e3 100644 --- a/tests/phpunit/api/v3/ReportTemplateTest.php +++ b/tests/phpunit/api/v3/ReportTemplateTest.php @@ -115,7 +115,7 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase { * Test getrows on contact summary report. */ public function testReportTemplateGetRowsContactSummary() { - $description = "Retrieve rows from a report template (optionally providing the instance_id)"; + $description = "Retrieve rows from a report template (optionally providing the instance_id)."; $result = $this->callAPIAndDocument('report_template', 'getrows', array( 'report_id' => 'contact/summary', 'options' => array('metadata' => array('labels', 'title')), @@ -169,7 +169,7 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase { if (in_array($reportID, array('contribute/softcredit', 'contribute/bookkeeping'))) { $this->markTestIncomplete($reportID . " has non enotices when calling statistics fn"); } - $description = "Get Statistics from a report (note there isn't much data to get in the test DB :-("; + $description = "Get Statistics from a report (note there isn't much data to get in the test DB)."; $result = $this->callAPIAndDocument('report_template', 'getstatistics', array( 'report_id' => $reportID, ), __FUNCTION__, __FILE__, $description, 'Getstatistics', 'getstatistics'); diff --git a/tests/phpunit/api/v3/SettingTest.php b/tests/phpunit/api/v3/SettingTest.php index 7c671598e9..f619dfe9a6 100644 --- a/tests/phpunit/api/v3/SettingTest.php +++ b/tests/phpunit/api/v3/SettingTest.php @@ -213,7 +213,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { * Check getfields works. */ public function testCreateSetting() { - $description = "shows setting a variable for a given domain - if no domain is set current is assumed"; + $description = "Shows setting a variable for a given domain - if no domain is set current is assumed."; $params = array( 'domain_id' => $this->_domainID2, @@ -222,7 +222,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__); $params = array('uniq_email_per_site' => 1); - $description = "shows setting a variable for a current domain"; + $description = "Shows setting a variable for a current domain."; $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__, $description, 'CreateSettingCurrentDomain'); $this->assertArrayHasKey(CRM_Core_Config::domainID(), $result['values']); } @@ -293,7 +293,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { * Check getfields works. */ public function testCreateSettingMultipleDomains() { - $description = "shows setting a variable for all domains"; + $description = "Shows setting a variable for all domains."; $params = array( 'domain_id' => 'all', @@ -311,7 +311,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { 'return' => 'uniq_email_per_site', ); // we'll check it with a 'get' - $description = "shows getting a variable for all domains"; + $description = "Shows getting a variable for all domains."; $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__, $description, 'GetAllDomains', 'Get'); $this->assertEquals(1, $result['values'][2]['uniq_email_per_site']); @@ -322,7 +322,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { 'domain_id' => array(1, 3), 'uniq_email_per_site' => 0, ); - $description = "shows setting a variable for specified domains"; + $description = "Shows setting a variable for specified domains."; $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__, $description, 'CreateSpecifiedDomains'); $this->assertEquals(0, $result['values'][3]['uniq_email_per_site']); @@ -331,7 +331,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { 'domain_id' => array(1, 2), 'return' => array('uniq_email_per_site'), ); - $description = "shows getting a variable for specified domains"; + $description = "Shows getting a variable for specified domains."; $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__, $description, 'GetSpecifiedDomains', 'Get'); $this->assertEquals(1, $result['values'][2]['uniq_email_per_site']); $this->assertEquals(0, $result['values'][1]['uniq_email_per_site']); @@ -343,14 +343,14 @@ class api_v3_SettingTest extends CiviUnitTestCase { 'domain_id' => $this->_domainID2, 'return' => 'uniq_email_per_site', ); - $description = "shows get setting a variable for a given domain - if no domain is set current is assumed"; + $description = "Shows get setting a variable for a given domain - if no domain is set current is assumed."; $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__); $params = array( 'return' => 'uniq_email_per_site', ); - $description = "shows getting a variable for a current domain"; + $description = "Shows getting a variable for a current domain."; $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__, $description, 'GetSettingCurrentDomain'); $this->assertArrayHasKey(CRM_Core_Config::domainID(), $result['values']); } @@ -447,14 +447,14 @@ class api_v3_SettingTest extends CiviUnitTestCase { 'name' => 'petition_contacts', 'group' => 'Campaign Preferences', ); - $description = "Demonstrates getvalue action - intended for runtime use as better caching than get"; + $description = "Demonstrates getvalue action - intended for runtime use as better caching than get."; $result = $this->callAPIAndDocument('setting', 'getvalue', $params, __FUNCTION__, __FILE__, $description); $this->assertEquals('Petition Contacts', $result); } public function testGetDefaults() { - $description = "gets defaults setting a variable for a given domain - if no domain is set current is assumed"; + $description = "Gets defaults setting a variable for a given domain - if no domain is set current is assumed."; $params = array( 'name' => 'address_format', @@ -483,7 +483,7 @@ class api_v3_SettingTest extends CiviUnitTestCase { $result = $this->callAPISuccess('setting', 'get', $params); //make sure it's set $this->assertEquals('xyz', $result['values'][CRM_Core_Config::domainID()]['address_format']); - $description = "Demonstrates reverting a parameter to default value"; + $description = "Demonstrates reverting a parameter to default value."; $result = $this->callAPIAndDocument('setting', 'revert', $revertParams, __FUNCTION__, __FILE__, $description, '', 'revert'); //make sure it's reverted $result = $this->callAPISuccess('setting', 'get', $params); diff --git a/tests/phpunit/api/v3/SurveyTest.php b/tests/phpunit/api/v3/SurveyTest.php index 5235bd05d4..b1f03d19e6 100644 --- a/tests/phpunit/api/v3/SurveyTest.php +++ b/tests/phpunit/api/v3/SurveyTest.php @@ -110,7 +110,7 @@ class api_v3_SurveyTest extends CiviUnitTestCase { * test generated examples. (these are to be found in the api/examples folder). */ public function testGetSurveyChainDelete() { - $description = "demonstrates get + delete in the same call"; + $description = "Demonstrates get + delete in the same call."; $subfile = 'ChainedGetDelete'; $params = array( 'title' => "survey title", diff --git a/tests/phpunit/api/v3/TagTest.php b/tests/phpunit/api/v3/TagTest.php index 1f9e7b7ac6..07ab1bdbd1 100644 --- a/tests/phpunit/api/v3/TagTest.php +++ b/tests/phpunit/api/v3/TagTest.php @@ -82,7 +82,7 @@ class api_v3_TagTest extends CiviUnitTestCase { * Test civicrm_tag_get - success expected. */ public function testGetReturnArray() { - $description = "demonstrates use of Return as an array"; + $description = "Demonstrates use of Return as an array."; $subfile = "getReturnArray"; $params = array( @@ -183,14 +183,14 @@ class api_v3_TagTest extends CiviUnitTestCase { } public function testTagGetfields() { - $description = "demonstrate use of getfields to interrogate api"; + $description = "Demonstrate use of getfields to interrogate api."; $params = array('action' => 'create'); $result = $this->callAPIAndDocument('tag', 'getfields', $params, __FUNCTION__, __FILE__, $description, NULL, 'getfields'); $this->assertEquals('civicrm_contact', $result['values']['used_for']['api.default']); } public function testTagGetList() { - $description = "Demonstrates use of api.getlist for autocomplete and quicksearch applications"; + $description = "Demonstrates use of api.getlist for autocomplete and quicksearch applications."; $params = array( 'input' => $this->tag['name'], 'extra' => array('used_for'), diff --git a/tests/phpunit/api/v3/TaxContributionPageTest.php b/tests/phpunit/api/v3/TaxContributionPageTest.php index bb6bdd39a9..0bad900c37 100644 --- a/tests/phpunit/api/v3/TaxContributionPageTest.php +++ b/tests/phpunit/api/v3/TaxContributionPageTest.php @@ -296,7 +296,7 @@ class api_v3_TaxContributionPageTest extends CiviUnitTestCase { ), ); - $description = "Create Contribution with Nested Line Items"; + $description = "Create Contribution with Nested Line Items."; $subfile = "CreateWithNestedLineItems"; $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile); diff --git a/tests/templates/documentFunction.tpl b/tests/templates/documentFunction.tpl index 36740310e9..6e1ee0bb06 100644 --- a/tests/templates/documentFunction.tpl +++ b/tests/templates/documentFunction.tpl @@ -10,7 +10,9 @@ {/if} {/if} {if $description} - * {$description} +{foreach from=$description item='line'} + * {$line} +{/foreach} * {/if} * @return array -- 2.25.1