Documentation

CiviCRM

APIv3

Packages

API

Classes

api_v3_ActivityCaseTest: Test Activity.get API with the case_id field
api_v3_AddressTest: Class api_v3_AddressTest
api_v3_APITest: Test class for API functions.
api_v3_APIWrapperTest: Test class for API functions
api_v3_BatchTest: Test class for Batch API - civicrm_batch_*
api_v3_CaseContactTest: Test APIv3 civicrm_case_* functions
api_v3_CaseTest: Test APIv3 civicrm_case_* functions
class_api_test: Test class for class.api.php
api_v3_CustomApiTest: Test class for API functions.
api_v3_EntityBatchTest: Test APIv3 civicrm_entity_batch_* functions
api_v3_EntityJoinTest: Test APIv3 ability to join across multiple entities
api_v3_EntityTagACLTest: Class api_v3_EntityTagTest.
api_v3_EntityTagTest: Class api_v3_EntityTagTest.
api_v3_ExceptionTest: Test class for Dedupe exceptions.
api_v3_ExtensionTest: Class api_v3_ExtensionTest.
api_v3_FinancialTypeTest: Base class for CiviCRM unit tests
api_v3_GroupTest: Test class for Group API - civicrm_group_*
api_v3_JobProcessMailingTest: Class api_v3_JobTest
api_v3_JobProcessMembershipTest: Class api_v3_JobProcessMembershipTest
api_v3_JobTest: Class api_v3_JobTest
api_v3_JobTestCustomDataTest: Tests for job api where custom data is involved.
api_v3_MailingContactTest: Class api_v3_MailingContactTest
api_v3_MessageTemplateTest: Test class for Template API - civicrm_msg_template*
api_v3_ParticipantTest: Class api_v3_ParticipantTest
api_v3_PcpTest: All API should contain at minimum a success test for each function - in this case - create, get & delete In addition any extra functionality should be tested & documented
api_v3_PledgePaymentTest: Test class for Pledge API - civicrm_pledge_*
api_v3_PledgeTest: Test class for Pledge API - civicrm_pledge_*
api_v3_SavedSearchTest: Class api_v3_SavedSearchTest
api_v3_SelectQueryTest: Test APIv3 ability to join across multiple entities
api_v3_SettingTest: Class contains api test cases for civicrm settings
api_v3_StatusPreferenceTest: Class api_v3_StatusPreferenceTest
api_v3_SurveyTest: All API should contain at minimum a success test for each function - in this case - create, get & delete In addition any extra functionality should be tested & documented
api_v3_SystemCheckTest: System.check API has many special test cases, so they have their own class.
api_v3_ValidateTest: Tests for the generic validate API action.
CRM_Mailing_MailingSystemTest: Class CRM_Mailing_MailingSystemTest.
CRM_Mailing_MailingSystemTestBase: Class CRM_Mailing_MailingSystemTest
CRM_SMS_ProviderTest: Base class for CiviCRM unit tests

Functions

civicrm_api() : array<string|int, mixed>|int|Result: The original API wrapper.
civicrm_api4() : Result: CiviCRM API version 4.
civicrm_api3() : array<string|int, mixed>|int: Version 3 wrapper for civicrm_api.
_civicrm_api3_api_getfields() : array<string|int, mixed>: Call getfields from api wrapper.
civicrm_error() : bool: Check if the result is an error. Note that this function has been retained from api v2 for convenience but the result is more standardised in v3 and param 'format.is_success' => 1 will result in a boolean success /fail being returned if that is what you need.
_civicrm_api_get_camel_name() : string|null: Get camel case version of entity name.
_civicrm_api_replace_variables() : mixed: Swap out any $values vars.
_civicrm_api_replace_variable() : mixed|null: Swap out a $value.foo variable with the value from parent api results.
_civicrm_api_get_entity_name_from_camel() : string: Convert possibly camel name to underscore separated entity name.
_civicrm_api_get_entity_name_from_dao() : string: Having a DAO object find the entity name.
civicrm_api3_acl_create() : array<string|int, mixed>: Save an Acl.
_civicrm_api3_acl_create_spec() : mixed: Acl create metadata.
civicrm_api3_acl_get() : array<string|int, mixed>: Get an Acl.
civicrm_api3_acl_delete() : array<string|int, mixed>: Delete an Acl.
civicrm_api3_acl_role_create() : array<string|int, mixed>: Save an AclRole.
_civicrm_api3_acl_role_create_spec() : mixed: AclRole create metadata.
civicrm_api3_acl_role_get() : array<string|int, mixed>: Get an AclRole.
civicrm_api3_acl_role_delete() : array<string|int, mixed>: Delete an AclRole.
civicrm_api3_action_schedule_get() : array<string|int, mixed>: Get CiviCRM ActionSchedule details.
civicrm_api3_action_schedule_create() : array<string|int, mixed>: Create a new ActionSchedule.
_civicrm_api3_action_schedule_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_action_schedule_delete() : array<string|int, mixed>: Delete an existing ActionSchedule.
civicrm_api3_activity_create() : array<string|int, mixed>: Creates or updates an Activity.
_civicrm_api3_activity_create_spec() : mixed: Specify Meta data for create.
_civicrm_api3_activity_get_spec() : mixed: Specify Metadata for get.
civicrm_api3_activity_get() : array<string|int, mixed>: Gets a CiviCRM activity according to parameters.
_civicrm_activity_get_handleSourceContactNameOrderBy() : mixed: Handle source_contact_name as a sort parameter.
_civicrm_api3_activity_get_extraFilters() : mixed: Support filters beyond what basic_get can do.
_civicrm_api3_activity_get_formatResult() : array<string|int, mixed>: Given a list of activities, append any extra data requested about the activities.
_civicrm_api3_activity_fill_activity_contact_names() : mixed: Append activity contact details to activity results.
civicrm_api3_activity_delete() : array<string|int, mixed>: Delete a specified Activity.
_civicrm_api3_activity_check_params() : array<string|int, mixed>: Check for required params.
_civicrm_api3_activity_getlist_params() : mixed: Get parameters for activity list.
_civicrm_api3_activity_getlist_output() : array<string|int, mixed>: Get output for activity list.
civicrm_api3_activity_contact_create() : array<string|int, mixed>: Add a record relating a contact with an activity.
_civicrm_api3_activity_contact_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_activity_contact_delete() : array<string|int, mixed>: Delete an existing ActivityContact record.
civicrm_api3_activity_contact_get() : array<string|int, mixed>: Get a ActivityContact.
_civicrm_api3_activity_type_deprecation() : string: Notification of deprecated function.
civicrm_api3_activity_type_get() : array<string|int, mixed>: Retrieve activity types.
civicrm_api3_activity_type_create() : array<string|int, mixed>: Create activity type.
_civicrm_api3_activity_type_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_activity_type_delete() : array<string|int, mixed>: Delete ActivityType.
civicrm_api3_address_create() : array<string|int, mixed>: Add an Address for a contact.
_civicrm_api3_address_create_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_address_get_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_address_delete() : array<string|int, mixed>: Delete an existing Address.
civicrm_api3_address_get() : array<string|int, mixed>: Retrieve one or more addresses.
_civicrm_api3_attachment_create_spec() : mixed: Adjust metadata for "create" action.
civicrm_api3_attachment_create() : array<string|int, mixed>: Create an Attachment.
_civicrm_api3_attachment_get_spec() : mixed: Adjust metadata for get action.
civicrm_api3_attachment_get() : array<string|int, mixed>: Get Attachment.
_civicrm_api3_attachment_delete_spec() : mixed: Adjust metadata for Attachment delete action.
civicrm_api3_attachment_delete() : array<string|int, mixed>: Delete Attachment.
__civicrm_api3_attachment_find() : CRM_Core_DAO: Attachment find helper.
_civicrm_api3_attachment_parse_params() : array<string|int, mixed>: Attachment parsing helper.
_civicrm_api3_attachment_format_result() : array<string|int, mixed>: Attachment result formatting helper.
_civicrm_api3_attachment_getfields() : array<string|int, mixed>: Attachment getfields helper.
civicrm_api3_batch_create() : array<string|int, mixed>: Save a Batch.
_civicrm_api3_batch_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_batch_get() : array<string|int, mixed>: Get a Batch.
civicrm_api3_batch_delete() : array<string|int, mixed>: Delete a Batch.
civicrm_api3_campaign_create() : array<string|int, mixed>: Create/update Campaign.
_civicrm_api3_campaign_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_campaign_get() : array<string|int, mixed>: Returns array of campaigns matching a set of one or more properties.
civicrm_api3_campaign_delete() : array<string|int, mixed>: Delete an existing campaign.
_civicrm_api3_campaign_getlist_params() : mixed: Get campaign list parameters.
_civicrm_api3_campaign_getlist_output() : array<string|int, mixed>: Get campaign list output.
civicrm_api3_case_create() : array<string|int, mixed>: Open a new case, add client and manager roles, and standard timeline.
_civicrm_api3_case_create_xmlProcessor() : mixed: When creating a new case, run the xmlProcessor to get all necessary params/configuration for the new case, as cases use an xml file to store their configuration.
_civicrm_api3_case_get_spec() : mixed: Adjust Metadata for Get Action.
_civicrm_api3_case_create_spec() : mixed: Adjust Metadata for Create Action.
_civicrm_api3_case_update_spec() : mixed: Adjust Metadata for Update action.
_civicrm_api3_case_delete_spec() : mixed: Adjust Metadata for Delete action.
civicrm_api3_case_get() : array<string|int, mixed>: Get details of a particular case, or search for cases, depending on params.
civicrm_api3_case_activity_create() : array<string|int, mixed>: Deprecated API.
civicrm_api3_case_addtimeline() : array<string|int, mixed>: Add a timeline to a case.
_civicrm_api3_case_addtimeline_spec() : mixed: Adjust Metadata for addtimeline action.
civicrm_api3_case_merge() : array<string|int, mixed>: Merge 2 cases.
_civicrm_api3_case_merge_spec() : mixed: Adjust Metadata for merge action.
_civicrm_api3_case_deprecation() : array<string|int, mixed>: Declare deprecated api functions.
civicrm_api3_case_update() : array<string|int, mixed>
civicrm_api3_case_delete() : mixed: Delete a specified case.
_civicrm_api3_case_restore_spec() : void: Case.restore API specification
civicrm_api3_case_restore() : mixed: Restore a specified case from the trash.
_civicrm_api3_case_read() : mixed: Augment case results with extra data.
_civicrm_api3_case_format_params() : mixed: Internal function to format create params for processing.
civicrm_api3_case_getList() : mixed: It actually works a lot better to use the CaseContact api instead of the Case api for entityRef fields so we can perform the necessary joins, so we pass off getlist requests to the CaseContact api.
_civicrm_api3_case_getlist_spec() : mixed: Needed due to the above override
civicrm_api3_case_getoptions() : mixed
civicrm_api3_case_contact_create() : array<string|int, mixed>: Save a CaseContact.
_civicrm_api3_case_contact_create_spec() : mixed
civicrm_api3_case_contact_get() : array<string|int, mixed>: Get a CaseContact.
civicrm_api3_case_contact_delete() : array<string|int, mixed>: Delete a CaseContact.
_civicrm_api3_case_contact_getlist_output() : array<string|int, mixed>: Results formatting for Case entityRef lookups.
civicrm_api3_case_type_create() : array<string|int, mixed>: Create or update case type.
civicrm_api3_case_type_get() : array<string|int, mixed>: Retrieve case types.
_civicrm_api3_case_type_get_formatResult() : array<string|int, mixed>: Format definition.
civicrm_api3_case_type_delete() : array<string|int, mixed>: Function to delete case type.
_civicrm_api3_constant_deprecation() : string: Declare deprecated api entity.
civicrm_api3_constant_get() : array<string|int, mixed>: Get constant values (deprecated).
_civicrm_api3_constant_get_spec() : mixed: Adjust metadata for constant get action.
civicrm_api3_contact_create() : array<string|int, mixed>: Create or update a Contact.
_civicrm_api3_contact_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_contact_get() : array<string|int, mixed>: Retrieve one or more contacts, given a set of search params.
civicrm_api3_contact_getcount() : int: Get number of contacts matching the supplied criteria.
_civicrm_api3_contact_get_spec() : mixed: Adjust Metadata for Get action.
_civicrm_api3_contact_get_supportanomalies() : mixed: Support for historical oddities.
civicrm_api3_contact_delete() : array<string|int, mixed>: Delete a Contact with given contact_id.
_civicrm_api3_contact_check_params() : null: Check parameters passed in.
_civicrm_api3_contact_update() : CRM_Contact_BAO_Contact|CRM_Core_Error: Helper function for Contact create.
_civicrm_api3_greeting_format_params() : mixed: Validate the addressee or email or postal greetings.
_civicrm_api3_quicksearch_get_order_by() : string: Get the order by string for the quicksearch query.
civicrm_api3_contact_merge() : array<string|int, mixed>: Merges given pair of duplicate contacts.
_civicrm_api3_contact_merge_spec() : mixed: Adjust metadata for contact_merge api function.
civicrm_api3_contact_get_merge_conflicts() : array<string|int, mixed>: Determines if given pair of contaacts have conflicts that would affect merging them.
_civicrm_api3_contact_get_merge_conflicts_spec() : mixed: Adjust metadata for contact_merge api function.
civicrm_api3_contact_getmergedto() : array<string|int, mixed>: Get the ultimate contact a contact was merged to.
_civicrm_api3_contact_getmergedto() : int|false: Get the contact our contact was finally merged to.
_civicrm_api3_contact_getmergedto_spec() : mixed: Adjust metadata for contact_merge api function.
civicrm_api3_contact_getmergedfrom() : array<string|int, mixed>: Get the ultimate contact a contact was merged to.
_civicrm_api3_contact_getmergedfrom() : array<string|int, mixed>: Get all the contacts merged into our contact.
_civicrm_api3_contact_getmergedfrom_spec() : mixed: Adjust metadata for contact_merge api function.
_civicrm_api3_contact_proximity_spec() : mixed: Adjust metadata for contact_proximity api function.
civicrm_api3_contact_proximity() : array<string|int, mixed>: Get contacts by proximity.
_civicrm_api3_contact_getlist_params() : mixed: Get parameters for getlist function.
_civicrm_api3_contact_getlist_output() : array<string|int, mixed>: Get output for getlist function.
civicrm_api3_contact_duplicatecheck() : array<string|int, mixed>: Check for duplicate contacts.
_civicrm_api3_contact_duplicatecheck_spec() : mixed: Declare metadata for contact dedupe function.
civicrm_api3_contact_type_create() : array<string|int, mixed>: Create/update ContactType.
civicrm_api3_contact_type_get() : array<string|int, mixed>: Returns array of contact_types matching a set of one or more properties.
civicrm_api3_contact_type_delete() : array<string|int, mixed>: Delete an existing ContactType.
_civicrm_api3_contribution_transact_spec() : mixed: Adjust Metadata for Transact action.
civicrm_api3_contribution_transact() : array<string|int, mixed>: Process a transaction and record it against the contact.
civicrm_api3_contribution_create() : array<string|int, mixed>: Add or update a Contribution.
_civicrm_api3_contribution_create_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_contribution_create_legacy_support_45() : mixed: Support for schema changes made in 4.5.
civicrm_api3_contribution_delete() : array<string|int, mixed>: Delete a Contribution.
_civicrm_api3_contribution_delete_spec() : mixed: Modify metadata for delete action.
civicrm_api3_contribution_get() : array<string|int, mixed>: Retrieve a set of contributions.
_civicrm_api3_contribution_get_support_nonunique_returns() : array<string|int, mixed>: Fix the return values to reflect cases where the schema has been changed.
_civicrm_api3_contribution_add_supported_fields() : mixed: Support for supported output variables.
civicrm_api3_contribution_getcount() : int: Get number of contacts matching the supplied criteria.
_civicrm_api3_format_soft_credit() : mixed: This function is used to format the soft credit for backward compatibility.
_civicrm_api3_contribution_get_spec() : mixed: Adjust Metadata for Get action.
_civicrm_api3_contribute_format_params() : array<string|int, mixed>: Legacy handling for contribution parameters.
civicrm_api3_contribution_sendconfirmation() : mixed: Send a contribution confirmation (receipt or invoice).
_civicrm_api3_contribution_sendconfirmation_spec() : mixed: Adjust Metadata for sendconfirmation action.
civicrm_api3_contribution_completetransaction() : array<string|int, mixed>: Complete an existing (pending) transaction.
_civicrm_api3_contribution_completetransaction_spec() : mixed: Provide function metadata.
civicrm_api3_contribution_repeattransaction() : array<string|int, mixed>: Complete an existing (pending) transaction.
_civicrm_api3_contribution_repeattransaction_spec() : mixed: Provide function metadata.
_civicrm_api3_contribution_deprecation() : array<string|int, mixed>: Declare deprecated functions.
civicrm_api3_contribution_page_create() : array<string|int, mixed>: Create or update a ContributionPage.
_civicrm_api3_contribution_page_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_contribution_page_get() : array<string|int, mixed>: Returns array of ContributionPage(s) matching a set of one or more group properties.
civicrm_api3_contribution_page_delete() : array<string|int, mixed>: Delete an existing ContributionPage.
civicrm_api3_contribution_page_submit() : array<string|int, mixed>: Submit a ContributionPage.
civicrm_api3_contribution_page_validate() : array<string|int, mixed>: Validate ContributionPage submission parameters.
_civicrm_api3_contribution_page_validate_spec() : mixed: Metadata for validate action.
_civicrm_api3_contribution_page_getlist_defaults() : array<string|int, mixed>: Set default getlist parameters.
_civicrm_api3_contribution_page_deprecation() : array<string|int, mixed>
civicrm_api3_contribution_product_create() : array<string|int, mixed>: Save a contribution product.
civicrm_api3_contribution_product_get() : array<string|int, mixed>: Get a contribution product.
civicrm_api3_contribution_product_delete() : array<string|int, mixed>: Delete a contribution product.
civicrm_api3_contribution_recur_create() : array<string|int, mixed>: Create or update a ContributionRecur.
_civicrm_api3_contribution_recur_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_contribution_recur_get() : array<string|int, mixed>: Returns array of contribution_recurs matching a set of one or more group properties.
civicrm_api3_contribution_recur_cancel() : array<string|int, mixed>: Cancel a recurring contribution of existing ContributionRecur given its id.
_civicrm_api3_contribution_recur_cancel_spec() : mixed: Adjust Metadata for Cancel action.
civicrm_api3_contribution_recur_delete() : array<string|int, mixed>: Delete an existing ContributionRecur.
civicrm_api3_contribution_soft_create() : array<string|int, mixed>: Create or Update a Soft Credit.
_civicrm_api3_contribution_soft_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_contribution_soft_delete() : array<string|int, mixed>: Deletes an existing Soft Credit.
civicrm_api3_contribution_soft_get() : array<string|int, mixed>: Retrieve one or more Soft Credits.
civicrm_api3_country_create() : array<string|int, mixed>: Add an Country for a contact.
_civicrm_api3_country_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_country_delete() : array<string|int, mixed>: Deletes an existing Country.
civicrm_api3_country_get() : array<string|int, mixed>: Retrieve one or more countryies.
civicrm_api3_custom_field_create() : array<string|int, mixed>: Create a 'custom field' within a custom field group.
_civicrm_api3_custom_field_flush_static_caches() : mixed: Flush static caches in functions that might have stored available custom fields.
_civicrm_api3_custom_field_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_custom_field_delete() : array<string|int, mixed>: Use this API to delete an existing custom field.
civicrm_api3_custom_field_get() : array<string|int, mixed>: Use this API to get existing custom fields.
_civicrm_api3_custom_field_validate_field() : array<string|int, mixed>|null: Helper function to validate custom field value.
civicrm_api3_custom_field_setvalue() : array<string|int, mixed>: CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.
civicrm_api3_custom_field_getoptions() : mixed
civicrm_api3_custom_group_create() : array<string|int, mixed>: This entire function consists of legacy handling, probably for a form that no longer exists.
_civicrm_api3_custom_group_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_custom_group_delete() : array<string|int, mixed>: Use this API to delete an existing group.
civicrm_api3_custom_group_get() : array<string|int, mixed>: API to get existing custom fields.
civicrm_api3_custom_group_setvalue() : array<string|int, mixed>: CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group.
civicrm_api3_custom_group_getoptions() : mixed
civicrm_api3_custom_search_get() : array<string|int, mixed>: Retrieve custom searches.
civicrm_api3_custom_search_create() : array<string|int, mixed>: Add a CustomSearch.
_civicrm_api3_custom_search_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_custom_search_delete() : array<string|int, mixed>: Deletes an existing CustomSearch.
civicrm_api3_custom_value_create() : array<string|int, mixed>: Sets custom values for an entity.
_civicrm_api3_custom_value_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_custom_value_get() : array<string|int, mixed>: Use this API to get existing custom values for an entity.
_civicrm_api3_custom_value_get_spec() : mixed: Adjust Metadata for Get action.
_civicrm_api3_custom_value_gettree_spec() : mixed: CustomValue.gettree API specification
civicrm_api3_custom_value_gettree() : array<string|int, mixed>: CustomValue.gettree API
_civicrm_api3_custom_value_getdisplayvalue_spec() : mixed: CustomValue.getdisplayvalue API specification
civicrm_api3_custom_value_getdisplayvalue() : array<string|int, mixed>: CustomValue.getdisplayvalue API
civicrm_api3_dashboard_create() : array<string|int, mixed>: Creates or updates an Dashlet.
_civicrm_api3_dashboard_create_spec() : mixed: Specify Meta data for create.
civicrm_api3_dashboard_get() : array<string|int, mixed>: Gets a CiviCRM Dashlets according to parameters.
civicrm_api3_dashboard_delete() : array<string|int, mixed>: Delete a specified Dashlet.
civicrm_api3_dashboard_contact_create() : array<string|int, mixed>: Creates/Updates a new Dashboard Contact Entry.
civicrm_api3_dashboard_contact_get() : array<string|int, mixed>: Gets a CiviCRM Dashlets of Contacts according to parameters.
_civicrm_api3_dashboard_contact_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_dashboard_contact_delete() : array<string|int, mixed>: Delete an existing dashboard-contact.
civicrm_api3_dedupe_get() : array<string|int, mixed>: Get rows for any cached attempted merges on the passed criteria.
_civicrm_api3_dedupe_get_spec() : mixed: Get rows for getting dedupe cache records.
civicrm_api3_dedupe_delete() : array<string|int, mixed>: Delete rows for any cached attempted merges on the passed criteria.
civicrm_api3_dedupe_create() : array<string|int, mixed>: Get the statistics for any cached attempted merges on the passed criteria.
civicrm_api3_dedupe_getstatistics() : array<string|int, mixed>: Get the statistics for any cached attempted merges on the passed criteria.
_civicrm_api3_dedupe_getstatistics_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_dedupe_getduplicates() : array<string|int, mixed>: Get the duplicate contacts for the supplied parameters.
_civicrm_api3_dedupe_getduplicates_spec() : mixed: Adjust Metadata for getduplicates action.. The metadata is used for setting defaults, documentation & validation.
civicrm_api3_domain_get() : array<string|int, mixed>: Get CiviCRM Domain details.
_civicrm_api3_domain_get_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_domain_create() : array<string|int, mixed>: Create a new Domain.
_civicrm_api3_domain_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_email_create() : array<string|int, mixed>: Add an Email for a contact.
_civicrm_api3_email_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_email_delete() : array<string|int, mixed>: Deletes an existing Email.
civicrm_api3_email_get() : array<string|int, mixed>: Retrieve one or more emails.
_civicrm_api3_email_getlist_defaults() : array<string|int, mixed>: Set default getlist parameters.
civicrm_api3_entity_batch_get() : array<string|int, mixed>: Get entity batches.
_civicrm_api3_entity_batch_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_entity_batch_create() : array<string|int, mixed>: Create an entity batch.
civicrm_api3_entity_batch_delete() : array<string|int, mixed>: Mark entity batch as removed.
civicrm_api3_entity_financial_account_create() : array<string|int, mixed>: Save an Entity Financial Account record.
_civicrm_api3_entity_financial_account_create_spec() : mixed: Save an Entity Financial Account record.
civicrm_api3_entity_financial_account_get() : array<string|int, mixed>: Get an Entity Financial Account record.
civicrm_api3_entity_financial_account_delete() : array<string|int, mixed>: Delete an Entity Financial Account record.
civicrm_api3_entity_financial_trxn_create() : array<string|int, mixed>: Save a Entity Financial Trxn.
civicrm_api3_entity_financial_trxn_get() : array<string|int, mixed>: Get a Entity Financial Trxn.
civicrm_api3_entity_financial_trxn_delete() : array<string|int, mixed>: Delete a Entity Financial Trxn.
_civicrm_api3_entity_financial_trxn_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_entity_tag_get() : array<string|int, mixed>: Get entity tags.
_civicrm_api3_entity_tag_get_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_entity_tag_create() : array<string|int, mixed>: Create an entity tag.
civicrm_api3_entity_tag_delete() : array<string|int, mixed>: Mark entity tag as removed.
_civicrm_api3_entity_tag_delete_spec() : mixed: Modify metadata.
_civicrm_api3_entity_tag_common() : array<string|int, mixed>: Helper function for formatting tags (part of api v2 legacy).
civicrm_api3_entity_tag_replace() : mixed: Replace tags for an entity
civicrm_api3_event_create() : array<string|int, mixed>: Create a Event.
_civicrm_api3_event_create_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_event_create_legacy_support_42() : mixed: Support for schema changes made in 4.2.
civicrm_api3_event_get() : array<string|int, mixed>: Get Event record.
_civicrm_api3_event_get_spec() : mixed: Adjust Metadata for Get action.
_civicrm_api3_event_get_legacy_support_42() : mixed: Support for schema changes made in 4.2.
civicrm_api3_event_delete() : array<string|int, mixed>: Delete an existing Event.
_civicrm_api3_event_getisfull() : mixed: Add 'is_full' & 'available_seats' to the return array.
_civicrm_api3_event_getlist_params() : mixed: Get event list parameters.
_civicrm_api3_event_getlist_output() : array<string|int, mixed>: Get event list output.
civicrm_api3_file_create() : array<string|int, mixed>: Create a file record.
civicrm_api3_file_get() : array<string|int, mixed>: Get a File.
civicrm_api3_file_update() : array<string|int, mixed>: Update an existing File.
civicrm_api3_file_delete() : array<string|int, mixed>: Delete an existing File.
civicrm_api3_financial_account_create() : array<string|int, mixed>: Save a FinancialAccount.
civicrm_api3_financial_account_get() : array<string|int, mixed>: Get a FinancialAccount.
civicrm_api3_financial_account_delete() : array<string|int, mixed>: Delete a FinancialAccount.
civicrm_api3_financial_item_create() : array<string|int, mixed>: Save a Financial Item.
civicrm_api3_financial_item_get() : array<string|int, mixed>: Get a FinancialItem.
civicrm_api3_financial_item_delete() : array<string|int, mixed>: Delete a Financial Item.
civicrm_api3_financial_trxn_create() : array<string|int, mixed>: Save a Financial Item.
civicrm_api3_financial_trxn_get() : array<string|int, mixed>: Get a Financialtrxn.
civicrm_api3_financial_trxn_delete() : array<string|int, mixed>: Delete a Financial trxn.
_civicrm_api3_financial_trxn_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_financial_type_create() : array<string|int, mixed>: Save a FinancialType.
_civicrm_api3_financial_type_create_spec() : mixed
civicrm_api3_financial_type_get() : array<string|int, mixed>: Get a FinancialType.
civicrm_api3_financial_type_delete() : array<string|int, mixed>: Delete a FinancialType.
civicrm_api3_generic_getActions() : array<string|int, mixed>: Get available api actions.
civicrm_api3_generic_getList() : mixed: Generic api wrapper used for quicksearch and autocomplete.
_civicrm_api3_generic_getlist_get_result() : array<string|int, mixed>
_civicrm_api3_generic_getList_defaults() : void: Set defaults for api.getlist.
_civicrm_api3_generic_getlist_params() : mixed: Fallback implementation of getlist_params. May be overridden by individual apis.
_civicrm_api3_generic_getlist_output() : array<string|int, mixed>: Fallback implementation of getlist_output. May be overridden by individual api functions.
_civicrm_api3_generic_getlist_postprocess() : mixed: Common postprocess for getlist output
_civicrm_api3_generic_getlist_spec() : mixed: Provide metadata for this api
civicrm_api3_generic_getunique() : mixed: Generic api wrapper used to get all unique fields for a given entity.
civicrm_api3_generic_setValue() : array<string|int, mixed>: Set a single value using the api.
civicrm_api3_generic_update() : array<string|int, mixed>|int|mixed: Update function is basically a hack.
_civicrm_api3_generic_validate_spec() : mixed: Provide meta-data for this api.
civicrm_api3_generic_validate() : mixed: Generic api wrapper used for validation of entity-action pair.
civicrm_api3_generic_getfields() : array<string|int, mixed>: Get information about fields for a given api request.
civicrm_api3_generic_getfield() : array<string|int, mixed>: Get metadata for a field
_civicrm_api3_generic_getfield_spec() : mixed: Get metadata for getfield action.
civicrm_api3_generic_getcount() : int: API return function to reformat results as count.
civicrm_api3_generic_getsingle() : int: API return function to reformat results as single result.
civicrm_api3_generic_getvalue() : int: API return function to reformat results as single value.
_civicrm_api3_generic_getrefcount_spec() : mixed: Get count of contact references.
civicrm_api3_generic_getrefcount() : array<string|int, mixed>: API to determine if a record is in-use.
civicrm_api3_generic_replace() : int: API wrapper for replace function.
civicrm_api3_generic_getoptions() : array<string|int, mixed>: API wrapper for getoptions function.
_civicrm_api3_generic_getoptions_spec() : mixed: Provide metadata for this generic action
_civicrm_api3_generic_get_metadata_options() : mixed: Get metadata.
civicrm_api3_group_create() : array<string|int, mixed>: Create/update group.
_civicrm_api3_group_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_group_get() : array<string|int, mixed>: Returns array of groups matching a set of one or more Group properties.
civicrm_api3_group_delete() : array<string|int, mixed>: Delete an existing Group.
civicrm_api3_group_contact_get() : array<string|int, mixed>: Fetch a list of groups for a contact, or contacts for a group.
_civicrm_api3_group_contact_create_spec() : mixed: Adjust metadata for Create action.
civicrm_api3_group_contact_create() : array<string|int, mixed>: Add contact(s) to group(s).
civicrm_api3_group_contact_delete() : array<string|int, mixed>: Delete group contact record.
_civicrm_api3_group_contact_delete_spec() : mixed: Adjust metadata.
civicrm_api3_group_contact_pending() : array<string|int, mixed>|int: Get pending group contacts.
_civicrm_api3_group_contact_common() : array<string|int, mixed>: Group contact helper function.
civicrm_api3_group_contact_update_status() : bool: Update group contact status.
_civicrm_api3_group_contact_deprecation() : array<string|int, mixed>: Deprecated function notices.
civicrm_api3_group_nesting_get() : array<string|int, mixed>: Provides group nesting record(s) given parent and/or child id.
civicrm_api3_group_nesting_create() : array<string|int, mixed>: Creates group nesting record for given parent and child id.
_civicrm_api3_group_nesting_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_group_nesting_delete() : array<string|int, mixed>: Removes specific nesting records.
civicrm_api3_group_organization_get() : array<string|int, mixed>: Get group organization record/s.
civicrm_api3_group_organization_create() : array<string|int, mixed>: Create group organization record.
_civicrm_api3_group_organization_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_group_organization_delete() : array<string|int, mixed>: Deletes an existing Group Organization.
civicrm_api3_im_create() : array<string|int, mixed>: Add an IM for a contact.
_civicrm_api3_im_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_im_delete() : array<string|int, mixed>: Deletes an existing IM.
civicrm_api3_im_get() : array<string|int, mixed>: Retrieve one or more IM.
_civicrm_api3_job_create_spec() : mixed: Adjust metadata for "Create" action.
civicrm_api3_job_create() : array<string|int, mixed>: Create scheduled job.
_civicrm_api3_job_clone_spec() : mixed: Adjust metadata for clone spec action.
civicrm_api3_job_clone() : array<string|int, mixed>: Clone Job.
civicrm_api3_job_get() : array<string|int, mixed>: Retrieve one or more job.
civicrm_api3_job_delete() : mixed: Delete a job.
civicrm_api3_job_execute() : array<string|int, mixed>: Dumb wrapper to execute scheduled jobs.
_civicrm_api3_job_execute_spec() : mixed: Adjust Metadata for Execute action.
civicrm_api3_job_geocode() : array<string|int, mixed>: Geocode group of contacts based on given params.
_civicrm_api3_job_geocode_spec() : mixed: First check on Code documentation.
civicrm_api3_job_send_reminder() : array<string|int, mixed>: Send the scheduled reminders as configured.
_civicrm_api3_job_send_reminder() : mixed: Adjust metadata for "send_reminder" action.
civicrm_api3_job_mail_report() : array<string|int, mixed>: Execute a specific report instance and send the output via email.
civicrm_api3_job_update_greeting() : array<string|int, mixed>: This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.
_civicrm_api3_job_update_greeting_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_job_process_pledge() : array<string|int, mixed>: Mass update pledge statuses.
civicrm_api3_job_process_mailing() : array<string|int, mixed>: Process mail queue.
civicrm_api3_job_process_sms() : array<string|int, mixed>: Process sms queue.
civicrm_api3_job_fetch_bounces() : array<string|int, mixed>: Job to get mail responses from civiMailing.
_civicrm_api3_job_fetch_bounces_spec() : mixed: Metadata for bounce function.
civicrm_api3_job_fetch_activities() : array<string|int, mixed>: Job to get mail and create activities.
civicrm_api3_job_process_participant() : array<string|int, mixed>: Process participant statuses.
civicrm_api3_job_process_membership() : bool: This api checks and updates the status of all membership records for a given domain.
_civicrm_api3_job_process_membership_spec() : mixed
civicrm_api3_job_process_respondent() : bool: This api checks and updates the status of all survey respondents.
civicrm_api3_job_process_batch_merge() : array<string|int, mixed>: Merges given pair of duplicate contacts.
_civicrm_api3_job_process_batch_merge_spec() : mixed: Metadata for batch merge function.
civicrm_api3_job_run_payment_cron() : mixed: Runs handlePaymentCron method in the specified payment processor.
civicrm_api3_job_cleanup() : array<string|int, mixed>: This api cleans up all the old session entries and temp tables.
civicrm_api3_job_disable_expired_relationships() : array<string|int, mixed>: Set expired relationships to disabled.
civicrm_api3_job_group_rebuild() : array<string|int, mixed>: This api reloads all the smart groups.
civicrm_api3_job_group_cache_flush() : array<string|int, mixed>: Flush smart groups caches.
civicrm_api3_job_acl_cache_flush() : array<string|int, mixed>: Flush acl caches.
civicrm_api3_job_version_check() : mixed: Check for CiviCRM software updates.
civicrm_api3_line_item_create() : array<string|int, mixed>: Create or update a line_item.
_civicrm_api3_line_item_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_line_item_get() : array<string|int, mixed>: Returns array of line_items matching a set of one or more group properties.
civicrm_api3_line_item_delete() : array<string|int, mixed>: Delete an existing LineItem.
civicrm_api3_location_type_create() : array<string|int, mixed>: Add a LocationType.
_civicrm_api3_location_type_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_location_type_delete() : array<string|int, mixed>: Deletes an existing LocationType.
civicrm_api3_location_type_get() : array<string|int, mixed>: Retrieve one or more LocationTypes.
civicrm_api3_loc_block_create() : array<string|int, mixed>: Create or update a LocBlock.
civicrm_api3_loc_block_get() : array<string|int, mixed>: Returns array of loc_blocks matching a set of one or more properties.
civicrm_api3_loc_block_delete() : array<string|int, mixed>: Delete an existing LocBlock.
civicrm_api3_logging_revert() : array<string|int, mixed>: Revert a log change.
_civicrm_api3_logging_revert_spec() : mixed: Get a log change.
civicrm_api3_logging_get() : array<string|int, mixed>: Get a log change.
_civicrm_api3_logging_get_spec() : mixed: Get a log change.
civicrm_api3_mailing_create() : array<string|int, mixed>: Handle a create event.
civicrm_api3_mailing_gettokens() : array<string|int, mixed>: Get tokens for one or more entity type
_civicrm_api3_mailing_gettokens_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_mailing_create_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_mailing_clone_spec() : mixed: Adjust metadata for clone spec action.
civicrm_api3_mailing_clone() : array<string|int, mixed>: Clone mailing.
civicrm_api3_mailing_delete() : array<string|int, mixed>: Handle a delete event.
civicrm_api3_mailing_get() : array<string|int, mixed>: Handle a get event.
_civicrm_api3_mailing_get_formatResult() : array<string|int, mixed>: Format definition.
_civicrm_api3_mailing_submit_spec() : mixed: Adjust metadata for mailing submit api function.
civicrm_api3_mailing_submit() : array<string|int, mixed>: Mailing submit.
civicrm_api3_mailing_event_bounce() : array<string|int, mixed>: Process a bounce event by passing through to the BAOs.
_civicrm_api3_mailing_event_bounce_spec() : mixed: Adjust Metadata for bounce_spec action.
civicrm_api3_mailing_event_confirm() : array<string|int, mixed>: Handle a confirm event.
_civicrm_api3_mailing_deprecation() : array<string|int, mixed>: Declare deprecated functions.
civicrm_api3_mailing_event_reply() : array<string|int, mixed>: Handle a reply event.
_civicrm_api3_mailing_event_reply_spec() : mixed: Adjust Metadata for event_reply action.
civicrm_api3_mailing_event_forward() : array<string|int, mixed>: Handle a forward event.
_civicrm_api3_mailing_event_forward_spec() : mixed: Adjust Metadata for event_forward action.
civicrm_api3_mailing_event_click() : array<string|int, mixed>: Handle a click event.
civicrm_api3_mailing_event_open() : array<string|int, mixed>: Handle an open event.
civicrm_api3_mailing_preview() : mixed: Preview mailing.
_civicrm_api3_mailing_send_test_spec() : mixed: Adjust metadata for send test function.
civicrm_api3_mailing_send_test() : array<string|int, mixed>: Send test mailing.
_civicrm_api3_mailing_stats_spec() : mixed: Adjust Metadata for send_mail action.
civicrm_api3_mailing_stats() : array<string|int, mixed>: Function which needs to be explained.
_civicrm_api3_mailing_update_email_resetdate_spec() : mixed
civicrm_api3_mailing_update_email_resetdate() : array<string|int, mixed>: Fix the reset dates on the email record based on when a mail was last delivered.
_civicrm_api3_mailing_a_b_create_spec() : mixed
civicrm_api3_mailing_a_b_create() : array<string|int, mixed>: Handle a create mailing ab testing.
civicrm_api3_mailing_a_b_delete() : array<string|int, mixed>: Handle a delete event.
civicrm_api3_mailing_a_b_get() : array<string|int, mixed>: Handle a get event.
_civicrm_api3_mailing_a_b_submit_spec() : mixed: Adjust Metadata for submit action.
civicrm_api3_mailing_a_b_submit() : array<string|int, mixed>: Send A/B mail to A/B recipients respectively.
_civicrm_api3_mailing_a_b_fill_winner() : mixed
_civicrm_api3_mailing_a_b_graph_stats_spec() : mixed: Adjust Metadata for graph_stats action.
civicrm_api3_mailing_a_b_graph_stats() : array<string|int, mixed>: Send graph detail for A/B tests mail.
civicrm_api3_mailing_component_create() : array<string|int, mixed>: Save a MailingComponent.
_civicrm_api3_mailing_component_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mailing_component_get() : array<string|int, mixed>: Get a MailingComponent.
_civicrm_api3_mailing_component_get_spec() : mixed: Adjust metadata for get.
civicrm_api3_mailing_component_delete() : array<string|int, mixed>: Delete a MailingComponent.
civicrm_api3_mailing_contact_get() : array<string|int, mixed>: Get all the mailings and details that a contact was involved with.
_civicrm_api3_mailing_contact_getresults() : mixed: This is a wrapper for the functions that return the results from the 'quasi-entity' mailing contact.
_civicrm_api3_mailing_contact_get_spec() : mixed: Adjust Metadata for Get action.
_civicrm_api3_mailing_contact_query() : array<string|int, mixed>: Helper function for mailing contact queries.
_civicrm_api3_mailing_contact_get_delivered() : array<string|int, mixed>: Get delivered mailing contacts.
_civicrm_api3_mailing_contact_get_bounced() : array<string|int, mixed>: Get bounced mailing contact records.
civicrm_api3_mailing_contact_getcount() : array<string|int, mixed>: Get count of all the mailings that a contact was involved with.
civicrm_api3_mailing_event_confirm_get() : array<string|int, mixed>: Get mailing event confirm record.
civicrm_api3_mailing_event_confirm_create() : array<string|int, mixed>: Handle a confirm event.
_civicrm_api3_mailing_event_confirm_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mailing_event_queue_create() : array<string|int, mixed>: Handle a queue event.
civicrm_api3_mailing_event_queue_get() : array<string|int, mixed>: Get mailing event queue record.
civicrm_api3_mailing_event_queue_delete() : array<string|int, mixed>: Delete mailing event queue record.
_civicrm_api3_mailing_event_queue_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mailing_event_resubscribe_create() : array<string|int, mixed>: Subscribe from mailing group.
_civicrm_api3_mailing_event_resubscribe_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mailing_event_subscribe_get() : array<string|int, mixed>: Get mailing event subscribe record.
civicrm_api3_mailing_event_subscribe_create() : array<string|int, mixed>: Subscribe from mailing group.
_civicrm_api3_mailing_event_subscribe_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mailing_event_unsubscribe_get() : array<string|int, mixed>: Get mailing event unsubscribe record.
civicrm_api3_mailing_event_unsubscribe_create() : array<string|int, mixed>: Unsubscribe from mailing group.
_civicrm_api3_mailing_event_unsubscribe_create_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_mailing_group_deprecation() : string: Declare deprecated functions.
civicrm_api3_mailing_group_event_unsubscribe() : array<string|int, mixed>: Handle an unsubscribe event.
civicrm_api3_mailing_group_event_domain_unsubscribe() : array<string|int, mixed>: Handle a site-level unsubscribe event.
civicrm_api3_mailing_group_event_resubscribe() : array<string|int, mixed>: Handle a re-subscription event.
civicrm_api3_mailing_group_event_subscribe() : array<string|int, mixed>: Handle a subscription event.
civicrm_api3_mailing_group_create() : array<string|int, mixed>: Create mailing group.
civicrm_api3_mailing_group_get() : array<string|int, mixed>: Get mailing group.
civicrm_api3_mailing_group_delete() : array<string|int, mixed>: Delete mailing group.
civicrm_api3_mailing_job_create() : array<string|int, mixed>: Handle creation of a MailingJob for a Mailing.
_civicrm_api3_mailing_job_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mailing_job_get() : array<string|int, mixed>: Returns array of Mailing Jobs matching a set of one or more group properties.
civicrm_api3_mailing_job_delete() : array<string|int, mixed>: Handle deletion of a Mailing Job for a Mailing.
civicrm_api3_mailing_recipients_get() : array<string|int, mixed>: Returns array of MailingRecipients.
civicrm_api3_mail_settings_create() : array<string|int, mixed>: Create or update a MailSettings.
_civicrm_api3_mail_settings_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mail_settings_get() : array<string|int, mixed>: Returns array of MailSettings matching a set of one or more properties.
civicrm_api3_mail_settings_delete() : array<string|int, mixed>: Delete an existing MailSettings.
civicrm_api3_mapping_create() : array<string|int, mixed>: Add a Mapping.
_civicrm_api3_mapping_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mapping_delete() : array<string|int, mixed>: Deletes an existing Mapping.
civicrm_api3_mapping_get() : array<string|int, mixed>: Retrieve one or more Mappings.
civicrm_api3_mapping_field_create() : array<string|int, mixed>: Add a Mapping Field.
_civicrm_api3_mapping_field_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_mapping_field_delete() : array<string|int, mixed>: Deletes an existing Mapping Field.
civicrm_api3_mapping_field_get() : array<string|int, mixed>: Retrieve one or more Mapping Fields.
_civicrm_api3_membership_delete_spec() : mixed: Adjust Metadata for Delete action.
civicrm_api3_membership_delete() : array<string|int, mixed>: Deletes an existing contact Membership.
civicrm_api3_membership_create() : array<string|int, mixed>: Create a Contact Membership.
_civicrm_api3_membership_create_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_membership_get_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_membership_get() : array<string|int, mixed>: Get contact Membership record.
_civicrm_api3_membership_relationsship_get_customv2behaviour() : array<string|int, mixed>: Non-standard behaviour inherited from v2.
civicrm_api3_membership_block_create() : array<string|int, mixed>: API to Create or update a MembershipBlock.
_civicrm_api3_membership_block_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_membership_block_get() : array<string|int, mixed>: Get a Membership Block.
civicrm_api3_membership_block_delete() : array<string|int, mixed>: Deletes an existing membership block.
civicrm_api3_membership_log_create() : array<string|int, mixed>: API to Create or update a MembershipLog.
_civicrm_api3_membership_log_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_membership_log_get() : array<string|int, mixed>: Get a Membership Log.
civicrm_api3_membership_log_delete() : array<string|int, mixed>: Deletes an existing membership log.
civicrm_api3_membership_payment_create() : array<string|int, mixed>: Add or update a link between contribution and membership.
_civicrm_api3_membership_payment_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_membership_payment_get() : array<string|int, mixed>: Retrieve one or more membership payment records.
civicrm_api3_membership_status_create() : array<string|int, mixed>: Create a Membership Status.
_civicrm_api3_membership_status_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_membership_status_get() : array<string|int, mixed>: Get a membership status.
civicrm_api3_membership_status_update() : array<string|int, mixed>: Update an existing membership status.
civicrm_api3_membership_status_delete() : array<string|int, mixed>: Deletes an existing membership status.
civicrm_api3_membership_status_calc() : array<string|int, mixed>: Derives the Membership Status of a given Membership Record.
_civicrm_api3_membership_status_calc_spec() : mixed: Adjust Metadata for Calc action.
civicrm_api3_membership_type_create() : array<string|int, mixed>: API to Create or update a Membership Type.
_civicrm_api3_membership_type_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_membership_type_get() : array<string|int, mixed>: Get a Membership Type.
_civicrm_api3_membership_type_get_spec() : mixed: Adjust Metadata for Get action.
_civicrm_api3_membership_type_getlist_params() : mixed: Adjust input for getlist action.
civicrm_api3_membership_type_delete() : array<string|int, mixed>: Deletes an existing membership type.
civicrm_api3_message_template_create() : array<string|int, mixed>: Create message template.
_civicrm_api3_message_template_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_message_template_delete() : bool: Delete message template.
_civicrm_api3_message_template_get_spec() : mixed: Adjust metadata for message_template get action.
civicrm_api3_message_template_get() : array<string|int, mixed>: Retrieve one or more message_template.
civicrm_api3_message_template_send() : mixed: Sends a template.
_civicrm_api3_message_template_send_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_navigation_reset_spec() : mixed: Adjust metadata for navigation reset action.
civicrm_api3_navigation_reset() : array<string|int, mixed>: Reset navigation.
_civicrm_api3_navigation_get_spec() : mixed: Adjust metadata for navigation get action.
civicrm_api3_navigation_get() : array<string|int, mixed>: Reset navigation.
civicrm_api3_navigation_create() : array<string|int, mixed>: Create navigation item.
_civicrm_api3_navigation_create_spec() : mixed: Adjust metadata for navigation create action.
civicrm_api3_navigation_delete() : array<string|int, mixed>: Delete navigation item.
civicrm_api3_note_create() : array<string|int, mixed>: Create Note.
_civicrm_api3_note_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_note_delete() : array<string|int, mixed>: Deletes an existing note.
civicrm_api3_note_get() : array<string|int, mixed>: Retrieve a specific note or notes, given a set of input params.
_civicrm_api3_note_get_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_note_tree_get() : array<string|int, mixed>: Get all descendants of given note.
_civicrm_api3_note_deprecation() : array<string|int, mixed>: Declare deprecated api functions.
civicrm_api3_open_i_d_create() : array<string|int, mixed>: Add an OpenID for a contact.
_civicrm_api3_open_i_d_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_open_i_d_delete() : array<string|int, mixed>: Deletes an existing OpenID.
civicrm_api3_open_i_d_get() : array<string|int, mixed>: Retrieve one or more OpenID.
civicrm_api3_option_group_get() : array<string|int, mixed>: Get option groups.
civicrm_api3_option_group_create() : array<string|int, mixed>: Create/update option group.
_civicrm_api3_option_group_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_option_group_delete() : array<string|int, mixed>: Delete an existing Option Group.
civicrm_api3_option_value_get() : array<string|int, mixed>: Retrieve one or more option values.
_civicrm_api3_option_value_get_spec() : mixed: Adjust Metadata for get action.
civicrm_api3_option_value_create() : array<string|int, mixed>: Add an OptionValue.
_civicrm_api3_option_value_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_option_value_delete() : array<string|int, mixed>: Deletes an existing option value.
civicrm_api3_order_get() : array<string|int, mixed>: Retrieve a set of Order.
_civicrm_api3_order_get_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_order_create() : array<string|int, mixed>: Add or update a Order.
civicrm_api3_order_delete() : array<string|int, mixed>: Delete a Order.
civicrm_api3_order_cancel() : array<string|int, mixed>: Cancel an Order.
_civicrm_api3_order_cancel_spec() : mixed: Adjust Metadata for Cancel action.
_civicrm_api3_order_create_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_order_delete_spec() : mixed: Adjust Metadata for Delete action.
_order_create_wrangle_membership_params() : mixed: Handle possibility of v3 style params.
civicrm_api3_participant_create() : array<string|int, mixed>: Create an Event Participant.
_civicrm_api3_participant_createlineitem() : mixed: Create a default participant line item.
_civicrm_api3_participant_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_participant_get() : array<string|int, mixed>: Retrieve a specific participant, given a set of input params.
_civicrm_api3_participant_get_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_participant_delete() : array<string|int, mixed>: Deletes an existing contact participant.
civicrm_api3_participant_payment_create() : array<string|int, mixed>: Create a Event Participant Payment.
_civicrm_api3_participant_payment_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_participant_payment_delete() : array<string|int, mixed>: Deletes an existing Participant Payment.
civicrm_api3_participant_payment_get() : array<string|int, mixed>: Retrieve one or more participant payment records.
civicrm_api3_participant_status_type_create() : array<string|int, mixed>: Create/update participant_status.
civicrm_api3_participant_status_type_get() : array<string|int, mixed>: Returns array of participant_statuses matching a set of one or more group properties.
civicrm_api3_participant_status_type_delete() : array<string|int, mixed>: Delete an existing participant_status.
civicrm_api3_payment_get() : array<string|int, mixed>: Retrieve a set of financial transactions which are payments.
civicrm_api3_payment_delete() : array<string|int, mixed>: Delete a payment.
civicrm_api3_payment_cancel() : array<string|int, mixed>: Cancel/Refund a payment for a Contribution.
civicrm_api3_payment_create() : array<string|int, mixed>: Add a payment for a Contribution.
_civicrm_api3_payment_create_spec() : mixed: Adjust Metadata for Create action.
_civicrm_api3_payment_get_spec() : mixed: Adjust Metadata for Get action.
_civicrm_api3_payment_delete_spec() : mixed: Adjust Metadata for Delete action.
_civicrm_api3_payment_cancel_spec() : mixed: Adjust Metadata for Cancel action.
civicrm_api3_payment_sendconfirmation() : array<string|int, mixed>: Send a payment confirmation.
_civicrm_api3_payment_sendconfirmation_spec() : mixed: Adjust Metadata for sendconfirmation action.
civicrm_api3_payment_processor_create() : array<string|int, mixed>: Add/Update a PaymentProcessor.
_civicrm_api3_payment_processor_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_payment_processor_delete() : array<string|int, mixed>: Deletes an existing PaymentProcessor.
civicrm_api3_payment_processor_get() : array<string|int, mixed>: Retrieve one or more PaymentProcessor.
_civicrm_api3_payment_processor_getlist_defaults() : array<string|int, mixed>: Set default getlist parameters.
civicrm_api3_payment_processor_pay() : array<string|int, mixed>: Action payment.
_civicrm_api3_payment_processor_pay_spec() : mixed: Action payment.
civicrm_api3_payment_processor_refund() : array<string|int, mixed>: Action refund.
_civicrm_api3_payment_processor_refund_spec() : mixed: Action Refund.
civicrm_api3_payment_processor_type_create() : array<string|int, mixed>: Create payment_processor type.
_civicrm_api3_payment_processor_type_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_payment_processor_type_get() : array<string|int, mixed>: Get all payment_processor types.
civicrm_api3_payment_processor_type_delete() : array<string|int, mixed>: Delete a payment_processor type delete.
civicrm_api3_payment_token_create() : array<string|int, mixed>: Create/update Payment Token.
_civicrm_api3_payment_token_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_payment_token_get() : array<string|int, mixed>: Returns array of campaigns matching a set of one or more properties.
civicrm_api3_payment_token_delete() : array<string|int, mixed>: Delete an existing payment token.
civicrm_api3_pcp_create() : array<string|int, mixed>: Create or update a survey.
_civicrm_api3_pcp_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_pcp_get() : array<string|int, mixed>: Returns array of pcps matching a set of one or more properties.
civicrm_api3_pcp_delete() : array<string|int, mixed>: Delete an existing PCP.
civicrm_api3_phone_get() : array<string|int, mixed>: Retrieve one or more phones.
civicrm_api3_phone_create() : array<string|int, mixed>: Add an Phone for a contact.
_civicrm_api3_phone_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_phone_delete() : array<string|int, mixed>: Delete an existing Phone.
civicrm_api3_pledge_create() : array<string|int, mixed>: Create or updates an Pledge.
civicrm_api3_pledge_delete() : array<string|int, mixed>: Delete a pledge.
_civicrm_api3_pledge_delete_spec() : mixed: Adjust metadata for pledge delete action.
_civicrm_api3_pledge_get_spec() : mixed: Adjust field specification specific to get requests.
_civicrm_api3_pledge_create_spec() : mixed: Adjust field specification specific to get requests.
civicrm_api3_pledge_get() : array<string|int, mixed>: Retrieve a set of pledges, given a set of input params.
_civicrm_api3_pledge_get_defaults() : mixed: Set default to not return test params.
_civicrm_api3_pledge_format_params() : mixed: Legacy function to format pledge parameters.
civicrm_api3_pledge_payment_create() : array<string|int, mixed>: Add or update a pledge payment.
_civicrm_api3_pledge_payment_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_pledge_payment_delete() : array<string|int, mixed>: Delete a pledge Payment - Note this deletes the contribution not just the link.
civicrm_api3_pledge_payment_get() : array<string|int, mixed>: Retrieve a set of pledges, given a set of input params.
civicrm_api3_premium_create() : array<string|int, mixed>: Save a premium.
civicrm_api3_premium_get() : array<string|int, mixed>: Get a premium.
civicrm_api3_premium_delete() : array<string|int, mixed>: Delete a premium.
_civicrm_api3_premium_get_spec() : mixed: Return field specification specific to get requests.
_civicrm_api3_premium_create_spec() : mixed: Return field specification specific to create requests.
civicrm_api3_price_field_create() : array<string|int, mixed>: Create or update a price_field.
_civicrm_api3_price_field_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_price_field_get() : array<string|int, mixed>: Returns array of price_fields matching a set of one or more group properties.
civicrm_api3_price_field_delete() : array<string|int, mixed>: Delete an existing price_field.
civicrm_api3_price_field_value_create() : array<string|int, mixed>: Create or update a PriceFieldValue.
_civicrm_api3_price_field_value_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_price_field_value_get() : array<string|int, mixed>: Returns array of PriceFieldValues matching a set of one or more group properties.
civicrm_api3_price_field_value_delete() : array<string|int, mixed>: Delete an existing PriceFieldValue.
civicrm_api3_price_set_create() : array<string|int, mixed>: Create or update a PriceSet.
_civicrm_api3_price_set_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_price_set_get() : array<string|int, mixed>: Returns array of price_sets matching a set of one or more group properties.
civicrm_api3_price_set_delete() : array<string|int, mixed>: Delete an existing PriceSet.
civicrm_api3_print_label_create() : array<string|int, mixed>: Save a PrintLabel.
_civicrm_api3_print_label_create_spec() : mixed: Adjust metadata for navigation create action.
civicrm_api3_print_label_get() : array<string|int, mixed>: Get a PrintLabel.
civicrm_api3_print_label_delete() : array<string|int, mixed>: Delete a PrintLabel.
civicrm_api3_product_create() : array<string|int, mixed>: Save a product.
_civicrm_api3_product_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_product_get() : array<string|int, mixed>: Get a product.
civicrm_api3_product_delete() : array<string|int, mixed>: Delete a product.
civicrm_api3_profile_get() : array<string|int, mixed>: Retrieve Profile field values.
_civicrm_api3_profile_get_spec() : mixed: Adjust profile get function metadata.
civicrm_api3_profile_submit() : array<string|int, mixed>: Submit a set of fields against a profile.
_civicrm_api3_profile_translate_fieldnames_for_bao() : string: Translate field names for BAO.
_civicrm_api3_profile_submit_spec() : mixed: Metadata for submit action.
civicrm_api3_profile_set() : array<string|int, mixed>: Update Profile field values.
civicrm_api3_profile_apply() : array<string|int, mixed>: Apply profile.
_civicrm_api3_profile_apply_spec() : mixed: Adjust Metadata for Apply action.
_civicrm_api3_profile_getbillingpseudoprofile() : array<string|int, mixed>: Get pseudo profile 'billing'.
_civicrm_api3_buildprofile_submitfields() : array<string|int, mixed>|void: Here we will build up getfields type data for all the fields in the profile.
_civicrm_api3_order_by_weight() : bool
_civicrm_api3_map_profile_fields_to_entity() : array<string|int, mixed>: Here we map the profile fields as stored in the uf_field table to their 'real entity' we also return the profile fieldname
_civicrm_api3_profile_getProfileID() : int|string
_civicrm_api3_profile_appendaliases() : array<string|int, mixed>: helper function to add all aliases as keys to getfields response so we can look for keys within it since the relationship between profile fields & api / metadata based fields is a bit inconsistent
_civicrm_api3_profile_deprecation() : array<string|int, mixed>
civicrm_api3_recurring_entity_get() : array<string|int, mixed>: Retrieve a recurring entity.
_civicrm_api3_recurring_entity_get_spec() : mixed: Adjust Metadata for Get action.
civicrm_api3_recurring_entity_create() : array<string|int, mixed>: Add or update a recurring entity.
_civicrm_api3_recurring_entity_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_recurring_entity_delete() : array<string|int, mixed>: Deletes an existing ReportInstance.
civicrm_api3_relationship_create() : array<string|int, mixed>: Add or update a relationship.
_civicrm_api3_relationship_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_relationship_delete() : array<string|int, mixed>: Delete a relationship.
civicrm_api3_relationship_get() : array<string|int, mixed>: Get one or more relationship/s.
_civicrm_api3_handle_relationship_type() : mixed: Legacy handling for relationship_type parameter.
civicrm_api3_relationship_setvalue() : array<string|int, mixed>: Hack to ensure inherited membership got created/deleted on relationship add/delete respectively.
_civicrm_api3_relationship_getoptions_spec() : mixed
civicrm_api3_relationship_type_create() : array<string|int, mixed>: Create relationship type.
_civicrm_api3_relationship_type_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_relationship_type_get() : array<string|int, mixed>: Get all relationship types.
civicrm_api3_relationship_type_delete() : array<string|int, mixed>: Delete a relationship type.
_civicrm_api3_relationship_type_getlist_defaults() : array<string|int, mixed>: Get list defaults for relationship types.
civicrm_api3_report_instance_get() : array<string|int, mixed>: Retrieve a report instance.
civicrm_api3_report_instance_create() : array<string|int, mixed>: Add or update a report instance.
_civicrm_api3_report_instance_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_report_instance_delete() : array<string|int, mixed>: Deletes an existing ReportInstance.
civicrm_api3_report_template_get() : array<string|int, mixed>: Retrieve a report template.
civicrm_api3_report_template_create() : array<string|int, mixed>: Add a Report Template.
_civicrm_api3_report_template_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_report_template_delete() : array<string|int, mixed>: Deletes an existing ReportTemplate.
civicrm_api3_report_template_getrows() : array<string|int, mixed>: Retrieve rows from a report template.
_civicrm_api3_report_template_getrows() : array<string|int, mixed>: Get report template rows.
civicrm_api3_report_template_getstatistics() : array<string|int, mixed>: Get statistics from a given report.
_civicrm_api3_report_template_getrows_spec() : mixed: Adjust metadata for template getrows action.
civicrm_api3_rule_create() : array<string|int, mixed>: Create or update a rule.
_civicrm_api3_rule_create_spec() : mixed: Specify Meta data for create.
civicrm_api3_rule_delete() : array<string|int, mixed>: Delete an existing Rule.
civicrm_api3_rule_get() : array<string|int, mixed>: Get a Rule.
civicrm_api3_rule_group_create() : array<string|int, mixed>: Create or update a rule_group.
_civicrm_api3_rule_group_create_spec() : mixed: Specify Meta data for create.
civicrm_api3_rule_group_delete() : array<string|int, mixed>: Delete an existing RuleGroup.
civicrm_api3_rule_group_get() : array<string|int, mixed>: Get a RuleGroup.
civicrm_api3_saved_search_create() : array<string|int, mixed>: Create or update a saved search.
_civicrm_api3_saved_search_create_spec() : mixed
civicrm_api3_saved_search_delete() : array<string|int, mixed>: Delete an existing saved search.
civicrm_api3_saved_search_get() : array<string|int, mixed>: Retrieve one or more saved search(es).
_civicrm_api3_saved_search_result_cleanup() : mixed: Unserialize the form_values field in SavedSearch API results.
civicrm_api3_setting_getfields() : array<string|int, mixed>: Get fields for setting api calls.
_civicrm_api3_setting_getfields_spec() : mixed: Alter metadata for getfields functions.
civicrm_api3_setting_getdefaults() : array<string|int, mixed>: Return default values for settings.
_civicrm_api3_setting_getdefaults_spec() : mixed: Metadata for Setting create function.
civicrm_api3_setting_getoptions() : array<string|int, mixed>: Get options for settings.
civicrm_api3_setting_revert() : array<string|int, mixed>: Revert settings to defaults.
_civicrm_api3_setting_revert_spec() : mixed: Alter metadata for getfields functions.
civicrm_api3_setting_fill() : array<string|int, mixed>: Revert settings to defaults.
_civicrm_api3_setting_fill_spec() : mixed: Alter metadata for getfields functions.
_civicrm_api3_setting_deprecation() : array<string|int, mixed>: Declare deprecated api functions.
civicrm_api3_setting_create() : array<string|int, mixed>: Create or update a setting.
_civicrm_api3_setting_create_spec() : mixed: Metadata for setting create function.
civicrm_api3_setting_get() : array<string|int, mixed>: Returns array of settings matching input parameters.
_civicrm_api3_setting_get_spec() : mixed: Metadata for setting create function.
civicrm_api3_setting_getvalue() : array<string|int, mixed>: Returns value for specific parameter.
_civicrm_api3_setting_getvalue_spec() : mixed: Metadata for setting create function.
_civicrm_api3_setting_getDomainArray() : array<string|int, mixed>: Converts domain input into an array.
civicrm_api3_sms_provider_create() : array<string|int, mixed>: Save an sms_provider.
_civicrm_api3_sms_provider_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_sms_provider_get() : array<string|int, mixed>: Get an sms_provider.
civicrm_api3_sms_provider_delete() : array<string|int, mixed>: Delete an sms_provider.
civicrm_api3_state_province_create() : array<string|int, mixed>: Add a state/province.
_civicrm_api3_state_province_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_state_province_delete() : array<string|int, mixed>: Deletes an existing state/province.
civicrm_api3_state_province_get() : array<string|int, mixed>: Retrieve one or more states/provinces.
civicrm_api3_status_preference_create() : array<string|int, mixed>: Save a Status Preference.
civicrm_api3_status_preference_get() : array<string|int, mixed>: Get an Acl.
civicrm_api3_status_preference_delete() : array<string|int, mixed>: Delete an Acl.
_civicrm_api3_status_preference_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_survey_create() : array<string|int, mixed>: Create or update a survey.
_civicrm_api3_survey_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_survey_get() : array<string|int, mixed>: Returns array of surveys matching a set of one or more group properties.
civicrm_api3_survey_delete() : array<string|int, mixed>: Delete an existing survey.
_civicrm_api3_survey_getlist_defaults() : array<string|int, mixed>: Set default getlist parameters.
_civicrm_api3_survey_respondant_deprecation() : string: Notify caller of deprecated function.
civicrm_api3_survey_respondant_get() : array<string|int, mixed>: Get the list of signatories.
civicrm_api3_survey_respondant_count() : array<string|int, mixed>: Count survey respondents.
civicrm_api3_system_flush() : array<string|int, mixed>: Flush all system caches.
_civicrm_api3_system_flush_spec() : mixed: Adjust Metadata for Flush action.
_civicrm_api3_system_check_spec() : mixed: System.Check API specification (optional).
civicrm_api3_system_check() : array<string|int, mixed>: System Check API.
civicrm_api3_system_log() : array<string|int, mixed>: Log entry to system log table.
_civicrm_api3_system_log_spec() : mixed: Metadata for log function.
civicrm_api3_system_get() : array<string|int, mixed>: System.Get API.
_civicrm_api3_system_get_redacted_ini() : array<string|int, mixed>: Generate a sanitized/anonymized/redacted dump of the PHP configuration.
_civicrm_api3_system_get_redacted_mysql() : array<string|int, mixed>: Generate ae sanitized/anonymized/redacted dump of MySQL configuration.
_civicrm_api3_system_get_redacted_settings() : array<string|int, mixed>: Get redacted settings.
_civicrm_api3_system_get_whitelist() : array<string|int, mixed>: Read a whitelist.
civicrm_api3_system_updatelogtables() : mixed: Update log table structures.
civicrm_api3_system_utf8conversion() : array<string|int, mixed>: Update log table structures.
_civicrm_api3_system_utf8conversion_spec() : mixed: Metadata for conversion function.
_civicrm_api3_system_updatelogtables_spec() : mixed: Adjust Metadata for Flush action.
civicrm_api3_system_updateindexes() : array<string|int, mixed>: Update indexes.
_civicrm_api3_system_updateindexes_spec() : mixed: Declare metadata for api System.getmissingindices
civicrm_api3_system_getmissingindices() : array<string|int, mixed>: Get an array of indices that should be defined but are not.
_civicrm_api3_system_getmissingindices_spec() : mixed: Declare metadata for api System.getmissingindices
civicrm_api3_system_createmissinglogtables() : mixed: Creates missing log tables.
civicrm_api3_system_rebuildmultilingualschema() : mixed: Rebuild Multilingual Schema
civicrm_api3_system_log_delete() : array<string|int, mixed>: Delete system log record.
civicrm_api3_system_log_create() : array<string|int, mixed>: Create system log record.
_civicrm_api3_system_log_create_spec() : mixed: Adjust system log create metadata.
civicrm_api3_system_log_get() : array<string|int, mixed>: Get system log record.
civicrm_api3_tag_create() : array<string|int, mixed>: Create or update a tag.
_civicrm_api3_tag_create_spec() : mixed: Specify Meta data for create.
civicrm_api3_tag_delete() : array<string|int, mixed>: Delete an existing Tag.
civicrm_api3_tag_get() : array<string|int, mixed>: Get a Tag.
civicrm_api3_uf_field_create() : array<string|int, mixed>: Defines 'uf field' within a group.
_civicrm_api3_uf_field_create_spec() : mixed: Adjust metadata for civicrm_uf_field create.
civicrm_api3_uf_field_get() : array<string|int, mixed>: Returns array of uf groups (profiles) matching a set of one or more group properties.
civicrm_api3_uf_field_delete() : array<string|int, mixed>: Delete uf field.
_civicrm_api3_uf_field_delete_spec() : mixed: Field id accepted for backward compatibility - unset required on id.
_civicrm_api3_uf_group_create_spec() : mixed: Adjust metadata for create action.
civicrm_api3_uf_group_create() : array<string|int, mixed>: Use this API to create a new group.
civicrm_api3_uf_group_get() : array<string|int, mixed>: Returns array of uf groups (profiles) matching a set of one or more group properties.
civicrm_api3_uf_group_delete() : array<string|int, mixed>: Delete uf group.
_civicrm_api3_uf_group_getlist_defaults() : array<string|int, mixed>: Set default getlist parameters.
_civicrm_api3_uf_group_getlist_output() : array<string|int, mixed>: Format getlist output
civicrm_api3_uf_join_create() : array<string|int, mixed>: Takes an associative array and creates a uf join in the database.
_civicrm_api3_uf_join_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_uf_join_get() : array<string|int, mixed>: Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record.
civicrm_api3_uf_join_delete() : array<string|int, mixed>: Delete a CiviCRM UF_Join.
civicrm_api3_uf_match_get() : array<string|int, mixed>: Get the contact_id given a uf_id or vice versa.
civicrm_api3_uf_match_create() : array<string|int, mixed>: Create or update a UF Match record.
_civicrm_api3_uf_match_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_uf_match_delete() : array<string|int, mixed>: Delete a UF Match record.
civicrm_api3_user_get() : array<string|int, mixed>: Get details about the CMS User entity.
_civicrm_api3_user_get_spec() : mixed: Adjust Metadata for Get action.
_civicrm_api3_initialize() : mixed: Initialize CiviCRM - should be run at the start of each API function.
civicrm_api3_verify_one_mandatory() : mixed: Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking.
civicrm_api3_verify_mandatory() : mixed: Check mandatory fields are included.
civicrm_api3_create_error() : array<string|int, mixed>: Create error array.
civicrm_api3_create_success() : array<string|int, mixed>: Format array in result output style.
_civicrm_api3_load_DAO() : bool: Load the DAO of the entity.
_civicrm_api3_get_DAO() : CRM_Core_DAO|string: Return the DAO of the function or Entity.
_civicrm_api3_get_BAO() : string|null: Return the BAO name of the function or Entity.
_civicrm_api3_separate_values() : mixed: Recursive function to explode value-separated strings into arrays.
_civicrm_api3_filter_fields_for_bao() : mixed: This is a legacy wrapper for api_store_values.
_civicrm_api3_store_values() : bool: Copy values (other than id) from params to values if they exist in fields.
_civicrm_api3_get_using_query_object() : array<string|int, mixed>: Get function for query object api.
_civicrm_api3_get_query_object() : array<string|int, mixed>: Get dao query object based on input params.
_civicrm_api3_dao_set_filter() : mixed: Function transfers the filters being passed into the DAO onto the params object.
_civicrm_api3_apply_filters_to_dao() : mixed: Apply filters (e.g. high, low) to DAO object (prior to find).
_civicrm_api3_get_options_from_params() : array<string|int, mixed>: Get sort, limit etc options from the params - supporting old & new formats.
_civicrm_api3_apply_options_to_dao() : mixed: Apply options (e.g. sort, limit, order by) to DAO object (prior to find).
_civicrm_api3_build_fields_array() : array<string|int, mixed>: Build fields array.
_civicrm_api3_get_unique_name_array() : array<string|int, mixed>: Build fields array.
_civicrm_api3_dao_to_array() : array<string|int, mixed>: Converts an DAO object to an array.
_civicrm_api3_custom_fields_are_required() : bool: Determine if custom fields need to be retrieved.
_civicrm_api3_object_to_array() : mixed: Converts an object to an array.
_civicrm_api3_object_to_array_unique_fields() : array<string|int, mixed>: Wrapper for _civicrm_object_to_array when api supports unique fields.
_civicrm_api3_custom_format_params() : mixed: Format custom parameters.
_civicrm_api3_format_params_for_create() : mixed: Format parameters for create action.
formatCheckBoxField() : mixed: We can't rely on downstream to add separators to checkboxes so we'll check here.
_civicrm_api3_basic_get() : array<string|int, mixed>: Function to do a 'standard' api get - when the api is only doing a $bao->find then use this.
_civicrm_api3_basic_create() : array<string|int, mixed>: Function to do a 'standard' api create - when the api is only doing a $bao::create then use this.
_civicrm_api3_basic_create_fallback() : CRM_Core_DAO|null: For BAO's which don't have a create() or add() functions, use this fallback implementation.
_civicrm_api3_basic_delete() : array<string|int, mixed>: Function to do a 'standard' api del.
_civicrm_api3_custom_data_get() : mixed: Get custom data for the given entity & Add it to the returnArray.
_civicrm_api3_validate() : array<string|int, mixed>: Used by the Validate API.
_civicrm_api3_validate_switch_cases() : mixed: Used by the Validate API.
_civicrm_api3_validate_fields() : mixed: Validate fields being passed into API.
_civicrm_api3_validate_foreign_keys() : mixed: Validate foreign key values of fields being passed into API.
_civicrm_api3_validate_date() : mixed: Validate date fields being passed into API.
_civicrm_api3_getValidDate() : mixed: Convert date into BAO friendly date.
_civicrm_api3_validate_constraint() : mixed: Validate foreign constraint fields being passed into API.
_civicrm_api3_validate_unique_key() : mixed: Validate foreign constraint fields being passed into API.
_civicrm_api3_generic_replace() : array<string|int, mixed>|int: Generic implementation of the "replace" action.
_civicrm_api3_generic_replace_base_params() : array<string|int, mixed>: Replace base parameters.
_civicrm_api_get_fields() : array<string|int, mixed>: Returns fields allowable by api.
_civicrm_api_get_custom_fields() : array<string|int, mixed>: Return an array of fields for a given entity.
_civicrm_api3_swap_out_aliases() : mixed: Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't.
_civicrm_api3_validate_integer() : mixed: Validate integer fields being passed into API.
_civicrm_api3_resolve_country_id() : int|null: Helper function to determine country_id given the myriad of values for country_id or country that are supported
_civicrm_api3_resolve_contactID() : int|null|"unknown-user": Determine a contact ID using a string expression.
_civicrm_api3_validate_html() : mixed: Validate html (check for scripting attack).
_civicrm_api3_validate_string() : mixed: Validate string fields being passed into API.
_civicrm_api3_api_match_pseudoconstant() : mixed: Validate & swap out any pseudoconstants / options.
_civicrm_api3_api_match_pseudoconstant_value() : mixed: Validate & swap a single option value for a field.
_civicrm_api3_api_resolve_alias() : bool|string: Returns the canonical name of a field.
_civicrm_api3_deprecation_check() : string|array<string|int, mixed>|null: Check if the function is deprecated.
_civicrm_api3_field_value_check() : mixed: Get the actual field value.
_civicrm_api3_basic_array_get() : array<string|int, mixed>: A generic "get" API based on simple array data. This is comparable to _civicrm_api3_basic_get but does not use DAO/BAO. This is useful for small/mid-size data loaded from external JSON or XML documents.
_civicrm_api3_check_edit_permissions() : mixed
_civicrm_api3_compare_timestamps() : bool: Check if an entity has been modified since the last known modified_date
civicrm_api3_website_create() : array<string|int, mixed>: Add an Website for a contact.
_civicrm_api3_website_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_website_delete() : array<string|int, mixed>: Deletes an existing Website.
civicrm_api3_website_get() : array<string|int, mixed>: Retrieve one or more websites.
civicrm_api3_word_replacement_get() : array<string|int, mixed>: Get CiviCRM Word Replacement details.
civicrm_api3_word_replacement_create() : array<string|int, mixed>: Create a new Word Replacement.
_civicrm_api3_word_replacement_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_word_replacement_delete() : array<string|int, mixed>: Delete an existing WordReplacement.
civicrm_api3_grant_create() : array<string|int, mixed>: Create/update Grant.
_civicrm_api3_grant_create_spec() : mixed: Adjust Metadata for Create action.
civicrm_api3_grant_get() : array<string|int, mixed>: Returns array of grants matching a set of one or more properties.
civicrm_api3_grant_delete() : array<string|int, mixed>: This method is used to delete an existing Grant.

civicrm_api()

The original API wrapper.

Not recommended for new code but ok for existing code to continue using.

Calling civicrm_api() is functionally identical to civicrm_api3() or civicrm_api4() except:

It requires $params['version'].
It catches exceptions and returns an array like ['is_error' => 1, 'error_message' => ...]. This is disfavored for typical business-logic/hooks/forms/etc. However, if an existing caller handles civicrm_api()-style errors, then there is no functional benefit to reworking it.


    
                    civicrm_api(string $entity, string $action, array<string|int, mixed> $params) : array<string|int, mixed>|int|Result

Parameters

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

Return values

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

civicrm_api4()

CiviCRM API version 4.


    
                    civicrm_api4(string $entity, string $action[, array<string|int, mixed> $params = [] ][, string|int|array<string|int, mixed> $index = NULL ]) : Result

This API (Application Programming Interface) is used to access and manage data in CiviCRM.

APIv4 is the latest stable version.

Parameters

$entity : string

Name of the CiviCRM entity to access. All entity names are capitalized CamelCase, e.g. ContributionPage. Most entities correspond to a database table (e.g. Contact is the table civicrm_contact). For a complete list of available entities, call civicrm_api4('Entity', 'get');

$action : string

The "verb" of the api call. For a complete list of actions for a given entity (e.g. Contact), call civicrm_api4('Contact', 'getActions');

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

An array of API input keyed by parameter name. The easiest way to discover all available parameters is to visit the API Explorer on your CiviCRM site. The API Explorer is listed in the CiviCRM menu under Support -> Developer.

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

Controls the Result array format. By default the api Result contains a non-associative array of data. Passing an $index tells the api to automatically reformat the array, depending on the variable type passed:

Integer: return a single result array; e.g. $index = 0 will return the first result, 1 will return the second, and -1 will return the last.

For APIv4 Explorer, use e.g. 0 in the Index box.
String: index the results by a field value; e.g. $index = "name" will return an associative array with the field 'name' as keys.

For APIv4 Explorer, use e.g. name in the Index box.
Non-associative array: return a single value from each result; e.g. $index = ['title'] will return a non-associative array of strings - the 'title' field from each result.

For APIv4 Explorer, use e.g. [title] in the Index box.
Associative array: a combination of the previous two modes; e.g. $index = ['name' => 'title'] will return an array of strings - the 'title' field keyed by the 'name' field.

For APIv4 Explorer, use e.g. {name: title} in the Index box.

Return values

Result

civicrm_api3()

Version 3 wrapper for civicrm_api.


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

Throws exception.

Parameters

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

Return values

array<string|int, mixed>|int —

Dependent on the $action

_civicrm_api3_api_getfields()

Call getfields from api wrapper.


    
                    _civicrm_api3_api_getfields(array<string|int, mixed> &$apiRequest) : array<string|int, mixed>

This function ensures that settings that could alter getfields output (e.g. action for all api & profile_id for profile api ) are consistently passed in.

We check whether the api call is 'getfields' because if getfields is being called we return an empty array as no alias swapping, validation or default filling is done on getfields & we want to avoid a loop

Parameters

$apiRequest : array<string|int, mixed>

Return values

array<string|int, mixed> —

getfields output

civicrm_error()

Check if the result is an error. Note that this function has been retained from api v2 for convenience but the result is more standardised in v3 and param 'format.is_success' => 1 will result in a boolean success /fail being returned if that is what you need.


    
                    civicrm_error(mixed $result) : bool

Parameters

$result : mixed

Return values

bool —

true if error, false otherwise

_civicrm_api_get_camel_name()

Get camel case version of entity name.


    
                    _civicrm_api_get_camel_name(string|null $entity) : string|null

Parameters

$entity : string|null

Return values

string|null

_civicrm_api_replace_variables()

Swap out any $values vars.


    
                    _civicrm_api_replace_variables(array<string|int, mixed> &$params, array<string|int, mixed> &$parentResult[, string $separator = '.' ]) : mixed

Ie. the value after $value is swapped for the parent $result 'activity_type_id' => '$value.testfield', 'tag_id' => '$value.api.tag.create.id', 'tag1_id' => '$value.api.entity.create.0.id'

Parameters

$params : array<string|int, mixed>
$parentResult : array<string|int, mixed>
$separator : string = '.'

_civicrm_api_replace_variable()

Swap out a $value.foo variable with the value from parent api results.


    
                    _civicrm_api_replace_variable(string $value, array<string|int, mixed> $parentResult, string $separator) : mixed|null

Called by _civicrm_api_replace_variables to do the substitution.

Parameters

$value : string
$parentResult : array<string|int, mixed>
$separator : string

Return values

mixed|null

_civicrm_api_get_entity_name_from_camel()

Convert possibly camel name to underscore separated entity name.


    
                    _civicrm_api_get_entity_name_from_camel(string $entity) : string

Parameters

$entity : string: Entity name in various formats e.g. Contribution, contribution, OptionValue, option_value, UFJoin, uf_join.

Return values

string —

Entity name in underscore separated format.

_civicrm_api_get_entity_name_from_dao()

Having a DAO object find the entity name.


    
                    _civicrm_api_get_entity_name_from_dao(CRM_Core_DAO $bao) : string

Parameters

$bao : CRM_Core_DAO: DAO being passed in.

Return values

string

civicrm_api3_acl_create()

Save an Acl.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_acl_create_spec()

Acl create metadata.


    
                    _civicrm_api3_acl_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_acl_get()

Get an Acl.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_acl_delete()

Delete an Acl.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_acl_role_create()

Save an AclRole.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_acl_role_create_spec()

AclRole create metadata.


    
                    _civicrm_api3_acl_role_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_acl_role_get()

Get an AclRole.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_acl_role_delete()

Delete an AclRole.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_action_schedule_get()

Get CiviCRM ActionSchedule details.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_action_schedule_create()

Create a new ActionSchedule.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_action_schedule_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_action_schedule_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_action_schedule_delete()

Delete an existing ActionSchedule.


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

Parameters

$params : array<string|int, mixed>: Array containing id of the action_schedule to be deleted.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_activity_create()

Creates or updates an Activity.


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

Parameters

$params : array<string|int, mixed>: Array per getfields documentation.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_activity_create_spec()

Specify Meta data for create.


    
                    _civicrm_api3_activity_create_spec(array<string|int, mixed> &$params) : mixed

Note that this data is retrievable via the getfields function and is used for pre-filling defaults and ensuring mandatory requirements are met.

Parameters

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

_civicrm_api3_activity_get_spec()

Specify Metadata for get.


    
                    _civicrm_api3_activity_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_activity_get()

Gets a CiviCRM activity according to parameters.


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

Parameters

$params : array<string|int, mixed>: Array per getfields documentation.

Return values

array<string|int, mixed> —

API result array

_civicrm_activity_get_handleSourceContactNameOrderBy()

Handle source_contact_name as a sort parameter.


    
                    _civicrm_activity_get_handleSourceContactNameOrderBy(array<string|int, mixed> &$params, array<string|int, mixed> &$options, CRM_Utils_SQL_Select $sql) : mixed

This is passed from the activity selector - e.g search results or contact tab.

It's a non-standard handling but this api already handles variations on handling source_contact as a filter & as a field so it's in keeping with that. Source contact has a one-one relationship with activity table.

Test coverage in CRM_Activity_BAO_ActivtiyTest::testGetActivitiesforContactSummaryWithSortOptions

Parameters

$params : array<string|int, mixed>
$options : array<string|int, mixed>
$sql : CRM_Utils_SQL_Select

_civicrm_api3_activity_get_extraFilters()

Support filters beyond what basic_get can do.


    
                    _civicrm_api3_activity_get_extraFilters(array<string|int, mixed> &$params, CRM_Utils_SQL_Select &$sql) : mixed

Parameters

$params : array<string|int, mixed>
$sql : CRM_Utils_SQL_Select

_civicrm_api3_activity_get_formatResult()

Given a list of activities, append any extra data requested about the activities.


    
                    _civicrm_api3_activity_get_formatResult(array<string|int, mixed> $params, array<string|int, mixed> $activities, array<string|int, mixed> $options) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>: API request parameters.
$activities : array<string|int, mixed>
$options : array<string|int, mixed>: Options array (pre-processed to extract 'return' from params).

Return values

array<string|int, mixed> —

new activities list

_civicrm_api3_activity_fill_activity_contact_names()

Append activity contact details to activity results.


    
                    _civicrm_api3_activity_fill_activity_contact_names(array<string|int, mixed> &$activities, array<string|int, mixed> $params, array<string|int, mixed> $returns) : mixed

Adds id & name of activity contacts to results array if check_permissions does not block access to them.

For historical reasons source_contact_id is always added & is not an array. The others are added depending on requested return params.

Parameters

$activities : array<string|int, mixed>
$params : array<string|int, mixed>
$returns : array<string|int, mixed>

civicrm_api3_activity_delete()

Delete a specified Activity.


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

Parameters

$params : array<string|int, mixed>: Array holding 'id' of activity to be deleted.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_activity_check_params()

Check for required params.


    
                    _civicrm_api3_activity_check_params(array<string|int, mixed> &$params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>: Associated array of fields.

Return values

array<string|int, mixed> —

array with errors

_civicrm_api3_activity_getlist_params()

Get parameters for activity list.


    
                    _civicrm_api3_activity_getlist_params(array<string|int, mixed> &$request) : mixed

Parameters

$request : array<string|int, mixed>: API request.

_civicrm_api3_activity_getlist_output()

Get output for activity list.


    
                    _civicrm_api3_activity_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>
$request : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_activity_contact_create()

Add a record relating a contact with an activity.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_activity_contact_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_activity_contact_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_activity_contact_delete()

Delete an existing ActivityContact record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_activity_contact_get()

Get a ActivityContact.


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

Parameters

$params : array<string|int, mixed>: An associative array of name/value pairs.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_activity_type_deprecation()

Notification of deprecated function.

api notice


    
                    _civicrm_api3_activity_type_deprecation() : string

Return values

string —

to indicate this entire api entity is deprecated

civicrm_api3_activity_type_get()

Retrieve activity types.

use the getoptions action instead


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

activity types keyed by id

civicrm_api3_activity_type_create()

Create activity type.

use the OptionValue api instead


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

created / updated activity type

_civicrm_api3_activity_type_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_activity_type_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_activity_type_delete()

Delete ActivityType.

use OptionValue api


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

Parameters

$params : array<string|int, mixed>: Array including id of activity_type to delete.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_address_create()

Add an Address for a contact.


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

FIXME: Should be using basic_create util

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_address_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_address_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

_civicrm_api3_address_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_address_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_address_delete()

Delete an existing Address.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_address_get()

Retrieve one or more addresses.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_attachment_create_spec()

Adjust metadata for "create" action.


    
                    _civicrm_api3_attachment_create_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>: List of fields.

civicrm_api3_attachment_create()

Create an Attachment.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_attachment_get_spec()

Adjust metadata for get action.


    
                    _civicrm_api3_attachment_get_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>: List of fields.

civicrm_api3_attachment_get()

Get Attachment.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

per APIv3

_civicrm_api3_attachment_delete_spec()

Adjust metadata for Attachment delete action.


    
                    _civicrm_api3_attachment_delete_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>

civicrm_api3_attachment_delete()

Delete Attachment.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

__civicrm_api3_attachment_find()

Attachment find helper.


    
                    __civicrm_api3_attachment_find(array<string|int, mixed> $params, int|null $id, array<string|int, mixed> $file, array<string|int, mixed> $entityFile, bool $isTrusted) : CRM_Core_DAO

Parameters

$params : array<string|int, mixed>
$id : int|null: the user-supplied ID of the attachment record
$file : array<string|int, mixed>: The user-supplied vales for the file (mime_type, description, upload_date).
$entityFile : array<string|int, mixed>: The user-supplied values of the entity-file (entity_table, entity_id).
$isTrusted : bool

Return values

CRM_Core_DAO

_civicrm_api3_attachment_parse_params()

Attachment parsing helper.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

(0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content, 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent)

array $file: whitelisted fields that can pass through directly to civicrm_file
array $entityFile: whitelisted fields that can pass through directly to civicrm_entity_file
string $name: the printable name
string $moveFile: the full path to a local file whose content should be loaded
bool $isTrusted: whether we trust the requester to do sketchy things (like moving files or reassigning entities)
bool $returnContent: whether we are expected to return the full content of the file

_civicrm_api3_attachment_format_result()

Attachment result formatting helper.


    
                    _civicrm_api3_attachment_format_result(CRM_Core_DAO_File $fileDao, CRM_Core_DAO_EntityFile $entityFileDao, bool $returnContent, bool $isTrusted) : array<string|int, mixed>

Parameters

$fileDao : CRM_Core_DAO_File: Maybe "File" or "File JOIN EntityFile".
$entityFileDao : CRM_Core_DAO_EntityFile: Maybe "EntityFile" or "File JOIN EntityFile".
$returnContent : bool: Whether to return the full content of the file.
$isTrusted : bool: Whether the current request is trusted to perform file-specific operations.

Return values

array<string|int, mixed>

_civicrm_api3_attachment_getfields()

Attachment getfields helper.


    
                    _civicrm_api3_attachment_getfields() : array<string|int, mixed>

Return values

array<string|int, mixed> —

list of fields (indexed by name)

civicrm_api3_batch_create()

Save a Batch.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_batch_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_batch_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_batch_get()

Get a Batch.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved batch property values.

civicrm_api3_batch_delete()

Delete a Batch.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_campaign_create()

Create/update Campaign.


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

This API is used to create new campaign or update any of the existing In case of updating existing campaign, id of that particular campaign must be in $params array.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_campaign_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_campaign_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_campaign_get()

Returns array of campaigns matching a set of one or more properties.


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

Parameters

$params : array<string|int, mixed>: Array per getfields

Return values

array<string|int, mixed> —

Array of matching campaigns

civicrm_api3_campaign_delete()

Delete an existing campaign.


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

This method is used to delete any existing campaign. Id of the campaign to be deleted is required field in $params array

Parameters

$params : array<string|int, mixed>: array containing id of the group to be deleted

Return values

array<string|int, mixed>

_civicrm_api3_campaign_getlist_params()

Get campaign list parameters.


    
                    _civicrm_api3_campaign_getlist_params(array<string|int, mixed> &$request) : mixed

Parameters

$request : array<string|int, mixed>

_civicrm_api3_campaign_getlist_output()

Get campaign list output.


    
                    _civicrm_api3_campaign_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>
$request : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_case_create()

Open a new case, add client and manager roles, and standard timeline.


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

Parameters

$params : array<string|int, mixed>

// REQUIRED for create:
'case_type_id' => int OR
'case_type' => str (provide one or the other)
'contact_id' => int // case client
'subject' => str
// REQUIRED for update:
'id' => case Id

//OPTIONAL
'medium_id' => int // see civicrm option values for possibilities
'creator_id' => int // case manager, default to the logged in user
'status_id' => int // defaults to 1 "ongoing"
'location' => str
'start_date' => str datestamp // defaults to: date('YmdHis')
'duration' => int // in minutes
'details' => str // html format

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_case_create_xmlProcessor()

When creating a new case, run the xmlProcessor to get all necessary params/configuration for the new case, as cases use an xml file to store their configuration.


    
                    _civicrm_api3_case_create_xmlProcessor(array<string|int, mixed> $params, CRM_Case_DAO_Case $caseBAO) : mixed

Parameters

$params : array<string|int, mixed>
$caseBAO : CRM_Case_DAO_Case

_civicrm_api3_case_get_spec()

Adjust Metadata for Get Action.


    
                    _civicrm_api3_case_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

_civicrm_api3_case_create_spec()

Adjust Metadata for Create Action.


    
                    _civicrm_api3_case_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

_civicrm_api3_case_update_spec()

Adjust Metadata for Update action.


    
                    _civicrm_api3_case_update_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

_civicrm_api3_case_delete_spec()

Adjust Metadata for Delete action.


    
                    _civicrm_api3_case_delete_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_case_get()

Get details of a particular case, or search for cases, depending on params.


    
                    civicrm_api3_case_get(array<string|int, mixed> $params[, mixed $sql = NULL ]) : array<string|int, mixed>

Please provide one (and only one) of the four get/search parameters:

Parameters

$params : array<string|int, mixed>: 'id' => if set, will get all available info about a case, including contacts and activities

// if no case_id provided, this function will use one of the following search parameters: 'client_id' => finds all cases with a specific client 'activity_id' => returns the case containing a specific activity 'contact_id' => finds all cases associated with a contact (in any role, not just client) $params CRM_Utils_SQL_Select $sql Other apis wishing to wrap & extend this one can pass in a $sql object with extra clauses
$sql : mixed = NULL

Return values

array<string|int, mixed> —

(get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found

civicrm_api3_case_activity_create()

Deprecated API.


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

Use activity API instead.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_case_addtimeline()

Add a timeline to a case.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_case_addtimeline_spec()

Adjust Metadata for addtimeline action.


    
                    _civicrm_api3_case_addtimeline_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_case_merge()

Merge 2 cases.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_case_merge_spec()

Adjust Metadata for merge action.


    
                    _civicrm_api3_case_merge_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

_civicrm_api3_case_deprecation()

Declare deprecated api functions.

api notice


    
                    _civicrm_api3_case_deprecation() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deprecated actions

civicrm_api3_case_update()

Update a specified case. Use civicrm_api3_case_create() instead.


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

Parameters

$params : array<string|int, mixed>: //REQUIRED: 'case_id' => int

//OPTIONAL 'status_id' => int 'start_date' => str datestamp 'contact_id' => int // case client

Return values

array<string|int, mixed> —

api result array

civicrm_api3_case_delete()

Delete a specified case.


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

Parameters

$params : array<string|int, mixed>

  //REQUIRED:
  'id' => int

  //OPTIONAL
  'move_to_trash' => bool (defaults to false)

_civicrm_api3_case_restore_spec()

Case.restore API specification


    
                    _civicrm_api3_case_restore_spec(array<string|int, mixed> &$spec) : void

Parameters

$spec : array<string|int, mixed>: description of fields supported by this API call

civicrm_api3_case_restore()

Restore a specified case from the trash.


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

Parameters

$params : array<string|int, mixed>

_civicrm_api3_case_read()

Augment case results with extra data.


    
                    _civicrm_api3_case_read(array<string|int, mixed> &$cases, array<string|int, mixed> $options) : mixed

Parameters

$cases : array<string|int, mixed>
$options : array<string|int, mixed>

_civicrm_api3_case_format_params()

Internal function to format create params for processing.


    
                    _civicrm_api3_case_format_params(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_case_getList()

It actually works a lot better to use the CaseContact api instead of the Case api for entityRef fields so we can perform the necessary joins, so we pass off getlist requests to the CaseContact api.


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

Parameters

$params : array<string|int, mixed>

_civicrm_api3_case_getlist_spec()

Needed due to the above override


    
                    _civicrm_api3_case_getlist_spec(array<string|int, mixed> &$params, array<string|int, mixed> $apiRequest) : mixed

Parameters

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

civicrm_api3_case_getoptions()


    
                    civicrm_api3_case_getoptions(mixed $params) : mixed

Parameters

$params : mixed

civicrm_api3_case_contact_create()

Save a CaseContact.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_case_contact_create_spec()


    
                    _civicrm_api3_case_contact_create_spec(array<string|int, mixed> &$fields) : mixed

Parameters

$fields : array<string|int, mixed>

civicrm_api3_case_contact_get()

Get a CaseContact.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved case_contact property values.

civicrm_api3_case_contact_delete()

Delete a CaseContact.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

_civicrm_api3_case_contact_getlist_output()

Results formatting for Case entityRef lookups.


    
                    _civicrm_api3_case_contact_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request, string $entity, array<string|int, mixed> $fields) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>
$request : array<string|int, mixed>
$entity : string
$fields : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_case_type_create()

Create or update case type.


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

Parameters

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

Return values

array<string|int, mixed> —

API result array

civicrm_api3_case_type_get()

Retrieve case types.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

case types keyed by id

_civicrm_api3_case_type_get_formatResult()

Format definition.


    
                    _civicrm_api3_case_type_get_formatResult(array<string|int, mixed> &$result[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

civicrm_api3_case_type_delete()

Function to delete case type.


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

Parameters

$params : array<string|int, mixed>: Array including id of CaseType to delete.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_constant_deprecation()

Declare deprecated api entity.

api notice


    
                    _civicrm_api3_constant_deprecation() : string

Return values

string —

to indicate this entire api entity is deprecated

civicrm_api3_constant_get()

Get constant values (deprecated).

as of CiviCRM 4.4. It's recommended to use the api getoptions action instead


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

Parameters

$params : array<string|int, mixed>: Name of a public static method of CRM_Core_PseudoConstant: one of activityStatus activityType addressee allGroup country countryIsoCode county currencyCode currencySymbols customGroup emailGreeting fromEmailAddress gender group groupIterator honor IMProvider individualPrefix individualSuffix locationType locationVcardName mailProtocol mappingTypes paymentProcessor paymentProcessorType pcm phoneType postalGreeting priority relationshipType stateProvince stateProvinceAbbreviation stateProvinceForCountry staticGroup tag tasks ufGroup visibility worldRegion wysiwygEditor

Return values

array<string|int, mixed>

_civicrm_api3_constant_get_spec()

Adjust metadata for constant get action.


    
                    _civicrm_api3_constant_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_contact_create()

Create or update a Contact.


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

Parameters

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

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_contact_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_contact_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_contact_get()

Retrieve one or more contacts, given a set of search params.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Result Array

civicrm_api3_contact_getcount()

Get number of contacts matching the supplied criteria.


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

Parameters

$params : array<string|int, mixed>

Return values

int

_civicrm_api3_contact_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_contact_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

_civicrm_api3_contact_get_supportanomalies()

Support for historical oddities.


    
                    _civicrm_api3_contact_get_supportanomalies(array<string|int, mixed> &$params, array<string|int, mixed> &$options) : mixed

We are supporting 'showAll' = 'all', 'trash' or 'active' for Contact get and for getcount

hopefully some day we'll come up with a std syntax for the 3-way-boolean of 0, 1 or not set

We also support 'filter_group_id' & 'filter.group_id'

Parameters

$params : array<string|int, mixed>: As passed into api get or getcount function.
$options : array<string|int, mixed>: Array of options (so we can modify the filter).

civicrm_api3_contact_delete()

Delete a Contact with given contact_id.


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

Parameters

$params : array<string|int, mixed>: input parameters per getfields

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_contact_check_params()

Check parameters passed in.


    
                    _civicrm_api3_contact_check_params(array<string|int, mixed> &$params) : null

This function is on it's way out.

Parameters

$params : array<string|int, mixed>

Return values

null

_civicrm_api3_contact_update()

Helper function for Contact create.


    
                    _civicrm_api3_contact_update(array<string|int, mixed> $params[, int $contactID = NULL ]) : CRM_Contact_BAO_Contact|CRM_Core_Error

Parameters

$params : array<string|int, mixed>: (reference ) an assoc array of name/value pairs.
$contactID : int = NULL: If present the contact with that ID is updated.

Return values

CRM_Contact_BAO_Contact|CRM_Core_Error

_civicrm_api3_greeting_format_params()

Validate the addressee or email or postal greetings.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

_civicrm_api3_quicksearch_get_order_by()

Get the order by string for the quicksearch query.


    
                    _civicrm_api3_quicksearch_get_order_by(string $name, bool $isPrependWildcard, string $field_name) : string

Get the order by string. The string might be

sort name if there is no search value provided and the site is configured to search by sort name
empty if there is no search value provided and the site is not configured to search by sort name
exactFirst and then sort name if a search value is provided and the site is configured to search by sort name
exactFirst if a search value is provided and the site is not configured to search by sort name

exactFirst means 'yes if the search value exactly matches the searched field. else no'. It is intended to prioritise exact matches for the entered string so on a first name search for 'kath' contacts with a first name of exactly Kath rise to the top.

On short strings it is expensive. Per CRM-19547 there is still an open question as to whether we should only do exactMatch on a minimum length or on certain fields.

However, we have mitigated this somewhat by not doing an exact match search on empty strings, non-wildcard sort-name searches and email searches where there is no @ after the first character.

For the user it is further mitigated by the fact they just don't know the slower queries are firing. If they type 'smit' slowly enough 4 queries will trigger but if the first 3 are slow the first result they see may be off the 4th query.

Parameters

$name : string
$isPrependWildcard : bool
$field_name : string

Return values

string

civicrm_api3_contact_merge()

Merges given pair of duplicate contacts.


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

Parameters

$params : array<string|int, mixed>: Allowed array keys are: -int to_keep_id: main contact id with whom merge has to happen -int to_remove_id: duplicate contact which would be deleted after merge operation -string mode: "safe" skips the merge if there are no conflicts. Does a force merge otherwise.

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_contact_merge_spec()

Adjust metadata for contact_merge api function.


    
                    _civicrm_api3_contact_merge_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_contact_get_merge_conflicts()

Determines if given pair of contaacts have conflicts that would affect merging them.


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

Parameters

$params : array<string|int, mixed>: Allowed array keys are: -int main_id: main contact id with whom merge has to happen -int other_id: duplicate contact which would be deleted after merge operation -string mode: "safe" skips the merge if there are no conflicts. Does a force merge otherwise.

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_contact_get_merge_conflicts_spec()

Adjust metadata for contact_merge api function.


    
                    _civicrm_api3_contact_get_merge_conflicts_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_contact_getmergedto()

Get the ultimate contact a contact was merged to.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_contact_getmergedto()

Get the contact our contact was finally merged to.


    
                    _civicrm_api3_contact_getmergedto(array<string|int, mixed> $params) : int|false

If the contact has been merged multiple times the crucial parent activity will have wound up on the ultimate contact so we can figure out the final resting place of the contact with only 2 activities even if 50 merges took place.

Parameters

$params : array<string|int, mixed>

Return values

int|false

_civicrm_api3_contact_getmergedto_spec()

Adjust metadata for contact_merge api function.


    
                    _civicrm_api3_contact_getmergedto_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_contact_getmergedfrom()

Get the ultimate contact a contact was merged to.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_contact_getmergedfrom()

Get all the contacts merged into our contact.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_contact_getmergedfrom_spec()

Adjust metadata for contact_merge api function.


    
                    _civicrm_api3_contact_getmergedfrom_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_contact_proximity_spec()

Adjust metadata for contact_proximity api function.


    
                    _civicrm_api3_contact_proximity_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_contact_proximity()

Get contacts by proximity.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_contact_getlist_params()

Get parameters for getlist function.


    
                    _civicrm_api3_contact_getlist_params(array<string|int, mixed> &$request) : mixed

Parameters

$request : array<string|int, mixed>

_civicrm_api3_contact_getlist_output()

Get output for getlist function.


    
                    _civicrm_api3_contact_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>
$request : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_contact_duplicatecheck()

Check for duplicate contacts.


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

Parameters

$params : array<string|int, mixed>: Params per getfields metadata.

Return values

array<string|int, mixed> —

API formatted array

_civicrm_api3_contact_duplicatecheck_spec()

Declare metadata for contact dedupe function.


    
                    _civicrm_api3_contact_duplicatecheck_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_contact_type_create()

Create/update ContactType.


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

This API is used to create new ContactType or update any of the existing In case of updating existing ContactType, id of that particular ContactType must be in $params array.

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

ContactType array

civicrm_api3_contact_type_get()

Returns array of contact_types matching a set of one or more properties.


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

Parameters

$params : array<string|int, mixed>: One or more valid property_name=>value pairs. If $params is set as null, all contact_types will be returned

Return values

array<string|int, mixed> —

Array of matching contact_types

civicrm_api3_contact_type_delete()

Delete an existing ContactType.


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

This method is used to delete any existing ContactType given its id.

Parameters

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

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_contribution_transact_spec()

Adjust Metadata for Transact action.


    
                    _civicrm_api3_contribution_transact_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_contribution_transact()

Process a transaction and record it against the contact.


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

Parameters

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

Return values

array<string|int, mixed> —

contribution of created or updated record (or a civicrm error)

civicrm_api3_contribution_create()

Add or update a Contribution.


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

Parameters

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

Return values

array<string|int, mixed> —

Api result array

_civicrm_api3_contribution_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_contribution_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_contribution_create_legacy_support_45()

Support for schema changes made in 4.5.


    
                    _civicrm_api3_contribution_create_legacy_support_45(array<string|int, mixed> &$params) : mixed

The main purpose of the API is to provide integrators a level of stability not provided by the core code or schema - this means we have to provide support for api calls (where possible) across schema changes.

Parameters

$params : array<string|int, mixed>

civicrm_api3_contribution_delete()

Delete a Contribution.


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

Parameters

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

Return values

array<string|int, mixed>

_civicrm_api3_contribution_delete_spec()

Modify metadata for delete action.


    
                    _civicrm_api3_contribution_delete_spec(array<string|int, mixed> &$params) : mixed

Legacy support for contribution_id.

Parameters

$params : array<string|int, mixed>

civicrm_api3_contribution_get()

Retrieve a set of contributions.


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

Parameters

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

Return values

array<string|int, mixed> —

Array of contributions, if error an array with an error id and error message

_civicrm_api3_contribution_get_support_nonunique_returns()

Fix the return values to reflect cases where the schema has been changed.


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

At the query object level using uniquenames dismbiguates between tables.

However, adding uniquename can change inputs accepted by the api, so we need to ensure we are asking for the unique name return fields.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_contribution_add_supported_fields()

Support for supported output variables.


    
                    _civicrm_api3_contribution_add_supported_fields(array<string|int, mixed> &$contribution) : mixed

Parameters

$contribution : array<string|int, mixed>

civicrm_api3_contribution_getcount()

Get number of contacts matching the supplied criteria.


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

Parameters

$params : array<string|int, mixed>

Return values

int

_civicrm_api3_format_soft_credit()

This function is used to format the soft credit for backward compatibility.


    
                    _civicrm_api3_format_soft_credit(array<string|int, mixed> &$contribution) : mixed

As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key but we still return first soft credit as a part of contribution array

Parameters

$contribution : array<string|int, mixed>

_civicrm_api3_contribution_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_contribution_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_contribute_format_params()

Legacy handling for contribution parameters.


    
                    _civicrm_api3_contribute_format_params(array<string|int, mixed> $params, array<string|int, mixed> &$values) : array<string|int, mixed>

Take the input parameter list as specified in the data model and convert it into the same format that we use in QF and BAO object.

Parameters

$params : array<string|int, mixed>: property name/value pairs to insert in new contact.
$values : array<string|int, mixed>: The reformatted properties that we can use internally.

Return values

array<string|int, mixed>

civicrm_api3_contribution_sendconfirmation()

Send a contribution confirmation (receipt or invoice).


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

The appropriate online template will be used (the existence of related objects (e.g. memberships ) will affect this selection

Parameters

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

_civicrm_api3_contribution_sendconfirmation_spec()

Adjust Metadata for sendconfirmation action.


    
                    _civicrm_api3_contribution_sendconfirmation_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_contribution_completetransaction()

Complete an existing (pending) transaction.


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

This will update related entities (participant, membership, pledge etc) and take any complete actions from the contribution page (e.g. send receipt).

Parameters

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

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_contribution_completetransaction_spec()

Provide function metadata.


    
                    _civicrm_api3_contribution_completetransaction_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_contribution_repeattransaction()

Complete an existing (pending) transaction.


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

This will update related entities (participant, membership, pledge etc) and take any complete actions from the contribution page (e.g. send receipt).

Parameters

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

Return values

array<string|int, mixed> —

Api result array.

_civicrm_api3_contribution_repeattransaction_spec()

Provide function metadata.


    
                    _civicrm_api3_contribution_repeattransaction_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_contribution_deprecation()

Declare deprecated functions.


    
                    _civicrm_api3_contribution_deprecation() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deprecated actions

civicrm_api3_contribution_page_create()

Create or update a ContributionPage.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_contribution_page_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_contribution_page_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

civicrm_api3_contribution_page_get()

Returns array of ContributionPage(s) matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API Result array Array of matching contribution_pages

civicrm_api3_contribution_page_delete()

Delete an existing ContributionPage.


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

This method is used to delete any existing ContributionPage given its id.

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result Array

civicrm_api3_contribution_page_submit()

Submit a ContributionPage.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_contribution_page_validate()

Validate ContributionPage submission parameters.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_contribution_page_validate_spec()

Metadata for validate action.


    
                    _civicrm_api3_contribution_page_validate_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_contribution_page_getlist_defaults()

Set default getlist parameters.


    
                    _civicrm_api3_contribution_page_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>

Parameters

$request : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_contribution_page_deprecation()


    
                    _civicrm_api3_contribution_page_deprecation() : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_contribution_product_create()

Save a contribution product.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_contribution_product_get()

Get a contribution product.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved product property values.

civicrm_api3_contribution_product_delete()

Delete a contribution product.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_contribution_recur_create()

Create or update a ContributionRecur.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_contribution_recur_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_contribution_recur_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_contribution_recur_get()

Returns array of contribution_recurs matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array of properties. If empty, all records will be returned.

Return values

array<string|int, mixed> —

API result Array of matching contribution_recurs

civicrm_api3_contribution_recur_cancel()

Cancel a recurring contribution of existing ContributionRecur given its id.


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

Parameters

$params : array<string|int, mixed>: Array containing id of the recurring contribution.

Return values

array<string|int, mixed> —

returns true is successfully cancelled

_civicrm_api3_contribution_recur_cancel_spec()

Adjust Metadata for Cancel action.


    
                    _civicrm_api3_contribution_recur_cancel_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_contribution_recur_delete()

Delete an existing ContributionRecur.


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

This method is used to delete an existing ContributionRecur given its id.

Parameters

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

Return values

array<string|int, mixed> —

API result array

civicrm_api3_contribution_soft_create()

Create or Update a Soft Credit.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_contribution_soft_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_contribution_soft_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_contribution_soft_delete()

Deletes an existing Soft Credit.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Api formatted result.

civicrm_api3_contribution_soft_get()

Retrieve one or more Soft Credits.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result

civicrm_api3_country_create()

Add an Country for a contact.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_country_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_country_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_country_delete()

Deletes an existing Country.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_country_get()

Retrieve one or more countryies.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

api result array

civicrm_api3_custom_field_create()

Create a 'custom field' within a custom field group.


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

We also empty the static var in the getfields function after deletion so that the field is available for us (getfields manages date conversion among other things

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API success array

_civicrm_api3_custom_field_flush_static_caches()

Flush static caches in functions that might have stored available custom fields.


    
                    _civicrm_api3_custom_field_flush_static_caches() : mixed

_civicrm_api3_custom_field_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_custom_field_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_custom_field_delete()

Use this API to delete an existing custom field.


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

Parameters

$params : array<string|int, mixed>: Array id of the field to be deleted.

Return values

array<string|int, mixed>

civicrm_api3_custom_field_get()

Use this API to get existing custom fields.


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

Parameters

$params : array<string|int, mixed>: Array to search on.

Return values

array<string|int, mixed>

_civicrm_api3_custom_field_validate_field()

Helper function to validate custom field value.


    
                    _civicrm_api3_custom_field_validate_field(string $fieldName, mixed $value, array<string|int, mixed> $fieldDetails[, array<string|int, mixed> &$errors = [] ]) : array<string|int, mixed>|null

Parameters

$fieldName : string: Custom field name (eg: custom_8 ).
$value : mixed: Field value to be validate.
$fieldDetails : array<string|int, mixed>: Field Details.
$errors : array<string|int, mixed> = []: Collect validation errors.

Return values

array<string|int, mixed>|null —

Validation errors

civicrm_api3_custom_field_setvalue()

CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

civicrm_api3_custom_field_getoptions()


    
                    civicrm_api3_custom_field_getoptions(mixed $params) : mixed

Parameters

$params : mixed

civicrm_api3_custom_group_create()

This entire function consists of legacy handling, probably for a form that no longer exists.


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

APIv3 is where code like this goes to die...

Parameters

$params : array<string|int, mixed>: For legacy reasons, 'extends' can be passed as an array (for setting Participant column_value)

Return values

array<string|int, mixed>

_civicrm_api3_custom_group_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_custom_group_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_custom_group_delete()

Use this API to delete an existing group.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_custom_group_get()

API to get existing custom fields.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

civicrm_api3_custom_group_setvalue()

CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

civicrm_api3_custom_group_getoptions()


    
                    civicrm_api3_custom_group_getoptions(mixed $params) : mixed

Parameters

$params : mixed

civicrm_api3_custom_search_get()

Retrieve custom searches.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_custom_search_create()

Add a CustomSearch.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_custom_search_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_custom_search_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_custom_search_delete()

Deletes an existing CustomSearch.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_custom_value_create()

Sets custom values for an entity.


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

Parameters

$params : array<string|int, mixed>: Expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID.

Return values

array<string|int, mixed> —

['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong']

_civicrm_api3_custom_value_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_custom_value_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_custom_value_get()

Use this API to get existing custom values for an entity.


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

Parameters

$params : array<string|int, mixed>: Array specifying the entity_id. Optionally include entity_type param, i.e. 'entity_type' => 'Activity' If no entity_type is supplied, it will be determined based on the fields you request. If no entity_type is supplied and no fields are specified, 'Contact' will be assumed. Optionally include the desired custom data to be fetched (or else all custom data for this entity will be returned) Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1 If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1

Return values

array<string|int, mixed>

_civicrm_api3_custom_value_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_custom_value_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_custom_value_gettree_spec()

CustomValue.gettree API specification


    
                    _civicrm_api3_custom_value_gettree_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>: description of fields supported by this API call

civicrm_api3_custom_value_gettree()

CustomValue.gettree API


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result

_civicrm_api3_custom_value_getdisplayvalue_spec()

CustomValue.getdisplayvalue API specification


    
                    _civicrm_api3_custom_value_getdisplayvalue_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>: description of fields supported by this API call

civicrm_api3_custom_value_getdisplayvalue()

CustomValue.getdisplayvalue API


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result

civicrm_api3_dashboard_create()

Creates or updates an Dashlet.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array containing 'is_error' to denote success or failure and details of the created activity

_civicrm_api3_dashboard_create_spec()

Specify Meta data for create.


    
                    _civicrm_api3_dashboard_create_spec(array<string|int, mixed> &$params) : mixed

Note that this data is retrievable via the getfields function and is used for pre-filling defaults and ensuring mandatory requirements are met.

Parameters

$params : array<string|int, mixed>: array of parameters determined by getfields.

civicrm_api3_dashboard_get()

Gets a CiviCRM Dashlets according to parameters.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_dashboard_delete()

Delete a specified Dashlet.


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

Parameters

$params : array<string|int, mixed>: Array holding 'id' of dashlet to be deleted.

Return values

array<string|int, mixed>

civicrm_api3_dashboard_contact_create()

Creates/Updates a new Dashboard Contact Entry.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_dashboard_contact_get()

Gets a CiviCRM Dashlets of Contacts according to parameters.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

_civicrm_api3_dashboard_contact_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_dashboard_contact_create_spec(array<string|int, mixed> &$fields) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

$fields : array<string|int, mixed>: Array of fields determined by getfields.

civicrm_api3_dashboard_contact_delete()

Delete an existing dashboard-contact.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_dedupe_get()

Get rows for any cached attempted merges on the passed criteria.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_dedupe_get_spec()

Get rows for getting dedupe cache records.


    
                    _civicrm_api3_dedupe_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_dedupe_delete()

Delete rows for any cached attempted merges on the passed criteria.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_dedupe_create()

Get the statistics for any cached attempted merges on the passed criteria.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_dedupe_getstatistics()

Get the statistics for any cached attempted merges on the passed criteria.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_dedupe_getstatistics_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_dedupe_getstatistics_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_dedupe_getduplicates()

Get the duplicate contacts for the supplied parameters.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_dedupe_getduplicates_spec()

Adjust Metadata for getduplicates action.. The metadata is used for setting defaults, documentation & validation.


    
                    _civicrm_api3_dedupe_getduplicates_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_domain_get()

Get CiviCRM Domain details.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_domain_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_domain_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_domain_create()

Create a new Domain.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_domain_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_domain_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_email_create()

Add an Email for a contact.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_email_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_email_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_email_delete()

Deletes an existing Email.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_email_get()

Retrieve one or more emails.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_email_getlist_defaults()

Set default getlist parameters.


    
                    _civicrm_api3_email_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>

Parameters

$request : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_entity_batch_get()

Get entity batches.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_entity_batch_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_entity_batch_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_entity_batch_create()

Create an entity batch.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_entity_batch_delete()

Mark entity batch as removed.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_entity_financial_account_create()

Save an Entity Financial Account record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_entity_financial_account_create_spec()

Save an Entity Financial Account record.


    
                    _civicrm_api3_entity_financial_account_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_entity_financial_account_get()

Get an Entity Financial Account record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved EntityFinancialAccount property values.

civicrm_api3_entity_financial_account_delete()

Delete an Entity Financial Account record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_entity_financial_trxn_create()

Save a Entity Financial Trxn.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_entity_financial_trxn_get()

Get a Entity Financial Trxn.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved Entity Financial Trxn property values.

civicrm_api3_entity_financial_trxn_delete()

Delete a Entity Financial Trxn.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

_civicrm_api3_entity_financial_trxn_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_entity_financial_trxn_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_entity_tag_get()

Get entity tags.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_entity_tag_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_entity_tag_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_entity_tag_create()

Create an entity tag.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_entity_tag_delete()

Mark entity tag as removed.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_entity_tag_delete_spec()

Modify metadata.


    
                    _civicrm_api3_entity_tag_delete_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_entity_tag_common()

Helper function for formatting tags (part of api v2 legacy).


    
                    _civicrm_api3_entity_tag_common(array<string|int, mixed> $params[, string $op = 'add' ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>
$op : string = 'add'

Return values

array<string|int, mixed>

civicrm_api3_entity_tag_replace()

Replace tags for an entity


    
                    civicrm_api3_entity_tag_replace(mixed $params) : mixed

Parameters

$params : mixed

civicrm_api3_event_create()

Create a Event.


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

Parameters

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

Return values

array<string|int, mixed> —

API result Array.

_civicrm_api3_event_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_event_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_event_create_legacy_support_42()

Support for schema changes made in 4.2.


    
                    _civicrm_api3_event_create_legacy_support_42(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_event_get()

Get Event record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of all found event property values.

_civicrm_api3_event_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_event_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_event_get_legacy_support_42()

Support for schema changes made in 4.2.


    
                    _civicrm_api3_event_get_legacy_support_42(array<string|int, mixed> &$event, int $event_id) : mixed

Parameters

$event : array<string|int, mixed>
$event_id : int

civicrm_api3_event_delete()

Delete an existing Event.


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

This API is used for deleting a event given its id.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_event_getisfull()

Add 'is_full' & 'available_seats' to the return array.


    
                    _civicrm_api3_event_getisfull(array<string|int, mixed> &$event, int $event_id) : mixed

(this might be better in the BAO) Default BAO function returns a string if full rather than a Bool - which is more appropriate to a form

Parameters

$event : array<string|int, mixed>: Return array of the event.
$event_id : int: Id of the event to be updated.

_civicrm_api3_event_getlist_params()

Get event list parameters.


    
                    _civicrm_api3_event_getlist_params(array<string|int, mixed> &$request) : mixed

Parameters

$request : array<string|int, mixed>

_civicrm_api3_event_getlist_output()

Get event list output.


    
                    _civicrm_api3_event_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>
$request : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_file_create()

Create a file record.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

civicrm_api3_file_get()

Get a File.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

Array of all found file object property values.

civicrm_api3_file_update()

Update an existing File.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

civicrm_api3_file_delete()

Delete an existing File.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API Result Array

civicrm_api3_financial_account_create()

Save a FinancialAccount.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_financial_account_get()

Get a FinancialAccount.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved FinancialAccount property values.

civicrm_api3_financial_account_delete()

Delete a FinancialAccount.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_financial_item_create()

Save a Financial Item.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_financial_item_get()

Get a FinancialItem.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved Financial Item property values.

civicrm_api3_financial_item_delete()

Delete a Financial Item.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_financial_trxn_create()

Save a Financial Item.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_financial_trxn_get()

Get a Financialtrxn.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved Financial trxn property values.

civicrm_api3_financial_trxn_delete()

Delete a Financial trxn.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

_civicrm_api3_financial_trxn_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_financial_trxn_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_financial_type_create()

Save a FinancialType.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_financial_type_create_spec()


    
                    _civicrm_api3_financial_type_create_spec(mixed &$params) : mixed

Parameters

$params : mixed

civicrm_api3_financial_type_get()

Get a FinancialType.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved FinancialType property values.

civicrm_api3_financial_type_delete()

Delete a FinancialType.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_generic_getActions()

Get available api actions.


    
                    civicrm_api3_generic_getActions(array<string|int, mixed> $apiRequest) : array<string|int, mixed>

Parameters

$apiRequest : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_generic_getList()

Generic api wrapper used for quicksearch and autocomplete.


    
                    civicrm_api3_generic_getList(array<string|int, mixed> $apiRequest) : mixed

Parameters

$apiRequest : array<string|int, mixed>

_civicrm_api3_generic_getlist_get_result()


    
                    _civicrm_api3_generic_getlist_get_result(mixed &$request, string $entity, mixed $meta, array<string|int, mixed> $apiRequest) : array<string|int, mixed>

Parameters

$request : mixed
$entity : string
$meta : mixed
$apiRequest : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_generic_getList_defaults()

Set defaults for api.getlist.


    
                    _civicrm_api3_generic_getList_defaults(string $entity, array<string|int, mixed> &$request, array<string|int, mixed> $apiDefaults, array<string|int, mixed> $fields) : void

Parameters

$entity : string
$request : array<string|int, mixed>
$apiDefaults : array<string|int, mixed>
$fields : array<string|int, mixed>

_civicrm_api3_generic_getlist_params()

Fallback implementation of getlist_params. May be overridden by individual apis.


    
                    _civicrm_api3_generic_getlist_params(array<string|int, mixed> &$request) : mixed

Parameters

$request : array<string|int, mixed>

_civicrm_api3_generic_getlist_output()

Fallback implementation of getlist_output. May be overridden by individual api functions.


    
                    _civicrm_api3_generic_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request, string $entity, array<string|int, mixed> $fields) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>
$request : array<string|int, mixed>
$entity : string
$fields : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_generic_getlist_postprocess()

Common postprocess for getlist output


    
                    _civicrm_api3_generic_getlist_postprocess(array<string|int, mixed> $result, array<string|int, mixed> $request, array<string|int, mixed> &$values) : mixed

Parameters

$result : array<string|int, mixed>
$request : array<string|int, mixed>
$values : array<string|int, mixed>

_civicrm_api3_generic_getlist_spec()

Provide metadata for this api


    
                    _civicrm_api3_generic_getlist_spec(array<string|int, mixed> &$params, array<string|int, mixed> $apiRequest) : mixed

Parameters

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

civicrm_api3_generic_getunique()

Generic api wrapper used to get all unique fields for a given entity.


    
                    civicrm_api3_generic_getunique(array<string|int, mixed> $apiRequest) : mixed

Parameters

$apiRequest : array<string|int, mixed>

civicrm_api3_generic_setValue()

Set a single value using the api.


    
                    civicrm_api3_generic_setValue(array<string|int, mixed> $apiRequest) : array<string|int, mixed>

This function is called when no specific setvalue api exists. Params must contain at least id=xx & {one of the fields from getfields}=value

Parameters

$apiRequest : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_generic_update()

Update function is basically a hack.


    
                    civicrm_api3_generic_update(array<string|int, mixed> $apiRequest) : array<string|int, mixed>|int|mixed

We want to remove it but must resolve issues in http://issues.civicrm.org/jira/browse/CRM-12144

It is not recommended & if update doesn't work & fix does then update will not be fixed

To do this, perform a 'get' action to load the existing values, then merge in the updates and call 'create' to save the revised entity.

Parameters

$apiRequest : array<string|int, mixed>

Array with keys:

entity: string
action: string
version: string
function: callback (mixed)
params: array, varies

Return values

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

_civicrm_api3_generic_validate_spec()

Provide meta-data for this api.


    
                    _civicrm_api3_generic_validate_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_generic_validate()

Generic api wrapper used for validation of entity-action pair.


    
                    civicrm_api3_generic_validate(array<string|int, mixed> $apiRequest) : mixed

Parameters

$apiRequest : array<string|int, mixed>

civicrm_api3_generic_getfields()

Get information about fields for a given api request.


    
                    civicrm_api3_generic_getfields(array<string|int, mixed> $apiRequest[, bool $unique = TRUE ]) : array<string|int, mixed>

Getfields information is used for documentation, validation, default setting We first query the scheme using the $dao->fields function & then augment that information by calling the _spec functions that apply to the relevant function Note that we use 'unique' field names as described in the xml/schema files for get requests & just field name for create. This is because some get functions access multiple objects e.g. contact api accesses is_deleted from the activity table & from the contact table

Parameters

$apiRequest : array<string|int, mixed>

Api request as an array. Keys are.

entity: string
action: string
version: string
function: callback (mixed)
params: array, varies

$unique : bool = TRUE

Determines whether to key by unique field names (only affects get-type) actions

Return values

array<string|int, mixed> —

API success object

civicrm_api3_generic_getfield()

Get metadata for a field


    
                    civicrm_api3_generic_getfield(array<string|int, mixed> $apiRequest) : array<string|int, mixed>

Parameters

$apiRequest : array<string|int, mixed>

Return values

array<string|int, mixed> —

API success object

_civicrm_api3_generic_getfield_spec()

Get metadata for getfield action.


    
                    _civicrm_api3_generic_getfield_spec(array<string|int, mixed> &$params, array<string|int, mixed> $apiRequest) : mixed

Parameters

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

civicrm_api3_generic_getcount()

API return function to reformat results as count.


    
                    civicrm_api3_generic_getcount(array<string|int, mixed> $apiRequest) : int

Parameters

$apiRequest : array<string|int, mixed>: Api request as an array. Keys are.

Return values

int —

count of results

civicrm_api3_generic_getsingle()

API return function to reformat results as single result.


    
                    civicrm_api3_generic_getsingle(array<string|int, mixed> $apiRequest) : int

Parameters

$apiRequest : array<string|int, mixed>: Api request as an array. Keys are.

Return values

int —

count of results

civicrm_api3_generic_getvalue()

API return function to reformat results as single value.


    
                    civicrm_api3_generic_getvalue(array<string|int, mixed> $apiRequest) : int

Parameters

$apiRequest : array<string|int, mixed>: Api request as an array. Keys are.

Return values

int —

count of results

_civicrm_api3_generic_getrefcount_spec()

Get count of contact references.


    
                    _civicrm_api3_generic_getrefcount_spec(array<string|int, mixed> &$params, array<string|int, mixed> $apiRequest) : mixed

Parameters

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

civicrm_api3_generic_getrefcount()

API to determine if a record is in-use.


    
                    civicrm_api3_generic_getrefcount(array<string|int, mixed> $apiRequest) : array<string|int, mixed>

Parameters

$apiRequest : array<string|int, mixed>: Api request as an array.

Return values

array<string|int, mixed> —

API result (int 0 or 1)

civicrm_api3_generic_replace()

API wrapper for replace function.


    
                    civicrm_api3_generic_replace(array<string|int, mixed> $apiRequest) : int

Parameters

$apiRequest : array<string|int, mixed>: Api request as an array. Keys are.

Return values

int —

count of results

civicrm_api3_generic_getoptions()

API wrapper for getoptions function.


    
                    civicrm_api3_generic_getoptions(array<string|int, mixed> $apiRequest) : array<string|int, mixed>

Parameters

$apiRequest : array<string|int, mixed>: Api request as an array.

Return values

array<string|int, mixed> —

Array of results

_civicrm_api3_generic_getoptions_spec()

Provide metadata for this generic action


    
                    _civicrm_api3_generic_getoptions_spec(array<string|int, mixed> &$params, array<string|int, mixed> $apiRequest) : mixed

Parameters

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

_civicrm_api3_generic_get_metadata_options()

Get metadata.


    
                    _civicrm_api3_generic_get_metadata_options(array<string|int, mixed> &$metadata, array<string|int, mixed> $apiRequest, string $fieldname, array<string|int, mixed> $fieldSpec) : mixed

Function fills the 'options' array on the metadata returned by getfields if

the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1) (this is passed in as the $fieldsToResolve array)
the field is a pseudoconstant and is NOT an FK

the reason for this is that checking / transformation is done on pseudoconstants but
if the field is an FK then mysql will enforce the data quality (& we have handling on failure)

Parameters

$metadata : array<string|int, mixed>: The array of metadata that will form the result of the getfields function.
$apiRequest : array<string|int, mixed>
$fieldname : string: Field currently being processed.
$fieldSpec : array<string|int, mixed>: Metadata for that field.

civicrm_api3_group_create()

Create/update group.


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

Parameters

$params : array<string|int, mixed>: name/value pairs to insert in new 'Group'

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_group_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_group_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_group_get()

Returns array of groups matching a set of one or more Group properties.


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

Parameters

$params : array<string|int, mixed>: Array of properties. If empty, all records will be returned.

Return values

array<string|int, mixed> —

Array of matching groups

civicrm_api3_group_delete()

Delete an existing Group.


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

Parameters

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

Return values

array<string|int, mixed> —

API result array

civicrm_api3_group_contact_get()

Fetch a list of groups for a contact, or contacts for a group.


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

Parameters

$params : array<string|int, mixed>: Name value pair of contact information.

Return values

array<string|int, mixed> —

list of groups, given contact subsribed to

_civicrm_api3_group_contact_create_spec()

Adjust metadata for Create action.


    
                    _civicrm_api3_group_contact_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_group_contact_create()

Add contact(s) to group(s).


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

This api has a legacy/nonstandard signature. On success, the return array will be structured as follows:

array(
  "is_error" => 0,
  "version"  => 3,
  "count"    => 3,
  "values" => array(
    "not_added"   => integer,
    "added"       => integer,
    "total_count" => integer
  )
)

On failure, the return array will be structured as follows:

array(
  'is_error' => 1,
  'error_message' = string,
  'error_data' = mixed or undefined
)

Parameters

$params : array<string|int, mixed>

Input parameters:

"contact_id" (required): First contact to add, or array of Contact IDs
"group_id" (required): First group to add contact(s) to, or array of Group IDs
"status" (optional): "Added" (default), "Pending" or "Removed" Legacy input parameters (will be deprecated):
"contact_id.1" etc. (optional): Additional contact_id to add to group(s)
"group_id.1" etc. (optional): Additional groups to add contact(s) to

Return values

array<string|int, mixed> —

Information about operation results

civicrm_api3_group_contact_delete()

Delete group contact record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_group_contact_delete_spec()

Adjust metadata.


    
                    _civicrm_api3_group_contact_delete_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_group_contact_pending()

Get pending group contacts.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>|int

_civicrm_api3_group_contact_common()

Group contact helper function.


    
                    _civicrm_api3_group_contact_common(array<string|int, mixed> $params[, string $op = 'Added' ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>
$op : string = 'Added'

Return values

array<string|int, mixed>

civicrm_api3_group_contact_update_status()

Update group contact status.

this should be part of create but need to know we aren't missing something


    
                    civicrm_api3_group_contact_update_status(array<string|int, mixed> $params) : bool

Parameters

$params : array<string|int, mixed>

Return values

bool

_civicrm_api3_group_contact_deprecation()

Deprecated function notices.

api notice


    
                    _civicrm_api3_group_contact_deprecation() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deprecated actions

civicrm_api3_group_nesting_get()

Provides group nesting record(s) given parent and/or child id.


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

Parameters

$params : array<string|int, mixed>: An array containing at least child_group_id or parent_group_id.

Return values

array<string|int, mixed> —

list of group nesting records

civicrm_api3_group_nesting_create()

Creates group nesting record for given parent and child id.


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

Parent and child groups need to exist.

Parameters

$params : array<string|int, mixed>: Parameters array - allowed array keys include:.

Return values

array<string|int, mixed> —

API success array

_civicrm_api3_group_nesting_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_group_nesting_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_group_nesting_delete()

Removes specific nesting records.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Success or fail array

civicrm_api3_group_organization_get()

Get group organization record/s.


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

Parameters

$params : array<string|int, mixed>: Name value pair of contact information.

Return values

array<string|int, mixed> —

list of groups, given contact subscribed to

civicrm_api3_group_organization_create()

Create group organization record.


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

Parameters

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

Return values

array<string|int, mixed>

_civicrm_api3_group_organization_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_group_organization_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_group_organization_delete()

Deletes an existing Group Organization.


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

This API is used for deleting a Group Organization

Parameters

$params : array<string|int, mixed>: With 'id' = ID of the Group Organization to be deleted.

Return values

array<string|int, mixed> —

API Result

civicrm_api3_im_create()

Add an IM for a contact.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_im_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_im_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_im_delete()

Deletes an existing IM.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result Array

civicrm_api3_im_get()

Retrieve one or more IM.


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

Parameters

$params : array<string|int, mixed>: An associative array of name/value pairs.

Return values

array<string|int, mixed> —

details of found IM

_civicrm_api3_job_create_spec()

Adjust metadata for "Create" action.


    
                    _civicrm_api3_job_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_job_create()

Create scheduled job.


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

Parameters

$params : array<string|int, mixed>: Associative array of property name/value pairs to insert in new job.

Return values

array<string|int, mixed>

_civicrm_api3_job_clone_spec()

Adjust metadata for clone spec action.


    
                    _civicrm_api3_job_clone_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>

civicrm_api3_job_clone()

Clone Job.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_get()

Retrieve one or more job.


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

Parameters

$params : array<string|int, mixed>: input parameters

Return values

array<string|int, mixed>

civicrm_api3_job_delete()

Delete a job.


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

Parameters

$params : array<string|int, mixed>

civicrm_api3_job_execute()

Dumb wrapper to execute scheduled jobs.


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

Always creates success - errors and results are handled in the job log.

Parameters

$params : array<string|int, mixed>: input parameters (unused).

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_job_execute_spec()

Adjust Metadata for Execute action.


    
                    _civicrm_api3_job_execute_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_job_geocode()

Geocode group of contacts based on given params.


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

Parameters

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

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_job_geocode_spec()

First check on Code documentation.


    
                    _civicrm_api3_job_geocode_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_job_send_reminder()

Send the scheduled reminders as configured.


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

Parameters

$params : array<string|int, mixed>

now - the time to use, in YmdHis format
makes testing a bit simpler since we can simulate past/future time

Return values

array<string|int, mixed>

_civicrm_api3_job_send_reminder()

Adjust metadata for "send_reminder" action.


    
                    _civicrm_api3_job_send_reminder(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_job_mail_report()

Execute a specific report instance and send the output via email.


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

Parameters

$params : array<string|int, mixed>: (reference ) input parameters. sendmail - Boolean - should email be sent?, required instanceId - Integer - the report instance ID resetVal - Integer - should we reset form state (always true)?

Return values

array<string|int, mixed>

civicrm_api3_job_update_greeting()

This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.


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

IMPORTANT: You must first create valid option value before using via admin interface. Check option lists for Email Greetings, Postal Greetings and Addressee

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_job_update_greeting_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_job_update_greeting_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_job_process_pledge()

Mass update pledge statuses.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_process_mailing()

Process mail queue.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_process_sms()

Process sms queue.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_fetch_bounces()

Job to get mail responses from civiMailing.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_job_fetch_bounces_spec()

Metadata for bounce function.


    
                    _civicrm_api3_job_fetch_bounces_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_job_fetch_activities()

Job to get mail and create activities.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_process_participant()

Process participant statuses.


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

Parameters

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

Return values

array<string|int, mixed> —

array of properties, if error an array with an error id and error message

civicrm_api3_job_process_membership()

This api checks and updates the status of all membership records for a given domain.


    
                    civicrm_api3_job_process_membership(array<string|int, mixed> $params) : bool

The function uses the calc_membership_status and update_contact_membership APIs.

IMPORTANT: Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.

Parameters

$params : array<string|int, mixed>: Input parameters NOT USED.

Return values

bool —

true if success, else false

_civicrm_api3_job_process_membership_spec()


    
                    _civicrm_api3_job_process_membership_spec(mixed &$params) : mixed

Parameters

$params : mixed

civicrm_api3_job_process_respondent()

This api checks and updates the status of all survey respondents.


    
                    civicrm_api3_job_process_respondent(array<string|int, mixed> $params) : bool

Parameters

$params : array<string|int, mixed>: (reference ) input parameters.

Return values

bool —

true if success, else false

civicrm_api3_job_process_batch_merge()

Merges given pair of duplicate contacts.


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

Parameters

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

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_job_process_batch_merge_spec()

Metadata for batch merge function.


    
                    _civicrm_api3_job_process_batch_merge_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_job_run_payment_cron()

Runs handlePaymentCron method in the specified payment processor.


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

Parameters

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

Expected @params array keys are: INCORRECTLY DOCUMENTED AND SHOULD BE IN THE _spec function for retrieval via getfields. {string 'processor_name' - the name of the payment processor, eg: Sagepay}

civicrm_api3_job_cleanup()

This api cleans up all the old session entries and temp tables.


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

We recommend that sites run this on an hourly basis.

Parameters

$params : array<string|int, mixed>: Sends in various config parameters to decide what needs to be cleaned.

Return values

array<string|int, mixed>

civicrm_api3_job_disable_expired_relationships()

Set expired relationships to disabled.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_group_rebuild()

This api reloads all the smart groups.


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

If the org has a large number of smart groups it is recommended that they use the limit clause to limit the number of smart groups evaluated on a per job basis.

Might also help to increase the smartGroupCacheTimeout and use the cache.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_group_cache_flush()

Flush smart groups caches.


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

This job purges aged smart group cache data (based on the timeout value). Sites can decide whether they want this job and / or the group cache rebuild job to run. In some cases performance is better when old caches are cleared out prior to any attempt to rebuild them. Also, many sites are very happy to have caches built on demand, provided the user is not having to wait for deadlocks to clear when invalidating them.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_acl_cache_flush()

Flush acl caches.


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

This job flushes the acl cache. For many sites it is better to do this by cron (or not at all if acls are not used) than whenever a contact is edited.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_job_version_check()

Check for CiviCRM software updates.


    
                    civicrm_api3_job_version_check() : mixed

Anonymous site statistics are sent back to civicrm.org during this check.

civicrm_api3_line_item_create()

Create or update a line_item.


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

Parameters

$params : array<string|int, mixed>: Array of property name/value pairs to insert in new 'line_item'

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_line_item_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_line_item_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_line_item_get()

Returns array of line_items matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array of one or more valid property_name=>value pairs. If $params is set. as null, all line_items will be returned (default limit is 25)

Return values

array<string|int, mixed> —

Array of matching line_items

civicrm_api3_line_item_delete()

Delete an existing LineItem.


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

This method is used to delete any existing LineItem given its id.

Parameters

$params : array<string|int, mixed>: Array containing id of the group to be deleted.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_location_type_create()

Add a LocationType.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_location_type_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_location_type_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_location_type_delete()

Deletes an existing LocationType.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_location_type_get()

Retrieve one or more LocationTypes.


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

Parameters

$params : array<string|int, mixed>: An associative array of name/value pairs.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_loc_block_create()

Create or update a LocBlock.


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

Parameters

$params : array<string|int, mixed>: Name/value pairs to insert in new 'LocBlock'.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_loc_block_get()

Returns array of loc_blocks matching a set of one or more properties.


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

Parameters

$params : array<string|int, mixed>: Array of one or more valid property_name=>value pairs. If $params is set. as null, all loc_blocks will be returned (default limit is 25).

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_loc_block_delete()

Delete an existing LocBlock.


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

Parameters

$params : array<string|int, mixed>: Array containing id of the record to be deleted.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_logging_revert()

Revert a log change.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Success Array

_civicrm_api3_logging_revert_spec()

Get a log change.


    
                    _civicrm_api3_logging_revert_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_logging_get()

Get a log change.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Success Array

_civicrm_api3_logging_get_spec()

Get a log change.


    
                    _civicrm_api3_logging_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_mailing_create()

Handle a create event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Success Array

civicrm_api3_mailing_gettokens()

Get tokens for one or more entity type


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

Output will be formatted either as a flat list, or pass sequential=1 to retrieve as a hierarchy formatted for select2.

Parameters

$params : array<string|int, mixed>: Should contain an array of entities to retrieve tokens for.

Return values

array<string|int, mixed>

_civicrm_api3_mailing_gettokens_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_gettokens_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_mailing_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_mailing_clone_spec()

Adjust metadata for clone spec action.


    
                    _civicrm_api3_mailing_clone_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>

civicrm_api3_mailing_clone()

Clone mailing.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_delete()

Handle a delete event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Success Array

civicrm_api3_mailing_get()

Handle a get event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_get_formatResult()

Format definition.


    
                    _civicrm_api3_mailing_get_formatResult(array<string|int, mixed> $result) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_submit_spec()

Adjust metadata for mailing submit api function.


    
                    _civicrm_api3_mailing_submit_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>

civicrm_api3_mailing_submit()

Mailing submit.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_event_bounce()

Process a bounce event by passing through to the BAOs.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_event_bounce_spec()

Adjust Metadata for bounce_spec action.


    
                    _civicrm_api3_mailing_event_bounce_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_event_confirm()

Handle a confirm event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_deprecation()

Declare deprecated functions.

api notice


    
                    _civicrm_api3_mailing_deprecation() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deprecated actions

civicrm_api3_mailing_event_reply()

Handle a reply event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_event_reply_spec()

Adjust Metadata for event_reply action.


    
                    _civicrm_api3_mailing_event_reply_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_event_forward()

Handle a forward event.

it is highly unlikely this function is ever used because to use it someone needs to forward an email by clicking on a link rather than.. forwarding the email. Even the links are probably never generated.

Also - it would be poor email server reputation management. Function is nasty but can die with apiv4 whenever that is (along with surveyRespondant)


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_event_forward_spec()

Adjust Metadata for event_forward action.


    
                    _civicrm_api3_mailing_event_forward_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_event_click()

Handle a click event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_event_open()

Handle an open event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_preview()

Preview mailing.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

_civicrm_api3_mailing_send_test_spec()

Adjust metadata for send test function.


    
                    _civicrm_api3_mailing_send_test_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>

civicrm_api3_mailing_send_test()

Send test mailing.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_stats_spec()

Adjust Metadata for send_mail action.


    
                    _civicrm_api3_mailing_stats_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_stats()

Function which needs to be explained.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_update_email_resetdate_spec()


    
                    _civicrm_api3_mailing_update_email_resetdate_spec(mixed &$spec) : mixed

Parameters

$spec : mixed

civicrm_api3_mailing_update_email_resetdate()

Fix the reset dates on the email record based on when a mail was last delivered.


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

We only consider mailings that were completed and finished in the last 3 to 7 days Both the min and max days can be set via the params

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_a_b_create_spec()


    
                    _civicrm_api3_mailing_a_b_create_spec(array<string|int, mixed> &$spec) : mixed

Parameters

$spec : array<string|int, mixed>

civicrm_api3_mailing_a_b_create()

Handle a create mailing ab testing.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Success Array

civicrm_api3_mailing_a_b_delete()

Handle a delete event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Success Array

civicrm_api3_mailing_a_b_get()

Handle a get event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_a_b_submit_spec()

Adjust Metadata for submit action.


    
                    _civicrm_api3_mailing_a_b_submit_spec(array<string|int, mixed> &$spec) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

$spec : array<string|int, mixed>: Array of parameters determined by getfields.

civicrm_api3_mailing_a_b_submit()

Send A/B mail to A/B recipients respectively.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_a_b_fill_winner()


    
                    _civicrm_api3_mailing_a_b_fill_winner(int $winner_id, int $final_id) : mixed

Parameters

$winner_id : int: The experimental mailing chosen as the "winner".
$final_id : int: The final mailing which should imitate the "winner".

_civicrm_api3_mailing_a_b_graph_stats_spec()

Adjust Metadata for graph_stats action.


    
                    _civicrm_api3_mailing_a_b_graph_stats_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_a_b_graph_stats()

Send graph detail for A/B tests mail.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_component_create()

Save a MailingComponent.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_mailing_component_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_component_create_spec(array<string|int, mixed> &$spec) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

$spec : array<string|int, mixed>: Array of parameters determined by getfields.

civicrm_api3_mailing_component_get()

Get a MailingComponent.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_mailing_component_get_spec()

Adjust metadata for get.


    
                    _civicrm_api3_mailing_component_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_mailing_component_delete()

Delete a MailingComponent.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_mailing_contact_get()

Get all the mailings and details that a contact was involved with.


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

Parameters

$params : array<string|int, mixed>: Input parameters - see _spec for details (returned by getfields)

Return values

array<string|int, mixed> —

API result

_civicrm_api3_mailing_contact_getresults()

This is a wrapper for the functions that return the results from the 'quasi-entity' mailing contact.


    
                    _civicrm_api3_mailing_contact_getresults(array<string|int, mixed> $params, bool $count) : mixed

Parameters

$params : array<string|int, mixed>
$count : bool

_civicrm_api3_mailing_contact_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_mailing_contact_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

_civicrm_api3_mailing_contact_query()

Helper function for mailing contact queries.


    
                    _civicrm_api3_mailing_contact_query(int $contactID, int $offset, int $limit, array<string|int, mixed>|null $selectFields, string|null $fromClause, string|null $whereClause, string|null $sort, bool $getCount) : array<string|int, mixed>

Parameters

$contactID : int
$offset : int
$limit : int
$selectFields : array<string|int, mixed>|null
$fromClause : string|null
$whereClause : string|null
$sort : string|null
$getCount : bool

Return values

array<string|int, mixed>

_civicrm_api3_mailing_contact_get_delivered()

Get delivered mailing contacts.


    
                    _civicrm_api3_mailing_contact_get_delivered(int $contactID, int $offset, int $limit, string|null $sort, bool $getCount) : array<string|int, mixed>

Parameters

$contactID : int
$offset : int
$limit : int
$sort : string|null
$getCount : bool

Return values

array<string|int, mixed>

_civicrm_api3_mailing_contact_get_bounced()

Get bounced mailing contact records.


    
                    _civicrm_api3_mailing_contact_get_bounced(int $contactID, int $offset, int $limit, string|null $sort, bool $getCount) : array<string|int, mixed>

Parameters

$contactID : int
$offset : int
$limit : int
$sort : string|null
$getCount : bool

Return values

array<string|int, mixed>

civicrm_api3_mailing_contact_getcount()

Get count of all the mailings that a contact was involved with.


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

Parameters

$params : array<string|int, mixed>: Input parameters per getfields

Return values

array<string|int, mixed> —

API result

civicrm_api3_mailing_event_confirm_get()

Get mailing event confirm record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_event_confirm_create()

Handle a confirm event.


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

Parameters

$params : array<string|int, mixed>: name/value pairs to insert in new 'survey'

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_mailing_event_confirm_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_event_confirm_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_event_queue_create()

Handle a queue event.


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

Parameters

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

Return values

array<string|int, mixed> —

api result array

civicrm_api3_mailing_event_queue_get()

Get mailing event queue record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_event_queue_delete()

Delete mailing event queue record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_event_queue_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_event_queue_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_event_resubscribe_create()

Subscribe from mailing group.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_mailing_event_resubscribe_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_event_resubscribe_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_event_subscribe_get()

Get mailing event subscribe record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_event_subscribe_create()

Subscribe from mailing group.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_mailing_event_subscribe_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_event_subscribe_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_event_unsubscribe_get()

Get mailing event unsubscribe record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_event_unsubscribe_create()

Unsubscribe from mailing group.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

Api result array

_civicrm_api3_mailing_event_unsubscribe_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_event_unsubscribe_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_mailing_group_deprecation()

Declare deprecated functions.

api notice


    
                    _civicrm_api3_mailing_group_deprecation() : string

Return values

string —

to indicate this entire api entity is deprecated

civicrm_api3_mailing_group_event_unsubscribe()

Handle an unsubscribe event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_group_event_domain_unsubscribe()

Handle a site-level unsubscribe event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_group_event_resubscribe()

Handle a re-subscription event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_group_event_subscribe()

Handle a subscription event.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_group_create()

Create mailing group.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_group_get()

Get mailing group.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_group_delete()

Delete mailing group.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_job_create()

Handle creation of a MailingJob for a Mailing.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mailing_job_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mailing_job_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mailing_job_get()

Returns array of Mailing Jobs matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API return Array of matching mailing jobs.

civicrm_api3_mailing_job_delete()

Handle deletion of a Mailing Job for a Mailing.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_mailing_recipients_get()

Returns array of MailingRecipients.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API return Array of matching mailing jobs

civicrm_api3_mail_settings_create()

Create or update a MailSettings.


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

Parameters

$params : array<string|int, mixed>: name/value pairs to insert in new 'MailSettings'

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_mail_settings_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mail_settings_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mail_settings_get()

Returns array of MailSettings matching a set of one or more properties.


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

Parameters

$params : array<string|int, mixed>: Array of one or more property_name=>value pairs. If $params is set as null, all MailSettings will be returned.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_mail_settings_delete()

Delete an existing MailSettings.


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

Parameters

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

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_mapping_create()

Add a Mapping.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mapping_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mapping_create_spec(array<string|int, mixed> &$spec) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

$spec : array<string|int, mixed>: Array of parameters determined by getfields.

civicrm_api3_mapping_delete()

Deletes an existing Mapping.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result Array

civicrm_api3_mapping_get()

Retrieve one or more Mappings.


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

Parameters

$params : array<string|int, mixed>: An associative array of name/value pairs.

Return values

array<string|int, mixed> —

details of found Mappings

civicrm_api3_mapping_field_create()

Add a Mapping Field.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_mapping_field_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_mapping_field_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_mapping_field_delete()

Deletes an existing Mapping Field.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result Array

civicrm_api3_mapping_field_get()

Retrieve one or more Mapping Fields.


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

Parameters

$params : array<string|int, mixed>: An associative array of name/value pairs.

Return values

array<string|int, mixed> —

details of found Mapping Fields

_civicrm_api3_membership_delete_spec()

Adjust Metadata for Delete action.


    
                    _civicrm_api3_membership_delete_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_membership_delete()

Deletes an existing contact Membership.


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

Parameters

$params : array<string|int, mixed>: Array array holding id - Id of the contact membership to be deleted.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_membership_create()

Create a Contact Membership.


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

This API is used for creating a Membership for a contact. Required parameters : membership_type_id and status_id.

Parameters

$params : array<string|int, mixed>: Array of name/value property values of civicrm_membership.

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_membership_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_membership_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_membership_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_membership_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_membership_get()

Get contact Membership record.


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

This api will return the membership records for the contacts having membership based on the relationship with the direct members.

Parameters

$params : array<string|int, mixed>: Key/value pairs for contact_id and some. options affecting the desired results; has legacy support for just passing the contact_id itself as the argument

Return values

array<string|int, mixed> —

Array of all found membership property values.

_civicrm_api3_membership_relationsship_get_customv2behaviour()

Non-standard behaviour inherited from v2.


    
                    _civicrm_api3_membership_relationsship_get_customv2behaviour(array<string|int, mixed> &$params, array<string|int, mixed> $membershipValues, int $contactID) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>: Parameters passed into get function.
$membershipValues : array<string|int, mixed>
$contactID : int

Return values

array<string|int, mixed> —

result for calling function

civicrm_api3_membership_block_create()

API to Create or update a MembershipBlock.


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

Parameters

$params : array<string|int, mixed>: An associative array of name/value property values of MembershipBlock.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_membership_block_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_membership_block_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_membership_block_get()

Get a Membership Block.


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

This api is used for finding an existing membership block.

Parameters

$params : array<string|int, mixed>: An associative array of name/value property values of civicrm_membership_block. {getfields MembershipBlock_get}

Return values

array<string|int, mixed> —

API result array

civicrm_api3_membership_block_delete()

Deletes an existing membership block.


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

This API is used for deleting a membership block Required parameters : id of a membership block

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_membership_log_create()

API to Create or update a MembershipLog.


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

Parameters

$params : array<string|int, mixed>: Values of MembershipLog.

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_membership_log_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_membership_log_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_membership_log_get()

Get a Membership Log.


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

This api is used for finding an existing membership log.

Parameters

$params : array<string|int, mixed>: An associative array of name/value property values of civicrm_membership_log. {getfields MembershipLog_get}

Return values

array<string|int, mixed> —

API result array

civicrm_api3_membership_log_delete()

Deletes an existing membership log.


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

This API is used for deleting a membership log Required parameters : id of a membership log

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_membership_payment_create()

Add or update a link between contribution and membership.


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

Parameters

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

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_membership_payment_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_membership_payment_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_membership_payment_get()

Retrieve one or more membership payment records.


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

Parameters

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

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_membership_status_create()

Create a Membership Status.


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

Parameters

$params : array<string|int, mixed>: Array of name/value property values of civicrm_membership_status.

Return values

array<string|int, mixed>

_civicrm_api3_membership_status_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_membership_status_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_membership_status_get()

Get a membership status.


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

This api is used for finding an existing membership status.

Parameters

$params : array<string|int, mixed>: An associative array of name/value property values of civicrm_membership_status.

Return values

array<string|int, mixed> —

Array of all found membership status property values.

civicrm_api3_membership_status_update()

Update an existing membership status.

should just use create


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

This api is used for updating an existing membership status. Required parameters: id of a membership status

Parameters

$params : array<string|int, mixed>: Array of name/value property values of civicrm_membership_status.

Return values

array<string|int, mixed> —

Array of updated membership status property values

civicrm_api3_membership_status_delete()

Deletes an existing membership status.


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

This API is used for deleting a membership status

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_membership_status_calc()

Derives the Membership Status of a given Membership Record.


    
                    civicrm_api3_membership_status_calc(array<string|int, mixed> $membershipParams) : array<string|int, mixed>

This API is used for deriving Membership Status of a given Membership record using the rules encoded in the membership_status table.

Parameters

$membershipParams : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of status id and status name

_civicrm_api3_membership_status_calc_spec()

Adjust Metadata for Calc action.


    
                    _civicrm_api3_membership_status_calc_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_membership_type_create()

API to Create or update a Membership Type.


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

Parameters

$params : array<string|int, mixed>: Array of name/value property values of civicrm_membership_type.

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_membership_type_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_membership_type_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_membership_type_get()

Get a Membership Type.


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

This api is used for finding an existing membership type.

Parameters

$params : array<string|int, mixed>: Array of name/value property values of civicrm_membership_type.

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_membership_type_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_membership_type_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_membership_type_getlist_params()

Adjust input for getlist action.


    
                    _civicrm_api3_membership_type_getlist_params(array<string|int, mixed> &$request) : mixed

We want to only return active membership types for getlist. It's a bit arguable whether this should be applied at the 'get' level but, since it's hard to unset we'll just do it here.

The usage of getlist is entity-reference fields & the like so using only active ones makes sense.

Parameters

$request : array<string|int, mixed>: Array of parameters determined by getfields.

civicrm_api3_membership_type_delete()

Deletes an existing membership type.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_message_template_create()

Create message template.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_message_template_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_message_template_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_message_template_delete()

Delete message template.


    
                    civicrm_api3_message_template_delete(array<string|int, mixed> $params) : bool

Parameters

$params : array<string|int, mixed>

Return values

bool —

API result array

_civicrm_api3_message_template_get_spec()

Adjust metadata for message_template get action.


    
                    _civicrm_api3_message_template_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_message_template_get()

Retrieve one or more message_template.


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

Parameters

$params : array<string|int, mixed>: Array of name/value pairs.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_message_template_send()

Sends a template.


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

Parameters

$params : array<string|int, mixed>

_civicrm_api3_message_template_send_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_message_template_send_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_navigation_reset_spec()

Adjust metadata for navigation reset action.


    
                    _civicrm_api3_navigation_reset_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_navigation_reset()

Reset navigation.


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

Parameters

$params : array<string|int, mixed>: Array of name/value pairs.

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_navigation_get_spec()

Adjust metadata for navigation get action.


    
                    _civicrm_api3_navigation_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_navigation_get()

Reset navigation.


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

Parameters

$params : array<string|int, mixed>: Array of name/value pairs.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_navigation_create()

Create navigation item.


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

Parameters

$params : array<string|int, mixed>: Array of name/value pairs.

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_navigation_create_spec()

Adjust metadata for navigation create action.


    
                    _civicrm_api3_navigation_create_spec(array<string|int, array<string|int, mixed>> &$fields) : mixed

Parameters

$fields : array<string|int, array<string|int, mixed>>

civicrm_api3_navigation_delete()

Delete navigation item.


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

Parameters

$params : array<string|int, mixed>: Array of name/value pairs.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_note_create()

Create Note.


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

This API is used for creating a note. Required parameters : entity_id AND note

Parameters

$params : array<string|int, mixed>: An associative array of name/value property values of civicrm_note.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_note_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_note_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_note_delete()

Deletes an existing note.


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

This API is used for deleting a note

Parameters

$params : array<string|int, mixed>: Including id of the note to be deleted.

Return values

array<string|int, mixed>

civicrm_api3_note_get()

Retrieve a specific note or notes, given a set of input params.


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

Parameters

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

Return values

array<string|int, mixed> —

array of properties, if error an array with an error id and error message

_civicrm_api3_note_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_note_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_note_tree_get()

Get all descendants of given note.


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

Parameters

$params : array<string|int, mixed>: array; only required 'id' parameter is used.

Return values

array<string|int, mixed> —

Nested associative array beginning with direct children of given note.

_civicrm_api3_note_deprecation()

Declare deprecated api functions.


    
                    _civicrm_api3_note_deprecation() : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_open_i_d_create()

Add an OpenID for a contact.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_open_i_d_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_open_i_d_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_open_i_d_delete()

Deletes an existing OpenID.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_open_i_d_get()

Retrieve one or more OpenID.


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

Parameters

$params : array<string|int, mixed>: An associative array of name/value pairs.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_option_group_get()

Get option groups.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_option_group_create()

Create/update option group.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

_civicrm_api3_option_group_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_option_group_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_option_group_delete()

Delete an existing Option Group.


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

This method is used to delete any existing OptionGroup given its id.

Parameters

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

Return values

array<string|int, mixed> —

API Result Array

civicrm_api3_option_value_get()

Retrieve one or more option values.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_option_value_get_spec()

Adjust Metadata for get action.


    
                    _civicrm_api3_option_value_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_option_value_create()

Add an OptionValue.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_option_value_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_option_value_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_option_value_delete()

Deletes an existing option value.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_order_get()

Retrieve a set of Order.


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

Parameters

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

Return values

array<string|int, mixed> —

Array of Order, if error an array with an error id and error message

_civicrm_api3_order_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_order_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_order_create()

Add or update a Order.


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

Parameters

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

Return values

array<string|int, mixed> —

Api result array

civicrm_api3_order_delete()

Delete a Order.


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

Parameters

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

Return values

array<string|int, mixed>

civicrm_api3_order_cancel()

Cancel an Order.


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

Parameters

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

Return values

array<string|int, mixed>

_civicrm_api3_order_cancel_spec()

Adjust Metadata for Cancel action.


    
                    _civicrm_api3_order_cancel_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_order_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_order_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_order_delete_spec()

Adjust Metadata for Delete action.


    
                    _civicrm_api3_order_delete_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_order_create_wrangle_membership_params()

Handle possibility of v3 style params.


    
                    _order_create_wrangle_membership_params(array<string|int, mixed> &$membershipParams) : mixed

We used to call v3 Membership.create. Now we call v4. This converts membership input parameters.

Parameters

$membershipParams : array<string|int, mixed>

civicrm_api3_participant_create()

Create an Event Participant.


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

Parameters

$params : array<string|int, mixed>: An associative array of name/value property values of civicrm_participant.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_participant_createlineitem()

Create a default participant line item.


    
                    _civicrm_api3_participant_createlineitem(array<string|int, mixed> &$params, CRM_Event_BAO_Participant $participant) : mixed

Parameters

$params : array<string|int, mixed>
$participant : CRM_Event_BAO_Participant

_civicrm_api3_participant_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_participant_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_participant_get()

Retrieve a specific participant, given a set of input params.


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

Parameters

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

Return values

array<string|int, mixed> —

array of properties, if error an array with an error id and error message

_civicrm_api3_participant_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_participant_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_participant_delete()

Deletes an existing contact participant.


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

This API is used for deleting a contact participant

Parameters

$params : array<string|int, mixed>: Array containing Id of the contact participant to be deleted.

Return values

array<string|int, mixed>

civicrm_api3_participant_payment_create()

Create a Event Participant Payment.


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

This API is used for creating a Participant Payment of Event. Required parameters: participant_id, contribution_id.

Parameters

$params : array<string|int, mixed>: An associative array of name/value property values of civicrm_participant_payment.

Return values

array<string|int, mixed>

_civicrm_api3_participant_payment_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_participant_payment_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_participant_payment_delete()

Deletes an existing Participant Payment.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result

civicrm_api3_participant_payment_get()

Retrieve one or more participant payment records.


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

Parameters

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

Return values

array<string|int, mixed> —

array of properties, if error an array with an error id and error message

civicrm_api3_participant_status_type_create()

Create/update participant_status.


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

This API is used to create new participant_status or update any of the existing In case of updating existing participant_status, id of that particular participant_status must be in $params array.

Parameters

$params : array<string|int, mixed>: name/value pairs to insert in new 'participant_status'

Return values

array<string|int, mixed> —

participant_status array

civicrm_api3_participant_status_type_get()

Returns array of participant_statuses matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array of properties. If empty, all records will be returned.

Return values

array<string|int, mixed> —

Array of matching participant_statuses

civicrm_api3_participant_status_type_delete()

Delete an existing participant_status.


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

This method is used to delete any existing participant_status given its id.

Parameters

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

Return values

array<string|int, mixed> —

api result array

civicrm_api3_payment_get()

Retrieve a set of financial transactions which are payments.


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

Parameters

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

Return values

array<string|int, mixed> —

Array of financial transactions which are payments, if error an array with an error id and error message

civicrm_api3_payment_delete()

Delete a payment.


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

Parameters

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

Return values

array<string|int, mixed> —

Api result array

civicrm_api3_payment_cancel()

Cancel/Refund a payment for a Contribution.


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

Parameters

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

Return values

array<string|int, mixed> —

Api result array

civicrm_api3_payment_create()

Add a payment for a Contribution.


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

Parameters

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

Return values

array<string|int, mixed> —

Api result array

_civicrm_api3_payment_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_payment_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_payment_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_payment_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_payment_delete_spec()

Adjust Metadata for Delete action.


    
                    _civicrm_api3_payment_delete_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_payment_cancel_spec()

Adjust Metadata for Cancel action.


    
                    _civicrm_api3_payment_cancel_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_payment_sendconfirmation()

Send a payment confirmation.


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

Parameters

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

Return values

array<string|int, mixed>

_civicrm_api3_payment_sendconfirmation_spec()

Adjust Metadata for sendconfirmation action.


    
                    _civicrm_api3_payment_sendconfirmation_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_payment_processor_create()

Add/Update a PaymentProcessor.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_payment_processor_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_payment_processor_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_payment_processor_delete()

Deletes an existing PaymentProcessor.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_payment_processor_get()

Retrieve one or more PaymentProcessor.


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

Parameters

$params : array<string|int, mixed>: Array of name/value pairs.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_payment_processor_getlist_defaults()

Set default getlist parameters.


    
                    _civicrm_api3_payment_processor_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>

Parameters

$request : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_payment_processor_pay()

Action payment.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_payment_processor_pay_spec()

Action payment.


    
                    _civicrm_api3_payment_processor_pay_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_payment_processor_refund()

Action refund.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_payment_processor_refund_spec()

Action Refund.


    
                    _civicrm_api3_payment_processor_refund_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_payment_processor_type_create()

Create payment_processor type.


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

Parameters

$params : array<string|int, mixed>: Associative array of property name/value pairs to insert in new payment_processor type.

Return values

array<string|int, mixed>

_civicrm_api3_payment_processor_type_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_payment_processor_type_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_payment_processor_type_get()

Get all payment_processor types.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_payment_processor_type_delete()

Delete a payment_processor type delete.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Result Array

civicrm_api3_payment_token_create()

Create/update Payment Token.


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

This API is used to create new campaign or update any of the existing In case of updating existing campaign, id of that particular campaign must be in $params array.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_payment_token_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_payment_token_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_payment_token_get()

Returns array of campaigns matching a set of one or more properties.


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

Parameters

$params : array<string|int, mixed>: Array per getfields

Return values

array<string|int, mixed> —

Array of matching campaigns

civicrm_api3_payment_token_delete()

Delete an existing payment token.


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

This method is used to delete any existing payment token. Id of the payment token to be deleted is required field in $params array

Parameters

$params : array<string|int, mixed>: array containing id of the group to be deleted

Return values

array<string|int, mixed>

civicrm_api3_pcp_create()

Create or update a survey.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_pcp_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_pcp_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_pcp_get()

Returns array of pcps matching a set of one or more properties.


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

Parameters

$params : array<string|int, mixed>: Array per getfields

Return values

array<string|int, mixed> —

Array of matching pcps

civicrm_api3_pcp_delete()

Delete an existing PCP.


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

This method is used to delete any existing PCP given its id.

Parameters

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

Return values

array<string|int, mixed> —

api result array

civicrm_api3_phone_get()

Retrieve one or more phones.


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

This function has been declared there instead than in api/v3/Phone.php for no specific reasons, beside to demonstrate this feature (that might be useful in your module, eg if you want to implement a civicrm_api ('Phone','Dial') that you would then simply put in your module under api/v3/Phone/Dial.php.

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_phone_create()

Add an Phone for a contact.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

_civicrm_api3_phone_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_phone_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_phone_delete()

Delete an existing Phone.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

Api Result

civicrm_api3_pledge_create()

Create or updates an Pledge.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array containing 'is_error' to denote success or failure and details of the created pledge

civicrm_api3_pledge_delete()

Delete a pledge.


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

Parameters

$params : array<string|int, mixed>: Array included 'pledge_id' of pledge to delete.

Return values

array<string|int, mixed>

_civicrm_api3_pledge_delete_spec()

Adjust metadata for pledge delete action.


    
                    _civicrm_api3_pledge_delete_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_pledge_get_spec()

Adjust field specification specific to get requests.


    
                    _civicrm_api3_pledge_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_pledge_create_spec()

Adjust field specification specific to get requests.


    
                    _civicrm_api3_pledge_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_pledge_get()

Retrieve a set of pledges, given a set of input params.


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

Parameters

$params : array<string|int, mixed>: Input parameters. Use interrogate for possible fields.

Return values

array<string|int, mixed> —

array of pledges, if error an array with an error id and error message

_civicrm_api3_pledge_get_defaults()

Set default to not return test params.


    
                    _civicrm_api3_pledge_get_defaults() : mixed

_civicrm_api3_pledge_format_params()

Legacy function to format pledge parameters.


    
                    _civicrm_api3_pledge_format_params(array<string|int, mixed> &$values) : mixed

I removed a bunch of stuff no longer required from here but it still needs more culling take the input parameter list as specified in the data model and convert it into the same format that we use in QF and BAO object

Parameters

$values : array<string|int, mixed>: The reformatted properties that we can use internally.

civicrm_api3_pledge_payment_create()

Add or update a pledge payment.


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

Pledge Payment API doesn't actually add a pledge. If the request is to 'create' and 'id' is not passed in the oldest pledge with no associated contribution is updated.

Parameters

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

Return values

array<string|int, mixed> —

API Result

_civicrm_api3_pledge_payment_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_pledge_payment_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_pledge_payment_delete()

Delete a pledge Payment - Note this deletes the contribution not just the link.


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

Parameters

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

Return values

array<string|int, mixed> —

API result

civicrm_api3_pledge_payment_get()

Retrieve a set of pledges, given a set of input params.


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

Parameters

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

Return values

array<string|int, mixed> —

array of pledges, if error an array with an error id and error message

civicrm_api3_premium_create()

Save a premium.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_premium_get()

Get a premium.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved premium property values.

civicrm_api3_premium_delete()

Delete a premium.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

_civicrm_api3_premium_get_spec()

Return field specification specific to get requests.


    
                    _civicrm_api3_premium_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_premium_create_spec()

Return field specification specific to create requests.


    
                    _civicrm_api3_premium_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_price_field_create()

Create or update a price_field.


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

Parameters

$params : array<string|int, mixed>: name/value pairs to insert in new 'price_field'

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_price_field_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_price_field_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_price_field_get()

Returns array of price_fields matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array of one or more valid property_name=>value pairs. If $params is set. as null, all price_fields will be returned (default limit is 25)

Return values

array<string|int, mixed> —

Array of matching price_fields

civicrm_api3_price_field_delete()

Delete an existing price_field.


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

This method is used to delete any existing price_field given its id.

Parameters

$params : array<string|int, mixed>: Array containing id of the group to be deleted.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_price_field_value_create()

Create or update a PriceFieldValue.


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

Parameters

$params : array<string|int, mixed>: name/value pairs to insert in new 'PriceFieldValue'

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_price_field_value_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_price_field_value_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_price_field_value_get()

Returns array of PriceFieldValues matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array of one or more valid property_name=>value pairs. If $params is set. as null, all price_field_values will be returned (default limit is 25)

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_price_field_value_delete()

Delete an existing PriceFieldValue.


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

This method is used to delete any existing PriceFieldValue given its id.

Parameters

$params : array<string|int, mixed>: Array containing id of the group to be deleted.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_price_set_create()

Create or update a PriceSet.


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

Parameters

$params : array<string|int, mixed>: name/value pairs to insert in new 'PriceSet'

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_price_set_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_price_set_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_price_set_get()

Returns array of price_sets matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array of one or more valid property_name=>value pairs. If $params is set. as null, all price_sets will be returned (default limit is 25)

Return values

array<string|int, mixed> —

Array of matching price_sets

civicrm_api3_price_set_delete()

Delete an existing PriceSet.


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

This method is used to delete any existing PriceSet given its id.

Parameters

$params : array<string|int, mixed>: Array containing id of the group to be deleted.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_print_label_create()

Save a PrintLabel.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_print_label_create_spec()

Adjust metadata for navigation create action.


    
                    _civicrm_api3_print_label_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_print_label_get()

Get a PrintLabel.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved PrintLabel property values.

civicrm_api3_print_label_delete()

Delete a PrintLabel.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_product_create()

Save a product.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_product_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_product_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_product_get()

Get a product.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved product property values.

civicrm_api3_product_delete()

Delete a product.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_profile_get()

Retrieve Profile field values.


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

NOTE this api is not standard & since it is tested we need to honour that but the correct behaviour is for it to return an id indexed array as this supports multiple instances - if a single profile is passed in we will not return a normal api result array in order to avoid breaking code. (This could still be confusing :-( but we have to keep the tested behaviour working

Note that if contact_id is empty an array of defaults is returned

Parameters

$params : array<string|int, mixed>: Associative array of property name/value. pairs to get profile field values

Return values

array<string|int, mixed>

_civicrm_api3_profile_get_spec()

Adjust profile get function metadata.


    
                    _civicrm_api3_profile_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_profile_submit()

Submit a set of fields against a profile.


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

Note choice of submit versus create is discussed CRM-13234 & related to the fact 'profile' is being treated as a data-entry entity

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_profile_translate_fieldnames_for_bao()

Translate field names for BAO.


    
                    _civicrm_api3_profile_translate_fieldnames_for_bao(string $fieldName) : string

The api standards expect field names to be lower case but the BAO uses mixed case so we accept 'email-primary' but pass 'email-Primary' to the BAO we could make the BAO handle email-primary but this would alter the fieldname seen by hooks & we would need to consider that change

Parameters

$fieldName : string: API field name.

Return values

string —

BAO Field Name

_civicrm_api3_profile_submit_spec()

Metadata for submit action.


    
                    _civicrm_api3_profile_submit_spec(array<string|int, mixed> &$params, array<string|int, mixed> $apirequest) : mixed

Parameters

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

civicrm_api3_profile_set()

Update Profile field values.

calling this function directly is deprecated as 'set' is not a clear action use submit


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

Parameters

$params : array<string|int, mixed>: Array of property name/value. pairs to update profile field values

Return values

array<string|int, mixed> —

Updated Contact/ Activity object|CRM_Error

civicrm_api3_profile_apply()

Apply profile.

appears to be an internal function - should not be accessible via api Provide formatted values for profile fields.


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

Parameters

$params : array<string|int, mixed>: Array of property name/value. pairs to profile field values

Return values

array<string|int, mixed>

_civicrm_api3_profile_apply_spec()

Adjust Metadata for Apply action.


    
                    _civicrm_api3_profile_apply_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_profile_getbillingpseudoprofile()

Get pseudo profile 'billing'.


    
                    _civicrm_api3_profile_getbillingpseudoprofile(array<string|int, mixed> &$params) : array<string|int, mixed>

This is a function to help us 'pretend' billing is a profile & treat it like it is one. It gets standard credit card address fields etc Note this is 'better' that the inbuilt version as it will pull in fallback values billing location -> is_billing -> primary

Note that that since the existing code for deriving a blank profile is not easily accessible our interim solution is just to return an empty array

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_buildprofile_submitfields()

Here we will build up getfields type data for all the fields in the profile.


    
                    _civicrm_api3_buildprofile_submitfields(int $profileID, int $optionsBehaviour, bool $is_flush) : array<string|int, mixed>|void

Because the integration with the form layer in core is so hard-coded we are not going to attempt to re-use it However, as this function is unit-tested & hence 'locked in' we can aspire to extract sharable code out of the form-layer over time.

The function deciphers which fields belongs to which entites & retrieves metadata about the entities Unfortunately we have inconsistencies such as 'contribution' uses contribution_status_id & participant has 'participant_status' so we have to standardise from the outside in here - find the oddities, 'mask them' at this layer, add tests & work to standardise over time so we can remove this handling

Parameters

$profileID : int
$optionsBehaviour : int: 0 = don't resolve, 1 = resolve non-aggressively, 2 = resolve aggressively - ie include country & state.
$is_flush : bool

Return values

array<string|int, mixed>|void

_civicrm_api3_order_by_weight()


    
                    _civicrm_api3_order_by_weight(array<string|int, mixed> $a, array<string|int, mixed> $b) : bool

Parameters

$a : array<string|int, mixed>
$b : array<string|int, mixed>

Return values

bool

_civicrm_api3_map_profile_fields_to_entity()

Here we map the profile fields as stored in the uf_field table to their 'real entity' we also return the profile fieldname


    
                    _civicrm_api3_map_profile_fields_to_entity(array<string|int, mixed> &$field) : array<string|int, mixed>

Parameters

$field : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_profile_getProfileID()


    
                    _civicrm_api3_profile_getProfileID(int $profileID) : int|string

Parameters

$profileID : int

Return values

int|string

_civicrm_api3_profile_appendaliases()

helper function to add all aliases as keys to getfields response so we can look for keys within it since the relationship between profile fields & api / metadata based fields is a bit inconsistent


    
                    _civicrm_api3_profile_appendaliases(array<string|int, mixed> $values, string $entity) : array<string|int, mixed>

Parameters

$values : array<string|int, mixed>: e.g getfields response incl 'membership_type_id' - with api.aliases = 'membership_type' returned array will include both as keys (with the same values)
$entity : string

Return values

array<string|int, mixed>

_civicrm_api3_profile_deprecation()

api notice


    
                    _civicrm_api3_profile_deprecation() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deprecated actions

civicrm_api3_recurring_entity_get()

Retrieve a recurring entity.


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

Parameters

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

Return values

array<string|int, mixed>

_civicrm_api3_recurring_entity_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_recurring_entity_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_recurring_entity_create()

Add or update a recurring entity.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_recurring_entity_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_recurring_entity_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_recurring_entity_delete()

Deletes an existing ReportInstance.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_relationship_create()

Add or update a relationship.


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

Parameters

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

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_relationship_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_relationship_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_relationship_delete()

Delete a relationship.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Result Array

civicrm_api3_relationship_get()

Get one or more relationship/s.


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

Parameters

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

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_handle_relationship_type()

Legacy handling for relationship_type parameter.


    
                    _civicrm_api3_handle_relationship_type(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>: Associative array of property name/value. pairs to insert in new contact.

civicrm_api3_relationship_setvalue()

Hack to ensure inherited membership got created/deleted on relationship add/delete respectively.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

_civicrm_api3_relationship_getoptions_spec()


    
                    _civicrm_api3_relationship_getoptions_spec(mixed &$params) : mixed

Parameters

$params : mixed

civicrm_api3_relationship_type_create()

Create relationship type.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

_civicrm_api3_relationship_type_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_relationship_type_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_relationship_type_get()

Get all relationship types.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_relationship_type_delete()

Delete a relationship type.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API Result Array

_civicrm_api3_relationship_type_getlist_defaults()

Get list defaults for relationship types.


    
                    _civicrm_api3_relationship_type_getlist_defaults(array<string|int, mixed> $request) : array<string|int, mixed>

Parameters

$request : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_report_instance_get()

Retrieve a report instance.


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

Parameters

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

Return values

array<string|int, mixed> —

API result array

civicrm_api3_report_instance_create()

Add or update a report instance.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_report_instance_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_report_instance_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_report_instance_delete()

Deletes an existing ReportInstance.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_report_template_get()

Retrieve a report template.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_report_template_create()

Add a Report Template.


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

Templates are stored as OptionValues.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_report_template_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_report_template_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_report_template_delete()

Deletes an existing ReportTemplate.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_report_template_getrows()

Retrieve rows from a report template.


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

Parameters

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

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_report_template_getrows()

Get report template rows.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_report_template_getstatistics()

Get statistics from a given report.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_report_template_getrows_spec()

Adjust metadata for template getrows action.


    
                    _civicrm_api3_report_template_getrows_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_rule_create()

Create or update a rule.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_rule_create_spec()

Specify Meta data for create.


    
                    _civicrm_api3_rule_create_spec(array<string|int, mixed> &$params) : mixed

Note that this data is retrievable via the getfields function and is used for pre-filling defaults and ensuring mandatory requirements are met.

Parameters

$params : array<string|int, mixed>

civicrm_api3_rule_delete()

Delete an existing Rule.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_rule_get()

Get a Rule.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_rule_group_create()

Create or update a rule_group.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_rule_group_create_spec()

Specify Meta data for create.


    
                    _civicrm_api3_rule_group_create_spec(array<string|int, mixed> &$params) : mixed

Note that this data is retrievable via the getfields function and is used for pre-filling defaults and ensuring mandatory requirements are met.

Parameters

$params : array<string|int, mixed>

civicrm_api3_rule_group_delete()

Delete an existing RuleGroup.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_rule_group_get()

Get a RuleGroup.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_saved_search_create()

Create or update a saved search.


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

Parameters

$params : array<string|int, mixed>: Associative array of property name-value pairs to insert in new saved search.

Return values

array<string|int, mixed> —

api result array saved_search_create

_civicrm_api3_saved_search_create_spec()


    
                    _civicrm_api3_saved_search_create_spec(array<string|int, mixed> &$fields) : mixed

Parameters

$fields : array<string|int, mixed>

civicrm_api3_saved_search_delete()

Delete an existing saved search.


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

Parameters

$params : array<string|int, mixed>: Associative array of property name-value pairs. $params['id'] should be the ID of the saved search to be deleted.

Return values

array<string|int, mixed> —

api result array saved_search_delete

civicrm_api3_saved_search_get()

Retrieve one or more saved search(es).


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

Parameters

$params : array<string|int, mixed>: An associative array of name-value pairs.

Return values

array<string|int, mixed> —

api result array saved_search_get

_civicrm_api3_saved_search_result_cleanup()

Unserialize the form_values field in SavedSearch API results.


    
                    _civicrm_api3_saved_search_result_cleanup(array<string|int, mixed> &$result) : mixed

Note: APIv4 handles serialization automatically based on metadata.

Parameters

$result : array<string|int, mixed>: API result to be cleaned up.

civicrm_api3_setting_getfields()

Get fields for setting api calls.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_setting_getfields_spec()

Alter metadata for getfields functions.


    
                    _civicrm_api3_setting_getfields_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_setting_getdefaults()

Return default values for settings.


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

We will domain key this as it could vary by domain (ie. urls) as we will be creating the option for a function rather than an value to be in the defaults Note that is not in place as yet.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_setting_getdefaults_spec()

Metadata for Setting create function.


    
                    _civicrm_api3_setting_getdefaults_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>: Parameters as passed to the API.

civicrm_api3_setting_getoptions()

Get options for settings.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_setting_revert()

Revert settings to defaults.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_setting_revert_spec()

Alter metadata for getfields functions.


    
                    _civicrm_api3_setting_revert_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_setting_fill()

Revert settings to defaults.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_setting_fill_spec()

Alter metadata for getfields functions.


    
                    _civicrm_api3_setting_fill_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_setting_deprecation()

Declare deprecated api functions.


    
                    _civicrm_api3_setting_deprecation() : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_setting_create()

Create or update a setting.


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

Parameters

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

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_setting_create_spec()

Metadata for setting create function.


    
                    _civicrm_api3_setting_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>: Parameters as passed to the API.

civicrm_api3_setting_get()

Returns array of settings matching input parameters.


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

Parameters

$params : array<string|int, mixed>: Array of one or more valid property_name=>value pairs.

Return values

array<string|int, mixed> —

Array of matching settings

_civicrm_api3_setting_get_spec()

Metadata for setting create function.


    
                    _civicrm_api3_setting_get_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>: Parameters as passed to the API.

civicrm_api3_setting_getvalue()

Returns value for specific parameter.


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

Function requires more fields than 'get' but is intended for runtime usage & should be quicker

Parameters

$params : array<string|int, mixed>: Array of one or more valid. property_name=>value pairs.

Return values

array<string|int, mixed> —

API result array.

_civicrm_api3_setting_getvalue_spec()

Metadata for setting create function.


    
                    _civicrm_api3_setting_getvalue_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>: Parameters as passed to the API.

_civicrm_api3_setting_getDomainArray()

Converts domain input into an array.


    
                    _civicrm_api3_setting_getDomainArray(array<string|int, mixed> &$params) : array<string|int, mixed>

If an array is passed in this is used, if 'all' is passed in this is converted to 'all arrays'

Really domain_id should always be set but doing an empty check because at the moment using crm-editable will pass an id & default won't be applied we did talk about id being a pseudonym for domain_id in this api so applying it here.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_sms_provider_create()

Save an sms_provider.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_sms_provider_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_sms_provider_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_sms_provider_get()

Get an sms_provider.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved sms_provider property values.

civicrm_api3_sms_provider_delete()

Delete an sms_provider.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

civicrm_api3_state_province_create()

Add a state/province.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_state_province_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_state_province_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_state_province_delete()

Deletes an existing state/province.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_state_province_get()

Retrieve one or more states/provinces.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

api result array

civicrm_api3_status_preference_create()

Save a Status Preference.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_status_preference_get()

Get an Acl.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of retrieved Acl property values.

civicrm_api3_status_preference_delete()

Delete an Acl.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deleted values.

_civicrm_api3_status_preference_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_status_preference_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_survey_create()

Create or update a survey.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_survey_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_survey_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_survey_get()

Returns array of surveys matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array of properties. If empty, all records will be returned.

Return values

array<string|int, mixed> —

API result Array of matching surveys

civicrm_api3_survey_delete()

Delete an existing survey.


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

This method is used to delete any existing survey given its id.

Parameters

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

Return values

array<string|int, mixed> —

api result array

_civicrm_api3_survey_getlist_defaults()

Set default getlist parameters.


    
                    _civicrm_api3_survey_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>

Parameters

$request : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_survey_respondant_deprecation()

Notify caller of deprecated function.

api notice


    
                    _civicrm_api3_survey_respondant_deprecation() : string

Return values

string —

String output indicates this entire api entity as deprecated

civicrm_api3_survey_respondant_get()

Get the list of signatories.

api currently not supported


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

Parameters

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

Return values

array<string|int, mixed>

civicrm_api3_survey_respondant_count()

Count survey respondents.

api currently not supported


    
                &    civicrm_api3_survey_respondant_count(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_system_flush()

Flush all system caches.


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

Parameters

$params : array<string|int, mixed>

Input parameters.

triggers: bool, whether to drop/create SQL triggers; default: FALSE
session: bool, whether to reset the CiviCRM session data; default: FALSE

Return values

array<string|int, mixed>

_civicrm_api3_system_flush_spec()

Adjust Metadata for Flush action.


    
                    _civicrm_api3_system_flush_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_system_check_spec()

System.Check API specification (optional).


    
                    _civicrm_api3_system_check_spec(array<string|int, mixed> &$spec) : mixed

This is used for documentation and validation.

Parameters

$spec : array<string|int, mixed>: Description of fields supported by this API call.

civicrm_api3_system_check()

System Check API.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result descriptor; return items are alert codes/messages

civicrm_api3_system_log()

Log entry to system log table.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_system_log_spec()

Metadata for log function.


    
                    _civicrm_api3_system_log_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_system_get()

System.Get API.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_system_get_redacted_ini()

Generate a sanitized/anonymized/redacted dump of the PHP configuration.


    
                    _civicrm_api3_system_get_redacted_ini() : array<string|int, mixed>

Some INI fields contain site-identifying information (SII) -- e.g. URLs, hostnames, file paths, IP addresses, passwords, or free-form comments could be used to identify a site or gain access to its resources.

A number of INI fields have been examined to determine whether they contain SII. Approved fields are put in a whitelist; all other fields are redacted.

Redaction hides the substance of a field but does not completely omit all information. Consider the field 'mail.log' - setting this field has a functional effect (it enables or disables the logging behavior) and also points to particular file. Empty values (FALSE/NULL/0/"") will pass through redaction, but all other values will be replaced by a string (eg "REDACTED"). This roughly indicates whether the option is enabled/disabled without giving away its content.

Return values

array<string|int, mixed>

_civicrm_api3_system_get_redacted_mysql()

Generate ae sanitized/anonymized/redacted dump of MySQL configuration.


    
                    _civicrm_api3_system_get_redacted_mysql() : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_system_get_redacted_settings()

Get redacted settings.


    
                    _civicrm_api3_system_get_redacted_settings() : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_system_get_whitelist()

Read a whitelist.


    
                    _civicrm_api3_system_get_whitelist(string $whitelistFile) : array<string|int, mixed>

Parameters

$whitelistFile : string: Name of a file. Each line is a field name. Comments begin with "#".

Return values

array<string|int, mixed>

civicrm_api3_system_updatelogtables()

Update log table structures.


    
                    civicrm_api3_system_updatelogtables(mixed $params) : mixed

This updates the engine type if defined in the hook and changes the field type for log_conn_id to reflect CRM-18193.

Parameters

$params : mixed

civicrm_api3_system_utf8conversion()

Update log table structures.


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

This updates the engine type if defined in the hook and changes the field type for log_conn_id to reflect CRM-18193.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_system_utf8conversion_spec()

Metadata for conversion function.


    
                    _civicrm_api3_system_utf8conversion_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_system_updatelogtables_spec()

Adjust Metadata for Flush action.


    
                    _civicrm_api3_system_updatelogtables_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_system_updateindexes()

Update indexes.


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

This adds any indexes that exist in the schema but not the database.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_system_updateindexes_spec()

Declare metadata for api System.getmissingindices


    
                    _civicrm_api3_system_updateindexes_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_system_getmissingindices()

Get an array of indices that should be defined but are not.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_system_getmissingindices_spec()

Declare metadata for api System.getmissingindices


    
                    _civicrm_api3_system_getmissingindices_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_system_createmissinglogtables()

Creates missing log tables.


    
                    civicrm_api3_system_createmissinglogtables() : mixed

CRM-20838 - This adds any missing log tables into the database.

civicrm_api3_system_rebuildmultilingualschema()

Rebuild Multilingual Schema


    
                    civicrm_api3_system_rebuildmultilingualschema() : mixed

civicrm_api3_system_log_delete()

Delete system log record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_system_log_create()

Create system log record.


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

It's arguable whether this function should exist as it fits our crud pattern and adding it meets our SyntaxConformance test requirements but it just wraps system.log which is more consistent with the PSR3 implemented.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_system_log_create_spec()

Adjust system log create metadata.


    
                    _civicrm_api3_system_log_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_system_log_get()

Get system log record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_tag_create()

Create or update a tag.


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

Tags are used to classify CRM entities (including Contacts, Groups and Actions).

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_tag_create_spec()

Specify Meta data for create.


    
                    _civicrm_api3_tag_create_spec(array<string|int, mixed> &$params) : mixed

Note that this data is retrievable via the getfields function and is used for pre-filling defaults and ensuring mandatory requirements are met.

Parameters

$params : array<string|int, mixed>

civicrm_api3_tag_delete()

Delete an existing Tag.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_tag_get()

Get a Tag.


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

This api is used for finding an existing tag. Either id or name of tag are required parameters for this api.

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_uf_field_create()

Defines 'uf field' within a group.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

Newly created $ufFieldArray

_civicrm_api3_uf_field_create_spec()

Adjust metadata for civicrm_uf_field create.


    
                    _civicrm_api3_uf_field_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_uf_field_get()

Returns array of uf groups (profiles) matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

civicrm_api3_uf_field_delete()

Delete uf field.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_uf_field_delete_spec()

Field id accepted for backward compatibility - unset required on id.


    
                    _civicrm_api3_uf_field_delete_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

_civicrm_api3_uf_group_create_spec()

Adjust metadata for create action.


    
                    _civicrm_api3_uf_group_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

civicrm_api3_uf_group_create()

Use this API to create a new group.


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

See the CRM Data Model for uf_group property definitions

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_uf_group_get()

Returns array of uf groups (profiles) matching a set of one or more group properties.


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

Parameters

$params : array<string|int, mixed>: Array of properties. If empty, all records will be returned.

Return values

array<string|int, mixed> —

Array of matching profiles

civicrm_api3_uf_group_delete()

Delete uf group.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_uf_group_getlist_defaults()

Set default getlist parameters.


    
                    _civicrm_api3_uf_group_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>

Parameters

$request : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_uf_group_getlist_output()

Format getlist output


    
                    _civicrm_api3_uf_group_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request, string $entity, array<string|int, mixed> $fields) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>
$request : array<string|int, mixed>
$entity : string
$fields : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_uf_join_create()

Takes an associative array and creates a uf join in the database.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

CRM_Core_DAO_UFJoin Array

_civicrm_api3_uf_join_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_uf_join_create_spec(array<string|int, mixed> &$params) : mixed

Parameters

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

civicrm_api3_uf_join_get()

Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record.


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

Parameters

$params : array<string|int, mixed>: Array of name/value pairs.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_uf_join_delete()

Delete a CiviCRM UF_Join.


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

Parameters

$params : array<string|int, mixed>: Array of name/value pairs.

Return values

array<string|int, mixed> —

API result array.

civicrm_api3_uf_match_get()

Get the contact_id given a uf_id or vice versa.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_uf_match_create()

Create or update a UF Match record.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

Api result array

_civicrm_api3_uf_match_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_uf_match_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_uf_match_delete()

Delete a UF Match record.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Api result array.

civicrm_api3_user_get()

Get details about the CMS User entity.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_user_get_spec()

Adjust Metadata for Get action.


    
                    _civicrm_api3_user_get_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

_civicrm_api3_initialize()

Initialize CiviCRM - should be run at the start of each API function.


    
                    _civicrm_api3_initialize() : mixed

civicrm_api3_verify_one_mandatory()

Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking.


    
                    civicrm_api3_verify_one_mandatory(array<string|int, mixed> $params[, array<string|int, mixed> $daoName = NULL ][, array<string|int, mixed> $keyoptions = [] ]) : mixed

Parameters

$params : array<string|int, mixed>: Array of fields to check.
$daoName : array<string|int, mixed> = NULL: String DAO to check for required fields (create functions only).
$keyoptions : array<string|int, mixed> = []: List of required fields options. One of the options is required.

civicrm_api3_verify_mandatory()

Check mandatory fields are included.


    
                    civicrm_api3_verify_mandatory(array<string|int, mixed> $params[, array<string|int, mixed> $daoName = NULL ][, array<string|int, mixed> $keys = [] ][, bool $verifyDAO = TRUE ]) : mixed

Parameters

$params : array<string|int, mixed>: Array of fields to check.
$daoName : array<string|int, mixed> = NULL: String DAO to check for required fields (create functions only).
$keys : array<string|int, mixed> = []: List of required fields. A value can be an array denoting that either this or that is required.
$verifyDAO : bool = TRUE

civicrm_api3_create_error()

Create error array.


    
                    civicrm_api3_create_error(string $msg[, array<string|int, mixed> $data = [] ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

civicrm_api3_create_success()

Format array in result output style.


    
                    civicrm_api3_create_success([array<string|int, mixed>|int $values = 1 ][, array<string|int, mixed> $params = [] ][, string $entity = NULL ][, string $action = NULL ][, object &$dao = NULL ][, array<string|int, mixed> $extraReturnValues = [] ]) : array<string|int, mixed>

Parameters

$values : array<string|int, mixed>|int = 1

values generated by API operation (the result)

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

Parameters passed into API call.

$entity : string = NULL

The entity being acted on.

$action : string = NULL

The action passed to the API.

$dao : object = NULL

DAO object to be freed here.

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

Additional values to be added to top level of result array(.

this param is currently used for legacy behaviour support

Return values

array<string|int, mixed>

_civicrm_api3_load_DAO()

Load the DAO of the entity.


    
                    _civicrm_api3_load_DAO(string $entity) : bool

Parameters

$entity : string

Return values

bool

_civicrm_api3_get_DAO()

Return the DAO of the function or Entity.


    
                    _civicrm_api3_get_DAO(string $name) : CRM_Core_DAO|string

Parameters

$name : string: Either a function of the api (civicrm_{entity}_create or the entity name. return the DAO name to manipulate this function eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"

Return values

CRM_Core_DAO|string

_civicrm_api3_get_BAO()

Return the BAO name of the function or Entity.


    
                    _civicrm_api3_get_BAO(string $name) : string|null

Parameters

$name : string: Is either a function of the api (civicrm_{entity}_create or the entity name. return the DAO name to manipulate this function eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"

Return values

string|null

_civicrm_api3_separate_values()

Recursive function to explode value-separated strings into arrays.


    
                    _civicrm_api3_separate_values(array<string|int, mixed> &$values) : mixed

Parameters

$values : array<string|int, mixed>

_civicrm_api3_filter_fields_for_bao()

This is a legacy wrapper for api_store_values.


    
                    _civicrm_api3_filter_fields_for_bao(string $entity, array<string|int, mixed> &$params, array<string|int, mixed> &$values) : mixed

It checks suitable fields using getfields rather than DAO->fields.

Getfields has handling for how to deal with unique names which dao->fields doesn't

Note this is used by BAO type create functions - eg. contribution

Parameters

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

_civicrm_api3_store_values()

Copy values (other than id) from params to values if they exist in fields.


    
                    _civicrm_api3_store_values(array<string|int, mixed> $fields, array<string|int, mixed> $params, array<string|int, mixed> &$values) : bool

Parameters

$fields : array<string|int, mixed>
$params : array<string|int, mixed>
$values : array<string|int, mixed>

Return values

bool

_civicrm_api3_get_using_query_object()

Get function for query object api.


    
                    _civicrm_api3_get_using_query_object(string $entity, array<string|int, mixed> $params[, array<string|int, mixed> $additional_options = [] ][, bool $getCount = NULL ][, int $mode = 1 ][, null|array<string|int, mixed> $defaultReturnProperties = NULL ]) : array<string|int, mixed>

The API supports 2 types of get request. The more complex uses the BAO query object. This is a generic function for those functions that call it

At the moment only called by contact we should extend to contribution & others that use the query object. Note that this function passes permission information in. The others don't

Ideally this would be merged with _civicrm_get_query_object but we need to resolve differences in what the 2 variants call

Parameters

$entity : string
$params : array<string|int, mixed>: As passed into api get or getcount function.
$additional_options : array<string|int, mixed> = []: Array of options (so we can modify the filter).
$getCount : bool = NULL: Are we just after the count.
$mode : int = 1: This basically correlates to the component.
$defaultReturnProperties : null|array<string|int, mixed> = NULL: Default return properties for the entity (used if return not set - but don't do that - set return!).

Return values

array<string|int, mixed>

_civicrm_api3_get_query_object()

Get dao query object based on input params.


    
                    _civicrm_api3_get_query_object(array<string|int, mixed> $params, string $mode, string $entity) : array<string|int, mixed>

Ideally this would be merged with _civicrm_get_using_query_object but we need to resolve differences in what the 2 variants call

Parameters

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

Return values

array<string|int, mixed> —

[CRM_Core_DAO|CRM_Contact_BAO_Query]

_civicrm_api3_dao_set_filter()

Function transfers the filters being passed into the DAO onto the params object.

DAO based retrieval is being phased out.


    
                    _civicrm_api3_dao_set_filter(CRM_Core_DAO &$dao, array<string|int, mixed> $params[, bool $unique = TRUE ][, array<string|int, mixed> $extraSql = [] ]) : mixed

Parameters

$dao : CRM_Core_DAO
$params : array<string|int, mixed>
$unique : bool = TRUE
$extraSql : array<string|int, mixed> = []: API specific queries eg for event isCurrent would be converted to $extraSql['where'] = array('civicrm_event' => array('(start_date >= CURDATE() || end_date >= CURDATE())'));

_civicrm_api3_apply_filters_to_dao()

Apply filters (e.g. high, low) to DAO object (prior to find).


    
                    _civicrm_api3_apply_filters_to_dao(string $filterField, string $filterValue, object &$dao) : mixed

Parameters

$filterField : string: Field name of filter.
$filterValue : string: Field value of filter.
$dao : object: DAO object.

_civicrm_api3_get_options_from_params()

Get sort, limit etc options from the params - supporting old & new formats.


    
                    _civicrm_api3_get_options_from_params(array<string|int, mixed> $params[, bool $queryObject = FALSE ][, string $entity = '' ][, string $action = '' ]) : array<string|int, mixed>

Get returnProperties for legacy

Parameters

$params : array<string|int, mixed>: Params array as passed into civicrm_api.
$queryObject : bool = FALSE: Is this supporting a queryObject api (e.g contact) - if so we support more options. for legacy report & return a unique fields array
$entity : string = ''
$action : string = ''

Return values

array<string|int, mixed> —

options extracted from params

_civicrm_api3_apply_options_to_dao()

Apply options (e.g. sort, limit, order by) to DAO object (prior to find).


    
                    _civicrm_api3_apply_options_to_dao(array<string|int, mixed> &$params, object &$dao, string $entity) : mixed

Parameters

$params : array<string|int, mixed>: Params array as passed into civicrm_api.
$dao : object: DAO object.
$entity : string

_civicrm_api3_build_fields_array()

Build fields array.


    
                    _civicrm_api3_build_fields_array(CRM_Core_DAO &$bao[, bool $unique = TRUE ]) : array<string|int, mixed>

This is the array of fields as it relates to the given DAO returns unique fields as keys by default but if set but can return by DB fields

Parameters

$bao : CRM_Core_DAO
$unique : bool = TRUE

Return values

array<string|int, mixed>

_civicrm_api3_get_unique_name_array()

Build fields array.


    
                    _civicrm_api3_get_unique_name_array(CRM_Core_DAO &$bao) : array<string|int, mixed>

This is the array of fields as it relates to the given DAO returns unique fields as keys by default but if set but can return by DB fields

Parameters

$bao : CRM_Core_DAO

Return values

array<string|int, mixed>

_civicrm_api3_dao_to_array()

Converts an DAO object to an array.

DAO based retrieval is being phased out.


    
                    _civicrm_api3_dao_to_array(CRM_Core_DAO $dao[, array<string|int, mixed> $params = NULL ][, bool $uniqueFields = TRUE ][, string $entity = "" ][, bool $autoFind = TRUE ]) : array<string|int, mixed>

Parameters

$dao : CRM_Core_DAO: Object to convert.
$params : array<string|int, mixed> = NULL
$uniqueFields : bool = TRUE
$entity : string = ""
$autoFind : bool = TRUE

Return values

array<string|int, mixed>

_civicrm_api3_custom_fields_are_required()

Determine if custom fields need to be retrieved.


    
                    _civicrm_api3_custom_fields_are_required(string $entity, array<string|int, mixed> $params) : bool

We currently retrieve all custom fields or none at this level so if we know the entity && it can take custom fields & there is the string 'custom' in their return request we get them all, they are filtered on the way out

Parameters

$entity : string: Entity name in CamelCase.
$params : array<string|int, mixed>

Return values

bool

_civicrm_api3_object_to_array()

Converts an object to an array.


    
                    _civicrm_api3_object_to_array(object &$dao, array<string|int, mixed> &$values[, array<string|int, mixed>|bool $uniqueFields = FALSE ]) : mixed

Parameters

$dao : object: (reference) object to convert.
$values : array<string|int, mixed>: (reference) array.
$uniqueFields : array<string|int, mixed>|bool = FALSE

_civicrm_api3_object_to_array_unique_fields()

Wrapper for _civicrm_object_to_array when api supports unique fields.


    
                    _civicrm_api3_object_to_array_unique_fields(CRM_Core_DAO &$dao, array<string|int, mixed> &$values) : array<string|int, mixed>

Parameters

$dao : CRM_Core_DAO
$values : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_custom_format_params()

Format custom parameters.


    
                    _civicrm_api3_custom_format_params(array<string|int, mixed> $params, array<string|int, mixed> &$values, string $extends[, string $entityId = NULL ]) : mixed

Parameters

$params : array<string|int, mixed>
$values : array<string|int, mixed>
$extends : string: Entity that this custom field extends (e.g. contribution, event, contact).
$entityId : string = NULL: ID of entity per $extends.

_civicrm_api3_format_params_for_create()

Format parameters for create action.


    
                    _civicrm_api3_format_params_for_create(array<string|int, mixed> &$params, string $entity) : mixed

Parameters

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

formatCheckBoxField()

We can't rely on downstream to add separators to checkboxes so we'll check here.


    
                    formatCheckBoxField(mixed &$checkboxFieldValue, string $customFieldLabel, string $entity) : mixed

We should look at pushing to BAO function and / or validate function but this is a safe place for now as it has massive test coverage & we can keep the change very specific note that this is specifically tested in the GRANT api test case so later refactoring should use that as a checking point

We will only alter the value if we are sure that changing it will make it correct - if it appears wrong but does not appear to have a clear fix we don't touch - lots of very cautious code in here

The resulting array should look like array( 'key' => 1, 'key1' => 1, );

OR one or more keys wrapped in a CRM_Core_DAO::VALUE_SEPARATOR - either it accepted by the receiving function

Parameters

$checkboxFieldValue : mixed
$customFieldLabel : string
$entity : string

_civicrm_api3_basic_get()

Function to do a 'standard' api get - when the api is only doing a $bao->find then use this.


    
                    _civicrm_api3_basic_get(string|CRM_Core_DAO $bao_name, array<string|int, mixed> $params[, bool $returnAsSuccess = TRUE ][, string $entity = "" ][, CRM_Utils_SQL_Select|null $sql = NULL ][, bool $uniqueFields = FALSE ]) : array<string|int, mixed>

Parameters

$bao_name : string|CRM_Core_DAO: Name of BAO.
$params : array<string|int, mixed>: Params from api.
$returnAsSuccess : bool = TRUE: Return in api success format.
$entity : string = ""
$sql : CRM_Utils_SQL_Select|null = NULL: Extra SQL bits to add to the query. For filtering current events, this might be: CRM_Utils_SQL_Select::fragment()->where('(start_date >= CURDATE() || end_date >= CURDATE())');
$uniqueFields : bool = FALSE: Should unique field names be returned (for backward compatibility)

Return values

array<string|int, mixed>

_civicrm_api3_basic_create()

Function to do a 'standard' api create - when the api is only doing a $bao::create then use this.


    
                    _civicrm_api3_basic_create(string $bao_name, array<string|int, mixed> &$params[, string $entity = NULL ]) : array<string|int, mixed>

Parameters

$bao_name : string: Name of BAO Class.
$params : array<string|int, mixed>: Parameters passed into the api call.
$entity : string = NULL: Entity - pass in if entity is non-standard & required $ids array.

Return values

array<string|int, mixed>

_civicrm_api3_basic_create_fallback()

For BAO's which don't have a create() or add() functions, use this fallback implementation.


    
                    _civicrm_api3_basic_create_fallback(string|CRM_Core_DAO $bao_name, array<string|int, mixed> $params) : CRM_Core_DAO|null

Parameters

$bao_name : string|CRM_Core_DAO
$params : array<string|int, mixed>

Return values

CRM_Core_DAO|null —

An instance of the BAO

_civicrm_api3_basic_delete()

Function to do a 'standard' api del.


    
                    _civicrm_api3_basic_delete(string|CRM_Core_DAO $bao_name, array<string|int, mixed> &$params) : array<string|int, mixed>

When the api is only doing a $bao::del then use this if api::del doesn't exist it will try DAO delete method.

Parameters

$bao_name : string|CRM_Core_DAO
$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_custom_data_get()

Get custom data for the given entity & Add it to the returnArray.


    
                    _civicrm_api3_custom_data_get(array<string|int, mixed> &$returnArray, bool $checkPermission, string $entity, int $entity_id[, int $groupID = NULL ][, int $subType = NULL ][, string $subName = NULL ]) : mixed

This looks like 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string' Where 123 is field value & 1 is the id within the custom group data table (value ID)

Parameters

$returnArray : array<string|int, mixed>: Array to append custom data too - generally $result[4] where 4 is the entity id.
$checkPermission : bool
$entity : string: E.g membership, event.
$entity_id : int
$groupID : int = NULL: Per CRM_Core_BAO_CustomGroup::getTree.
$subType : int = NULL: E.g. membership_type_id where custom data doesn't apply to all membership types.
$subName : string = NULL: Subtype of entity.

_civicrm_api3_validate()

Used by the Validate API.


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

Parameters

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

Return values

array<string|int, mixed> —

$errors

_civicrm_api3_validate_switch_cases()

Used by the Validate API.


    
                    _civicrm_api3_validate_switch_cases(string $fieldName, array<string|int, mixed> $fieldInfo, string $entity, array<string|int, mixed> $params, string $action) : mixed

Parameters

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

_civicrm_api3_validate_fields()

Validate fields being passed into API.


    
                    _civicrm_api3_validate_fields(string $entity, string $action, array<string|int, mixed> &$params, array<string|int, mixed> $fields) : mixed

This function relies on the getFields function working accurately for the given API.

As of writing only date was implemented.

Parameters

$entity : string
$action : string
$params : array<string|int, mixed>: -.
$fields : array<string|int, mixed>: Response from getfields all variables are the same as per civicrm_api.

_civicrm_api3_validate_foreign_keys()

Validate foreign key values of fields being passed into API.


    
                    _civicrm_api3_validate_foreign_keys(string $entity, string $action, array<string|int, mixed> &$params, array<string|int, mixed> $fields) : mixed

This function relies on the getFields function working accurately for the given API.

Parameters

$entity : string
$action : string
$params : array<string|int, mixed>
$fields : array<string|int, mixed>: Response from getfields all variables are the same as per civicrm_api.

_civicrm_api3_validate_date()

Validate date fields being passed into API.


    
                    _civicrm_api3_validate_date(array<string|int, mixed> &$params, string &$fieldName, array<string|int, mixed> &$fieldInfo) : mixed

It currently converts both unique fields and DB field names to a mysql date.

Parameters

$params : array<string|int, mixed>: Params from civicrm_api.
$fieldName : string: Uniquename of field being checked.
$fieldInfo : array<string|int, mixed>: Array of fields from getfields function.

_civicrm_api3_getValidDate()

Convert date into BAO friendly date.


    
                    _civicrm_api3_getValidDate(string $dateValue, string $fieldName, int $fieldType) : mixed

We accept 'whatever strtotime accepts'

Parameters

$dateValue : string
$fieldName : string
$fieldType : int

_civicrm_api3_validate_constraint()

Validate foreign constraint fields being passed into API.


    
                    _civicrm_api3_validate_constraint(mixed $fieldValue, string $fieldName, array<string|int, mixed> $fieldInfo, string $entity) : mixed

Parameters

$fieldValue : mixed
$fieldName : string: Unique name of field being checked.
$fieldInfo : array<string|int, mixed>: Array of fields from getfields function.
$entity : string

_civicrm_api3_validate_unique_key()

Validate foreign constraint fields being passed into API.


    
                    _civicrm_api3_validate_unique_key(array<string|int, mixed> &$params, string &$fieldName) : mixed

Parameters

$params : array<string|int, mixed>: Params from civicrm_api.
$fieldName : string: Uniquename of field being checked.

_civicrm_api3_generic_replace()

Generic implementation of the "replace" action.


    
                    _civicrm_api3_generic_replace(string $entity, array<string|int, mixed> $params) : array<string|int, mixed>|int

Replace the old set of entities (matching some given keys) with a new set of entities (matching the same keys).

Parameters

$entity : string

Entity name.

$params : array<string|int, mixed>

Params from civicrm_api, including:.

'values': an array of records to save
all other items: keys which identify new/pre-existing records.

Return values

array<string|int, mixed>|int

_civicrm_api3_generic_replace_base_params()

Replace base parameters.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api_get_fields()

Returns fields allowable by api.


    
                    _civicrm_api_get_fields(string $entity[, bool $unique = FALSE ][, array<string|int, mixed> &$params = [] ]) : array<string|int, mixed>

Parameters

$entity : string: String Entity to query.
$unique : bool = FALSE: Index by unique fields?.
$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>

_civicrm_api_get_custom_fields()

Return an array of fields for a given entity.


    
                    _civicrm_api_get_custom_fields(string $entity, array<string|int, mixed> &$params) : array<string|int, mixed>

This is the same as the BAO function but fields are prefixed with 'custom_' to represent api params.

Parameters

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

Return values

array<string|int, mixed>

_civicrm_api3_swap_out_aliases()

Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't.


    
                    _civicrm_api3_swap_out_aliases(array<string|int, mixed> &$apiRequest, array<string|int, mixed> $fields) : mixed

If multiple aliases the last takes precedence

Function also swaps unique fields for non-unique fields & vice versa.

Parameters

$apiRequest : array<string|int, mixed>
$fields : array<string|int, mixed>

_civicrm_api3_validate_integer()

Validate integer fields being passed into API.


    
                    _civicrm_api3_validate_integer(array<string|int, mixed> &$params, string $fieldName, array<string|int, mixed> &$fieldInfo, string $entity) : mixed

It currently converts the incoming value 'user_contact_id' into the id of the currently logged in user.

Parameters

$params : array<string|int, mixed>: Params from civicrm_api.
$fieldName : string: Uniquename of field being checked.
$fieldInfo : array<string|int, mixed>: Array of fields from getfields function.
$entity : string

_civicrm_api3_resolve_country_id()

Helper function to determine country_id given the myriad of values for country_id or country that are supported


    
                    _civicrm_api3_resolve_country_id(array<string|int, mixed> $params) : int|null

Parameters

$params : array<string|int, mixed>

Return values

int|null

_civicrm_api3_resolve_contactID()

Determine a contact ID using a string expression.


    
                    _civicrm_api3_resolve_contactID(string $contactIdExpr) : int|null|"unknown-user"

Parameters

$contactIdExpr : string: E.g. "user_contact_id" or "@user:username".

Return values

int|null|"unknown-user"

_civicrm_api3_validate_html()

Validate html (check for scripting attack).


    
                    _civicrm_api3_validate_html(array<string|int, mixed> &$params, string &$fieldName, array<string|int, mixed> $fieldInfo) : mixed

Parameters

$params : array<string|int, mixed>
$fieldName : string
$fieldInfo : array<string|int, mixed>

_civicrm_api3_validate_string()

Validate string fields being passed into API.


    
                    _civicrm_api3_validate_string(array<string|int, mixed> &$params, string &$fieldName, array<string|int, mixed> &$fieldInfo, string $entity, string $action) : mixed

Parameters

$params : array<string|int, mixed>: Params from civicrm_api.
$fieldName : string: Uniquename of field being checked.
$fieldInfo : array<string|int, mixed>: Array of fields from getfields function.
$entity : string
$action : string

_civicrm_api3_api_match_pseudoconstant()

Validate & swap out any pseudoconstants / options.


    
                    _civicrm_api3_api_match_pseudoconstant(mixed &$fieldValue, string $entity, string $fieldName, array<string|int, mixed> $fieldInfo[, string $op = '=' ][, array<string|int, mixed> $additional_lookup_params = [] ]) : mixed

Parameters

$fieldValue : mixed
$entity : string: : api entity name
$fieldName : string: : field name used in api call (not necessarily the canonical name)
$fieldInfo : array<string|int, mixed>: : getfields meta-data
$op : string = '='
$additional_lookup_params : array<string|int, mixed> = []

_civicrm_api3_api_match_pseudoconstant_value()

Validate & swap a single option value for a field.


    
                    _civicrm_api3_api_match_pseudoconstant_value(string &$value, array<string|int, mixed> $options, string $fieldName, bool $isRequired) : mixed

Parameters

$value : string: field value
$options : array<string|int, mixed>: array of options for this field
$fieldName : string: field name used in api call (not necessarily the canonical name)
$isRequired : bool: Is this a required field or is 'null' an acceptable option. We allow 'null' last in case we have the weird situation of it being a valid option in which case our brains will probably explode.

_civicrm_api3_api_resolve_alias()

Returns the canonical name of a field.


    
                    _civicrm_api3_api_resolve_alias(string $entity, string $fieldName[, string $action = 'create' ]) : bool|string

Parameters

$entity : string: api entity name (string should already be standardized - no camelCase).
$fieldName : string: any variation of a field's name (name, unique_name, api.alias).
$action : string = 'create'

Return values

bool|string —

FieldName or FALSE if the field does not exist

_civicrm_api3_deprecation_check()

Check if the function is deprecated.


    
                    _civicrm_api3_deprecation_check(string $entity[, array<string|int, mixed> $result = [] ]) : string|array<string|int, mixed>|null

Parameters

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

Return values

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

_civicrm_api3_field_value_check()

Get the actual field value.


    
                    _civicrm_api3_field_value_check(array<string|int, mixed> &$params, string $fieldName[, string $type = NULL ]) : mixed

In some case $params[$fieldName] holds Array value in this format Array([operator] => [value]) So this function returns the actual field value.

Parameters

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

_civicrm_api3_basic_array_get()

A generic "get" API based on simple array data. This is comparable to _civicrm_api3_basic_get but does not use DAO/BAO. This is useful for small/mid-size data loaded from external JSON or XML documents.


    
                    _civicrm_api3_basic_array_get(string $entity, array<string|int, mixed> $params, array<string|int, mixed> $records, string $idCol, array<string|int, mixed> $filterableFields) : array<string|int, mixed>

Parameters

$entity : string
$params : array<string|int, mixed>: API parameters.
$records : array<string|int, mixed>: List of all records.
$idCol : string: The property which defines the ID of a record
$filterableFields : array<string|int, mixed>: List of filterable fields.

Return values

array<string|int, mixed>

_civicrm_api3_check_edit_permissions()


    
                    _civicrm_api3_check_edit_permissions(string $bao_name, array<string|int, mixed> $params) : mixed

Parameters

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

_civicrm_api3_compare_timestamps()

Check if an entity has been modified since the last known modified_date


    
                    _civicrm_api3_compare_timestamps(string $modifiedDate, int $id, string $entity) : bool

Parameters

$modifiedDate : string: Last knowm modified_date
$id : int: Id of record to check
$entity : string: API Entity

Return values

bool

civicrm_api3_website_create()

Add an Website for a contact.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

_civicrm_api3_website_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_website_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_website_delete()

Deletes an existing Website.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_website_get()

Retrieve one or more websites.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result array

civicrm_api3_word_replacement_get()

Get CiviCRM Word Replacement details.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_word_replacement_create()

Create a new Word Replacement.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

_civicrm_api3_word_replacement_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_word_replacement_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_word_replacement_delete()

Delete an existing WordReplacement.


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

Parameters

$params : array<string|int, mixed>: Array containing id of the WordReplacement to be deleted.

Return values

array<string|int, mixed> —

API result array

civicrm_api3_grant_create()

Create/update Grant.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed>

_civicrm_api3_grant_create_spec()

Adjust Metadata for Create action.


    
                    _civicrm_api3_grant_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters

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

civicrm_api3_grant_get()

Returns array of grants matching a set of one or more properties.


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

Parameters

$params : array<string|int, mixed>: Array per getfields metadata.

Return values

array<string|int, mixed> —

Array of matching grants

civicrm_api3_grant_delete()

This method is used to delete an existing Grant.


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

Parameters

$params : array<string|int, mixed>: Id of the Grant to be deleted is required.

Return values

array<string|int, mixed> —

API Result Array

APIv3

Table of Contents

Packages

Classes

Functions

Functions

civicrm_api()

Parameters

Return values

civicrm_api4()

Parameters

Tags

Return values

civicrm_api3()

Parameters

Tags

Return values

_civicrm_api3_api_getfields()

Parameters

Tags

Return values

civicrm_error()

Parameters

Return values

_civicrm_api_get_camel_name()

Parameters

Return values

_civicrm_api_replace_variables()

Parameters

_civicrm_api_replace_variable()

Parameters

Return values

_civicrm_api_get_entity_name_from_camel()

Parameters

Return values

_civicrm_api_get_entity_name_from_dao()

Parameters

Return values

civicrm_api3_acl_create()

Parameters

Return values

_civicrm_api3_acl_create_spec()

Parameters

civicrm_api3_acl_get()

Parameters

Return values

civicrm_api3_acl_delete()

Parameters

Return values

civicrm_api3_acl_role_create()

Parameters

Return values

_civicrm_api3_acl_role_create_spec()

Parameters

civicrm_api3_acl_role_get()

Parameters

Return values

civicrm_api3_acl_role_delete()

Parameters

Return values

civicrm_api3_action_schedule_get()

Parameters

Return values

civicrm_api3_action_schedule_create()

Parameters

Return values

_civicrm_api3_action_schedule_create_spec()

Parameters

civicrm_api3_action_schedule_delete()

Parameters

Return values

civicrm_api3_activity_create()

Parameters

Tags

Return values

_civicrm_api3_activity_create_spec()

Parameters

_civicrm_api3_activity_get_spec()

Parameters

civicrm_api3_activity_get()