Documentation

API Documentation

Namespaces

Civi
E2E
GuzzleHttp
CiviMix
api

Interfaces

API_Wrapper: Interface API_Wrapper
CRM_Contact_Form_Search_Interface
CRM_Core_CodeGen_ITask: Implemented by CG tasks
CRM_Core_FileSearchInterface: Interface CRM_Core_FileSearchInterface
CRM_Core_PrevNextCache_Interface: Interface CRM_Core_PrevNextCache_Interface
CRM_Core_Reference_Interface: Interface CRM_Core_Reference_Interface
CRM_Core_Resources_CollectionAdderInterface: The collection-adder interface provides write-only support for a collection.
CRM_Core_Resources_CollectionInterface: Class CRM_Core_Resources_CollectionInterface
CRM_Core_Selector_API: This interface defines the set of functions a class needs to implement to use the CRM/Selector object.
CRM_Extension_Container_Interface: An extension container is a locally-accessible source tree which can be scanned for extensions.
CRM_Extension_Manager_Interface: The extension manager handles installing, disabling enabling, and uninstalling extensions.
CRM_Extension_Upgrader_Interface: An "upgrader" is a class that handles the DB install+upgrade lifecycle for an extension.
CRM_Queue_Queue_BatchQueueInterface: Variation on CRM_Queue_Queue which can claim/release/delete items in batches.
CRM_Utils_Cache_Interface

Classes

civicrm_api3: This class allows to consume the API, either from within a module that knows civicrm already:
civicrm_cli: base class for doing all command line operations via civicrm used by cli.php
civicrm_cli_csv_exporter: class used by csv/export.php to export records from the database in a csv file format.
civicrm_cli_csv_file: base class used by both civicrm_cli_csv_import and civicrm_cli_csv_deleter to add or delete records based on those found in a csv file passed to the script.
civicrm_cli_csv_importer: class for processing records to add used by csv/import.php
civicrm_cli_csv_deleter: class for processing records to delete used by csv/delete.php
CiviContributeProcessor
Civi: Class Civi
CRM_ACL_API
CRM_ACL_BAO_ACL: Access Control List
CRM_ACL_BAO_ACLEntityRole: Access Control AclRole.
CRM_ACL_BAO_Cache: Access Control Cache.
CRM_ACL_BAO_EntityRole: Access Control AclRole.
CRM_ACL_DAO_ACL: Placeholder class retained for legacy compatibility.
CRM_ACL_DAO_ACLCache: Placeholder class retained for legacy compatibility.
CRM_ACL_DAO_ACLEntityRole: Placeholder class retained for legacy compatibility.
CRM_ACL_Form_ACL: Base class for admin forms.
CRM_ACL_Form_EntityRole: Base class for admin forms.
CRM_ACL_Form_WordPress_Permissions: This class provides the functionality to Grant access to CiviCRM components and other CiviCRM permissions.
CRM_ACL_Page_ACL: A Page is basically data in a nice pretty format.
CRM_ACL_Page_EntityRole: A Page is basically data in a nice pretty format.
CRM_Activity_ActionMapping: This defines the scheduled-reminder functionality for Activities.
CRM_Activity_BAO_Activity: This class is for activity functions.
CRM_Activity_BAO_ActivityAssignment: This class is for activity assignment functions.
CRM_Activity_BAO_ActivityContact: This class is for activity assignment functions.
CRM_Activity_BAO_ActivityType: This class is a wrapper that moves some boilerplate code out of the Form class and helps remove some ambiguity with name and label.
CRM_Activity_BAO_ICalendar: Generate ical invites for activities.
CRM_Activity_BAO_Query
CRM_Activity_Controller_Search: This class is used by the Search functionality.
CRM_Activity_DAO_Activity: Placeholder class retained for legacy compatibility.
CRM_Activity_DAO_ActivityContact: Placeholder class retained for legacy compatibility.
CRM_Activity_Export_Form_Map: This class gets the name of the file to upload
CRM_Activity_Export_Form_Select: This class gets the name of the file to upload
CRM_Activity_Form_Activity: This class generates form components for Activity.
CRM_Activity_Form_ActivityFilter: This class generates form components for Activity Filter.
CRM_Activity_Form_ActivityLinks: This class generates form components for Activity Links.
CRM_Activity_Form_ActivityView: This class handle activity view mode.
CRM_Activity_Form_Search: This file is for activity search.
CRM_Activity_Form_Task_AddToTag: This class provides the functionality to tag a group of activities (or a single activity)
CRM_Activity_Form_Task_Batch: This class provides the functionality for batch profile update for Activities
CRM_Activity_Form_Task_Delete: This class provides the functionality to delete a group of Activities. This class provides functionality for the actual deletion.
CRM_Activity_Form_Task_Email: This class provides the functionality to email a group of contacts.
CRM_Activity_Form_Task_FileOnCase: This class provides the functionality to email a group of contacts
CRM_Activity_Form_Task_PDF: This class provides the functionality to create PDF/Word letters for activities.
CRM_Activity_Form_Task_PickOption: This class provides the functionality to email a group of contacts.
CRM_Activity_Form_Task_PickProfile: This class provides the functionality for batch profile update for Activity.
CRM_Activity_Form_Task_Print: This class provides the functionality to print activity records.
CRM_Activity_Form_Task_RemoveFromTag: This class provides the functionality to remove tags of contact(s).
CRM_Activity_Form_Task_SMS: This class provides the functionality to sms a group of contacts.
CRM_Activity_Form_Task: Class for activity form task actions.
CRM_Activity_Import_Form_DataSource: This class gets the name of the file to upload.
CRM_Activity_Import_Form_MapField: This class gets the name of the file to upload.
CRM_Activity_Import_Form_Preview: This class previews the uploaded file and returns summary statistics.
CRM_Activity_Import_Parser_Activity: Class to parse activity csv files.
CRM_Activity_Page_AJAX: This class contains all the function that are called using AJAX (jQuery)
CRM_Activity_Page_Tab: Main page for viewing activities,
CRM_Activity_Page_UserDashboard: This class is for building event(participation) block on user dashboard.
CRM_Activity_Selector_Activity: This class is used to retrieve and display activities for a contact.
CRM_Activity_Selector_Search: This class is used to retrieve and display a range of contacts that match the given criteria.
CRM_Activity_StateMachine_Search: Core StateMachine.
CRM_Activity_Task: Class to represent the actions that can be performed on a group of contacts used by the search forms.
CRM_Activity_Tokens: Generate "activity.*" tokens.
CRM_Admin_Form_CMSUser: This class generates form components for Synchronizing CMS Users
CRM_Admin_Form_ContactType: This class generates form components for ContactSub Type.
CRM_Admin_Form_Extensions: This class generates form components for Extensions.
CRM_Admin_Form_Generic: Generic metadata based settings form.
CRM_Admin_Form_Job: Class for configuring jobs.
CRM_Admin_Form_LabelFormats: This class generates form components for Label Format Settings.
CRM_Admin_Form_LocationType: This class generates form components for Location Type.
CRM_Admin_Form_MailSettings: This class handles mail account settings.
CRM_Admin_Form_Mapping: This class generates form components for Mapping.
CRM_Admin_Form_MessageTemplates: This class generates form components for Message templates used by membership, contributions, event registrations, etc.
CRM_Admin_Form_Navigation: This class generates form components for Navigation.
CRM_Admin_Form_OptionGroup: This class generates form components for Option Group.
CRM_Admin_Form_Options: This class generates form components for Options.
CRM_Admin_Form_ParticipantStatusType: Base class for admin forms.
CRM_Admin_Form_PaymentProcessor: This class generates form components for Payment Processor.
CRM_Admin_Form_PaymentProcessorType: This class generates form components for Location Type.
CRM_Admin_Form_PdfFormats: This class generates form components for PDF Page Format Settings.
CRM_Admin_Form_Preferences_Address: This class generates form components for Address Section.
CRM_Admin_Form_Preferences_Contribute: This class generates form components for the display preferences.
CRM_Admin_Form_Preferences_Display: This class generates form components for the display preferences.
CRM_Admin_Form_Preferences_Mailing: This class generates form components for the mailing component preferences.
CRM_Admin_Form_Preferences_Member: This class generates form components for component preferences.
CRM_Admin_Form_Preferences: Base class for settings forms.
CRM_Admin_Form_PreferencesDate: This class generates form components for Location Type.
CRM_Admin_Form_RelationshipType: This class generates form components for Relationship Type.
CRM_Admin_Form_ScheduleReminders: ActionSchedule (aka Scheduled Reminder) create/edit/delete form.
CRM_Admin_Form_Setting_Case: This class generates form components for CiviCase.
CRM_Admin_Form_Setting_Component: This class generates form components for Component.
CRM_Admin_Form_Setting_Date: This class generates form components for Date Formatting.
CRM_Admin_Form_Setting_Debugging: This class generates form components for Error Handling and Debugging.
CRM_Admin_Form_Setting_Localization: This class generates form components for Localization.
CRM_Admin_Form_Setting_Mail: This class generates form components for CiviMail.
CRM_Admin_Form_Setting_Mapping: This class generates form components for Mapping and Geocoding.
CRM_Admin_Form_Setting_Miscellaneous: This class generates form components for Miscellaneous.
CRM_Admin_Form_Setting_Path: This class generates form components for File System Path.
CRM_Admin_Form_Setting_Search: This class generates form components for Search Parameters
CRM_Admin_Form_Setting_Smtp: This class generates form components for Smtp Server.
CRM_Admin_Form_Setting_UF: This class generates form components for Site Url.
CRM_Admin_Form_Setting_UpdateConfigBackend: This class generates form components for Error Handling and Debugging
CRM_Admin_Form_Setting_Url: This class generates form components for Site Url.
CRM_Admin_Form_Setting: This class generates form components generic to CiviCRM settings.
CRM_Admin_Form_WordReplacements: Class CRM_Core_Form
CRM_Admin_Form: Base class for admin forms.
CRM_Admin_Page_Access: Dashboard page for managing Access Control.
CRM_Admin_Page_Admin: Page for displaying Administer CiviCRM Control Panel.
CRM_Admin_Page_AJAX: This class contains all the function that are called using AJAX.
CRM_Admin_Page_APIExplorer: Api Explorer
CRM_Admin_Page_ConfigTaskList: Page for displaying list of site configuration tasks with links to each setting form.
CRM_Admin_Page_ContactType: Page for displaying list of contact Subtypes.
CRM_Admin_Page_EventTemplate: Page for displaying list of event templates.
CRM_Admin_Page_Extensions: This page displays the list of extensions registered in the system.
CRM_Admin_Page_ExtensionsUpgrade: Display a page which displays a progress bar while executing upgrade tasks.
CRM_Admin_Page_Job: Page for displaying list of jobs.
CRM_Admin_Page_JobLog: Page for displaying log of jobs.
CRM_Admin_Page_LabelFormats: Page for displaying list of Label Formats.
CRM_Admin_Page_LocationType: Page for displaying list of location types.
CRM_Admin_Page_MailSettings: Page for displaying list of Mail account settings.
CRM_Admin_Page_Mapping: Page for displaying list of categories.
CRM_Admin_Page_MessageTemplates: Page for displaying list of message templates.
CRM_Admin_Page_Navigation: Page for editing the navigation menu.
CRM_Admin_Page_Options: Page for displaying list of option groups and option values.
CRM_Admin_Page_ParticipantStatusType: A Page is basically data in a nice pretty format.
CRM_Admin_Page_PaymentProcessor: Page for displaying list of payment processors.
CRM_Admin_Page_PaymentProcessorType: Page for displaying list of payment processor types.
CRM_Admin_Page_PdfFormats: Page for displaying list of PDF Page Formats.
CRM_Admin_Page_PreferencesDate: Page for displaying list of date preferences.
CRM_Admin_Page_RelationshipType: Page for displaying list of relationship types.
CRM_Admin_Page_ScheduleReminders: Page for displaying list of Reminders.
CRM_Api4_Page_AJAX: A Page is basically data in a nice pretty format.
CRM_Api4_Page_Api4Explorer: A Page is basically data in a nice pretty format.
CRM_Badge_BAO_Badge: Class CRM_Badge_Format_Badge.
CRM_Badge_BAO_Layout: Placeholder class retained for legacy compatibility.
CRM_Badge_Form_Layout: This class generates form components for name badge layout.
CRM_Badge_Page_AJAX
CRM_Badge_Page_Layout: Page for list page badges.
CRM_Batch_BAO_Batch: Batch BAO class.
CRM_Batch_BAO_EntityBatch: Placeholder class retained for legacy compatibility.
CRM_Batch_DAO_Batch: Placeholder class retained for legacy compatibility.
CRM_Batch_DAO_EntityBatch: Placeholder class retained for legacy compatibility.
CRM_Batch_Form_Batch: This class generates form components for batch entry.
CRM_Batch_Form_Entry: This class provides the functionality for batch entry for contributions/memberships.
CRM_Batch_Form_Search: Class CRM_Core_Form
CRM_Batch_Page_AJAX: This class contains functions that are called using AJAX.
CRM_Batch_Page_Batch: Page for displaying list of current batches
CRM_Bridge_OG_CiviCRM
CRM_Bridge_OG_Drupal: d6 compatible?
CRM_Bridge_OG_Utils
CRM_Campaign_BAO_Campaign: Placeholder class retained for legacy compatibility.
CRM_Campaign_BAO_Petition: Class CRM_Campaign_BAO_Survey.
CRM_Campaign_BAO_Query
CRM_Campaign_BAO_Survey: Class CRM_Campaign_BAO_Survey.
CRM_Campaign_Controller_Search: This class is used by the Search functionality.
CRM_Campaign_DAO_Campaign: Placeholder class retained for legacy compatibility.
CRM_Campaign_DAO_CampaignGroup: Placeholder class retained for legacy compatibility.
CRM_Campaign_DAO_Survey: Placeholder class retained for legacy compatibility.
CRM_Campaign_Form_Campaign: This class generates form components for processing a campaign.
CRM_Campaign_Form_Gotv: Files required
CRM_Campaign_Form_Petition_Signature: This class generates form components for processing a petition signature.
CRM_Campaign_Form_Petition: This class generates form components for adding a petition.
CRM_Campaign_Form_Search: Files required.
CRM_Campaign_Form_Survey_Delete: This class is to build the form for deleting a Survey.
CRM_Campaign_Form_Survey_Main: This class generates form components for processing a survey.
CRM_Campaign_Form_Survey_Questions: This class generates form components for processing a survey.
CRM_Campaign_Form_Survey_Results: This class generates form components for processing a survey.
CRM_Campaign_Form_Survey_TabHeader
CRM_Campaign_Form_Survey: This class generates form components for processing a survey.
CRM_Campaign_Form_SurveyType: This class generates form components for Option Group.
CRM_Campaign_Form_Task_Interview: This class provides the functionality to record voter's interview.
CRM_Campaign_Form_Task_Print: This class provides the functionality to print voter records
CRM_Campaign_Form_Task_Release: This class provides the functionality to add contacts for voter reservation.
CRM_Campaign_Form_Task_Reserve: This class provides the functionality to add contacts for voter reservation.
CRM_Campaign_Form_Task_Result: Used for displaying results.
CRM_Campaign_Form_Task: This class generates form components for relationship.
CRM_Campaign_Info: This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.
CRM_Campaign_Page_AJAX: This class contains all campaign related functions that are called using AJAX (jQuery)
CRM_Campaign_Page_Petition_Confirm: A Page is basically data in a nice pretty format.
CRM_Campaign_Page_Petition_ThankYou: A Page is basically data in a nice pretty format.
CRM_Campaign_Page_Petition: Page for displaying Petition Signatures.
CRM_Campaign_Page_SurveyType: Page for displaying list of survey types.
CRM_Campaign_Page_Vote: Page for voting tab interface.
CRM_Campaign_Selector_Search: This class is used to retrieve and display a range of contacts that match the given criteria.
CRM_Campaign_StateMachine_Search: Core StateMachine.
CRM_Campaign_SurveyTokens: Generate "survey.*" tokens.
CRM_Campaign_Task: class to represent the actions that can be performed on a group of voters.
CRM_Campaign_WorkflowMessage_PetitionConfirmationNeeded: Invoice generated when invoicing is enabled.
CRM_Campaign_WorkflowMessage_PetitionSign: Invoice generated when invoicing is enabled.
CRM_Campaign_WorkflowMessage_Survey_Survey: Basic contribution example for contribution templates.
CRM_Case_Audit_Audit: Class CRM_Case_Audit_Audit
CRM_Case_Audit_AuditConfig: Class CRM_Case_Audit_AuditConfig
CRM_Case_BAO_Case: This class contains the functions for Case Management.
CRM_Case_BAO_CaseContact: This class contains the functions for Case Contact management.
CRM_Case_BAO_CaseType: This class contains the functions for Case Type management.
CRM_Case_BAO_Query
CRM_Case_Controller_Search: This class is used by the Search functionality.
CRM_Case_DAO_Case: Placeholder class retained for legacy compatibility.
CRM_Case_DAO_CaseActivity: Placeholder class retained for legacy compatibility.
CRM_Case_DAO_CaseContact: Placeholder class retained for legacy compatibility.
CRM_Case_DAO_CaseType: Placeholder class retained for legacy compatibility.
CRM_Case_Export_Form_Map: This class gets the name of the file to upload
CRM_Case_Export_Form_Select: This class gets the name of the file to upload
CRM_Case_Form_Activity_ChangeCaseStartDate: This class generates form components for OpenCase Activity.
CRM_Case_Form_Activity_ChangeCaseStatus: This class generates form components for OpenCase Activity.
CRM_Case_Form_Activity_ChangeCaseType: This class generates form components for OpenCase Activity.
CRM_Case_Form_Activity_LinkCases: This class generates form components for LinkCase Activity.
CRM_Case_Form_Activity_OpenCase: This class generates form components for OpenCase Activity.
CRM_Case_Form_Activity: This class create activities for a case.
CRM_Case_Form_ActivityToCase: This class generates form components for building activity to a case.
CRM_Case_Form_ActivityView: This class does pre processing for viewing an activity or their revisions.
CRM_Case_Form_AddToCaseAsRole: Class CRM_Case_Form_AddToCaseAsRole
CRM_Case_Form_Case: This class generates form components for case activity.
CRM_Case_Form_CaseView: This class generates view mode for CiviCase.
CRM_Case_Form_CustomData: This class generates form components for custom data
CRM_Case_Form_DeleteClient: This class assigns the current case to another client.
CRM_Case_Form_EditClient: This class assigns the current case to another client.
CRM_Case_Form_Report: This class generates form components for case report.
CRM_Case_Form_Search: This file is for Case search.
CRM_Case_Form_Task_Batch: This class provides the functionality for batch profile update for cases
CRM_Case_Form_Task_Delete: This class provides the functionality to delete a group of case records.
CRM_Case_Form_Task_Email: This class provides the functionality to email a group of contacts.
CRM_Case_Form_Task_PDF: This class provides the functionality to create PDF letter for a group of contacts.
CRM_Case_Form_Task_PickProfile: This class provides the functionality for batch profile update for case
CRM_Case_Form_Task_Print: This class provides the functionality to save a search Saved Searches are used for saving frequently used queries
CRM_Case_Form_Task_Restore: This class provides the functionality to restore a group of participations.
CRM_Case_Form_Task_Result: Used for displaying results.
CRM_Case_Form_Task: This class generates form task actions for CiviCase.
CRM_Case_Info: This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.
CRM_Case_ManagedEntities: Class CRM_Case_ManagedEntities
CRM_Case_Page_AJAX: This class contains all case related functions that are called using AJAX
CRM_Case_Page_CaseDetails: A Page is basically data in a nice pretty format.
CRM_Case_Page_DashBoard: This page is for Case Dashboard.
CRM_Case_Page_Tab: This class handle case related functions.
CRM_Case_PseudoConstant: This class holds all the Pseudo constants that are specific for CiviCase.
CRM_Case_Selector_Search: This class is used to retrieve and display a range of contacts that match the given criteria.
CRM_Case_StateMachine_Search: Core StateMachine.
CRM_Case_Task: Class to represent the actions that can be performed on a group of contacts.
CRM_Case_Tokens: Class CRM_Case_Tokens
CRM_Case_WorkflowMessage_ActivityExamples: Basic contribution example for contribution templates.
CRM_Case_WorkflowMessage_CaseActivity: When an activity is created in a case, the "case_activity" email is sent.
CRM_Case_XMLProcessor_Process
CRM_Case_XMLProcessor_Report
CRM_Case_XMLProcessor_Settings
CRM_Case_XMLProcessor
CRM_Case_XMLRepository
CRM_Contact_ActionMapping: This defines the scheduled-reminder functionality for contact entities. It is useful for, e.g., sending a reminder based on birth date, modification date, or other custom dates on the contact record.
CRM_Contact_BAO_Contact_Location
CRM_Contact_BAO_Contact_Permission
CRM_Contact_BAO_Contact_Utils
CRM_Contact_BAO_Contact: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_ContactType: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_DashboardContact: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_Group: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_GroupContact: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_GroupContactCache: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_GroupNesting: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_GroupNestingCache
CRM_Contact_BAO_GroupOrganization: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_Household: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_Individual: Class contains functions for individual contact type.
CRM_Contact_BAO_ProximityQuery
CRM_Contact_BAO_Query_Hook: Delegate query functions based on hook system.
CRM_Contact_BAO_Query_Interface: Abstract class for search BAO query objects
CRM_Contact_BAO_Query: This is the heart of the search query building mechanism.
CRM_Contact_BAO_Relationship: Class CRM_Contact_BAO_Relationship.
CRM_Contact_BAO_RelationshipCache: Class CRM_Contact_BAO_RelationshipCache.
CRM_Contact_BAO_RelationshipType: Placeholder class retained for legacy compatibility.
CRM_Contact_BAO_SavedSearch: Business object for Saved searches.
CRM_Contact_BAO_SubscriptionHistory: BAO object for civicrm_subscription_history table.
CRM_Contact_Controller_Search: This class is used by the Search functionality.
CRM_Contact_DAO_ACLContactCache: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_Contact: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_ContactType: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_DashboardContact: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_Group: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_GroupContact: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_GroupContactCache: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_GroupNesting: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_GroupOrganization: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_Relationship: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_RelationshipCache: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_RelationshipType: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_SavedSearch: Placeholder class retained for legacy compatibility.
CRM_Contact_DAO_SubscriptionHistory: Placeholder class retained for legacy compatibility.
CRM_Contact_Export_Form_Map: This class gets the name of the file to upload
CRM_Contact_Export_Form_Select: This class gets the name of the file to upload
CRM_Contact_Form_Contact: This class generates form components generic to all the contact types.
CRM_Contact_Form_CustomData: This class generates form components for custom data.
CRM_Contact_Form_DedupeFind: This class generates form components for DedupeRules.
CRM_Contact_Form_DedupeRules: This class generates form components for DedupeRules.
CRM_Contact_Form_Domain: This class is to build the form for adding Group.
CRM_Contact_Form_Edit_Address: This class is used to build address block.
CRM_Contact_Form_Edit_CommunicationPreferences: Form helper class for an Communication Preferences object.
CRM_Contact_Form_Edit_CustomData: Form helper class for an Demographics object (ahem).
CRM_Contact_Form_Edit_Demographics: Form helper class for an Demographics object.
CRM_Contact_Form_Edit_Email: Form helper class for an Email object.
CRM_Contact_Form_Edit_Household: Auxiliary class to provide support to the Contact Form class.
CRM_Contact_Form_Edit_IM: Form helper class for an IM object.
CRM_Contact_Form_Edit_Individual: Auxiliary class to provide support to the Contact Form class.
CRM_Contact_Form_Edit_Lock: Auxiliary class to provide support for locking (and ignoring locks on) contact records.
CRM_Contact_Form_Edit_Notes
CRM_Contact_Form_Edit_OpenID: Form helper class for an OpenID object.
CRM_Contact_Form_Edit_Organization: Auxiliary class to provide support to the Contact Form class.
CRM_Contact_Form_Edit_Phone: Form helper class for a phone object.
CRM_Contact_Form_Edit_TagsAndGroups
CRM_Contact_Form_Edit_Website: Form helper class for an Website object.
CRM_Contact_Form_GroupContact: This class generates form components for groupContact.
CRM_Contact_Form_Inline_Address: Form helper class for address section.
CRM_Contact_Form_Inline_CommunicationPreferences: Form helper class for communication preferences inline edit section.
CRM_Contact_Form_Inline_ContactInfo: Form helper class for contact info section.
CRM_Contact_Form_Inline_ContactName: Form helper class for contact name section.
CRM_Contact_Form_Inline_CustomData: Form helper class for custom data section.
CRM_Contact_Form_Inline_Demographics: Form helper class for demographics section.
CRM_Contact_Form_Inline_Email: Form helper class for an Email object.
CRM_Contact_Form_Inline_IM: Form helper class for an IM object.
CRM_Contact_Form_Inline_Lock: Auxiliary class to provide support for locking (and ignoring locks on) contact records.
CRM_Contact_Form_Inline_OpenID: Form helper class for an OpenID object.
CRM_Contact_Form_Inline_Phone: Form helper class for an Phone object.
CRM_Contact_Form_Inline_Website: Form helper class for an Website object,
CRM_Contact_Form_Inline: Parent class for inline contact forms.
CRM_Contact_Form_Location
CRM_Contact_Form_Merge: Class CRM_Contact_Form_Merge.
CRM_Contact_Form_RelatedContact: This class generates form components generic to all the contact types.
CRM_Contact_Form_Relationship: This class generates form components for relationship.
CRM_Contact_Form_Search_Advanced: Advanced search, extends basic search.
CRM_Contact_Form_Search_Basic: Base Search / View form for *all* listing of multiple contacts.
CRM_Contact_Form_Search_Builder: This class is for search builder processing.
CRM_Contact_Form_Search_Criteria
CRM_Contact_Form_Search: Base Search / View form for *all* listing of multiple contacts
CRM_Contact_Form_Task_AddToGroup: This class provides the functionality to group contacts.
CRM_Contact_Form_Task_AddToHousehold: This class provides the functionality to add contact(s) to Household.
CRM_Contact_Form_Task_AddToIndividual: This class provides the functionality to add contact(s) to Individual.
CRM_Contact_Form_Task_AddToOrganization: This class provides the functionality to add contact(s) to Organization.
CRM_Contact_Form_Task_AddToParentClass: This class provides the shared functionality for addToHousehold and addToOrganization.
CRM_Contact_Form_Task_AddToTag: This class provides the functionality to delete a group of contacts.
CRM_Contact_Form_Task_AlterPreferences: This class provides the functionality to alter a privacy options for selected contacts
CRM_Contact_Form_Task_Batch: This class provides the functionality for batch profile update.
CRM_Contact_Form_Task_Delete: This class provides the functionality to delete a group of contacts.
CRM_Contact_Form_Task_Email: This class provides the functionality to email a group of contacts.
CRM_Contact_Form_Task_EmailCommon: This class provides the common functionality for sending email to one or a group of contact ids. This class is reused by all the search components in CiviCRM (since they all have send email as a task)
CRM_Contact_Form_Task_HookSample: This class provides the functionality to save a search.
CRM_Contact_Form_Task_Label: This class helps to print the labels for contacts.
CRM_Contact_Form_Task_LabelCommon: This class provides the common functionality for sending email to one or a group of contact ids.
CRM_Contact_Form_Task_Map_Event: This class provides the functionality to map the address for group of contacts.
CRM_Contact_Form_Task_Map: This class provides the functionality to map the address for group of contacts.
CRM_Contact_Form_Task_Merge: This class provides the functionality to Merge contacts.
CRM_Contact_Form_Task_PDF: This class provides the functionality to create PDF letter for a group of contacts or a single contact.
CRM_Contact_Form_Task_PDFLetterCommon: This class provides the common functionality for creating PDF letter for one or a group of contact ids.
CRM_Contact_Form_Task_PickProfile: This class provides the functionality for Update multiple contacts
CRM_Contact_Form_Task_Print: This class provides the functionality to save a search Saved Searches are used for saving frequently used queries
CRM_Contact_Form_Task_ProximityCommon: This class provides the functionality to support Proximity Searches.
CRM_Contact_Form_Task_RemoveFromGroup: This class provides the functionality to delete a group of contacts. This class provides functionality for the actual addition of contacts to groups.
CRM_Contact_Form_Task_RemoveFromTag: This class provides the functionality to remove tags of contact(s).
CRM_Contact_Form_Task_Result: Used for displaying results
CRM_Contact_Form_Task_SaveSearch_Update: This class provides the functionality to update a saved search.
CRM_Contact_Form_Task_SaveSearch: This class provides the functionality to save a search.
CRM_Contact_Form_Task_SMS: This class provides the functionality to sms a group of contacts.
CRM_Contact_Form_Task_SMSCommon: This class provides the common functionality for sending sms to one or a group of contact ids.
CRM_Contact_Form_Task_Unhold: Class CRM_Contact_Form_Task_Unhold
CRM_Contact_Form_Task_Useradd: This class generates form components generic to useradd.
CRM_Contact_Form_Task: This class generates form components for search-result tasks.
CRM_Contact_Import_Form_DataSource: This class delegates to the chosen DataSource to grab the data to be imported.
CRM_Contact_Import_Form_MapField: This class gets the name of the file to upload.
CRM_Contact_Import_Form_Preview: This class previews the uploaded file and returns summary statistics.
CRM_Contact_Import_Form_Summary: This class summarizes the import results.
CRM_Contact_Import_Page_AJAX: This class contains all the function that are called using AJAX.
CRM_Contact_Import_Parser_Contact: class to parse contact csv files
CRM_Contact_Page_AJAX: This class contains all contact related functions that are called using AJAX (jQuery)
CRM_Contact_Page_DashBoard: CiviCRM Dashboard.
CRM_Contact_Page_DedupeException: Main page for viewing contact.
CRM_Contact_Page_DedupeFind: A Page is basically data in a nice pretty format.
CRM_Contact_Page_DedupeMerge: A Page is basically data in a nice pretty format.
CRM_Contact_Page_DedupeRules: A Page is basically data in a nice pretty format.
CRM_Contact_Page_ImageFile: A Page is basically data in a nice pretty format.
CRM_Contact_Page_Inline_Actions: Dummy page for actions button.
CRM_Contact_Page_Inline_Address: Dummy page for details of address.
CRM_Contact_Page_Inline_CommunicationPreferences: Dummy page for details of communication preferences.
CRM_Contact_Page_Inline_ContactInfo: Page to display contact information on top of summary.
CRM_Contact_Page_Inline_ContactName: Page to display contact name on top of the summary.
CRM_Contact_Page_Inline_CustomData: This page displays custom data during inline edit.
CRM_Contact_Page_Inline_Demographics: Dummy page for details of demographics.
CRM_Contact_Page_Inline_Email: Dummy page for details of Email.
CRM_Contact_Page_Inline_IM: Dummy page for details for IM.
CRM_Contact_Page_Inline_OpenID: Dummy page for details for OpenID.
CRM_Contact_Page_Inline_Phone: Dummy page for details of Phone.
CRM_Contact_Page_Inline_Website: Dummy page for details of website.
CRM_Contact_Page_SavedSearch: Main page for viewing all Saved searches.
CRM_Contact_Page_Task: This is a dummy class that does nothing at the moment.
CRM_Contact_Page_View_ContactSmartGroup: A Page is basically data in a nice pretty format.
CRM_Contact_Page_View_CustomData: Page for displaying custom data.
CRM_Contact_Page_View_GroupContact: A Page is basically data in a nice pretty format.
CRM_Contact_Page_View_Log: A Page is basically data in a nice pretty format.
CRM_Contact_Page_View_Print: Main page for viewing contact.
CRM_Contact_Page_View_Relationship: A Page is basically data in a nice pretty format.
CRM_Contact_Page_View_Summary: Main page for viewing contact.
CRM_Contact_Page_View_Tag: A Page is basically data in a nice pretty format.
CRM_Contact_Page_View_Useradd: Dummy page for details of Email.
CRM_Contact_Page_View_UserDashBoard_GroupContact: This class is used to build User Dashboard
CRM_Contact_Page_View_UserDashBoard: This class is used to build User Dashboard
CRM_Contact_Page_View_Vcard: vCard export class.
CRM_Contact_Page_View: Main page for viewing contact.
CRM_Contact_Selector_Controller: This class is a generic class to be used when we want to display a list of rows along with a set of associated actions
CRM_Contact_Selector: Class is to retrieve and display a range of contacts that match the given criteria.
CRM_Contact_StateMachine_Search: Core StateMachine.
CRM_Contact_Task: Class to represent the actions that can be performed on a group of contacts used by the search forms.
CRM_Contact_Tokens: Class CRM_Contact_Tokens
CRM_Contribute_ActionMapping_ByPage: Class CRM_Contribute_ActionMapping_ByPage
CRM_Contribute_ActionMapping_ByType: Class CRM_Contribute_ActionMapping_ByType
CRM_Contribute_BAO_Contribution_Utils
CRM_Contribute_BAO_Contribution: Placeholder class retained for legacy compatibility.
CRM_Contribute_BAO_ContributionPage: This class contains Contribution Page related functions.
CRM_Contribute_BAO_ContributionRecur: Placeholder class retained for legacy compatibility.
CRM_Contribute_BAO_ContributionSoft: Placeholder class retained for legacy compatibility.
CRM_Contribute_BAO_Premium: Placeholder class retained for legacy compatibility.
CRM_Contribute_BAO_Product: Placeholder class retained for legacy compatibility.
CRM_Contribute_BAO_Query
CRM_Contribute_BAO_Widget: Class to retrieve information about a contribution page.
CRM_Contribute_Controller_Contribution: This class is used by the Search functionality.
CRM_Contribute_Controller_ContributionPage: This class is used by the Search functionality.
CRM_Contribute_Controller_Search: This class is used by the Search functionality.
CRM_Contribute_Controller_Task: Class CRM_Export_Controller_Standalone
CRM_Contribute_DAO_Contribution: Placeholder class retained for legacy compatibility.
CRM_Contribute_DAO_ContributionPage: Placeholder class retained for legacy compatibility.
CRM_Contribute_DAO_ContributionProduct: Placeholder class retained for legacy compatibility.
CRM_Contribute_DAO_ContributionRecur: Placeholder class retained for legacy compatibility.
CRM_Contribute_DAO_ContributionSoft: Placeholder class retained for legacy compatibility.
CRM_Contribute_DAO_Premium: Placeholder class retained for legacy compatibility.
CRM_Contribute_DAO_PremiumsProduct: Placeholder class retained for legacy compatibility.
CRM_Contribute_DAO_Product: Placeholder class retained for legacy compatibility.
CRM_Contribute_DAO_Widget: Placeholder class retained for legacy compatibility.
CRM_Contribute_Exception_CheckLineItemsException: Class CRM_Contribute_Exception_CheckLineItemsException
CRM_Contribute_Exception_FutureContributionPageException
CRM_Contribute_Exception_InactiveContributionPageException: Created by PhpStorm.
CRM_Contribute_Exception_PastContributionPageException
CRM_Contribute_Export_Form_Map: This class gets the name of the file to upload
CRM_Contribute_Export_Form_Select: This class gets the name of the file to upload
CRM_Contribute_Form_AbstractEditPayment: This class generates form components for processing a contribution CRM-16229 - During the event registration bulk action via search we need to inherit CRM_Contact_Form_Task so that we can inherit functions like getContactIds and make use of controller state. But this is not possible because CRM_Event_Form_Participant inherits this class.
CRM_Contribute_Form_AdditionalInfo
CRM_Contribute_Form_AdditionalPayment: This form records additional payments needed when event/contribution is partially paid.
CRM_Contribute_Form_CancelSubscription: This class provides support for canceling recurring subscriptions.
CRM_Contribute_Form_Contribution_Confirm: form to process actions on the group aspect of Custom Data
CRM_Contribute_Form_Contribution_Main: This class generates form components for processing a Contribution.
CRM_Contribute_Form_Contribution_ThankYou: Form for thank-you / success page - 3rd step of online contribution process.
CRM_Contribute_Form_Contribution: This class generates form components for processing a contribution.
CRM_Contribute_Form_ContributionBase: This class generates form components for processing a contribution.
CRM_Contribute_Form_ContributionCharts: Class CRM_Core_Form
CRM_Contribute_Form_ContributionPage_AddProduct: form to process actions fo adding product to contribution page
CRM_Contribute_Form_ContributionPage_Amount: form to process actions on the group aspect of Custom Data
CRM_Contribute_Form_ContributionPage_Custom: Form to process actions on the group aspect of Custom Data.
CRM_Contribute_Form_ContributionPage_Delete: This class is to build the form for Deleting Group.
CRM_Contribute_Form_ContributionPage_Premium: Form to process actions on Premiums.
CRM_Contribute_Form_ContributionPage_Settings: Contribution Page form.
CRM_Contribute_Form_ContributionPage_TabHeader: Helper class to build navigation links.
CRM_Contribute_Form_ContributionPage_ThankYou: Form to configure thank-you messages and receipting features for an online contribution page.
CRM_Contribute_Form_ContributionPage_Widget: Contribution Page form.
CRM_Contribute_Form_ContributionPage: Contribution Page form.
CRM_Contribute_Form_ContributionRecur: Shared parent class for recurring contribution forms.
CRM_Contribute_Form_ContributionView: This class generates form components for Payment-Instrument.
CRM_Contribute_Form_ManagePremiums: This class generates form components for Premiums.
CRM_Contribute_Form_Search: Advanced search, extends basic search.
CRM_Contribute_Form_SearchContribution: Class CRM_Core_Form
CRM_Contribute_Form_SoftCredit: This class build form elements for select existing or create new soft block.
CRM_Contribute_Form_Task_Batch: This class provides the functionality for batch profile update for contributions.
CRM_Contribute_Form_Task_Delete: This class provides the functionality to delete a group of contributions.
CRM_Contribute_Form_Task_Email: This class provides the functionality to email a group of contacts.
CRM_Contribute_Form_Task_Invoice: This class provides the functionality to email a group of contacts.
CRM_Contribute_Form_Task_PDF: This class provides the functionality to email a group of contacts.
CRM_Contribute_Form_Task_PDFLetter: This class provides the functionality to create PDF letter for a group of contacts or a single contact.
CRM_Contribute_Form_Task_PickProfile: This class provides the functionality for batch profile update for contributions.
CRM_Contribute_Form_Task_Print: This class provides the functionality to print contribution records.
CRM_Contribute_Form_Task_Result: Used for displaying results
CRM_Contribute_Form_Task_Status: This class provides the functionality to email a group of contacts.
CRM_Contribute_Form_Task: Class for contribute form task actions.
CRM_Contribute_Form_UpdateBilling: This class generates form components for processing a contribution.
CRM_Contribute_Form_UpdateSubscription: This class generates form components generic to recurring contributions.
CRM_Contribute_Form: This class generates form components generic to Contribution admin.
CRM_Contribute_Import_Form_DataSource: This class gets the name of the file to upload
CRM_Contribute_Import_Form_MapField: This class gets the name of the file to upload.
CRM_Contribute_Import_Form_Preview: This class previews the uploaded file and returns summary statistics.
CRM_Contribute_Import_Parser_Contribution: Class to parse contribution csv files.
CRM_Contribute_Info: This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.
CRM_Contribute_Page_AJAX: This class contains all the function that are called using AJAX (jQuery)
CRM_Contribute_Page_ContributionPage: Create a page for displaying Contribute Pages Contribute Pages are pages that are used to display contributions of different types. Pages consist of many customizable sections which can be accessed.
CRM_Contribute_Page_ContributionRecur: Main page for viewing Recurring Contributions.
CRM_Contribute_Page_ContributionRecurPayments: Shows list of contributions done as payments within a recurring contribution.
CRM_Contribute_Page_DashBoard: Page for displaying list of Payment-Instrument.
CRM_Contribute_Page_ManagePremiums: Page for displaying list of Premiums.
CRM_Contribute_Page_PaymentInfo: A Page is basically data in a nice pretty format.
CRM_Contribute_Page_Premium: Page for displaying list of Premiums.
CRM_Contribute_Page_SubscriptionStatus: A Page is basically data in a nice pretty format.
CRM_Contribute_Page_Tab: A Page is basically data in a nice pretty format.
CRM_Contribute_Page_UserDashboard: This class is used to build User Dashboard
CRM_Contribute_Page_Widget: A Page is basically data in a nice pretty format.
CRM_Contribute_RecurTokens: Class CRM_Contribute_RecurTokens
CRM_Contribute_Selector_Search: Class to render contribution search results.
CRM_Contribute_StateMachine_Contribution: State machine for managing different states of the Import process.
CRM_Contribute_StateMachine_ContributionPage: State machine for managing different states of the Import process.
CRM_Contribute_StateMachine_Search: Core StateMachine.
CRM_Contribute_Task: Class to represent the actions that can be performed on a group of contacts.
CRM_Contribute_Tokens: Class CRM_Contribute_Tokens
CRM_Contribute_WorkflowMessage_Contribution_BasicContribution: Basic contribution example for contribution templates.
CRM_Contribute_WorkflowMessage_ContributionInvoiceReceipt: Invoice generated when invoicing is enabled.
CRM_Contribute_WorkflowMessage_ContributionOfflineReceipt: Receipt sent when confirming a back office contribution.
CRM_Contribute_WorkflowMessage_ContributionOnlineReceipt: Receipt sent when confirming contribution add payment.
CRM_Contribute_WorkflowMessage_PaymentOrRefundNotification: Receipt sent when confirming contribution add payment.
CRM_Contribute_WorkflowMessage_RecurringCancelled: Generic base-class for describing the inputs for a workflow email template.
CRM_Contribute_WorkflowMessage_RecurringEdit_AlexCancelled: Helper class for defining WorkflowMessage example-data.
CRM_Contribute_WorkflowMessage_RecurringEdit_BarbPending: Helper class for defining WorkflowMessage example-data.
CRM_Contribute_WorkflowMessage_RecurringEdit: Generic base-class for describing the inputs for a workflow email template.
CRM_Core_Action: The core concept of the system is an action performed on an object. Typically this will be a "data model" object as specified in the API specs. We attempt to keep the number and type of actions consistent and similar across all objects (thus providing both reuse and standards)
CRM_Core_BAO_ActionLog: This class contains functions for managing Action Logs
CRM_Core_BAO_ActionSchedule: This class contains functions for managing Scheduled Reminders
CRM_Core_BAO_Address: This is class to handle address related functions.
CRM_Core_BAO_Block: Add static functions to include some common functionality used across location sub object BAO classes.
CRM_Core_BAO_Cache: BAO object for civicrm_cache table.
CRM_Core_BAO_CMSUser: Class CRM_Core_BAO_CMSUser
CRM_Core_BAO_ConfigSetting: File contains functions used in civicrm configuration.
CRM_Core_BAO_Country: This class contains functions for managing Action Logs
CRM_Core_BAO_County: This class contains functions for managing Counties.
CRM_Core_BAO_CustomField: Class CRM_Core_BAO_CustomField
CRM_Core_BAO_CustomGroup: Business object for managing custom data groups.
CRM_Core_BAO_CustomOption: Business objects for managing custom data options.
CRM_Core_BAO_CustomQuery
CRM_Core_BAO_CustomValue: Business objects for managing custom data values.
CRM_Core_BAO_CustomValueTable
CRM_Core_BAO_Dashboard: Class contains Contact dashboard related functions.
CRM_Core_BAO_Discount: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_Domain: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_Email: This class contains functions for email handling.
CRM_Core_BAO_EntityTag: This class contains functions for managing Tag(tag) for a contact
CRM_Core_BAO_Extension: This class contains functions for managing extensions
CRM_Core_BAO_File: BAO object for crm_log table
CRM_Core_BAO_FinancialTrxn: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_IM: This class contain function for IM handling
CRM_Core_BAO_Job: This class contains scheduled jobs related functions.
CRM_Core_BAO_LabelFormat: This class contains functions for managing Label Formats.
CRM_Core_BAO_Location: This class handle creation of location block elements.
CRM_Core_BAO_LocationType: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_Log: BAO object for crm_log table
CRM_Core_BAO_MailSettings: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_Managed: This class contains functions for managed entities.
CRM_Core_BAO_Mapping: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_MessageTemplate: Class CRM_Core_BAO_MessageTemplate.
CRM_Core_BAO_Navigation: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_Note: BAO object for crm_note table.
CRM_Core_BAO_OpenID: This class contains function for Open Id
CRM_Core_BAO_OptionGroup: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_OptionValue: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_PaperSize: This class contains functions for managing Paper Sizes.
CRM_Core_BAO_PdfFormat: This class contains functions for managing PDF Page Formats.
CRM_Core_BAO_Phone: Class contains functions for phone.
CRM_Core_BAO_PreferencesDate: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_PrevNextCache: BAO object for civicrm_prevnext_cache table.
CRM_Core_BAO_Query
CRM_Core_BAO_RecurringEntity: Class CRM_Core_BAO_RecurringEntity.
CRM_Core_BAO_SchemaHandler: This file contains functions for creating and altering CiviCRM-tables structure.
CRM_Core_BAO_Setting: BAO object for civicrm_setting table. This table is used to store civicrm settings that are not used very frequently (i.e. not on every page load)
CRM_Core_BAO_SiteToken: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_StatusPreference: This class contains functions for managing Status Preferences.
CRM_Core_BAO_Tag: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_TranslateGetWrapper: Wrapper to swap in translated text.
CRM_Core_BAO_Translation: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_UFField: This class contains function for UFField.
CRM_Core_BAO_UFGroup: UF group BAO class.
CRM_Core_BAO_UFJoin: Placeholder class retained for legacy compatibility.
CRM_Core_BAO_UFMatch: The basic class that interfaces with the external user framework.
CRM_Core_BAO_UserJob: This class contains user jobs functionality.
CRM_Core_BAO_Website: This class contain function for Website handling.
CRM_Core_BAO_WordReplacement: Class CRM_Core_BAO_WordReplacement.
CRM_Core_Block: Defines a simple implementation of a drupal block.
CRM_Core_ClassLoader
CRM_Core_CodeGen_BaseTask: Class CRM_Core_CodeGen_BaseTask
CRM_Core_CodeGen_BounceType
CRM_Core_CodeGen_Config: Generate configuration files
CRM_Core_CodeGen_DAO: Create DAO ORM classes.
CRM_Core_CodeGen_DedupeRule
CRM_Core_CodeGen_GenerateData
CRM_Core_CodeGen_I18n: Generate language files and classes
CRM_Core_CodeGen_Main: Class CRM_Core_CodeGen_Main
CRM_Core_CodeGen_Reflection: Create classes which are used for schema introspection.
CRM_Core_CodeGen_Schema: Create SQL files to create and populate a new schema.
CRM_Core_CodeGen_Specification: Read the schema specification and parse into internal data structures
CRM_Core_CodeGen_Test: Generate files used during testing.
CRM_Core_CodeGen_Util_ArraySyntaxConverter: Class CRM_Core_CodeGen_Util_ArraySyntaxConverter
CRM_Core_CodeGen_Util_File: Class CRM_Core_CodeGen_Util_File
CRM_Core_CodeGen_Util_MessageTemplates: Class CRM_Core_CodeGen_Util_MessageTemplate
CRM_Core_CodeGen_Util_Smarty: Class CRM_Core_CodeGen_Util_Smarty
CRM_Core_CodeGen_Util_Template: Class CRM_Core_CodeGen_Util_Template
CRM_Core_CodeGen_Util_Xml: Class CRM_Core_CodeGen_Util_Xml
CRM_Core_CommunityMessages: Manage the download, validation, and rendering of community messages
CRM_Core_Component_Info: This interface defines methods that need to be implemented for a component to introduce itself to the system.
CRM_Core_Component: Component stores all the static and dynamic information of the various CiviCRM components
CRM_Core_Config_MagicMerge: Class CRM_Core_Config_MagicMerge
CRM_Core_Config_Runtime: Class CRM_Core_Config_Runtime
CRM_Core_Config: Class CRM_Core_Config
CRM_Core_Controller_Simple: We use QFC for both single page and multi page wizards. We want to make creation of single page forms as easy and as seamless as possible. This class is used to optimize and make single form pages a relatively trivial process
CRM_Core_Controller_Task: Class CRM_Export_Controller_Standalone
CRM_Core_Controller: Class CRM_Core_Controller
CRM_Core_DAO_ActionLog: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_ActionSchedule: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Address: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_AddressFormat: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_AllCoreTables
CRM_Core_DAO_Base: Base for concrete DAO/BAO classes which are defined with a schema/entityType.php file.
CRM_Core_DAO_Cache: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Component: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Country: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_County: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_CustomField: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_CustomGroup: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Dashboard: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Discount: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Domain: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Email: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_EntityFile: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_EntityTag: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Extension: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Factory: Class CRM_Core_DAO_Factory
CRM_Core_DAO_File: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_IM: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Job: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_JobLog: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_LocationType: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_LocBlock: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Log: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_MailSettings: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Managed: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Mapping: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_MappingField: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Menu: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_MessageTemplate: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Navigation: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Note: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_OpenID: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_OptionGroup: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_OptionValue: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Phone: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_PreferencesDate: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_PrevNextCache: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_PrintLabel: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_RecurringEntity: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Setting: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_SiteToken: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_StateProvince: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_StatusPreference: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_SystemLog: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Tag: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Timezone: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Translation: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_UFField: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_UFGroup: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_UFJoin: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_UFMatch: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_UserJob: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Website: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_WordReplacement: Placeholder class retained for legacy compatibility.
CRM_Core_DAO_Worldregion: Placeholder class retained for legacy compatibility.
CRM_Core_DAO: Class CRM_Core_DAO
CRM_Core_DomainTokens: Class CRM_Case_Tokens
CRM_Core_EntityTokens: Class CRM_Core_EntityTokens
CRM_Core_Error_Log: Class CRM_Core_Error_Log
CRM_Core_Error: Class CRM_Core_Error
CRM_Core_Exception_PrematureExitException: Exception thrown during tests where live code would exit.
CRM_Core_Exception_ResourceConflictException: Exception thrown when contention over a resource causes process to abort.
CRM_Core_Exception: Base class for exceptions generated by CiviCRM.
CRM_Core_Form_Date
CRM_Core_Form_RecurringEntity: This class generates form components for processing Entity.
CRM_Core_Form_Renderer: Customize QF output to meet our specific requirements
CRM_Core_Form_Search: Base class for most search forms
CRM_Core_Form_ShortCode: Builds a form of shortcodes that can be added to WP posts.
CRM_Core_Form_Tag: This class generates form element for free tag widget.
CRM_Core_Form_Task_Batch: This class provides the functionality for batch profile update
CRM_Core_Form_Task_PDFLetterCommon: This is the base class for common PDF/Doc Merge functionality.
CRM_Core_Form_Task_PickProfile: This class provides the functionality for batch profile update for case
CRM_Core_Form_Task: This is a shared parent class for form task actions.
CRM_Core_Form: Class CRM_Core_Form
CRM_Core_GroupTokens: Class CRM_Core_GroupTokens
CRM_Core_HTMLInputCoder: Class CRM_Core_HTMLInputCoder
CRM_Core_I18n_Form: Class CRM_Core_Form
CRM_Core_I18n_NativeGettext
CRM_Core_I18n_PseudoConstant
CRM_Core_I18n_Schema
CRM_Core_I18n_SchemaStructure
CRM_Core_I18n_SchemaStructure_4_7_31
CRM_Core_I18n_SchemaStructure_5_13_alpha1
CRM_Core_I18n_SchemaStructure_5_20_alpha1
CRM_Core_I18n_SchemaStructure_5_31_alpha1
CRM_Core_I18n_SchemaStructure_5_4_alpha1
CRM_Core_I18n_SchemaStructure_5_61_alpha1
CRM_Core_I18n
CRM_Core_IDS
CRM_Core_Invoke: Given an argument list, invoke the appropriate CRM function Serves as a wrapper between the UserFrameWork and Core CRM
CRM_Core_JobManager: This interface defines methods that need to be implemented by every scheduled job (cron task) in CiviCRM.
CRM_Core_Joomla: Joomla class.
CRM_Core_Key
CRM_Core_LegacyErrorHandler: Class CRM_Core_LegacyErrorHandler
CRM_Core_Lock
CRM_Core_ManagedEntities: The ManagedEntities system allows modules to add records to the database declaratively. Those records will be automatically inserted, updated, deactivated, and deleted in tandem with their modules.
CRM_Core_Menu: Class CRM_Core_Menu.
CRM_Core_Module: A module is any software package that participates in the hook system, such as CiviCRM Module-Extension, a Drupal Module, or a Joomla Plugin.
CRM_Core_OptionGroup
CRM_Core_OptionValue
CRM_Core_Page_AJAX_Attachment: CRM_Core_Page_AJAX_Attachment defines an end-point for AJAX operations which upload file-attachments.
CRM_Core_Page_AJAX_Location: This class contains all the function that are called using AJAX
CRM_Core_Page_AJAX_RecurringEntity: Description of EntityApplyChangesTo
CRM_Core_Page_AJAX: This is base class for all ajax calls
CRM_Core_Page_Basic: A Page is basically data in a nice pretty format.
CRM_Core_Page_FakeError: The "civicrm/dev/fake-error" page is a mock to facilitate E2E testing of the error-reporting mechanism.
CRM_Core_Page_File: A Page is basically data in a nice pretty format.
CRM_Core_Page_Inline_Help: This loads a smarty help file via ajax and returns as html
CRM_Core_Page_QUnit: Accept requests for "civicrm/dev/qunit/$ext/$suite"; locate the qunit test-suite ($suite) in an extension ($ext) and render it.
CRM_Core_Page_RecurringEntityPreview: A Page is basically data in a nice pretty format.
CRM_Core_Page_Redirect: Placeholder page which generates a redirect
CRM_Core_Page_RemoteTestFunction: Handle requests for civicrm/dev/rtf
CRM_Core_Page: A Page is basically data in a nice pretty format.
CRM_Core_Payment_AuthorizeNet: NOTE: When looking up response codes in the Authorize.Net API, they begin at one, so always delete one from the "Position in Response"
CRM_Core_Payment_AuthorizeNetIPN: Class CRM_Core_Payment_BaseIPN.
CRM_Core_Payment_BaseIPN: Class CRM_Core_Payment_BaseIPN.
CRM_Core_Payment_Dummy: Dummy payment processor
CRM_Core_Payment_FirstData: From Payment processor documentation For testing purposes, you can use any of the card numbers listed below. The test card numbers will not result in any charges to the card. Use these card numbers with any expiration date in the future.
CRM_Core_Payment_Form: Class for constructing the payment processor block.
CRM_Core_Payment_Manual: Class CRM_Core_Payment.
CRM_Core_Payment_PayJunction: Class CRM_Core_Payment_PayJunction.
CRM_Core_Payment_PayPalImpl: Class CRM_Core_Payment_PayPalImpl for paypal pro, paypal standard & paypal express.
CRM_Core_Payment_PayPalIPN: Class CRM_Core_Payment_BaseIPN.
CRM_Core_Payment_PayPalProIPN: Class CRM_Core_Payment_BaseIPN.
CRM_Core_Payment_ProcessorForm: Base class for building payment block for online contribution / event pages.
CRM_Core_Payment_Realex: Class CRM_Core_Payment.
CRM_Core_Payment: Class CRM_Core_Payment.
CRM_Core_Permission_Backdrop
CRM_Core_Permission_Base
CRM_Core_Permission_Drupal
CRM_Core_Permission_Drupal8
CRM_Core_Permission_DrupalBase
CRM_Core_Permission_Joomla
CRM_Core_Permission_List: Class CRM_Core_Permission_List
CRM_Core_Permission_Soap
CRM_Core_Permission_Standalone: Permissions class for Standalone.
CRM_Core_Permission_Temp: This supplements the permissions of the CMS system, allowing us to temporarily acknowledge permission grants for API keys.
CRM_Core_Permission_UnitTests
CRM_Core_Permission_WordPress
CRM_Core_Permission: This is the basic permission class wrapper
CRM_Core_PrevNextCache_Redis: Class CRM_Core_PrevNextCache_Memory
CRM_Core_PrevNextCache_Sql: Class CRM_Core_PrevNextCache_Sql
CRM_Core_PseudoConstant: Stores all constants and pseudo constants for CRM application.
CRM_Core_QuickForm_Action_Back: Redefine the back action.
CRM_Core_QuickForm_Action_Cancel: Redefine the cancel action
CRM_Core_QuickForm_Action_Display: Redefine the display action.
CRM_Core_QuickForm_Action_Done: Redefine the back action.
CRM_Core_QuickForm_Action_Jump: Redefine the jump action.
CRM_Core_QuickForm_Action_Next: Redefine the next action.
CRM_Core_QuickForm_Action_Process: Redefine the process action.
CRM_Core_QuickForm_Action_Refresh: Redefine the refresh action.
CRM_Core_QuickForm_Action_Reload: Define the reload action. Reload the page but do not do any validation.
CRM_Core_QuickForm_Action_Submit: Redefine the submit action.
CRM_Core_QuickForm_Action_Upload: Redefine the upload action.
CRM_Core_QuickForm_Action: Class CRM_Core_QuickForm_Action
CRM_Core_QuickForm_GroupMultiSelect: Class CRM_Core_QuickForm_NestedAdvMultiSelect
CRM_Core_QuickForm_NestedAdvMultiSelect: Class CRM_Core_QuickForm_NestedAdvMultiSelect
CRM_Core_Reference_Basic: Description of a one-way link between two entities
CRM_Core_Reference_Dynamic: Description of a one-way link between two entities
CRM_Core_Reference_OptionValue: Description of a one-way link between an option-value and an entity
CRM_Core_Region: Maintain a set of markup/templates to inject inside various regions
CRM_Core_Report_Excel: Class CRM_Core_Report_Excel
CRM_Core_Resources_Bundle: Class CRM_Core_Resources_Bundle
CRM_Core_Resources_Common: Define some common, global lists of resources.
CRM_Core_Resources_Strings: Manage translatable strings on behalf of resource files.
CRM_Core_Resources: This class facilitates the loading of resources such as JavaScript files and CSS files.
CRM_Core_ScheduledJob: This interface defines methods that need to be implemented by every scheduled job (cron task) in CiviCRM.
CRM_Core_Selector_Base: A simple base class for objects that need to implement the selector api interface. This class provides common functionality with regard to actions and display names
CRM_Core_Selector_Controller: This class is a generic class to be used when we want to display a list of rows along with a set of associated actions
CRM_Core_SelectValues: One place to store frequently used values in Select Elements. Note that some of the below elements will be dynamic, so we'll probably have a smart caching scheme on a per domain basis
CRM_Core_Session: Class CRM_Core_Session.
CRM_Core_ShowHideBlocks
CRM_Core_SiteTokens: Class CRM_Site_Tokens
CRM_Core_Smarty_Permissions: Class CRM_Core_Smarty_Permissions
CRM_Core_Smarty_UserContentPolicy: Define the security-constraints to apply to user-supplied Smarty content.
CRM_Core_Smarty
CRM_Core_SmartyCompatibility
CRM_Core_State: The basic state element. Each state element is linked to a form and represents the form in the transition diagram. We use the state to determine what action to take on various user input. Actions include things like going back / stepping forward / process etc
CRM_Core_StateMachine: Core StateMachine.
CRM_Core_TableHierarchy: Class representing the table relationships
CRM_Core_Task: Class to represent the actions that can be performed on a group of contacts used by the search forms.
CRM_Core_TemporaryErrorScope: This is an evil, evil work-around for CRM-11043. It is used to temporarily change the error-handling behavior and then automatically restore it -- that protocol is an improvement over the current protocol (in which random bits of code will change the global error handler setting and then forget to change it back). This class and all references to it should be removed in 4.3/4.4 (when we adopt exception-based error handling).
CRM_Core_TestEntity: Class CRM_Core_TestEntity.
CRM_Core_TokenSmarty: `Token-Smarty` is a hybrid template format, combining Civi token notation with Smarty notation, as in `{if {contact.id} > 10}...{/if}`.
CRM_Core_Transaction
CRM_Core_WorkflowMessage_Profile_Profile: Basic profile example.
CRM_Core_WorkflowMessage_UFNotify: Receipt sent when someone receives a copy of profile that has been filled out.
CRM_Custom_Form_CustomData: Deprecated class no longer used in core.
CRM_Custom_Form_CustomDataByType: This form is loaded when custom data is loaded by ajax.
CRM_Custom_Form_DeleteField: This class is to build the form for deleting a field
CRM_Custom_Form_DeleteGroup: This class is to build the form for Deleting Group
CRM_Custom_Form_Field: form to process actions on the field aspect of Custom
CRM_Custom_Form_Group: form to process actions on the set aspect of Custom Data
CRM_Custom_Form_MoveField: This class is to build the form for Deleting Group
CRM_Custom_Form_Option: form to process actions on the field aspect of Custom
CRM_Custom_Form_Preview: This class generates form components for previewing custom data
CRM_Custom_Import_Form_DataSource: This class gets the name of the file to upload
CRM_Custom_Import_Form_MapField: Class CRM_Custom_Import_Form_MapField
CRM_Custom_Import_Form_Preview: Class CRM_Custom_Import_Form_Preview
CRM_Custom_Import_Parser_Api: Class CRM_Custom_Import_Parser_Api
CRM_Custom_Page_AJAX: This class contains the functions that are called using AJAX (jQuery)
CRM_Custom_Page_Field: Create a page for displaying Custom Fields.
CRM_Custom_Page_Group: Create a page for displaying Custom Sets.
CRM_Custom_Page_Option: Create a page for displaying Custom Options.
CRM_Cxn_ApiRouter: Class CRM_Cxn_ApiRouter
CRM_Cxn_BAO_Cxn: This class helps to manage connections to third-party apps.
CRM_Cxn_CiviCxnHttp: Class CRM_Cxn_CiviCxnHttp
CRM_Cxn_CiviCxnStore: Class CRM_Cxn_CiviCxnStore
CRM_Cxn_DAO_Cxn: Placeholder class retained for legacy compatibility.
CRM_Dashlet_Page_Activity: Main page for activity dashlet
CRM_Dashlet_Page_AllCases: Main page for Cases dashlet
CRM_Dashlet_Page_Blog: Main page for blog dashlet
CRM_Dashlet_Page_CaseDashboard: Main page for Case Dashboard dashlet
CRM_Dashlet_Page_GettingStarted: Main page for getting started dashlet
CRM_Dashlet_Page_MyCases: Main page for Cases dashlet
CRM_Dedupe_BAO_DedupeException: Manages dedupe exceptions - ie pairs marked as non-duplicates.
CRM_Dedupe_BAO_DedupeRule: The CiviCRM duplicate discovery engine is based on an algorithm designed by David Strauss <david@fourkitchens.com>.
CRM_Dedupe_BAO_DedupeRuleGroup: The CiviCRM duplicate discovery engine is based on an algorithm designed by David Strauss <david@fourkitchens.com>.
CRM_Dedupe_BAO_Exception: Manages dedupe exceptions - ie pairs marked as non-duplicates.
CRM_Dedupe_BAO_QueryBuilder_IndividualGeneral: TODO: How to handle NULL values/records? Class CRM_Dedupe_BAO_QueryBuilder_IndividualGeneral
CRM_Dedupe_BAO_QueryBuilder_IndividualSupervised: TODO: How to handle NULL values/records? Class CRM_Dedupe_BAO_QueryBuilder_IndividualSupervised
CRM_Dedupe_BAO_QueryBuilder_IndividualUnsupervised: Class CRM_Dedupe_BAO_QueryBuilder_IndividualUnsupervised
CRM_Dedupe_BAO_QueryBuilder: Class CRM_Dedupe_BAO_QueryBuilder
CRM_Dedupe_BAO_Rule: The CiviCRM duplicate discovery engine is based on an algorithm designed by David Strauss <david@fourkitchens.com>.
CRM_Dedupe_BAO_RuleGroup: The CiviCRM duplicate discovery engine is based on an algorithm designed by David Strauss <david@fourkitchens.com>.
CRM_Dedupe_DAO_DedupeException: Placeholder class retained for legacy compatibility.
CRM_Dedupe_DAO_DedupeRule: Placeholder class retained for legacy compatibility.
CRM_Dedupe_DAO_DedupeRuleGroup: Placeholder class retained for legacy compatibility.
CRM_Dedupe_Finder: The CiviCRM duplicate discovery engine is based on an algorithm designed by David Strauss <david@fourkitchens.com>.
CRM_Dedupe_MergeHandler: This class exists primarily for the purposes of supporting code clean up in the Merger class.
CRM_Dedupe_Merger
CRM_Event_ActionMapping_ByEvent: This defines the scheduled-reminder functionality for CiviEvent participants with filtering by event-type.
CRM_Event_ActionMapping_ByTemplate: This defines the scheduled-reminder functionality for CiviEvent participants with filtering by event-type.
CRM_Event_ActionMapping_ByType: This defines the scheduled-reminder functionality for CiviEvent participants with filtering by event-type.
CRM_Event_ActionMapping: Shared scheduled-reminder functionality for CiviEvent participants.
CRM_Event_Badge_Logo: Class CRM_Event_Badge_Logo
CRM_Event_Badge_Logo5395: Class CRM_Event_Badge_Logo5395
CRM_Event_Badge_NameTent: This class print the name badges for the participants It isn't supposed to be called directly, but is the parent class of the classes in CRM/Event/Badges/XXX.php
CRM_Event_Badge_Simple: This class print the name badges for the participants It isn't supposed to be called directly, but is the parent class of the classes in CRM/Event/Badges/XXX.php
CRM_Event_Badge: This class print the name badges for the participants It isn't supposed to be called directly, but is the parent class of the classes in CRM/Event/Badges/XXX.php
CRM_Event_BAO_Event: Placeholder class retained for legacy compatibility.
CRM_Event_BAO_Participant: Placeholder class retained for legacy compatibility.
CRM_Event_BAO_ParticipantPayment: Placeholder class retained for legacy compatibility.
CRM_Event_BAO_ParticipantStatusType: Placeholder class retained for legacy compatibility.
CRM_Event_BAO_Query
CRM_Event_Controller_Registration: Class CRM_Event_Controller_Registration
CRM_Event_Controller_Search: This class is used by the Search functionality.
CRM_Event_DAO_Event: Placeholder class retained for legacy compatibility.
CRM_Event_DAO_Participant: Placeholder class retained for legacy compatibility.
CRM_Event_DAO_ParticipantPayment: Placeholder class retained for legacy compatibility.
CRM_Event_DAO_ParticipantStatusType: Placeholder class retained for legacy compatibility.
CRM_Event_Export_Form_Map: This class gets the name of the file to upload
CRM_Event_Export_Form_Select: This class gets the name of the file to upload
CRM_Event_Form_EventFees: This class generates form components for processing a participation fee block
CRM_Event_Form_ManageEvent_Delete: This class is to build the form for Deleting Group.
CRM_Event_Form_ManageEvent_EventInfo: This class generates form components for processing Event.
CRM_Event_Form_ManageEvent_Fee: This class generates form components for Event Fees.
CRM_Event_Form_ManageEvent_Location: This class generates form components for processing Event Location civicrm_event_page.
CRM_Event_Form_ManageEvent_Registration: This class generates form components for processing Event.
CRM_Event_Form_ManageEvent_Repeat: Class to manage the "Repeat" functionality for event
CRM_Event_Form_ManageEvent_ScheduleReminders: This class generates form components for scheduling reminders for Event
CRM_Event_Form_ManageEvent_TabHeader: Helper class to build navigation links
CRM_Event_Form_ManageEvent: This class generates form components for processing Event.
CRM_Event_Form_Participant_Delete: Back office participant delete form.
CRM_Event_Form_Participant: Back office participant form.
CRM_Event_Form_ParticipantFeeSelection: This form used for changing / updating fee selections for the events event/contribution is partially paid
CRM_Event_Form_ParticipantView: This class generates form components for Participant
CRM_Event_Form_Registration_AdditionalParticipant: This class generates form components for processing Event.
CRM_Event_Form_Registration_Confirm: This class generates form components for processing Event.
CRM_Event_Form_Registration_ParticipantConfirm: This class generates form components for processing Event
CRM_Event_Form_Registration_Register: This class generates form components for processing Event.
CRM_Event_Form_Registration_ThankYou: This class generates form components for processing Event
CRM_Event_Form_Registration: This class generates form components for processing Event.
CRM_Event_Form_Search: This file is for civievent search
CRM_Event_Form_SearchEvent: Class CRM_Core_Form
CRM_Event_Form_SelfSvcTransfer: This class generates form components to transfer an Event to another participant
CRM_Event_Form_SelfSvcUpdate: This class generates form components to allow an Event to be cancelled or transferred from an email link
CRM_Event_Form_Task_AddToGroup: This class provides the functionality to group contacts. This class provides functionality for the actual addition of contacts to groups.
CRM_Event_Form_Task_Badge: This class helps to print the labels for contacts.
CRM_Event_Form_Task_Batch: This class provides the functionality for batch profile update for events.
CRM_Event_Form_Task_Cancel: This class provides the functionality for cancel registration for event participations
CRM_Event_Form_Task_Delete: This class provides the functionality to delete a group of participations. This class provides functionality for the actual deletion.
CRM_Event_Form_Task_Email: This class provides the functionality to email a group of contacts.
CRM_Event_Form_Task_ParticipantStatus: This class provides the functionality for batch profile update for events.
CRM_Event_Form_Task_PDF: This class provides the functionality to create PDF letter for a group of participants or a single participant.
CRM_Event_Form_Task_PickProfile: This class provides the functionality for batch profile update for event participations
CRM_Event_Form_Task_Print: This class provides the functionality to participant records
CRM_Event_Form_Task_Register: This class provides the register functionality from a search context.
CRM_Event_Form_Task_Result: Used for displaying results
CRM_Event_Form_Task_SaveSearch_Update: This class provides the functionality to update a saved search
CRM_Event_Form_Task_SaveSearch: This class provides the functionality to save a search Saved Searches are used for saving frequently used queries regarding the event participations
CRM_Event_Form_Task: Class for event form task actions.
CRM_Event_ICalendar: Class to generate various "icalendar" type event feeds
CRM_Event_Import_Form_DataSource: This class gets the name of the file to upload
CRM_Event_Import_Form_MapField: This class gets the name of the file to upload
CRM_Event_Import_Form_Preview: This class previews the uploaded file and returns summary statistics
CRM_Event_Import_Parser_Participant: class to parse membership csv files
CRM_Event_Info: This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.
CRM_Event_Page_AJAX: This class contains all the function that are called using AJAX
CRM_Event_Page_DashBoard: This is page is for Event Dashboard
CRM_Event_Page_EventInfo: Event Info Page - Summary about the event
CRM_Event_Page_List: Display a list of events on a page
CRM_Event_Page_ManageEvent: Page for displaying list of events
CRM_Event_Page_ParticipantListing_Name: A Page is basically data in a nice pretty format.
CRM_Event_Page_ParticipantListing_NameAndEmail: A Page is basically data in a nice pretty format.
CRM_Event_Page_ParticipantListing_NameStatusAndDate: A Page is basically data in a nice pretty format.
CRM_Event_Page_ParticipantListing_Simple: A Page is basically data in a nice pretty format.
CRM_Event_Page_ParticipantListing: A Page is basically data in a nice pretty format.
CRM_Event_Page_Tab: A Page is basically data in a nice pretty format.
CRM_Event_Page_UserDashboard: This class is for building event(participation) block on user dashboard
CRM_Event_ParticipantTokens: Class CRM_Event_ParticipantTokens
CRM_Event_PseudoConstant: Stores all constants and pseudo constants for CRM application.
CRM_Event_Selector_Search: This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.
CRM_Event_StateMachine_Registration: State machine for managing different states of the EventWizard process.
CRM_Event_StateMachine_Search: Class CRM_Event_StateMachine_Search
CRM_Event_Task: class to represent the actions that can be performed on a group of contacts used by the search forms
CRM_Event_Tokens: Class CRM_Event_Tokens
CRM_Event_WorkflowMessage_EventExamples: Basic contribution example for contribution templates.
CRM_Event_WorkflowMessage_EventOfflineReceipt: Receipt sent when confirming a back office participation record.
CRM_Event_WorkflowMessage_EventOnlineReceipt: Receipt sent when confirming a back office participation record.
CRM_Event_WorkflowMessage_ParticipantCancelled: Notification that a registration has been cancelled.
CRM_Event_WorkflowMessage_ParticipantConfirm: Notification that a registration has been cancelled.
CRM_Event_WorkflowMessage_ParticipantExpired: Notification that a registration has been cancelled.
CRM_Event_WorkflowMessage_ParticipantTransferred: Notification that a registration has been transferred to a different person.
CRM_Export_BAO_Export: This class contains the functions for Component export
CRM_Export_BAO_ExportProcessor: Class CRM_Export_BAO_ExportProcessor
CRM_Export_Controller_Standalone: Class CRM_Export_Controller_Standalone
CRM_Export_Form_Map: This class gets the name of the file to upload
CRM_Export_Form_Select: This class gets the name of the file to upload
CRM_Export_StateMachine_Standalone: Core StateMachine.
CRM_Export_Utils
CRM_Extension_BootCache
CRM_Extension_Browser: This class glues together the various parts of the extension system.
CRM_Extension_ClassLoader: Class CRM_Extension_ClassLoader
CRM_Extension_Container_Basic: An extension container is a locally-accessible source tree which can be scanned for extensions.
CRM_Extension_Container_Collection: An extension container is a locally-accessible source tree which can be scanned for extensions.
CRM_Extension_Container_Default: The default container is just a basic container which can be configured via the web UI.
CRM_Extension_Container_Static: An extension container is a locally-accessible source tree which can be scanned for extensions.
CRM_Extension_Downloader: This class handles downloads of remotely-provided extensions
CRM_Extension_Exception_DependencyException: An extension management operation failed because it would break a dependency.
CRM_Extension_Exception_MissingException: An extension could not be located
CRM_Extension_Exception_ParseException: Error reading XML for an extension
CRM_Extension_Exception: Class CRM_Extension_Exception
CRM_Extension_Info: Metadata for an extension (e.g. the extension's "info.xml" file)
CRM_Extension_Manager_Base: The extension manager handles installing, disabling enabling, and uninstalling extensions.
CRM_Extension_Manager_Module: This class stores logic for managing CiviCRM extensions.
CRM_Extension_Manager_Payment: This class stores logic for managing CiviCRM extensions.
CRM_Extension_Manager_Report: This class stores logic for managing CiviCRM extensions.
CRM_Extension_Manager_Search: This class stores logic for managing CiviCRM extensions.
CRM_Extension_Manager: The extension manager handles installing, disabling enabling, and uninstalling extensions.
CRM_Extension_Mapper: This class proivdes various helper functions for locating extensions data. It's designed for compatibility with pre-existing functions from CRM_Core_Extensions.
CRM_Extension_MixInfo: "Mixins" allow extensions to be initialized with small, reusable chunks of code.
CRM_Extension_MixinLoader: The MixinLoader gets a list of extensions and mixins - then loads them.
CRM_Extension_MixinScanner: The MixinScanner scans the list of actives extensions and their required mixins.
CRM_Extension_System: This class glues together the various parts of the extension system.
CRM_Extension_Upgrader_Base: Base class which provides helpers to execute upgrade logic.
CRM_Extension_Upgrader_Component: Upgrader base class ONLY for core component extensions (e.g. `civi_mail`, `civi_event`).
CRM_Extension_Upgrades: This class stores logic for managing schema upgrades in CiviCRM extensions.
CRM_Financial_BAO_EntityFinancialAccount: Placeholder class retained for legacy compatibility.
CRM_Financial_BAO_EntityFinancialTrxn: Placeholder class retained for legacy compatibility.
CRM_Financial_BAO_ExportFormat_CSV: Base class for Export Formats Create a subclass for a specific format.
CRM_Financial_BAO_ExportFormat_IIF: Base class for Export Formats Create a subclass for a specific format.
CRM_Financial_BAO_ExportFormat: Base class for Export Formats Create a subclass for a specific format.
CRM_Financial_BAO_FinancialAccount: Placeholder class retained for legacy compatibility.
CRM_Financial_BAO_FinancialItem: Placeholder class retained for legacy compatibility.
CRM_Financial_BAO_FinancialTrxn: Placeholder class retained for legacy compatibility.
CRM_Financial_BAO_FinancialType: Placeholder class retained for legacy compatibility.
CRM_Financial_BAO_Payment: This class contains payment related functions.
CRM_Financial_BAO_PaymentProcessor: This class contains payment processor related functions.
CRM_Financial_BAO_PaymentProcessorType: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_Currency: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_EntityFinancialAccount: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_EntityFinancialTrxn: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_FinancialAccount: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_FinancialItem: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_FinancialTrxn: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_FinancialType: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_PaymentProcessor: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_PaymentProcessorType: Placeholder class retained for legacy compatibility.
CRM_Financial_DAO_PaymentToken: Placeholder class retained for legacy compatibility.
CRM_Financial_FinancialTrxnTokens: Class CRM_Event_Tokens
CRM_Financial_Form_BatchTransaction: This class generates form components for Financial Type
CRM_Financial_Form_Export: This class provides the functionality to delete a group of contributions. This class provides functionality for the actual deletion.
CRM_Financial_Form_FinancialAccount: This class generates form components for Financial Account
CRM_Financial_Form_FinancialBatch: This class generates form components for Accounting Batch
CRM_Financial_Form_FinancialType: This class generates form components for Financial Type
CRM_Financial_Form_FinancialTypeAccount: This class generates form components for Financial Type Account
CRM_Financial_Form_Payment: Class CRM_Core_Form
CRM_Financial_Form_PaymentEdit: Class CRM_Core_Form
CRM_Financial_Form_Search: Class CRM_Core_Form
CRM_Financial_Page_AJAX: This class contains all the function that are called using AJAX
CRM_Financial_Page_Batch: Page for displaying list of current batches
CRM_Financial_Page_BatchTransaction: Page for displaying list of financial batches
CRM_Financial_Page_FinancialAccount: Page for displaying list of financial accounts
CRM_Financial_Page_FinancialBatch: Page for displaying list of financial batches
CRM_Financial_Page_FinancialType: Page for displaying list of financial types
CRM_Financial_Page_FinancialTypeAccount: Page for displaying list of financial type accounts
CRM_Friend_DAO_Friend: Placeholder class retained for legacy compatibility.
CRM_Group_Controller: Class CRM_Core_Controller
CRM_Group_Form_Edit: This class is to build the form for adding Group.
CRM_Group_Form_Search: Class CRM_Core_Form
CRM_Group_Page_AJAX: This class contains the functions that are called using AJAX (jQuery)
CRM_Group_Page_Group: A Page is basically data in a nice pretty format.
CRM_Group_StateMachine: Core StateMachine.
CRM_Import_Controller: Class CRM_Core_Controller
CRM_Import_DataSource_CSV: This class defines the DataSource interface but must be subclassed to be useful.
CRM_Import_DataSource_SQL: This class defines the DataSource interface but must be subclassed to be useful.
CRM_Import_DataSource: This class defines the DataSource interface but must be subclassed to be useful.
CRM_Import_Exception_ImportTableUnavailable: Base class for exceptions generated by CiviCRM.
CRM_Import_Form_DataSource: Base class for upload-only import forms (all but Contact import).
CRM_Import_Form_DataSourceConfig: This class allows datasource specific fields to be added to the datasource form.
CRM_Import_Form_MapField: This class gets the name of the file to upload.
CRM_Import_Form_Preview: This class previews the uploaded file and returns summary statistics.
CRM_Import_Forms: This class helps the forms within the import flow access submitted & parsed values.
CRM_Import_ImportProcessor: Class CRM_Import_ImportProcessor.
CRM_Invoicing_Utils
CRM_Logging_Differ
CRM_Logging_ReportDetail: Class CRM_Report_Form
CRM_Logging_ReportSummary: Class CRM_Logging_ReportSummary
CRM_Logging_Reverter
CRM_Logging_Schema
CRM_Mailing_ActionTokens: Class CRM_Mailing_ActionTokens
CRM_Mailing_BAO_BouncePattern: Placeholder class retained for legacy compatibility.
CRM_Mailing_BAO_Component: Placeholder class retained for legacy compatibility.
CRM_Mailing_BAO_Mailing: Class CRM_Mailing_BAO_Mailing
CRM_Mailing_BAO_MailingAB: Class CRM_Mailing_BAO_MailingAB
CRM_Mailing_BAO_MailingComponent: Placeholder class retained for legacy compatibility.
CRM_Mailing_BAO_MailingJob: Class CRM_Mailing_BAO_MailingJob
CRM_Mailing_BAO_MailingRecipients: Placeholder class retained for legacy compatibility.
CRM_Mailing_BAO_MailingTrackableURL: Placeholder class retained for legacy compatibility.
CRM_Mailing_BAO_Query
CRM_Mailing_BAO_SMSJob: Job for SMS deliery functions.
CRM_Mailing_BAO_Spool: Placeholder class retained for legacy compatibility.
CRM_Mailing_Config
CRM_Mailing_Controller_Send: Class CRM_Core_Controller
CRM_Mailing_DAO_BouncePattern: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_BounceType: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_Mailing: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_MailingAB: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_MailingComponent: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_MailingGroup: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_MailingJob: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_MailingRecipients: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_MailingTrackableURL: Placeholder class retained for legacy compatibility.
CRM_Mailing_DAO_Spool: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_BAO_MailingEventBounce: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_BAO_MailingEventConfirm: Class CRM_Mailing_Event_BAO_Confirm
CRM_Mailing_Event_BAO_MailingEventDelivered: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_BAO_MailingEventForward: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_BAO_MailingEventOpened: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_BAO_MailingEventQueue: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_BAO_MailingEventReply: Class CRM_Mailing_Event_BAO_Reply
CRM_Mailing_Event_BAO_MailingEventResubscribe: Class CRM_Mailing_Event_BAO_MailingEventResubscribe
CRM_Mailing_Event_BAO_MailingEventSubscribe: Class CRM_Mailing_Event_BAO_Subscribe
CRM_Mailing_Event_BAO_MailingEventTrackableURLOpen: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_BAO_MailingEventUnsubscribe: Class CRM_Mailing_Event_BAO_Unsubscribe
CRM_Mailing_Event_DAO_MailingEventBounce: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventConfirm: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventDelivered: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventForward: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventOpened: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventQueue: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventReply: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventSubscribe: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventTrackableURLOpen: Placeholder class retained for legacy compatibility.
CRM_Mailing_Event_DAO_MailingEventUnsubscribe: Placeholder class retained for legacy compatibility.
CRM_Mailing_Form_Approve: Class CRM_Core_Form
CRM_Mailing_Form_Browse: Build the form object for disable mail feature
CRM_Mailing_Form_Component: This class generates form components for Location Type.
CRM_Mailing_Form_ForwardMailing: Class CRM_Core_Form
CRM_Mailing_Form_Optout: Class CRM_Core_Form
CRM_Mailing_Form_Search: Base class for most search forms
CRM_Mailing_Form_Subscribe: Class CRM_Core_Form
CRM_Mailing_Form_Task_AdhocMailing: Given the selected contacts, prepare a mailing with a hidden group.
CRM_Mailing_Form_Task_Print: This class provides the functionality to print mailing recipient records
CRM_Mailing_Form_Task: Class for mailing form task actions.
CRM_Mailing_Form_Unsubscribe: Class CRM_Core_Form
CRM_Mailing_Info: This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.
CRM_Mailing_MailStore_Imap: Class CRM_Mailing_MailStore_Imap
CRM_Mailing_MailStore_Localdir: Class CRM_Mailing_MailStore_Localdir
CRM_Mailing_MailStore_Maildir: Class CRM_Mailing_MailStore_Maildir
CRM_Mailing_MailStore_Mbox: Class CRM_Mailing_MailStore_Mbox
CRM_Mailing_MailStore_Pop3: Class CRM_Mailing_MailStore_Pop3
CRM_Mailing_MailStore
CRM_Mailing_Page_AJAX: This class contains all the function that are called using AJAX
CRM_Mailing_Page_Browse: This implements the profile page for all contacts. It uses a selector object to do the actual display. The fields displayed are controlled by the admin
CRM_Mailing_Page_Common: A Page is basically data in a nice pretty format.
CRM_Mailing_Page_Component: Page to display / edit the header / footer of a mailing
CRM_Mailing_Page_Confirm: A Page is basically data in a nice pretty format.
CRM_Mailing_Page_Event: This implements the profile page for all contacts.
CRM_Mailing_Page_Open: Indicate that a CiviMail message has been opened
CRM_Mailing_Page_Report: Page to display / edit the header / footer of a mailing.
CRM_Mailing_Page_Resubscribe: A Page is basically data in a nice pretty format.
CRM_Mailing_Page_Tab: This class handle mailing and contact related functions
CRM_Mailing_Page_Unsubscribe: A Page is basically data in a nice pretty format.
CRM_Mailing_Page_Url: Redirects a user to the full url from a mailing url.
CRM_Mailing_Page_View: A page for mailing preview.
CRM_Mailing_PseudoConstant: This class holds all the Pseudo constants that are specific to Mass mailing. This avoids polluting the core class and isolates the mass mailer class.
CRM_Mailing_Selector_Browse: This class is used to browse past mailings.
CRM_Mailing_Selector_Event: This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.
CRM_Mailing_Selector_Search: This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.
CRM_Mailing_Service_ListUnsubscribe: Apply a full range of `List-Unsubscribe` header options.
CRM_Mailing_Task: class to represent the actions that can be performed on a group of contacts used by the search forms.
CRM_Mailing_Tokens: Class CRM_Mailing_Tokens
CRM_Member_ActionMapping: This defines the scheduled-reminder functionality for CiviMember memberships. It allows one to target reminders based on join date or end date, with additional filtering based on membership-type.
CRM_Member_BAO_Membership: Placeholder class retained for legacy compatibility.
CRM_Member_BAO_MembershipBlock: Placeholder class retained for legacy compatibility.
CRM_Member_BAO_MembershipLog: Placeholder class retained for legacy compatibility.
CRM_Member_BAO_MembershipPayment: Placeholder class retained for legacy compatibility.
CRM_Member_BAO_MembershipStatus: Placeholder class retained for legacy compatibility.
CRM_Member_BAO_MembershipType: Placeholder class retained for legacy compatibility.
CRM_Member_BAO_Query
CRM_Member_Controller_Search: This class is used by the Search functionality.
CRM_Member_DAO_Membership: Placeholder class retained for legacy compatibility.
CRM_Member_DAO_MembershipBlock: Placeholder class retained for legacy compatibility.
CRM_Member_DAO_MembershipLog: Placeholder class retained for legacy compatibility.
CRM_Member_DAO_MembershipPayment: Placeholder class retained for legacy compatibility.
CRM_Member_DAO_MembershipStatus: Placeholder class retained for legacy compatibility.
CRM_Member_DAO_MembershipType: Placeholder class retained for legacy compatibility.
CRM_Member_Export_Form_Map: This class gets the name of the file to upload
CRM_Member_Export_Form_Select: This class gets the name of the file to upload
CRM_Member_Form_Membership: This class generates form components for offline membership form.
CRM_Member_Form_MembershipBlock: form to process actions on Membership
CRM_Member_Form_MembershipConfig: Base class for offline membership / membership type / membership renewal and membership status forms
CRM_Member_Form_MembershipRenewal: This class generates form components for Membership Renewal
CRM_Member_Form_MembershipStatus: This class generates form components for Membership Type
CRM_Member_Form_MembershipType: This class generates form components for Membership Type
CRM_Member_Form_MembershipView: This class generates form components for Payment-Instrument
CRM_Member_Form_Search: Membership search.
CRM_Member_Form_Task_Batch: This class provides the functionality for batch profile update for members
CRM_Member_Form_Task_Delete: This class provides the functionality to delete a group of members. This class provides functionality for the actual deletion.
CRM_Member_Form_Task_Email: This class provides the functionality to email a group of contacts.
CRM_Member_Form_Task_Label: This class helps to print the labels for contacts
CRM_Member_Form_Task_PDFLetter: This class provides the functionality to create PDF letter for a group of contacts or a single contact.
CRM_Member_Form_Task_PickProfile: This class provides the functionality for batch profile update for membership
CRM_Member_Form_Task_Print: This class provides the functionality to print members
CRM_Member_Form_Task_Result: Used for displaying results
CRM_Member_Form_Task: Class for member form task actions.
CRM_Member_Form: Base class for offline membership / membership type / membership renewal and membership status forms
CRM_Member_Import_Form_DataSource: This class gets the name of the file to upload
CRM_Member_Import_Form_MapField: This class gets the name of the file to upload
CRM_Member_Import_Form_Preview: This class previews the uploaded file and returns summary statistics
CRM_Member_Import_Parser_Membership: class to parse membership csv files
CRM_Member_Info: This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.
CRM_Member_Page_AJAX: This class contains all the function that are called using AJAX (dojo)
CRM_Member_Page_DashBoard: Page for displaying members.
CRM_Member_Page_MembershipStatus: Page for displaying list of membership statuses
CRM_Member_Page_MembershipType: Page for displaying list of membership types
CRM_Member_Page_RecurringContributions: Shows list of recurring contributions related to membership.
CRM_Member_Page_Tab: A Page is basically data in a nice pretty format.
CRM_Member_Page_UserDashboard: This class is for building membership block on user dashboard
CRM_Member_PseudoConstant: This class holds all the Pseudo constants that are specific to the civimember component. This avoids polluting the core class and isolates the mass mailer class
CRM_Member_Selector_Search: This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.
CRM_Member_StateMachine_Search: Core StateMachine.
CRM_Member_StatusOverrideTypes: Membership status override types.
CRM_Member_Task: class to represent the actions that can be performed on a group of contacts (CiviMember) used by the search forms
CRM_Member_Tokens: Class CRM_Member_Tokens
CRM_Member_Utils_RelationshipProcessor: Class CRM_Member_Utils_RelationshipProcessor
CRM_Member_WorkflowMessage_Membership_Membership: Examples for membership templates.
CRM_Member_WorkflowMessage_MembershipOfflineReceipt: Receipt sent when confirming a back office membership.
CRM_Member_WorkflowMessage_MembershipOnlineReceipt: Receipt sent when confirming a back office membership.
CRM_Note_Form_Note: This class generates form components generic to note
CRM_PCP_BAO_PCP: Placeholder class retained for legacy compatibility.
CRM_PCP_BAO_PCPBlock: Placeholder class retained for legacy compatibility.
CRM_PCP_Controller_PCP: This class is used by the Search functionality.
CRM_PCP_DAO_PCP: Placeholder class retained for legacy compatibility.
CRM_PCP_DAO_PCPBlock: Placeholder class retained for legacy compatibility.
CRM_PCP_Form_Campaign: This class generates form components for processing a pcp page.
CRM_PCP_Form_Contribute: This class generates form components for Tell A Friend
CRM_PCP_Form_Event: This class generates form components for PCP
CRM_PCP_Form_PCP: Administer Personal Campaign Pages - Search form
CRM_PCP_Form_PCPAccount: This class generates form components for processing a contribution.
CRM_PCP_Page_PCP: Page for displaying list of personal campaign pages
CRM_PCP_Page_PCPInfo: PCP Info Page - Summary about the PCP
CRM_PCP_StateMachine_PCP: State machine for managing different pages while setting up PCP flow.
CRM_Pledge_BAO_Pledge: Placeholder class retained for legacy compatibility.
CRM_Pledge_BAO_PledgeBlock: Placeholder class retained for legacy compatibility.
CRM_Pledge_BAO_PledgePayment: Placeholder class retained for legacy compatibility.
CRM_Pledge_BAO_Query
CRM_Pledge_Controller_Search: This class is used by the Search functionality.
CRM_Pledge_DAO_Pledge: Placeholder class retained for legacy compatibility.
CRM_Pledge_DAO_PledgeBlock: Placeholder class retained for legacy compatibility.
CRM_Pledge_DAO_PledgePayment: Placeholder class retained for legacy compatibility.
CRM_Pledge_Export_Form_Map: This class gets the name of the file to upload
CRM_Pledge_Export_Form_Select: This class gets the name of the file to upload
CRM_Pledge_Form_Payment: This class generates form components for processing a pledge payment.
CRM_Pledge_Form_Pledge: This class generates form components for processing a pledge
CRM_Pledge_Form_PledgeView: This class generates form components for Pledge
CRM_Pledge_Form_Search: This file is for Pledge search
CRM_Pledge_Form_Task_Delete: This class provides the functionality to delete a group of participations. This class provides functionality for the actual deletion.
CRM_Pledge_Form_Task_Print: This class provides the functionality to save a search Saved Searches are used for saving frequently used queries
CRM_Pledge_Form_Task_Result: Used for displaying results.
CRM_Pledge_Form_Task: Class for pledge form task actions.
CRM_Pledge_Info: This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.
CRM_Pledge_Page_AJAX: This class contains all the function that are called using AJAX
CRM_Pledge_Page_DashBoard: This page is for the Pledge Dashboard.
CRM_Pledge_Page_Payment: A Page is basically data in a nice pretty format.
CRM_Pledge_Page_Tab: A Page is basically data in a nice pretty format.
CRM_Pledge_Page_UserDashboard: This class is used to build User Dashboard
CRM_Pledge_Selector_Search: This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.
CRM_Pledge_StateMachine_Search: Core StateMachine.
CRM_Pledge_Task: class to represent the actions that can be performed on a group of contacts used by the search forms.
CRM_Pledge_Tokens: Class CRM_Pledge_Tokens
CRM_Pledge_WorkflowMessage_PledgeAcknowledge: Acknowledge a new pledge being set up
CRM_Pledge_WorkflowMessage_PledgeReminder: Reminder pledger that a payment is due.
CRM_Price_BAO_LineItem: Business objects for Line Items generated by monetary transactions
CRM_Price_BAO_PriceField: Business objects for managing price fields.
CRM_Price_BAO_PriceFieldValue: Business objects for managing price fields values.
CRM_Price_BAO_PriceSet: Business object for managing price sets.
CRM_Price_DAO_LineItem: Placeholder class retained for legacy compatibility.
CRM_Price_DAO_PriceField: Placeholder class retained for legacy compatibility.
CRM_Price_DAO_PriceFieldValue: Placeholder class retained for legacy compatibility.
CRM_Price_DAO_PriceSet: Placeholder class retained for legacy compatibility.
CRM_Price_DAO_PriceSetEntity: Placeholder class retained for legacy compatibility.
CRM_Price_Form_DeleteField: This class is to build the form for Deleting Group
CRM_Price_Form_DeleteSet: This class is to build the form for Deleting Set
CRM_Price_Form_Field: form to process actions on the field aspect of Price
CRM_Price_Form_Option: form to process actions on the field aspect of Custom
CRM_Price_Form_Preview: This class generates form components for previewing custom data
CRM_Price_Form_Set: Form to process actions on Price Sets.
CRM_Price_Page_Field: Create a page for displaying Price Fields.
CRM_Price_Page_Option: Create a page for displaying Custom Options.
CRM_Price_Page_Set: Create a page for displaying Price Sets.
CRM_Profile_Form_Dynamic: This class generates form components for custom data
CRM_Profile_Form_Edit: This class generates form components for custom data
CRM_Profile_Form_Search: This class generates form components generic to all the contact types.
CRM_Profile_Form: This class generates form components for custom data
CRM_Profile_Page_Dynamic: Create a page for displaying CiviCRM Profile Fields.
CRM_Profile_Page_Listings: This implements the profile page for all contacts. It uses a selector object to do the actual display. The fields displayed are controlled by the admin.
CRM_Profile_Page_MultipleRecordFieldsListing: A Page is basically data in a nice pretty format.
CRM_Profile_Page_Router: This is some kind of special-purpose router/front-controller for the various profile URLs.
CRM_Profile_Page_View: Main page for viewing contact.
CRM_Profile_Selector_Listings: This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.
CRM_Queue_BAO_Queue: Track a list of known queues.
CRM_Queue_BAO_QueueItem: Helpers for managing SQL-backed queue items
CRM_Queue_DAO_Queue: Placeholder class retained for legacy compatibility.
CRM_Queue_DAO_QueueItem: Placeholder class retained for legacy compatibility.
CRM_Queue_ErrorPolicy: To ensure that PHP errors or unhandled exceptions are reported in JSON format, wrap this around your code. For example:
CRM_Queue_Menu: Class CRM_Queue_Menu
CRM_Queue_Page_AJAX: Class CRM_Queue_Page_AJAX
CRM_Queue_Page_Monitor: The queue-monitor page provides an interactive, web-based system running the tasks in a queue and monitoring its progression.
CRM_Queue_Page_Runner: The queue-runner page provides an interactive, web-based system running the tasks in a queue and monitoring its progression.
CRM_Queue_Queue_Memory: A queue implementation which stores items in the CiviCRM SQL database
CRM_Queue_Queue_Sql: A queue implementation which stores items in the CiviCRM SQL database
CRM_Queue_Queue_SqlParallel: A queue implementation which stores items in the CiviCRM SQL database
CRM_Queue_Queue: A queue is an object (usually backed by some persistent data store) which stores a list of tasks or messages for use by other processes.
CRM_Queue_Runner: `CRM_Queue_Runner` runs a list tasks from a queue. It originally supported the database-upgrade queue. Consequently, this runner is optimal for queues which are:
CRM_Queue_Service: The queue service provides an interface for creating or locating queues. Note that this approach hides the details of data-storage: different queue-providers may store the queue content in different ways (in memory, in SQL, or in an external service).
CRM_Queue_Task: A task is an item that can be enqueued and later executed
CRM_Queue_TaskContext: Describe the runtime environment in which a queue task executes
CRM_Queue_TaskRunner: `CRM_Queue_TaskRunner` a list tasks from a queue. It is designed to supported background tasks which run automatically.
CRM_Report_BAO_Hook: Report hooks that allow extending a particular report.
CRM_Report_BAO_HookInterface: Interface class for Report hook query objects
CRM_Report_BAO_ReportInstance: Placeholder class retained for legacy compatibility.
CRM_Report_DAO_ReportInstance: Placeholder class retained for legacy compatibility.
CRM_Report_Form_Activity: Class CRM_Report_Form
CRM_Report_Form_ActivitySummary: Class CRM_Report_Form
CRM_Report_Form_Campaign_SurveyDetails: Class CRM_Report_Form
CRM_Report_Form_Case_Demographics: Class CRM_Report_Form
CRM_Report_Form_Case_Detail: Class CRM_Report_Form
CRM_Report_Form_Case_Summary: Class CRM_Report_Form
CRM_Report_Form_Case_TimeSpent: Class CRM_Report_Form
CRM_Report_Form_Contact_CurrentEmployer: Class CRM_Report_Form
CRM_Report_Form_Contact_Detail: Class CRM_Report_Form
CRM_Report_Form_Contact_Log: Class CRM_Report_Form
CRM_Report_Form_Contact_LoggingDetail: Class CRM_Report_Form
CRM_Report_Form_Contact_LoggingSummary: Class CRM_Logging_ReportSummary
CRM_Report_Form_Contact_Relationship: Class CRM_Report_Form
CRM_Report_Form_Contact_Summary: Class CRM_Report_Form
CRM_Report_Form_Contribute_Bookkeeping: Class CRM_Report_Form
CRM_Report_Form_Contribute_DeferredRevenue: Class CRM_Report_Form
CRM_Report_Form_Contribute_Detail: Class CRM_Report_Form
CRM_Report_Form_Contribute_History: Class CRM_Report_Form
CRM_Report_Form_Contribute_HouseholdSummary: Class CRM_Report_Form
CRM_Report_Form_Contribute_Lybunt: Class CRM_Report_Form
CRM_Report_Form_Contribute_OrganizationSummary: Class CRM_Report_Form
CRM_Report_Form_Contribute_PCP: Class CRM_Report_Form
CRM_Report_Form_Contribute_Recur: Class CRM_Report_Form
CRM_Report_Form_Contribute_RecurSummary: Class CRM_Report_Form
CRM_Report_Form_Contribute_Repeat: Class CRM_Report_Form
CRM_Report_Form_Contribute_SoftCredit: Class CRM_Report_Form
CRM_Report_Form_Contribute_Summary: Class CRM_Report_Form
CRM_Report_Form_Contribute_Sybunt: Class CRM_Report_Form
CRM_Report_Form_Contribute_TopDonor: Class CRM_Report_Form
CRM_Report_Form_Event_Income: Class CRM_Report_Form
CRM_Report_Form_Event_IncomeCountSummary: Class CRM_Report_Form
CRM_Report_Form_Event_ParticipantListCount: Class CRM_Report_Form
CRM_Report_Form_Event_ParticipantListing: Class CRM_Report_Form
CRM_Report_Form_Event_Summary: Class CRM_Report_Form
CRM_Report_Form_Instance: Class CRM_Report_Form_Instance
CRM_Report_Form_Mailing_Bounce: Class CRM_Report_Form
CRM_Report_Form_Mailing_Clicks: Class CRM_Report_Form
CRM_Report_Form_Mailing_Detail: Class CRM_Report_Form
CRM_Report_Form_Mailing_Opened: Class CRM_Report_Form
CRM_Report_Form_Mailing_Summary: Class CRM_Report_Form
CRM_Report_Form_Member_ContributionDetail: Class CRM_Report_Form
CRM_Report_Form_Member_Detail: Class CRM_Report_Form
CRM_Report_Form_Member_Lapse: Class CRM_Report_Form
CRM_Report_Form_Member_Summary: Class CRM_Report_Form
CRM_Report_Form_Membership_Summary: Class CRM_Report_Form
CRM_Report_Form_Pledge_Detail: Class CRM_Report_Form
CRM_Report_Form_Pledge_Pbnp: Class CRM_Report_Form
CRM_Report_Form_Pledge_Summary: Class CRM_Report_Form
CRM_Report_Form_Register: Class CRM_Core_Form
CRM_Report_Form_Walklist_Walklist: Class CRM_Report_Form
CRM_Report_Form: Class CRM_Report_Form
CRM_Report_Info: This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.
CRM_Report_OutputHandler_Csv: CSV Report Output Handler
CRM_Report_OutputHandler_Pdf: PDF Report Output Handler
CRM_Report_OutputHandler_Print: CSV Report Output Handler
CRM_Report_Page_Instance: Page for invoking report instances
CRM_Report_Page_InstanceList: Page for invoking report instances.
CRM_Report_Page_Options: Page for displaying list of report options
CRM_Report_Page_Report: Page for invoking report templates.
CRM_Report_Page_TemplateList: Page for displaying list of Report templates available.
CRM_Report_Utils_Get
CRM_Report_Utils_Report
CRM_SMS_BAO_SmsProvider: Placeholder class retained for legacy compatibility.
CRM_SMS_Controller_Send: Class CRM_Core_Controller
CRM_SMS_DAO_SmsProvider: Placeholder class retained for legacy compatibility.
CRM_SMS_Form_Group: Choose include / exclude groups and mass sms.
CRM_SMS_Form_Provider: SMS Form.
CRM_SMS_Form_Schedule: Class CRM_Core_Form
CRM_SMS_Form_Upload: This file is used to build the form configuring mass sms details.
CRM_SMS_Message
CRM_SMS_Page_Callback
CRM_SMS_Page_Provider: Page for displaying list of Providers
CRM_SMS_Provider
CRM_SMS_StateMachine_Send: State machine for managing different states of the Import process.
CRM_Tag_Form_Edit: This class generates form components for Tag.
CRM_Tag_Form_Merge: Form for merging tags.
CRM_Tag_Form_Tag: This class generates form components for tags
CRM_Tag_Page_Tag: Page for managing tags.
CRM_UF_Form_AbstractPreview: This class generates form components for previewing Civicrm Profile Group
CRM_UF_Form_AdvanceSetting: This class is for UF Group (Profile) configuration.
CRM_UF_Form_Field: Form to process actions on the field aspect of Custom.
CRM_UF_Form_Group: This class is for UF Group (Profile) configuration.
CRM_UF_Form_Inline_Preview: This class generates form components for previewing Civicrm Profile Group
CRM_UF_Form_Inline_PreviewById: This class generates form components for previewing Civicrm Profile Group
CRM_UF_Form_Preview: This class generates form components for previewing Civicrm Profile Group
CRM_UF_Page_Field: Create a page for displaying CiviCRM Profile Fields.
CRM_UF_Page_Group: Create a page for displaying UF Groups.
CRM_UF_Page_ProfileEditor: This class is not a real page -- it contains helpers for rendering the profile-selector and profile-editor widgets
CRM_Upgrade_Controller: Class CRM_Core_Controller
CRM_Upgrade_DispatchPolicy
CRM_Upgrade_Form: Class CRM_Upgrade_Form
CRM_Upgrade_Headless: Perform an upgrade without using the web-frontend
CRM_Upgrade_Incremental_Base: Base class for incremental upgrades
CRM_Upgrade_Incremental_General: This class contains generic upgrade logic which runs regardless of version.
CRM_Upgrade_Incremental_MessageTemplates
CRM_Upgrade_Incremental_php_FiveEight: Upgrade logic for FiveEight
CRM_Upgrade_Incremental_php_FiveEighteen: Upgrade logic for FiveEighteen
CRM_Upgrade_Incremental_php_FiveEighty: Upgrade logic for the 5.80.x series.
CRM_Upgrade_Incremental_php_FiveEightyOne: Upgrade logic for the 5.81.x series.
CRM_Upgrade_Incremental_php_FiveEleven: Upgrade logic for FiveEleven
CRM_Upgrade_Incremental_php_FiveFifteen: Upgrade logic for FiveFifteen
CRM_Upgrade_Incremental_php_FiveFifty: Upgrade logic for the 5.50.x series.
CRM_Upgrade_Incremental_php_FiveFiftyEight: Upgrade logic for the 5.58.x series.
CRM_Upgrade_Incremental_php_FiveFiftyFive: Upgrade logic for the 5.55.x series.
CRM_Upgrade_Incremental_php_FiveFiftyFour: Upgrade logic for the 5.54.x series.
CRM_Upgrade_Incremental_php_FiveFiftyNine: Upgrade logic for the 5.59.x series.
CRM_Upgrade_Incremental_php_FiveFiftyOne: Upgrade logic for the 5.51.x series.
CRM_Upgrade_Incremental_php_FiveFiftySeven: Upgrade logic for the 5.57.x series.
CRM_Upgrade_Incremental_php_FiveFiftySix: Upgrade logic for the 5.56.x series.
CRM_Upgrade_Incremental_php_FiveFiftyThree: Upgrade logic for the 5.53.x series.
CRM_Upgrade_Incremental_php_FiveFiftyTwo: Upgrade logic for the 5.52.x series.
CRM_Upgrade_Incremental_php_FiveFive: Upgrade logic for FiveFive
CRM_Upgrade_Incremental_php_FiveForty: Upgrade logic for FiveForty
CRM_Upgrade_Incremental_php_FiveFortyEight: Upgrade logic for the 5.48.x series.
CRM_Upgrade_Incremental_php_FiveFortyFive: Upgrade logic for FiveFortyFive
CRM_Upgrade_Incremental_php_FiveFortyFour: Upgrade logic for FiveFortyFour
CRM_Upgrade_Incremental_php_FiveFortyNine: Upgrade logic for the 5.49.x series.
CRM_Upgrade_Incremental_php_FiveFortyOne: Upgrade logic for FiveFortyOne
CRM_Upgrade_Incremental_php_FiveFortySeven: Upgrade logic for the 5.47.x series.
CRM_Upgrade_Incremental_php_FiveFortySix: Upgrade logic for FiveFortySix
CRM_Upgrade_Incremental_php_FiveFortyThree: Upgrade logic for FiveFortyThree
CRM_Upgrade_Incremental_php_FiveFortyTwo: Upgrade logic for FiveFortyTwo
CRM_Upgrade_Incremental_php_FiveFour: Upgrade logic for FiveFour
CRM_Upgrade_Incremental_php_FiveFourteen: Upgrade logic for FiveFourteen
CRM_Upgrade_Incremental_php_FiveNine: Upgrade logic for FiveNine
CRM_Upgrade_Incremental_php_FiveNineteen: Upgrade logic for FiveNineteen
CRM_Upgrade_Incremental_php_FiveOne: Upgrade logic for FiveOne
CRM_Upgrade_Incremental_php_FiveSeven: Upgrade logic for FiveSeven
CRM_Upgrade_Incremental_php_FiveSeventeen: Upgrade logic for FiveSeventeen
CRM_Upgrade_Incremental_php_FiveSeventy: Upgrade logic for the 5.70.x series.
CRM_Upgrade_Incremental_php_FiveSeventyEight: Upgrade logic for the 5.78.x series.
CRM_Upgrade_Incremental_php_FiveSeventyFive: Upgrade logic for the 5.75.x series.
CRM_Upgrade_Incremental_php_FiveSeventyFour: Upgrade logic for the 5.74.x series.
CRM_Upgrade_Incremental_php_FiveSeventyNine: Upgrade logic for the 5.79.x series.
CRM_Upgrade_Incremental_php_FiveSeventyOne: Upgrade logic for the 5.71.x series.
CRM_Upgrade_Incremental_php_FiveSeventySeven: Upgrade logic for the 5.77.x series.
CRM_Upgrade_Incremental_php_FiveSeventySix: Upgrade logic for the 5.76.x series.
CRM_Upgrade_Incremental_php_FiveSeventyThree: Upgrade logic for the 5.73.x series.
CRM_Upgrade_Incremental_php_FiveSeventyTwo: Upgrade logic for the 5.72.x series.
CRM_Upgrade_Incremental_php_FiveSix: Upgrade logic for FiveSix
CRM_Upgrade_Incremental_php_FiveSixteen: Upgrade logic for FiveSixteen
CRM_Upgrade_Incremental_php_FiveSixty: Upgrade logic for the 5.60.x series.
CRM_Upgrade_Incremental_php_FiveSixtyEight: Upgrade logic for the 5.68.x series.
CRM_Upgrade_Incremental_php_FiveSixtyFive: Upgrade logic for the 5.65.x series.
CRM_Upgrade_Incremental_php_FiveSixtyFour: Upgrade logic for the 5.64.x series.
CRM_Upgrade_Incremental_php_FiveSixtyNine: Upgrade logic for the 5.69.x series.
CRM_Upgrade_Incremental_php_FiveSixtyOne: Upgrade logic for the 5.61.x series.
CRM_Upgrade_Incremental_php_FiveSixtySeven: Upgrade logic for the 5.67.x series.
CRM_Upgrade_Incremental_php_FiveSixtySix: Upgrade logic for the 5.66.x series.
CRM_Upgrade_Incremental_php_FiveSixtyThree: Upgrade logic for the 5.63.x series.
CRM_Upgrade_Incremental_php_FiveSixtyTwo: Upgrade logic for the 5.62.x series.
CRM_Upgrade_Incremental_php_FiveTen: Upgrade logic for FiveTen
CRM_Upgrade_Incremental_php_FiveThirteen: Upgrade logic for FiveThirteen
CRM_Upgrade_Incremental_php_FiveThirty: Upgrade logic for FiveThirty
CRM_Upgrade_Incremental_php_FiveThirtyEight: Upgrade logic for FiveThirtyEight
CRM_Upgrade_Incremental_php_FiveThirtyFive: Upgrade logic for FiveThirtyFive
CRM_Upgrade_Incremental_php_FiveThirtyFour: Upgrade logic for FiveThirtyFour
CRM_Upgrade_Incremental_php_FiveThirtyNine: Upgrade logic for FiveThirtyNine
CRM_Upgrade_Incremental_php_FiveThirtyOne: Upgrade logic for FiveThirtyOne
CRM_Upgrade_Incremental_php_FiveThirtySeven: Upgrade logic for FiveThirtySeven
CRM_Upgrade_Incremental_php_FiveThirtySix: Upgrade logic for FiveThirtySix
CRM_Upgrade_Incremental_php_FiveThirtyThree: Upgrade logic for FiveThirtyThree
CRM_Upgrade_Incremental_php_FiveThirtyTwo: Upgrade logic for FiveThirtyTwo
CRM_Upgrade_Incremental_php_FiveThree: Upgrade logic for FiveThree
CRM_Upgrade_Incremental_php_FiveTwelve: Upgrade logic for FiveTwelve
CRM_Upgrade_Incremental_php_FiveTwenty: Upgrade logic for FiveTwenty
CRM_Upgrade_Incremental_php_FiveTwentyEight: Upgrade logic for FiveTwentyEight
CRM_Upgrade_Incremental_php_FiveTwentyFive: Upgrade logic for FiveTwentyFive
CRM_Upgrade_Incremental_php_FiveTwentyFour: Upgrade logic for FiveTwentyFour
CRM_Upgrade_Incremental_php_FiveTwentyNine: Upgrade logic for FiveTwentyNine
CRM_Upgrade_Incremental_php_FiveTwentyOne: Upgrade logic for FiveTwentyOne
CRM_Upgrade_Incremental_php_FiveTwentySeven: Upgrade logic for FiveTwentySeven
CRM_Upgrade_Incremental_php_FiveTwentySix: Upgrade logic for FiveTwentySix
CRM_Upgrade_Incremental_php_FiveTwentyThree: Upgrade logic for FiveTwentyThree
CRM_Upgrade_Incremental_php_FiveTwentyTwo: Upgrade logic for FiveTwentyTwo
CRM_Upgrade_Incremental_php_FiveTwo: Upgrade logic for FiveTwo
CRM_Upgrade_Incremental_php_FiveZero: Upgrade logic for 5.0
CRM_Upgrade_Incremental_php_FourSeven: Upgrade logic for 4.7
CRM_Upgrade_Incremental_SmartGroups
CRM_Upgrade_Page_Upgrade: A Page is basically data in a nice pretty format.
CRM_Upgrade_Snapshot: Provide helpers for recording data snapshots during an upgrade.
CRM_Upgrade_StateMachine: State machine for managing different states of the upgrade process.
CRM_Utils_Address_BatchUpdate: A PHP cron script to format all the addresses in the database. Currently it only does geocoding if the geocode values are not set. At a later stage we will also handle USPS address cleanup and other formatting issues
CRM_Utils_Address_USPS: Address utilities.
CRM_Utils_Address: Address Utilities
CRM_Utils_API_AbstractFieldCoder: Class CRM_Utils_API_AbstractFieldCoder.
CRM_Utils_API_HTMLInputCoder: This class captures the encoding practices of CRM-5667 in a reusable fashion. In this design, all submitted values are partially HTML-encoded before saving to the database. If a DB reader needs to output in non-HTML medium, then it should undo the partial HTML encoding.
CRM_Utils_API_MatchOption: Class CRM_Utils_API_MatchOption
CRM_Utils_API_NullOutputCoder: Class CRM_Utils_API_NullOutputCoder
CRM_Utils_API_ReloadOption: Class CRM_Utils_API_ReloadOption
CRM_Utils_Array: Provides a collection of static methods for array manipulation.
CRM_Utils_AutoClean: Class CRM_Utils_AutoClean
CRM_Utils_Cache_APCcache
CRM_Utils_Cache_APCucache
CRM_Utils_Cache_ArrayCache: Class CRM_Utils_Cache_ArrayCache
CRM_Utils_Cache_ArrayDecorator: Class CRM_Utils_Cache_ArrayDecorator
CRM_Utils_Cache_CacheException: Class CRM_Utils_Cache_CacheException
CRM_Utils_Cache_CacheWrapper
CRM_Utils_Cache_FastArrayDecorator: Class CRM_Utils_Cache_FastArrayDecorator
CRM_Utils_Cache_InvalidArgumentException: Class CRM_Utils_Cache_InvalidArgumentException
CRM_Utils_Cache_Memcache
CRM_Utils_Cache_Memcached
CRM_Utils_Cache_NoCache
CRM_Utils_Cache_Redis
CRM_Utils_Cache_SqlGroup: This caching provider stores all cached items as a "group" in the "civicrm_cache" table. The entire 'group' may be prefetched when instantiating the cache provider.
CRM_Utils_Cache_Tiered: Class CRM_Utils_Cache_Tiered
CRM_Utils_Cache: Cache is an empty base object, we'll modify the scheme when we have different caching schemes
CRM_Utils_Chart: Build various graphs using the dc chart library.
CRM_Utils_Check_Component_AddressParsing
CRM_Utils_Check_Component_Case
CRM_Utils_Check_Component_Cms
CRM_Utils_Check_Component_ContactTypes
CRM_Utils_Check_Component_DedupeRules
CRM_Utils_Check_Component_Env
CRM_Utils_Check_Component_LocationTypes
CRM_Utils_Check_Component_Mailing
CRM_Utils_Check_Component_OptionGroups
CRM_Utils_Check_Component_PriceFields
CRM_Utils_Check_Component_Schema
CRM_Utils_Check_Component_Security
CRM_Utils_Check_Component_Smarty
CRM_Utils_Check_Component_Source
CRM_Utils_Check_Component_Timestamps
CRM_Utils_Check_Component_Tokens
CRM_Utils_Check_Component
CRM_Utils_Check_Message
CRM_Utils_Check
CRM_Utils_Color: Static utility functions for working with colors
CRM_Utils_ConsoleTee: Capture the output from the console, copy it to a file, and pass it on.
CRM_Utils_Constant: Class CRM_Utils_Constant
CRM_Utils_Crypt
CRM_Utils_Date: Date utilties
CRM_Utils_EchoLogger
CRM_Utils_EnglishNumber
CRM_Utils_FakeObject: This is a quick-and-dirty way to define a vaguely-class-ish structure. It's non-performant, abnormal, and not a complete OOP system. Only use for testing/mocking.
CRM_Utils_File: class to provide simple static functions for file objects
CRM_Utils_Geocode_Google: Class that uses google geocoder
CRM_Utils_GeocodeProvider
CRM_Utils_GlobalStack: Temporarily change a global variable.
CRM_Utils_GuzzleMiddleware: Additional helpers/utilities for use as Guzzle middleware.
CRM_Utils_Hook_Backdrop
CRM_Utils_Hook_Drupal
CRM_Utils_Hook_Drupal8
CRM_Utils_Hook_DrupalBase
CRM_Utils_Hook_Joomla
CRM_Utils_Hook_Soap
CRM_Utils_Hook_Standalone
CRM_Utils_Hook_UnitTests
CRM_Utils_Hook_WordPress
CRM_Utils_Hook
CRM_Utils_Http
CRM_Utils_HttpClient: This class handles HTTP downloads
CRM_Utils_ICalendar
CRM_Utils_JS: Parse Javascript content and extract translatable strings.
CRM_Utils_JSON: Class handles functions for JSON format
CRM_Utils_LazyArray: A lazy-array works much like a regular array or ArrayObject. However, it is initially empty - and it is only populated if used.
CRM_Utils_Mail_CaseMail: Class CRM_Utils_Mail_CaseMail.
CRM_Utils_Mail_EmailProcessor: Class CRM_Utils_Mail_EmailProcessor.
CRM_Utils_Mail_FilteredPearMailer: The filtered-mailer is a utility to wrap an existing PEAR Mail class and apply extra filters. It is primarily intended for resolving quirks in the standard implementations.
CRM_Utils_Mail_Incoming
CRM_Utils_Mail_Logger: An attachment to PEAR Mail which logs emails to files based on the CIVICRM_MAIL_LOG configuration.
CRM_Utils_Mail
CRM_Utils_Migrate_Export
CRM_Utils_Migrate_ExportJSON
CRM_Utils_Migrate_Import
CRM_Utils_Migrate_ImportJSON
CRM_Utils_Monaco
CRM_Utils_Money: Money utilties
CRM_Utils_Network: Simple static helpers for network operations
CRM_Utils_Number: Class CRM_Utils_Number
CRM_Utils_OptionBag: Class CRM_Utils_OptionBag.
CRM_Utils_Pager: Class CRM_Utils_Pager
CRM_Utils_PagerAToZ: This class is for displaying alphabetical bar
CRM_Utils_PDF_Document: Class CRM_Utils_PDF_Document.
CRM_Utils_PDF_Label: Class CRM_Utils_PDF_Label
CRM_Utils_PDF_Utils
CRM_Utils_PseudoConstant: Utilities for manipulating/inspecting CRM_*_PseudoConstant classes.
CRM_Utils_Recent: Recent items utility class.
CRM_Utils_Request: Class for managing a http request
CRM_Utils_REST: This class handles all REST client requests.
CRM_Utils_Rule: Class CRM_Utils_Rule
CRM_Utils_SameSite: SameSite Utility Class.
CRM_Utils_Schema: Helper classes for parsing the xml schema files.
CRM_Utils_Signer: A utility which signs and verifies a list of key-value pairs
CRM_Utils_SoapServer: (OBSOLETE) This class previously handled SOAP requests.
CRM_Utils_Sort: Base class to provide generic sort functionality.
CRM_Utils_SQL_BaseParamQuery: Class CRM_Utils_SQL_BaseParamQuery
CRM_Utils_SQL_Delete: Object-oriented SQL builder for DELETE queries.
CRM_Utils_SQL_Insert: Object-oriented SQL builder for INSERT queries.
CRM_Utils_SQL_Literal: A literal fragment of SQL.
CRM_Utils_SQL_Select: Object-oriented SQL builder for SELECT queries.
CRM_Utils_SQL_TempTable
CRM_Utils_SQL: Just another collection of static utils functions.
CRM_Utils_String: This class contains string functions.
CRM_Utils_System_Backdrop: Backdrop-specific logic that differs from Drupal.
CRM_Utils_System_Base: Base class for UF system integrations
CRM_Utils_System_Drupal: Drupal specific stuff goes here
CRM_Utils_System_Drupal8: Drupal specific stuff goes here.
CRM_Utils_System_DrupalBase: Drupal specific stuff goes here
CRM_Utils_System_Joomla: Joomla specific stuff goes here.
CRM_Utils_System_Soap: Soap specific stuff goes here.
CRM_Utils_System_Standalone: Standalone specific stuff goes here.
CRM_Utils_System_UnitTests: Helper authentication class for unit tests
CRM_Utils_System_WordPress: WordPress specific stuff goes here
CRM_Utils_System: System wide utilities.
CRM_Utils_SystemLogger
CRM_Utils_Time: Date time utilties
CRM_Utils_Token: Class to abstract token replacement.
CRM_Utils_Type
CRM_Utils_Url
CRM_Utils_Verp: Class to handle encoding and decoding Variable Enveleope Return Path (VERP) headers.
CRM_Utils_VersionCheck
CRM_Utils_Weight: Class CRM_Utils_Weight
CRM_Utils_Wrapper: The Contact Wrapper is a wrapper class which is called by contact.module after it parses the menu path.
CRM_Utils_XML
CRM_Utils_Zip: Utilities for working with zip files
CRM_AfformAdmin_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_AfformAdmin_Page_Base: Base page for Afform admin
CRM_AfformAdmin_Upgrader: Collection of upgrade steps.
CRM_Afform_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Afform_AfformScanner: Class CRM_Afform_AfformScanner
CRM_Afform_ArrayHtml: Class CRM_Afform_ArrayHtml
CRM_Afform_BAO_AfformSubmission: Placeholder class retained for legacy compatibility.
CRM_Afform_DAO_AfformSubmission: Placeholder class retained for legacy compatibility.
CRM_Afform_Page_AfformBase: A Page is basically data in a nice pretty format.
CRM_Afform_Page_Verify: A Page is basically data in a nice pretty format.
CRM_Afform_Upgrader: Collection of upgrade steps.
CRM_Afform_PageTest
CRM_Afform_UtilTest
CRM_AfformHtml_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_AfformLoginToken_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_AfformMock_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Authx_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Authx_Page_AJAX
CRM_ChartKit_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Campaign_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Case_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Contribute_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Event_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Mailing_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Member_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Pledge_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Report_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
ReportTest: Test CiviReport functionality.
CRM_CivicrmAdminUi_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_CivicrmAdminUi_Upgrader: Collection of upgrade steps.
E2E_CivicrmAdminUi_ManageGroupsTest: E2E Mink tests for Manage Groups screen.
CRM_CivicrmSearchUi_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_CivicrmSearchUi_Upgrader: Collection of upgrade steps.
CRM_Grant_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Grant_BAO_Grant: Class CRM_Grant_BAO_Grant
CRM_Grant_BAO_Query: Class CRM_Grant_BAO_Query
CRM_Grant_Controller_Search: This class is used by the Search functionality.
CRM_Grant_DAO_Grant: Placeholder class retained for legacy compatibility.
CRM_Grant_Export_Form_Map: This class gets the name of the file to upload
CRM_Grant_Export_Form_Select: This class gets the name of the file to upload
CRM_Grant_Form_Grant: This class generates form components for processing a case
CRM_Grant_Form_GrantView: Not a real form: displays a grant in view mode.
CRM_Grant_Form_Search: This file is for CiviGrant search
CRM_Grant_Form_Task_Delete: This class provides the functionality to delete a group of participations. This class provides functionality for the actual deletion.
CRM_Grant_Form_Task_Print: This class provides the functionality to grant list
CRM_Grant_Form_Task_Result: Used for displaying results
CRM_Grant_Form_Task_Update: This class provides the functionality to update a group of grants. This class provides functionality for the actual update.
CRM_Grant_Form_Task: Class for grant form task actions.
CRM_Grant_Page_DashBoard: This is page is for Grant Dashboard
CRM_Grant_Selector_Search: This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.
CRM_Grant_StateMachine_Search: Core StateMachine.
CRM_Grant_Task: class to represent the actions that can be performed on a group of contacts used by the search forms
CRM_Grant_Upgrader: Collection of upgrade steps.
CRM_Report_Form_Grant_Detail: Class CRM_Report_Form
CRM_Report_Form_Grant_Statistics: Class CRM_Report_Form
api_v3_GrantTest: Test APIv3 civicrm_grant* functions
CRM_Civiimport_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CiviApiImportTest: FIXME - Add test description.
CRM_Ckeditor4_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Ckeditor4_Form_CKEditorConfig: Form for configuring CKEditor options.
CRM_Ckeditor4_Upgrader: Collection of upgrade steps.
CRM_Contributioncancelactions_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CancelTest: FIXME - Add test description.
CRM_Core_Payment_Elavon: ----------------------------------------------------------------------------------------------- The basic functionality of this processor is that variables from the $params object are transformed into xml. The xml is submitted to the processor's https site using curl and the response is translated back into an array using the processor's function.
CRM_Elavon_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Core_Payment_ElavonTest: FIXME - Add test description.
CRM_Event_Cart_BAO_Cart: Class CRM_Event_Cart_BAO_Cart
CRM_Event_Cart_BAO_Conference: Class CRM_Event_Cart_BAO_Conference
CRM_Event_Cart_BAO_EventInCart: Class CRM_Event_Cart_BAO_EventInCart
CRM_Event_Cart_BAO_MerParticipant: Class CRM_Event_Cart_BAO_MerParticipant
CRM_Event_Cart_Controller_Checkout: Class CRM_Event_Cart_Controller_Checkout
CRM_Event_Cart_DAO_Cart: Placeholder class retained for legacy compatibility.
CRM_Event_Cart_DAO_EventCartParticipant: Placeholder class retained for legacy compatibility.
CRM_Event_Cart_DAO_EventInCart: Placeholder class retained for legacy compatibility.
CRM_Event_Cart_Form_Cart: Class CRM_Event_Cart_Form_Cart
CRM_Event_Cart_Form_Checkout_ConferenceEvents: Class CRM_Event_Cart_Form_Checkout_ConferenceEvents
CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices: Class CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices
CRM_Event_Cart_Form_Checkout_Payment: Class CRM_Event_Cart_Form_Checkout_Payment
CRM_Event_Cart_Form_Checkout_ThankYou: Class CRM_Event_Cart_Form_Checkout_ThankYou
CRM_Event_Cart_Form_MerParticipant: Class CRM_Event_Cart_Form_MerParticipant
CRM_Event_Cart_Page_AddToCart: Class CRM_Event_Cart_Page_AddToCart
CRM_Event_Cart_Page_CheckoutAJAX: Class CRM_Event_Cart_Page_CheckoutAJAX
CRM_Event_Cart_Page_RemoveFromCart: Class CRM_Event_Cart_Page_RemoveFromCart
CRM_Event_Cart_Page_ViewCart: Class CRM_Event_Cart_Page_ViewCart
CRM_Event_Cart_PageCallback
CRM_Event_Cart_StateMachine_Checkout: Class CRM_Event_Cart_StateMachine_Checkout
CRM_Event_Cart_Upgrader: Collection of upgrade steps.
CRM_Event_Form_ManageEvent_Conference: This class generates form components for Conference Slots.
CRM_Event_Cart_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Core_Payment_eWAY: Class CRM_Core_Payment_eWAY.
CRM_Ewaysingle_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
GatewayRequest
GatewayResponse: Licensed to CiviCRM under the Academic Free License version 3.0 Written & Contributed by Dolphin Software P/L - March 2008
CRM_Core_Payment_EwayTest: FIXME - Add test description.
CRM_Financialacls_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Flexmailer_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Greenwich_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Iframe_Page_InstallPage: A Page is basically data in a nice pretty format.
CRM_Iframe_Utils
CRM_Iframe_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Contact_BAO_SearchCustom
CRM_Contact_Form_Search_Action_Export: This is a shared parent class for form task actions.
CRM_Contact_Form_Search_Custom_ActivitySearch
CRM_Contact_Form_Search_Custom_Base
CRM_Contact_Form_Search_Custom_Basic
CRM_Contact_Form_Search_Custom_ContribSYBNT
CRM_Contact_Form_Search_Custom_ContributionAggregate
CRM_Contact_Form_Search_Custom_DateAdded
CRM_Contact_Form_Search_Custom_EventAggregate
CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
CRM_Contact_Form_Search_Custom_FullText_Activity
CRM_Contact_Form_Search_Custom_FullText_Case
CRM_Contact_Form_Search_Custom_FullText_Contact
CRM_Contact_Form_Search_Custom_FullText_Contribution
CRM_Contact_Form_Search_Custom_FullText_Membership
CRM_Contact_Form_Search_Custom_FullText_Participant
CRM_Contact_Form_Search_Custom_FullText
CRM_Contact_Form_Search_Custom_Group
CRM_Contact_Form_Search_Custom_MultipleValues
CRM_Contact_Form_Search_Custom_PostalMailing
CRM_Contact_Form_Search_Custom_PriceSet
CRM_Contact_Form_Search_Custom_Proximity: This search now functions as a subset of advanced search since at some point it was added to advanced search.
CRM_Contact_Form_Search_Custom_RandomSegment
CRM_Contact_Form_Search_Custom_Sample
CRM_Contact_Form_Search_Custom_TagContributions
CRM_Contact_Form_Search_Custom_ZipCodeRange
CRM_Contact_Form_Search_Custom: Base Search / View form for *all* listing of multiple contacts
CRM_Contact_Page_CustomSearch: Main page for viewing all Saved searches.
CRM_Contact_Selector_Custom: This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.
CRM_Core_InnoDBIndexer: The InnoDB indexer is responsible for creating and destroying full-text indices on InnoDB classes.
CRM_Legacycustomsearches_Controller_Search: This class is used by the Search functionality.
CRM_Legacycustomsearches_StateMachine_Search: Core StateMachine.
CRM_Utils_QueryFormatter: Class CRM_Utils_QueryFormatter
CRM_Legacycustomsearches_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Contact_Form_Search_Custom_PriceSetTest: Test contact custom search functions
CRM_Core_InnoDBIndexerTest: Class CRM_Core_InnoDBIndexerTest
CRM_Utils_QueryFormatterTest: FIXME - Add test description.
CRM_MessageAdmin_Page_MsgtplBasePage: A Page is basically data in a nice pretty format.
CRM_MessageAdmin_Settings
CRM_MessageAdmin_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_OAuth_Angular
CRM_OAuth_BAO_OAuthClient: Database access object for the OAuthClient entity.
CRM_OAuth_BAO_OAuthContactToken: Database access object for the OAuthContactToken entity.
CRM_OAuth_BAO_OAuthSysToken: Database access object for the OAuthSysToken entity.
CRM_OAuth_ContactFromToken
CRM_OAuth_DAO_OAuthClient: Database access object for the OAuthClient entity.
CRM_OAuth_DAO_OAuthContactToken: Database access object for the OAuthContactToken entity.
CRM_OAuth_DAO_OAuthSysToken: Database access object for the OAuthSysToken entity.
CRM_OAuth_MailSetup
CRM_OAuth_Page_Return: A Page is basically data in a nice pretty format.
CRM_OAuth_Upgrader: Collection of upgrade steps.
CRM_OAuth_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
api_v4_OAuthClientGrantTest: Test the "grant" methods (authorizationCode, clientCredential, etc).
api_v4_OAuthClientTest: Create, read, and destroy OAuth clients.
api_v4_OAuthContactTokenTest: Create, read, and destroy contact-specific OAuth tokens
api_v4_OAuthProviderTest: Read list of OAuth providers
api_v4_OAuthSessionTokenTest: Create and read session-specific OAuth tokens
api_v4_OAuthSysTokenTest: Create, read, and destroy OAuth tokens.
CRM_OAuth_MailSetupTest: Test helper functions in CRM_OAuth_MailSetup.
CRM_Oembed_Page_Oembed: The `civicrm/oembed` route supports these modes:
CRM_Oembed_Page_OembedShare: The `civicrm/share?url=ABSOLUTE_URL` route defines a stub/placeholder.
CRM_Oembed_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Oembed_Page_OembedDiscoveryTest
CRM_Oembed_Page_OembedTest
CRM_Core_Payment_PayflowPro: Class CRM_Core_Payment_PayflowPro.
CRM_Payflowpro_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Core_Payment_PayflowProTest: FIXME - Add test description.
CRM_Utils_ReCAPTCHA
ReCaptchaResponse: A ReCaptchaResponse is returned from recaptcha_check_answer()
CRM_Recaptcha_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_ScheduledCommunications_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Search_BAO_SearchDisplay: Search Display BAO
CRM_Search_BAO_SearchSegment: Search Segment BAO
CRM_Search_DAO_SearchDisplay: Placeholder class retained for legacy compatibility.
CRM_Search_DAO_SearchSegment: Placeholder class retained for legacy compatibility.
CRM_Search_Page_Admin: Angular base page for search admin
CRM_Search_Page_AJAX: Ajax callback used to reload admin settings when they may have changed.
CRM_Search_Page_Search: Angular base page for search admin
CRM_Search_Upgrader: Collection of upgrade steps.
CRM_Search_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Sequentialcreditnotes_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
SequentialcreditnotesTest: FIXME - Add test description.
CRM_Standaloneusers_BAO_Role: Placeholder class retained for legacy compatibility.
CRM_Standaloneusers_BAO_Session: Placeholder class retained for legacy compatibility.
CRM_Standaloneusers_BAO_Totp: DAOs provide an OOP-style facade for reading and writing database records.
CRM_Standaloneusers_BAO_User: Business access object for the User entity.
CRM_Standaloneusers_DAO_Role: Placeholder class retained for legacy compatibility.
CRM_Standaloneusers_DAO_Session: Placeholder class retained for legacy compatibility.
CRM_Standaloneusers_DAO_Totp: DAOs provide an OOP-style facade for reading and writing database records.
CRM_Standaloneusers_DAO_User: Placeholder class retained for legacy compatibility.
CRM_Standaloneusers_DAO_UserRole: Placeholder class retained for legacy compatibility.
CRM_Standaloneusers_Page_ChangePassword: A Page is basically data in a nice pretty format.
CRM_Standaloneusers_Page_Login: A Page is basically data in a nice pretty format.
CRM_Standaloneusers_Page_PermissionDenied: Display an "Access Denied" screen.
CRM_Standaloneusers_Page_ResetPassword: Provide the send password reset / reset password page.
CRM_Standaloneusers_Page_TOTP: Page for /civicrm/mfa/totp
CRM_Standaloneusers_Page_TOTPSetup: Page for /civicrm/mfa/totp-setup
CRM_Standaloneusers_Upgrader: Collection of upgrade steps.
CRM_Standaloneusers_WorkflowMessage_PasswordReset: Generic base-class for describing the inputs for a workflow email template.
CRM_Standaloneusers_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Friend_BAO_Friend: This class contains the functions for Friend
CRM_Friend_Form_Contribute: This class generates form components for Tell A Friend
CRM_Friend_Form_Event: This class generates form components for Tell A Friend
CRM_Friend_Form: This class generates form components for Tell A Friend Form For End User
CRM_Friend_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_UserDashboard_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Shimmy_DAO_ShimThing: Database access object for the ShimThing entity.
CRM_Shimmy_Page_FooBar: A Page is basically data in a nice pretty format.
CRM_Shimmy_ShimmyHookObject: In this example, we use a non-static hook function.
CRM_Shimmy_ShimmyMessage: Generic base-class for describing the inputs for a workflow email template.
CRM_Shimmy_Utils
InstallSchemaPlugin
CRM_GCD: Class CRM_GCD
CRM_Shimmy_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
E2E_Shimmy_LifecycleTest: Enable, disable, and uninstall an extension. Ensure that various local example is enabled and disabled appropriately.
CRM_Moduleupgtest_Upgrader: Base class which provides helpers to execute upgrade logic.
test_extension_manager_paymenttest: Class test_extension_manager_paymenttest
test_extension_manager_reporttest: Class test_extension_manager_reporttest
test_extension_manager_searchtest: Class test_extension_manager_searchtest
AllTests: Class containing all test suites
api_v3_ACLCachingTest: This class is intended to test ACL permission using the multisite module
api_v3_ACLPermissionTest: This class is intended to test ACL permission using the multisite module
api_v3_ActionScheduleTest: Test APIv3 civicrm_action_schedule functions
api_v3_ActivityCaseTest: Test Activity.get API with the case_id field
api_v3_ActivityContactTest: Test APIv3 civicrm_activity_contact* functions
api_v3_ActivityTest: Test APIv3 civicrm_activity_* functions
api_v3_ActivityTypeTest: Test APIv3 civicrm_activity_* functions
api_v3_AddressTest: Class api_v3_AddressTest
api_v3_AllTests: Class containing all API v3 test suites
api_v3_APITest: Test class for API functions.
api_v3_APIWrapperTest: Test class for API functions
api_v3_APIWrapperTest_Impl: Class api_v3_APIWrapperTest_Impl
api_v3_AttachmentTest: Test for the Attachment API
api_v3_BatchTest: Test class for Batch API - civicrm_batch_*
api_v3_CampaignTest: Class api_v3_CampaignTest
api_v3_CaseContactTest: Test APIv3 civicrm_case_* functions
api_v3_CaseTest: Test APIv3 civicrm_case_* functions
api_v3_CaseTypeTest: Class api_v3_CaseTypeTest
class_api_test: Test class for class.api.php
api_v3_ConstantTest: Test APIv3 civicrm_activity_* functions
api_v3_ContactTest: Test APIv3 civicrm_contact* functions
api_v3_ContactTypeTest: Class api_v3_ContactTypeTest
api_v3_ContributionPageTest: Test APIv3 civicrm_contribution_page* functions
api_v3_ContributionRecurTest: Test APIv3 civicrm_contribute_recur* functions
api_v3_ContributionSoftTest: Test APIv3 civicrm_contribute_* functions
api_v3_ContributionTest: Test APIv3 civicrm_contribute_* functions
api_v3_CountryTest: Test APIv3 civicrm_country* functions
api_v3_CRM11793Test: Test APIv3 civicrm_activity_* functions
CRM_Omnimail_DAO_MailingProviderData: CRM_Omnimail_DAO_MailingProviderData constructor.
CRM_Omnimail_BAO_MailingProviderData: CRM_Omnimail_BAO_MailingProviderData constructor.
api_v3_CustomApiTest: Test class for API functions.
api_v3_CustomFieldTest: Test APIv3 civicrm_create_custom_group
api_v3_CustomGroupTest: Test APIv3 civicrm_custom_group* functions
api_v3_CustomSearchTest: Class api_v3_CustomSearchTest
api_v3_CustomValueContactTypeTest: Base class for CiviCRM unit tests
api_v3_CustomValueTest: Class api_v3_CustomValueTest
api_v3_DashboardContactTest: Test APIv3 civicrm_action_schedule functions
api_v3_DashboardTest: Test APIv3 civicrm_action_schedule functions
api_v3_DomainTest: Test class for Domain API - civicrm_domain_*
api_v3_EmailTest: Class api_v3_EmailTest
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_EventTest: Class api_v3_EventTest
api_v3_ExceptionTest: Test class for Dedupe exceptions.
api_v3_ExtensionTest: Class api_v3_ExtensionTest.
api_v3_FinancialTypeACLTest: Test APIv3 civicrm_contribute_* functions
api_v3_FinancialTypeTest: Base class for CiviCRM unit tests
api_v3_GroupContactTest: Class api_v3_GroupContactTest
api_v3_GroupNestingTest: Test class for GroupNesting API - civicrm_group_nesting_*
api_v3_GroupOrganizationTest: Test class for GroupOrganization API - civicrm_group_organization_*
api_v3_GroupTest: Test class for Group API - civicrm_group_*
api_v3_ImTest: Test APIv3 civicrm_im_* functions
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_LineItemTest: Class api_v3_LineItemTest
api_v3_LocBlockTest: Class api_v3_LocBlockTest
api_v3_LoggingTest: Test class for Logging API.
api_v3_MailingABTest: Test APIv3 civicrm_mailingab_* functions
api_v3_MailingContactTest: Class api_v3_MailingContactTest
api_v3_MailingGroupTest: Test APIv3 civicrm_mailing_group_* functions
api_v3_MailingTest: Test APIv3 civicrm_mailing_* functions
api_v3_MailSettingsTest: Class api_v3_MailSettingsTest
api_v3_MappingFieldTest: Test APIv3 civicrm_mapping_field_* functions
api_v3_MappingTest: Test APIv3 civicrm_mapping_* functions
api_v3_MembershipPaymentTest: Test APIv3 civicrm_membership_payment* functions
api_v3_MembershipStatusTest: Class api_v3_MembershipStatusTest
api_v3_MembershipTest: Class api_v3_MembershipTest
api_v3_MembershipTypeTest: Class api_v3_MembershipTypeTest
api_v3_MessageTemplateTest: Test class for Template API - civicrm_msg_template*
api_v3_MultilingualTest: Test class for the option.language API parameter in multilingual.
api_v3_NavigationTest: Class api_v3_NavigationTest
api_v3_NoteTest: Class contains api test cases for "civicrm_note"
api_v3_OpenIDTest: Test APIv3 civicrm_openid_* functions
api_v3_OptionGroupTest: Class api_v3_OptionGroupTest
api_v3_OptionValueTest: Class api_v3_OptionValueTest
api_v3_OrderTest: Test APIv3 civicrm_contribute_* functions
api_v3_ParticipantPaymentTest: Test APIv3 civicrm_participant_* functions
api_v3_ParticipantStatusTypeTest: Class api_v3_ParticipantStatusTypeTest
api_v3_ParticipantTest: Class api_v3_ParticipantTest
api_v3_PaymentProcessorTest: Class contains api test cases for "civicrm_payment_processor"
api_v3_PaymentProcessorTypeTest: Class contains api test cases for "civicrm_payment_processor_type"
api_v3_PaymentTest: Test APIv3 civicrm_contribute_* functions
api_v3_PaymentTokenTest: Class api_v3_PaymentTokenTest
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_PhoneTest: Test APIv3 civicrm_phone* functions
api_v3_PledgePaymentTest: Test class for Pledge API - civicrm_pledge_*
api_v3_PledgeTest: Test class for Pledge API - civicrm_pledge_*
api_v3_PriceFieldTest: Class api_v3_PriceFieldTest
api_v3_PriceFieldValueTest: Class api_v3_PriceFieldValueTest.
api_v3_PriceSetTest: Class api_v3_PriceSetTest
api_v3_ProductTest: Class api_v3_ProductTest
api_v3_ProfileTest: Test APIv3 civicrm_profile_* functions
api_v3_RelationshipTest: Class contains api test cases for "civicrm_relationship"
api_v3_RelationshipTypeTest: Class contains api test cases for "civicrm_relationship_type"
api_v3_ReportTemplateTest: Test APIv3 civicrm_report_instance_* functions
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_StateProvinceTest: Test APIv3 civicrm_state_province* functions
api_v3_StatusPreferenceTest: Class api_v3_StatusPreferenceTest
api_v3_SurveyRespondantTest: Class api_v3_SurveyRespondantTest
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_SyntaxConformanceTest: Test that the core actions for APIv3 entities comply with standard syntax+behavior.
api_v3_SystemCheckTest: System.check API has many special test cases, so they have their own class.
api_v3_SystemTest: Test class for System API - civicrm_system_*
api_v3_TagTest: Test APIv3 civicrm_tag_* functions
api_v3_TaxContributionPageTest: Class api_v3_TaxContributionPageTest
api_v3_UFFieldTest: Test class for UFField API
api_v3_UFGroupTest: Test class for UFGroup API - civicrm_uf_*
api_v3_UFJoinTest: Test class for UFGroup API - civicrm_uf_*
api_v3_UFMatchTest: Test class for UFMatch api.
api_v3_UserTest: Test APIv3 civicrm_user_* functions
api_v3_UtilsTest: Test class for API utils
api_v3_ValidateTest: Tests for the generic validate API action.
api_v3_WebsiteTest: Test APIv3 civicrm_website_* functions
api_v4_AllTests: Class containing the APIv4 test suite
Civi_AllTests: Class containing all CRM test suites
CiviCaseTestCase: Class CiviReportTestCase
CiviDBAssert
CiviEndToEndTestCase: Class CiviEndToEndTestCase
CiviMailUtils: Class CiviMailUtils
CiviReportTestCase: Class CiviReportTestCase
CiviSimpleCacheTest
CiviTestSMSProvider: Test SMS provider to allow for testing
CiviTestSuite: Parent class for test suites
CiviUnitTestCase: Base class for CiviCRM unit tests
CRM_ACL_ListTest: Class CRM_ACL_Test
CRM_Activity_ActionMappingTest: Class CRM_Activity_ActionMappingTest
CRM_Activity_AllTests: Class containing all test suites
CRM_Activity_BAO_ActivityAssignmentTest: Test class for CRM_Activity_BAO_ActivityAssignment BAO
CRM_Activity_BAO_ActivityTest: Class CRM_Activity_BAO_ActivityTest
CRM_Activity_BAO_ActivityTypeTest: Base class for CiviCRM unit tests
CRM_Activity_Form_ActivityTest: Include dataProvider for tests
CRM_Activity_Form_ActivityViewTest: Base class for CiviCRM unit tests
CRM_Activity_Form_SearchTest: Include dataProvider for tests
CRM_Activity_Form_Task_PDFTest: Class CRM_Activity_Form_Task_PDFLetterCommonTest
CRM_Activity_Import_Parser_ActivityTest: Test Activity Import Parser functions
CRM_Activity_Page_AJAXTest: Base class for CiviCRM unit tests
CRM_Activity_Selector_SearchTest: Class CRM_Activity_Selector_SearchTest
CRM_Admin_Form_PaymentProcessorTest: Base class for CiviCRM unit tests
CRM_Admin_Form_Setting_LocalizationTest: Base class for CiviCRM unit tests
CRM_AllTests: Class containing all CRM test suites
CRM_Batch_BAO_BatchTest: Test CRM/Batch/BAO/Batch.php getBatchFinancialItems
CRM_Batch_Form_EntryTest: Base class for CiviCRM unit tests
CRM_Bridge_OG_DrupalTest: Test contact custom search functions
CRM_Campaign_BAO_PetitionTest: Base class for CiviCRM unit tests
CRM_Campaign_BAO_QueryTest: Test APIv3 civicrm_contribute_* functions
CRM_Campaign_Form_CampaignTest: Base class for CiviCRM unit tests
CRM_Case_AllTests: Class containing all test suites
CRM_Case_BAO_CaseTest: Class CRM_Case_BAO_CaseTest
CRM_Case_BAO_CaseTypeForkTest: Case Types support an optional forking mechanism wherein the local admin creates a custom DB-based definition that deviates from the file-based definition.
CRM_Case_BAO_CaseTypeTest: Class CRM_Case_BAO_CaseTypeTest
CRM_Case_BAO_QueryTest: Include dataProvider for tests
CRM_Case_Form_CaseViewTest: Class CRM_Case_Form_CaseViewTest
CRM_Case_Form_ChangeStartDateTest: Class CiviReportTestCase
CRM_Case_Form_CustomDataTest: Class CRM_Case_Form_CustomDataTest
CRM_Case_Form_EmailTest: Class CiviReportTestCase
CRM_Case_Form_SearchTest: Class CRM_Case_Form_SearchTest
CRM_Case_Form_TaskTest: Class CRM_Case_Form_TaskTest
CRM_Case_PseudoConstantTest: Class CRM_Case_PseudoConstantTest
CRM_Case_WorkflowMessage_CaseActivityTest: Class CRM_Case_WorkflowMessage_CaseActivityTest
CRM_Case_WorkflowMessage_CaseActivityTestWorkflow_CaseAdhocExample: Helper class for defining WorkflowMessage example-data.
CRM_Case_WorkflowMessage_CaseActivityTestWorkflow_CaseModelExample: Helper class for defining WorkflowMessage example-data.
CRM_Case_WorkflowMessage_CaseActivityTestWorkflow: Sample to test test model architecture.
CRM_Case_XMLProcessor_ProcessTest: Class CRM_Case_PseudoConstantTest
CRM_Case_XMLProcessor_ReportTest: Class CRM_Case_XMLProcessor_ReportTest
CRM_Case_XMLProcessorTest: Class CRM_Case_XMLProcessorTest
CRM_Case_XMLRepositoryTest: Class CRM_Case_XMLRepositoryTest
CRM_Contact_AllTests: Class containing all test suites
CRM_Contact_BAO_ActivitySearchTest: Test APIv3 civicrm_activity_* functions
CRM_Contact_BAO_ContactTest: Class CRM_Contact_BAO_ContactTest
CRM_Contact_BAO_ContactType_ContactSearchTest: Class CRM_Contact_BAO_ContactType_ContactSearchTest
CRM_Contact_BAO_ContactType_ContactTest: Class CRM_Contact_BAO_ContactType_ContactTest
CRM_Contact_BAO_ContactType_ContactTypeTest: Class CRM_Contact_BAO_ContactType_ContactTypeTest
CRM_Contact_BAO_ContactType_RelationshipTest: Class CRM_Contact_BAO_ContactType_RelationshipTest
CRM_Contact_BAO_GroupContactCacheTest: Test class for CRM_Contact_BAO_GroupContact BAO
CRM_Contact_BAO_GroupContactTest: Test class for CRM_Contact_BAO_GroupContact BAO
CRM_Contact_BAO_GroupTest: Test class for CRM_Contact_BAO_Group BAO
CRM_Contact_BAO_IndividualTest: Class CRM_Contact_BAO_IndividualTest
CRM_Contact_BAO_QueryStateNameTest: Class CRM_Contact_BAO_QueryStateNameTest
CRM_Contact_BAO_QueryTest: Include dataProvider for tests
CRM_Contact_BAO_RelationshipCacheTest: Test class for CRM_Contact_BAO_RelationshipCache
CRM_Contact_BAO_RelationshipTest: Test class for CRM_Contact_BAO_Relationship
CRM_Contact_BAO_SavedSearchTest: Test class for CRM_Contact_BAO_Group BAO
CRM_Contact_Form_IndividualTest: Class CRM_Contact_Form_IndividualTest
CRM_Contact_Form_Search_BasicTest: Test class for CRM_Contact_Form_Basic
CRM_Contact_Form_Search_CriteriaTest: Test class for CRM_Contact_Form_Search_Criteria
CRM_Contact_Form_Search_SearchContactTest: Test class for CRM_Contact_BAO_Group BAO
CRM_Contact_Form_Task_AddToGroupTest: Base class for CiviCRM unit tests
CRM_Contact_Form_Task_DeleteTest: Base class for CiviCRM unit tests
CRM_Contact_Form_Task_EmailTest: Test class for CRM_Contact_Form_Task_Email.
CRM_Contact_Form_Task_PDFLetterCommonTest: Test class for CRM_Contact_Form_Task_PDFLetterCommon.
CRM_Contact_Form_Task_PrintDocumentTest: Test class for CRM_Contact_Form_Task_PDF.
CRM_Contact_Form_Task_PrintMailingLabelTest: Test class for CRM_Contact_Form_Task_Label.
CRM_Contact_Form_Task_SMSCommonTest: Test class for CRM_Contact_Form_Task_SMSCommon.
CRM_Contact_Form_Task_UseraddTest: Base class for CiviCRM unit tests
CRM_Contact_Import_Form_DataSourceTest: Test contact import datasource.
CRM_Contact_Import_Form_MapFieldTest: Test contact import map field.
CRM_Contact_Import_Parser_ContactTest: Test contact import parser.
CRM_Contact_Page_AjaxTest: Base class for CiviCRM unit tests
CRM_Contact_Page_DedupeExceptionTest: Test class for CRM_Contact_Page_DedupeException BAO
CRM_Contact_Page_View_UserDashboard_GroupContactTest: Test class for CRM_Contact_BAO_GroupContact BAO
CRM_Contact_Page_View_UserDashBoardTest: Test class for CRM_Contact_Page_View_UserDashBoard
CRM_Contact_SelectorTest: Test contact custom search functions
CRM_Contribute_ActionMapping_ByTypeTest: Class CRM_Contribute_ActionMapping_ByTypeTest
CRM_Contribute_AllTests: Class containing all test suites
CRM_Contribute_BAO_ContributionPageTest: Class CRM_Contribute_BAO_ContributionPageTest
CRM_Contribute_BAO_ContributionRecurTest: Class CRM_Contribute_BAO_ContributionRecurTest
CRM_Contribute_BAO_ContributionTest: Class CRM_Contribute_BAO_ContributionTest
CRM_Contribute_BAO_ContributionTypeTest: Class CRM_Contribute_BAO_ContributionTypeTest
CRM_Contribute_BAO_ProductTest: Class CRM_Contribute_BAO_ProductTest
CRM_Contribute_BAO_QueryTest: Include dataProvider for tests
CRM_Contribute_Form_AdditionalPaymentTest: Test APIv3 civicrm_contribute_* functions
CRM_Contribute_Form_CancelSubscriptionTest: Class CRM_Contribute_Form_UpdateSubscriptionTest
CRM_Contribute_Form_Contribution_ConfirmTest: Test APIv3 civicrm_contribute_* functions
CRM_Contribute_Form_Contribution_MainTest: Test APIv3 civicrm_contribute_* functions
CRM_Contribute_Form_Contribution_ThankYouTest: Test CRM_Contribute_Form_Contribution_ThankYou
CRM_Contribute_Form_ContributionPage_SettingsTest: Base class for CiviCRM unit tests
CRM_Contribute_Form_ContributionPageTranslationTest: Test ContributionPage translation features.
CRM_Contribute_Form_ContributionTest: Test APIv3 civicrm_contribute_* functions
CRM_Contribute_Form_ContributionViewTest: Base class for CiviCRM unit tests
CRM_Contribute_Form_SearchTest: Test Contribution Search form filters
CRM_Contribute_Form_Task_BatchTest: Base class for CiviCRM unit tests
CRM_Contribute_Form_Task_EmailTest: Test Email task.
CRM_Contribute_Form_Task_InvoiceTest: Test APIv3 civicrm_contribute_* functions
CRM_Contribute_Form_Task_PDFLetterCommonTest: Test APIv3 civicrm_contribute_* functions
CRM_Contribute_Form_Task_PDFTest: Test Email task.
CRM_Contribute_Form_Task_StatusTest: Class CRM_Contribute_Form_Task_StatusTest
CRM_Contribute_Form_TaskTest: Class CRM_Contribute_Form_TaskTest
CRM_Contribute_Form_UpdateSubscriptionTest: Class CRM_Contribute_Form_UpdateSubscriptionTest
CRM_Contribute_Import_Parser_ContributionTest: Test Contribution import parser.
CRM_Contribute_Page_AjaxTest: Class CRM_Contribute_Page_AjaxTest
CRM_Contribute_Page_TabTest: Class CRM_Contribute_Page_AjaxTest
CRM_Contribute_PseudoConstantTest: CRM_Contribute_PseudoConstantTest
CRM_Contribute_Selector_SearchTest: Class CRM_Contribute_Selector_SearchTest
CRM_Core_AllTests: Class containing all test suites
CRM_Core_BAO_ActionScheduleTest: Class CRM_Core_BAO_ActionScheduleTest.
CRM_Core_BAO_AddressTest: Class CRM_Core_BAO_AddressTest
CRM_Core_BAO_CacheTest: Class CRM_Core_BAO_CacheTest
CRM_Core_BAO_ConfigSettingTest: Class CiviReportTestCase
CRM_Core_BAO_CustomFieldTest: Class CRM_Core_BAO_CustomFieldTest
CRM_Core_BAO_CustomGroupTest: Class CRM_Core_BAO_CustomGroupTest
CRM_Core_BAO_CustomQueryTest: Include dataProvider for tests
CRM_Core_BAO_CustomValueTableMultipleTest: Class CRM_Core_BAO_CustomValueTableMultipleTest
CRM_Core_BAO_CustomValueTableSetGetTest: Class CRM_Core_BAO_CustomValueTableSetGetTest
CRM_Core_BAO_CustomValueTableTest: Class CRM_Core_BAO_CustomValueTableTest
CRM_Core_BAO_CustomValueTest: Class CRM_Core_BAO_CustomValueTest
CRM_Core_BAO_DiscountTest: Class CRM_Core_BAO_DiscountTest
CRM_Core_BAO_EmailTest: Class CRM_Core_BAO_EmailTest
CRM_Core_BAO_FileTest: Class CRM_Core_BAO_FileTest
CRM_Core_BAO_FinancialTrxnTest: Class CRM_Core_BAO_FinancialTrxnTest
CRM_Core_BAO_IMTest: Class CRM_Core_BAO_IMTest
CRM_Core_BAO_LocationTest: Class CRM_Core_BAO_LocationTest
CRM_Core_BAO_MappingTest: Class CRM_Core_BAO_MappingTest.
CRM_Core_BAO_MessageTemplateTest: Class CRM_Core_BAO_MessageTemplateTest
CRM_Core_BAO_NavigationTest: Class CRM_Core_BAO_NavigationTest.
CRM_Core_BAO_OpenIDTest: Class CRM_Core_BAO_OpenIDTest
CRM_Core_BAO_OptionGroupTest: Class CRM_Core_BAO_SchemaHandlerTest.
CRM_Core_BAO_OptionValueTest: Class CRM_Core_BAO_SchemaHandlerTest.
CRM_Core_BAO_PhoneTest: Class CRM_Core_BAO_PhoneTest
CRM_Core_BAO_PreferencesTest: Class CRM_Core_BAO_PreferencesTest
CRM_Core_BAO_PrevNextCacheTest: Class CRM_Core_BAO_PrevNextCacheTest
CRM_Core_BAO_RecurringEntityTest: Class CRM_Core_BAO_RecurringEntityTest
CRM_Core_BAO_SchemaHandlerTest: Class CRM_Core_BAO_SchemaHandlerTest.
CRM_Core_BAO_SettingTest: Class CRM_Core_BAO_SettingTest
CRM_Core_BAO_TagTest: Class CRM_Core_BAO_TagTest
CRM_Core_BAO_UFFieldTest: Class CRM_Core_BAO_UFFieldTest
CRM_Core_BAO_UFGroupTest: Class CRM_Core_BAO_UFGroupTest.
CRM_Core_BAO_UFMatchTest: Class CRM_Core_BAO_UFMatchTest
CRM_Core_CommunityMessagesTest: Class CRM_Core_CommunityMessagesTest
CRM_Core_ComposerConfigTest: Class CRM_Core_ComposerConfigTest
CRM_Core_Config_MagicMergeTest: Class CRM_Core_Config_MagicMergeTest
CRM_Core_Config_MailerTest: Class CRM_Core_Config_MailerTest
CRM_Core_CopyTest: Base class for CiviCRM unit tests
CRM_Core_DAO_AllCoreTablesTest: Class CRM_Core_DAO_AllCoreTablesTest
CRM_Core_DAOConformanceTest: Class for testing new DAO meet required standards.
CRM_Core_DAOTest: Class CRM_Core_DAOTest
CRM_Core_ErrorTest: Tests for linking to resource files
CRM_Core_FieldOptionsTest: Tests for field options
CRM_Core_FormTest: Base class for CiviCRM unit tests
CRM_Core_I18n_LocaleTest: Class CRM_Core_I18n_LocaleTest
CRM_Core_I18n_SchemaStructureTest: Class CRM_Core_I18n_SchemaTest
CRM_Core_I18n_SchemaTest: Class CRM_Core_I18n_SchemaTest
CRM_Core_InvokeTest: Base class for CiviCRM unit tests
CRM_Core_JobManagerTest: Class CRM_Core_JobManagerTest
CRM_Core_KeyTest: Class CRM_Core_KeyTest
CRM_Core_ManagedEntitiesTest: Class CRM_Core_ManagedEntitiesTest
CRM_Core_MenuTest: Class CRM_Core_MenuTest
CRM_Core_OptionGroupTest: Tests for field options
CRM_Core_Page_AJAXTest: Class CRM_Core_Page_AJAXTest
CRM_Core_Page_HookTest: Test that page hooks only get invoked once per page run.
CRM_Core_Page_Inline_HelpTest: Class CRM_Core_Page_Inline_HelpTest
CRM_Core_Page_RedirectTest: Class CRM_Core_Page_RedirectTest
CRM_Core_PageTest: Class CRM_Core_PageTest
CRM_Core_Payment_AuthorizeNetIPNTest: Class CRM_Core_Payment_PayPalProIPNTest
CRM_Core_Payment_AuthorizeNetTest: Class CRM_Core_Payment_AuthorizeNetTest
CRM_Core_Payment_BaseIPNTest: Class CRM_Core_Payment_BaseIPNTest
CRM_Core_Payment_PayPalIPNTest: Class CRM_Core_Payment_PayPalProIPNTest
CRM_Core_Payment_PayPalProIPNTest: Class CRM_Core_Payment_PayPalProIPNTest
CRM_Core_Payment_PaypalProTest: Class CRM_Core_Payment_PaypalPro
CRM_Core_Payment_PaypalStdTest: Class CRM_Core_Payment_PaypalPro
CRM_Core_Payment_ProcessorFormTest: Class CRM_Core_Payment_ProcessorFormTest
PaymentProcessorWithStandardBillingRequirements: Class CRM_Core_Payment.
PaymentProcessorWithCustomBillingRequirements: Class CRM_Core_Payment.
CRM_Core_PaymentTest: Class CRM_Core_PaymentTest
CRM_Core_Permission_BaseTest: Class CRM_Core_Permission_BaseTest
CRM_Core_Permission_GenericTest: Class CRM_Core_Permission_GenericTest
CRM_Core_Permission_JoomlaTest: Class CRM_Core_Permission_JoomlaTest
CRM_Core_PseudoConstantTest: Tests for pseudoconstant retrieval
CRM_Core_RegionTest: Class CRM_Core_RegionTest
CRM_Core_Resources_BundleTest: Tests for manipulating bundles
CRM_Core_Resources_StringsTest: Tests for parsing translatable strings in HTML content.
CRM_Core_ResourcesTest: Tests for linking to resource files
CRM_Core_SessionTest: Class CRM_Core_SessionTest
CRM_Core_Smarty_plugins_CrmMoneyTest: Class CRM_Core_Smarty_plugins_CrmMoneyTest
CRM_Core_Smarty_plugins_CrmPermissionTest: Class CRM_Core_Smarty_plugins_CrmMoneyTest
CRM_Core_Smarty_plugins_CrmRSSPubDateTest: Class CRM_Core_Smarty_plugins_CrmRSSPubDateTest
CRM_Core_Smarty_plugins_CrmScopeTest: Class CRM_Core_Smarty_plugins_CrmScopeTest
CRM_Core_Smarty_plugins_CrmUpperTest: Class CRM_Core_Smarty_plugins_CrmUpperTest
CRM_Core_Smarty_plugins_HtxtTest: Class CRM_Core_Smarty_plugins_CrmScopeTest
CRM_Core_Smarty_plugins_UrlTest: Class CRM_Core_Smarty_plugins_UrlTest
CRM_Core_SmartyTest: Class CRM_Core_SmartyTest
CRM_Core_TokenSmartyTest: The Token-Smarty template notation is a hybrid notation that combines `{entity.field}` tokens and `{$smarty.expressions}`. At time of writing, this notation is commonly used with MessageTemplates.
CRM_Core_TransactionTest: Class CRM_Core_TransactionTest
CRM_Custom_Form_FieldTest: Class CRM_Custom_Form_FieldTest
CRM_Custom_Form_OptionTest: Class CRM_Custom_Form_OptionTest
CRM_Custom_Import_Parser_ApiTest: Test Contribution import parser.
CRM_Custom_Page_AJAXTest: Class CRM_Custom_Page_AJAXTest
CRM_Dedupe_DAO_TestEntity: Class CRM_Core_DAO
CRM_Dedupe_BAO_RuleGroupTest: Class CRM_Dedupe_BAO_RuleGroupTest
CRM_Dedupe_DedupeFinderTest: Class CRM_Dedupe_DedupeFinderTest
CRM_Dedupe_MergerTest: Class CRM_Dedupe_DedupeMergerTest
CRM_Event_ActionMappingTest: Class CRM_Event_ActionMappingTest
CRM_Event_AllTests: Class containing all test suites
CRM_Event_BAO_AdditionalPaymentTest: Class CRM_Event_BAO_AdditionalPaymentTest
CRM_Event_BAO_ChangeFeeSelectionTest: Class CRM_Event_BAO_AdditionalPaymentTest
CRM_Event_BAO_EventPermissionsTest: Class CRM_Event_BAO_EventPermissionsTest
CRM_Event_BAO_ParticipantStatusTest: Test class for CRM_Event_BAO_ParticipantStatus BAO
CRM_Event_BAO_ParticipantTest: Class CRM_Event_BAO_ParticipantTest
CRM_Event_BAO_QueryTest: Base class for CiviCRM unit tests
CRM_Event_Form_ManageEvent_EventInfoTest: Base class for CiviCRM unit tests
CRM_Event_Form_ManageEvent_LocationTest: Test CRM_Event_Form_Registration functions.
CRM_Event_Form_ManageEvent_RegistrationTest: Base class for CiviCRM unit tests
CRM_Event_Form_ParticipantTest: Test CRM_Event_Form_Registration functions.
CRM_Event_Form_Registration_ConfirmTest: Test CRM_Event_Form_Registration functions.
CRM_Event_Form_Registration_RegisterTest: Class CRM_Event_Form_Registration_RegisterTest
CRM_Event_Form_SearchTest: Base class for CiviCRM unit tests
CRM_Event_Form_SelfSvcTransferTest: Test CRM_Event_Form_Registration functions.
CRM_Event_Form_SelfSvcUpdateTest: Test CRM_Event_Form_Registration functions.
CRM_Event_Form_Task_BadgeTest: Test CRM_Event_Form_Registration functions.
CRM_Event_Form_Task_BatchTest: Test CRM_Event_Form_Registration functions.
CRM_Event_Form_Task_RegisterTest: Test CRM_Event_Form_Registration functions.
CRM_Event_Import_Parser_ParticipantTest: Base class for CiviCRM unit tests
CRM_Event_Page_EventInfoTest: Base class for CiviCRM unit tests
CRM_Export_BAO_ExportTest: Class CRM_Core_DAOTest
CRM_Extension_AllTests: Class containing all test suites
CRM_Extension_BrowserTest: Class CRM_Extension_BrowserTest
CRM_Extension_Container_AllTests: Class containing all test suites
CRM_Extension_Container_BasicTest: Class CRM_Extension_Container_BasicTest
CRM_Extension_Container_CollectionTest: Class CRM_Extension_Container_CollectionTest
CRM_Extension_Container_StaticTest: Class CRM_Extension_Container_StaticTest
CRM_Extension_InfoTest: Class CRM_Extension_InfoTest
CRM_Extension_Manager_AllTests: Class containing all test suites
CRM_Extension_Manager_ModuleTest: Class CRM_Extension_Manager_ModuleTest
CRM_Extension_Manager_ModuleUpgTest: Class CRM_Extension_Manager_ModuleUpgTest
CRM_Extension_Manager_PaymentTest: Class CRM_Extension_Manager_PaymentTest
CRM_Extension_Manager_ReportTest: Class CRM_Extension_Manager_ReportTest
CRM_Extension_Manager_SearchTest: Class CRM_Extension_Manager_SearchTest
CRM_Extension_ManagerTest: Class CRM_Extension_ManagerTest
CRM_Extension_MapperTest: Class CRM_Extension_MapperTest
CRM_Financial_BAO_FinancialAccountTest: Class CRM_Financial_BAO_FinancialAccountTest
CRM_Financial_BAO_FinancialItemTest: Class CRM_Financial_BAO_FinancialItemTest
CRM_Financial_BAO_FinancialTypeAccountTest: Class CRM_Financial_BAO_FinancialTypeAccountTest
CRM_Financial_BAO_FinancialTypeTest: Class CRM_Financial_BAO_FinancialTypeTest
CRM_Financial_BAO_OrderTest: Class CRM_Financial_BAO_OrderTest
CRM_Financial_BAO_PaymentProcessorTest: Class CRM_Financial_BAO_PaymentProcessorTypeTest
CRM_Financial_BAO_PaymentProcessorTypeTest: Class CRM_Financial_BAO_PaymentProcessorTypeTest
CRM_Financial_Form_PaymentEditTest: Test PaymentEdit form submission
CRM_Financial_Form_PaymentFormsTest: Test various payment forms.
CRM_Financial_Page_AjaxBatchSummaryTest: Test for CRM_Financial_Page_Ajax class.
CRM_Financial_Page_AjaxTest: Test for CRM_Financial_Page_Ajax class.
CRM_Group_Page_AjaxTest: Class CRM_Group_Page_AjaxTest
CRM_Import_DataSource_CsvTest: Tests for the CRM_Import_Datasource_Csv class.
CRM_Import_FormsTest: Test various forms extending CRM_Import_Forms.
CRM_Logging_LoggingTest: Class CRM_Core_DAOTest
CRM_Logging_SchemaTest: Class CRM_Logging_SchmeaTest
CRM_Mailing_BAO_ConfirmTest: Class CRM_Mailing_BAO_MailingTest
CRM_Mailing_BAO_MailingJobTest: Class CRM_Mailing_BAO_MailingTest
CRM_Mailing_BAO_MailingTest: Class CRM_Mailing_BAO_MailingTest
CRM_Mailing_BAO_QueryTest: Include dataProvider for tests
CRM_Mailing_BAO_QueryTestDataProvider: Provide data to the CRM_Mailing_BAO_QueryTest class
CRM_Mailing_BAO_SpoolTest: Class CRM_Mailing_BAO_SpoolTest
CRM_Mailing_Form_Task_AdhocMailingTest: Test class for CRM_Mailing_Form_Task_AdhocMailing.
CRM_Mailing_Form_UnsubscribeTest: Test class for CRM_Mailing_Form_Unsubscribe.
CRM_Mailing_MailingSystemTest: Class CRM_Mailing_MailingSystemTest.
CRM_Mailing_MailingSystemTestBase: Class CRM_Mailing_MailingSystemTest
CRM_Mailing_MailingUnsubscribeTest: Class CRM_Mailing_MailingUnsubscribeTest
CRM_Mailing_MailStoreTest: Base class for CiviCRM unit tests
CRM_Mailing_MultilingualSystemTest: Base class for CiviCRM unit tests
CRM_Mailing_TokensTest: Base class for CiviCRM unit tests
CRM_Member_AllTests: Class containing all test suites
CRM_Member_BAO_MembershipLogTest: Test CRM/Member/BAO Membership Log add , delete functions
CRM_Member_BAO_MembershipStatusTest: Class CRM_Member_BAO_MembershipStatusTest
CRM_Member_BAO_MembershipTest: Class CRM_Member_BAO_MembershipTest
CRM_Member_BAO_MembershipTypeTest: Class CRM_Member_BAO_MembershipTypeTest
CRM_Member_BAO_QueryTest: Include dataProvider for tests
CRM_Member_Form_AllTests: Class containing all test suites
CRM_Member_Form_MembershipRenewalTest: Test CRM_Member_Form_Membership functions.
CRM_Member_Form_MembershipTest: Test CRM_Member_Form_Membership functions.
CRM_Member_Form_Task_BatchTest: Base class for CiviCRM unit tests
CRM_Member_Form_Task_LabelTest: Base class for CiviCRM unit tests
CRM_Member_Form_Task_PDFLetterTest: Base class for CiviCRM unit tests
CRM_Member_Import_Parser_MembershipTest: Base class for CiviCRM unit tests
CRM_Member_Page_MembershipTypeTest: Test CRM_Member_Form_Membership functions.
CRM_Member_Selector_SearchTest: Class CRM_Member_BAO_MembershipTest
CRM_Member_StatusOverrideTypesTest: Class CRM_Member_BAO_MembershipTest
CRM_Member_TaskTest: Class CRM_Member_BAO_MembershipTest
CRM_PCP_BAO_PCPTest: Test class for CRM_PCP_BAO_PCPTest BAO
CRM_Pledge_AllTests: Class containing all test suites
CRM_Pledge_BAO_PledgeBlockTest: Test class for CRM_Pledge_BAO_PledgeBlock BAO
CRM_Pledge_BAO_PledgePaymentTest: Test class for CRM_Pledge_BAO_PledgePayment BAO
CRM_Pledge_BAO_PledgeTest: Test class for CRM_Pledge_BAO_Pledge BAO
CRM_Pledge_Form_PledgeTest: CRM_Pledge_Form_PledgeTest
CRM_Pledge_Form_SearchTest: Include dataProvider for tests
CRM_Price_BAO_PriceFieldTest: Test class for CRM_Price_BAO_PriceField.
CRM_Price_BAO_PriceFieldValueTest: Test class for CRM_Price_BAO_PriceSet.
CRM_Price_BAO_PriceSetTest: Test class for CRM_Price_BAO_PriceSet.
CRM_Price_Form_FieldTest: Base class for CiviCRM unit tests
CRM_Price_Form_OptionTest: Base class for CiviCRM unit tests
CRM_Profile_Form_EditTest: Test class for CRM_Price_BAO_PriceSet.
CRM_Queue_AllTests: Class containing all test suites
CRM_Queue_Queue_AllTests: Class containing all test suites
CRM_Queue_Queue_SqlTest: Ensure that the extended interface for SQL-backed queues work. For example, the createItem() interface supports priority-queueing.
CRM_Queue_QueueTest: Ensure that various queue implementations comply with the interface
CRM_Queue_RunnerTest: Ensure that various queue implementations comply with the interface
CRM_Report_Form_ActivityTest: Test Activity report outcome
CRM_Report_Form_Contact_LoggingDetailTest: Test Activity report outcome
CRM_Report_Form_ContactSummaryTest: Test Contact Summary report outcome
CRM_Report_Form_Contribute_DetailTest: Test report outcome
CRM_Report_Form_Member_DetailTest: Test Activity report outcome
CRM_Report_Form_SampleForm: Helper class to simulate a report form but allow us access to some protected fields for tests.
CRM_Report_Form_TestCaseTest: Verify that the CiviReportTestCase provides a working set of primitives for tests. Do this by running various scenarios that should yield positive and negative results.
CRM_Report_FormTest: Test CRM_Report_Form functions.
CRM_Report_Utils_ReportTest: Test CRM_Report_Utils_Report functions.
CRM_SMS_BAO_ProviderTest: Test CRM_SMS_BAO_SmsProvider functions
CRM_SMS_PreviewTest: Test SMS Preview
CRM_SMS_ProviderTest: Base class for CiviCRM unit tests
CRM_UF_Page_ProfileEditorTest: Class CRM_UF_Page_ProfileEditorTest
CRM_Upgrade_FormTest: Class CRM_Upgrade_FormTest
CRM_Upgrade_Incremental_BaseTest: Base class for CiviCRM unit tests
CRM_Upgrade_Incremental_php_FiveFiftyFiveTest: Class CRM_Upgrade_Incremental_php_FiveFiftyFiveTest
CRM_Upgrade_Incremental_php_FiveSixtyFourTest: Class CRM_Upgrade_Incremental_php_FiveSixtyFour
CRM_Upgrade_Incremental_php_FiveTwentyTest: Class CRM_Upgrade_Incremental_php_FiveTwentyTest
CRM_Upgrade_SnapshotTest: Class CRM_Upgrade_SnapshotTest
CRM_Utils_AddressTest: Class CRM_Utils_AddressTest
CRM_Utils_API_MatchOptionTest: Test that the API accepts the 'match' and 'match-mandatory' options.
CRM_Utils_API_ReloadOptionTest: Test that the API accepts the 'reload' option.
CRM_Utils_ArrayTest: Class CRM_Utils_ArrayTest
CRM_Utils_AutoCleanTest: Class CRM_Utils_AutoCleanTest
CRM_Utils_Cache_AllTests: Class containing all test suites.
CRM_Utils_Cache_SqlGroupTest: Class CRM_Utils_Cache_SqlGroupTest
CRM_Utils_CacheTest: Class CRM_Utils_CacheTest
CRM_Utils_Check_Component_EnvTest: Class CRM_Utils_Check_Component_EnvTest
CRM_Utils_Check_Component_OptionGroupsTest: Class CRM_Utils_TypeTest
CRM_Utils_ColorTest: Class CRM_Utils_ColorTest
CRM_Utils_DateTest: Test CRM_Utils_Date functions.
CRM_Utils_EnglishNumberTest: Class CRM_Utils_EnglishNumberTest
CRM_Utils_FileTest: Class CRM_Utils_FileTest
CRM_Utils_Geocode_TestProvider
CRM_Utils_GlobalStackTest: Class CRM_Utils_GlobalStackTest
CRM_Utils_HookTest: Class CRM_Utils_HookTest
CRM_Utils_HTMLTest: Tests for parsing translatable strings in HTML content.
CRM_Utils_HtmlToTextTest: Class CRM_Utils_HtmlToTextTest
CRM_Utils_HttpClientTest: Class CRM_Utils_HttpClientTest
CRM_Utils_ICalendarTest: Tests for linking to resource files
CRM_Utils_JSTest: Tests for linking to resource files
CRM_Utils_LazyArrayTest: Class CRM_Utils_LazyArrayTest
CRM_Utils_Mail_EmailProcessorInboundTest: Class CRM_Utils_Mail_EmailProcessorInboundTest
CRM_Utils_Mail_EmailProcessorTest: Class CRM_Utils_Mail_EmailProcessorTest
CRM_Utils_Mail_FilteredPearMailerTest: Class CRM_Utils_Mail_FilteredPearMailerTest
CRM_Utils_Mail_IncomingTest: Class for testing CRM_Utils_Mail_Incoming.
CRM_Utils_MailTest: Class CRM_Utils_MailTest
CRM_Utils_Migrate_ImportExportTest: Class CRM_Utils_Migrate_ImportExportTest
CRM_Utils_MoneyTest: Class CRM_Utils_RuleTest
CRM_Utils_NumberTest: Class CRM_Utils_NumberTest
CRM_Utils_PDF_UtilsTest: Class CRM_Utils_PDF_UtilsTest
CRM_Utils_RestTest: Class CRM_Utils_RestTest
CRM_Utils_RuleTest: Class CRM_Utils_RuleTest
CRM_Utils_SignerTest: Class CRM_Utils_SignerTest
CRM_Utils_SQL_DeleteTest: Class CRM_Utils_SQL_DeleteTest
CRM_Utils_SQL_InsertTest: Class CRM_Utils_SQL_SelectTest
CRM_Utils_SQL_SelectTest: Class CRM_Utils_SQL_SelectTest
CRM_Utils_SQLTest: Class CRM_Utils_SQLTest
CRM_Utils_StringTest: Class CRM_Utils_StringTest
CRM_Utils_SystemTest: Class CRM_Utils_SystemTest
CRM_Utils_TimeTest: Class CRM_Utils_TimeTest
CRM_Utils_TokenConsistencyTest: CRM_Utils_TokenConsistencyTest
CRM_Utils_TokenTest: Class CRM_Utils_TokenTest
CRM_Utils_TypeTest: Class CRM_Utils_TypeTest
CRM_Utils_UrlTest: Class CRM_Utils_UrlTest
CRM_Utils_versionCheckTest: Class CRM_Utils_versionCheckTest
CRM_Utils_XMLTest: Class CRM_Utils_XMLTest
CRM_Utils_ZipTest: Class CRM_Utils_ZipTest
E2E_AllTests: Class containing all CRM test suites
E2E_Cache_APCcacheTest: Verify that CRM_Utils_Cache_APCcache complies with PSR-16.
E2E_Cache_APCucacheTest: Verify that CRM_Utils_Cache_APCucache complies with PSR-16.
E2E_Cache_ArrayCacheTest: Verify that CRM_Utils_Cache_ArrayCache complies with PSR-16.
E2E_Cache_ArrayDecoratorTest: Verify that CRM_Utils_Cache_ArrayDecorator complies with PSR-16.
E2E_Cache_CacheTestCase: Verify that a cache service complies with PSR-16.
E2E_Cache_ConfiguredMemoryTest: Verify that CRM_Utils_Cache_{Redis,Memcache} complies with PSR-16.
E2E_Cache_FastArrayDecoratorTest: Verify that CRM_Utils_Cache_FastArrayDecorator complies with PSR-16.
E2E_Cache_SqlGroupTest: Verify that CRM_Utils_Cache_SqlGroup complies with PSR-16.
E2E_Cache_TieredTest: Verify that CRM_Utils_Cache_Tiered complies with PSR-16.
E2E_Cache_TwoInstancesTest: If you make two instances of a cache driver, do they coexist as you would expect?
E2E_Extern_AuthxRestTest: Verify that the REST API bindings correctly parse and authenticate requests.
E2E_Extern_BaseRestTest: Verify that the REST API bindings correctly parse and authenticate requests.
E2E_Extern_CliRunnerTest: Check that various CLI runners are able to bootstrap an environment with reasonable paths.
E2E_Extern_LegacyRestTest: Verify that the REST API bindings correctly parse and authenticate requests.
E2E_Extern_WidgetTest: Verify Contribution Page Widget endpoint works correctly.
EnvTests: The EnvTests suite allows you to specify an arbitrary mix of tests using an environment variable. For example:
HelloTest: Class HelloTest
CRM_EventCheck_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CRM_Demoqueue_Page_DemoQueue: An example page which queues several tasks and then executes them
CRM_Demoqueue_Page_DemoQueueDone: Class CRM_Demoqueue_Page_DemoQueueDone
CRM_PhpStorm_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
Mixlib: The Mixlib class is a utility for downloading/listing available mixins.
StandaloneRouter: The StandaloneRouter allows you to run CiviCRM's "Standalone" UF with the PHP built-in server.

Traits

CRM_Activity_Form_ActivityFormTrait: Trait implements functions to retrieve activity related values.
CRM_Admin_Form_SettingTrait: This trait allows us to consolidate Preferences & Settings forms.
CRM_Campaign_Form_CampaignFormTrait: Trait implements functions to retrieve activity related values.
CRM_Case_Form_CaseFormTrait: Trait implements functions to retrieve activity related values.
CRM_Contact_AccessTrait: Trait shared with entities attached to the contact record.
CRM_Contact_Form_ContactFormTrait: Trait implements getContactValue + overridable getContactID functions.
CRM_Contact_Form_Task_EmailTrait: This class provides the common functionality for tasks that send emails.
CRM_Contact_Form_Task_PDFTrait: This class provides the common functionality for tasks that send emails.
CRM_Contact_Form_Task_SMSTrait: This trait provides the common functionality for tasks that send sms.
CRM_Contact_Import_MetadataTrait: Trait CRM_Contact_Import_MetadataTrait
CRM_Contribute_Form_ContributeFormTrait: Trait implements functions to retrieve contribution related values.
CRM_Contribute_Form_Task_TaskTrait: This class provides shared contribution task functionality.
CRM_Contribute_WorkflowMessage_ContributionTrait
CRM_Contribute_WorkflowMessage_RecurringTrait
CRM_Core_DynamicFKAccessTrait: Trait for with entities with an entity_table + entity_id dynamic FK.
CRM_Core_Form_EntityFormTrait
CRM_Core_Page_EntityPageTrait
CRM_Core_Resources_CollectionAdderTrait: Class CRM_Core_Resources_CollectionTrait
CRM_Core_Resources_CollectionTrait: Class CRM_Core_Resources_CollectionTrait
CRM_Core_TokenTrait
CRM_Core_WorkflowMessage_ProfileTrait: Trait for participant workflow classes.
CRM_Event_Form_EventFormTrait: Trait implements getContactValue + overridable getContactID functions.
CRM_Event_WorkflowMessage_ParticipantTrait: Trait for participant workflow classes.
CRM_Extension_Upgrader_IdentityTrait: Track minimal information which identifies the target extension.
CRM_Extension_Upgrader_QueueTrait: The QueueTrait provides helper methods for adding new tasks to a queue.
CRM_Extension_Upgrader_RevisionsTrait: The revisions trait automatically enqueues any functions named 'upgrade_NNNN()' (where NNNN is taken to be a revision number).
CRM_Extension_Upgrader_SchemaTrait: The SchemaTrait provides utilities for altering tables during an upgrade.
CRM_Extension_Upgrader_TasksTrait: The TasksTrait provides a library of tasks that are useful to run during an upgrade.
CRM_Financial_Form_FrontEndPaymentFormTrait: This class holds functionality shared between various front end forms.
CRM_Financial_Form_PaymentProcessorFormTrait: Trait implements functions to retrieve payment processor related values.
CRM_Financial_Form_SalesTaxTrait
CRM_Member_Form_MembershipFormTrait: Trait implements functions to retrieve membership related values.
CRM_Member_WorkflowMessage_MembershipTrait
CRM_Pledge_Form_PledgeFormTrait: Trait implements getContactValue + overridable getContactID functions.
CRM_Queue_Queue_SqlTrait: Trait defines methods that are commonly used to implement a SQL-backed queue.
CRM_Upgrade_Incremental_php_TimezoneRevertTrait: Circa v5.47.x-5.48.x, the `civicrm_event.event_tz` columns were introduced. But there were still significant issues.
CRM_Utils_Cache_NaiveHasTrait
CRM_Utils_Cache_NaiveMultipleTrait
CRM_Utils_SQL_EscapeStringTrait
CRM_Core_Payment_AuthorizeNetTrait: Class CRM_Core_Payment_AuthorizeNetTest
CRM_Core_Payment_PaypalProTrait: Class CRM_Core_Payment_AuthorizeNetTest
CRM_Core_Resources_CollectionTestTrait: Class CRM_Core_Resources_CollectionTestTrait
CRMTraits_Contribute_RecurFormsTrait: Trait CRMTraits_Contribute_RecurFormsTrait
CRMTraits_Custom_CustomDataTrait: Trait Custom Data trait.
CRMTraits_Event_ScenarioTrait: Trait to do set up for event scenarios.
CRMTraits_Financial_FinancialACLTrait: Trait FinancialACLTrait
CRMTraits_Financial_OrderTrait: Trait OrderTrait
CRMTraits_Financial_PriceSetTrait: Trait PriceSetTrait
CRMTraits_Financial_TaxTrait: Trait TaxTrait
CRMTraits_Import_ParserTrait: Trait ParserTrait
CRMTraits_Page_PageTestTrait: Trait CRMTraits_Page_PageTestTrait
CRMTraits_PCP_PCPTestTrait: Trait CRMTraits_PCP_PCPTestTrait
CRMTraits_Profile_ProfileTrait: Trait PriceSetTrait

Constants

_CIVICRM_FAKE_SESSION = TRUE
_JEXEC = 1
AFFORM_HTML_MONACO = 'bower_components/monaco-editor/min/vs'
API_LATEST_VERSION = 3
API_V3_EXTENSION_DELIMITER = ','
BACKDROP_ROOT = $cmsPath
BACKDROP_ROOT = getcwd()
BLOCK_CACHE_GLOBAL = 0x8
BLOCK_CACHE_PER_PAGE = 0x4
BLOCK_NO_CACHE = -1
CHUNK_SIZE = 128
CHUNK_SIZE = 128
CHUNK_SIZE = 128
CIVI_SETUP = 1
CIVICRM_CONTAINER_CACHE = 'never'
CIVICRM_DSN = $composedDsn
CIVICRM_HIBP_URL = 'https://api.pwnedpasswords.com/range/'
CIVICRM_IFRAME = 1
CIVICRM_IFRAME = 1
CIVICRM_IFRAME = 1
CIVICRM_L10N_BASEDIR = \getenv('CIVICRM_L10N_BASEDIR') ? \getenv('CIVICRM_L10N_BASEDIR') : (__DIR__ . '/../l10n')
CIVICRM_L10N_BASEDIR = \getenv('CIVICRM_L10N_BASEDIR') ? \getenv('CIVICRM_L10N_BASEDIR') : (__DIR__ . '/../l10n')
CIVICRM_SETTINGS_PATH = $config['conf_path'] . '/civicrm.settings.php'
CIVICRM_SETTINGS_PATH = $settingsPath
CIVICRM_TEMPLATE_COMPILEDIR = $model->templateCompilePath
CIVICRM_TEST = 1
CIVICRM_TEST = 1
CIVICRM_TEST = 1
CIVICRM_UF = 'Joomla'
CIVICRM_UF = 'Drupal'
CIVICRM_UF = $model->cms
CIVICRM_UF = 'Drupal'
CIVICRM_UF_BASEURL = '/'
CIVICRM_UF_BASEURL = $model->cmsBaseUrl
CIVICRM_UF_BASEURL = '/'
DB_DSN_MODE = 'auto'
DRUPAL_ROOT = $cmsPath
DRUPAL_ROOT = getcwd()
DS = DIRECTORY_SEPARATOR
JDEBUG = FALSE
JPATH_BASE = $joomlaBase . DS . 'administrator'
JVERSION = $jversion->getShortVersion()
MAIL_BATCH_SIZE = 50
RECAPTCHA_API_SECURE_SERVER = "https://www.google.com/recaptcha/api.js"
RECAPTCHA_API_SERVER = "http://www.google.com/recaptcha/api.js": The reCAPTCHA server URL's
RECAPTCHA_VERIFY_SERVER = "https://www.google.com"
WP_USE_THEMES = FALSE

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_cxn_register_spec() : mixed: Adjust metadata for "register" action.
civicrm_api3_cxn_register() : array<string|int, mixed>: Register with a remote application and create a new connection.
_civicrm_api3_cxn_unregister_spec() : mixed: Adjust metadata for cxn unregister.
civicrm_api3_cxn_unregister() : array<string|int, mixed>: Unregister with a remote application; destroy an existing connection.
_civicrm_api3_cxn_parseCxnId() : string
_civicrm_api3_cxn_get_spec() : mixed: Adjust metadata for cxn get action.
civicrm_api3_cxn_get() : array<string|int, mixed>: Returns an array of Cxn records.
_civicrm_api3_cxn_getlink_spec() : mixed: Adjust metadata for "getlink" action.
civicrm_api3_cxn_getlink() : array<string|int, mixed>
civicrm_api3_cxn_getcfg() : array<string|int, mixed>
civicrm_api3_cxn_create() : page: Creates or modifies a Cxn row.
_civicrm_api3_cxn_app_get_spec() : mixed: Adjust metadata for "register" action.
civicrm_api3_cxn_app_get() : array<string|int, mixed>: Get a list of applications available for connections.
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_deprecation() : array<string|int, mixed>: Get list of deprecated entities.
civicrm_api3_entity_create() : array<string|int, mixed>: Placeholder function.
civicrm_api3_entity_delete() : array<string|int, mixed>: Placeholder function.
civicrm_api3_entity_getfields() : array<string|int, mixed>: Placeholder function.
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_exception_get() : array<string|int, mixed>: Get a Dedupe Exception.
civicrm_api3_exception_create() : array<string|int, mixed>: Create or update an dedupe exception.
civicrm_api3_exception_delete() : array<string|int, mixed>: Delete an existing Exception.
civicrm_api3_extension_install() : array<string|int, mixed>: Install an extension.
_civicrm_api3_extension_install_spec() : mixed: Spec function for getfields
civicrm_api3_extension_upgrade() : array<string|int, mixed>: Upgrade an extension - runs upgrade_N hooks and system.flush.
civicrm_api3_extension_enable() : array<string|int, mixed>: Enable an extension.
_civicrm_api3_extension_enable_spec() : mixed: Spec function for getfields
civicrm_api3_extension_disable() : array<string|int, mixed>: Disable an extension.
_civicrm_api3_extension_disable_spec() : mixed: Spec function for getfields
civicrm_api3_extension_uninstall() : array<string|int, mixed>: Uninstall an extension.
_civicrm_api3_extension_uninstall_spec() : mixed: Spec function for getfields
civicrm_api3_extension_download() : array<string|int, mixed>: Download and install an extension.
_civicrm_api3_extension_download_spec() : mixed: Spec function for getfields
civicrm_api3_extension_refresh() : array<string|int, mixed>: Download and install an extension.
_civicrm_api3_extension_refresh_spec() : mixed: Spec function for getfields
civicrm_api3_extension_get() : array<string|int, mixed>: Get a list of available extensions.
civicrm_api3_extension_getremote() : array<string|int, mixed>: Get a list of remotely available extensions.
_civicrm_api3_getKeys() : array<string|int, mixed>: Determine the list of extension keys.
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_job_log_get() : array<string|int, mixed>: Retrieve one or more job log record.
civicrm_api3_job_log_create() : array<string|int, mixed>: Create one or more job log record.
civicrm_api3_job_log_delete() : array<string|int, mixed>: Delete one or more job log record.
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.
run() : mixed
run() : mixed
run() : mixed
run() : mixed
run() : mixed
_civicrm_api3_permissions() : array<string|int, mixed>: Decide what permissions to check for an api call
smarty_block_crmButton() : string|null: Generate the html for a button-style link
smarty_block_crmPermission() : string: Show block conditionally, based on the permission
smarty_block_crmRegion() : string: Smarty block function for defining content-regions which can be dynamically-altered
smarty_block_crmScope() : string: Smarty block function to temporarily define variables.
smarty_block_crmUpgradeSnapshot() : string|null: Generate a pre-upgrade data-snapshot -- if the local policy supports them.
smarty_block_edit() : string|null: Smarty block function providing edit-only display support
smarty_block_htxt() : string|null: Smarty block function providing support for CiviCRM's helptext mechanism
smarty_block_icon() : string|null: Display an icon with some alternative text.
smarty_block_localize() : string: Smarty block function for multilingualizing upgrade SQL queries.
smarty_block_ts() : string|null: Smarty block function providing gettext support
smarty_block_url() : string: Generate a URL. This is thin wrapper for the Civi::url() helper.
smarty_compiler_continue() : string: Skip remaining logic in the current iteration of a loop.
smarty_function_copyIcon() : string: Display a copy icon that copies the first row's values down.
smarty_function_crmAPI() : string|void
smarty_function_crmAttributes() : string: Formats an array of attributes as html
smarty_function_crmCrudLink() : string: Dynamically construct a link based on an entity-type and entity-id.
smarty_function_crmGetAttribute() : string: Fetch an attribute from html
smarty_function_crmKey() : string: Generate a CRM_Core_Key of a given name
smarty_function_crmResPath() : string: Determine the path of a resource file
smarty_function_crmResURL() : string: Determine the URL of a resource file
smarty_function_crmScript() : mixed: Add a Javascript file to a specific part of the page
smarty_function_crmSetting() : int|string|null: Retrieve CiviCRM settings from the api for use in templates.
smarty_function_crmSigner() : mixed: Generate a secure signature
smarty_function_crmStyle() : mixed: Add a stylesheet <LINK> to a specific part of the page
smarty_function_crmURL() : string: Generate a URL.
smarty_function_crmVersion() : string: Display the CiviCRM version
smarty_function_docURL() : string|null: Given one of: ( page, title, text ) parameters, generates an HTML link to documentation.
smarty_function_help() : string: Adds inline help.
smarty_function_isValueChange() : null: Smarty function for checking change in a property's value, for example when looping through an array.
smarty_function_privacyFlag() : string: Display a banned icon to flag privacy preferences
smarty_function_sectionTotal() : string: Smarty block function for printing the correct report section total
smarty_function_simpleActivityContacts() : string: Get details for the target and assignee contact of an activity.
smarty_modifier_colorContrast() : string: Wrapper around CRM_Utils_Color::getContrast
smarty_modifier_crmAddClass() : string: Add a class to an html element
smarty_modifier_crmBtnType() : string: Grab the button type from a passed button element 'name' by checking for reserved QF button type strings
smarty_modifier_crmCountCharacters() : int: Smarty count_characters modifier plugin
smarty_modifier_crmDate() : string: Convert the date string "YYYY-MM-DD" to "MM<long> DD, YYYY".
smarty_modifier_crmDelete() : string: Replace the value of an attribute in the input string. Assume the the attribute is well formed, of the type name="value". If no replacement is mentioned the value is inserted at the end of the form element
smarty_modifier_crmFirstWord() : string: Replace a string with the first word in the string
smarty_modifier_crmICalDate() : string: Format the given text in an ical suitable format
smarty_modifier_crmICalText() : string: Format the given text in an ical suitable format
smarty_modifier_crmInsert() : string: Replace the value of an attribute in the input string. Assume the the attribute is well formed, of the type name="value". If no replacement is mentioned the value is inserted at the end of the form element
smarty_modifier_crmMoney() : string: Format the given monetary amount (and currency) for display
smarty_modifier_crmNumberFormat() : string: Add thousands separator to numeric strings using PHP number_format() function.
smarty_modifier_crmReplace() : string: Replace the value of an attribute in the input string. Assume the the attribute is well formed, of the type name="value". If no replacement is mentioned the value is inserted at the end of the form element
smarty_modifier_crmRSSPubDate() : string: Format the given date to RSS pubDate RFC822 format, http://www.w3.org/Protocols/rfc822/#z28
smarty_modifier_crmStripAlternatives() : string: Given an ezComponents-parsed representation of a text with alternatives return only the first one
smarty_modifier_crmUpper() : string: Upper case a string but use the multibyte strtoupper function to better handle accents / umlaut
smarty_modifier_htmlize() : string: Convert a given text part a better HTML representation (add paragraphs and make URLs clickable)
smarty_modifier_json() : string: Convert the data to a JSON string
smarty_modifier_mb_truncate() : string: Smarty mb_truncate modifier plugin
smarty_modifier_nl2brIfNotHTML() : string: If the given string looks like HTML, do nothing and return it.
smarty_modifier_print_array() : string: Smarty print_array modifier plugin
smarty_modifier_purify() : string: Purify HTML to mitigate against XSS attacks
smarty_modifier_smarty() : string: Implement smarty:nodefaults for Smarty3.
smarty_modifier_substring() : string: Smarty plugin Type: modifier Name: substring Version: 0.1 Date: 2006-16-02 Author: Thorsten Albrecht <thor_REMOVE.THIS_@wolke7.net> Purpose: "substring" allows you to retrieve a small part (substring) of a string.
smarty_prefilter_htxtFilter() : string: The content of an "{htxt}" block should not be evaluated unless the active request is relevant. Otherwise, it will try to evaluate unassigned variables.
smarty_prefilter_resetExtScope() : string: Wrap every Smarty template in a {crmScope} tag that sets the variable "extensionKey" to blank.
civicrm_smarty_resource_string_get_template() : bool
civicrm_smarty_resource_string_get_timestamp() : bool
civicrm_smarty_resource_string_get_secure() : bool
civicrm_smarty_resource_string_get_trusted() : mixed
civicrm_smarty_register_string_resource() : mixed
crm_smarty_compatibility_get_path() : string|null: Get the path to load Smarty.
generateJoomlaConfig() : mixed
repo() : array<string|int, mixed>: Make a small report about the git content in a given folder+branch.
_afform_admin_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_afform_admin_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_afform_admin_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_afform_admin_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_afform_admin_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_afform_admin_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_afform_admin_civix_fixNavigationMenuItems() : mixed
afform_admin_civicrm_config() : mixed: Implements hook_civicrm_config().
afform_admin_civicrm_install() : mixed: Implements hook_civicrm_install().
afform_admin_civicrm_enable() : mixed: Implements hook_civicrm_enable().
_afform_civix_class_loader() : mixed
_afform_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_afform_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_afform_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_afform_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_afform_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_afform_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_afform_civix_fixNavigationMenuItems() : mixed
_afform_fields_filter() : array<string|int, mixed>: Filter the content of $params to only have supported afform fields.
afform_civicrm_config() : mixed: Implements hook_civicrm_config().
afform_civicrm_install() : mixed: Implements hook_civicrm_install().
afform_civicrm_enable() : mixed: Implements hook_civicrm_enable().
afform_civicrm_managed() : mixed: Implements hook_civicrm_managed().
afform_civicrm_tabset() : mixed: Implements hook_civicrm_tabset().
afform_civicrm_pageRun() : mixed: Implements hook_civicrm_pageRun().
afform_civicrm_contactSummaryBlocks() : mixed: Implements hook_civicrm_contactSummaryBlocks().
_afform_get_contact_types() : array<string|int, mixed>: Resolve a mixed list of contact types and sub-types into just top-level contact types (Individual, Organization, Household)
_afform_hook_civicrm_angularModules() : mixed: Late-listener for Angular modules: adds all Afforms and their dependencies.
_afform_get_partials() : array<string|int, mixed>: Callback to retrieve partials for a given afform/angular module.
afform_civicrm_buildAsset() : mixed: Implements hook_civicrm_buildAsset().
afform_civicrm_alterMenu() : mixed: Implements hook_civicrm_alterMenu().
afform_civicrm_permission() : mixed: Implements hook_civicrm_permission().
afform_civicrm_permission_check() : mixed: Implements hook_civicrm_permission_check().
afform_civicrm_permissionList() : mixed: Implements hook_civicrm_permissionList().
_afform_clear() : mixed: Clear any local/in-memory caches based on afform data.
_afform_angular_module_name() : string
afform_civicrm_preProcess() : mixed: Implements hook_civicrm_preProcess().
afform_civicrm_pre() : mixed: Implements hook_civicrm_pre().
afform_civicrm_referenceCounts() : mixed: Implements hook_civicrm_referenceCounts().
afform_shortcode_content() : string: Wordpress only: Render Afform content for shortcodes.
afform_civicrm_searchKitTasks() : mixed: Implements hook_civicrm_searchKitTasks().
civicrm_api3_afform_get() : array<string|int, mixed>: Get a list of afforms.
_civicrm_api3_afform_get_spec() : mixed
_civicrm_api3_afform_getlist_params() : mixed: Augment parameters for Afform entityRef list.
_civicrm_api3_afform_getlist_output() : array<string|int, mixed>: Format output for Afform entityRef list.
cv() : string: Call the "cv" command.
_afform_html_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_afform_html_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_afform_html_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_afform_html_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_afform_html_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_afform_html_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_afform_html_civix_fixNavigationMenuItems() : mixed
afform_html_civicrm_config() : mixed: Implements hook_civicrm_config().
afform_html_civicrm_install() : mixed: Implements hook_civicrm_install().
afform_html_civicrm_enable() : mixed: Implements hook_civicrm_enable().
_afform_login_token_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_afform_login_token_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_afform_login_token_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_afform_login_token_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_afform_login_token_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_afform_login_token_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_afform_login_token_civix_fixNavigationMenuItems() : mixed
afform_login_token_civicrm_config() : void: Implements hook_civicrm_config().
afform_login_token_civicrm_install() : void: Implements hook_civicrm_install().
afform_login_token_civicrm_enable() : void: Implements hook_civicrm_enable().
_afform_mock_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_afform_mock_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_afform_mock_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_afform_mock_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_afform_mock_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_afform_mock_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_afform_mock_civix_fixNavigationMenuItems() : mixed
afform_mock_civicrm_config() : mixed: Implements hook_civicrm_config().
afform_mock_civicrm_install() : mixed: Implements hook_civicrm_install().
afform_mock_civicrm_enable() : mixed: Implements hook_civicrm_enable().
cv() : mixed: Call the "cv" command.
_authx_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_authx_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_authx_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_authx_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_authx_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_authx_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_authx_civix_fixNavigationMenuItems() : mixed
authx_login() : array{contactId: int, userId: ?int, flow: string, credType: string, useSession: bool}: Perform a system login.
_authx_uf() : AuthxInterface
_authx_redact() : mixed: For parameter-based authentication, this option will hide parameters.
_authx_reload() : mixed: Reload the current page-view.
authx_civicrm_config() : mixed: Implements hook_civicrm_config().
authx_civicrm_install() : mixed: Implements hook_civicrm_install().
authx_civicrm_enable() : mixed: Implements hook_civicrm_enable().
authx_civicrm_permission() : mixed: Implements hook_civicrm_permission().
cv() : string: Call the "cv" command.
_chart_kit_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_chart_kit_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_chart_kit_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_chart_kit_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_chart_kit_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_chart_kit_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_chart_kit_civix_fixNavigationMenuItems() : mixed
chart_kit_civicrm_config() : void: Implements hook_civicrm_config().
chart_kit_civicrm_install() : void: Implements hook_civicrm_install().
chart_kit_civicrm_enable() : void: Implements hook_civicrm_enable().
_civi_campaign_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civi_campaign_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civi_campaign_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civi_campaign_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civi_campaign_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civi_campaign_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civi_campaign_civix_fixNavigationMenuItems() : mixed
_civi_case_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civi_case_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civi_case_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civi_case_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civi_case_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civi_case_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civi_case_civix_fixNavigationMenuItems() : mixed
civi_case_civicrm_managed() : mixed: Implements hook_civicrm_managed().
civi_case_civicrm_selectWhereClause() : mixed: Applies Case permissions to Activities
_civi_contribute_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civi_contribute_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civi_contribute_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civi_contribute_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civi_contribute_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civi_contribute_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civi_contribute_civix_fixNavigationMenuItems() : mixed
cv() : mixed: Call the "cv" command.
_civi_event_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civi_event_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civi_event_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civi_event_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civi_event_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civi_event_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civi_event_civix_fixNavigationMenuItems() : mixed
_civi_mail_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civi_mail_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civi_mail_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civi_mail_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civi_mail_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civi_mail_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civi_mail_civix_fixNavigationMenuItems() : mixed
_civi_member_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civi_member_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civi_member_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civi_member_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civi_member_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civi_member_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civi_member_civix_fixNavigationMenuItems() : mixed
_civi_pledge_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civi_pledge_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civi_pledge_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civi_pledge_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civi_pledge_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civi_pledge_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civi_pledge_civix_fixNavigationMenuItems() : mixed
_civi_report_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civi_report_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civi_report_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civi_report_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civi_report_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civi_report_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civi_report_civix_fixNavigationMenuItems() : mixed
cv() : mixed: Call the "cv" command.
_civicrm_admin_ui_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civicrm_admin_ui_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civicrm_admin_ui_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civicrm_admin_ui_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civicrm_admin_ui_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civicrm_admin_ui_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civicrm_admin_ui_civix_fixNavigationMenuItems() : mixed
civicrm_admin_ui_civicrm_config() : mixed: Implements hook_civicrm_config().
civicrm_admin_ui_civicrm_postProcess() : mixed: Implements hook_civicrm_postProcess().
cv() : mixed: Call the "cv" command.
_civicrm_search_ui_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civicrm_search_ui_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civicrm_search_ui_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civicrm_search_ui_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civicrm_search_ui_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civicrm_search_ui_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civicrm_search_ui_civix_fixNavigationMenuItems() : mixed
civicrm_search_ui_civicrm_config() : void: Implements hook_civicrm_config().
civicrm_search_ui_civicrm_install() : void: Implements hook_civicrm_install().
civicrm_search_ui_civicrm_enable() : void: Implements hook_civicrm_enable().
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.
_civigrant_civix_class_loader() : mixed
_civigrant_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civigrant_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civigrant_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civigrant_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civigrant_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civigrant_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civigrant_civix_fixNavigationMenuItems() : mixed
civigrant_civicrm_config() : mixed: Implements hook_civicrm_config().
civigrant_civicrm_links() : mixed: Implements hook_civicrm_links().
civigrant_civicrm_summaryActions() : mixed: Implements hook_civicrm_summaryActions().
civigrant_civicrm_permission() : mixed: Implements hook_civicrm_permission().
civigrant_civicrm_alterAPIPermissions() : mixed: Implements hook_civicrm_alterAPIPermissions().
civigrant_civicrm_queryObjects() : mixed: Implements hook_civicrm_queryObjects().
cv() : mixed: Call the "cv" command.
_civiimport_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_civiimport_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_civiimport_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_civiimport_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_civiimport_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_civiimport_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_civiimport_civix_fixNavigationMenuItems() : mixed
civiimport_civicrm_config() : mixed: Implements hook_civicrm_config().
civiimport_civicrm_install() : mixed: Implements hook_civicrm_install().
civiimport_civicrm_enable() : mixed: Implements hook_civicrm_enable().
civiimport_civicrm_entityTypes() : void: Implements hook_civicrm_entityTypes().
_civiimport_civicrm_get_import_tables() : array<string|int, mixed>: Get the available import tables.
civiimport_civicrm_alterTemplateFile() : void: Alter the template for the contribution import mapping to use angular form.
civiimport_civicrm_searchKitTasks() : mixed: Implements search tasks hook to add the `validate` and `import` actions.
civiimport_civicrm_buildForm() : mixed: Load the angular app for our form.
cv() : mixed: Call the "cv" command.
_ckeditor4_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_ckeditor4_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_ckeditor4_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_ckeditor4_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_ckeditor4_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_ckeditor4_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_ckeditor4_civix_fixNavigationMenuItems() : mixed
ckeditor4_civicrm_config() : mixed: Implements hook_civicrm_config().
ckeditor4_civicrm_install() : mixed: Implements hook_civicrm_install().
ckeditor4_civicrm_enable() : mixed: Implements hook_civicrm_enable().
ckeditor4_civicrm_buildForm() : mixed
ckeditor4_civicrm_coreResourceList() : mixed
_contributioncancelactions_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_contributioncancelactions_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_contributioncancelactions_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_contributioncancelactions_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_contributioncancelactions_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_contributioncancelactions_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_contributioncancelactions_civix_fixNavigationMenuItems() : mixed
contributioncancelactions_civicrm_post() : mixed: Implements hook_civicrm_preProcess().
contributioncancelactions_cancel_related_pending_participant_records() : void: Find and cancel any pending participant records.
contributioncancelactions_cancel_related_pending_memberships() : void: Find and cancel any pending memberships.
cv() : string: Call the "cv" command.
_elavon_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_elavon_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_elavon_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_elavon_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_elavon_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_elavon_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_elavon_civix_fixNavigationMenuItems() : mixed
elavon_civicrm_config() : mixed: Implements hook_civicrm_config().
elavon_civicrm_install() : mixed: Implements hook_civicrm_install().
elavon_civicrm_enable() : mixed: Implements hook_civicrm_enable().
cv() : mixed: Call the "cv" command.
_eventcart_civix_class_loader() : mixed
_eventcart_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_eventcart_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_eventcart_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_eventcart_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_eventcart_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_eventcart_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_eventcart_civix_fixNavigationMenuItems() : mixed
eventcart_civicrm_config() : mixed: Implements hook_civicrm_config().
eventcart_civicrm_install() : mixed: Implements hook_civicrm_install().
eventcart_civicrm_alterMailParams() : mixed: Add the conference session variable to the template.
eventcart_civicrm_enable() : mixed: Implements hook_civicrm_enable().
eventcart_civicrm_tabset() : mixed
_ewaysingle_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_ewaysingle_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_ewaysingle_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_ewaysingle_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_ewaysingle_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_ewaysingle_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_ewaysingle_civix_fixNavigationMenuItems() : mixed
ewaysingle_civicrm_config() : mixed: Implements hook_civicrm_config().
ewaysingle_civicrm_install() : mixed: Implements hook_civicrm_install().
ewaysingle_civicrm_enable() : mixed: Implements hook_civicrm_enable().
cv() : string: Call the "cv" command.
_financialacls_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_financialacls_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_financialacls_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_financialacls_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_financialacls_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_financialacls_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_financialacls_civix_fixNavigationMenuItems() : mixed
financialacls_civicrm_config() : mixed: Implements hook_civicrm_config().
financialacls_civicrm_container() : mixed
financialacls_civicrm_install() : mixed: Implements hook_civicrm_install().
financialacls_civicrm_enable() : mixed: Implements hook_civicrm_enable().
financialacls_civicrm_pre() : mixed: Intervene to prevent deletion, where permissions block it.
financialacls_civicrm_selectWhereClause() : mixed: Implements hook_civicrm_selectWhereClause().
_financialacls_civicrm_get_accounts_clause() : string: Get the clause to limit available types.
_financialacls_civicrm_get_type_clause() : string: Get the clause to limit available types.
_financialacls_civicrm_get_accessible_financial_types() : array<string|int, int>: Get an array of the ids of accessible financial types.
_financialacls_civicrm_get_inaccessible_financial_types() : array<string|int, int>: Get an array of the ids of accessible financial types.
_financialacls_civicrm_get_membership_type_clause() : string: Get the clause to limit available membership types.
financialacls_civicrm_buildAmount() : mixed: Remove unpermitted options.
financialacls_civicrm_membershipTypeValues() : mixed: Remove unpermitted membership types from selection availability.
financialacls_civicrm_permission() : mixed: Add permissions.
_financialacls_civi_api4_authorizeContribution() : mixed: Listener for 'civi.api4.authorizeRecord::Contribution'
_civicrm_financial_acls_check_permissioned_line_items() : bool: Function to check if lineitems present in a contribution have permissioned FTs.
_financialacls_getRequiredPermission() : string: Get the permission required to perform this action on this financial type.
financialacls_civicrm_fieldOptions() : mixed: Remove unpermitted financial types from field Options in search context.
financialacls_is_acl_limiting_enabled() : bool: Is financial acl limiting enabled.
financialacls_toggle() : mixed: Clear the statics cache when the setting is enabled or disabled.
financialacls_civicrm_alterMenu() : void: Require financial acl permissions for financial screens.
financialacls_civicrm_preProcess() : void
financialacls_civicrm_links() : mixed: Hide edit/enable/disable links for memberships of a given Financial Type Note: The $objectID param can be an int, string or null, hence not typed
cv() : string: Call the "cv" command.
_flexmailer_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_flexmailer_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_flexmailer_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_flexmailer_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_flexmailer_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_flexmailer_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_flexmailer_civix_fixNavigationMenuItems() : mixed
flexmailer_civicrm_config() : mixed: Implements hook_civicrm_config().
flexmailer_civicrm_install() : mixed: Implements hook_civicrm_install().
flexmailer_civicrm_enable() : mixed: Implements hook_civicrm_enable().
flexmailer_civicrm_container() : mixed: Implements hook_civicrm_container().
flexmailer_civicrm_scanClasses() : void
cv() : string: Call the "cv" command.
_greenwich_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_greenwich_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_greenwich_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_greenwich_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_greenwich_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_greenwich_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_greenwich_civix_fixNavigationMenuItems() : mixed
greenwich_civicrm_config() : mixed: Implements hook_civicrm_config().
greenwich_civicrm_themes() : mixed: Implements hook_civicrm_themes().
greenwich_civicrm_alterBundle() : mixed: Implements hook_civicrm_alterBundle().
_iframe_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_iframe_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_iframe_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_iframe_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_iframe_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_iframe_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_iframe_civix_fixNavigationMenuItems() : mixed
iframe_civicrm_config() : void: Implements hook_civicrm_config().
iframe_civicrm_install() : void: Implements hook_civicrm_install().
iframe_civicrm_enable() : void: Implements hook_civicrm_enable().
_legacycustomsearches_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_legacycustomsearches_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_legacycustomsearches_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_legacycustomsearches_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_legacycustomsearches_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_legacycustomsearches_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_legacycustomsearches_civix_fixNavigationMenuItems() : mixed
legacycustomsearches_civicrm_config() : mixed: Implements hook_civicrm_config().
legacycustomsearches_civicrm_install() : mixed: Implements hook_civicrm_install().
legacycustomsearches_civicrm_enable() : mixed: Implements hook_civicrm_enable().
legacycustomsearches_civicrm_buildGroupContactCache() : void: Determine the sql
cv() : mixed: Call the "cv" command.
_message_admin_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_message_admin_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_message_admin_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_message_admin_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_message_admin_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_message_admin_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_message_admin_civix_fixNavigationMenuItems() : mixed
message_admin_civicrm_config() : mixed: Implements hook_civicrm_config().
message_admin_civicrm_install() : mixed: Implements hook_civicrm_install().
message_admin_civicrm_enable() : mixed: Implements hook_civicrm_enable().
buildInputUrl() : mixed
buildRedirectUrl() : mixed
_oauth_client_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_oauth_client_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_oauth_client_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_oauth_client_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_oauth_client_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_oauth_client_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_oauth_client_civix_fixNavigationMenuItems() : mixed
oauth_client_civicrm_config() : mixed: Implements hook_civicrm_config().
oauth_client_civicrm_permission() : mixed: Implements hook_civicrm_permission().
oauth_client_civicrm_container() : mixed
oauth_client_civicrm_oauthProviders() : mixed: Implements hook_civicrm_oauthProviders().
oauth_client_civicrm_mailSetupActions() : mixed: Implements hook_civicrm_mailSetupActions().
oauth_client_civicrm_oauthReturn() : mixed: Implements hook_civicrm_oauthReturn().
oauth_client_civicrm_alterMailStore() : mixed: Implements hook_civicrm_alterMailStore().
cv() : string: Call the "cv" command.
_oembed_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_oembed_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_oembed_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_oembed_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_oembed_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_oembed_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_oembed_civix_fixNavigationMenuItems() : mixed
oembed_civicrm_config() : void: Implements hook_civicrm_config().
oembed_civicrm_install() : void: Implements hook_civicrm_install().
oembed_civicrm_enable() : void: Implements hook_civicrm_enable().
cv() : mixed: Call the "cv" command.
_payflowpro_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_payflowpro_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_payflowpro_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_payflowpro_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_payflowpro_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_payflowpro_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_payflowpro_civix_fixNavigationMenuItems() : mixed
payflowpro_civicrm_config() : mixed: Implements hook_civicrm_config().
payflowpro_civicrm_install() : mixed: Implements hook_civicrm_install().
payflowpro_civicrm_enable() : mixed: Implements hook_civicrm_enable().
cv() : string: Call the "cv" command.
_recaptcha_qsencode() : string: Encodes the given data into a query string format
_recaptcha_http_post() : string: Submits an HTTP POST to a reCAPTCHA server
recaptcha_get_html() : string: Gets the challenge HTML (javascript and non-javascript version).
recaptcha_check_answer() : ReCaptchaResponse: Calls an HTTP POST function to verify if the user's guess was correct
recaptcha_get_signup_url() : mixed: gets a URL where the user can sign up for reCAPTCHA. If your application has a configuration page where you enter a key, you should provide a link using this function.
_recaptcha_aes_pad() : mixed
_recaptcha_aes_encrypt() : mixed: Mailhide related code
_recaptcha_mailhide_urlbase64() : mixed
recaptcha_mailhide_url() : mixed: gets the reCAPTCHA Mailhide url for a given email, public key and private key
_recaptcha_mailhide_email_parts() : mixed: gets the parts of the email to expose to the user.
recaptcha_mailhide_html() : mixed: Gets html to display an email address given a public an private key.
_recaptcha_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_recaptcha_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_recaptcha_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_recaptcha_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_recaptcha_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_recaptcha_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_recaptcha_civix_fixNavigationMenuItems() : mixed
recaptcha_civicrm_config() : mixed: Implements hook_civicrm_config().
recaptcha_civicrm_install() : mixed: Implements hook_civicrm_install().
recaptcha_civicrm_enable() : mixed: Implements hook_civicrm_enable().
recaptcha_civicrm_buildForm() : mixed: Intercept form functions
_scheduled_communications_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_scheduled_communications_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_scheduled_communications_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_scheduled_communications_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_scheduled_communications_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_scheduled_communications_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_scheduled_communications_civix_fixNavigationMenuItems() : mixed
scheduled_communications_civicrm_config() : void: Implements hook_civicrm_config().
scheduled_communications_civicrm_install() : void: Implements hook_civicrm_install().
scheduled_communications_civicrm_enable() : void: Implements hook_civicrm_enable().
scheduled_communications_civicrm_permission() : mixed
scheduled_communications_civicrm_pre() : void: Implements hook_civicrm_pre().
scheduled_communications_civicrm_post() : void: Implements hook_civicrm_post().
cv() : mixed: Call the "cv" command.
_search_kit_civix_class_loader() : mixed
_search_kit_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_search_kit_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_search_kit_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_search_kit_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_search_kit_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_search_kit_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_search_kit_civix_fixNavigationMenuItems() : mixed
search_kit_civicrm_config() : mixed: Implements hook_civicrm_config().
search_kit_civicrm_permission() : mixed: Implements hook_civicrm_permission().
search_kit_civicrm_angularModules() : mixed: Implements hook_civicrm_angularModules().
search_kit_civicrm_pre() : mixed: Implements hook_civicrm_pre().
search_kit_civicrm_post() : mixed: Implements hook_civicrm_post().
search_kit_civicrm_entityTypes() : void: Implements hook_civicrm_entityTypes().
_getSearchKitDisplayTableName() : string: Returns a SQL-safe table name for a display (for use with displays of type "entity")
_getSearchKitEntityDisplays() : array<string|int, mixed>: Uncached function to fetch displays of type "entity" to be used by boot-level code
cv() : string: Call the "cv" command.
_sequentialcreditnotes_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_sequentialcreditnotes_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_sequentialcreditnotes_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_sequentialcreditnotes_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_sequentialcreditnotes_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_sequentialcreditnotes_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_sequentialcreditnotes_civix_fixNavigationMenuItems() : mixed
sequentialcreditnotes_civicrm_pre() : mixed: Add a creditnote_id if appropriate.
sequentialcreditnotes_create_credit_note_id() : string: Generate credit note id with next available number
cv() : string: Call the "cv" command.
_standaloneusers_civix_class_loader() : mixed
_standaloneusers_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_standaloneusers_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_standaloneusers_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_standaloneusers_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_standaloneusers_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_standaloneusers_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_standaloneusers_civix_fixNavigationMenuItems() : mixed
standaloneusers_civicrm_alterBundle() : mixed
standaloneusers_civicrm_buildForm() : mixed: Hide the inherit CMS language on the Settings - Localization form.
standaloneusers_civicrm_config() : mixed: Implements hook_civicrm_config().
standaloneusers_civicrm_install() : mixed: Implements hook_civicrm_install().
standaloneusers_civicrm_enable() : mixed: Implements hook_civicrm_enable().
standaloneusers_civicrm_permission() : mixed: Implements hook_civicrm_permission().
standaloneusers_civicrm_navigationMenu() : mixed
cv() : mixed: Call the "cv" command.
_tellafriend_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_tellafriend_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_tellafriend_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_tellafriend_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_tellafriend_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_tellafriend_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_tellafriend_civix_fixNavigationMenuItems() : mixed
tellafriend_civicrm_config() : void: Implements hook_civicrm_config().
tellafriend_civicrm_install() : void: Implements hook_civicrm_install().
tellafriend_civicrm_enable() : void: Implements hook_civicrm_enable().
tellafriend_civicrm_tabset() : mixed: Implements hook_civicrm_tabset().
tellafriend_civicrm_check() : mixed: Implements hook_civicrm_check().
_user_dashboard_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_user_dashboard_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_user_dashboard_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_user_dashboard_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_user_dashboard_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_user_dashboard_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_user_dashboard_civix_fixNavigationMenuItems() : mixed
user_dashboard_civicrm_config() : void: Implements hook_civicrm_config().
user_dashboard_civicrm_install() : void: Implements hook_civicrm_install().
user_dashboard_civicrm_enable() : void: Implements hook_civicrm_enable().
user_dashboard_civicrm_post() : mixed: Tag SavedSearches with the "UserDashboard" tag.
ts() : string: Short-named function for string translation, defined in global scope so it's available everywhere.
makeDAOs() : void
_corereqadapter_addMessages() : mixed
_backdrop_civisetup_getPublicFiles() : mixed
_backdrop_civisetup_getPrivateFiles() : mixed
_drupal_civisetup_getPublicFiles() : mixed
_drupal_civisetup_getPrivateFiles() : mixed
_drupal8_civisetup_getPublicFiles() : mixed
_drupal8_civisetup_getPrivateFiles() : mixed
_standalone_setup_scheme() : string
_civicrm_wordpress_plugin_file() : string
civicrm_install_set_backdrop_perms() : mixed
civicrm_install_set_drupal_perms() : mixed
civicrm_install_set_drupal8_perms() : mixed
generateRandomDate() : string
user_access() : bool
module_list() : array<string|int, mixed>
_shimmy_civix_mixin_polyfill() : mixed
_shimmy_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_shimmy_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_shimmy_civix_civicrm_postInstall() : mixed: Implements hook_civicrm_postInstall().
_shimmy_civix_civicrm_uninstall() : mixed: Implements hook_civicrm_uninstall().
_shimmy_civix_civicrm_enable() : mixed: (Delegated) Implements hook_civicrm_enable().
_shimmy_civix_civicrm_disable() : mixed: (Delegated) Implements hook_civicrm_disable().
_shimmy_civix_civicrm_upgrade() : mixed: (Delegated) Implements hook_civicrm_upgrade().
_shimmy_civix_upgrader() : CRM_Shimmy_Upgrader
_shimmy_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_shimmy_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_shimmy_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_shimmy_civix_fixNavigationMenuItems() : mixed
_shimmy_civix_civicrm_entityTypes() : mixed: (Delegated) Implements hook_civicrm_entityTypes().
shimmy_civicrm_config() : mixed: Implements hook_civicrm_config().
shimmy_civicrm_install() : mixed: Implements hook_civicrm_install().
shimmy_civicrm_postInstall() : mixed: Implements hook_civicrm_postInstall().
shimmy_civicrm_uninstall() : mixed: Implements hook_civicrm_uninstall().
shimmy_civicrm_enable() : mixed: Implements hook_civicrm_enable().
shimmy_civicrm_disable() : mixed: Implements hook_civicrm_disable().
shimmy_civicrm_upgrade() : mixed: Implements hook_civicrm_upgrade().
shimmy_civicrm_entityTypes() : mixed: Implements hook_civicrm_entityTypes().
_shimmy_assert_service_object() : mixed: Assert that there is a service with a given name+type.
cv() : mixed: Call the "cv" command.
moduletest_civicrm_install() : mixed: Implements civicrm_install
moduletest_civicrm_postInstall() : mixed: Implements civicrm_postInstall
moduletest_civicrm_uninstall() : mixed: Implements civicrm_uninstall
moduletest_civicrm_enable() : mixed: Implements civicrm_enable
moduletest_civicrm_disable() : mixed: Implements civicrm_disable
civicrm_api3_mailing_provider_data_get() : array<string|int, mixed>: MailingProviderData.get API
_civicrm_api3_mailing_provider_data_get_spec() : mixed: Metadata for MailingProviderData.get API
civicrm_api3_mailing_provider_data_create() : array<string|int, mixed>: MailingProviderData.create API
civicrm_api3_contact_example_action2() : array<string|int, mixed>
civicrm_api3_generic_example_action1() : array<string|int, mixed>
civicrm_api3_generic_example_action2() : array<string|int, mixed>: Example result for API Test.
civicrm_api3_test_entity_example_action3() : array<string|int, mixed>: Example result for API Test.
civitest_civicrm_scanClasses() : void
_phpunit_mockoloader() : mixed
cv() : string: Call the "cv" command.
hooktesta_civicrm_testRunHooks_outer() : mixed: Implements hook_civicrm_testRunHooks_outer().
hooktestb_civicrm_testRunHooks_outer() : mixed
hooktestc_civicrm_testRunHooks_outer() : mixed
hooktesta_civicrm_testRunHooks_inner() : mixed
hooktestb_civicrm_testRunHooks_inner() : mixed
hooktesta_civicrm_testRunHooks_merge() : array<string|int, mixed>
hooktestc_civicrm_testRunHooks_merge() : mixed: Implements hook_civicrm_testRunHooks_merge().
hooktestd_civicrm_testRunHooks_merge() : null
hookteste_civicrm_testRunHooks_merge() : array<string|int, mixed>
updateFile() : mixed: Update the content of a file.
updateXmlFile() : mixed: Update the content of an XML file
initFile() : mixed: Initialize a file (if it doesn't already exist).
makeVerName() : string: Render a pretty string for a major/minor version number.
isVersionValid() : mixed
fatal() : mixed
parseArgs() : array<string|int, mixed>
_event_check_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_event_check_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_event_check_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_event_check_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_event_check_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_event_check_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_event_check_civix_fixNavigationMenuItems() : mixed
event_check_civicrm_config() : void: Implements hook_civicrm_config().
_demoqueue_civix_civicrm_config() : mixed: (Delegated) Implementation of hook_civicrm_config
_demoqueue_civix_civicrm_xmlMenu() : mixed: (Delegated) Implementation of hook_civicrm_xmlMenu
demoqueue_civicrm_config() : mixed: Implementation of hook_civicrm_config
demoqueue_civicrm_xmlMenu() : mixed: Implementation of hook_civicrm_xmlMenu
_phpstorm_civix_civicrm_config() : mixed: (Delegated) Implements hook_civicrm_config().
_phpstorm_civix_civicrm_install() : mixed: Implements hook_civicrm_install().
_phpstorm_civix_civicrm_enable() : void: (Delegated) Implements hook_civicrm_enable().
_phpstorm_civix_insert_navigation_menu() : bool: Inserts a navigation menu item at a given place in the hierarchy.
_phpstorm_civix_navigationMenu() : mixed: (Delegated) Implements hook_civicrm_navigationMenu().
_phpstorm_civix_fixNavigationMenu() : mixed: Given a navigation menu, generate navIDs for any items which are missing them.
_phpstorm_civix_fixNavigationMenuItems() : mixed
phpstorm_metadata_dir() : string: Determine the folder where we will store PhpStorm metadata files.
_phpstorm_metadata_dirs() : array<string|int, mixed>
phpstorm_civicrm_config() : void: Implements hook_civicrm_config().
phpstorm_civicrm_container() : mixed
phpstorm_civicrm_managed() : mixed
phpstorm_civicrm_enable() : void
phpstorm_civicrm_uninstall() : void
_phpstorm_cleanup() : void
compareFile() : mixed
parseLog() : mixed
splitContactIDs() : array<string|int, mixed>: Split a large array of contactIDs into more manageable smaller chunks
generateSolrJSON() : string: Given an array of values, generate the JSON in the Solr format
escapeJsonString() : mixed
getValues() : array<string|int, mixed>: Given a set of contact IDs get the values
getTableInfo() : mixed
getContactInfo() : mixed
getNoteInfo() : mixed
getPhoneInfo() : mixed
getEmailInfo() : mixed
getAddressInfo() : mixed
appendValue() : mixed
run() : mixed
splitContactIDs() : array<string|int, mixed>: Split a large array of contactIDs into more manageable smaller chunks
generateSolrXML() : string: Given an array of values, generate the XML in the Solr format
getValues() : array<string|int, mixed>: Given a set of contact IDs get the values
getTableInfo() : mixed
getContactInfo() : mixed
getLocationInfo() : mixed
run() : mixed
splitContactIDs() : array<string|int, mixed>: Split a large array of contactIDs into more manageable smaller chunks
getValues() : array<string|int, mixed>: Given a set of contact IDs get the values
getTableInfo() : mixed
getContactInfo() : mixed
getNoteInfo() : mixed
getPhoneInfo() : mixed
getEmailInfo() : mixed
getAddressInfo() : mixed
getRelationshipInfo() : mixed
getActivityInfo() : mixed
appendValue() : mixed
getDBFields() : mixed
addAdditionalContacts() : mixed
run() : mixed
smarty_block_ts() : string

_CIVICRM_FAKE_SESSION


    public
        mixed
    _CIVICRM_FAKE_SESSION
    = TRUE

_JEXEC


    public
        mixed
    _JEXEC
    = 1

AFFORM_HTML_MONACO


    public
        mixed
    AFFORM_HTML_MONACO
    = 'bower_components/monaco-editor/min/vs'

API_LATEST_VERSION


    public
        mixed
    API_LATEST_VERSION
    = 3

API_V3_EXTENSION_DELIMITER


    public
        mixed
    API_V3_EXTENSION_DELIMITER
    = ','

BACKDROP_ROOT


    public
        mixed
    BACKDROP_ROOT
    = $cmsPath

BACKDROP_ROOT


    public
        mixed
    BACKDROP_ROOT
    = getcwd()

BLOCK_CACHE_GLOBAL


    public
        mixed
    BLOCK_CACHE_GLOBAL
    = 0x8

BLOCK_CACHE_PER_PAGE


    public
        mixed
    BLOCK_CACHE_PER_PAGE
    = 0x4

BLOCK_NO_CACHE


    public
        mixed
    BLOCK_NO_CACHE
    = -1

CHUNK_SIZE


    public
        mixed
    CHUNK_SIZE
    = 128

CHUNK_SIZE


    public
        mixed
    CHUNK_SIZE
    = 128

CHUNK_SIZE


    public
        mixed
    CHUNK_SIZE
    = 128

CIVI_SETUP


    public
        mixed
    CIVI_SETUP
    = 1

CIVICRM_CONTAINER_CACHE


    public
        mixed
    CIVICRM_CONTAINER_CACHE
    = 'never'

CIVICRM_DSN


    public
        mixed
    CIVICRM_DSN
    = $composedDsn

CIVICRM_HIBP_URL


    public
        mixed
    CIVICRM_HIBP_URL
    = 'https://api.pwnedpasswords.com/range/'

CIVICRM_IFRAME


    public
        mixed
    CIVICRM_IFRAME
    = 1

CIVICRM_IFRAME


    public
        mixed
    CIVICRM_IFRAME
    = 1

CIVICRM_IFRAME


    public
        mixed
    CIVICRM_IFRAME
    = 1

CIVICRM_L10N_BASEDIR


    public
        mixed
    CIVICRM_L10N_BASEDIR
    = \getenv('CIVICRM_L10N_BASEDIR') ? \getenv('CIVICRM_L10N_BASEDIR') : (__DIR__ . '/../l10n')

CIVICRM_L10N_BASEDIR


    public
        mixed
    CIVICRM_L10N_BASEDIR
    = \getenv('CIVICRM_L10N_BASEDIR') ? \getenv('CIVICRM_L10N_BASEDIR') : (__DIR__ . '/../l10n')

CIVICRM_SETTINGS_PATH


    public
        mixed
    CIVICRM_SETTINGS_PATH
    = $config['conf_path'] . '/civicrm.settings.php'

CIVICRM_SETTINGS_PATH


    public
        mixed
    CIVICRM_SETTINGS_PATH
    = $settingsPath

CIVICRM_TEMPLATE_COMPILEDIR


    public
        mixed
    CIVICRM_TEMPLATE_COMPILEDIR
    = $model->templateCompilePath

CIVICRM_TEST


    public
        mixed
    CIVICRM_TEST
    = 1

CIVICRM_TEST


    public
        mixed
    CIVICRM_TEST
    = 1

CIVICRM_TEST


    public
        mixed
    CIVICRM_TEST
    = 1

CIVICRM_UF


    public
        mixed
    CIVICRM_UF
    = 'Joomla'

CIVICRM_UF


    public
        mixed
    CIVICRM_UF
    = 'Drupal'

CIVICRM_UF


    public
        mixed
    CIVICRM_UF
    = $model->cms

CIVICRM_UF


    public
        mixed
    CIVICRM_UF
    = 'Drupal'

CIVICRM_UF_BASEURL


    public
        mixed
    CIVICRM_UF_BASEURL
    = '/'

CIVICRM_UF_BASEURL


    public
        mixed
    CIVICRM_UF_BASEURL
    = $model->cmsBaseUrl

CIVICRM_UF_BASEURL


    public
        mixed
    CIVICRM_UF_BASEURL
    = '/'

DB_DSN_MODE


    public
        mixed
    DB_DSN_MODE
    = 'auto'

DRUPAL_ROOT


    public
        mixed
    DRUPAL_ROOT
    = $cmsPath

DRUPAL_ROOT


    public
        mixed
    DRUPAL_ROOT
    = getcwd()

DS


    public
        mixed
    DS
    = DIRECTORY_SEPARATOR

JDEBUG


    public
        mixed
    JDEBUG
    = FALSE

JPATH_BASE


    public
        mixed
    JPATH_BASE
    = $joomlaBase . DS . 'administrator'

JVERSION


    public
        mixed
    JVERSION
    = $jversion->getShortVersion()

MAIL_BATCH_SIZE


    public
        mixed
    MAIL_BATCH_SIZE
    = 50

RECAPTCHA_API_SECURE_SERVER


    public
        mixed
    RECAPTCHA_API_SECURE_SERVER
    = "https://www.google.com/recaptcha/api.js"

RECAPTCHA_API_SERVER

The reCAPTCHA server URL's


    public
        mixed
    RECAPTCHA_API_SERVER
    = "http://www.google.com/recaptcha/api.js"

RECAPTCHA_VERIFY_SERVER


    public
        mixed
    RECAPTCHA_VERIFY_SERVER
    = "https://www.google.com"

WP_USE_THEMES


    public
        mixed
    WP_USE_THEMES
    = FALSE

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_cxn_register_spec()

Adjust metadata for "register" action.


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

Parameters

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

civicrm_api3_cxn_register()


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

One should generally identify an application using the app_guid. However, if you need to test a new/experimental application, then disable CIVICRM_CXN_CA and specify app_meta_url.

Parameters

$params : array<string|int, mixed>

Array with keys:

app_guid: The unique identifier of the target application.
app_meta_url: The URL for the application's metadata.

Return values

array<string|int, mixed>

_civicrm_api3_cxn_unregister_spec()

Adjust metadata for cxn unregister.


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

Parameters

$spec : array<string|int, mixed>

civicrm_api3_cxn_unregister()

Unregister with a remote application; destroy an existing connection.


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

Specify app_guid XOR cxn_guid.

Parameters

$params : array<string|int, mixed>

Array with keys:

cxn_guid: string
app_guid: string
force: bool

Return values

array<string|int, mixed>

_civicrm_api3_cxn_parseCxnId()


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

Parameters

$params : array<string|int, mixed>: An array with cxn_guid and/or app_guid.

Return values

string —

The CxnId. (If not available, then an exception is thrown.)

_civicrm_api3_cxn_get_spec()

Adjust metadata for cxn get action.


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

Parameters

$spec : array<string|int, mixed>

civicrm_api3_cxn_get()

Returns an array of Cxn records.


    
                    civicrm_api3_cxn_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> —

API result array.

_civicrm_api3_cxn_getlink_spec()

Adjust metadata for "getlink" action.


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

Parameters

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

civicrm_api3_cxn_getlink()


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

Parameters

$params : array<string|int, mixed>

Array with keys:

cxn_guid OR app_guid: string.
page: string.

Return values

array<string|int, mixed>

civicrm_api3_cxn_getcfg()


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_cxn_create()

Creates or modifies a Cxn row.


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

Parameters

$params : array<string|int, mixed>

Array with keys:

id, cxn_guid OR app_guid: string.
is_active: boolean.
options: JSON

Return values

page

_civicrm_api3_cxn_app_get_spec()

Adjust metadata for "register" action.


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

Parameters

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

civicrm_api3_cxn_app_get()

Get a list of applications available for connections.


    
                    civicrm_api3_cxn_app_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_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_deprecation()

Get list of deprecated entities.


    
                    _civicrm_api3_entity_deprecation(array<string|int, mixed> $entities) : array<string|int, mixed>

This is called by the api wrapper when returning the result of api.Entity.get.

Parameters

$entities : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of deprecated api entities

civicrm_api3_entity_create()

Placeholder function.


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

This should never be called, as it doesn't have any meaning.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_entity_delete()

Placeholder function.


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

This should never be called, as it doesn't have any meaning.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_entity_getfields()

Placeholder function.


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

This should never be called, as it doesn't have any meaning.

Parameters

$params : 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_exception_get()

Get a Dedupe Exception.


    
                    civicrm_api3_exception_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 dedupe exception object property values.

civicrm_api3_exception_create()

Create or update an dedupe exception.


    
                    civicrm_api3_exception_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_exception_delete()

Delete an existing Exception.


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

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

Parameters

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

Return values

array<string|int, mixed> —

api result array

civicrm_api3_extension_install()

Install an extension.


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

Parameters

$params : array<string|int, mixed>

Input parameters.

key: string, eg "com.example.myextension"
keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")
path: string, e.g. "/var/www/extensions/*"

Using 'keys' should be more performant than making multiple API calls with 'key'

Return values

array<string|int, mixed>

_civicrm_api3_extension_install_spec()

Spec function for getfields


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

Parameters

$fields : array<string|int, mixed>

civicrm_api3_extension_upgrade()

Upgrade an extension - runs upgrade_N hooks and system.flush.


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

Return values

array<string|int, mixed> —

API result

civicrm_api3_extension_enable()

Enable an extension.


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

Parameters

$params : array<string|int, mixed>

Input parameters.

key: string, eg "com.example.myextension"
keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")
path: string, e.g. "/var/www/vendor/foo/myext" or "/var/www/vendor/*"

Using 'keys' should be more performant than making multiple API calls with 'key'

Return values

array<string|int, mixed>

_civicrm_api3_extension_enable_spec()

Spec function for getfields


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

Parameters

$fields : array<string|int, mixed>

civicrm_api3_extension_disable()

Disable an extension.


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

Parameters

$params : array<string|int, mixed>

Input parameters.

key: string, eg "com.example.myextension"
keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")
path: string, e.g. "/var/www/vendor/foo/myext" or "/var/www/vendor/*"

Using 'keys' should be more performant than making multiple API calls with 'key'

Return values

array<string|int, mixed>

_civicrm_api3_extension_disable_spec()

Spec function for getfields


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

Parameters

$fields : array<string|int, mixed>

civicrm_api3_extension_uninstall()

Uninstall an extension.


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

Parameters

$params : array<string|int, mixed>

Input parameters.

key: string, eg "com.example.myextension"
keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")
path: string, e.g. "/var/www/vendor/foo/myext" or "/var/www/vendor/*"

Using 'keys' should be more performant than making multiple API calls with 'key'

Return values

array<string|int, mixed>

_civicrm_api3_extension_uninstall_spec()

Spec function for getfields


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

Parameters

$fields : array<string|int, mixed>

civicrm_api3_extension_download()

Download and install an extension.


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

Parameters

$params : array<string|int, mixed>

Input parameters.

key: string, eg "com.example.myextension"
url: string eg "http://repo.com/myextension-1.0.zip"

Return values

array<string|int, mixed> —

API result

_civicrm_api3_extension_download_spec()

Spec function for getfields


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

Parameters

$fields : array<string|int, mixed>

civicrm_api3_extension_refresh()

Download and install an extension.


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

Parameters

$params : array<string|int, mixed>

Input parameters.

local: bool, whether to rescan local filesystem (default: TRUE)
remote: bool, whether to rescan remote repository (default: TRUE)

Return values

array<string|int, mixed> —

API result

_civicrm_api3_extension_refresh_spec()

Spec function for getfields


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

Parameters

$fields : array<string|int, mixed>

civicrm_api3_extension_get()

Get a list of available extensions.


    
                    civicrm_api3_extension_get(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_extension_getremote()

Get a list of remotely available extensions.


    
                    civicrm_api3_extension_getremote(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_getKeys()

Determine the list of extension keys.


    
                    _civicrm_api3_getKeys(array<string|int, mixed> $params[, string $key = 'keys' ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>

$key : string = 'keys'

API request params with 'keys' or 'path'.

keys: A comma-delimited list of extension names
path: An absolute directory path. May append '*' to match all sub-directories.

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_job_log_get()

Retrieve one or more job log record.


    
                    civicrm_api3_job_log_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_log_create()

Create one or more job log record.


    
                    civicrm_api3_job_log_create(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_log_delete()

Delete one or more job log record.


    
                    civicrm_api3_job_log_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_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

run()


    
                    run() : mixed

run()


    
                    run() : mixed

run()


    
                    run() : mixed

run()


    
                    run() : mixed

run()


    
                    run() : mixed

_civicrm_api3_permissions()

Decide what permissions to check for an api call


    
                    _civicrm_api3_permissions(string $entity, string $action, array<string|int, mixed> &$params) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed> —

Array of permissions to check for this entity-action combo

smarty_block_crmButton()

Generate the html for a button-style link


    
                    smarty_block_crmButton(array<string|int, mixed> $params, string $text, CRM_Core_Smarty &$smarty, bool &$repeat) : string|null

Parameters

$params : array<string|int, mixed>: Params of the {crmButton} call.
$text : string: Contents of block.
$smarty : CRM_Core_Smarty: The Smarty object.
$repeat : bool: Repeat is true for the opening tag, false for the closing tag

Return values

string|null —

The generated html.

smarty_block_crmPermission()

Show block conditionally, based on the permission


    
                    smarty_block_crmPermission(array<string|int, mixed> $params, mixed $content, CRM_Core_Smarty &$smarty, bool &$repeat) : string

/**

Parameters

$params : array<string|int, mixed>: Array containing the permission/s to check and optional contact ID.
$content : mixed
$smarty : CRM_Core_Smarty: The Smarty object.
$repeat : bool: Repeat is true for the opening tag, false for the closing tag

Return values

string —

The content in the black, if allowed.

smarty_block_crmRegion()

Smarty block function for defining content-regions which can be dynamically-altered


    
                    smarty_block_crmRegion(array<string|int, mixed> $params, string $content, CRM_Core_Smarty &$smarty, mixed &$repeat) : string

Parameters

$params : array<string|int, mixed>: Must define 'name'.
$content : string: Default content.
$smarty : CRM_Core_Smarty: The Smarty object.
$repeat : mixed

Return values

string

smarty_block_crmScope()

Smarty block function to temporarily define variables.


    
                    smarty_block_crmScope(array<string|int, mixed> $params, string $content, Smarty_Internal_Template &$smarty, mixed &$repeat) : string

Example:

{tsScope x=1}
  Expect {$x}==1
  {tsScope x=2}
    Expect {$x}==2
  {/tsScope}
  Expect {$x}==1
{/tsScope}

Parameters

$params : array<string|int, mixed>: Must define 'name'.
$content : string: Default content.
$smarty : Smarty_Internal_Template: The Smarty object.
$repeat : mixed

Return values

string

smarty_block_crmUpgradeSnapshot()

Generate a pre-upgrade data-snapshot -- if the local policy supports them.


    
                    smarty_block_crmUpgradeSnapshot(array<string|int, mixed> $params, string|null $text, CRM_Core_Smarty &$smarty, bool &$repeat) : string|null

(Rule of thumb: Small databases enable snapshots. Large databases and multi-lingual databases do not. Some sysadmins may force-enable or force-disable snapshots.)

Example: Before modifying civicrm_foobar.some_field, make a snapshot of that column

{crmUpgradeSnapshot name=foobar} SELECT id, some_field FROM civicrm_foobar {/crmUpgradeSnapshot} UPDATE civicrm_foobar SET some_field = 999 WHERE some_field = 666;

TIP: If you are modifying a large table (like civicrm_contact or civicrm_mailing_event_queue), then you probably shouldn't use *.mysql.tpl because it doesn't paginate operations. Similarly, {crmUpgradeSnapshot} doesn't paginate. For pagination, use non-Smarty upgrade-tasks.

Parameters

$params : array<string|int, mixed>
$text : string|null: The SELECT query which supplies the interesting data to be stored in the snapshot.
$smarty : CRM_Core_Smarty
$repeat : bool: Repeat is true for the opening tag, false for the closing tag

Return values

string|null

smarty_block_edit()

Smarty block function providing edit-only display support


    
                    smarty_block_edit(array<string|int, mixed> $params, string $text, CRM_Core_Smarty &$smarty, bool &$repeat) : string|null

Parameters

$params : array<string|int, mixed>: Template call's parameters.
$text : string: {edit} block contents from the template.
$smarty : CRM_Core_Smarty: The Smarty object.
$repeat : bool: Repeat is true for the opening tag, false for the closing tag

Return values

string|null —

the string, translated by gettext

smarty_block_htxt()

Smarty block function providing support for CiviCRM's helptext mechanism


    
                    smarty_block_htxt(array<string|int, mixed> $params, string $text, CRM_Core_Smarty $smarty, bool &$repeat) : string|null

Parameters

$params : array<string|int, mixed>: Template call's parameters.
$text : string: {ts} block contents from the template.
$smarty : CRM_Core_Smarty: The Smarty object.
$repeat : bool: Repeat is true for the opening tag, false for the closing tag

Return values

string|null —

the string, translated by gettext

smarty_block_icon()

Display an icon with some alternative text.


    
                    smarty_block_icon(mixed $params, mixed $text, mixed &$smarty, bool &$repeat) : string|null

This is a wrapper around CRM_Core_Page::icon().

Parameters

$params : mixed

condition: if present and falsey, return empty
icon: the icon class to display instead of fa-check
anything else is passed along as attributes for the icon

$text : mixed

The translated text to include in the icon's title and screen-reader text.

$smarty : mixed

$repeat : bool

Repeat is true for the opening tag, false for the closing tag

Return values

string|null

smarty_block_localize()

Smarty block function for multilingualizing upgrade SQL queries.


    
                    smarty_block_localize(array<string|int, mixed> $params, string $text, CRM_Core_Smarty $smarty, bool &$repeat) : string

The string passed in $text is repeated locale-number times, with the param field (if provided) appended with a different locale every time.

Parameters

$params : array<string|int, mixed>: Template call's parameters.
$text : string: {ts} block contents from the template.
$smarty : CRM_Core_Smarty: The Smarty object.
$repeat : bool: Confusing variable that means it's either the opening tag or you can use it to signal back not to repeat.

Return values

string —

multilingualized query

smarty_block_ts()

Smarty block function providing gettext support


    
                    smarty_block_ts(array<string|int, mixed> $params, string $text, CRM_Core_Smarty &$smarty, bool &$repeat) : string|null

See CRM_Core_I18n class documentation for details.

Parameters

$params : array<string|int, mixed>: Template call's parameters.
$text : string: {ts} block contents from the template.
$smarty : CRM_Core_Smarty: The Smarty object.
$repeat : bool: Repeat is true for the opening tag, false for the closing tag

Return values

string|null —

the string, translated by gettext

smarty_block_url()

Generate a URL. This is thin wrapper for the Civi::url() helper.


    
                    smarty_block_url(array<string|int, mixed> $params, string $text, CRM_Core_Smarty &$smarty, bool &$repeat) : string

Parameters

$params : array<string|int, mixed>

The following parameters have specific meanings:

"assign" (string) - Assign output to a Smarty variable
"flags" (string) - List of options, as per Civi::url(...$flags) All other parameters will be passed-through as variables for the URL.

$text : string

Contents of block.

$smarty : CRM_Core_Smarty

The Smarty object.

$repeat : bool

Repeat is true for the opening tag, false for the closing tag

Return values

string

smarty_compiler_continue()

Skip remaining logic in the current iteration of a loop.


    
                    smarty_compiler_continue(mixed $contents, mixed &$smarty) : string

Parameters

$contents : mixed
$smarty : mixed

Return values

string

smarty_function_copyIcon()

Display a copy icon that copies the first row's values down.


    
                    smarty_function_copyIcon(mixed $params, mixed &$smarty) : string

Parameters

$params : mixed

name: the field name
title: the field title

$smarty : mixed

Return values

string

smarty_function_crmAPI()


    
                    smarty_function_crmAPI(mixed $params, mixed &$smarty) : string|void

Parameters

$params : mixed
$smarty : mixed

Return values

string|void

smarty_function_crmAttributes()

Formats an array of attributes as html


    
                    smarty_function_crmAttributes(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : string

Parameters

$params : array<string|int, mixed>: ['a'] array of attributes.
$smarty : CRM_Core_Smarty

Return values

string

smarty_function_crmCrudLink()

Dynamically construct a link based on an entity-type and entity-id.


    
                    smarty_function_crmCrudLink(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : string

Parameters

$params : array<string|int, mixed>

Array with keys:

entity|table: string
id: int
action: string, 'view', 'update', 'delete', etc [default: view]
title: string [optionally override default title]

$smarty : CRM_Core_Smarty

Return values

string

smarty_function_crmGetAttribute()

Fetch an attribute from html


    
                    smarty_function_crmGetAttribute(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : string

Parameters

$params : array<string|int, mixed>
$smarty : CRM_Core_Smarty

Return values

string

smarty_function_crmKey()

Generate a CRM_Core_Key of a given name


    
                    smarty_function_crmKey(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : string

Parameters

$params : array<string|int, mixed>: Params of the {crmKey} call, with the ‘name’ key holding the name of the key.
$smarty : CRM_Core_Smarty: The Smarty object.

Return values

string —

the generated key

smarty_function_crmResPath()

Determine the path of a resource file


    
                    smarty_function_crmResPath(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : string

Parameters

$params : array<string|int, mixed>

Identify the resource by either 'ext'+'file' or 'expr'.

Array with keys:

ext: string, extension name. see CRM_Core_Resources::getPath
file: string, relative file path. see CRM_Core_Resources::getPath
expr: string, a dynamic path expression. See: \Civi\Core\Paths::getPath()

$smarty : CRM_Core_Smarty

Return values

string

smarty_function_crmResURL()

Determine the URL of a resource file


    
                    smarty_function_crmResURL(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : string

Parameters

$params : array<string|int, mixed>

Identify the resource by either 'ext'+'file' or 'expr'.

Array with keys:

ext: string, extension name. see CRM_Core_Resources::getUrl
file: string, relative file path. see CRM_Core_Resources::getUrl
expr: string, a dynamic path expression. See: \Civi\Core\Paths::getUrl()

$smarty : CRM_Core_Smarty

Return values

string

smarty_function_crmScript()

Add a Javascript file to a specific part of the page


    
                    smarty_function_crmScript(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : mixed

Parameters

$params : array<string|int, mixed>

Array with keys:

ext: string, extension name. see CRM_Core_Resources::addScriptFile
file: string, relative file path. see CRM_Core_Resources::addScriptFile
url: string. see CRM_Core_Resources::addScriptURL
weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)
region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')

$smarty : CRM_Core_Smarty

smarty_function_crmSetting()

Retrieve CiviCRM settings from the api for use in templates.


    
                    smarty_function_crmSetting(mixed $params, mixed &$smarty) : int|string|null

Parameters

$params : mixed
$smarty : mixed

Return values

int|string|null

smarty_function_crmSigner()

Generate a secure signature


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

{code} {crmSigner var=mySig extra=123} var urlParams = ts={$mySig.ts}&extra={$mySig.extra}&sig={$mySig.signature} {endcode}

Parameters

$params : array<string|int, mixed>

Array with keys:

var: string, a smarty variable to generate
ts: int, the current time (if omitted, autogenerated)
any other vars are put into the signature (sorted)

$smarty : mixed

smarty_function_crmStyle()

Add a stylesheet <LINK> to a specific part of the page


    
                    smarty_function_crmStyle(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : mixed

Parameters

$params : array<string|int, mixed>

Array with keys:

ext: string, extension name. see CRM_Core_Resources::addStyleFile
file: string, relative file path. see CRM_Core_Resources::addStyleFile
url: string. see CRM_Core_Resources::addStyleURL
weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)
region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')

$smarty : CRM_Core_Smarty

smarty_function_crmURL()

Generate a URL.


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

Ex: {crmURL p='civicrm/acl/entityrole' q='reset=1'} Ex: {crmURL p='civicrm/profile/create' q='id=123&reset=1' fe=1}

Each URL component uses an abbreviation (e.g. "p"<=>"path"; "q"<=>"query").

Parameters

$params : array<string|int, mixed>

List of URL properties.

"p" (string $path) The path being linked to, such as "civicrm/add".
"q" (array|string $query) A query string to append to the link, or an array of key-value pairs.
"a" (bool $absolute) Whether to force the output to be an absolute link (beginning with a URI-scheme such as 'http:'). Useful for links that will be displayed outside the site, such as in an RSS feed.
"f" (string $fragment) A "#" fragment to append to the link. This could a named anchor (as in #section2) or a client-side route (as in #/mailing/new).
"h" (bool $htmlize) Whether to encode special html characters such as &.
"fe" (bool $frontend) This link should be to the CMS front end (applies to WP & Joomla).
"fb" (bool $forceBackend) This link should be to the CMS back end (applies to WP & Joomla).

Return values

string

smarty_function_crmVersion()

Display the CiviCRM version


    
                    smarty_function_crmVersion(mixed $params, mixed &$smarty) : string

The version is {crmVersion}.

{crmVersion redact=auto assign=ver}The version is {$ver}.

Parameters

$params : mixed
$smarty : mixed

Return values

string

smarty_function_docURL()

Given one of: ( page, title, text ) parameters, generates an HTML link to documentation.


    
                    smarty_function_docURL(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : string|null

Parameters

$params : array<string|int, mixed>: The function params.
$smarty : CRM_Core_Smarty: Reference to the smarty object.

Return values

string|null —

HTML code of a link to documentation

smarty_function_help()

Adds inline help.


    
                    smarty_function_help(array<string|int, mixed> $params, Smarty $smarty) : string

This function adds a call to the js function which loads the help text in a pop-up.

It does a lot of work to get the title which it passes into the crmHelp function but the main reason it gets that title is because it adds that to the css as title & aria-label. Since it's loaded it somewhat makes sense to pass it into CRM.help but .. it's confusing.

Parameters

$params : array<string|int, mixed>: The function params.
$smarty : Smarty: Smarty object.

Return values

string —

the help html to be inserted

smarty_function_isValueChange()

Smarty function for checking change in a property's value, for example when looping through an array.


    
                    smarty_function_isValueChange(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : null

Smarty param: string $key unique identifier for this property (REQUIRED) Smarty param: mixed $value the current value of the property Smarty param: string $assign name of template variable to which to assign result

Parameters

$params : array<string|int, mixed>: Template call's parameters.
$smarty : CRM_Core_Smarty: The Smarty object.

Return values

null

smarty_function_privacyFlag()

Display a banned icon to flag privacy preferences


    
                    smarty_function_privacyFlag(mixed $params, mixed &$smarty) : string

Parameters

$params : mixed

field: the applicable privacy field (one of CRM_Core_SelectValues::privacy() or on_hold)
condition: if present and falsey, return empty

$smarty : mixed

Return values

string

smarty_function_sectionTotal()

Smarty block function for printing the correct report section total

This is called from table.tpl but we aim to remove from there.


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

Smarty param: string $key value of the current section column Smarty param: int $depth the depth of the current section (sections declared first have lesser depth, starting at 0)

Parameters

$params : array<string|int, mixed>: Template call's parameters.

Return values

string —

the string, translated by gettext

smarty_function_simpleActivityContacts()

Get details for the target and assignee contact of an activity.


    
                    smarty_function_simpleActivityContacts(array<string|int, mixed> $params, CRM_Core_Smarty &$smarty) : string

This is "simple" in that it is only appropriate for activities in which the business-process guarantees that there is only one target and one assignee. If the business-process permits multiple targets or multiple assignees, then consider the more versatile (but less sugary) function "crmAPI".

Note: This will perform like a dog, but who cares -- at most, we deal with O(100) iterations as part of a background task.

Parameters

$params : array<string|int, mixed>

, Array with keys:

activity_id: int, required
target_var: string, optional; name of a variable which will store the first/only target contact; default "target"
assignee_var: string, optional; name of a variable which will store the first/only assignee contact; default "assignee"
return: string, optional; comma-separated list of fields to return for each contact

$smarty : CRM_Core_Smarty

Return values

string

smarty_modifier_colorContrast()

Wrapper around CRM_Utils_Color::getContrast


    
                    smarty_modifier_colorContrast(string $color) : string

Parameters

$color : string

Return values

string

smarty_modifier_crmAddClass()

Add a class to an html element


    
                    smarty_modifier_crmAddClass(string $string, string $class) : string

Parameters

$string : string: The html to be tweaked.
$class : string: The new class or classes to add (separate with a space).

Return values

string —

the new modified html string

smarty_modifier_crmBtnType()

Grab the button type from a passed button element 'name' by checking for reserved QF button type strings


    
                    smarty_modifier_crmBtnType(string $btnName) : string

Parameters

$btnName : string

Return values

string —

button type, one of: 'upload', 'next', 'back', 'cancel', 'refresh' 'submit', 'done', 'display', 'jump' 'process'

smarty_modifier_crmCountCharacters()

Smarty count_characters modifier plugin


    
                    smarty_modifier_crmCountCharacters(string $string[, bool $include_spaces = FALSE ]) : int

Type: modifier
Name: crmCountCharacteres
Purpose: count the number of characters in a text with handling for NULL values

Parameters

$string : string
$include_spaces : bool = FALSE: include whitespace in the character count

Return values

int

smarty_modifier_crmDate()

Convert the date string "YYYY-MM-DD" to "MM<long> DD, YYYY".


    
                    smarty_modifier_crmDate(string $dateString[, string|null $dateFormat = NULL ][, bool $onlyTime = FALSE ]) : string

Parameters

$dateString : string

Date which needs to converted to human readable format.

$dateFormat : string|null = NULL

A string per https://www.php.net/manual/en/function.strftime.php or one of our configured formats name - eg

dateformatDatetime
dateformatFull
dateformatPartial
dateformatTime
dateformatYear
dateformatFinancialBatch
dateformatshortdate

$onlyTime : bool = FALSE

Return values

string —

human readable date format | invalid date message

smarty_modifier_crmDelete()

Replace the value of an attribute in the input string. Assume the the attribute is well formed, of the type name="value". If no replacement is mentioned the value is inserted at the end of the form element


    
                    smarty_modifier_crmDelete(string $string, string $attribute) : string

Parameters

$string : string: The html to be tweaked with.
$attribute : string: The attribute to modify.

Return values

string —

the new modified html string

smarty_modifier_crmFirstWord()

Replace a string with the first word in the string


    
                    smarty_modifier_crmFirstWord(string $string) : string

Parameters

$string : string: The html to be tweaked with.

Return values

string

smarty_modifier_crmICalDate()

Format the given text in an ical suitable format


    
                    smarty_modifier_crmICalDate(string $str[, bool $gdata = FALSE ]) : string

Parameters

$str : string
$gdata : bool = FALSE

Return values

string —

formatted text

smarty_modifier_crmICalText()

Format the given text in an ical suitable format


    
                    smarty_modifier_crmICalText(string $str[, mixed $keep_html = FALSE ][, mixed $position = 0 ]) : string

Parameters

$str : string
$keep_html : mixed = FALSE
$position : mixed = 0

Return values

string —

formatted text

smarty_modifier_crmInsert()


    
                    smarty_modifier_crmInsert(string $string, string $attribute, string $value[, string $insertBefore = '/>' ]) : string

Parameters

$string : string: The html to be tweaked with.
$attribute : string: The attribute to insert.
$value : string: The new attribute value.
$insertBefore : string = '/>': The string before which we want this tag inserted.

Return values

string —

the new modified html string

smarty_modifier_crmMoney()

Format the given monetary amount (and currency) for display


    
                    smarty_modifier_crmMoney(string|int|float $amount[, string|null $currency = NULL ][, string|null $locale = NULL ]) : string

Parameters

$amount : string|int|float: The monetary amount up for display.
$currency : string|null = NULL: The (optional) currency.
$locale : string|null = NULL: The (optional) locale.

Return values

string —

formatted monetary amount

smarty_modifier_crmNumberFormat()

Add thousands separator to numeric strings using PHP number_format() function.


    
                    smarty_modifier_crmNumberFormat(float $number[, int $decimals = 0 ][, string $dec_point = NULL ][, string $thousands_sep = NULL ]) : string

Parameters

$number : float: Numeric value to be formatted.
$decimals : int = 0: Number of decimal places.
$dec_point : string = NULL: Decimal point character (if other than ".").
$thousands_sep : string = NULL: Thousands sep character (if other than ",").

Return values

string —

the formatted string

For alternate decimal point and thousands separator, delimit values with single quotes in the template. EXAMPLE: {$number|crmNumberFormat:2:',':' '} for French notation - 1234.56 becomes 1 234,56

smarty_modifier_crmReplace()


    
                    smarty_modifier_crmReplace(string $string, string $attribute, string $value) : string

Parameters

$string : string: The html to be tweaked with.
$attribute : string: The attribute to modify.
$value : string: The new attribute value.

Return values

string —

the new modified html string

smarty_modifier_crmRSSPubDate()

Format the given date to RSS pubDate RFC822 format, http://www.w3.org/Protocols/rfc822/#z28


    
                    smarty_modifier_crmRSSPubDate(string $dateString) : string

Parameters

$dateString : string: Date which needs to converted to RFC822 format.

Return values

string —

formatted text

smarty_modifier_crmStripAlternatives()

Given an ezComponents-parsed representation of a text with alternatives return only the first one


    
                    smarty_modifier_crmStripAlternatives(string $full) : string

Parameters

$full : string: All alternatives as a long string (or some other text).

Return values

string —

only the first alternative found (or the text without alternatives)

smarty_modifier_crmUpper()

Upper case a string but use the multibyte strtoupper function to better handle accents / umlaut


    
                    smarty_modifier_crmUpper(string $string) : string

Parameters

$string : string: the string to upper case

Return values

string

smarty_modifier_htmlize()

Convert a given text part a better HTML representation (add paragraphs and make URLs clickable)


    
                    smarty_modifier_htmlize(string $text) : string

Parameters

$text : string: Text to HTML-ize.

Return values

string —

HTML-ized version of $text

smarty_modifier_json()

Convert the data to a JSON string


    
                    smarty_modifier_json(mixed $data) : string

Example usage: {$myArray|@json}

Parameters

$data : mixed

Return values

string —

JSON

smarty_modifier_mb_truncate()

Smarty mb_truncate modifier plugin


    
                    smarty_modifier_mb_truncate(string $string[, int $length = 80 ][, string $etc = '...' ][, bool $break_words = FALSE ]) : string

Type: modifier
Name: mb_truncate
Purpose: Truncate a string to a certain length if necessary, optionally splitting in the middle of a word, and appending the $etc string. Multibyte version.

Parameters

$string : string
$length : int = 80
$etc : string = '...'
$break_words : bool = FALSE

Return values

string

smarty_modifier_nl2brIfNotHTML()

If the given string looks like HTML, do nothing and return it.


    
                    smarty_modifier_nl2brIfNotHTML(string $text) : string

If it doesn't, replace newlines with br tags. The HTML check is somewhat greedy and may not add br tags to some non-HTML text that contains angle brackets.

Parameters

$text : string

Return values

string —

Text with br tags if input was non-HTML.

smarty_modifier_print_array()

Smarty print_array modifier plugin


    
                    smarty_modifier_print_array(array<string|int, mixed>|object $var[, int $depth = 0 ][, int $length = 40 ]) : string

Type: modifier
Name: print_array
Purpose: formats array for output in DAO files and in APIv3 Examples To find where this is used do a grep in Smarty templates for |@print_array

Parameters

$var : array<string|int, mixed>|object
$depth : int = 0
$length : int = 40

Return values

string

smarty_modifier_purify()

Purify HTML to mitigate against XSS attacks


    
                    smarty_modifier_purify(string $text) : string

Parameters

$text : string: Input text, potentially containing XSS

Return values

string —

Output text, containing only clean HTML

smarty_modifier_smarty()

Implement smarty:nodefaults for Smarty3.


    
                    smarty_modifier_smarty(string $string, string $modifier) : string

Adding |smarty:nodefaults to strings is the smarty v2 way to indicates that a string should not be escaped. It doesn't work with smarty 3 but it is a useful way to make strings findable for this purpose as we figure out the best way for smarty 3.

As a bridging mechanism this ensures the modifiers added in v2 do not error in v3.

Eventually we want to run v3/v4 to escape by default but we are deferring that challenge until we have achieved the first set of upgrading to v3.

Parameters

$string : string: The html to be tweaked.
$modifier : string: Either nodefaults or nothing

Return values

string —

the new modified html string

smarty_modifier_substring()

Smarty plugin Type: modifier Name: substring Version: 0.1 Date: 2006-16-02 Author: Thorsten Albrecht <thor_REMOVE.THIS_@wolke7.net> Purpose: "substring" allows you to retrieve a small part (substring) of a string.


    
                    smarty_modifier_substring(string $string, int $position, int $length) : string

Notes: The substring is specified by giving the start position and the length. Unlike the original function substr() in PHP the position of the characters in the string starts at 1 (not at 0 as usual in php). Example smarty code: {$my_string|substring:2:4} returns substring from character 2 until character 6

Parameters

$string : string
$position : int: startposition of the substring, beginning with 0
$length : int: length of substring

Return values

string

smarty_prefilter_htxtFilter()

The content of an "{htxt}" block should not be evaluated unless the active request is relevant. Otherwise, it will try to evaluate unassigned variables.


    
                    smarty_prefilter_htxtFilter(string $tpl_source) : string

Parameters

$tpl_source : string

Return values

string

smarty_prefilter_resetExtScope()

Wrap every Smarty template in a {crmScope} tag that sets the variable "extensionKey" to blank.


    
                    smarty_prefilter_resetExtScope(string $tpl_source) : string

Parameters

$tpl_source : string

Return values

string

civicrm_smarty_resource_string_get_template()


    
                    civicrm_smarty_resource_string_get_template(mixed $tpl_name, mixed &$tpl_source) : bool

Parameters

$tpl_name : mixed
$tpl_source : mixed

Return values

bool

civicrm_smarty_resource_string_get_timestamp()


    
                    civicrm_smarty_resource_string_get_timestamp(string $tpl_name, mixed &$tpl_timestamp) : bool

Parameters

$tpl_name : string
$tpl_timestamp : mixed

Return values

bool

civicrm_smarty_resource_string_get_secure()


    
                    civicrm_smarty_resource_string_get_secure() : bool

Return values

bool

civicrm_smarty_resource_string_get_trusted()


    
                    civicrm_smarty_resource_string_get_trusted() : mixed

civicrm_smarty_register_string_resource()


    
                    civicrm_smarty_register_string_resource() : mixed

crm_smarty_compatibility_get_path()

Get the path to load Smarty.


    
                    crm_smarty_compatibility_get_path() : string|null

Return values

string|null

generateJoomlaConfig()


    
                    generateJoomlaConfig(mixed $version) : mixed

Parameters

$version : mixed

repo()

Make a small report about the git content in a given folder+branch.


    
                    repo(string $path, string $branch) : array<string|int, mixed>

Parameters

$path : string
$branch : string

Return values

array<string|int, mixed> —

branch: string
commit: string

_afform_admin_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _afform_admin_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_afform_admin_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _afform_admin_civix_civicrm_install() : mixed

_afform_admin_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _afform_admin_civix_civicrm_enable() : void

_afform_admin_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _afform_admin_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_afform_admin_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _afform_admin_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_admin_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _afform_admin_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_admin_civix_fixNavigationMenuItems()


    
                    _afform_admin_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

afform_admin_civicrm_config()

Implements hook_civicrm_config().


    
                    afform_admin_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

afform_admin_civicrm_install()

Implements hook_civicrm_install().


    
                    afform_admin_civicrm_install() : mixed

afform_admin_civicrm_enable()

Implements hook_civicrm_enable().


    
                    afform_admin_civicrm_enable() : mixed

_afform_civix_class_loader()


    
                    _afform_civix_class_loader(mixed $class) : mixed

Parameters

$class : mixed

_afform_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _afform_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_afform_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _afform_civix_civicrm_install() : mixed

_afform_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _afform_civix_civicrm_enable() : void

_afform_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _afform_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_afform_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _afform_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _afform_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_civix_fixNavigationMenuItems()


    
                    _afform_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

_afform_fields_filter()

Filter the content of $params to only have supported afform fields.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

afform_civicrm_config()

Implements hook_civicrm_config().


    
                    afform_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

afform_civicrm_install()

Implements hook_civicrm_install().


    
                    afform_civicrm_install() : mixed

afform_civicrm_enable()

Implements hook_civicrm_enable().


    
                    afform_civicrm_enable() : mixed

afform_civicrm_managed()

Implements hook_civicrm_managed().


    
                    afform_civicrm_managed(mixed &$entities, mixed $modules) : mixed

Generate a list of entities to create/deactivate/delete when this module is installed, disabled, uninstalled.

Parameters

$entities : mixed
$modules : mixed

afform_civicrm_tabset()

Implements hook_civicrm_tabset().


    
                    afform_civicrm_tabset(mixed $tabsetName, mixed &$tabs, mixed $context) : mixed

Adds afforms as contact summary tabs.

Parameters

$tabsetName : mixed
$tabs : mixed
$context : mixed

afform_civicrm_pageRun()

Implements hook_civicrm_pageRun().


    
                    afform_civicrm_pageRun(mixed &$page) : mixed

Adds afforms as contact summary blocks.

Parameters

$page : mixed

afform_civicrm_contactSummaryBlocks()

Implements hook_civicrm_contactSummaryBlocks().


    
                    afform_civicrm_contactSummaryBlocks(mixed &$blocks) : mixed

Parameters

$blocks : mixed

_afform_get_contact_types()

Resolve a mixed list of contact types and sub-types into just top-level contact types (Individual, Organization, Household)


    
                    _afform_get_contact_types(array<string|int, mixed> $mixedTypes) : array<string|int, mixed>

Parameters

$mixedTypes : array<string|int, mixed>

Return values

array<string|int, mixed>

_afform_hook_civicrm_angularModules()

Late-listener for Angular modules: adds all Afforms and their dependencies.


    
                    _afform_hook_civicrm_angularModules(GenericHookEvent $e) : mixed

Must run last so that all other modules are present for reverse-dependency mapping.

Parameters

$e : GenericHookEvent

_afform_get_partials()

Callback to retrieve partials for a given afform/angular module.


    
                    _afform_get_partials(string $moduleName, array<string|int, mixed> $module) : array<string|int, mixed>

Parameters

$moduleName : string: The module name.
$module : array<string|int, mixed>: The module definition.

Return values

array<string|int, mixed> —

Array(string $filename => string $html).

afform_civicrm_buildAsset()

Implements hook_civicrm_buildAsset().


    
                    afform_civicrm_buildAsset(mixed $asset, mixed $params, mixed &$mimeType, mixed &$content) : mixed

Parameters

$asset : mixed
$params : mixed
$mimeType : mixed
$content : mixed

afform_civicrm_alterMenu()

Implements hook_civicrm_alterMenu().


    
                    afform_civicrm_alterMenu(mixed &$items) : mixed

Parameters

$items : mixed

afform_civicrm_permission()

Implements hook_civicrm_permission().


    
                    afform_civicrm_permission(mixed &$permissions) : mixed

Define Afform permissions.

Parameters

$permissions : mixed

afform_civicrm_permission_check()

Implements hook_civicrm_permission_check().


    
                    afform_civicrm_permission_check(mixed $permission, mixed &$granted, mixed $contactId) : mixed

This extends the list of permissions available in CRM_Core_Permission:check() by introducing virtual-permissions named @afform:myForm. The evaluation of these virtual-permissions is dependent on the settings for myForm. myForm may be exposed/integrated through multiple subsystems (routing, nav-menu, API, etc), and the use of virtual-permissions makes easy to enforce consistent permissions across any relevant subsystems.

Parameters

$permission : mixed
$granted : mixed
$contactId : mixed

afform_civicrm_permissionList()

Implements hook_civicrm_permissionList().


    
                    afform_civicrm_permissionList(mixed &$permissions) : mixed

Parameters

$permissions : mixed

_afform_clear()

Clear any local/in-memory caches based on afform data.


    
                    _afform_clear() : mixed

_afform_angular_module_name()


    
                    _afform_angular_module_name(string $fileBaseName[, string $format = 'camel' ]) : string

Parameters

$fileBaseName : string: Ex: foo-bar
$format : string = 'camel': 'camel' or 'dash'.

Return values

string —

Ex: 'FooBar' or 'foo-bar'.

afform_civicrm_preProcess()

Implements hook_civicrm_preProcess().


    
                    afform_civicrm_preProcess(mixed $formName, mixed &$form) : mixed

Wordpress only: Adds Afforms to the shortcode dialog (when editing pages/posts).

Parameters

$formName : mixed
$form : mixed

afform_civicrm_pre()

Implements hook_civicrm_pre().


    
                    afform_civicrm_pre(mixed $op, mixed $entity, mixed $id, mixed &$params) : mixed

Parameters

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

afform_civicrm_referenceCounts()

Implements hook_civicrm_referenceCounts().


    
                    afform_civicrm_referenceCounts(mixed $dao, mixed &$counts) : mixed

Parameters

$dao : mixed
$counts : mixed

afform_shortcode_content()

Wordpress only: Render Afform content for shortcodes.


    
                    afform_shortcode_content(string $content, array<string|int, mixed> $atts, array<string|int, mixed> $args, string $context) : string

Parameters

$content : string: HTML Markup
$atts : array<string|int, mixed>: Shortcode attributes.
$args : array<string|int, mixed>: Existing shortcode arguments.
$context : string: How many shortcodes are present on the page: 'single' or 'multiple'.

Return values

string —

Modified markup.

afform_civicrm_searchKitTasks()

Implements hook_civicrm_searchKitTasks().


    
                    afform_civicrm_searchKitTasks(array<string|int, mixed> &$tasks, bool $checkPermissions, int|null $userID) : mixed

Parameters

$tasks : array<string|int, mixed>
$checkPermissions : bool
$userID : int|null

civicrm_api3_afform_get()

Get a list of afforms.


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

This API exists solely for the purpose of entityRef widgets. All other Afform api functionality is v4.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result

_civicrm_api3_afform_get_spec()


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

Parameters

$fields : array<string|int, mixed>

_civicrm_api3_afform_getlist_params()

Augment parameters for Afform entityRef list.


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

Parameters

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

_civicrm_api3_afform_getlist_output()

Format output for Afform entityRef list.


    
                    _civicrm_api3_afform_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>

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_afform_html_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _afform_html_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_afform_html_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _afform_html_civix_civicrm_install() : mixed

_afform_html_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _afform_html_civix_civicrm_enable() : void

_afform_html_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _afform_html_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_afform_html_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _afform_html_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_html_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _afform_html_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_html_civix_fixNavigationMenuItems()


    
                    _afform_html_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

afform_html_civicrm_config()

Implements hook_civicrm_config().


    
                    afform_html_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

afform_html_civicrm_install()

Implements hook_civicrm_install().


    
                    afform_html_civicrm_install() : mixed

afform_html_civicrm_enable()

Implements hook_civicrm_enable().


    
                    afform_html_civicrm_enable() : mixed

_afform_login_token_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _afform_login_token_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_afform_login_token_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _afform_login_token_civix_civicrm_install() : mixed

_afform_login_token_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _afform_login_token_civix_civicrm_enable() : void

_afform_login_token_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _afform_login_token_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_afform_login_token_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _afform_login_token_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_login_token_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _afform_login_token_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_login_token_civix_fixNavigationMenuItems()


    
                    _afform_login_token_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

afform_login_token_civicrm_config()

Implements hook_civicrm_config().


    
                    afform_login_token_civicrm_config(mixed &$config) : void

Parameters

$config : mixed

afform_login_token_civicrm_install()

Implements hook_civicrm_install().


    
                    afform_login_token_civicrm_install() : void

afform_login_token_civicrm_enable()

Implements hook_civicrm_enable().


    
                    afform_login_token_civicrm_enable() : void

_afform_mock_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _afform_mock_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_afform_mock_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _afform_mock_civix_civicrm_install() : mixed

_afform_mock_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _afform_mock_civix_civicrm_enable() : void

_afform_mock_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _afform_mock_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_afform_mock_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _afform_mock_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_mock_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _afform_mock_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_afform_mock_civix_fixNavigationMenuItems()


    
                    _afform_mock_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

afform_mock_civicrm_config()

Implements hook_civicrm_config().


    
                    afform_mock_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

afform_mock_civicrm_install()

Implements hook_civicrm_install().


    
                    afform_mock_civicrm_install() : mixed

afform_mock_civicrm_enable()

Implements hook_civicrm_enable().


    
                    afform_mock_civicrm_enable() : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_authx_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _authx_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_authx_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _authx_civix_civicrm_install() : mixed

_authx_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _authx_civix_civicrm_enable() : void

_authx_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _authx_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_authx_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _authx_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_authx_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _authx_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_authx_civix_fixNavigationMenuItems()


    
                    _authx_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

authx_login()

Perform a system login.


    
                    authx_login(array{flow: ?string, useSession: ?bool, principal: ?array, cred: ?string} $details) : array{contactId: int, userId: ?int, flow: string, credType: string, useSession: bool}

This is useful for backend scripts that need to switch to a specific user.

As needed, this will update the Civi session and CMS data.

Parameters

$details : array{flow: ?string, useSession: ?bool, principal: ?array, cred: ?string}

Describe the authentication process with these properties:

string $flow (default 'script'); The type of authentication flow being used Ex: 'param', 'header', 'auto'
bool $useSession (default FALSE) If TRUE, then the authentication should be persistent (in a session variable). If FALSE, then the authentication should be ephemeral (single page-request).

And then ONE of these properties to describe the user/principal:

string $cred The credential, as formatted in the 'Authorization' header. Ex: 'Bearer 12345', 'Basic ASDFFDSA=='
array $principal Description of a validated principal. Must include 'contactId', 'userId', xor 'user'

Return values

array{contactId: int, userId: ?int, flow: string, credType: string, useSession: bool} —

An array describing the authenticated session.

_authx_uf()


    
                    _authx_uf() : AuthxInterface

Return values

AuthxInterface

_authx_redact()

For parameter-based authentication, this option will hide parameters.


    
                    _authx_redact(array<string|int, mixed> $keys) : mixed

This is mostly a precaution, hedging against the possibility that some routes make broad use of $_GET or $_PARAMS.

Parameters

$keys : array<string|int, mixed>

_authx_reload()

Reload the current page-view.


    
                    _authx_reload(string $route, string $queryString) : mixed

Parameters

$route : string
$queryString : string

authx_civicrm_config()

Implements hook_civicrm_config().


    
                    authx_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

authx_civicrm_install()

Implements hook_civicrm_install().


    
                    authx_civicrm_install() : mixed

authx_civicrm_enable()

Implements hook_civicrm_enable().


    
                    authx_civicrm_enable() : mixed

authx_civicrm_permission()

Implements hook_civicrm_permission().


    
                    authx_civicrm_permission(mixed &$permissions) : mixed

Parameters

$permissions : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_chart_kit_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _chart_kit_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_chart_kit_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _chart_kit_civix_civicrm_install() : mixed

_chart_kit_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _chart_kit_civix_civicrm_enable() : void

_chart_kit_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _chart_kit_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_chart_kit_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _chart_kit_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_chart_kit_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _chart_kit_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_chart_kit_civix_fixNavigationMenuItems()


    
                    _chart_kit_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

chart_kit_civicrm_config()

Implements hook_civicrm_config().


    
                    chart_kit_civicrm_config(mixed &$config) : void

Parameters

$config : mixed

chart_kit_civicrm_install()

Implements hook_civicrm_install().


    
                    chart_kit_civicrm_install() : void

chart_kit_civicrm_enable()

Implements hook_civicrm_enable().


    
                    chart_kit_civicrm_enable() : void

_civi_campaign_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civi_campaign_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civi_campaign_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civi_campaign_civix_civicrm_install() : mixed

_civi_campaign_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civi_campaign_civix_civicrm_enable() : void

_civi_campaign_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civi_campaign_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civi_campaign_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civi_campaign_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_campaign_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civi_campaign_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_campaign_civix_fixNavigationMenuItems()


    
                    _civi_campaign_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

_civi_case_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civi_case_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civi_case_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civi_case_civix_civicrm_install() : mixed

_civi_case_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civi_case_civix_civicrm_enable() : void

_civi_case_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civi_case_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civi_case_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civi_case_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_case_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civi_case_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_case_civix_fixNavigationMenuItems()


    
                    _civi_case_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

civi_case_civicrm_managed()

Implements hook_civicrm_managed().


    
                    civi_case_civicrm_managed(mixed &$entities, mixed $modules) : mixed

Parameters

$entities : mixed
$modules : mixed

civi_case_civicrm_selectWhereClause()

Applies Case permissions to Activities


    
                    civi_case_civicrm_selectWhereClause(mixed $entityName, mixed &$clauses, mixed $userId, mixed $conditions) : mixed

Parameters

$entityName : mixed
$clauses : mixed
$userId : mixed
$conditions : mixed

_civi_contribute_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civi_contribute_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civi_contribute_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civi_contribute_civix_civicrm_install() : mixed

_civi_contribute_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civi_contribute_civix_civicrm_enable() : void

_civi_contribute_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civi_contribute_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civi_contribute_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civi_contribute_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_contribute_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civi_contribute_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_contribute_civix_fixNavigationMenuItems()


    
                    _civi_contribute_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_civi_event_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civi_event_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civi_event_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civi_event_civix_civicrm_install() : mixed

_civi_event_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civi_event_civix_civicrm_enable() : void

_civi_event_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civi_event_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civi_event_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civi_event_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_event_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civi_event_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_event_civix_fixNavigationMenuItems()


    
                    _civi_event_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

_civi_mail_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civi_mail_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civi_mail_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civi_mail_civix_civicrm_install() : mixed

_civi_mail_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civi_mail_civix_civicrm_enable() : void

_civi_mail_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civi_mail_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civi_mail_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civi_mail_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_mail_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civi_mail_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_mail_civix_fixNavigationMenuItems()


    
                    _civi_mail_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

_civi_member_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civi_member_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civi_member_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civi_member_civix_civicrm_install() : mixed

_civi_member_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civi_member_civix_civicrm_enable() : void

_civi_member_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civi_member_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civi_member_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civi_member_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_member_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civi_member_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_member_civix_fixNavigationMenuItems()


    
                    _civi_member_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

_civi_pledge_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civi_pledge_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civi_pledge_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civi_pledge_civix_civicrm_install() : mixed

_civi_pledge_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civi_pledge_civix_civicrm_enable() : void

_civi_pledge_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civi_pledge_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civi_pledge_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civi_pledge_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_pledge_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civi_pledge_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_pledge_civix_fixNavigationMenuItems()


    
                    _civi_pledge_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

_civi_report_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civi_report_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civi_report_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civi_report_civix_civicrm_install() : mixed

_civi_report_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civi_report_civix_civicrm_enable() : void

_civi_report_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civi_report_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civi_report_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civi_report_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_report_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civi_report_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civi_report_civix_fixNavigationMenuItems()


    
                    _civi_report_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_civicrm_admin_ui_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civicrm_admin_ui_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civicrm_admin_ui_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civicrm_admin_ui_civix_civicrm_install() : mixed

_civicrm_admin_ui_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civicrm_admin_ui_civix_civicrm_enable() : void

_civicrm_admin_ui_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civicrm_admin_ui_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civicrm_admin_ui_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civicrm_admin_ui_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civicrm_admin_ui_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civicrm_admin_ui_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civicrm_admin_ui_civix_fixNavigationMenuItems()


    
                    _civicrm_admin_ui_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

civicrm_admin_ui_civicrm_config()

Implements hook_civicrm_config().


    
                    civicrm_admin_ui_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

civicrm_admin_ui_civicrm_postProcess()

Implements hook_civicrm_postProcess().


    
                    civicrm_admin_ui_civicrm_postProcess(mixed $className, mixed $form) : mixed

Parameters

$className : mixed
$form : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_civicrm_search_ui_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civicrm_search_ui_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civicrm_search_ui_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civicrm_search_ui_civix_civicrm_install() : mixed

_civicrm_search_ui_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civicrm_search_ui_civix_civicrm_enable() : void

_civicrm_search_ui_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civicrm_search_ui_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civicrm_search_ui_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civicrm_search_ui_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civicrm_search_ui_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civicrm_search_ui_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civicrm_search_ui_civix_fixNavigationMenuItems()


    
                    _civicrm_search_ui_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

civicrm_search_ui_civicrm_config()

Implements hook_civicrm_config().


    
                    civicrm_search_ui_civicrm_config(mixed &$config) : void

Parameters

$config : mixed

civicrm_search_ui_civicrm_install()

Implements hook_civicrm_install().


    
                    civicrm_search_ui_civicrm_install() : void

civicrm_search_ui_civicrm_enable()

Implements hook_civicrm_enable().


    
                    civicrm_search_ui_civicrm_enable() : void

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

_civigrant_civix_class_loader()


    
                    _civigrant_civix_class_loader(mixed $class) : mixed

Parameters

$class : mixed

_civigrant_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civigrant_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civigrant_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civigrant_civix_civicrm_install() : mixed

_civigrant_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civigrant_civix_civicrm_enable() : void

_civigrant_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civigrant_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civigrant_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civigrant_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civigrant_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civigrant_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civigrant_civix_fixNavigationMenuItems()


    
                    _civigrant_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

civigrant_civicrm_config()

Implements hook_civicrm_config().


    
                    civigrant_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

civigrant_civicrm_links()

Implements hook_civicrm_links().


    
                    civigrant_civicrm_links(mixed $context, mixed $name, mixed $id, mixed &$links) : mixed

Add shortcut link to create new grant.

Parameters

$context : mixed
$name : mixed
$id : mixed
$links : mixed

civigrant_civicrm_summaryActions()

Implements hook_civicrm_summaryActions().


    
                    civigrant_civicrm_summaryActions(mixed &$menu, mixed $cid) : mixed

Add contact summary link to create new grant.

Parameters

$menu : mixed
$cid : mixed

civigrant_civicrm_permission()

Implements hook_civicrm_permission().


    
                    civigrant_civicrm_permission(mixed &$permissions) : mixed

Define CiviGrant permissions.

Parameters

$permissions : mixed

civigrant_civicrm_alterAPIPermissions()

Implements hook_civicrm_alterAPIPermissions().


    
                    civigrant_civicrm_alterAPIPermissions(mixed $entity, mixed $action, mixed &$params, mixed &$permissions) : mixed

Set CiviGrant permissions for APIv3.

Parameters

$entity : mixed
$action : mixed
$params : mixed
$permissions : mixed

civigrant_civicrm_queryObjects()

Implements hook_civicrm_queryObjects().


    
                    civigrant_civicrm_queryObjects(mixed &$queryObjects, mixed $type) : mixed

Adds query object for legacy screens like advanced search, search builder, etc.

Parameters

$queryObjects : mixed
$type : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_civiimport_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _civiimport_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_civiimport_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _civiimport_civix_civicrm_install() : mixed

_civiimport_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _civiimport_civix_civicrm_enable() : void

_civiimport_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _civiimport_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_civiimport_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _civiimport_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civiimport_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _civiimport_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_civiimport_civix_fixNavigationMenuItems()


    
                    _civiimport_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

civiimport_civicrm_config()

Implements hook_civicrm_config().


    
                    civiimport_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

civiimport_civicrm_install()

Implements hook_civicrm_install().


    
                    civiimport_civicrm_install() : mixed

civiimport_civicrm_enable()

Implements hook_civicrm_enable().


    
                    civiimport_civicrm_enable() : mixed

civiimport_civicrm_entityTypes()

Implements hook_civicrm_entityTypes().


    
                    civiimport_civicrm_entityTypes(array<string|int, mixed> &$entityTypes) : void

Declare each import table as an entity type. This function was intended to be in the ImportSubscriber class but kept getting errors when it was there so it's here, at least for now.

Parameters

$entityTypes : array<string|int, mixed>

_civiimport_civicrm_get_import_tables()

Get the available import tables.


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

Note this lives here as entityTypes hook calls it - which may not fully have class loading set up by the time it runs.

Where the database is fully booted already it is better to call Civi\BAO\Import::getImportTables() which is expected to have caching.

Currently both functions share the Civi::statics caching in this function - but we have had lots of back & forth so the principle is - call this if we know caching could be scary - call the other for 'whatever caching is most performant'.

Return values

array<string|int, mixed>

civiimport_civicrm_alterTemplateFile()

Alter the template for the contribution import mapping to use angular form.


    
                    civiimport_civicrm_alterTemplateFile(string $formName, CRM_Core_Form $form, string $type, string &$templateFile) : void

Parameters

$formName : string
$form : CRM_Core_Form
$type : string
$templateFile : string

civiimport_civicrm_searchKitTasks()

Implements search tasks hook to add the `validate` and `import` actions.


    
                    civiimport_civicrm_searchKitTasks(array<string|int, mixed> &$tasks, bool $checkPermissions, int|null $userId) : mixed

Parameters

$tasks : array<string|int, mixed>
$checkPermissions : bool
$userId : int|null

civiimport_civicrm_buildForm()

Load the angular app for our form.


    
                    civiimport_civicrm_buildForm(string $formName, CRM_Contribute_Import_Form_MapField $form) : mixed

Parameters

$formName : string
$form : CRM_Contribute_Import_Form_MapField

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_ckeditor4_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _ckeditor4_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_ckeditor4_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _ckeditor4_civix_civicrm_install() : mixed

_ckeditor4_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _ckeditor4_civix_civicrm_enable() : void

_ckeditor4_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _ckeditor4_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_ckeditor4_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _ckeditor4_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_ckeditor4_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _ckeditor4_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_ckeditor4_civix_fixNavigationMenuItems()


    
                    _ckeditor4_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

ckeditor4_civicrm_config()

Implements hook_civicrm_config().


    
                    ckeditor4_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

ckeditor4_civicrm_install()

Implements hook_civicrm_install().


    
                    ckeditor4_civicrm_install() : mixed

ckeditor4_civicrm_enable()

Implements hook_civicrm_enable().


    
                    ckeditor4_civicrm_enable() : mixed

ckeditor4_civicrm_buildForm()


    
                    ckeditor4_civicrm_buildForm(mixed $formName, mixed $form) : mixed

Parameters

$formName : mixed
$form : mixed

ckeditor4_civicrm_coreResourceList()


    
                    ckeditor4_civicrm_coreResourceList(mixed &$list, mixed $region) : mixed

Parameters

$list : mixed
$region : mixed

_contributioncancelactions_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _contributioncancelactions_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_contributioncancelactions_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _contributioncancelactions_civix_civicrm_install() : mixed

_contributioncancelactions_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _contributioncancelactions_civix_civicrm_enable() : void

_contributioncancelactions_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _contributioncancelactions_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_contributioncancelactions_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _contributioncancelactions_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_contributioncancelactions_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _contributioncancelactions_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_contributioncancelactions_civix_fixNavigationMenuItems()


    
                    _contributioncancelactions_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

contributioncancelactions_civicrm_post()

Implements hook_civicrm_preProcess().


    
                    contributioncancelactions_civicrm_post(mixed $op, mixed $objectName, mixed $objectId, mixed $objectRef) : mixed

This enacts the following

find and cancel any related pending memberships
(not yet implemented) find and cancel any related pending participant records
(not yet implemented) find any related pledge payment records. Remove the contribution id.

Parameters

$op : mixed
$objectName : mixed
$objectId : mixed
$objectRef : mixed

contributioncancelactions_cancel_related_pending_participant_records()

Find and cancel any pending participant records.


    
                    contributioncancelactions_cancel_related_pending_participant_records(int $contributionID) : void

Parameters

$contributionID : int

contributioncancelactions_cancel_related_pending_memberships()

Find and cancel any pending memberships.


    
                    contributioncancelactions_cancel_related_pending_memberships(int $contributionID) : void

Parameters

$contributionID : int

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_elavon_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _elavon_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_elavon_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _elavon_civix_civicrm_install() : mixed

_elavon_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _elavon_civix_civicrm_enable() : void

_elavon_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _elavon_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_elavon_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _elavon_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_elavon_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _elavon_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_elavon_civix_fixNavigationMenuItems()


    
                    _elavon_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

elavon_civicrm_config()

Implements hook_civicrm_config().


    
                    elavon_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

elavon_civicrm_install()

Implements hook_civicrm_install().


    
                    elavon_civicrm_install() : mixed

elavon_civicrm_enable()

Implements hook_civicrm_enable().


    
                    elavon_civicrm_enable() : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_eventcart_civix_class_loader()


    
                    _eventcart_civix_class_loader(mixed $class) : mixed

Parameters

$class : mixed

_eventcart_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _eventcart_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_eventcart_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _eventcart_civix_civicrm_install() : mixed

_eventcart_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _eventcart_civix_civicrm_enable() : void

_eventcart_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _eventcart_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_eventcart_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _eventcart_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_eventcart_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _eventcart_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_eventcart_civix_fixNavigationMenuItems()


    
                    _eventcart_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

eventcart_civicrm_config()

Implements hook_civicrm_config().


    
                    eventcart_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

eventcart_civicrm_install()

Implements hook_civicrm_install().


    
                    eventcart_civicrm_install() : mixed

eventcart_civicrm_alterMailParams()

Add the conference session variable to the template.


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

Parameters

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

eventcart_civicrm_enable()

Implements hook_civicrm_enable().


    
                    eventcart_civicrm_enable() : mixed

eventcart_civicrm_tabset()


    
                    eventcart_civicrm_tabset(mixed $name, mixed &$tabs) : mixed

Parameters

$name : mixed
$tabs : mixed

_ewaysingle_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _ewaysingle_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_ewaysingle_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _ewaysingle_civix_civicrm_install() : mixed

_ewaysingle_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _ewaysingle_civix_civicrm_enable() : void

_ewaysingle_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _ewaysingle_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_ewaysingle_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _ewaysingle_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_ewaysingle_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _ewaysingle_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_ewaysingle_civix_fixNavigationMenuItems()


    
                    _ewaysingle_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

ewaysingle_civicrm_config()

Implements hook_civicrm_config().


    
                    ewaysingle_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

ewaysingle_civicrm_install()

Implements hook_civicrm_install().


    
                    ewaysingle_civicrm_install() : mixed

ewaysingle_civicrm_enable()

Implements hook_civicrm_enable().


    
                    ewaysingle_civicrm_enable() : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_financialacls_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _financialacls_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_financialacls_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _financialacls_civix_civicrm_install() : mixed

_financialacls_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _financialacls_civix_civicrm_enable() : void

_financialacls_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _financialacls_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_financialacls_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _financialacls_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_financialacls_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _financialacls_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_financialacls_civix_fixNavigationMenuItems()


    
                    _financialacls_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

financialacls_civicrm_config()

Implements hook_civicrm_config().


    
                    financialacls_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

financialacls_civicrm_container()


    
                    financialacls_civicrm_container(ContainerBuilder $container) : mixed

Parameters

$container : ContainerBuilder

financialacls_civicrm_install()

Implements hook_civicrm_install().


    
                    financialacls_civicrm_install() : mixed

financialacls_civicrm_enable()

Implements hook_civicrm_enable().


    
                    financialacls_civicrm_enable() : mixed

financialacls_civicrm_pre()

Intervene to prevent deletion, where permissions block it.


    
                    financialacls_civicrm_pre(string $op, string $objectName, int|null $id, array<string|int, mixed> &$params) : mixed

Parameters

$op : string
$objectName : string
$id : int|null
$params : array<string|int, mixed>

financialacls_civicrm_selectWhereClause()

Implements hook_civicrm_selectWhereClause().


    
                    financialacls_civicrm_selectWhereClause(mixed $entity, mixed &$clauses) : mixed

Parameters

$entity : mixed
$clauses : mixed

_financialacls_civicrm_get_accounts_clause()

Get the clause to limit available types.


    
                    _financialacls_civicrm_get_accounts_clause() : string

Return values

string

_financialacls_civicrm_get_type_clause()

Get the clause to limit available types.


    
                    _financialacls_civicrm_get_type_clause() : string

Return values

string

_financialacls_civicrm_get_accessible_financial_types()

Get an array of the ids of accessible financial types.


    
                    _financialacls_civicrm_get_accessible_financial_types() : array<string|int, int>

If none then it will be [0]

Return values

array<string|int, int>

_financialacls_civicrm_get_inaccessible_financial_types()

Get an array of the ids of accessible financial types.


    
                    _financialacls_civicrm_get_inaccessible_financial_types() : array<string|int, int>

If none then it will be [0]

Return values

array<string|int, int>

_financialacls_civicrm_get_membership_type_clause()

Get the clause to limit available membership types.


    
                    _financialacls_civicrm_get_membership_type_clause() : string

Return values

string

financialacls_civicrm_buildAmount()

Remove unpermitted options.


    
                    financialacls_civicrm_buildAmount(string $component, CRM_Core_Form $form, array<string|int, mixed> &$feeBlock) : mixed

Parameters

$component : string
$form : CRM_Core_Form
$feeBlock : array<string|int, mixed>

financialacls_civicrm_membershipTypeValues()

Remove unpermitted membership types from selection availability.


    
                    financialacls_civicrm_membershipTypeValues(CRM_Core_Form $form, array<string|int, mixed> &$membershipTypeValues) : mixed

Parameters

$form : CRM_Core_Form
$membershipTypeValues : array<string|int, mixed>

financialacls_civicrm_permission()

Add permissions.


    
                    financialacls_civicrm_permission(array<string|int, mixed> &$permissions) : mixed

Parameters

$permissions : array<string|int, mixed>

_financialacls_civi_api4_authorizeContribution()

Listener for 'civi.api4.authorizeRecord::Contribution'


    
                    _financialacls_civi_api4_authorizeContribution(AuthorizeRecordEvent $e) : mixed

Parameters

$e : AuthorizeRecordEvent

_civicrm_financial_acls_check_permissioned_line_items()

Function to check if lineitems present in a contribution have permissioned FTs.


    
                    _civicrm_financial_acls_check_permissioned_line_items(int $id, string $op[, bool $force = TRUE ][, int $contactID = NULL ]) : bool

Parameters

$id : int: contribution id
$op : string: the mode of operation, can be add, view, edit, delete
$force : bool = TRUE
$contactID : int = NULL

Return values

bool

_financialacls_getRequiredPermission()

Get the permission required to perform this action on this financial type.


    
                    _financialacls_getRequiredPermission(int $financialTypeID, string $action) : string

Parameters

$financialTypeID : int
$action : string

Return values

string

financialacls_civicrm_fieldOptions()

Remove unpermitted financial types from field Options in search context.


    
                    financialacls_civicrm_fieldOptions(string $entity, string $field, array<string|int, mixed> &$options, array<string|int, mixed> $params) : mixed

Search context is described as 'search' => "search: searchable options are returned; labels are translated.", So this is appropriate to removing the options from search screens.

Parameters

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

financialacls_is_acl_limiting_enabled()

Is financial acl limiting enabled.


    
                    financialacls_is_acl_limiting_enabled() : bool

Once this extension is detangled enough to be optional this will go and the status of the extension rather than the setting will dictate.

Return values

bool

financialacls_toggle()

Clear the statics cache when the setting is enabled or disabled.


    
                    financialacls_toggle() : mixed

Note the setting will eventually disappear in favour of whether the extension is enabled or disabled.

financialacls_civicrm_alterMenu()

Require financial acl permissions for financial screens.


    
                    financialacls_civicrm_alterMenu(array<string|int, mixed> &$menu) : void

Parameters

$menu : array<string|int, mixed>

financialacls_civicrm_preProcess()


    
                    financialacls_civicrm_preProcess(string $formName, CRM_Event_Form_Registration|CRM_Contribute_Form_Contribution $form) : void

Parameters

$formName : string
$form : CRM_Event_Form_Registration|CRM_Contribute_Form_Contribution

financialacls_civicrm_links()

Hide edit/enable/disable links for memberships of a given Financial Type Note: The $objectID param can be an int, string or null, hence not typed


    
                    financialacls_civicrm_links(string $op, string|null $objectName, mixed $objectID, array<string|int, mixed> &$links, int|null &$mask, array<string|int, mixed> &$values) : mixed

Implements hook_civicrm_links()

Parameters

$op : string
$objectName : string|null
$objectID : mixed
$links : array<string|int, mixed>
$mask : int|null
$values : array<string|int, mixed>

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_flexmailer_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _flexmailer_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_flexmailer_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _flexmailer_civix_civicrm_install() : mixed

_flexmailer_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _flexmailer_civix_civicrm_enable() : void

_flexmailer_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _flexmailer_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_flexmailer_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _flexmailer_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_flexmailer_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _flexmailer_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_flexmailer_civix_fixNavigationMenuItems()


    
                    _flexmailer_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

flexmailer_civicrm_config()

Implements hook_civicrm_config().


    
                    flexmailer_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

flexmailer_civicrm_install()

Implements hook_civicrm_install().


    
                    flexmailer_civicrm_install() : mixed

flexmailer_civicrm_enable()

Implements hook_civicrm_enable().


    
                    flexmailer_civicrm_enable() : mixed

flexmailer_civicrm_container()

Implements hook_civicrm_container().


    
                    flexmailer_civicrm_container(mixed $container) : mixed

Parameters

$container : mixed

flexmailer_civicrm_scanClasses()


    
                    flexmailer_civicrm_scanClasses(array<string|int, mixed> &$classes) : void

Parameters

$classes : array<string|int, mixed>

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_greenwich_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _greenwich_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_greenwich_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _greenwich_civix_civicrm_install() : mixed

_greenwich_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _greenwich_civix_civicrm_enable() : void

_greenwich_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _greenwich_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_greenwich_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _greenwich_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_greenwich_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _greenwich_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_greenwich_civix_fixNavigationMenuItems()


    
                    _greenwich_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

greenwich_civicrm_config()

Implements hook_civicrm_config().


    
                    greenwich_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

greenwich_civicrm_themes()

Implements hook_civicrm_themes().


    
                    greenwich_civicrm_themes(mixed &$themes) : mixed

Parameters

$themes : mixed

greenwich_civicrm_alterBundle()

Implements hook_civicrm_alterBundle().


    
                    greenwich_civicrm_alterBundle(CRM_Core_Resources_Bundle $bundle) : mixed

Parameters

$bundle : CRM_Core_Resources_Bundle

_iframe_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _iframe_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_iframe_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _iframe_civix_civicrm_install() : mixed

_iframe_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _iframe_civix_civicrm_enable() : void

_iframe_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _iframe_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_iframe_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _iframe_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_iframe_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _iframe_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_iframe_civix_fixNavigationMenuItems()


    
                    _iframe_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

iframe_civicrm_config()

Implements hook_civicrm_config().


    
                    iframe_civicrm_config(mixed &$config[, array<string|int, mixed>|null $flags = NULL ]) : void

Parameters

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

iframe_civicrm_install()

Implements hook_civicrm_install().


    
                    iframe_civicrm_install() : void

iframe_civicrm_enable()

Implements hook_civicrm_enable().


    
                    iframe_civicrm_enable() : void

_legacycustomsearches_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _legacycustomsearches_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_legacycustomsearches_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _legacycustomsearches_civix_civicrm_install() : mixed

_legacycustomsearches_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _legacycustomsearches_civix_civicrm_enable() : void

_legacycustomsearches_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _legacycustomsearches_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_legacycustomsearches_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _legacycustomsearches_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_legacycustomsearches_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _legacycustomsearches_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_legacycustomsearches_civix_fixNavigationMenuItems()


    
                    _legacycustomsearches_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

legacycustomsearches_civicrm_config()

Implements hook_civicrm_config().


    
                    legacycustomsearches_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

legacycustomsearches_civicrm_install()

Implements hook_civicrm_install().


    
                    legacycustomsearches_civicrm_install() : mixed

legacycustomsearches_civicrm_enable()

Implements hook_civicrm_enable().


    
                    legacycustomsearches_civicrm_enable() : mixed

legacycustomsearches_civicrm_buildGroupContactCache()

Determine the sql


    
                    legacycustomsearches_civicrm_buildGroupContactCache(array<string|int, mixed> $savedSearch, int $groupID, string &$sql) : void

Parameters

$savedSearch : array<string|int, mixed>
$groupID : int
$sql : string

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_message_admin_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _message_admin_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_message_admin_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _message_admin_civix_civicrm_install() : mixed

_message_admin_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _message_admin_civix_civicrm_enable() : void

_message_admin_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _message_admin_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_message_admin_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _message_admin_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_message_admin_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _message_admin_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_message_admin_civix_fixNavigationMenuItems()


    
                    _message_admin_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

message_admin_civicrm_config()

Implements hook_civicrm_config().


    
                    message_admin_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

message_admin_civicrm_install()

Implements hook_civicrm_install().


    
                    message_admin_civicrm_install() : mixed

message_admin_civicrm_enable()

Implements hook_civicrm_enable().


    
                    message_admin_civicrm_enable() : mixed

buildInputUrl()


    
                    buildInputUrl(mixed $s) : mixed

Parameters

$s : mixed

buildRedirectUrl()


    
                    buildRedirectUrl(mixed $get) : mixed

Parameters

$get : mixed

_oauth_client_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _oauth_client_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_oauth_client_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _oauth_client_civix_civicrm_install() : mixed

_oauth_client_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _oauth_client_civix_civicrm_enable() : void

_oauth_client_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _oauth_client_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_oauth_client_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _oauth_client_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_oauth_client_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _oauth_client_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_oauth_client_civix_fixNavigationMenuItems()


    
                    _oauth_client_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

oauth_client_civicrm_config()

Implements hook_civicrm_config().


    
                    oauth_client_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

oauth_client_civicrm_permission()

Implements hook_civicrm_permission().


    
                    oauth_client_civicrm_permission(mixed &$permissions) : mixed

Parameters

$permissions : mixed

oauth_client_civicrm_container()


    
                    oauth_client_civicrm_container(ContainerBuilder $container) : mixed

Parameters

$container : ContainerBuilder

oauth_client_civicrm_oauthProviders()

Implements hook_civicrm_oauthProviders().


    
                    oauth_client_civicrm_oauthProviders(mixed &$providers) : mixed

Parameters

$providers : mixed

oauth_client_civicrm_mailSetupActions()

Implements hook_civicrm_mailSetupActions().


    
                    oauth_client_civicrm_mailSetupActions(mixed &$setupActions) : mixed

Parameters

$setupActions : mixed

oauth_client_civicrm_oauthReturn()

Implements hook_civicrm_oauthReturn().


    
                    oauth_client_civicrm_oauthReturn(mixed $token, mixed &$nextUrl) : mixed

Parameters

$token : mixed
$nextUrl : mixed

oauth_client_civicrm_alterMailStore()

Implements hook_civicrm_alterMailStore().


    
                    oauth_client_civicrm_alterMailStore(mixed &$mailSettings) : mixed

Parameters

$mailSettings : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_oembed_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _oembed_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_oembed_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _oembed_civix_civicrm_install() : mixed

_oembed_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _oembed_civix_civicrm_enable() : void

_oembed_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _oembed_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_oembed_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _oembed_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_oembed_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _oembed_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_oembed_civix_fixNavigationMenuItems()


    
                    _oembed_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

oembed_civicrm_config()

Implements hook_civicrm_config().


    
                    oembed_civicrm_config(mixed &$config) : void

Parameters

$config : mixed

oembed_civicrm_install()

Implements hook_civicrm_install().


    
                    oembed_civicrm_install() : void

oembed_civicrm_enable()

Implements hook_civicrm_enable().


    
                    oembed_civicrm_enable() : void

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_payflowpro_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _payflowpro_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_payflowpro_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _payflowpro_civix_civicrm_install() : mixed

_payflowpro_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _payflowpro_civix_civicrm_enable() : void

_payflowpro_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _payflowpro_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_payflowpro_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _payflowpro_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_payflowpro_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _payflowpro_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_payflowpro_civix_fixNavigationMenuItems()


    
                    _payflowpro_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

payflowpro_civicrm_config()

Implements hook_civicrm_config().


    
                    payflowpro_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

payflowpro_civicrm_install()

Implements hook_civicrm_install().


    
                    payflowpro_civicrm_install() : mixed

payflowpro_civicrm_enable()

Implements hook_civicrm_enable().


    
                    payflowpro_civicrm_enable() : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_recaptcha_qsencode()

Encodes the given data into a query string format


    
                    _recaptcha_qsencode(mixed $data) : string

Parameters

$data : mixed

array of string elements to be encoded

Return values

string —

encoded request

_recaptcha_http_post()

Submits an HTTP POST to a reCAPTCHA server


    
                    _recaptcha_http_post(string $host, string $path, array<string|int, mixed> $data) : string

Parameters

$host : string
$path : string
$data : array<string|int, mixed>

Return values

string —

response

recaptcha_get_html()

Gets the challenge HTML (javascript and non-javascript version).


    
                    recaptcha_get_html(string $pubkey[, string $error = NULL ][, bool $use_ssl = FALSE ]) : string

This is called from the browser, and the resulting reCAPTCHA HTML widget is embedded within the HTML form it was called from.

Parameters

$pubkey : string: A public key for reCAPTCHA
$error : string = NULL: The error given by reCAPTCHA (optional, default is null)
$use_ssl : bool = FALSE: Should the request be made over ssl? (optional, default is false)

Return values

string —

The HTML to be embedded in the user's form.

recaptcha_check_answer()

Calls an HTTP POST function to verify if the user's guess was correct


    
                    recaptcha_check_answer(string $privkey, string $remoteip, string $response[, array<string|int, mixed> $extra_params = array() ]) : ReCaptchaResponse

Parameters

$privkey : string
$remoteip : string
$response : string
$extra_params : array<string|int, mixed> = array(): an array of extra variables to post to the server

Return values

ReCaptchaResponse

recaptcha_get_signup_url()

gets a URL where the user can sign up for reCAPTCHA. If your application has a configuration page where you enter a key, you should provide a link using this function.


    
                    recaptcha_get_signup_url([string $domain = NULL ][, string $appname = NULL ]) : mixed

Parameters

$domain : string = NULL: The domain where the page is hosted
$appname : string = NULL: The name of your application

_recaptcha_aes_pad()


    
                    _recaptcha_aes_pad(mixed $val) : mixed

Parameters

$val : mixed

_recaptcha_aes_encrypt()

Mailhide related code


    
                    _recaptcha_aes_encrypt(mixed $val, mixed $ky) : mixed

Parameters

$val : mixed
$ky : mixed

_recaptcha_mailhide_urlbase64()


    
                    _recaptcha_mailhide_urlbase64(mixed $x) : mixed

Parameters

$x : mixed

recaptcha_mailhide_url()

gets the reCAPTCHA Mailhide url for a given email, public key and private key


    
                    recaptcha_mailhide_url(mixed $pubkey, mixed $privkey, mixed $email) : mixed

Parameters

$pubkey : mixed
$privkey : mixed
$email : mixed

_recaptcha_mailhide_email_parts()

gets the parts of the email to expose to the user.


    
                    _recaptcha_mailhide_email_parts(mixed $email) : mixed

eg, given johndoe@example,com return ["john", "example.com"]. the email is then displayed as john...@example.com

Parameters

$email : mixed

recaptcha_mailhide_html()

Gets html to display an email address given a public an private key.


    
                    recaptcha_mailhide_html(mixed $pubkey, mixed $privkey, mixed $email) : mixed

to get a key, go to:

http://www.google.com/recaptcha/mailhide/apikey

Parameters

$pubkey : mixed
$privkey : mixed
$email : mixed

_recaptcha_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _recaptcha_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_recaptcha_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _recaptcha_civix_civicrm_install() : mixed

_recaptcha_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _recaptcha_civix_civicrm_enable() : void

_recaptcha_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _recaptcha_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_recaptcha_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _recaptcha_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_recaptcha_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _recaptcha_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_recaptcha_civix_fixNavigationMenuItems()


    
                    _recaptcha_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

recaptcha_civicrm_config()

Implements hook_civicrm_config().


    
                    recaptcha_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

recaptcha_civicrm_install()

Implements hook_civicrm_install().


    
                    recaptcha_civicrm_install() : mixed

recaptcha_civicrm_enable()

Implements hook_civicrm_enable().


    
                    recaptcha_civicrm_enable() : mixed

recaptcha_civicrm_buildForm()

Intercept form functions


    
                    recaptcha_civicrm_buildForm(mixed $formName, mixed &$form) : mixed

Parameters

$formName : mixed
$form : mixed

_scheduled_communications_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _scheduled_communications_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_scheduled_communications_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _scheduled_communications_civix_civicrm_install() : mixed

_scheduled_communications_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _scheduled_communications_civix_civicrm_enable() : void

_scheduled_communications_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _scheduled_communications_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_scheduled_communications_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _scheduled_communications_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_scheduled_communications_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _scheduled_communications_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_scheduled_communications_civix_fixNavigationMenuItems()


    
                    _scheduled_communications_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

scheduled_communications_civicrm_config()

Implements hook_civicrm_config().


    
                    scheduled_communications_civicrm_config(mixed &$config) : void

Parameters

$config : mixed

scheduled_communications_civicrm_install()

Implements hook_civicrm_install().


    
                    scheduled_communications_civicrm_install() : void

scheduled_communications_civicrm_enable()

Implements hook_civicrm_enable().


    
                    scheduled_communications_civicrm_enable() : void

scheduled_communications_civicrm_permission()


    
                    scheduled_communications_civicrm_permission(mixed &$permissions) : mixed

Parameters

$permissions : mixed

scheduled_communications_civicrm_pre()

Implements hook_civicrm_pre().


    
                    scheduled_communications_civicrm_pre(mixed $op, mixed $entity, mixed $id, mixed $params) : void

Parameters

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

scheduled_communications_civicrm_post()

Implements hook_civicrm_post().


    
                    scheduled_communications_civicrm_post(mixed $op, mixed $entity, mixed $id, mixed $object) : void

Parameters

$op : mixed
$entity : mixed
$id : mixed
$object : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_search_kit_civix_class_loader()


    
                    _search_kit_civix_class_loader(mixed $class) : mixed

Parameters

$class : mixed

_search_kit_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _search_kit_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_search_kit_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _search_kit_civix_civicrm_install() : mixed

_search_kit_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _search_kit_civix_civicrm_enable() : void

_search_kit_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _search_kit_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_search_kit_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _search_kit_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_search_kit_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _search_kit_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_search_kit_civix_fixNavigationMenuItems()


    
                    _search_kit_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

search_kit_civicrm_config()

Implements hook_civicrm_config().


    
                    search_kit_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

search_kit_civicrm_permission()

Implements hook_civicrm_permission().


    
                    search_kit_civicrm_permission(mixed &$permissions) : mixed

Define SearchKit permissions.

Parameters

$permissions : mixed

search_kit_civicrm_angularModules()

Implements hook_civicrm_angularModules().


    
                    search_kit_civicrm_angularModules(mixed &$angularModules) : mixed

Generate a list of Angular modules.

Note: This hook only runs in CiviCRM 4.5+. It may use features only available in v4.6+.

Parameters

$angularModules : mixed

search_kit_civicrm_pre()

Implements hook_civicrm_pre().


    
                    search_kit_civicrm_pre(mixed $op, mixed $entity, mixed $id, mixed &$params) : mixed

Parameters

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

search_kit_civicrm_post()

Implements hook_civicrm_post().


    
                    search_kit_civicrm_post(mixed $op, mixed $entity, mixed $id, mixed $object) : mixed

Parameters

$op : mixed
$entity : mixed
$id : mixed
$object : mixed

search_kit_civicrm_entityTypes()

Implements hook_civicrm_entityTypes().


    
                    search_kit_civicrm_entityTypes(array<string|int, mixed> &$entityTypes) : void

Parameters

$entityTypes : array<string|int, mixed>

_getSearchKitDisplayTableName()

Returns a SQL-safe table name for a display (for use with displays of type "entity")


    
                    _getSearchKitDisplayTableName(string $displayName) : string

Parameters

$displayName : string

Return values

string

_getSearchKitEntityDisplays()

Uncached function to fetch displays of type "entity" to be used by boot-level code


    
                    _getSearchKitEntityDisplays([mixed $name = NULL ]) : array<string|int, mixed>

Parameters

$name : mixed = NULL

Return values

array<string|int, mixed>

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_sequentialcreditnotes_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _sequentialcreditnotes_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_sequentialcreditnotes_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _sequentialcreditnotes_civix_civicrm_install() : mixed

_sequentialcreditnotes_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _sequentialcreditnotes_civix_civicrm_enable() : void

_sequentialcreditnotes_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _sequentialcreditnotes_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_sequentialcreditnotes_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _sequentialcreditnotes_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_sequentialcreditnotes_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _sequentialcreditnotes_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_sequentialcreditnotes_civix_fixNavigationMenuItems()


    
                    _sequentialcreditnotes_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

sequentialcreditnotes_civicrm_pre()

Add a creditnote_id if appropriate.


    
                    sequentialcreditnotes_civicrm_pre(CRM_Core_DAO $op, string $objectName, int|null $id, array<string|int, mixed> &$params) : mixed

If the contribution is created with cancelled or refunded status, add credit note id do the same for chargeback

creditnotes for chargebacks entered the code 'accidentally' but since it did we maintain it.

Parameters

$op : CRM_Core_DAO
$objectName : string
$id : int|null
$params : array<string|int, mixed>

sequentialcreditnotes_create_credit_note_id()

Generate credit note id with next available number


    
                    sequentialcreditnotes_create_credit_note_id() : string

Return values

string —

Credit Note Id.

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

_standaloneusers_civix_class_loader()


    
                    _standaloneusers_civix_class_loader(mixed $class) : mixed

Parameters

$class : mixed

_standaloneusers_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _standaloneusers_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_standaloneusers_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _standaloneusers_civix_civicrm_install() : mixed

_standaloneusers_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _standaloneusers_civix_civicrm_enable() : void

_standaloneusers_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _standaloneusers_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_standaloneusers_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _standaloneusers_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_standaloneusers_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _standaloneusers_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_standaloneusers_civix_fixNavigationMenuItems()


    
                    _standaloneusers_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

standaloneusers_civicrm_alterBundle()


    
                    standaloneusers_civicrm_alterBundle(CRM_Core_Resources_Bundle $bundle) : mixed

Parameters

$bundle : CRM_Core_Resources_Bundle

standaloneusers_civicrm_buildForm()

Hide the inherit CMS language on the Settings - Localization form.


    
                    standaloneusers_civicrm_buildForm(mixed $formName, CRM_Core_Form $form) : mixed

Implements hook_civicrm_buildForm().

Parameters

$formName : mixed
$form : CRM_Core_Form

standaloneusers_civicrm_config()

Implements hook_civicrm_config().


    
                    standaloneusers_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

standaloneusers_civicrm_install()

Implements hook_civicrm_install().


    
                    standaloneusers_civicrm_install() : mixed

standaloneusers_civicrm_enable()

Implements hook_civicrm_enable().


    
                    standaloneusers_civicrm_enable() : mixed

standaloneusers_civicrm_permission()

Implements hook_civicrm_permission().


    
                    standaloneusers_civicrm_permission(mixed &$permissions) : mixed

Parameters

$permissions : mixed

standaloneusers_civicrm_navigationMenu()


    
                    standaloneusers_civicrm_navigationMenu(mixed &$menu) : mixed

Parameters

$menu : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

_tellafriend_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _tellafriend_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_tellafriend_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _tellafriend_civix_civicrm_install() : mixed

_tellafriend_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _tellafriend_civix_civicrm_enable() : void

_tellafriend_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _tellafriend_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_tellafriend_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _tellafriend_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_tellafriend_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _tellafriend_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_tellafriend_civix_fixNavigationMenuItems()


    
                    _tellafriend_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

tellafriend_civicrm_config()

Implements hook_civicrm_config().


    
                    tellafriend_civicrm_config(mixed &$config) : void

Parameters

$config : mixed

tellafriend_civicrm_install()

Implements hook_civicrm_install().


    
                    tellafriend_civicrm_install() : void

tellafriend_civicrm_enable()

Implements hook_civicrm_enable().


    
                    tellafriend_civicrm_enable() : void

tellafriend_civicrm_tabset()

Implements hook_civicrm_tabset().


    
                    tellafriend_civicrm_tabset(mixed $tabsetName, mixed &$tabs, mixed $context) : mixed

Parameters

$tabsetName : mixed
$tabs : mixed
$context : mixed

tellafriend_civicrm_check()

Implements hook_civicrm_check().


    
                    tellafriend_civicrm_check(mixed &$messages) : mixed

Parameters

$messages : mixed

_user_dashboard_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _user_dashboard_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_user_dashboard_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _user_dashboard_civix_civicrm_install() : mixed

_user_dashboard_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _user_dashboard_civix_civicrm_enable() : void

_user_dashboard_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _user_dashboard_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_user_dashboard_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _user_dashboard_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_user_dashboard_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _user_dashboard_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_user_dashboard_civix_fixNavigationMenuItems()


    
                    _user_dashboard_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

user_dashboard_civicrm_config()

Implements hook_civicrm_config().


    
                    user_dashboard_civicrm_config(mixed &$config) : void

Parameters

$config : mixed

user_dashboard_civicrm_install()

Implements hook_civicrm_install().


    
                    user_dashboard_civicrm_install() : void

user_dashboard_civicrm_enable()

Implements hook_civicrm_enable().


    
                    user_dashboard_civicrm_enable() : void

user_dashboard_civicrm_post()

Tag SavedSearches with the "UserDashboard" tag.


    
                    user_dashboard_civicrm_post(mixed $action, mixed $entity, mixed $id, mixed $savedSearch) : mixed

The reason for using this hook is that it's write-once (just during insert), and after that the user can freely tag and untag searches.

If the tag was part of the .mgd.php file for each search then it would "stick" and the user would not be able to remove tags without their changes reverting on every managed reconcile. Also, adding it to the .mgd.php file requires hacking the exported api call with a 'chain', etc.

Parameters

$action : mixed
$entity : mixed
$id : mixed
$savedSearch : mixed

ts()

Short-named function for string translation, defined in global scope so it's available everywhere.


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

Parameters

$text : string: String for translating. Ex: 'Hello, %1!'
$params : array<string|int, mixed> = []: An array of additional parameters, as per crm_translate(). Ex: [1 => 'Dave']

Return values

string —

The translated string Ex: '¡Buenos días Dave!`

makeDAOs()


    
                    makeDAOs(string $basedir, string $xmlSchemasGlob) : void

Parameters

$basedir : string: Where to find XML's and put DAO's.
$xmlSchemasGlob : string: Expression to find XML's.

_corereqadapter_addMessages()


    
                    _corereqadapter_addMessages(CheckRequirementsEvent $e, mixed $section, array<string|int, mixed> $msgs) : mixed

Parameters

$e : CheckRequirementsEvent: Symbolic machine name for this group of messages. Ex: 'database' or 'system'.
$section : mixed
$msgs : array<string|int, mixed>: A list of messages in the format used by \Civi\Install\Requirements

_backdrop_civisetup_getPublicFiles()


    
                    _backdrop_civisetup_getPublicFiles() : mixed

_backdrop_civisetup_getPrivateFiles()


    
                    _backdrop_civisetup_getPrivateFiles() : mixed

_drupal_civisetup_getPublicFiles()


    
                    _drupal_civisetup_getPublicFiles() : mixed

_drupal_civisetup_getPrivateFiles()


    
                    _drupal_civisetup_getPrivateFiles() : mixed

_drupal8_civisetup_getPublicFiles()


    
                    _drupal8_civisetup_getPublicFiles() : mixed

_drupal8_civisetup_getPrivateFiles()


    
                    _drupal8_civisetup_getPrivateFiles() : mixed

_standalone_setup_scheme()


    
                    _standalone_setup_scheme() : string

Return values

string

_civicrm_wordpress_plugin_file()


    
                    _civicrm_wordpress_plugin_file() : string

Return values

string

civicrm_install_set_backdrop_perms()


    
                    civicrm_install_set_backdrop_perms() : mixed

civicrm_install_set_drupal_perms()


    
                    civicrm_install_set_drupal_perms() : mixed

civicrm_install_set_drupal8_perms()


    
                    civicrm_install_set_drupal8_perms() : mixed

generateRandomDate()


    
                    generateRandomDate() : string

Return values

string

user_access()


    
                    user_access([null $str = NULL ]) : bool

Parameters

$str : null = NULL

Return values

bool

module_list()


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

Return values

array<string|int, mixed>

_shimmy_civix_mixin_polyfill()


    
                    _shimmy_civix_mixin_polyfill() : mixed

_shimmy_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _shimmy_civix_civicrm_config([mixed &$config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_shimmy_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _shimmy_civix_civicrm_install() : mixed

_shimmy_civix_civicrm_postInstall()

Implements hook_civicrm_postInstall().


    
                    _shimmy_civix_civicrm_postInstall() : mixed

_shimmy_civix_civicrm_uninstall()

Implements hook_civicrm_uninstall().


    
                    _shimmy_civix_civicrm_uninstall() : mixed

_shimmy_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _shimmy_civix_civicrm_enable() : mixed

_shimmy_civix_civicrm_disable()

(Delegated) Implements hook_civicrm_disable().


    
                    _shimmy_civix_civicrm_disable() : mixed

_shimmy_civix_civicrm_upgrade()

(Delegated) Implements hook_civicrm_upgrade().


    
                    _shimmy_civix_civicrm_upgrade(mixed $op[, mixed $queue = NULL ]) : mixed

Parameters

$op : mixed: string, the type of operation being performed; 'check' or 'enqueue'
$queue : mixed = NULL: CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks

Return values

mixed —

based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) for 'enqueue', returns void

_shimmy_civix_upgrader()


    
                    _shimmy_civix_upgrader() : CRM_Shimmy_Upgrader

Return values

CRM_Shimmy_Upgrader

_shimmy_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _shimmy_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_shimmy_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _shimmy_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_shimmy_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _shimmy_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_shimmy_civix_fixNavigationMenuItems()


    
                    _shimmy_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

_shimmy_civix_civicrm_entityTypes()

(Delegated) Implements hook_civicrm_entityTypes().


    
                    _shimmy_civix_civicrm_entityTypes(mixed &$entityTypes) : mixed

Find any *.entityType.php files, merge their content, and return.

Parameters

$entityTypes : mixed

shimmy_civicrm_config()

Implements hook_civicrm_config().


    
                    shimmy_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

shimmy_civicrm_install()

Implements hook_civicrm_install().


    
                    shimmy_civicrm_install() : mixed

shimmy_civicrm_postInstall()

Implements hook_civicrm_postInstall().


    
                    shimmy_civicrm_postInstall() : mixed

shimmy_civicrm_uninstall()

Implements hook_civicrm_uninstall().


    
                    shimmy_civicrm_uninstall() : mixed

shimmy_civicrm_enable()

Implements hook_civicrm_enable().


    
                    shimmy_civicrm_enable() : mixed

shimmy_civicrm_disable()

Implements hook_civicrm_disable().


    
                    shimmy_civicrm_disable() : mixed

shimmy_civicrm_upgrade()

Implements hook_civicrm_upgrade().


    
                    shimmy_civicrm_upgrade(mixed $op[, CRM_Queue_Queue|null $queue = NULL ]) : mixed

Parameters

$op : mixed
$queue : CRM_Queue_Queue|null = NULL

shimmy_civicrm_entityTypes()

Implements hook_civicrm_entityTypes().


    
                    shimmy_civicrm_entityTypes(mixed &$entityTypes) : mixed

Declare entity types provided by this module.

Parameters

$entityTypes : mixed

_shimmy_assert_service_object()

Assert that there is a service with a given name+type.


    
                    _shimmy_assert_service_object(string $class, string $expectServiceName, string $notServiceName) : mixed

Parameters

$class : string
$expectServiceName : string
$notServiceName : string

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : mixed

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

mixed —

Response output (if the command executed normally). For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.

moduletest_civicrm_install()

Implements civicrm_install


    
                    moduletest_civicrm_install() : mixed

moduletest_civicrm_postInstall()

Implements civicrm_postInstall


    
                    moduletest_civicrm_postInstall() : mixed

moduletest_civicrm_uninstall()

Implements civicrm_uninstall


    
                    moduletest_civicrm_uninstall() : mixed

moduletest_civicrm_enable()

Implements civicrm_enable


    
                    moduletest_civicrm_enable() : mixed

moduletest_civicrm_disable()

Implements civicrm_disable


    
                    moduletest_civicrm_disable() : mixed

civicrm_api3_mailing_provider_data_get()

MailingProviderData.get API


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result descriptor

_civicrm_api3_mailing_provider_data_get_spec()

Metadata for MailingProviderData.get API


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

Parameters

$params : array<string|int, mixed>

civicrm_api3_mailing_provider_data_create()

MailingProviderData.create API


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

API result descriptor

civicrm_api3_contact_example_action2()


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_generic_example_action1()


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

Parameters

$apiRequest : mixed

Return values

array<string|int, mixed>

civicrm_api3_generic_example_action2()

Example result for API Test.


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

Parameters

$apiRequest : array<string|int, mixed>

Return values

array<string|int, mixed>

civicrm_api3_test_entity_example_action3()

Example result for API Test.


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

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed>

civitest_civicrm_scanClasses()


    
                    civitest_civicrm_scanClasses(array<string|int, mixed> &$classes) : void

Parameters

$classes : array<string|int, mixed>

_phpunit_mockoloader()


    
                    _phpunit_mockoloader(mixed $prefix, mixed $base_dir, mixed $class) : mixed

Parameters

$prefix : mixed
$base_dir : mixed
$class : mixed

cv()

Call the "cv" command.


    
                    cv(string $cmd[, string $decode = 'json' ]) : string

Parameters

$cmd : string: The rest of the command to send.
$decode : string = 'json': Ex: 'json' or 'phpcode'.

Return values

string —

Response output (if the command executed normally).

hooktesta_civicrm_testRunHooks_outer()

Implements hook_civicrm_testRunHooks_outer().


    
                    hooktesta_civicrm_testRunHooks_outer() : mixed

hooktestb_civicrm_testRunHooks_outer()


    
                    hooktestb_civicrm_testRunHooks_outer() : mixed

hooktestc_civicrm_testRunHooks_outer()


    
                    hooktestc_civicrm_testRunHooks_outer() : mixed

hooktesta_civicrm_testRunHooks_inner()


    
                    hooktesta_civicrm_testRunHooks_inner() : mixed

hooktestb_civicrm_testRunHooks_inner()


    
                    hooktestb_civicrm_testRunHooks_inner() : mixed

hooktesta_civicrm_testRunHooks_merge()


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

Return values

array<string|int, mixed>

hooktestc_civicrm_testRunHooks_merge()

Implements hook_civicrm_testRunHooks_merge().


    
                    hooktestc_civicrm_testRunHooks_merge() : mixed

hooktestd_civicrm_testRunHooks_merge()


    
                    hooktestd_civicrm_testRunHooks_merge() : null

Return values

null

hookteste_civicrm_testRunHooks_merge()


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

Return values

array<string|int, mixed>

updateFile()

Update the content of a file.


    
                    updateFile(string $file, callable $callback) : mixed

Parameters

$file : string
$callback : callable: Function(string $originalContent) => string $newContent.

updateXmlFile()

Update the content of an XML file


    
                    updateXmlFile(string $file, callable $callback) : mixed

Parameters

$file : string
$callback : callable: Function(DOMDocument $dom)

initFile()

Initialize a file (if it doesn't already exist).


    
                    initFile(string $file, callable $callback) : mixed

Parameters

$file : string
$callback : callable: Function() => string $newContent.

makeVerName()

Render a pretty string for a major/minor version number.


    
                    makeVerName(string $version) : string

Parameters

$version : string: Ex: '5.10.alpha1'

Return values

string —

Ex: 'FiveTen'.

isVersionValid()


    
                    isVersionValid(mixed $v) : mixed

Parameters

$v : mixed

fatal()


    
                    fatal(mixed $error) : mixed

Parameters

$error : mixed

parseArgs()


    
                    parseArgs(array<string|int, mixed> $argv) : array<string|int, mixed>

Parameters

$argv : array<string|int, mixed>: Ex: ['myscript.php', '--no-commit', '5.6.7']

Return values

array<string|int, mixed> —

Ex: ['scriptFile' => 'myscript.php', 'doCommit' => FALSE, 'newVersion' => '5.6.7', 'releaseDate' => '2039-01-01']

_event_check_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _event_check_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_event_check_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _event_check_civix_civicrm_install() : mixed

_event_check_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _event_check_civix_civicrm_enable() : void

_event_check_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _event_check_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_event_check_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _event_check_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_event_check_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _event_check_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_event_check_civix_fixNavigationMenuItems()


    
                    _event_check_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

event_check_civicrm_config()

Implements hook_civicrm_config().


    
                    event_check_civicrm_config(mixed &$config[, array<string|int, mixed>|null $flags = NULL ]) : void

Parameters

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

_demoqueue_civix_civicrm_config()

(Delegated) Implementation of hook_civicrm_config


    
                    _demoqueue_civix_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

_demoqueue_civix_civicrm_xmlMenu()

(Delegated) Implementation of hook_civicrm_xmlMenu


    
                    _demoqueue_civix_civicrm_xmlMenu(mixed &$files) : mixed

Parameters

$files : mixed: array(string)

demoqueue_civicrm_config()

Implementation of hook_civicrm_config


    
                    demoqueue_civicrm_config(mixed &$config) : mixed

Parameters

$config : mixed

demoqueue_civicrm_xmlMenu()

Implementation of hook_civicrm_xmlMenu


    
                    demoqueue_civicrm_xmlMenu(mixed &$files) : mixed

Parameters

$files : mixed: array(string)

_phpstorm_civix_civicrm_config()

(Delegated) Implements hook_civicrm_config().


    
                    _phpstorm_civix_civicrm_config([mixed $config = NULL ]) : mixed

Parameters

$config : mixed = NULL

_phpstorm_civix_civicrm_install()

Implements hook_civicrm_install().


    
                    _phpstorm_civix_civicrm_install() : mixed

_phpstorm_civix_civicrm_enable()

(Delegated) Implements hook_civicrm_enable().


    
                    _phpstorm_civix_civicrm_enable() : void

_phpstorm_civix_insert_navigation_menu()

Inserts a navigation menu item at a given place in the hierarchy.


    
                    _phpstorm_civix_insert_navigation_menu(array<string|int, mixed> &$menu, string $path, array<string|int, mixed> $item) : bool

Parameters

$menu : array<string|int, mixed>

menu hierarchy

$path : string

path to parent of this item, e.g. 'my_extension/submenu' 'Mailing', or 'Administer/System Settings'

$item : array<string|int, mixed>

the item to insert (parent/child attributes will be filled for you)

Return values

bool

_phpstorm_civix_navigationMenu()

(Delegated) Implements hook_civicrm_navigationMenu().


    
                    _phpstorm_civix_navigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_phpstorm_civix_fixNavigationMenu()

Given a navigation menu, generate navIDs for any items which are missing them.


    
                    _phpstorm_civix_fixNavigationMenu(mixed &$nodes) : mixed

Parameters

$nodes : mixed

_phpstorm_civix_fixNavigationMenuItems()


    
                    _phpstorm_civix_fixNavigationMenuItems(mixed &$nodes, mixed &$maxNavID, mixed $parentID) : mixed

Parameters

$nodes : mixed
$maxNavID : mixed
$parentID : mixed

phpstorm_metadata_dir()

Determine the folder where we will store PhpStorm metadata files.


    
                    phpstorm_metadata_dir() : string

Not 100% sure which is best. These options trade-off in edge-cases of writability and readability:

'[civicrm.files]/.phpstorm.meta.php'
'[civicrm.compile]/.phpstorm.meta.php'
'[civicrm.root]/.phpstorm.meta.php'

Return values

string

_phpstorm_metadata_dirs()


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

Return values

array<string|int, mixed>

phpstorm_civicrm_config()

Implements hook_civicrm_config().


    
                    phpstorm_civicrm_config(mixed &$config) : void

Parameters

$config : mixed

phpstorm_civicrm_container()


    
                    phpstorm_civicrm_container(ContainerBuilder $container) : mixed

Parameters

$container : ContainerBuilder

phpstorm_civicrm_managed()


    
                    phpstorm_civicrm_managed(mixed &$entities, mixed $modules) : mixed

Parameters

$entities : mixed
$modules : mixed

phpstorm_civicrm_enable()


    
                    phpstorm_civicrm_enable() : void

phpstorm_civicrm_uninstall()


    
                    phpstorm_civicrm_uninstall() : void

_phpstorm_cleanup()


    
                    _phpstorm_cleanup() : void

compareFile()


    
                    compareFile(mixed $file, mixed $diffCmd) : mixed

Parameters

$file : mixed
$diffCmd : mixed

parseLog()


    
                    parseLog(mixed $logString, mixed &$deletedFiles[, mixed $prefix = '' ]) : mixed

Parameters

$logString : mixed
$deletedFiles : mixed
$prefix : mixed = ''

splitContactIDs()

Split a large array of contactIDs into more manageable smaller chunks


    
                &    splitContactIDs(mixed &$contactIDs) : array<string|int, mixed>

Parameters

$contactIDs : mixed

Return values

array<string|int, mixed>

generateSolrJSON()

Given an array of values, generate the JSON in the Solr format


    
                &    generateSolrJSON(mixed $values) : string

Parameters

$values : mixed

Return values

string

escapeJsonString()


    
                    escapeJsonString(mixed $value) : mixed

Parameters

$value : mixed

getValues()

Given a set of contact IDs get the values


    
                    getValues(mixed &$contactIDs, mixed &$values) : array<string|int, mixed>

Parameters

$contactIDs : mixed
$values : mixed

Return values

array<string|int, mixed>

getTableInfo()


    
                    getTableInfo(mixed &$contactIDs, mixed &$values, mixed $tableName, mixed &$fields, mixed $whereField[, string|null $additionalWhereCond = NULL ]) : mixed

Parameters

$contactIDs : mixed
$values : mixed
$tableName : mixed
$fields : mixed
$whereField : mixed
$additionalWhereCond : string|null = NULL

getContactInfo()


    
                    getContactInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getNoteInfo()


    
                    getNoteInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getPhoneInfo()


    
                    getPhoneInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getEmailInfo()


    
                    getEmailInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getAddressInfo()


    
                    getAddressInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

appendValue()


    
                    appendValue(mixed &$values, mixed $contactID, mixed $name, mixed $value) : mixed

Parameters

$values : mixed
$contactID : mixed
$name : mixed
$value : mixed

run()


    
                    run(mixed &$contactIDs) : mixed

Parameters

$contactIDs : mixed

splitContactIDs()

Split a large array of contactIDs into more manageable smaller chunks


    
                &    splitContactIDs(mixed &$contactIDs) : array<string|int, mixed>

Parameters

$contactIDs : mixed

Return values

array<string|int, mixed>

generateSolrXML()

Given an array of values, generate the XML in the Solr format


    
                &    generateSolrXML(mixed $values) : string

Parameters

$values : mixed

Return values

string

getValues()

Given a set of contact IDs get the values


    
                    getValues(mixed &$contactIDs, mixed &$values) : array<string|int, mixed>

Parameters

$contactIDs : mixed
$values : mixed

Return values

array<string|int, mixed>

getTableInfo()


    
                    getTableInfo(mixed &$contactIDs, mixed &$values, mixed $tableName, mixed &$fields, mixed $whereField[, string|null $additionalWhereCond = NULL ]) : mixed

Parameters

$contactIDs : mixed
$values : mixed
$tableName : mixed
$fields : mixed
$whereField : mixed
$additionalWhereCond : string|null = NULL

getContactInfo()


    
                    getContactInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getLocationInfo()


    
                    getLocationInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

run()


    
                    run(mixed &$contactIDs) : mixed

Parameters

$contactIDs : mixed

splitContactIDs()

Split a large array of contactIDs into more manageable smaller chunks


    
                &    splitContactIDs(mixed &$contactIDs) : array<string|int, mixed>

Parameters

$contactIDs : mixed

Return values

array<string|int, mixed>

getValues()

Given a set of contact IDs get the values


    
                    getValues(mixed &$contactIDs, mixed &$values, mixed &$allContactIDs, mixed &$addditionalContactIDs) : array<string|int, mixed>

Parameters

$contactIDs : mixed
$values : mixed
$allContactIDs : mixed
$addditionalContactIDs : mixed

Return values

array<string|int, mixed>

getTableInfo()


    
                    getTableInfo(mixed &$contactIDs, mixed &$values, mixed $tableName, mixed &$fields, mixed $whereField[, string|null $additionalWhereCond = NULL ][, bool $flat = FALSE ]) : mixed

Parameters

$contactIDs : mixed
$values : mixed
$tableName : mixed
$fields : mixed
$whereField : mixed
$additionalWhereCond : string|null = NULL
$flat : bool = FALSE

getContactInfo()


    
                    getContactInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getNoteInfo()


    
                    getNoteInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getPhoneInfo()


    
                    getPhoneInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getEmailInfo()


    
                    getEmailInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getAddressInfo()


    
                    getAddressInfo(mixed &$contactIDs, mixed &$values) : mixed

Parameters

$contactIDs : mixed
$values : mixed

getRelationshipInfo()


    
                    getRelationshipInfo(mixed &$contactIDs, mixed &$values, mixed &$allContactIDs, mixed &$additionalContacts) : mixed

Parameters

$contactIDs : mixed
$values : mixed
$allContactIDs : mixed
$additionalContacts : mixed

getActivityInfo()


    
                    getActivityInfo(mixed &$contactIDs, mixed &$values, mixed &$allContactIDs, mixed &$additionalContacts) : mixed

Parameters

$contactIDs : mixed
$values : mixed
$allContactIDs : mixed
$additionalContacts : mixed

appendValue()


    
                    appendValue(mixed &$values, mixed $id, mixed $name, mixed $value[, bool $ignored = FALSE ]) : mixed

Parameters

$values : mixed
$id : mixed
$name : mixed
$value : mixed
$ignored : bool = FALSE

getDBFields()


    
                    getDBFields(string $daoName) : mixed

Parameters

$daoName : string

addAdditionalContacts()


    
                    addAdditionalContacts(mixed $contactIDs, mixed &$allContactIDs, mixed &$additionalContacts) : mixed

Parameters

$contactIDs : mixed
$allContactIDs : mixed
$additionalContacts : mixed

run()


    
                    run(mixed &$values, mixed &$contactIDs, mixed &$allContactIDs) : mixed

Parameters

$values : mixed
$contactIDs : mixed
$allContactIDs : mixed

smarty_block_ts()


    
                    smarty_block_ts(array<string|int, mixed> $params, mixed $text, mixed &$smarty) : string

Parameters

$params : array<string|int, mixed>
$text : mixed
$smarty : mixed

Return values

string

API Documentation

Table of Contents

Namespaces

Interfaces

Classes

Traits

Constants

Functions

Constants

_CIVICRM_FAKE_SESSION

_JEXEC

AFFORM_HTML_MONACO

API_LATEST_VERSION

API_V3_EXTENSION_DELIMITER

BACKDROP_ROOT

BACKDROP_ROOT

BLOCK_CACHE_GLOBAL

BLOCK_CACHE_PER_PAGE

BLOCK_NO_CACHE

CHUNK_SIZE

CHUNK_SIZE

CHUNK_SIZE

CIVI_SETUP

CIVICRM_CONTAINER_CACHE

CIVICRM_DSN

CIVICRM_HIBP_URL

CIVICRM_IFRAME

CIVICRM_IFRAME

CIVICRM_IFRAME

CIVICRM_L10N_BASEDIR

CIVICRM_L10N_BASEDIR

CIVICRM_SETTINGS_PATH

CIVICRM_SETTINGS_PATH

CIVICRM_TEMPLATE_COMPILEDIR

CIVICRM_TEST

CIVICRM_TEST

CIVICRM_TEST

CIVICRM_UF

CIVICRM_UF

CIVICRM_UF

CIVICRM_UF

CIVICRM_UF_BASEURL

CIVICRM_UF_BASEURL

CIVICRM_UF_BASEURL

DB_DSN_MODE

DRUPAL_ROOT

DRUPAL_ROOT

DS

JDEBUG

JPATH_BASE

JVERSION

MAIL_BATCH_SIZE

RECAPTCHA_API_SECURE_SERVER

RECAPTCHA_API_SERVER

RECAPTCHA_VERIFY_SERVER

WP_USE_THEMES

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