Documentation

api_v3_ContactTest extends CiviUnitTestCase
in package

CiviCRM

APIv3

API

Contact

uses CRMTraits_Custom_CustomDataTrait

Test APIv3 civicrm_contact* functions

Properties

$apiversion : int: API version to use for any api calls.
$hookClass : CRM_Utils_Hook_UnitTests: Class used for hooks during tests.
$setupIDs : array<string|int, mixed>: Array of IDs created during test setup routine.
$_apiversion : int: API version in use.
$_contactID : mixed
$_entity : mixed
$_financialTypeId : mixed
$_params : array<string|int, mixed>
$_tablesToTruncate : array<string|int, mixed>: Track tables we have modified during a test.
$entity : string: Entity to be extended.
$formController : CRM_Event_Controller_Registration: Form controller being used.
$ids : array<string|int, mixed>: Array of IDs created to support the test.
$isGetSafe : bool: Has the test class been verified as 'getsafe'.
$isLocationTypesOnPostAssert : bool: Should location types be checked to ensure primary addresses are correctly assigned after each test.
$isValidateFinancialsOnPostAssert : bool: Should financials be checked after the test but before tear down.
$origExtensionSystem : CRM_Extension_System
$originalSettings : array<string|int, mixed>
$tempDirs : array<string|int, mixed>
$errorHandlerAtStartOfTest : mixed
$form : FormWrapper
$frozenTime : CRM_Utils_AutoClean
$page : PageWrapper
$tx : CRM_Core_Transaction

Methods

__construct() : mixed: Constructor.
_checkFinancialRecords() : mixed
aclWhereNoBobH() : void: Full results returned.
activityCreate() : array<string|int, mixed>: Create Activity.
addDiscountPriceSet() : void: Add a discount price set to the given event.
assertAPIArrayComparison() : mixed: Check that api returned 'is_error' => 1 else provide full message
assertAPIDeleted() : mixed: Check that a deleted item has been deleted.
assertAPIFailure() : void: Check that api returned 'is_error' => 1.
assertAPISuccess() : mixed: Check that api returned 'is_error' => 0.
assertApproxEquals() : mixed: Assert that two numbers are approximately equal, give or take some $tolerance.
assertArrayKeyExists() : mixed
assertArrayValueNotNull() : mixed
assertArrayValuesEqual() : mixed: Assert the 2 arrays have the same values.
assertAttributesEquals() : mixed: Assert attributes are equal.
assertDBCompareValue() : mixed: Compare a single column value in a retrieved DB record to an expected value.
assertDBCompareValues() : mixed: Compare all values in a single retrieved DB record to an array of expected values.
assertDBNotNull() : null|string: Request a record from the DB by seachColumn+searchValue. Success if a record is found.
assertDBNull() : mixed: Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
assertDBQuery() : void: Assert that a SQL query returns a given value.
assertDBRowExist() : mixed: Request a record from the DB by id. Success if row not found.
assertDBRowNotExist() : mixed: Request a record from the DB by id. Success if row not found.
assertDBState() : void: Generic function to compare expected values after an api call to retrieved.
assertLocationValidity() : void: Validate that all location entities have exactly one primary.
assertTreeEquals() : mixed: Assert that two array-trees are exactly equal.
assertType() : mixed
batchCreate() : int: Create a sample batch.
buildEnvironment() : CiviEnvBuilder: Declare the environment that we wish to run in.
callAPIAndDocument() : array<string|int, mixed>|int
callAPIFailure() : array<string|int, mixed>|int: This function exists to wrap api functions.
callAPISuccess() : array<string|int, mixed>|int: wrap api functions.
callAPISuccessGetCount() : array<string|int, mixed>|int: This function exists to wrap api getValue function & check the result so we can ensure they succeed & throw exceptions without littering the test with checks There is a type check in this
callAPISuccessGetSingle() : array<string|int, mixed>|int: This function exists to wrap api getsingle function & check the result so we can ensure they succeed & throw exceptions without litterering the test with checks
callAPISuccessGetValue() : array<string|int, mixed>|int: This function wraps the getValue api and checks the result.
campaignCreate() : int
caseCreate() : void
checkArrayEquals() : void: Get formatted values in the actual and expected result.
civicrm_api() : array<string|int, mixed>|int: A stub for the API interface. This can be overriden by subclasses to change how the API is called.
CiviUnitTestCase_fatalErrorHandler() : mixed
cleanTempDirs() : mixed
contactDelete() : void: Delete contact, ensuring it is not the domain contact
contactMembershipCreate() : int: Create membership.
contributionCreate() : int: Create contribution.
contributionDelete() : array<string|int, mixed>|int: Delete contribution.
contributionPageCreate() : array<string|int, mixed>: Create contribution page.
createCase() : CRM_Case_BAO_Case: Create and return a case object for the given Client ID.
createCustomFieldsOfAllTypes() : array<string|int, mixed>
createCustomGroup() : int: Create a custom group.
createCustomGroupWithFieldOfType() : void: Create a custom group with a single field.
createCustomGroupWithFieldsOfAllTypes() : void: Create a custom group with fields of multiple types.
createDomainContacts() : void: Create default domain contacts for the two domains added during test class.
createExternalAPI() : ExternalBatch: Create a batch of external API calls which can be executed concurrently.
createLoggedInUser() : int: Emulate a logged in user since certain functions use that.
createMailing() : int: Helper function to create new mailing.
createPriceSetWithPage() : void: Create price set with contribution test for test setup.
createTempDir() : string: Generate a temporary folder.
customDirectories() : mixed: Helper to enable/disable custom directory support
customFieldCreate() : array<string|int, mixed>: Create custom field.
customFieldDelete() : array<string|int, mixed>|int: Delete custom field.
customFieldOptionValueCreate() : array<string|int, mixed>|int: Create custom field with Option Values.
customGroupCreate() : array<string|int, mixed>: Create custom group.
CustomGroupCreateByParams() : array<string|int, mixed>|int: Existing function doesn't allow params to be over-ridden so need a new one this one allows you to only pass in the params you want to change
customGroupDelete() : array<string|int, mixed>|int: Delete custom group.
CustomGroupMultipleCreateByParams() : array<string|int, mixed>|int: Create custom group with multi fields.
CustomGroupMultipleCreateWithFields() : array<string|int, mixed>: Create custom group with multi fields.
deleteMailing() : mixed: Helper function to delete mailing.
disableMultilingual() : void
dummyProcessorCreate() : CRM_Core_Payment_Dummy: Create Payment Processor.
enableCiviCampaign() : void: Enable CiviCampaign Component.
enableMultilingual() : void: Enable multilingual.
entityCustomGroupWithSingleFieldCreate() : array<string|int, mixed>: Create a custom group with a single text custom field. See participant:testCreateWithCustom for how to use this
entityCustomGroupWithSingleStringMultiSelectFieldCreate() : array<string|int, mixed>: Create a custom group with a single text custom field, multi-select widget, with a variety of option values including upper and lower case.
entityTagAdd() : true: Add entity(s) to the tag
eventCreate() : array<string|int, mixed>: Create an Event.
eventDelete() : array<string|int, mixed>|int: Delete event.
financialAccountDelete() : mixed
getAndCheck() : void
getBooleanDataProvider() : array<string|int, mixed>: Get the boolean options as a provider.
getCustomGroupTable() : string: Get the table_name for the specified custom group.
getFieldsValuesByType() : array<string|int, mixed>: Get default field values for the type of field.
getFinancialTypeID() : int: Return financial type id on basis of name
getFormObject() : CRM_Core_Form|CRM_Event_Form_Registration_Register: Instantiate form object.
getInternationalStrings() : array<string|int, mixed>: Get international string data for testing against api calls.
getLoggedInUser() : int|null: Get the logged in user record.
getPhoneStrings() : array<string|int, mixed>
getSearchFormObject() : CRM_Core_Form: Instantiate form object.
getSearchSortOptions() : array<string|int, mixed>
getTestForm() : FormWrapper
getTestPage() : PageWrapper
getThousandSeparators() : array<string|int, mixed>: Get possible thousand separators.
groupContactCreate() : int: Function to add a Group.
groupCreate() : int: Add a Group.
groupDelete() : mixed: Delete a Group.
householdCreate() : int: Generic function to create Household, to be used in test cases
individualCreate() : int: Generic function to create Individual, to be used in test cases
killTheJusticeLeague() : void: Implements hook_pre().
loadAllFixtures() : void: Read everything from the datasets directory and insert into the db.
locationAdd() : int: Add a Location.
locationTypeCreate() : int: Add a Location Type.
locationTypeDelete() : void: Delete a Location Type.
mappingCreate() : CRM_Core_DAO_Mapping: Add a Mapping.
mappingDelete() : void: Delete a Mapping
membershipDelete() : mixed
membershipRenewalDate() : mixed
membershipStatusCreate() : int
membershipStatusDelete() : void: Delete the given membership status, deleting any memberships of the status first.
membershipTypeCreate() : int
membershipTypeDelete() : mixed: Delete Membership Type.
offsetDefaultPriceSet() : mixed: Alter default price set so that the field numbers are not all 1 (hiding errors)
onPost() : mixed: An implementation of hook_civicrm_post used with all our test cases.
organizationCreate() : int: Generic function to create Organisation, to be used in test cases
participantCreate() : int: Create Participant.
participantDelete() : array<string|int, mixed>|int: Delete participant.
participantPaymentCreate() : int: Create participant payment.
participantPaymentDelete() : mixed: Delete participant payment.
paymentProcessorCreate() : int: Create an instance of the paypal processor.
paymentProcessorTypeCreate() : int
pledgeCreate() : int: Create pledge.
pledgeDelete() : void: Delete pledge.
processorCreate() : int: Create Payment Processor.
quickCleanup() : void: Quick clean by emptying tables created for the test.
quickCleanUpFinancialEntities() : void: Clean up financial entities after financial tests (so we remember to get all the tables :-))
relationshipTypeCreate() : int: Create a relationship type.
relationshipTypeDelete() : mixed: Delete Relatinship Type.
restoreDefaultPriceSetConfig() : void: Reset the price set config so results exist.
restoreMembershipTypes() : void: Recreate default membership types.
retrieveEntityFinancialTrxn() : array<string|int, mixed>: Retrieve entity financial trxn details.
runApi4Legacy() : array<string|int, mixed>|int: Emulate v3 syntax so we can run api3 tests on v4
sampleContact() : array<string|int, mixed>: Helper function for getting sample contact properties.
selectWhereClauseHook() : void
setExtensionSystem() : mixed: Temporarily replace the singleton extension with a different one.
setMockSettingsMetaData() : void: Temporarily alter the settings-metadata to add a mock setting.
setUp() : void: Test setup for every test.
setupACL() : void: Set up an acl allowing contact to see 2 specified groups - $this->_permissionedGroup & $this->_permissionedDisabledGroup
setUpBeforeClass() : void
setupForSmsTests() : mixed: Setup or clean up SMS tests
setupMembershipRecurringPaymentProcessorTransaction() : void: We don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it
setupRecurringPaymentProcessorTransaction() : void: Set up initial recurring payment allowing subsequent IPN payments.
smartGroupCreate() : int: Create a smart group.
tagCreate() : array<string|int, mixed>: Create Tag.
tagDelete() : int: Delete Tag.
tearDown() : void: Restore the DB for the next test.
testAddCreateIndividual() : void: Test civicrm_contact_create.
testAddCreateIndividualWithPreferredLanguage() : void: Test civicrm_contact_create.
testChainingValuesCreate() : void: Test checks usage of $values to pick & choose inputs.
testContactCreateCurrentEmployer() : void: Test creating a current employer through API.
testContactCreateDuplicateCurrentEmployerEnables() : void: Test creating a current employer through API.
testContactCreateFormatIsSuccessFalse() : void: Test TrueFalse format.
testContactCreateLongDisplayName() : void: Test long display names.
testContactCreationPermissions() : void: Test that permissions are respected when creating contacts.
testContactDelete() : void: Test civicrm_contact_delete().
testContactDeleteError() : void: Test civicrm_contact_delete() with error.
testContactDeleteNoID() : void: Test civicrm_contact_delete() with no contact ID.
testContactDeletePermissions() : void: Test that delete with skip undelete respects permissions.
testContactGetBirthDate() : void: Test birth date parameters.
testContactGetByUnknownUsername() : void: Test for Contact.get id=@user:username (with an invalid username).
testContactGetByUsername() : void: Test for Contact.get id=@user:username.
testContactGetDeceasedDate() : void: Test Deceased date parameters.
testContactGetEmail() : void: Test civicrm_contact_search_count().
testContactGetEmptyParams() : void: Test civicrm_contact_get) with empty params.
testContactGetFormatCountOnly() : void: Test Single Entity format.
testContactGetFormatIDOnly() : void: Test id only format.
testContactGetFormatIsSuccessTrue() : void: Test TrueFalse format - I couldn't come up with an easy way to get an error on Get.
testContactGetFormatSingleValue() : void: Test id only format.
testContactGetFromGroup() : void: API test to retrieve contact from group having different group title and name.
testContactGetOldParamsNoMatches() : void: Test civicrm_contact_get(,true) with no matches.
testContactGetOldParamsOneMatch() : void: Test civicrm_contact_get(,true) with one match.
testContactGetProximity() : void: Test the prox_distance functionality works.
testContactGetRetDefault() : void: Test civicrm_contact_get() with default return properties.
testContactGetRetFirst() : void: Test civicrm_contact_get() return only first name.
testContactGetReturnFirstLast() : void: Test civicrm_contact_get() return only first name & last name.
testContactGetReturnFirstLastNoComma() : void: Test civicrm_contact_get() return only first name & last name.
testContactGetReturnGroup() : void: Ensure format with return=group shows comma-separated group IDs.
testContactGetReturnValues() : void: Test to check return works OK.
testContactGetSingleEntityArray() : void: Test Single Entity format.
testContactGetSpaceMatches() : void: Test civicrm_contact_get(,true) with space in sort_name.
testContactGetUnique() : void: Test getunique api call for Contact entity
testContactGetWithAddressFields() : void: Test Address parameters
testContactGetWithGroupTitle() : void: CRM-20144 Verify that passing title of group works as well as id Tests the following formats contact.get group='title1' contact.get group=id1
testContactGetWithGroupTitleMultipleGroups() : void: CRM-20144 Verify that passing title of group works as well as id Tests the following formats contact.get group=array('title1', title1) contact.get group=array('IN' => array('title1', 'title2)
testContactGetWithGroupTitleMultipleGroupsLegacyFormat() : void: CRM-20144 Verify that passing title of group works as well as id Tests the following formats contact.get group=array('title1' => 1) contact.get group=array('title1' => 1, 'title2' => 1) contact.get group=array('id1' => 1) contact.get group=array('id1' => 1, id2 => 1)
testContactGetWithTag() : void: Verify that passing tag IDs to Contact.get works
testContactGreetingsCreate() : void: Test that creating a contact with various contact greetings works.
testContactGreetingsCreateWithCustomField() : void: Test that creating a contact with various contact greetings works.
testContactProximity() : void: Test contact proximity api.
testContactUpdatePermissions() : void: Test update with check permissions set.
testCreateAlterSortName() : void: Test that we can set the sort name via the api or alter it via a hook.
testCreateApiKey() : void: Check that permissions on API key are restricted (CRM-18112).
testCreateBadRequiredFieldsHousehold() : void: Verify that attempt to create household contact without required fields fails.
testCreateBadRequiredFieldsIndividual() : void: Verify that attempt to create individual contact without required fields fails.
testCreateBadRequiredFieldsOrganization() : void: Test required field check.
testCreateBadTypeContact() : void: Verify that attempt to create contact with bad contact type fails.
testCreateCommunicationStylePassed() : void: CRM-21041 Test if 'communication style' is set if value is passed.
testCreateCommunicationStyleUnset() : void: CRM-21041 Test if 'communication style' is set to site default if not passed.
testCreateContactCustomFldDateTime() : void: CRM-15792 - create/update datetime field for contact.
testCreateDisplayNameIndividual() : void: Test creating individual by display_name.
testCreateEmailIndividual() : void: Verify that attempt to create individual contact with only an email succeeds.
testCreateEmptyContact() : void: Verify that attempt to create contact with empty params fails.
testCreateHouseholdDetails() : void: Verify that attempt to create household contact with details succeeds.
testCreateHouseholdInadequateDetails() : void: Verify that attempt to create household contact with inadequate details fails.
testCreateIndividualNoCacheClear() : void: Test that it is possible to prevent cache clearing via option.
testCreateIndividualWithChainedArrayAndSequential() : void: Verify attempt to create individual with chained arrays and sequential.
testCreateIndividualWithContributionChainedArrays() : void: Verify that attempt to create individual contact with chained contribution and website succeeds.
testCreateIndividualWithContributionDottedSyntax() : void: Verify that attempt to create individual contact with two chained websites succeeds.
testCreateIndividualWithEmployer() : void: Verify that when changing employers the old employer relationship becomes inactive.
testCreateIndividualWithJustEmail() : void: Verify that attempt to create individual contact just email succeeds.
testCreateIndividualWithJustEmailViaChain() : void: Verify that updating a contact email updates their display name.
testCreateIndividualWithNameEmail() : void: Verify that attempt to create individual contact with first, and last names and email succeeds.
testCreateIndividualWithNameEmailLocationType() : void: Test create individual contact with first &last names, email and location type succeeds.
testCreateIndividualWithOutNameEmail() : void: Verify that attempt to create individual contact with no data fails.
testCreateNameHousehold() : void: Test household name is sufficient for create.
testCreateNameIndividual() : void: Test creating individual by name.
testCreateNameIndividualOldKeys() : void: Test old keys still work.
testCreateNameIndividualRecommendedKeys2() : void: Test preferred keys work.
testCreateNameOrganization() : void: Test organization name is sufficient for create.
testCreateNoNameOrganization() : void: Verify that attempt to create organization contact without organization name fails.
testCreateNoteInCreate() : void: Test creating a note from the contact.create API call when only passing the note as a string.
testCreateNoteInCreateArrayFormat() : void: Test Creating a note from the contact.create api call when passing the note params as an array.
testCreatePreferredLanguageNull() : void: CRM-14232 test preferred language returns setting if not passed where setting is NULL.
testCreatePreferredLanguagePassed() : void: CRM-14232 test preferred language returns setting if not passed where setting is NULL.
testCreatePreferredLanguageSet() : void: CRM-14232 test preferred language returns setting if not passed.
testCreatePreferredLanguageUnset() : void: CRM-14232 test preferred language set to site default if not passed.
testCreateWithCustom() : void: Check with complete array + custom field.
testCreateWithEmptyCustomCheckbox() : void: Test create contact with custom checkbox with empty array
testCreateWithNULLCustomCRM12773() : void: CRM-12773 - expectation is that civicrm quietly ignores fields without values.
testCRM13252MultipleChainedPhones() : void: Test creating multiple phones using chaining.
testDirectionChainingRelationshipsCRM16084() : void: Test for direction when chaining relationships.
testDuplicateCheck() : void: Test the duplicate check function.
testDuplicateCheckRuleNotReserved() : void: Test the duplicate check function.
testEmojiInWhereClause() : void: Test a lack of fatal errors when the where contains an emoji.
testGetActions() : void: Test contact getactions.
testGetApostropheCRM10857() : void: Test apostrophe works in get & create.
testGetBetweenZeroWorks() : void: Test between accepts zero.
testGetByAddresseeID() : void: Test retrieval by addressee id.
testGetByContactType() : void: Test variants on retrieving contact by type.
testGetConflictsAggressiveMode() : void
testGetContactsByPrivacyFlag() : void: CRM-14743 - test api respects search operators.
testGetCreatedDateByOperators() : void: CRM-14743 - test api respects search operators.
testGetDeceasedRetrieved() : void: Check deceased contacts are not retrieved.
testGetDeleted() : void: Test variants on deleted behaviour.
testGetEmailLike() : void: Test the like operator works for Contact.get
testGetEscapedCustomField() : void: Test fetching custom field value that needs to be escaped.
testGetGroupIDFromContact() : void: Test group filter syntax.
testGetIndividualWithChainedArrays() : void: Verify attempt to create individual with chained arrays.
testGetIndividualWithChainedArraysAndMultipleCustom() : void: Test complex chaining.
testGetIndividualWithChainedArraysAndSequential() : void: Verify attempt to create individual with chained arrays and sequential.
testGetIndividualWithChainedArraysFormats() : void: Test retrieving an individual with chained array syntax.
testGetINIDArray() : void: Test that we can retrieve contacts using array syntax.
testGetlistExcludeConditions() : void: CRM-15443 - ensure getlist api does not return deleted contacts.
testGetlistInvalidID() : void: Test getlist gets an organization with a number that is not a valid organization ID.
testGetMatchesPhoneWithType() : void: Test that duplicates can be found even when phone type is specified.
testGetModifiedDateByOperators() : void: CRM-14743 - test api respects search operators.
testGetMultipleContactSubTypes() : void: Verify that we can retrieve contacts of different sub types
testGetNameVariantsCaseInsensitive() : void: Test that name searches are case insensitive.
testGetOptions() : void
testGetReferenceCounts() : void: Test get ref api - gets a list of references to an entity.
testGetReturnAddress() : void: Check that address name, ID is returned if required.
testGetSort() : void: Test that sort works - old syntax.
testGetSortNewSyntax() : void: Test that sort works - new syntax.
testGetWithCustom() : void: Check with complete array + custom field.
testGetWithCustomOfActivityType() : void: Tests that using 'return' with a custom field not of type contact does not inappropriately filter.
testGetWithCustomReturnSyntax() : void: Check with complete array + custom field.
testGreetingParseSmarty() : void: Test that smarty variables are parsed if they exist in the greeting template.
testGreetingUpdates() : void: Test the greeting fields update sensibly.
testIndividualSubType() : void: Test civicrm_contact_create with sub-types.
testInternationalStrings() : void: Test for international string acceptance (CRM-10210).
testLoggedInUserAPISupportToken() : void
testMerge() : void: Test merging 2 contacts.
testMergeBizarreOldParams() : void: Test merging 2 contacts.
testMergeContactReferenceCustomFieldTarget() : void: Test merging a contact that is the target of a contact reference field on another contact.
testMergeCustomFields() : void: Test merging 2 contacts with custom fields.
testMergedGet() : void: Test retrieving merged contacts.
testMergedGetWithPermanentlyDeletedContact() : void: Test retrieving merged contacts.
testMergeGetConflicts() : void: Test the function that determines if 2 contacts have conflicts.
testMergeMultiContactReferenceCustomFieldTarget() : void: Test merging a contact that is the target of a contact reference field on another contact.
testMergeMultipleCustomValues() : void: Test merging when a multiple record set is in use.
testMergeNoTrash() : void: Test merging 2 contacts with delete to trash off.
testMergeOrganizations() : void: Test merging 2 organizations.
testMergeWithBlankLocationData() : void: Test that a blank location does not overwrite a location with data.
testPseudoFields() : void: Ensure consistent return format for option group fields.
testReturnCityProfile() : void: CRM-14263 check that API is not affected by search profile related bug.
testSetPreferredCommunicationNull() : void: Ensure consistent return format for option group fields.
testSmartGroupsForRelatedContacts() : void: Test the related contacts filter.
testSortLimitChainedRelationshipGetCRM15983() : void: Test sort and limit for chained relationship get.
testSQLOperatorsOnContactAPI() : void: Test the use of sql operators.
testUpdateCreateWithID() : void: Test civicrm_update() without contact type.
testUpdateHouseholdWithAll() : void: Verify successful update of household contact.
testUpdateIndividualWithAll() : void: Verify successful update of individual contact.
testUpdateOrganizationWithAll() : void: Verify successful update of organization contact.
uFFieldCreate() : mixed: Create a UFField.
ufjoinCreate() : int: Add a UF Join Entry.
unsetExtensionSystem() : mixed
useMultilingual() : CRM_Utils_AutoClean: Temporarily use multilingual.
useTransaction() : mixed: Wrap the entire test case in a transaction.
versionAndPrivacyOption() : array<string|int, mixed>: Combinations of versions and privacy choices.
versionThreeAndFour() : array<string|int, mixed>: Get the api versions to test.
addLocationBlockToDomain() : void: Add an address block to the current domain.
addOptionToCustomField() : int: Add another option to the custom field.
addProfile() : mixed: Add a profile to a contribution page.
addTaxAccountToFinancialType() : CRM_Financial_DAO_EntityFinancialAccount: Add Sales Tax Account for the financial type.
assertAttachmentExistence() : void: Assert the attachment exists.
assertLike() : void: Assert 2 sql strings are the same, ignoring double spaces.
assertMailSentContainingHeaderString() : void: Assert that the sent mail included the supplied string.
assertMailSentContainingHeaderStrings() : void: Assert that the sent mail included the supplied strings.
assertMailSentContainingString() : void: Assert that the sent mail included the supplied string.
assertMailSentContainingStrings() : void: Assert that the sent mail included the supplied strings.
assertMailSentCount() : void: Assert the right number of mails were sent.
assertMailSentNotContainingString() : void: Assert that the sent mail included the supplied string.
assertMailSentNotContainingStrings() : void: Assert that the sent mail included the supplied strings.
assertMailSentTo() : void: Assert that the sent mail included the supplied strings.
assertOutputNotContainsString() : void: Assert that the status set does not contain the given string.
assertPostConditions() : void: CHeck that all tests that have created payments have created them with the right financial entities.
assertPrematureExit() : void
assertTemplateVariable() : void
assertValidationError() : void: Assert that the sent mail included the supplied string.
basicCreateTest() : void: Generic create test.
basicDeleteTest() : void: Generic delete test.
captureOutputToCSV() : Reader: Stop capturing browser output and return as a csv.
cleanUpAfterACLs() : mixed: Reset after ACLs.
cleanupCustomGroups() : void: Delete any existing custom data groups.
cleanUpSetUpIDs() : mixed: Cleanup function for contents of $this->ids.
createAutoCompleteCustomField() : array<string|int, mixed>: Create custom select field.
createBooleanCustomField() : array<string|int, mixed>: Create a custom text fields.
createContactReferenceCustomField() : array<string|int, mixed>: Create a custom text fields.
createCountryCustomField() : array<string|int, mixed>: Create a custom country fields.
createDateCustomField() : array<string|int, mixed>: Create a custom field of type date.
createDeeplyConflictedContacts() : array<string|int, mixed>: Create pair of contacts with multiple conflicts.
createFileCustomField() : array<string|int, mixed>: Create a custom text fields.
createFinancialType() : array<string|int, mixed>: Create Financial Type.
createIntCustomField() : array<string|int, mixed>: Create a custom text fields.
createIntegerRadioCustomField() : array<string|int, mixed>: Create a custom field of type radio with integer values.
createLinkCustomField() : array<string|int, mixed>: Create a custom text fields.
createMoneyTextCustomField() : array<string|int, mixed>: Create a custom field of type money.
createMultiCountryCustomField() : array<string|int, mixed>: Create a custom multi select country fields.
createMultiStateCustomField() : array<string|int, mixed>: Create a custom multi select state fields.
createPartiallyPaidParticipantOrder() : array<string|int, mixed>: Add participant with contribution
createPriceSet() : array<string|int, mixed>: Create price set that includes one price field with two option values.
createRuleGroup() : array<string|int, mixed>|int
createSelectCustomField() : array<string|int, mixed>: Create custom select field.
createStateCustomField() : array<string|int, mixed>: Create a custom state fields.
createStringCheckboxCustomField() : array<string|int, mixed>: Create a custom field of type radio with integer values.
createTextCustomField() : array<string|int, mixed>: Create a custom text fields.
deleteNonDefaultRelationshipTypes() : void: Delete any extraneous relationship types.
disableTaxAndInvoicing() : void: Enable Tax and Invoicing
disorganizeOptionValues() : void: Disorganize our option values to ensure we are not relying on luck.
doMerge() : array<string|int, mixed>|int: Do the merge on the 2 contacts.
enableTaxAndInvoicing() : void: Enable Tax and Invoicing
ensureMembershipPriceSetExists() : void: Ensure the default price set & field exist for memberships.
ensureMySQLMode() : void: Ensure the specified mysql mode/s are activated.
eventCreatePaid() : array<string|int, mixed>: Create a paid event.
eventCreateUnpaid() : array<string|int, mixed>: Create an unpaid event.
eventPriceSetCreate() : int: Create a price set for an event.
flushFinancialTypeStatics() : void: Flush statics relating to financial type.
formatMoneyInput() : string: Format money as it would be input.
getAvailableFieldCombinations() : array<string|int, mixed>: Get data available for custom fields.
getContributionObject() : CRM_Contribute_BAO_Contribution: Get the contribution object.
getCustomFieldColumnName() : string: Get the the column name for the identified custom field.
getCustomFieldID() : string: Get the custom field name for the relevant key.
getCustomFieldName() : string: Get the custom field name for the relevant key.
getDefaultSystemLocale() : string: Get the default system locale.
getDeprecatedProperty() : mixed: Retrieve a deprecated property, ensuring a deprecation notice is thrown.
getEntity() : string: Get the entity being acted on.
getEvent() : array<string|int, mixed>: This retrieves the values used to create the event.
getEventExampleData() : array<string|int, mixed>: Get example data with which to create the event.
getEventID() : int: Get the event id of the event created in set up.
getEventValue() : mixed|null: Get a value from an event used in setup.
getExampleData() : array<string|int, mixed>: Get example data.
getOptionGroupID() : string: Get the option group id of the created field.
getOptionGroupName() : string: Get the option group id of the created field.
getParticipantOrderParams() : array<string|int, mixed>: Get parameters to set up a multi-line participant order.
getPriceFieldOptions() : array<string|int, array<string|int, mixed>>: Get the options for the price set.
getRenderedFormContents() : false|string: Get the rendered contents from a form.
getTablesWithData() : array<string|int, mixed>: Get an array of tables with rows - useful for diagnosing cleanup issues.
loadXMLDataSet() : mixed: Load the data that used to be handled by the discontinued dbunit class.
organizeOptionValues() : void: This undoes the `disorganizeOptionValues` function.
prepareForACLs() : void: Prepare class for ACLs.
putGroupContactCacheInClearableState() : void
renameLabels() : mixed: Rename various labels to not match the names.
resetHooks() : void: Reset any registered hooks.
resetLabels() : mixed: Undo any label renaming.
revertSetting() : void
revertTemplateToReservedTemplate() : void: Reinstate the default template.
runApi4LegacyChain() : array<string|int, mixed>
runTest() : mixed: Override to run the test and assert its state.
setCurrencySeparators() : void: Set the separators for thousands and decimal points.
setDefaultCurrency() : void: Sets the default currency.
setMonetaryDecimalPoint() : void: Sets the decimal separator.
setMonetaryThousandSeparator() : void: Sets the thousand separator.
setPermissions() : void: Set the permissions to the supplied array.
startCapturingOutput() : mixed: Start capturing browser output.
swapMessageTemplateForInput() : void: Replace the template with a test-oriented template designed to show all the variables.
swapMessageTemplateForTestTemplate() : void: Replace the template with a test-oriented template designed to show all the variables.
updateEvent() : void: Update an event.
useFrozenTime() : void: Temporarily freeze time, as perceived through `CRM_Utils_Time`.
validateAllContributions() : void: Validate all created contributions.
validateAllPayments() : void: Validate all created payments.
validateContactField() : void
validatePayments() : void
_contactCreate() : int: Private helper function for calling civicrm_contact_add.
addProfilesToEvent() : void: Add profiles to the event.
createEmployerOfMembership() : array<string|int, mixed>: Create inherited membership type for employer relationship.
createEventProfile() : void: Create a profile attached to an event.
eventCreatePriceSet() : void: Create a price set for an event.
unsetID() : void: Unset the key 'id' from the array

$apiversion

API version to use for any api calls.


    public
        int
    $apiversion
     = 4

$hookClass

Class used for hooks during tests.


    public
        CRM_Utils_Hook_UnitTests
    $hookClass

This can be used to test hooks within tests. For example in the ACL_PermissionTrait:

$this->hookClass->setHook('civicrm_aclWhereClause', [$this, 'aclWhereHookAllResults']);

$setupIDs

Array of IDs created during test setup routine.


    public
        array<string|int, mixed>
    $setupIDs
     = []

The cleanUpSetUpIds method can be used to clear these at the end of the test.

$_apiversion

API version in use.


    protected
        int
    $_apiversion
     = 3

$_contactID


    protected
        mixed
    $_contactID

$_entity


    protected
        mixed
    $_entity

$_financialTypeId


    protected
        mixed
    $_financialTypeId
     = 1

$_params


    protected
        array<string|int, mixed>
    $_params

Common values to be re-used multiple times within a class - usually to create the relevant entity

$_tablesToTruncate

Track tables we have modified during a test.


    protected
        array<string|int, mixed>
    $_tablesToTruncate
     = []

$entity

Entity to be extended.


    protected
        string
    $entity
     = 'Contact'

$formController

Form controller being used.


    protected
        CRM_Event_Controller_Registration
    $formController

We need to re-use this for multi-part forms.

$ids

Array of IDs created to support the test.


    protected
        array<string|int, mixed>
    $ids
     = []

e.g $this->ids = ['Contact' => ['descriptive_key' => $contactID], 'Group' => [$groupID]];

$isGetSafe

Has the test class been verified as 'getsafe'.


    protected
        bool
    $isGetSafe
     = \FALSE

If a class is getsafe it means that where callApiSuccess is called 'return' is specified or 'return' =>'id' can be added by that function. This is part of getting away from open-ended get calls.

Eventually we want to not be doing these in our test classes & start to work to not do them in our main code base. Note they mainly cause issues for activity.get and contact.get as these are where the too many joins limit is most likely to be hit.

$isLocationTypesOnPostAssert

Should location types be checked to ensure primary addresses are correctly assigned after each test.


    protected
        bool
    $isLocationTypesOnPostAssert
     = \TRUE

$isValidateFinancialsOnPostAssert

Should financials be checked after the test but before tear down.


    protected
        bool
    $isValidateFinancialsOnPostAssert
     = \TRUE

Ideally all tests (or at least all that call any financial api calls ) should do this but there are some test data issues and some real bugs currently blocking.

$origExtensionSystem


    protected
        CRM_Extension_System
    $origExtensionSystem

$originalSettings


    protected
        array<string|int, mixed>
    $originalSettings
     = []

$tempDirs


    protected
        array<string|int, mixed>
    $tempDirs
     = []

Array of temporary directory names

$errorHandlerAtStartOfTest


    private
        mixed
    $errorHandlerAtStartOfTest

$form


    private
        FormWrapper
    $form

$frozenTime


    private
        CRM_Utils_AutoClean
    $frozenTime

$page


    private
        PageWrapper
    $page

$tx


    private
        CRM_Core_Transaction
    $tx

__construct()

Constructor.


    public
                    __construct([string $name = NULL ][, array<string|int, mixed> $data = [] ][, string $dataName = '' ]) : mixed

Because we are overriding the parent class constructor, we need to show the same arguments as exist in the constructor of PHPUnit_Framework_TestCase, since PHPUnit_Framework_TestSuite::createTest() creates a ReflectionClass of the Test class and checks the constructor of that class to decide how to set up the test.

Parameters

$name : string = NULL
$data : array<string|int, mixed> = []
$dataName : string = ''

_checkFinancialRecords()


    public
                    _checkFinancialRecords(array<string|int, mixed> $params, mixed $context) : mixed

Parameters

$params : array<string|int, mixed>
$context : mixed

aclWhereNoBobH()

Full results returned.


    public
                    aclWhereNoBobH(string $type, array<string|int, mixed> &$tables, array<string|int, mixed> &$whereTables, int &$contactID, string|null &$where) : void

Parameters

$type : string
$tables : array<string|int, mixed>
$whereTables : array<string|int, mixed>
$contactID : int
$where : string|null

activityCreate()

Create Activity.


    public
                    activityCreate([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>

addDiscountPriceSet()

Add a discount price set to the given event.


    public
                    addDiscountPriceSet([string $eventIdentifier = 'PaidEvent' ][, array<string|int, mixed> $discountParameters = [] ][, array<string|int, mixed> $priceSetParameters = [] ][, string $identifier = 'discount' ][, float $fraction = 0.5 ]) : void

Parameters

$eventIdentifier : string = 'PaidEvent'
$discountParameters : array<string|int, mixed> = []
$priceSetParameters : array<string|int, mixed> = []
$identifier : string = 'discount'
$fraction : float = 0.5

assertAPIArrayComparison()

Check that api returned 'is_error' => 1 else provide full message


    public
                    assertAPIArrayComparison(array<string|int, mixed> $result, mixed $expected[, array<string|int, mixed> $valuesToExclude = [] ][, string $prefix = '' ]) : mixed

Parameters

$result : array<string|int, mixed>
$expected : mixed
$valuesToExclude : array<string|int, mixed> = []
$prefix : string = '': Extra test to add to message.

assertAPIDeleted()

Check that a deleted item has been deleted.


    public
                    assertAPIDeleted(mixed $entity, mixed $id) : mixed

Parameters

$entity : mixed
$id : mixed

assertAPIFailure()

Check that api returned 'is_error' => 1.


    public
                    assertAPIFailure(array<string|int, mixed> $apiResult[, string $prefix = '' ][, string|null $expectedError = NULL ]) : void

Parameters

$apiResult : array<string|int, mixed>: Api result.
$prefix : string = '': Extra test to add to message.
$expectedError : string|null = NULL

assertAPISuccess()

Check that api returned 'is_error' => 0.


    public
                    assertAPISuccess(array<string|int, mixed> $apiResult[, string $prefix = '' ]) : mixed

Parameters

$apiResult : array<string|int, mixed>: Api result.
$prefix : string = '': Extra test to add to message.

assertApproxEquals()

Assert that two numbers are approximately equal, give or take some $tolerance.


    public
                    assertApproxEquals(int|float $expected, int|float $actual, int|float $tolerance[, string $message = NULL ]) : mixed

Parameters

$expected : int|float
$actual : int|float
$tolerance : int|float: Any differences <$tolerance are considered irrelevant. Differences >=$tolerance are considered relevant.
$message : string = NULL

assertArrayKeyExists()


    public
                    assertArrayKeyExists(string|int $key, array<string|int, mixed> &$list) : mixed

Parameters

$key : string|int
$list : array<string|int, mixed>

assertArrayValueNotNull()


    public
                    assertArrayValueNotNull(string|int $key, array<string|int, mixed> &$list) : mixed

Parameters

$key : string|int
$list : array<string|int, mixed>

assertArrayValuesEqual()

Assert the 2 arrays have the same values.


    public
                    assertArrayValuesEqual(array<string|int, mixed> $array1, array<string|int, mixed> $array2) : mixed

The order of arrays, and keys of the arrays, do not affect the outcome.

Parameters

$array1 : array<string|int, mixed>
$array2 : array<string|int, mixed>

assertAttributesEquals()

Assert attributes are equal.


    public
                    assertAttributesEquals(array<string|int, mixed> $expectedValues, array<string|int, mixed> $actualValues[, string $message = NULL ]) : mixed

Parameters

$expectedValues : array<string|int, mixed>
$actualValues : array<string|int, mixed>
$message : string = NULL

assertDBCompareValue()

Compare a single column value in a retrieved DB record to an expected value.


    public
                    assertDBCompareValue(string $daoName, mixed $searchValue, mixed $returnColumn, mixed $searchColumn, mixed $expectedValue, mixed $message) : mixed

Parameters

$daoName : string
$searchValue : mixed
$returnColumn : mixed
$searchColumn : mixed
$expectedValue : mixed
$message : mixed

assertDBCompareValues()

Compare all values in a single retrieved DB record to an array of expected values.


    public
                    assertDBCompareValues(string $daoName, array<string|int, mixed> $searchParams, mixed $expectedValues) : mixed

Parameters

$daoName : string
$searchParams : array<string|int, mixed>
$expectedValues : mixed

assertDBNotNull()

Request a record from the DB by seachColumn+searchValue. Success if a record is found.


    public
                    assertDBNotNull(string $daoName, mixed $searchValue, mixed $returnColumn, mixed $searchColumn, mixed $message) : null|string

Parameters

$daoName : string
$searchValue : mixed
$returnColumn : mixed
$searchColumn : mixed
$message : mixed

Return values

null|string

assertDBNull()

Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.


    public
                    assertDBNull(string $daoName, mixed $searchValue, mixed $returnColumn, mixed $searchColumn, mixed $message) : mixed

Parameters

$daoName : string
$searchValue : mixed
$returnColumn : mixed
$searchColumn : mixed
$message : mixed

assertDBQuery()

Assert that a SQL query returns a given value.


    public
                    assertDBQuery(string|null|int $expected, string $query[, array<string|int, mixed> $params = [] ][, string $message = '' ]) : void

The first argument is an expected value. The remaining arguments are passed to CRM_Core_DAO::singleValueQuery

Example: $this->assertSql(2, 'select count(*) from foo where foo.bar like "%1"', array(1 => array("Whiz", "String")));

Parameters

$expected : string|null|int
$query : string
$params : array<string|int, mixed> = []
$message : string = ''

assertDBRowExist()

Request a record from the DB by id. Success if row not found.


    public
                    assertDBRowExist(string $daoName, int $id[, null $message = NULL ]) : mixed

Parameters

$daoName : string
$id : int
$message : null = NULL

assertDBRowNotExist()

Request a record from the DB by id. Success if row not found.


    public
                    assertDBRowNotExist(string $daoName, int $id[, null $message = NULL ]) : mixed

Parameters

$daoName : string
$id : int
$message : null = NULL

assertDBState()

Generic function to compare expected values after an api call to retrieved.


    public
                    assertDBState(mixed $daoName, mixed $id, mixed $match[, bool $delete = FALSE ]) : void

DB values.

Parameters

$daoName : mixed
$id : mixed
$match : mixed
$delete : bool = FALSE

assertLocationValidity()

Validate that all location entities have exactly one primary.


    public
                    assertLocationValidity() : void

This query takes about 2 minutes on a DB with 10s of millions of contacts.

assertTreeEquals()

Assert that two array-trees are exactly equal.


    public
                    assertTreeEquals(array<string|int, mixed> $expected, array<string|int, mixed> $actual) : mixed

The ordering of keys do not affect the outcome (within either the roots or in any child elements).

Error messages will reveal a readable -path-, regardless of how many levels of nesting are present.

Parameters

$expected : array<string|int, mixed>
$actual : array<string|int, mixed>

assertType()


    public
                    assertType(string $expected, mixed $actual[, string $message = '' ]) : mixed

Parameters

$expected : string: Ex: 'array', 'object', 'int'
$actual : mixed: The variable/item to check.
$message : string = ''

batchCreate()

Create a sample batch.


    public
                    batchCreate() : int

Return values

int

buildEnvironment()

Declare the environment that we wish to run in.


    public
        final    static        buildEnvironment() : CiviEnvBuilder

TODO: The hope is to get this to align with Civi\Test::headless() and perhaps assimilate other steps from 'setUp()'. The method is reserved while we look for the right split. However, when we're a little further along on that, this should be made overrideable.

Return values

CiviEnvBuilder

callAPIAndDocument()


    public
                    callAPIAndDocument(string $entity, string $action, array<string|int, mixed> $params) : array<string|int, mixed>|int

Parameters

$entity : string
$action : string
$params : array<string|int, mixed>

Return values

array<string|int, mixed>|int

callAPIFailure()

This function exists to wrap api functions.


    public
                    callAPIFailure(string $entity, string $action[, array<string|int, mixed> $params = [] ][, string $expectedErrorMessage = NULL ][, null $extraOutput = NULL ]) : array<string|int, mixed>|int

so we can ensure they fail where expected & throw exceptions without litterering the test with checks

Parameters

$entity : string
$action : string
$params : array<string|int, mixed> = []
$expectedErrorMessage : string = NULL: Error.
$extraOutput : null = NULL

Return values

array<string|int, mixed>|int

callAPISuccess()

wrap api functions.


    public
                    callAPISuccess(string $entity, string $action[, array<string|int, mixed> $params = [] ][, mixed $checkAgainst = NULL ]) : array<string|int, mixed>|int

so we can ensure they succeed & throw exceptions without litterering the test with checks

Parameters

$entity : string
$action : string
$params : array<string|int, mixed> = []
$checkAgainst : mixed = NULL: Optional value to check result against, implemented for getvalue,. getcount, getsingle. Note that for getvalue the type is checked rather than the value for getsingle the array is compared against an array passed in - the id is not compared (for better or worse )

Return values

array<string|int, mixed>|int

callAPISuccessGetCount()

This function exists to wrap api getValue function & check the result so we can ensure they succeed & throw exceptions without littering the test with checks There is a type check in this


    public
                    callAPISuccessGetCount(string $entity, array<string|int, mixed> $params[, int $count = NULL ]) : array<string|int, mixed>|int

Parameters

$entity : string
$params : array<string|int, mixed>
$count : int = NULL

Return values

array<string|int, mixed>|int

callAPISuccessGetSingle()

This function exists to wrap api getsingle function & check the result so we can ensure they succeed & throw exceptions without litterering the test with checks


    public
                    callAPISuccessGetSingle(string $entity, array<string|int, mixed> $params[, array<string|int, mixed> $checkAgainst = NULL ]) : array<string|int, mixed>|int

Parameters

$entity : string

$params : array<string|int, mixed>

$checkAgainst : array<string|int, mixed> = NULL

Array to compare result against.

boolean
integer
double
string
array
object

Return values

array<string|int, mixed>|int

callAPISuccessGetValue()

This function wraps the getValue api and checks the result.


    public
                    callAPISuccessGetValue(string $entity, array<string|int, mixed> $params[, string $type = NULL ]) : array<string|int, mixed>|int

Parameters

$entity : string

$params : array<string|int, mixed>

$type : string = NULL

Per http://php.net/manual/en/function.gettype.php possible types.

boolean
integer
double
string
array
object

Return values

array<string|int, mixed>|int

campaignCreate()


    public
                    campaignCreate([array<string|int, mixed> $params = [] ]) : int

Parameters

$params : array<string|int, mixed> = []: Optional parameters.

Return values

int —

Campaign ID.

caseCreate()


    public
                    caseCreate(array<string|int, mixed> $formValues, string $identifier) : void

Parameters

$formValues : array<string|int, mixed>
$identifier : string

checkArrayEquals()

Get formatted values in the actual and expected result.


    public
                    checkArrayEquals(array<string|int, mixed> &$actual, array<string|int, mixed> &$expected) : void

Parameters

$actual : array<string|int, mixed>: Actual calculated values.
$expected : array<string|int, mixed>: Expected values.

civicrm_api()

A stub for the API interface. This can be overriden by subclasses to change how the API is called.


    public
                    civicrm_api(mixed $entity, mixed $action[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|int

Parameters

$entity : mixed
$action : mixed
$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>|int

CiviUnitTestCase_fatalErrorHandler()


    public
                    CiviUnitTestCase_fatalErrorHandler(mixed $message) : mixed

Parameters

$message : mixed

cleanTempDirs()


    public
                    cleanTempDirs() : mixed

contactDelete()

Delete contact, ensuring it is not the domain contact


    public
                    contactDelete(int $contactID) : void

Parameters

$contactID : int: Contact ID to delete

contactMembershipCreate()

Create membership.


    public
                    contactMembershipCreate(array<string|int, mixed> $params) : int

Parameters

$params : array<string|int, mixed>

Return values

int

contributionCreate()

Create contribution.


    public
                    contributionCreate(array<string|int, mixed> $params) : int

Parameters

$params : array<string|int, mixed>: Array of parameters.

Return values

int —

id of created contribution

contributionDelete()

Delete contribution.


    public
                    contributionDelete(int $contributionID) : array<string|int, mixed>|int

Parameters

$contributionID : int

Return values

array<string|int, mixed>|int

contributionPageCreate()

Create contribution page.


    public
                    contributionPageCreate([array<string|int, mixed> $contributionPageValues = [] ][, string $identifier = 'test' ]) : array<string|int, mixed>

Parameters

$contributionPageValues : array<string|int, mixed> = []
$identifier : string = 'test'

Return values

array<string|int, mixed> —

Array of contribution page

createCase()

Create and return a case object for the given Client ID.


    public
                    createCase(int $clientID[, int|null $loggedInUser = NULL ][, array<string|int, mixed> $extra = [] ][, string $identifier = 'form-created' ]) : CRM_Case_BAO_Case

Note that calling caseCreate directly is preferred.

Parameters

$clientID : int
$loggedInUser : int|null = NULL: Omit or pass NULL to use the same as clientId
$extra : array<string|int, mixed> = []: Optional specific parameters such as start_date
$identifier : string = 'form-created'

Return values

CRM_Case_BAO_Case

createCustomFieldsOfAllTypes()


    public
                    createCustomFieldsOfAllTypes() : array<string|int, mixed>

Return values

array<string|int, mixed>

createCustomGroup()

Create a custom group.


    public
                    createCustomGroup([array<string|int, mixed> $params = [] ]) : int

Parameters

$params : array<string|int, mixed> = []

Return values

int

createCustomGroupWithFieldOfType()

Create a custom group with a single field.


    public
                    createCustomGroupWithFieldOfType([array<string|int, mixed> $groupParams = [] ][, string $customFieldType = 'text' ][, string|null $identifier = NULL ][, array<string|int, mixed> $fieldParams = [] ]) : void

Parameters

$groupParams : array<string|int, mixed> = []: Params for the group to be created.
$customFieldType : string = 'text'
$identifier : string|null = NULL
$fieldParams : array<string|int, mixed> = []

createCustomGroupWithFieldsOfAllTypes()

Create a custom group with fields of multiple types.


    public
                    createCustomGroupWithFieldsOfAllTypes([array<string|int, mixed> $groupParams = [] ]) : void

Parameters

$groupParams : array<string|int, mixed> = []

createDomainContacts()

Create default domain contacts for the two domains added during test class.


    public
                    createDomainContacts() : void

database population.

createExternalAPI()

Create a batch of external API calls which can be executed concurrently.


    public
                    createExternalAPI() : ExternalBatch

$calls = $this->createExternalAPI()
   ->addCall('Contact', 'get', ...)
   ->addCall('Contact', 'get', ...)
   ...
   ->run()
   ->getResults();

Return values

ExternalBatch

createLoggedInUser()

Emulate a logged in user since certain functions use that.


    public
                    createLoggedInUser() : int

value to store a record in the DB (like activity)

Return values

int —

Contact ID of the created user.

createMailing()

Helper function to create new mailing.


    public
                    createMailing([array<string|int, mixed> $params = [] ][, string $identifier = 'default' ]) : int

Parameters

$params : array<string|int, mixed> = []
$identifier : string = 'default'

Return values

int

createPriceSetWithPage()

Create price set with contribution test for test setup.


    public
                    createPriceSetWithPage() : void

This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage on parent class at some point.

createTempDir()

Generate a temporary folder.


    public
                    createTempDir([string $prefix = 'test-' ]) : string

Parameters

$prefix : string = 'test-'

Return values

string

customDirectories()

Helper to enable/disable custom directory support


    public
                    customDirectories(array<string|int, mixed> $customDirs) : mixed

Parameters

$customDirs : array<string|int, mixed>: With members:. 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path

customFieldCreate()

Create custom field.


    public
                    customFieldCreate(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>: (custom_group_id) is required.

Return values

array<string|int, mixed>

customFieldDelete()

Delete custom field.


    public
                    customFieldDelete(int $customFieldID) : array<string|int, mixed>|int

Parameters

$customFieldID : int

Return values

array<string|int, mixed>|int

customFieldOptionValueCreate()

Create custom field with Option Values.


    public
                    customFieldOptionValueCreate(array<string|int, mixed> $customGroup, string $name[, array<string|int, mixed> $extraParams = [] ]) : array<string|int, mixed>|int

Parameters

$customGroup : array<string|int, mixed>
$name : string: Name of custom field.
$extraParams : array<string|int, mixed> = []: Additional parameters to pass through.

Return values

array<string|int, mixed>|int

customGroupCreate()

Create custom group.


    public
                    customGroupCreate([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>

CustomGroupCreateByParams()

Existing function doesn't allow params to be over-ridden so need a new one this one allows you to only pass in the params you want to change


    public
                    CustomGroupCreateByParams([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|int

Parameters

$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>|int

customGroupDelete()

Delete custom group.


    public
                    customGroupDelete(int $customGroupID) : array<string|int, mixed>|int

Parameters

$customGroupID : int

Return values

array<string|int, mixed>|int

CustomGroupMultipleCreateByParams()

Create custom group with multi fields.


    public
                    CustomGroupMultipleCreateByParams([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|int

Parameters

$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>|int

CustomGroupMultipleCreateWithFields()

Create custom group with multi fields.


    public
                    CustomGroupMultipleCreateWithFields([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>

deleteMailing()

Helper function to delete mailing.


    public
                    deleteMailing(mixed $id) : mixed

Parameters

$id : mixed

disableMultilingual()


    public
                    disableMultilingual() : void

dummyProcessorCreate()

Create Payment Processor.


    public
                    dummyProcessorCreate([array<string|int, mixed> $processorParams = [] ]) : CRM_Core_Payment_Dummy

Parameters

$processorParams : array<string|int, mixed> = []

Return values

CRM_Core_Payment_Dummy —

Instance of Dummy Payment Processor

enableCiviCampaign()

Enable CiviCampaign Component.


    public
                    enableCiviCampaign() : void

enableMultilingual()

Enable multilingual.


    public
                    enableMultilingual([array<string|int, mixed>|null $addLocales = NULL ]) : void

Parameters

$addLocales : array<string|int, mixed>|null = NULL: A list of new locales to setup. A locale is initialized by copying from an existing locale.

Ex: Copy from en_US to fr_CA ['en_US' => 'fr_CA'] Ex: Copy from en_US to fr_CA and de_DE ['en_US' => ['fr_CA', 'de_DE]]

entityCustomGroupWithSingleFieldCreate()

Create a custom group with a single text custom field. See participant:testCreateWithCustom for how to use this


    public
                    entityCustomGroupWithSingleFieldCreate(string $function, string $filename) : array<string|int, mixed>

Parameters

$function : string: FUNCTION.
$filename : string: $file FILE.

Return values

array<string|int, mixed> —

ids of created objects

entityCustomGroupWithSingleStringMultiSelectFieldCreate()

Create a custom group with a single text custom field, multi-select widget, with a variety of option values including upper and lower case.


    public
                    entityCustomGroupWithSingleStringMultiSelectFieldCreate(string $function, string $filename) : array<string|int, mixed>

See api_v3_SyntaxConformanceTest:testCustomDataGet for how to use this

Parameters

$function : string: FUNCTION.
$filename : string: $file FILE.

Return values

array<string|int, mixed> —

ids of created objects

entityTagAdd()

Add entity(s) to the tag


    public
                    entityTagAdd(array<string|int, mixed> $params) : true

Parameters

$params : array<string|int, mixed>

Return values

true

eventCreate()

Create an Event.


    public
                    eventCreate([array<string|int, mixed> $params = [] ][, string $identifier = 'event' ]) : array<string|int, mixed>

Note this is not expected to be called directly - call

eventCreatePaid
eventCreateUnpaid

Parameters

$params : array<string|int, mixed> = []: Name-value pair for an event.
$identifier : string = 'event'

Return values

array<string|int, mixed>

eventDelete()

Delete event.


    public
                    eventDelete(int $id) : array<string|int, mixed>|int

Parameters

$id : int: ID of the event.

Return values

array<string|int, mixed>|int

financialAccountDelete()


    public
                    financialAccountDelete(string $name) : mixed

Parameters

$name : string

getAndCheck()


    public
                    getAndCheck(array<string|int, mixed> $params, int $id, string $entity[, int $delete = 1 ][, string $errorText = '' ]) : void

Parameters

$params : array<string|int, mixed>
$id : int
$entity : string
$delete : int = 1
$errorText : string = ''

getBooleanDataProvider()

Get the boolean options as a provider.


    public
                    getBooleanDataProvider() : array<string|int, mixed>

Return values

array<string|int, mixed>

getCustomGroupTable()

Get the table_name for the specified custom group.


    public
                    getCustomGroupTable([string $identifier = 'Custom Group' ]) : string

Parameters

$identifier : string = 'Custom Group'

Return values

string

getFieldsValuesByType()

Get default field values for the type of field.


    public
                    getFieldsValuesByType(string $dataType[, string $htmlType = 'default' ]) : array<string|int, mixed>

Parameters

$dataType : string
$htmlType : string = 'default'

Return values

array<string|int, mixed>

getFinancialTypeID()

Return financial type id on basis of name


    public
                    getFinancialTypeID(string $name) : int

Parameters

$name : string: Financial type m/c name

Return values

int

getFormObject()

Instantiate form object.


    public
                    getFormObject(string $class[, array<string|int, mixed> $formValues = [] ][, array<string|int, mixed> $urlParameters = [] ]) : CRM_Core_Form|CRM_Event_Form_Registration_Register

We need to instantiate the form to run preprocess, which means we have to trick it about the request method.

Parameters

$class : string: Name of form class.
$formValues : array<string|int, mixed> = []
$urlParameters : array<string|int, mixed> = []

Return values

CRM_Core_Form|CRM_Event_Form_Registration_Register

getInternationalStrings()

Get international string data for testing against api calls.


    public
                    getInternationalStrings() : array<string|int, mixed>

Return values

array<string|int, mixed>

getLoggedInUser()

Get the logged in user record.


    public
                    getLoggedInUser() : int|null

Return values

int|null

getPhoneStrings()


    public
                    getPhoneStrings() : array<string|int, mixed>

Return values

array<string|int, mixed>

getSearchFormObject()

Instantiate form object.


    public
                    getSearchFormObject(string $class[, array<string|int, mixed> $formValues = [] ][, string|null $pageName = 'Search' ][, array<string|int, mixed> $searchFormValues = [] ]) : CRM_Core_Form

We need to instantiate the form to run preprocess, which means we have to trick it about the request method.

Parameters

$class : string: Name of form class.
$formValues : array<string|int, mixed> = []
$pageName : string|null = 'Search'
$searchFormValues : array<string|int, mixed> = []: Values for the search form if the form is a task eg. for selected ids 6 & 8: [ 'radio_ts' => 'ts_sel', 'task' => CRM_Member_Task::PDF_LETTER, 'mark_x_6' => 1, 'mark_x_8' => 1, ]

Return values

CRM_Core_Form

getSearchSortOptions()


    public
                    getSearchSortOptions() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTestForm()


    public
                    getTestForm(mixed $formName, mixed $submittedValues[, array<string|int, mixed> $urlParameters = [] ]) : FormWrapper

Parameters

$formName : mixed
$submittedValues : mixed
$urlParameters : array<string|int, mixed> = []

Return values

FormWrapper

getTestPage()


    public
                    getTestPage(string $pageName[, array<string|int, mixed> $urlParameters = [] ]) : PageWrapper

Parameters

$pageName : string
$urlParameters : array<string|int, mixed> = []

Return values

PageWrapper

getThousandSeparators()

Get possible thousand separators.


    public
                    getThousandSeparators() : array<string|int, mixed>

Return values

array<string|int, mixed>

groupContactCreate()

Function to add a Group.


    public
                    groupContactCreate(int $groupID[, int $totalCount = 10 ][, bool $random = FALSE ]) : int

Parameters

$groupID : int
$totalCount : int = 10
$random : bool = FALSE

Return values

int —

groupId of created group

groupCreate()

Add a Group.


    public
                    groupCreate([array<string|int, mixed> $params = [] ][, string $identifier = 'group' ]) : int

Parameters

$params : array<string|int, mixed> = []
$identifier : string = 'group'

Return values

int —

groupId of created group

groupDelete()

Delete a Group.


    public
                    groupDelete(int $gid) : mixed

Parameters

$gid : int

householdCreate()

Generic function to create Household, to be used in test cases


    public
                    householdCreate([array<string|int, mixed> $params = [] ][, int|string $identifier = 'household_0' ]) : int

Parameters

$params : array<string|int, mixed> = []: parameters for civicrm_contact_add api function call
$identifier : int|string = 'household_0': If the identifier is numeric (discouraged) it will affect which contact is loaded. Numeric identifiers and values for random other than FALSE are generally discouraged in favour if specifying data in params where variety is needed.

Return values

int —

id of Household created

individualCreate()

Generic function to create Individual, to be used in test cases


    public
                    individualCreate([array<string|int, mixed> $params = [] ][, int|string $identifier = 'individual_0' ][, bool $random = FALSE ]) : int

Parameters

$params : array<string|int, mixed> = []: parameters for civicrm_contact_add api function call
$identifier : int|string = 'individual_0': If the identifier is numeric (discouraged) it will affect which contact is loaded. Numeric identifiers and values for random other than FALSE are generally discouraged in favour if specifying data in params where variety is needed.
$random : bool = FALSE: Random is deprecated.

Return values

int —

id of Individual created

killTheJusticeLeague()

Implements hook_pre().


    public
                    killTheJusticeLeague(mixed $op, mixed $entity, mixed $id, mixed &$params) : void

Parameters

$op : mixed
$entity : mixed
$id : mixed
$params : mixed

loadAllFixtures()

Read everything from the datasets directory and insert into the db.


    public
                    loadAllFixtures() : void

locationAdd()

Add a Location.


    public
                    locationAdd(int $contactID) : int

Parameters

$contactID : int

Return values

int —

location id of created location

locationTypeCreate()

Add a Location Type.


    public
                    locationTypeCreate([array<string|int, mixed> $params = [] ]) : int

Parameters

$params : array<string|int, mixed> = []

Return values

int —

location id of created location

locationTypeDelete()

Delete a Location Type.


    public
                    locationTypeDelete(int $locationTypeID) : void

Parameters

$locationTypeID : int

mappingCreate()

Add a Mapping.


    public
                    mappingCreate([array<string|int, mixed> $params = NULL ]) : CRM_Core_DAO_Mapping

Parameters

$params : array<string|int, mixed> = NULL

Return values

CRM_Core_DAO_Mapping —

Mapping id of created mapping

mappingDelete()

Delete a Mapping


    public
                    mappingDelete(int $mappingID) : void

Parameters

$mappingID : int

membershipDelete()


    public
                    membershipDelete(int $membershipID) : mixed

Parameters

$membershipID : int

membershipRenewalDate()


    public
                    membershipRenewalDate(mixed $durationUnit, mixed $membershipEndDate) : mixed

Parameters

$durationUnit : mixed
$membershipEndDate : mixed

membershipStatusCreate()


    public
                    membershipStatusCreate([string $name = 'test member status' ]) : int

Parameters

$name : string = 'test member status'

Return values

int

membershipStatusDelete()

Delete the given membership status, deleting any memberships of the status first.


    public
                    membershipStatusDelete(int $membershipStatusID) : void

Parameters

$membershipStatusID : int

membershipTypeCreate()


    public
                    membershipTypeCreate([array<string|int, mixed> $params = [] ][, string $identifer = 'test' ]) : int

Parameters

$params : array<string|int, mixed> = []
$identifer : string = 'test'

Return values

int

membershipTypeDelete()

Delete Membership Type.


    public
                    membershipTypeDelete(array<string|int, mixed> $params) : mixed

Parameters

$params : array<string|int, mixed>

offsetDefaultPriceSet()

Alter default price set so that the field numbers are not all 1 (hiding errors)


    public
                    offsetDefaultPriceSet() : mixed

onPost()

An implementation of hook_civicrm_post used with all our test cases.


    public
                    onPost(mixed $op, string $objectName, int $objectId, mixed &$objectRef) : mixed

Parameters

$op : mixed
$objectName : string
$objectId : int
$objectRef : mixed

organizationCreate()

Generic function to create Organisation, to be used in test cases


    public
                    organizationCreate([array<string|int, mixed> $params = [] ][, int|string $identifier = 'organization_0' ]) : int

Parameters

$params : array<string|int, mixed> = []: parameters for civicrm_contact_add api function call
$identifier : int|string = 'organization_0': If the identifier is numeric (discouraged) it will affect which contact is loaded. Numeric identifiers and values for random other than FALSE are generally discouraged in favour if specifying data in params where variety is needed.

Return values

int —

id of Organisation created

participantCreate()

Create Participant.


    public
                    participantCreate([array<string|int, mixed> $params = [] ]) : int

Parameters

$params : array<string|int, mixed> = []: Array of contact id and event id values.

Return values

int —

id of participant created

participantDelete()

Delete participant.


    public
                    participantDelete(int $participantID) : array<string|int, mixed>|int

Parameters

$participantID : int

Return values

array<string|int, mixed>|int

participantPaymentCreate()

Create participant payment.


    public
                    participantPaymentCreate(int $participantID[, int $contributionID = NULL ]) : int

Parameters

$participantID : int
$contributionID : int = NULL

Return values

int —

$id of created payment

participantPaymentDelete()

Delete participant payment.


    public
                    participantPaymentDelete(int $paymentID) : mixed

Parameters

$paymentID : int

paymentProcessorCreate()

Create an instance of the paypal processor.


    public
                    paymentProcessorCreate([array<string|int, mixed> $params = [] ][, string $identifier = 'test' ]) : int

Parameters

$params : array<string|int, mixed> = []
$identifier : string = 'test'

Return values

int —

$result['id'] payment processor id

paymentProcessorTypeCreate()


    public
                    paymentProcessorTypeCreate([array<string|int, mixed> $params = [] ]) : int

Parameters

$params : array<string|int, mixed> = []

Return values

int

pledgeCreate()

Create pledge.


    public
                    pledgeCreate(array<string|int, mixed> $params) : int

Parameters

$params : array<string|int, mixed>: Parameters.

Return values

int —

id of created pledge

pledgeDelete()

Delete pledge.


    public
                    pledgeDelete(int $pledgeID) : void

Parameters

$pledgeID : int

processorCreate()

Create Payment Processor.


    public
                    processorCreate([mixed $params = [] ]) : int

Parameters

$params : mixed = []

Return values

int —

Payment Processor ID.

quickCleanup()

Quick clean by emptying tables created for the test.


    public
                    quickCleanup(array<string|int, mixed> $tablesToTruncate[, bool $dropCustomValueTables = FALSE ]) : void

Parameters

$tablesToTruncate : array<string|int, mixed>
$dropCustomValueTables : bool = FALSE

quickCleanUpFinancialEntities()

Clean up financial entities after financial tests (so we remember to get all the tables :-))


    public
                    quickCleanUpFinancialEntities() : void

relationshipTypeCreate()

Create a relationship type.


    public
                    relationshipTypeCreate([array<string|int, mixed> $params = [] ]) : int

Parameters

$params : array<string|int, mixed> = []

Return values

int

relationshipTypeDelete()

Delete Relatinship Type.


    public
                    relationshipTypeDelete(int $relationshipTypeID) : mixed

Parameters

$relationshipTypeID : int

restoreDefaultPriceSetConfig()

Reset the price set config so results exist.


    public
                    restoreDefaultPriceSetConfig() : void

restoreMembershipTypes()

Recreate default membership types.


    public
                    restoreMembershipTypes() : void

retrieveEntityFinancialTrxn()

Retrieve entity financial trxn details.


    public
                    retrieveEntityFinancialTrxn(array<string|int, mixed> $params[, bool $maxId = FALSE ]) : array<string|int, mixed>

only called by tests - to be replaced with $trxn = (array) EntityFinancialTrxn::get() ->addWhere('id', '=', $contributionID) ->addWhere('entity_table', '=', 'civicrm_contribution') ->addSelect('*')->execute();

this was used so much in tests I copied it over - but it should go.... the tests just need to use the api.

Parameters

$params : array<string|int, mixed>: an assoc array of name/value pairs.
$maxId : bool = FALSE: To retrieve max id.

Return values

array<string|int, mixed>

runApi4Legacy()

Emulate v3 syntax so we can run api3 tests on v4


    public
                    runApi4Legacy(mixed $v3Entity, mixed $v3Action[, array<string|int, mixed> $v3Params = [] ]) : array<string|int, mixed>|int

Parameters

$v3Entity : mixed
$v3Action : mixed
$v3Params : array<string|int, mixed> = []

Return values

array<string|int, mixed>|int

sampleContact()

Helper function for getting sample contact properties.


    public
                    sampleContact(string $contact_type[, int $seq = 0 ][, bool $random = FALSE ]) : array<string|int, mixed>

Parameters

$contact_type : string: enum contact type: Individual, Organization
$seq : int = 0: sequence number for the values of this type
$random : bool = FALSE

Return values

array<string|int, mixed> —

properties of sample contact (ie. $params for API call)

selectWhereClauseHook()


    public
                    selectWhereClauseHook(string $entity, array<string|int, mixed> &$clauses) : void

Parameters

$entity : string
$clauses : array<string|int, mixed>

setExtensionSystem()

Temporarily replace the singleton extension with a different one.


    public
                    setExtensionSystem(CRM_Extension_System $system) : mixed

Parameters

$system : CRM_Extension_System

setMockSettingsMetaData()

Temporarily alter the settings-metadata to add a mock setting.


    public
                    setMockSettingsMetaData(mixed $extras) : void

WARNING: The setting metadata will disappear on the next cache-clear.

Parameters

$extras : mixed

setUp()

Test setup for every test.


    public
                    setUp() : void

Connect to the database, truncate the tables that will be used and redirect stdin to a temporary file

setupACL()

Set up an acl allowing contact to see 2 specified groups - $this->_permissionedGroup & $this->_permissionedDisabledGroup


    public
                    setupACL([bool $isProfile = FALSE ]) : void

You need to have pre-created these groups & created the user e.g $this->createLoggedInUser(); $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled')); $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));

Parameters

$isProfile : bool = FALSE

setUpBeforeClass()


    public
            static        setUpBeforeClass() : void

setupForSmsTests()

Setup or clean up SMS tests


    public
                    setupForSmsTests([bool $teardown = FALSE ]) : mixed

Parameters

$teardown : bool = FALSE

setupMembershipRecurringPaymentProcessorTransaction()

We don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it


    public
                    setupMembershipRecurringPaymentProcessorTransaction([array<string|int, mixed> $params = [] ][, array<string|int, mixed> $contributionParams = [] ]) : void

Parameters

$params : array<string|int, mixed> = []: Optionally modify params for membership/recur (duration_unit/frequency_unit)
$contributionParams : array<string|int, mixed> = []: Parameters to pass to contribution create.

setupRecurringPaymentProcessorTransaction()

Set up initial recurring payment allowing subsequent IPN payments.


    public
                    setupRecurringPaymentProcessorTransaction([array<string|int, mixed> $recurParams = [] ][, array<string|int, mixed> $contributionParams = [] ][, string $identifier = 'default' ]) : void

Parameters

$recurParams : array<string|int, mixed> = []: (Optional)
$contributionParams : array<string|int, mixed> = []: (Optional)
$identifier : string = 'default'

smartGroupCreate()

Create a smart group.


    public
                    smartGroupCreate([array<string|int, mixed> $smartGroupParams = [] ][, array<string|int, mixed> $groupParams = [] ][, string $contactType = 'Household' ]) : int

By default it will be a group of households.

Parameters

$smartGroupParams : array<string|int, mixed> = []
$groupParams : array<string|int, mixed> = []
$contactType : string = 'Household'

Return values

int

tagCreate()

Create Tag.


    public
                    tagCreate([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []

Return values

array<string|int, mixed> —

result of created tag

tagDelete()

Delete Tag.


    public
                    tagDelete(int $tagID) : int

Parameters

$tagID : int: ID of the tag to be deleted.

Return values

int

tearDown()

Restore the DB for the next test.


    public
                    tearDown() : void

testAddCreateIndividual()

Test civicrm_contact_create.


    public
                    testAddCreateIndividual(int $version) : void

Verify that attempt to create individual contact with only first and last names succeeds

Parameters

$version : int

testAddCreateIndividualWithPreferredLanguage()

Test civicrm_contact_create.


    public
                    testAddCreateIndividualWithPreferredLanguage(int $version) : void

Verify that preferred language can be set.

Parameters

$version : int

testChainingValuesCreate()

Test checks usage of $values to pick & choose inputs.


    public
                    testChainingValuesCreate() : void

Api3 Only - chaining syntax is too funky for v4 (assuming entityTag "entity_id" field will be filled by magic)

testContactCreateCurrentEmployer()

Test creating a current employer through API.


    public
                    testContactCreateCurrentEmployer() : void

testContactCreateDuplicateCurrentEmployerEnables()

Test creating a current employer through API.


    public
                    testContactCreateDuplicateCurrentEmployerEnables() : void

Check it will re-activate a de-activated employer

testContactCreateFormatIsSuccessFalse()

Test TrueFalse format.


    public
                    testContactCreateFormatIsSuccessFalse(int $version) : void

Parameters

$version : int

testContactCreateLongDisplayName()

Test long display names.


    public
                    testContactCreateLongDisplayName(int $version) : void

Parameters

$version : int

testContactCreationPermissions()

Test that permissions are respected when creating contacts.


    public
                    testContactCreationPermissions(int $version) : void

Parameters

$version : int

testContactDelete()

Test civicrm_contact_delete().


    public
                    testContactDelete(int $version) : void

Parameters

$version : int

testContactDeleteError()

Test civicrm_contact_delete() with error.


    public
                    testContactDeleteError(int $version) : void

Parameters

$version : int

testContactDeleteNoID()

Test civicrm_contact_delete() with no contact ID.


    public
                    testContactDeleteNoID(int $version) : void

Parameters

$version : int

testContactDeletePermissions()

Test that delete with skip undelete respects permissions.


    public
                    testContactDeletePermissions(int $version) : void

Parameters

$version : int

testContactGetBirthDate()

Test birth date parameters.


    public
                    testContactGetBirthDate() : void

These include value, array & birth_date_high, birth_date_low && deceased.

testContactGetByUnknownUsername()

Test for Contact.get id=@user:username (with an invalid username).


    public
                    testContactGetByUnknownUsername() : void

testContactGetByUsername()

Test for Contact.get id=@user:username.


    public
                    testContactGetByUsername() : void

testContactGetDeceasedDate()

Test Deceased date parameters.


    public
                    testContactGetDeceasedDate() : void

These include value, array & Deceased_date_high, Deceased date_low && deceased.

testContactGetEmail()

Test civicrm_contact_search_count().


    public
                    testContactGetEmail() : void

testContactGetEmptyParams()

Test civicrm_contact_get) with empty params.


    public
                    testContactGetEmptyParams(int $version) : void

Parameters

$version : int

testContactGetFormatCountOnly()

Test Single Entity format.


    public
                    testContactGetFormatCountOnly(int $version) : void

Parameters

$version : int

testContactGetFormatIDOnly()

Test id only format.


    public
                    testContactGetFormatIDOnly(int $version) : void

Parameters

$version : int

testContactGetFormatIsSuccessTrue()

Test TrueFalse format - I couldn't come up with an easy way to get an error on Get.


    public
                    testContactGetFormatIsSuccessTrue(int $version) : void

Parameters

$version : int

testContactGetFormatSingleValue()

Test id only format.


    public
                    testContactGetFormatSingleValue(int $version) : void

Parameters

$version : int

testContactGetFromGroup()

API test to retrieve contact from group having different group title and name.


    public
                    testContactGetFromGroup() : void

testContactGetOldParamsNoMatches()

Test civicrm_contact_get(,true) with no matches.


    public
                    testContactGetOldParamsNoMatches(int $version) : void

Parameters

$version : int

testContactGetOldParamsOneMatch()

Test civicrm_contact_get(,true) with one match.


    public
                    testContactGetOldParamsOneMatch() : void

testContactGetProximity()

Test the prox_distance functionality works.


    public
                    testContactGetProximity() : void

This is primarily testing functionality in the BAO_Query object that 'happens to be' accessible via the api.

testContactGetRetDefault()

Test civicrm_contact_get() with default return properties.


    public
                    testContactGetRetDefault() : void

testContactGetRetFirst()

Test civicrm_contact_get() return only first name.


    public
                    testContactGetRetFirst(int $version) : void

Parameters

$version : int

testContactGetReturnFirstLast()

Test civicrm_contact_get() return only first name & last name.


    public
                    testContactGetReturnFirstLast(int $version) : void

Use comma separated string return with a space.

Parameters

$version : int

testContactGetReturnFirstLastNoComma()

Test civicrm_contact_get() return only first name & last name.


    public
                    testContactGetReturnFirstLastNoComma(int $version) : void

Use comma separated string return without a space

Parameters

$version : int

testContactGetReturnGroup()

Ensure format with return=group shows comma-separated group IDs.


    public
                    testContactGetReturnGroup() : void

testContactGetReturnValues()

Test to check return works OK.


    public
                    testContactGetReturnValues() : void

testContactGetSingleEntityArray()

Test Single Entity format.


    public
                    testContactGetSingleEntityArray(int $version) : void

Parameters

$version : int

testContactGetSpaceMatches()

Test civicrm_contact_get(,true) with space in sort_name.


    public
                    testContactGetSpaceMatches() : void

testContactGetUnique()

Test getunique api call for Contact entity


    public
                    testContactGetUnique() : void

testContactGetWithAddressFields()

Test Address parameters


    public
                    testContactGetWithAddressFields() : void

This include state_province, state_province_name, country

testContactGetWithGroupTitle()

CRM-20144 Verify that passing title of group works as well as id Tests the following formats contact.get group='title1' contact.get group=id1


    public
                    testContactGetWithGroupTitle() : void

testContactGetWithGroupTitleMultipleGroups()

CRM-20144 Verify that passing title of group works as well as id Tests the following formats contact.get group=array('title1', title1) contact.get group=array('IN' => array('title1', 'title2)


    public
                    testContactGetWithGroupTitleMultipleGroups() : void

testContactGetWithGroupTitleMultipleGroupsLegacyFormat()

CRM-20144 Verify that passing title of group works as well as id Tests the following formats contact.get group=array('title1' => 1) contact.get group=array('title1' => 1, 'title2' => 1) contact.get group=array('id1' => 1) contact.get group=array('id1' => 1, id2 => 1)


    public
                    testContactGetWithGroupTitleMultipleGroupsLegacyFormat() : void

testContactGetWithTag()

Verify that passing tag IDs to Contact.get works


    public
                    testContactGetWithTag() : void

Tests the following formats

Contact.get tag='id1'
Contact.get tag='id1,id2'
Contact.get tag='id1, id2'

testContactGreetingsCreate()

Test that creating a contact with various contact greetings works.


    public
                    testContactGreetingsCreate(int $version) : void

Parameters

$version : int

testContactGreetingsCreateWithCustomField()

Test that creating a contact with various contact greetings works.


    public
                    testContactGreetingsCreateWithCustomField(int $version) : void

Parameters

$version : int

testContactProximity()

Test contact proximity api.


    public
                    testContactProximity() : void

testContactUpdatePermissions()

Test update with check permissions set.


    public
                    testContactUpdatePermissions(int $version) : void

Parameters

$version : int

testCreateAlterSortName()

Test that we can set the sort name via the api or alter it via a hook.


    public
                    testCreateAlterSortName(int $version) : void

As of writing this is being fixed for Organization & Household but it makes sense to do for individuals too.

Parameters

$version : int

testCreateApiKey()

Check that permissions on API key are restricted (CRM-18112).


    public
                    testCreateApiKey(int $version) : void

Parameters

$version : int

testCreateBadRequiredFieldsHousehold()

Verify that attempt to create household contact without required fields fails.


    public
                    testCreateBadRequiredFieldsHousehold() : void

testCreateBadRequiredFieldsIndividual()

Verify that attempt to create individual contact without required fields fails.


    public
                    testCreateBadRequiredFieldsIndividual() : void

testCreateBadRequiredFieldsOrganization()

Test required field check.


    public
                    testCreateBadRequiredFieldsOrganization() : void

Verify that attempt to create organization contact without required fields fails.

testCreateBadTypeContact()

Verify that attempt to create contact with bad contact type fails.


    public
                    testCreateBadTypeContact() : void

testCreateCommunicationStylePassed()

CRM-21041 Test if 'communication style' is set if value is passed.


    public
                    testCreateCommunicationStylePassed() : void

testCreateCommunicationStyleUnset()

CRM-21041 Test if 'communication style' is set to site default if not passed.


    public
                    testCreateCommunicationStyleUnset(int $version) : void

Parameters

$version : int

testCreateContactCustomFldDateTime()

CRM-15792 - create/update datetime field for contact.


    public
                    testCreateContactCustomFldDateTime() : void

testCreateDisplayNameIndividual()

Test creating individual by display_name.


    public
                    testCreateDisplayNameIndividual(int $version) : void

Display name & sort name should be set.

Parameters

$version : int

testCreateEmailIndividual()

Verify that attempt to create individual contact with only an email succeeds.


    public
                    testCreateEmailIndividual() : void

testCreateEmptyContact()

Verify that attempt to create contact with empty params fails.


    public
                    testCreateEmptyContact() : void

testCreateHouseholdDetails()

Verify that attempt to create household contact with details succeeds.


    public
                    testCreateHouseholdDetails() : void

testCreateHouseholdInadequateDetails()

Verify that attempt to create household contact with inadequate details fails.


    public
                    testCreateHouseholdInadequateDetails() : void

testCreateIndividualNoCacheClear()

Test that it is possible to prevent cache clearing via option.


    public
                    testCreateIndividualNoCacheClear() : void

Cache clearing is bypassed if 'options' => array('do_not_reset_cache' => 1 is used.

testCreateIndividualWithChainedArrayAndSequential()

Verify attempt to create individual with chained arrays and sequential.


    public
                    testCreateIndividualWithChainedArrayAndSequential(int $version) : void

Parameters

$version : int

testCreateIndividualWithContributionChainedArrays()

Verify that attempt to create individual contact with chained contribution and website succeeds.


    public
                    testCreateIndividualWithContributionChainedArrays() : void

testCreateIndividualWithContributionDottedSyntax()

Verify that attempt to create individual contact with two chained websites succeeds.


    public
                    testCreateIndividualWithContributionDottedSyntax() : void

testCreateIndividualWithEmployer()

Verify that when changing employers the old employer relationship becomes inactive.


    public
                    testCreateIndividualWithEmployer() : void

testCreateIndividualWithJustEmail()

Verify that attempt to create individual contact just email succeeds.


    public
                    testCreateIndividualWithJustEmail() : void

testCreateIndividualWithJustEmailViaChain()

Verify that updating a contact email updates their display name.


    public
                    testCreateIndividualWithJustEmailViaChain(int $version) : void

Parameters

$version : int

testCreateIndividualWithNameEmail()

Verify that attempt to create individual contact with first, and last names and email succeeds.


    public
                    testCreateIndividualWithNameEmail() : void

testCreateIndividualWithNameEmailLocationType()

Test create individual contact with first &last names, email and location type succeeds.


    public
                    testCreateIndividualWithNameEmailLocationType() : void

testCreateIndividualWithOutNameEmail()

Verify that attempt to create individual contact with no data fails.


    public
                    testCreateIndividualWithOutNameEmail() : void

testCreateNameHousehold()

Test household name is sufficient for create.


    public
                    testCreateNameHousehold(int $version) : void

Verify that attempt to create household contact with only household name succeeds

Parameters

$version : int

testCreateNameIndividual()

Test creating individual by name.


    public
                    testCreateNameIndividual(int $version) : void

Verify create individual contact with only first and last names succeeds.

Parameters

$version : int

testCreateNameIndividualOldKeys()

Test old keys still work.


    public
                    testCreateNameIndividualOldKeys() : void

Verify that attempt to create individual contact with first and last names and old key values works

testCreateNameIndividualRecommendedKeys2()

Test preferred keys work.


    public
                    testCreateNameIndividualRecommendedKeys2() : void

Verify that attempt to create individual contact with first and last names and old key values works

testCreateNameOrganization()

Test organization name is sufficient for create.


    public
                    testCreateNameOrganization(int $version) : void

Verify that attempt to create organization contact with only organization name succeeds.

Parameters

$version : int

testCreateNoNameOrganization()

Verify that attempt to create organization contact without organization name fails.


    public
                    testCreateNoNameOrganization() : void

testCreateNoteInCreate()

Test creating a note from the contact.create API call when only passing the note as a string.


    public
                    testCreateNoteInCreate() : void

testCreateNoteInCreateArrayFormat()

Test Creating a note from the contact.create api call when passing the note params as an array.


    public
                    testCreateNoteInCreateArrayFormat() : void

testCreatePreferredLanguageNull()

CRM-14232 test preferred language returns setting if not passed where setting is NULL.


    public
                    testCreatePreferredLanguageNull() : void

TODO: Api4

testCreatePreferredLanguagePassed()

CRM-14232 test preferred language returns setting if not passed where setting is NULL.


    public
                    testCreatePreferredLanguagePassed(int $version) : void

Parameters

$version : int

testCreatePreferredLanguageSet()

CRM-14232 test preferred language returns setting if not passed.


    public
                    testCreatePreferredLanguageSet(int $version) : void

Parameters

$version : int

testCreatePreferredLanguageUnset()

CRM-14232 test preferred language set to site default if not passed.


    public
                    testCreatePreferredLanguageUnset(int $version) : void

Parameters

$version : int

testCreateWithCustom()

Check with complete array + custom field.


    public
                    testCreateWithCustom(int $version) : void

Note that the test is written on purpose without any variables specific to participant so it can be replicated into other entities and / or moved to the automated test suite

Parameters

$version : int

testCreateWithEmptyCustomCheckbox()

Test create contact with custom checkbox with empty array


    public
                    testCreateWithEmptyCustomCheckbox() : void

testCreateWithNULLCustomCRM12773()

CRM-12773 - expectation is that civicrm quietly ignores fields without values.


    public
                    testCreateWithNULLCustomCRM12773() : void

testCRM13252MultipleChainedPhones()

Test creating multiple phones using chaining.


    public
                    testCRM13252MultipleChainedPhones(int $version) : void

Parameters

$version : int

testDirectionChainingRelationshipsCRM16084()

Test for direction when chaining relationships.


    public
                    testDirectionChainingRelationshipsCRM16084(int $version) : void

https://issues.civicrm.org/jira/browse/CRM-16084

Parameters

$version : int

testDuplicateCheck()

Test the duplicate check function.


    public
                    testDuplicateCheck() : void

testDuplicateCheckRuleNotReserved()

Test the duplicate check function.


    public
                    testDuplicateCheckRuleNotReserved() : void

testEmojiInWhereClause()

Test a lack of fatal errors when the where contains an emoji.


    public
                    testEmojiInWhereClause() : void

By default our DBs are not 🦉 compliant. This test will age out when we are.

testGetActions()

Test contact getactions.


    public
                    testGetActions() : void

testGetApostropheCRM10857()

Test apostrophe works in get & create.


    public
                    testGetApostropheCRM10857(int $version) : void

Parameters

$version : int

testGetBetweenZeroWorks()

Test between accepts zero.


    public
                    testGetBetweenZeroWorks(int $version) : void

In the past it incorrectly required !empty.

Parameters

$version : int

testGetByAddresseeID()

Test retrieval by addressee id.


    public
                    testGetByAddresseeID() : void

V3 only - the "skip_greeting_processing" param is not currently in v4

testGetByContactType()

Test variants on retrieving contact by type.


    public
                    testGetByContactType() : void

testGetConflictsAggressiveMode()


    public
                    testGetConflictsAggressiveMode() : void

testGetContactsByPrivacyFlag()

CRM-14743 - test api respects search operators.


    public
                    testGetContactsByPrivacyFlag(int $version, mixed $query, mixed $field, mixed $expected) : void

Parameters

$version : int
$query : mixed
$field : mixed
$expected : mixed

testGetCreatedDateByOperators()

CRM-14743 - test api respects search operators.


    public
                    testGetCreatedDateByOperators(int $version) : void

Parameters

$version : int

testGetDeceasedRetrieved()

Check deceased contacts are not retrieved.


    public
                    testGetDeceasedRetrieved(int $version) : void

Note at time of writing the default is to return default. This should possibly be changed & test added.

Parameters

$version : int

testGetDeleted()

Test variants on deleted behaviour.


    public
                    testGetDeleted() : void

testGetEmailLike()

Test the like operator works for Contact.get


    public
                    testGetEmailLike() : void

testGetEscapedCustomField()

Test fetching custom field value that needs to be escaped.


    public
                    testGetEscapedCustomField() : void

testGetGroupIDFromContact()

Test group filter syntax.


    public
                    testGetGroupIDFromContact() : void

testGetIndividualWithChainedArrays()

Verify attempt to create individual with chained arrays.


    public
                    testGetIndividualWithChainedArrays() : void

testGetIndividualWithChainedArraysAndMultipleCustom()

Test complex chaining.


    public
                    testGetIndividualWithChainedArraysAndMultipleCustom() : void

testGetIndividualWithChainedArraysAndSequential()

Verify attempt to create individual with chained arrays and sequential.


    public
                    testGetIndividualWithChainedArraysAndSequential(int $version) : void

Parameters

$version : int

testGetIndividualWithChainedArraysFormats()

Test retrieving an individual with chained array syntax.


    public
                    testGetIndividualWithChainedArraysFormats() : void

testGetINIDArray()

Test that we can retrieve contacts using array syntax.


    public
                    testGetINIDArray(int $version) : void

I.e 'id' => array('IN' => array('3,4')).

Parameters

$version : int

testGetlistExcludeConditions()

CRM-15443 - ensure getlist api does not return deleted contacts.


    public
                    testGetlistExcludeConditions() : void

testGetlistInvalidID()

Test getlist gets an organization with a number that is not a valid organization ID.


    public
                    testGetlistInvalidID() : void

testGetMatchesPhoneWithType()

Test that duplicates can be found even when phone type is specified.


    public
                    testGetMatchesPhoneWithType(string $phoneKey) : void

Parameters

$phoneKey : string

testGetModifiedDateByOperators()

CRM-14743 - test api respects search operators.


    public
                    testGetModifiedDateByOperators(int $version) : void

Parameters

$version : int

testGetMultipleContactSubTypes()

Verify that we can retrieve contacts of different sub types


    public
                    testGetMultipleContactSubTypes(int $version) : void

Parameters

$version : int

testGetNameVariantsCaseInsensitive()

Test that name searches are case insensitive.


    public
                    testGetNameVariantsCaseInsensitive(int $version) : void

Parameters

$version : int

testGetOptions()


    public
                    testGetOptions() : void

testGetReferenceCounts()

Test get ref api - gets a list of references to an entity.


    public
                    testGetReferenceCounts() : void

testGetReturnAddress()

Check that address name, ID is returned if required.


    public
                    testGetReturnAddress() : void

testGetSort()

Test that sort works - old syntax.


    public
                    testGetSort() : void

testGetSortNewSyntax()

Test that sort works - new syntax.


    public
                    testGetSortNewSyntax(int $version) : void

Parameters

$version : int

testGetWithCustom()

Check with complete array + custom field.


    public
                    testGetWithCustom() : void

Note that the test is written on purpose without any variables specific to participant so it can be replicated into other entities and / or moved to the automated test suite

testGetWithCustomOfActivityType()

Tests that using 'return' with a custom field not of type contact does not inappropriately filter.


    public
                    testGetWithCustomOfActivityType() : void

https://lab.civicrm.org/dev/core/issues/1025

testGetWithCustomReturnSyntax()

Check with complete array + custom field.


    public
                    testGetWithCustomReturnSyntax() : void

Note that the test is written on purpose without any variables specific to participant so it can be replicated into other entities and / or moved to the automated test suite

testGreetingParseSmarty()

Test that smarty variables are parsed if they exist in the greeting template.


    public
                    testGreetingParseSmarty(int $version) : void

In this test we have both a Civi token & a Smarty token and we check both are processed.

Parameters

$version : int

testGreetingUpdates()

Test the greeting fields update sensibly.


    public
                    testGreetingUpdates() : void

testIndividualSubType()

Test civicrm_contact_create with sub-types.


    public
                    testIndividualSubType(int $version) : void

Verify that sub-types are created successfully and not deleted by subsequent updates.

Parameters

$version : int

testInternationalStrings()

Test for international string acceptance (CRM-10210).


    public
                    testInternationalStrings(string $string) : void

Requires the database to be in utf8.

Parameters

$string : string: String to be tested.

Bool to see if we should check charset.

testLoggedInUserAPISupportToken()


    public
                    testLoggedInUserAPISupportToken() : void

testMerge()

Test merging 2 contacts.


    public
                    testMerge() : void

testMergeBizarreOldParams()

Test merging 2 contacts.


    public
                    testMergeBizarreOldParams() : void

Someone kindly bequeathed us the legacy of mixed up use of main_id & other_id in the params for contact.merge api.

This test protects that legacy.

testMergeContactReferenceCustomFieldTarget()

Test merging a contact that is the target of a contact reference field on another contact.


    public
                    testMergeContactReferenceCustomFieldTarget() : void

testMergeCustomFields()

Test merging 2 contacts with custom fields.


    public
                    testMergeCustomFields() : void

testMergedGet()

Test retrieving merged contacts.


    public
                    testMergedGet() : void

The goal here is to start with a contact deleted by merged and find out the contact that is the current version of them.

testMergedGetWithPermanentlyDeletedContact()

Test retrieving merged contacts.


    public
                    testMergedGetWithPermanentlyDeletedContact() : void

The goal here is to start with a contact deleted by merged and find out the contact that is the current version of them.

testMergeGetConflicts()

Test the function that determines if 2 contacts have conflicts.


    public
                    testMergeGetConflicts() : void

testMergeMultiContactReferenceCustomFieldTarget()

Test merging a contact that is the target of a contact reference field on another contact.


    public
                    testMergeMultiContactReferenceCustomFieldTarget() : void

testMergeMultipleCustomValues()

Test merging when a multiple record set is in use.


    public
                    testMergeMultipleCustomValues() : void

testMergeNoTrash()

Test merging 2 contacts with delete to trash off.


    public
                    testMergeNoTrash() : void

We are checking that there is no error due to attempting to add an activity for the deleted contact.

testMergeOrganizations()

Test merging 2 organizations.


    public
                    testMergeOrganizations() : void

CRM-20421: This test make sure that inherited memberships are deleted upon merging organization.

testMergeWithBlankLocationData()

Test that a blank location does not overwrite a location with data.


    public
                    testMergeWithBlankLocationData(bool $isReverse) : void

This is a poor data edge case where a contact has an address record with no meaningful data. This record should be removed in favour of the one with data.

Parameters

$isReverse : bool

testPseudoFields()

Ensure consistent return format for option group fields.


    public
                    testPseudoFields() : void

testReturnCityProfile()

CRM-14263 check that API is not affected by search profile related bug.


    public
                    testReturnCityProfile() : void

testSetPreferredCommunicationNull()

Ensure consistent return format for option group fields.


    public
                    testSetPreferredCommunicationNull(int $version) : void

Parameters

$version : int

testSmartGroupsForRelatedContacts()

Test the related contacts filter.


    public
                    testSmartGroupsForRelatedContacts() : void

testSortLimitChainedRelationshipGetCRM15983()

Test sort and limit for chained relationship get.


    public
                    testSortLimitChainedRelationshipGetCRM15983(int $version) : void

https://issues.civicrm.org/jira/browse/CRM-15983

Parameters

$version : int

testSQLOperatorsOnContactAPI()

Test the use of sql operators.


    public
                    testSQLOperatorsOnContactAPI(int $version) : void

Parameters

$version : int

testUpdateCreateWithID()

Test civicrm_update() without contact type.


    public
                    testUpdateCreateWithID(int $version) : void

Deliberately exclude contact_type as it should still cope using civicrm_api.

CRM-7645.

Parameters

$version : int

testUpdateHouseholdWithAll()

Verify successful update of household contact.


    public
                    testUpdateHouseholdWithAll(int $version) : void

Parameters

$version : int

testUpdateIndividualWithAll()

Verify successful update of individual contact.


    public
                    testUpdateIndividualWithAll() : void

testUpdateOrganizationWithAll()

Verify successful update of organization contact.


    public
                    testUpdateOrganizationWithAll() : void

uFFieldCreate()

Create a UFField.


    public
                    uFFieldCreate([array<string|int, mixed> $params = [] ]) : mixed

Parameters

$params : array<string|int, mixed> = []

ufjoinCreate()

Add a UF Join Entry.


    public
                    ufjoinCreate([array<string|int, mixed>|null $params = NULL ]) : int

Parameters

$params : array<string|int, mixed>|null = NULL

Return values

int —

$id of created UF Join

unsetExtensionSystem()


    public
                    unsetExtensionSystem() : mixed

useMultilingual()

Temporarily use multilingual.


    public
                    useMultilingual(array<string|int, mixed> $addLocales) : CRM_Utils_AutoClean

Parameters

$addLocales : array<string|int, mixed>: A list of new locales to setup. A locale is initialized by copying from an existing locale.

Ex: Copy from en_US to fr_CA ['en_US' => 'fr_CA'] Ex: Copy from en_US to fr_CA and de_DE ['en_US' => ['fr_CA', 'de_DE]]

Return values

CRM_Utils_AutoClean —

A reference to the temporary configuration. Once removed, the system will revert to single language.

useTransaction()

Wrap the entire test case in a transaction.


    public
                    useTransaction([bool $nest = TRUE ]) : mixed

Only subsequent DB statements will be wrapped in TX -- this cannot retroactively wrap old DB statements. Therefore, it makes sense to call this at the beginning of setUp().

Note: Recall that TRUNCATE and ALTER will force-commit transactions, so this option does not work with, e.g., custom-data.

WISHLIST: Monitor SQL queries in unit-tests and generate an exception if TRUNCATE or ALTER is called while using a transaction.

Parameters

$nest : bool = TRUE: Whether to use nesting or reference-counting.

versionAndPrivacyOption()

Combinations of versions and privacy choices.


    public
                    versionAndPrivacyOption() : array<string|int, mixed>

Return values

array<string|int, mixed>

versionThreeAndFour()

Get the api versions to test.


    public
                    versionThreeAndFour() : array<string|int, mixed>

Return values

array<string|int, mixed>

addLocationBlockToDomain()

Add an address block to the current domain.


    protected
                    addLocationBlockToDomain() : void

addOptionToCustomField()

Add another option to the custom field.


    protected
                    addOptionToCustomField(string $key, array<string|int, mixed> $values) : int

Parameters

$key : string
$values : array<string|int, mixed>

Return values

int

addProfile()

Add a profile to a contribution page.


    protected
                    addProfile(string $name, int $contributionPageID[, string $module = 'CiviContribute' ]) : mixed

Parameters

$name : string
$contributionPageID : int
$module : string = 'CiviContribute'

addTaxAccountToFinancialType()

Add Sales Tax Account for the financial type.


    protected
                    addTaxAccountToFinancialType(int $financialTypeID[, array<string|int, mixed> $accountParams = [] ]) : CRM_Financial_DAO_EntityFinancialAccount

Parameters

$financialTypeID : int
$accountParams : array<string|int, mixed> = []

Return values

CRM_Financial_DAO_EntityFinancialAccount

assertAttachmentExistence()

Assert the attachment exists.


    protected
                    assertAttachmentExistence(bool $exists, array<string|int, mixed> $apiResult) : void

Parameters

$exists : bool
$apiResult : array<string|int, mixed>

assertLike()

Assert 2 sql strings are the same, ignoring double spaces.


    protected
                    assertLike(string $expectedSQL, string $actualSQL[, string $message = 'different sql' ]) : void

Parameters

$expectedSQL : string
$actualSQL : string
$message : string = 'different sql'

assertMailSentContainingHeaderString()

Assert that the sent mail included the supplied string.


    protected
                    assertMailSentContainingHeaderString(string $string[, int $mailIndex = 0 ]) : void

Parameters

$string : string
$mailIndex : int = 0

assertMailSentContainingHeaderStrings()

Assert that the sent mail included the supplied strings.


    protected
                    assertMailSentContainingHeaderStrings(array<string|int, mixed> $strings[, int $mailIndex = 0 ]) : void

Parameters

$strings : array<string|int, mixed>
$mailIndex : int = 0

assertMailSentContainingString()

Assert that the sent mail included the supplied string.


    protected
                    assertMailSentContainingString(string $string[, int $mailIndex = 0 ]) : void

Parameters

$string : string
$mailIndex : int = 0

assertMailSentContainingStrings()

Assert that the sent mail included the supplied strings.


    protected
                    assertMailSentContainingStrings(array<string|int, mixed> $strings[, int $mailIndex = 0 ]) : void

Parameters

$strings : array<string|int, mixed>
$mailIndex : int = 0

assertMailSentCount()

Assert the right number of mails were sent.


    protected
                    assertMailSentCount(int $count) : void

Parameters

$count : int

assertMailSentNotContainingString()

Assert that the sent mail included the supplied string.


    protected
                    assertMailSentNotContainingString(string $string[, int $mailIndex = 0 ]) : void

Parameters

$string : string
$mailIndex : int = 0

assertMailSentNotContainingStrings()

Assert that the sent mail included the supplied strings.


    protected
                    assertMailSentNotContainingStrings(array<string|int, mixed> $strings[, int $mailIndex = 0 ]) : void

Parameters

$strings : array<string|int, mixed>
$mailIndex : int = 0

assertMailSentTo()

Assert that the sent mail included the supplied strings.


    protected
                    assertMailSentTo(array<string|int, mixed> $recipients[, int $mailIndex = 0 ]) : void

Parameters

$recipients : array<string|int, mixed>
$mailIndex : int = 0

assertOutputNotContainsString()

Assert that the status set does not contain the given string.


    protected
                    assertOutputNotContainsString(string $string) : void

Parameters

$string : string

assertPostConditions()

CHeck that all tests that have created payments have created them with the right financial entities.


    protected
                    assertPostConditions() : void

assertPrematureExit()


    protected
                    assertPrematureExit() : void

assertTemplateVariable()


    protected
                    assertTemplateVariable(mixed $name, mixed $expected) : void

Parameters

$name : mixed
$expected : mixed

assertValidationError()

Assert that the sent mail included the supplied string.


    protected
                    assertValidationError(array<string|int, mixed> $errors) : void

Parameters

$errors : array<string|int, mixed>

basicCreateTest()

Generic create test.


    protected
                    basicCreateTest(int $version) : void

Parameters

$version : int

basicDeleteTest()

Generic delete test.


    protected
                    basicDeleteTest(int $version) : void

Parameters

$version : int

captureOutputToCSV()

Stop capturing browser output and return as a csv.


    protected
                    captureOutputToCSV([bool $isFirstRowHeaders = TRUE ]) : Reader

Parameters

$isFirstRowHeaders : bool = TRUE

Return values

Reader

cleanUpAfterACLs()

Reset after ACLs.


    protected
                    cleanUpAfterACLs() : mixed

cleanupCustomGroups()

Delete any existing custom data groups.


    protected
                    cleanupCustomGroups() : void

cleanUpSetUpIDs()

Cleanup function for contents of $this->ids.


    protected
                    cleanUpSetUpIDs() : mixed

This is a best effort cleanup to use in tear downs etc.

It will not fail if the data has already been removed (some tests may do their own cleanup).

createAutoCompleteCustomField()

Create custom select field.


    protected
                    createAutoCompleteCustomField(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createBooleanCustomField()

Create a custom text fields.


    protected
                    createBooleanCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createContactReferenceCustomField()

Create a custom text fields.


    protected
                    createContactReferenceCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createCountryCustomField()

Create a custom country fields.


    protected
                    createCountryCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createDateCustomField()

Create a custom field of type date.


    protected
                    createDateCustomField(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

createDeeplyConflictedContacts()

Create pair of contacts with multiple conflicts.


    protected
                    createDeeplyConflictedContacts() : array<string|int, mixed>

Return values

array<string|int, mixed>

createFileCustomField()

Create a custom text fields.


    protected
                    createFileCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createFinancialType()

Create Financial Type.


    protected
                    createFinancialType([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>

createIntCustomField()

Create a custom text fields.


    protected
                    createIntCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createIntegerRadioCustomField()

Create a custom field of type radio with integer values.


    protected
                    createIntegerRadioCustomField(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

createLinkCustomField()

Create a custom text fields.


    protected
                    createLinkCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createMoneyTextCustomField()

Create a custom field of type money.


    protected
                    createMoneyTextCustomField(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

createMultiCountryCustomField()

Create a custom multi select country fields.


    protected
                    createMultiCountryCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createMultiStateCustomField()

Create a custom multi select state fields.


    protected
                    createMultiStateCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createPartiallyPaidParticipantOrder()

Add participant with contribution


    protected
                    createPartiallyPaidParticipantOrder() : array<string|int, mixed>

Return values

array<string|int, mixed>

createPriceSet()

Create price set that includes one price field with two option values.


    protected
                    createPriceSet([string $component = 'contribution_page' ][, int|null $componentID = NULL ][, array<string|int, mixed> $priceFieldOptions = [] ][, string $identifier = 'price_set_test' ]) : array<string|int, mixed>

Parameters

$component : string = 'contribution_page'
$componentID : int|null = NULL
$priceFieldOptions : array<string|int, mixed> = []
$identifier : string = 'price_set_test'

Return values

array<string|int, mixed> —

the result of API3 PriceFieldValue.get for the new PriceField

createRuleGroup()


    protected
                    createRuleGroup() : array<string|int, mixed>|int

Return values

array<string|int, mixed>|int

createSelectCustomField()

Create custom select field.


    protected
                    createSelectCustomField(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createStateCustomField()

Create a custom state fields.


    protected
                    createStateCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

createStringCheckboxCustomField()

Create a custom field of type radio with integer values.


    protected
                    createStringCheckboxCustomField(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

createTextCustomField()

Create a custom text fields.


    protected
                    createTextCustomField([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Parameter overrides, must include custom_group_id.

Return values

array<string|int, mixed>

deleteNonDefaultRelationshipTypes()

Delete any extraneous relationship types.


    protected
                    deleteNonDefaultRelationshipTypes() : void

disableTaxAndInvoicing()

Enable Tax and Invoicing


    protected
                    disableTaxAndInvoicing() : void

disorganizeOptionValues()

Disorganize our option values to ensure we are not relying on luck.


    protected
                    disorganizeOptionValues() : void

For example our contributions and recurring contributions use different option groups for contribution_status_id but by happy co-incidence (ahem) both have 1 for completed by default. This upsets that co-incidence for more robust testing. Ideally we would do this for all tests & for a range of values but there is too much hard-coding to roll that out right now.

doMerge()

Do the merge on the 2 contacts.


    protected
                    doMerge([bool $isReverse = FALSE ]) : array<string|int, mixed>|int

Parameters

$isReverse : bool = FALSE

Return values

array<string|int, mixed>|int

enableTaxAndInvoicing()

Enable Tax and Invoicing


    protected
                    enableTaxAndInvoicing([array<string|int, mixed> $params = [] ]) : void

Parameters

$params : array<string|int, mixed> = []

ensureMembershipPriceSetExists()

Ensure the default price set & field exist for memberships.


    protected
                    ensureMembershipPriceSetExists() : void

ensureMySQLMode()

Ensure the specified mysql mode/s are activated.


    protected
                    ensureMySQLMode(array<string|int, mixed> $modes) : void

Parameters

$modes : array<string|int, mixed>

eventCreatePaid()

Create a paid event.


    protected
                    eventCreatePaid([array<string|int, mixed> $eventParameters = [] ][, array<string|int, mixed> $priceSetParameters = [] ][, string $identifier = 'PaidEvent' ]) : array<string|int, mixed>

Parameters

$eventParameters : array<string|int, mixed> = []: Values to
$priceSetParameters : array<string|int, mixed> = []
$identifier : string = 'PaidEvent': Index for storing event ID in ids array.

Return values

array<string|int, mixed>

eventCreateUnpaid()

Create an unpaid event.


    protected
                    eventCreateUnpaid([array<string|int, mixed> $eventParameters = [] ][, string $identifier = 'event' ]) : array<string|int, mixed>

Parameters

$eventParameters : array<string|int, mixed> = []: Values to
$identifier : string = 'event': Index for storing event ID in ids array.

Return values

array<string|int, mixed>

eventPriceSetCreate()

Create a price set for an event.


    protected
                    eventPriceSetCreate(float $feeTotal[, float $minAmt = 0 ][, string $type = 'Text' ][, array<string|int, mixed> $options = [['name' => 'hundred', 'amount' => 100]] ]) : int

Parameters

$feeTotal : float
$minAmt : float = 0
$type : string = 'Text'
$options : array<string|int, mixed> = [['name' => 'hundred', 'amount' => 100]]

Return values

int —

Price Set ID.

flushFinancialTypeStatics()

Flush statics relating to financial type.


    protected
                    flushFinancialTypeStatics() : void

formatMoneyInput()

Format money as it would be input.


    protected
                    formatMoneyInput(string $amount) : string

Parameters

$amount : string

Return values

string

getAvailableFieldCombinations()

Get data available for custom fields.


    protected
                    getAvailableFieldCombinations() : array<string|int, mixed>

The 'default' key holds general values. Where more than one html type is an option then the any values that differ to the defaults are keyed by html key.

The order below is consistent with the UI.

Return values

array<string|int, mixed>

getContributionObject()

Get the contribution object.


    protected
                    getContributionObject(int $contributionID) : CRM_Contribute_BAO_Contribution

Parameters

$contributionID : int

Return values

CRM_Contribute_BAO_Contribution

getCustomFieldColumnName()

Get the the column name for the identified custom field.


    protected
                    getCustomFieldColumnName(string $key) : string

Parameters

$key : string: Identifier - generally keys map to data type - eg. 'text', 'int' etc.

Return values

string

getCustomFieldID()

Get the custom field name for the relevant key.


    protected
                    getCustomFieldID(string $key) : string

e.g returns 'custom_5' where 5 is the id of the field using the key.

Generally keys map to data types.

Parameters

$key : string

Return values

string

getCustomFieldName()

Get the custom field name for the relevant key.


    protected
                    getCustomFieldName([string $key = 'text' ][, int $version = 3 ]) : string

e.g returns 'custom_5' where 5 is the id of the field using the key.

Generally keys map to data types.

Parameters

$key : string = 'text'
$version : int = 3

Return values

string

getDefaultSystemLocale()

Get the default system locale.


    protected
                    getDefaultSystemLocale() : string

Return values

string

getDeprecatedProperty()

Retrieve a deprecated property, ensuring a deprecation notice is thrown.


    protected
                    getDeprecatedProperty(string $property) : mixed

Parameters

$property : string

getEntity()

Get the entity being acted on.


    protected
                    getEntity() : string

Return values

string

getEvent()

This retrieves the values used to create the event.


    protected
                    getEvent(string $identifier) : array<string|int, mixed>

Note this does not actually retrieve the event from the database although it arguably might be more useful.

Parameters

$identifier : string

Return values

array<string|int, mixed>

getEventExampleData()

Get example data with which to create the event.


    protected
                    getEventExampleData([string $name = 'PaidEvent' ]) : array<string|int, mixed>

Parameters

$name : string = 'PaidEvent'

Return values

array<string|int, mixed>

getEventID()

Get the event id of the event created in set up.


    protected
                    getEventID([string $identifier = 'event' ]) : int

If only one has been created it will be selected. Otherwise you should pass in the appropriate identifier.

Parameters

$identifier : string = 'event'

Return values

int

getEventValue()

Get a value from an event used in setup.


    protected
                    getEventValue(string $value, string $identifier) : mixed|null

Parameters

$value : string
$identifier : string

Return values

mixed|null

getExampleData()

Get example data.


    protected
                    getExampleData(string $entity, string $name) : array<string|int, mixed>

Parameters

$entity : string
$name : string

Return values

array<string|int, mixed>

getOptionGroupID()

Get the option group id of the created field.


    protected
                    getOptionGroupID(string $key) : string

Parameters

$key : string

Return values

string

getOptionGroupName()

Get the option group id of the created field.


    protected
                    getOptionGroupName(string $key) : string

Parameters

$key : string

Return values

string

getParticipantOrderParams()

Get parameters to set up a multi-line participant order.


    protected
                    getParticipantOrderParams() : array<string|int, mixed>

Return values

array<string|int, mixed>

getPriceFieldOptions()

Get the options for the price set.


    protected
                    getPriceFieldOptions([string $identifier = 'PaidEvent' ]) : array<string|int, array<string|int, mixed>>

Parameters

$identifier : string = 'PaidEvent': Optional string if we want to specify different options. This is not currently used but is consistent with our other functions and would allow over-riding.

Return values

array<string|int, array<string|int, mixed>>

getRenderedFormContents()

Get the rendered contents from a form.


    protected
                    getRenderedFormContents(string $formName) : false|string

Parameters

$formName : string

Return values

false|string

getTablesWithData()

Get an array of tables with rows - useful for diagnosing cleanup issues.


    protected
                    getTablesWithData() : array<string|int, mixed>

Return values

array<string|int, mixed>

loadXMLDataSet()

Load the data that used to be handled by the discontinued dbunit class.


    protected
                    loadXMLDataSet(string $fileName) : mixed

This could do with further tidy up - the initial priority is simply to get rid of the dbunity package which is no longer supported.

Parameters

$fileName : string

organizeOptionValues()

This undoes the `disorganizeOptionValues` function.


    protected
                    organizeOptionValues() : void

prepareForACLs()

Prepare class for ACLs.


    protected
                    prepareForACLs() : void

putGroupContactCacheInClearableState()


    protected
                    putGroupContactCacheInClearableState(mixed $groupID, mixed $contact) : void

Parameters

$groupID : mixed
$contact : mixed

renameLabels()

Rename various labels to not match the names.


    protected
                    renameLabels() : mixed

Doing these mimics the fact the name != the label in international installs & triggers failures in code that expects it to.

resetHooks()

Reset any registered hooks.


    protected
                    resetHooks() : void

resetLabels()

Undo any label renaming.


    protected
                    resetLabels() : mixed

revertSetting()


    protected
                    revertSetting(string $setting) : void

Parameters

$setting : string

revertTemplateToReservedTemplate()

Reinstate the default template.


    protected
                    revertTemplateToReservedTemplate() : void

runApi4LegacyChain()


    protected
                    runApi4LegacyChain(string $key, mixed $params, string $mainEntity, array<string|int, mixed> $result, bool $sequential) : array<string|int, mixed>

Parameters

$key : string
$params : mixed
$mainEntity : string
$result : array<string|int, mixed>
$sequential : bool

Return values

array<string|int, mixed>

runTest()

Override to run the test and assert its state.


    protected
                    runTest() : mixed

setCurrencySeparators()

Set the separators for thousands and decimal points.


    protected
                    setCurrencySeparators(string $thousandSeparator) : void

Note that this only covers some common scenarios.

Most notably it tests our legacy way of setting currency separators.

It is now preferred to use the locale instead. This test disables partial_locales in order to test our legacy method.

Parameters

$thousandSeparator : string

setDefaultCurrency()

Sets the default currency.


    protected
                    setDefaultCurrency(string $currency) : void

Parameters

$currency : string

setMonetaryDecimalPoint()

Sets the decimal separator.


    protected
                    setMonetaryDecimalPoint(string $decimalPoint) : void

If you use this function also set the thousand separator setMonetaryDecimalPoint

Parameters

$decimalPoint : string

setMonetaryThousandSeparator()

Sets the thousand separator.


    protected
                    setMonetaryThousandSeparator(mixed $thousandSeparator) : void

If you use this function also set the decimal separator: setMonetaryDecimalSeparator

Parameters

$thousandSeparator : mixed

setPermissions()

Set the permissions to the supplied array.


    protected
                    setPermissions(array<string|int, mixed> $permissions) : void

Parameters

$permissions : array<string|int, mixed>

startCapturingOutput()

Start capturing browser output.


    protected
                    startCapturingOutput() : mixed

The starts the process of browser output being captured, setting any variables needed for e-notice prevention.

swapMessageTemplateForInput()

Replace the template with a test-oriented template designed to show all the variables.


    protected
                    swapMessageTemplateForInput(string $templateName, string $input[, string $type = 'html' ]) : void

Parameters

$templateName : string
$input : string
$type : string = 'html'

swapMessageTemplateForTestTemplate()

Replace the template with a test-oriented template designed to show all the variables.


    protected
                    swapMessageTemplateForTestTemplate([string $templateName = 'contribution_online_receipt' ][, string $type = 'html' ]) : void

Parameters

$templateName : string = 'contribution_online_receipt'
$type : string = 'html'

updateEvent()

Update an event.


    protected
                    updateEvent([array<string|int, mixed> $eventParameters = [] ][, string $identifier = 'event' ]) : void

Parameters

$eventParameters : array<string|int, mixed> = []: Values to
$identifier : string = 'event': Index for storing event ID in ids array.

useFrozenTime()

Temporarily freeze time, as perceived through `CRM_Utils_Time`.


    protected
                    useFrozenTime() : void

validateAllContributions()

Validate all created contributions.


    protected
                    validateAllContributions() : void

validateAllPayments()

Validate all created payments.


    protected
                    validateAllPayments() : void

validateContactField()


    protected
                    validateContactField(string $fieldName, mixed $expected, int|null $contactID[, array<string|int, mixed>|null $criteria = NULL ]) : void

Parameters

$fieldName : string
$expected : mixed
$contactID : int|null
$criteria : array<string|int, mixed>|null = NULL

validatePayments()


    protected
                    validatePayments(mixed $payments) : void

Parameters

$payments : mixed

_contactCreate()

Private helper function for calling civicrm_contact_add.


    private
                    _contactCreate(array<string|int, mixed> $params[, string $identifier = 'Contact' ]) : int

Parameters

$params : array<string|int, mixed>: For civicrm_contact_add api function call.
$identifier : string = 'Contact'

Return values

int —

id of contact created

addProfilesToEvent()

Add profiles to the event.


    private
                    addProfilesToEvent([string $identifier = 'event' ]) : void

This function is designed to reflect the normal use case where events do have profiles.

Note if any classes do not want profiles, or want something different, the thinking is they should override this. Once that arises we can review making it protected rather than private & checking we are happy with the signature.

Parameters

$identifier : string = 'event'

createEmployerOfMembership()

Create inherited membership type for employer relationship.


    private
                    createEmployerOfMembership() : array<string|int, mixed>

Return values

array<string|int, mixed>

createEventProfile()

Create a profile attached to an event.


    private
                    createEventProfile(array<string|int, mixed> $profile, string $identifier[, bool $isAdditional = FALSE ]) : void

Parameters

$profile : array<string|int, mixed>
$identifier : string
$isAdditional : bool = FALSE

eventCreatePriceSet()

Create a price set for an event.


    private
                    eventCreatePriceSet(array<string|int, mixed> $priceSetParameters, string $identifier) : void

Parameters

$priceSetParameters : array<string|int, mixed>
$identifier : string

unsetID()

Unset the key 'id' from the array


    private
                    unsetID(array<string|int, mixed> &$unformattedArray) : void

Parameters

$unformattedArray : array<string|int, mixed>: The array from which the 'id' has to be unset.

api_v3_ContactTest extends CiviUnitTestCase in package CiviCRM APIv3 API Contact uses CRMTraits_Custom_CustomDataTrait

Tags

Table of Contents

Properties

Methods

Properties

$apiversion

$hookClass

$setupIDs

$_apiversion

$_contactID

$_entity

$_financialTypeId

$_params

$_tablesToTruncate

$entity

$formController

$ids

$isGetSafe

$isLocationTypesOnPostAssert

$isValidateFinancialsOnPostAssert

$origExtensionSystem

$originalSettings

$tempDirs

$errorHandlerAtStartOfTest

$form

$frozenTime

$page

$tx

Methods

__construct()

Parameters

_checkFinancialRecords()

Parameters

aclWhereNoBobH()

Parameters

Tags

activityCreate()

Parameters

Return values

addDiscountPriceSet()

Parameters

Tags

assertAPIArrayComparison()

Parameters

assertAPIDeleted()

Parameters

assertAPIFailure()

Parameters

assertAPISuccess()

Parameters

assertApproxEquals()

Parameters

assertArrayKeyExists()

Parameters

assertArrayValueNotNull()

Parameters

assertArrayValuesEqual()

Parameters

assertAttributesEquals()

Parameters

Tags

assertDBCompareValue()

Parameters

assertDBCompareValues()

Parameters

assertDBNotNull()

Parameters

Tags

Return values

assertDBNull()

Parameters

assertDBQuery()

Parameters

Tags

assertDBRowExist()

Parameters

assertDBRowNotExist()

Parameters

assertDBState()

api_v3_ContactTest extends CiviUnitTestCase
in package

CiviCRM

APIv3

API

Contact

uses CRMTraits_Custom_CustomDataTrait