Documentation

Application

Interfaces

API_Wrapper: Interface API_Wrapper
ChangeSetInterface
ProviderInterface: An API "provider" provides a means to execute API requests.
EntityInterface: This is currently a null interface - it allows picking up AbstractEntities via the ClassScanner
SpecProviderInterface
CiviEventDispatcherInterface: The EventDispatcherInterface is the central point of Symfony's event listener system.
LockInterface: Lock interface.
AutoServiceInterface: The CiviCRM container will automatically load classes that implement AutoServiceInterface.
DataSourceInterface: Objects that implement the DataSource interface can be used in CiviCRM imports.
EntityMetadataInterface
EntityStorageInterface
StepInterface
ExampleDataInterface
UserJobInterface
WorkflowMessageInterface
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_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.
BehaviorInterface: An AfformBehavior is a collection of configuration and functionality for an entity on a form.
ClickTrackerInterface
MFAInterface
AlgorithmInterface
SchemaHelperInterface: The SchemaHelperInterface provides utility methods for managing the schema in an extension (e.g. installing or uninstalling all SQL tables).
SetupControllerInterface

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
Events
MappingBase: Base implementation of MappingInterface.
AngularLoader: The AngularLoader loads any JS/CSS/JSON resources required for setting up AngularJS.
ChangeSet
Coder
Main: This page is simply a container; any Angular modules defined by CiviCRM (or by CiviCRM extensions) will be activated on this page.
Modules: This page aggregates data from Angular modules.
Api3SelectQuery: Query builder for civicrm_api_basic_get.
ExceptionEvent: Handle any exceptions that occur while processing an API request.
Events: The API kernel dispatches a series of events while processing each API request.
AdhocProvider: An adhoc provider is useful for creating mock API implementations.
MagicFunctionProvider: This class manages the loading of API's using strict file+function naming conventions.
ReflectionProvider: This class defines operations for inspecting the API's metadata.
StaticProvider: A static provider is useful for creating mock API implementations which manages records in-memory.
WrappingProvider: A wrapping provider overrides an existing API. It has discretion to pass-through to the original API (0 or many times) or to substitute with entirely different behavior.
APIv3SchemaAdapter: This class determines what fields are allowed for a request and validates that the fields are provided correctly.
ChainSubscriber: The ChainSubscriber looks for API parameters which specify a nested or chained API call. For example:
DynamicFKAuthorization: This is only used by the APIv3 "Attachment" entity.
PermissionCheck: For any API requests that correspond to a Doctrine entity ($apiRequest['doctrineClass']), check permissions specified in Civi\API\Annotation\Permission.
WrapperAdapter: This is a wrapper for the legacy "API Wrapper" interface which allows wrappers to run through the new kernel. It translates from dispatcher events ('civi.api.prepare', 'civi.api.respond') to wrapper calls ('fromApiInput', 'toApiOutput').
Create: Create a new $ENTITY from supplied values.
GetCoordinates: Converts an address string to lat/long coordinates.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
Create: Create a new $ENTITY from supplied values.
Delete: Deletes a contact, by default moving to trash. Set `useTrash = FALSE` for permanent deletion.
GetChecksum: Generate a security checksum for anonymous access to CiviCRM.
GetDuplicates: Get matching contacts based on a dedupe rule
MergeDuplicates: Merge 2 contacts
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
ValidateChecksum: Generate a security checksum for anonymous access to CiviCRM.
Create: Create a new $ENTITY from supplied values.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
Create: Create a new $ENTITY from supplied values.
Delete: Delete one or more items, based on criteria specified in Where param.
Get: Get fields for a custom group.
Save: Create or update one or more $ENTITIES.
Update: Update one or more records with new values. Use the where clause to select them.
Get: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
Get: Get the names & docblocks of all APIv4 entities.
Get: Base class for all actions that need to fetch records (`Get`, `Update`, `Delete`, etc.).
Get: Get a list of example data-sets.
GetActions: Get all API actions for the $ENTITY entity.
GetLinks: Get action links for the $ENTITY entity.
Refresh: $ACTION one or more $ENTITIES.
Create: Create a new $ENTITY from supplied values.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
Create: Create a new $ENTITY from supplied values.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
Create: Create a new $ENTITY from supplied values.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
Reconcile: Refresh managed entities.
Revert: Reverts a MessageTemplate subject and message to the contents of the master
Get: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
Create: Base class for all api actions.
Get: Get a list of extant permissions.
ClaimItems: Claim an item from the queue. Returns zero or one items.
Run: Run a series of items from a queue.
RunItems: Run an enqueued item (task).
Get: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
Rebuild: Rebuild contents of the `civicrm_relationship_cache` table.
AbstractSettingAction: Base class for setting actions.
Get: Get the value of one or more CiviCRM settings.
GetFields: Get information about CiviCRM settings.
Revert: Revert one or more CiviCRM settings to their default value.
Set: Set the value of one or more CiviCRM settings.
Check: Retrieve system notices, warnings, errors, etc.
Flush: Clear CiviCRM caches, and optionally rebuild triggers and reset sessions.
ResetPaths: Reset paths using doSiteMove().
RotateKey: Rotate the keys used for encrypted database content.
Render: Render a message.
AuthorizeRecordEvent: Determine if the a user has WRITE access to a given record.
CreateApi4RequestEvent: Unused event, kept around to prevent undefined class errors in extensions that listen for it.
Events
SchemaMapBuildEvent: Class GenericHookEvent
ActivitySchemaMapSubscriber: AutoService is a base-class for defining a service (in Civi's service-container).
ContactSchemaMapSubscriber: AutoService is a base-class for defining a service (in Civi's service-container).
AbstractPrepareSubscriber: AutoService is a base-class for defining a service (in Civi's service-container).
PreCreationSubscriber: AutoService is a base-class for defining a service (in Civi's service-container).
PreSaveSubscriber: AutoService is a base-class for defining a service (in Civi's service-container).
IsCurrentSubscriber: AutoService is a base-class for defining a service (in Civi's service-container).
MessageTemplateSchemaMapSubscriber: AutoService is a base-class for defining a service (in Civi's service-container).
PermissionCheckSubscriber: For any API requests that correspond to a Doctrine entity ($apiRequest['doctrineClass']), check permissions specified in Civi\API\Annotation\Permission.
ValidateFieldsSubscriber: Validate field inputs based on annotations in the action class
ValidateValuesEvent: The ValidateValuesEvent ('civi.api4.validate') is emitted when creating or saving an entire record via APIv4.
AbstractAction: Base class for all api actions.
AbstractEntity: Base class for all api entities.
AutocompleteAction: Retrieve $ENTITIES for an autocomplete form field.
BasicCreateAction: Create a new $ENTITY from supplied values.
BasicEntity: Base class for ad-hoc entities that implement CRUD actions.
BasicGetAction: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
BasicGetFieldsAction: Lists information about fields for the $ENTITY entity.
BasicReplaceAction: Replaces an existing set of $ENTITIES with a new one.
BasicSaveAction: Create or update one or more $ENTITIES.
BasicUpdateAction: Update one or more $ENTITY with new values.
CheckAccessAction: Check if current user is authorized to perform specified action on a given $ENTITY.
DAOCreateAction: Create a new $ENTITY from supplied values.
DAODeleteAction: Delete one or more $ENTITIES.
DAOEntity: Base class for DAO entities (sql tables).
DAOGetAction: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
DAOGetFieldsAction: Lists information about fields for the $ENTITY entity.
DAOSaveAction: Create or update one or more $ENTITIES.
DAOUpdateAction: Update one or more $ENTITY with new values.
ExportAction: Export $ENTITY to civicrm_managed format.
Result: Container for api results.
ActionObjectProvider: Accept $apiRequests based on \Civi\API\Action
Api4EntitySetQuery: Constructs queries for set operations (UNION, etc).
Api4Query: A query `node` may be in one of three formats:
Api4SelectQuery: Constructs SELECT FROM queries for API4 GET actions.
SqlBool: Boolean sql expression
SqlEquation: Numeric sql expression
SqlField: Sql column expression
SqlFunctionABS: Sql function
SqlFunctionAVG: Sql function
SqlFunctionBINARY: Sql function
SqlFunctionCOALESCE: Sql function
SqlFunctionCONCAT: Sql function
SqlFunctionCONCAT_WS: Sql function
SqlFunctionCOUNT: Sql function
SqlFunctionCURDATE: Sql function
SqlFunctionDATE: Sql function
SqlFunctionDATEDIFF: Sql function
SqlFunctionDAYOFWEEK: Sql function
SqlFunctionDAYSTOANNIV: Sql function
SqlFunctionEXTRACT: Sql function
SqlFunctionGREATEST: Sql function
SqlFunctionGROUP_CONCAT: Sql function
SqlFunctionGROUP_FIRST: Sql function returns the first item in a GROUP_CONCAT set (per the ORDER_BY param)
SqlFunctionIF: Sql function
SqlFunctionIFNULL: Sql function
SqlFunctionISNULL: Sql function
SqlFunctionLEAST: Sql function
SqlFunctionLEFT: Sql function
SqlFunctionLOWER: Sql function
SqlFunctionMAX: Sql function
SqlFunctionMIN: Sql function
SqlFunctionMONTH: Sql function
SqlFunctionNEXTANNIV: Sql function
SqlFunctionNOW: Sql function
SqlFunctionNULLIF: Sql function
SqlFunctionQUARTER: Sql function
SqlFunctionRAND: Sql function
SqlFunctionREPLACE: Sql function
SqlFunctionRIGHT: Sql function
SqlFunctionROUND: Sql function
SqlFunctionSUBSTRING: Sql function
SqlFunctionSUM: Sql function
SqlFunctionTIME: Sql function
SqlFunctionUPPER: Sql function
SqlFunctionYEAR: Sql function
SqlNull: NULL sql expression
SqlNumber: Numeric sql expression
SqlString: String sql expression
SqlWild: Wild * sql expression
LegacyEntityScanner: This provides transitional support for extensions that provide Api4 Entities without having the scan-classes mixin
LegacySpecScanner: This provides transitional support for extensions that implemented 'SpecProviderInterface'.
CustomGroupJoinable
ExtraJoinable: Like Joinable but without any default conditions so it can be fully customized.
Joinable
Joiner
SchemaMap
SchemaMapBuilder: AutoService is a base-class for defining a service (in Civi's service-container).
Table
CustomFieldSpec: Contains APIv4 field metadata
FieldSpec: Contains APIv4 field metadata
RequestSpec
SpecFormatter
CoreUtil
FormattingUtil
ReflectionUtils: Just another place to put static functions.
SelectUtil
SequenceListener: The sequence-listener looks for CiviCase XML tags with "<sequence>". If a change is made to any record in case-type which uses "<sequence>", then it attempts to add the next step in the sequence.
CSVParser: Parse phpunit result files
EnvTestRunner: Parse phpunit result files
JenkinsParser: Parse Jenkins result files
PHPUnitParser: Parse phpunit result files
PHPUnitScanner: Search for PHPUnit test cases
CiviEventInspector: Class CiviEventInspector
ClassScanner: The ClassScanner is a helper for finding/loading classes based on their tagged interfaces.
AutoServiceScannerPass: Scan the source-tree for implementations of `AutoServiceInterface`. Load them.
EventScannerPass: Scan for services that have the tag 'event_subscriber'.
SpecProviderPass: Scan the container for services tagged as 'spec_provider'.
EventScanner: The `EventScanner` is a utility for scanning a class to see if it has any event-listeners. It may check for common interfaces and conventions. Example:
HookStyleServiceListener: A hook-style service-listener is a callable with two properties:
DBQueryException: Error when the syntax of a DB query is incorrect.
UnknownAssetException: Base class for exceptions generated by CiviCRM.
Locale: Define a locale.
MetadataFlush: Event subscriber for metadata cache clear events.
ResolverGlobalCallback
PharExtensionInterceptor: An alternate PharExtensionInterceptor to support phar-based CLI tools.
AutoDefinition
AutoService: AutoService is a base-class for defining a service (in Civi's service-container).
AutoSubscriber: AutoSubscriber allows child classes to listen to events.
Url: Generate a URL.
CryptoException: Class CryptException
FkEntityDeleteSubscriber: AutoSubscriber allows child classes to listen to events.
BrowserLoader: The BrowserLoader leverages the browser's built-in support for ECMAScript Modules (ESM's).
ImportMap: ECMAScript Modules (ESMs) allow you to load a JS file based on a physical-path or a logical-path. Compare:
ShimLoader: The ShimLoader leverages `es-module-shims` for loading ECMAScript Modules (ESM's).
PaymentProcessorException: Class PaymentProcessorException
PropertyBag
BasicPipeClient: This is a thin/trivial client implementation that connects to Civi::pipe() and synchronously exchanges JSON messages.
JsonRpc
JsonRpcMethodException: The JsonRpcMethodException is emitted by a JSON-RPC client if a method call returns an error.
PipeSession
PublicMethods: Collection of methods to expose to the pipe session. Any public method will be accessible.
OutputHandlerBase: Base Report Output Handler
EntityMetadataBase
EntityProvider
EntityRepository: Gathers and stores schema metadata
LegacySqlEntityMetadata: Supports older extensions that created dao-based entities with `civix generate:entity-boilerplate`.
SqlEntityMetadata
SqlEntityStorage
ErrorHandler: Standalone's custom error handler (was previously in index.php)
WebEntrypoint: Logic for loading web pages (would be in index.php, but here we can update it)
CallbackStep
ExtensionsStep
SqlFileStep
SqlStep
CiviEnvBuilder: Class CiviEnvBuilder
Data: Class Data
EntityExample: Helper class for defining entity examples.
EventCheck: An EventCheck is a fragment of a unit-test -- it is mixed into various test-scenarios and applies extra assertions.
EventChecker
EventCheckException
Alex: Helper class for defining entity examples.
Barb: Helper class for defining entity examples.
TheDailyBugle: Helper class for defining entity examples.
Euro5990: Helper class for defining entity examples.
Euro5990: Helper class for defining entity examples.
PaidEvent: Helper class for defining entity examples.
ExampleDataLoader
FormWrapper
EventFormOnline
EventFormParticipant
LocalHttpClient: (Experimental) Send HTTP-style requests directly to CRM_Core_Invoke (PSR-18 ClientInterface).
MinkBase: Class MinkBase. Helper functions for E2E testing.
PageWrapper
RemoteTestFunction: RemoteTestFunctions may be used by tests to define (inline) code that will run on a remote server.
Schema: Class Schema
TAP7: Implementation of TAP for PHPUnit 7.x-8.x.
TAP9: Implementation of TAP for PHPUnit 9.x.
TAPLegacy
Test: Class Test
Events
GenericEntityTokens: Class CRM_Core_EntityTokens
StandardFilters: This class is a collection of token filter functions. For example, consider this message:
TokenException: Base class for exceptions generated by CiviCRM.
TokenProcessor: The TokenProcessor is a template/token-engine. It is heavily influenced by traditional expectations of CiviMail, but it's adapted to an object-oriented, extensible design.
TokenRowIterator
WorkflowMessageException: An error encountered while evaluating a workflow-message-template.
FieldSpec
Alex: Helper class for defining WorkflowMessage example-data.
GenericWorkflowMessage: Generic base-class for describing the inputs for a workflow email template.
WorkflowMessage: A WorkflowMessage describes the inputs to an automated email messages.
WorkflowMessageExample: Helper class for defining WorkflowMessage example-data.
Civi: Class Civi
CRM_ACL_BAO_ACL: Access Control List
CRM_Activity_BAO_Activity: This class is for activity functions.
CRM_Activity_Form_Task_PDF: This class provides the functionality to create PDF/Word letters for activities.
CRM_Admin_Form_MessageTemplates: This class generates form components for Message templates used by membership, contributions, event registrations, etc.
CRM_Admin_Page_ExtensionsUpgrade: Display a page which displays a progress bar while executing upgrade tasks.
CRM_Badge_Form_Layout: This class generates form components for name badge layout.
CRM_Batch_Form_Batch: This class generates form components for batch entry.
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_Form_Activity_OpenCase: This class generates form components for OpenCase Activity.
CRM_Case_Form_AddToCaseAsRole: Class CRM_Case_Form_AddToCaseAsRole
CRM_Case_Form_DeleteClient: This class assigns the current case to another client.
CRM_Case_ManagedEntities: Class CRM_Case_ManagedEntities
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_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_Relationship: Class CRM_Contact_BAO_Relationship.
CRM_Contact_BAO_RelationshipCache: Class CRM_Contact_BAO_RelationshipCache.
CRM_Contact_Form_Relationship: This class generates form components for relationship.
CRM_Contact_Form_Task_AddToHousehold: This class provides the functionality to add contact(s) to Household.
CRM_Contact_Form_Task_AddToParentClass: This class provides the shared functionality for addToHousehold and addToOrganization.
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_Import_Parser_Contact: class to parse contact csv files
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_Controller_Task: Class CRM_Export_Controller_Standalone
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_Form_CancelSubscription: This class provides support for canceling recurring subscriptions.
CRM_Contribute_Form_Contribution: This class generates form components for processing a contribution.
CRM_Contribute_Form_ContributionView: This class generates form components for Payment-Instrument.
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_Page_ContributionRecurPayments: Shows list of contributions done as payments within a recurring contribution.
CRM_Contribute_RecurTokens: Class CRM_Contribute_RecurTokens
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_BAO_Cache: BAO object for civicrm_cache table.
CRM_Core_BAO_CMSUser: Class CRM_Core_BAO_CMSUser
CRM_Core_BAO_TranslateGetWrapper: Wrapper to swap in translated text.
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_Config_MagicMerge: Class CRM_Core_Config_MagicMerge
CRM_Core_Config_Runtime: Class CRM_Core_Config_Runtime
CRM_Core_Controller_Task: Class CRM_Export_Controller_Standalone
CRM_Core_DAO_Base: Base for concrete DAO/BAO classes which are defined with a schema/entityType.php file.
CRM_Core_DAO_Factory: Class CRM_Core_DAO_Factory
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_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_Search: Base class for most search forms
CRM_Core_Form_Task: This is a shared parent class for form task actions.
CRM_Core_GroupTokens: Class CRM_Core_GroupTokens
CRM_Core_HTMLInputCoder: Class CRM_Core_HTMLInputCoder
CRM_Core_LegacyErrorHandler: Class CRM_Core_LegacyErrorHandler
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_Page_AJAX_Attachment: CRM_Core_Page_AJAX_Attachment defines an end-point for AJAX operations which upload file-attachments.
CRM_Core_Page_AJAX_RecurringEntity: Description of EntityApplyChangesTo
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_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_Redirect: Placeholder page which generates a redirect
CRM_Core_Page_RemoteTestFunction: Handle requests for civicrm/dev/rtf
CRM_Core_Payment_BaseIPN: Class CRM_Core_Payment_BaseIPN.
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_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_ProcessorForm: Base class for building payment block for online contribution / event pages.
CRM_Core_Payment: Class CRM_Core_Payment.
CRM_Core_Permission_List: Class CRM_Core_Permission_List
CRM_Core_PrevNextCache_Redis: Class CRM_Core_PrevNextCache_Memory
CRM_Core_PrevNextCache_Sql: Class CRM_Core_PrevNextCache_Sql
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_Session: Class CRM_Core_Session.
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_SmartyCompatibility
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_TokenSmarty: `Token-Smarty` is a hybrid template format, combining Civi token notation with Smarty notation, as in `{if {contact.id} > 10}...{/if}`.
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_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_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_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_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_Controller_Registration: Class CRM_Event_Controller_Registration
CRM_Event_Controller_Search: This class is used by the Search functionality.
CRM_Event_Form_ManageEvent_Location: This class generates form components for processing Event Location civicrm_event_page.
CRM_Event_Form_ManageEvent_Repeat: Class to manage the "Repeat" functionality for event
CRM_Event_ICalendar: Class to generate various "icalendar" type event feeds
CRM_Event_Page_DashBoard: This is page is for Event Dashboard
CRM_Event_Page_List: Display a list of events on a page
CRM_Event_ParticipantTokens: Class CRM_Event_ParticipantTokens
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_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_Controller_Standalone: Class CRM_Export_Controller_Standalone
CRM_Export_Utils
CRM_Extension_BootCache
CRM_Extension_ClassLoader: Class CRM_Extension_ClassLoader
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_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_Financial_FinancialTrxnTokens: Class CRM_Event_Tokens
CRM_Import_Exception_ImportTableUnavailable: Base class for exceptions generated by CiviCRM.
CRM_Import_ImportProcessor: Class CRM_Import_ImportProcessor.
CRM_Logging_ReportSummary: Class CRM_Logging_ReportSummary
CRM_Mailing_ActionTokens: Class CRM_Mailing_ActionTokens
CRM_Mailing_BAO_MailingJob: Class CRM_Mailing_BAO_MailingJob
CRM_Mailing_BAO_SMSJob: Job for SMS deliery functions.
CRM_Mailing_Event_BAO_MailingEventConfirm: Class CRM_Mailing_Event_BAO_Confirm
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_MailingEventUnsubscribe: Class CRM_Mailing_Event_BAO_Unsubscribe
CRM_Mailing_Service_ListUnsubscribe: Apply a full range of `List-Unsubscribe` header options.
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_Form_Membership: This class generates form components for offline membership form.
CRM_Member_Form_MembershipBlock: form to process actions on Membership
CRM_Member_Page_RecurringContributions: Shows list of recurring contributions related to membership.
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_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_PriceField: Business objects for managing price fields.
CRM_Profile_Page_Dynamic: Create a page for displaying CiviCRM Profile Fields.
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_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_Form_Instance: Class CRM_Report_Form_Instance
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_UF_Form_Inline_Preview: This class generates form components for previewing Civicrm Profile Group
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_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_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_Snapshot: Provide helpers for recording data snapshots during an upgrade.
CRM_Utils_Cache_CacheException: Class CRM_Utils_Cache_CacheException
CRM_Utils_Cache_InvalidArgumentException: Class CRM_Utils_Cache_InvalidArgumentException
CRM_Utils_ConsoleTee: Capture the output from the console, copy it to a file, and pass it on.
CRM_Utils_GuzzleMiddleware: Additional helpers/utilities for use as Guzzle middleware.
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_SameSite: SameSite Utility Class.
CRM_Utils_SQL_BaseParamQuery: Class CRM_Utils_SQL_BaseParamQuery
CRM_Utils_SQL_Insert: Object-oriented SQL builder for INSERT queries.
CRM_Utils_SQL_Literal: A literal fragment of SQL.
CRM_Utils_System_Base: Base class for UF system integrations
CRM_Utils_Token: Class to abstract token replacement.
CRM_Utils_Url
CRM_Utils_Weight: Class CRM_Utils_Weight
CRM_AfformAdmin_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
AfformAdminMeta
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.
AbstractBehavior: Base class for Afform Behaviors
AHQ: AHQ: ArrayHtml Query
AfformBaseEvent: Class GenericHookEvent
AfformEntitySortEvent: This event allows listeners to declare that entities depend on others.
AfformPrefillEvent: Class GenericHookEvent
AfformValidateEvent: Class GenericHookEvent
PageTokenCredential: Allow Afform-based pages to accept page-level access token
StatusChecks
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_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.
AfformBehaviorTest
AfformContactSummaryTest
AfformGetTest
AfformMetadataTest
AfformSubmissionTest
FormDataModelTest
SymbolsTest
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.
Tokens: Every afform with the property `is_token=true` should have a corresponding set of tokens, `{afform.myFormLoginUrl}` and `{afform.myFormLoginLink}`.
CRM_AfformMock_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
AfformAutocompleteUsageTest: Test case for Afform with autocomplete.
AfformConditionalUsageTest: Test case for Afform with autocomplete.
AfformContactUsageTest: Test case for Afform.checkAccess, Afform.prefill and Afform.submit.
AfformCustomFieldUsageTest: Test case for Afform.prefill and Afform.submit.
AfformEventUsageTest: Test case for Afform.prefill and Afform.submit with Event records.
AfformFileUploadTest: Test case for Afform.prefill and Afform.submit.
AfformGroupSubscriptionUsageTest: Test case for Afform.prefill and Afform.submit with GroupSubscription records.
AfformPrefillUsageTest: Test case for Afform with autocomplete.
AfformRelationshipUsageTest: Test case for Afform.prefill and Afform.submit.
AfformRoutingTest: Ensure that the routes created by Afform are working.
AfformTest: Afform.Get API Test Case This is a generic test class implemented with PHPUnit.
AfformTestCase: Base class for Afform API tests.
AfformUsageTestCase: Test case for Afform.prefill and Afform.submit.
MockPublicFormBrowserTest: Perform some tests against `mockPublicForm.aff.html`.
MockPublicFormTest: Perform some tests against `mockPublicForm.aff.html`.
CRM_Authx_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
Create: Generate a security checksum for anonymous access to CiviCRM.
Validate: Validate that a credential is still valid and can be used in CiviCRM.
AuthenticatorTarget
AuthxException: Base class for exceptions generated by CiviCRM.
AuthxRequestBuilder: (TEST HELPER/EXPERIMENTAL) This class helps with building test-scenarios where we use different authx flows/credentials.
Backdrop
CheckCredential: This class is a small collection of common/default credential checkers.
CheckCredentialEvent: CheckCredentialEvent examines a credential and (if it validly represents a user-principal) then it reports the principal.
CheckPolicyEvent: After we have determined that a credential appears authentic, we must check whether our current policies allow this credential be used in this way.
Drupal
Drupal8
Joomla
Meta
None
WordPress
CRM_Authx_Page_AJAX
AuthxCredentialTest: Test AuthxCredential API methods
AbstractFlowsTest
CustomFlowsTest: Send requests using customizable flows. These don't use standard HTTP requests.
JwtCredsTest: Check that JWT credentials work in the expected ways.
MixedFlowsTest: In the MixedFlowsTest, we assume that the basic flows work -- then step out to another level.
StatefulFlowsTest: Send requests using stateful authentication mechanisms (such as `login`).
StatelessFlowsTest: Send requests using stateless authentication mechanisms (such as `header`, `xheader`, and `param`).
CRM_ChartKit_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
Get: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
CRM_Campaign_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
Create: Create a new $ENTITY from supplied values.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
CRM_Case_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
Create: Create a new $ENTITY from supplied values.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
Create: This API Action creates a payment and supports setting custom fields on FinancialTrxn
Get: This API Action gets a payment
CRM_Contribute_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
ContributionRecurTest: FIXME - Add test description.
Get: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
CRM_Event_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
CreateAction: Create a new $ENTITY from supplied values.
SaveAction: Create or update one or more $ENTITIES.
UpdateAction: Update one or more $ENTITY with new values.
TestConnection: $ACTION one or more $ENTITIES.
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.
ReportInstanceTest: Test CiviReportInstance functionality.
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_Form_Grant: This class generates form components for processing a case
CRM_Grant_Form_Task: Class for grant form task actions.
CRM_Grant_Upgrader: Collection of upgrade steps.
CheckAccessAction: Check if current user is authorized to perform specified action on the given import.
Create: Create a new $ENTITY from supplied values.
Import: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
Validate: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
Spreadsheet: Objects that implement the DataSource interface can be used in CiviCRM imports.
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_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_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_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.
BaseTestClass
BuildAmountHookTest: Test that that financial acls are applied in the context of buildAmountHook.
ContributionSoftTest: Class CRM_Contribute_BAO_ContributionTest
ContributionTest: Class CRM_Contribute_BAO_ContributionTest
EntityFinancialAccountTest
FinancialAccountTest
FinancialTypeTest
LineItemTest: FIXME - Add test description.
MembershipTypesTest
OptionsTest
ProductTest
CRM_Flexmailer_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
MailingPreview
HtmlClickTracker: AutoService is a base-class for defining a service (in Civi's service-container).
TextClickTracker: AutoService is a base-class for defining a service (in Civi's service-container).
Attachments: AutoService is a base-class for defining a service (in Civi's service-container).
BaseListener
BasicHeaders: AutoService is a base-class for defining a service (in Civi's service-container).
BounceTracker: AutoService is a base-class for defining a service (in Civi's service-container).
DefaultBatcher: AutoService is a base-class for defining a service (in Civi's service-container).
DefaultSender: AutoService is a base-class for defining a service (in Civi's service-container).
HookAdapter: AutoService is a base-class for defining a service (in Civi's service-container).
OpenTracker: AutoService is a base-class for defining a service (in Civi's service-container).
TestPrefix: AutoService is a base-class for defining a service (in Civi's service-container).
ToHeader: AutoService is a base-class for defining a service (in Civi's service-container).
MailParams: Class MailParams
HtmlClickTrackerTest: Class HtmlClickTrackerTest
TextClickTrackerTest: Class HtmlClickTrackerTest
ClickTrackerTest: Tests that URLs are converted to tracked ones if at all possible.
ConcurrentDeliveryTest: Class ConcurrentDeliveryTest
FlexMailerSystemTest: Class FlexMailerSystemTest
SimpleFilterTest: Class SimpleFilterTest
MailingPreviewTest: Class MailingPreviewTest
ValidatorTest: Class ValidatorTest
CRM_Greenwich_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
Iframe: Base class for ad-hoc entities that implement CRUD actions.
Cosession: The co-session provides a long (real) session built on top of short (fake) sessions.
Backdrop: Begin processing of an embedded page-view on Backdrop
Drupal: Begin processing of an embedded page-view on Drupal 7.
Drupal8: Begin processing of an embedded page-view on Drupal 8/9/10/etc.
Iframe: AutoService is a base-class for defining a service (in Civi's service-container).
Router: AutoService is a base-class for defining a service (in Civi's service-container).
ScriptManager: Manage the iframe entry-point script.
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.
IframeDrupalKernel: We want to set the cookie-name so that `iframe.php` doesn't try to use or change cookies issued by `index.php`. This will be... fun.
IframeSessionConfiguration
CRM_Core_InnoDBIndexer: The InnoDB indexer is responsible for creating and destroying full-text indices on InnoDB classes.
CRM_Legacycustomsearches_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
FullTextTest: FIXME - Add test description.
SampleTest: FIXME - Add test description.
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.
Create: Create a new $ENTITY from supplied values.
Update: Update one or more $ENTITY with new values.
Delete: Delete one or more $ENTITIES.
OAuthProvider: Base class for all api entities.
OAuthException: Base class for exceptions generated by CiviCRM.
OAuthLeagueFacade
OAuthTokenFacade
TestOAuthDotComProvider: Class CiviGenericProvider
CRM_OAuth_Angular
CRM_OAuth_BAO_OAuthContactToken: Database access object for the OAuthContactToken entity.
CRM_OAuth_ContactFromToken
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.
DummyProvider: Class CiviGenericProvider
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.
AuthCodeFlowTest
CiviGenericProviderTest
CRM_OAuth_MailSetupTest: Test helper functions in CRM_OAuth_MailSetup.
Oembed: AutoService is a base-class for defining a service (in Civi's service-container).
OembedDiscovery: Emit tags so that downstream users know that pages are embeddable.
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.
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.
SendTest
SearchKitSubscriber: Event subscriber to check extra permission for SavedSearches
SkEntityMetaProvider
CRM_Search_BAO_SearchDisplay: Search Display BAO
CRM_Search_BAO_SearchSegment: Search Segment BAO
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.
AbstractRunActionTest
EntityDisplayTest
ManagedSearchTest
SearchAfformTest
SearchDisplayTest
SearchDownloadTest
SearchExportTest
SearchRunTest
SearchRunWithCustomFieldTest: Use this base class for any APIv4 tests which create custom groups/fields, to ensure they get cleaned up properly.
UtilsTest
SearchSegmentTest
AdminTest
CRM_Sequentialcreditnotes_ExtensionUtil: The ExtensionUtil class provides small stubs for accessing resources of this extension.
SequentialcreditnotesTest: FIXME - Add test description.
Get: Retrieve $ENTITIES based on criteria specified in the `where` parameter.
Save: Create or update one or more $ENTITIES.
Update: Update one or more $ENTITY with new values.
ConfirmSeed: Verify that the user correctly applied the seed to their authenticator app.
Create: use Civi\Api4\Generic\Result;
Login: Base class for all api actions.
PasswordReset: This is designed to be a public API
Save: Create or update one or more $ENTITIES.
SendPasswordReset: This is designed to be a public API
Update: Update one or more $ENTITY with new values.
Standalone
Base
TOTP: Time based One-Time Password.
Drupal7
Security: Security related functions for Standaloneusers.
SessionHandler
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_DAO_Totp: DAOs provide an OOP-style facade for reading and writing database records.
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.
RolePermissionTest
UserTest: Test the Standaloneusers User Api4 actions
MfaTest: FIXME - Add test description.
SecurityTest: Test Security flows in Standalone
SessionHandlerTest
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.
CaseTypeTest: Assert that the case-type XML mixin is working properly.
EntityTypesTest: Assert that the `settings/*.setting.php` mixin is working properly.
CRM_Shimmy_Page_FooBar: A Page is basically data in a nice pretty format.
MenuXmlTest: Assert that the `xml/Menu/*.xml` mixin is working properly.
ManagedCaseTypeTest: Assert that the mgd-php mixin is picking the case-type and all its related data.
ManagedTest: Assert that the managed-entity mixin is working properly.
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.
ScanClassesTest: Assert that the 'scan-classes' mixin is working properly.
SettingsAdminTest: Assert that the settings-page is created.
About
Nav
CRM_Shimmy_Utils
SettingsTest: Assert that the `settings/*.setting.php` mixin is working properly.
SmartyTest: Assert that the 'scan-classes' mixin is working properly.
SmartyTest: Assert that the 'scan-classes' mixin is working properly.
InstallSchemaPlugin
BasicRunner
DbUtil
DrupalUtil
BaseSetupEvent: Class GenericHookEvent
CheckAuthorizedEvent: Check if the current user is authorized to perform installations.
CheckInstalledEvent: Check if CiviCRM is already installed.
CheckRequirementsEvent: Check if the local system meets the installation requirements.
InitEvent: Initialize a "Setup" subsystem. This is useful for populating the model with default settings.
InstallDatabaseEvent: Initialize the CiviCRM database.
InstallFilesEvent: Initialize the CiviCRM support files, such as `civicrm.settings.php` or `templateCompileDir`
UninstallDatabaseEvent: Purge any CiviCRM schema (tables, views, functions) from the database.
UninstallFilesEvent: Purge any CiviCRM support files, such as `civicrm.settings.php` or `templateCompileDir`
InitException
SqlException
FileUtil
LocaleUtil
PackageUtil
SchemaGenerator
SettingsUtil: Helpers for working with "civicrm.settings.php.template" data.
SmartyUtil
StandaloneScaffold: Install basic scaffolding for standalone. This creates a handful of small, static folders and files.
Template
BaseUIEvent: Class GenericHookEvent
UIBootEvent: Run the stock web-based UI.
UIConstructEvent: Create a web-based UI for handling the installation.
UIRunEvent: Run the stock web-based UI.
SetupController
SetupResponse: This represents a response from the Setup UI.
Setup
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
api_v3_APIWrapperTest_Impl: Class api_v3_APIWrapperTest_Impl
api_v3_CampaignTest: Class api_v3_CampaignTest
api_v3_CaseTypeTest: Class api_v3_CaseTypeTest
api_v3_ContactTypeTest: Class api_v3_ContactTypeTest
api_v3_CustomSearchTest: Class api_v3_CustomSearchTest
api_v3_CustomValueTest: Class api_v3_CustomValueTest
api_v3_EmailTest: Class api_v3_EmailTest
api_v3_EventTest: Class api_v3_EventTest
api_v3_GroupContactTest: Class api_v3_GroupContactTest
api_v3_LineItemTest: Class api_v3_LineItemTest
api_v3_LocBlockTest: Class api_v3_LocBlockTest
api_v3_MailSettingsTest: Class api_v3_MailSettingsTest
api_v3_MembershipStatusTest: Class api_v3_MembershipStatusTest
api_v3_MembershipTest: Class api_v3_MembershipTest
api_v3_MembershipTypeTest: Class api_v3_MembershipTypeTest
api_v3_NavigationTest: Class api_v3_NavigationTest
api_v3_NoteTest: Class contains api test cases for "civicrm_note"
api_v3_OptionGroupTest: Class api_v3_OptionGroupTest
api_v3_OptionValueTest: Class api_v3_OptionValueTest
api_v3_ParticipantStatusTypeTest: Class api_v3_ParticipantStatusTypeTest
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_PaymentTokenTest: Class api_v3_PaymentTokenTest
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_RelationshipTest: Class contains api test cases for "civicrm_relationship"
api_v3_RelationshipTypeTest: Class contains api test cases for "civicrm_relationship_type"
api_v3_SurveyRespondantTest: Class api_v3_SurveyRespondantTest
api_v3_TaxContributionPageTest: Class api_v3_TaxContributionPageTest
ActionScheduleTest: Test ActionSchedule functionality
CampaignTest
PCPTest
AjaxTest
FormattingUtilTest
AbstractMappingTest: The AbstractMappingTest is a base class which can help define new tests for scheduled-reminders.
SavedSearchMappingTest: Test scheduled-communications based on SavedSearches.
ChangeSetTest: Test the reading-writing of HTML snippets.
LoaderTest: Test the Angular loader.
ManagerTest: Test the Angular base page.
PartialSyntaxTest: Ensure that all Angular *.html partials are well-formed.
EntityLookupTest: Base class for CiviCRM unit tests
PrepareEventTest: Base class for CiviCRM unit tests
KernelTest: Base class for CiviCRM unit tests
RequestTest: Base class for CiviCRM unit tests
DynamicFKAuthorizationTest: Base class for CiviCRM unit tests
TransactionSubscriberTest: Base class for CiviCRM unit tests
WhitelistSubscriberTest: The WhitelistSubscriber enforces security policies based on API whitelists. This test combines a number of different policies with different requests and determines if the policies are correctly enforced.
DoNothing: Action that does nothing; called via magic method
CiviEventInspectorTest: Class CiviEventInspectorTest
CiviFacadeTest: Base class for CiviCRM unit tests
GenericHookEventTest: Base class for CiviCRM unit tests
HookStyleServiceListenerTest: Register a service (eg 'test.hssvlt') with a hook method (eg `function hook_civicrm_hssvlt()`).
HookStyleServiceListenerTestExample
ServiceListenerTest: Base class for CiviCRM unit tests
ServiceListenerTestExample
AutoDefinitionTest: The 'AutoDefinition' uses Civi-style annotations to construct the `Definition` of a Symfony service. To test this, we need many different class/annotation combinations.
SettingsBagTest: Base class for CiviCRM unit tests
SettingsManagerTest: Base class for CiviCRM unit tests
SettingsStackTest: Base class for CiviCRM unit tests
SettingsStyleTest: Base class for CiviCRM unit tests
ThemesTest: Class CRM_Core_RegionTest
CryptoJwtTest: Test major use-cases of the 'crypto.token' service.
CryptoRegistryTest: Test major use-cases of the 'crypto.registry' service.
CryptoTokenTest: Test major use-cases of the 'crypto.token' service.
FkEntityDeleteSubscriberTest: Base class for CiviCRM unit tests
PropertyBagTest
JsonRpcSessionTest: Base class for CiviCRM unit tests
SampleOutputHandler: Helper class to simulate an OutputHandler that an extension might provide.
EntityTest: Base class for CiviCRM unit tests
MagicGetterSetterTest: Base class for CiviCRM unit tests
ExampleHookTest: This is an example of a barebones test which implements `HookInterface`. Methods are automatically scanned to find event-listeners based on a naming convention:
ExampleSubscriberTest: This is an example of a barebones test which implements `EventSubscriberInterface`. The method `getSubscribedEvents()` is used to get a list of listeners.
ExampleTransactionalTest: This is an example of a barebones test which uses a transaction (based on CiviTestListener).
InvasiveTest: Base class for CiviCRM unit tests
ImpliedContextSubscriberTest: Base class for CiviCRM unit tests
TokenProcessorTest: Base class for CiviCRM unit tests
ExampleWorkflowMessageTest: Test the WorkflowMessage class
FieldSpecTest: Base class for CiviCRM unit tests
AddressingTraitTest: Base class for CiviCRM unit tests
CiviCaseTestCase: Class CiviReportTestCase
CiviEndToEndTestCase: Class CiviEndToEndTestCase
CiviReportTestCase: Class CiviReportTestCase
CiviSimpleCacheTest
CiviTestSMSProvider: Test SMS provider to allow for testing
CRM_ACL_ListTest: Class CRM_ACL_Test
CRM_Activity_ActionMappingTest: Class CRM_Activity_ActionMappingTest
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_Page_AJAXTest: Base class for CiviCRM unit tests
CRM_Admin_Form_PaymentProcessorTest: Base class for CiviCRM unit tests
CRM_Admin_Form_Setting_LocalizationTest: Base class for CiviCRM unit tests
CRM_Campaign_Form_CampaignTest: Base class for CiviCRM unit tests
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_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_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_Form_IndividualTest: Class CRM_Contact_Form_IndividualTest
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_Page_AjaxTest: Base class for CiviCRM unit tests
CRM_Contribute_ActionMapping_ByTypeTest: Class CRM_Contribute_ActionMapping_ByTypeTest
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_CancelSubscriptionTest: Class CRM_Contribute_Form_UpdateSubscriptionTest
CRM_Contribute_Form_ContributionPage_SettingsTest: Base class for CiviCRM unit tests
CRM_Contribute_Form_ContributionPageTranslationTest: Test ContributionPage translation features.
CRM_Contribute_Form_ContributionViewTest: Base class for CiviCRM unit tests
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_Page_AjaxTest: Class CRM_Contribute_Page_AjaxTest
CRM_Contribute_Page_TabTest: Class CRM_Contribute_Page_AjaxTest
CRM_Contribute_PseudoConstantTest: CRM_Contribute_PseudoConstantTest
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_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_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_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_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_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_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_RegistrationTest: Base class for CiviCRM unit tests
CRM_Event_Form_Registration_RegisterTest: Class CRM_Event_Form_Registration_RegisterTest
CRM_Event_Form_SearchTest: 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_BrowserTest: Class CRM_Extension_BrowserTest
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_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_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_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_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_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_Selector_SearchTest: Class CRM_Member_BAO_MembershipTest
CRM_Member_StatusOverrideTypesTest: Class CRM_Member_BAO_MembershipTest
CRM_Member_TaskTest: Class CRM_Member_BAO_MembershipTest
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_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_SampleForm: Helper class to simulate a report form but allow us access to some protected fields for tests.
CRM_Report_Utils_ReportTest: Test CRM_Report_Utils_Report functions.
CRM_SMS_PreviewTest: Test SMS Preview
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_SqlGroupTest: Class CRM_Utils_Cache_SqlGroupTest
CRM_Utils_CacheTest: Class CRM_Utils_CacheTest
CRM_Utils_ColorTest: Class CRM_Utils_ColorTest
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_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_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?
UrlFacadeTest: Test generation of URLs via `Civi::url()` (`Civi\Core\Url`).
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
Api3Generator: AutoService is a base-class for defining a service (in Civi's service-container).
Api4Generator: AutoService is a base-class for defining a service (in Civi's service-container).
EntityGenerator: AutoService is a base-class for defining a service (in Civi's service-container).
EventGenerator: AutoService is a base-class for defining a service (in Civi's service-container).
PathGenerator: AutoService is a base-class for defining a service (in Civi's service-container).
PhpStormCompilePass: Generate metadata about dynamic CiviCRM services for use by PhpStorm.
PhpStormMetadata: Utility class for building new metadata files. For example:
SettingsGenerator: AutoService is a base-class for defining a service (in Civi's service-container).
StaticGenerator: Generate simple/static mappings.
UrlGenerator: AutoService is a base-class for defining a service (in Civi's service-container).
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

EntityLookupTrait
AddressSaveTrait: Code shared by Address create/update/save actions
ContactSaveTrait: Code shared by Contact create/update/save actions
CustomFieldSaveTrait: Code shared by CustomField create/update/save actions
GroupContactSaveTrait
GroupSubscriptionProcessor
LocBlockSaveTrait: Code shared by LocBlock create/update/save actions
ActiveUserTrait
DAOActionTrait: Common properties and helper-methods used for DB-oriented actions.
EntityBridge: A bridge is a small table that provides an intermediary link between two other tables.
GetSetValueTrait: Trait for actions with a `$values` array
HierarchicalEntity: A hierarchical entity has nested parent/child levels.
IsCurrentTrait
ManagedEntity: A managed entity includes extra fields and methods to revert from an overridden local to base state.
ReadOnlyEntity: Trait for Entities not intended to be publicly writable.
SoftDeleteActionTrait: This trait is used by delete actions with a "move to trash" option.
SortableEntity: A sortable entity has a 'weight' column which will be auto-updated by the API.
LinksProviderTrait
AutoServiceTrait: By combining AutoServiceInterface and AutoServiceTrait, you can make any class behave like an AutoService (auto-registered in the CiviCRM container).
IsActiveTrait
BasicLoaderTrait: The BasicLoaderTrait is a building-block for BrowserLoader and ShimLoader.
DataSourceTrait: Provides all the helpers to add a datasource easily.
LineSessionTrait: Synchronous line-oriented communication session.
ACLPermissionTrait: Trait Civi\Test\ACLPermissionTrait.
ContributionPageTestTrait: Helper for event tests.
EntityTrait: Helper for tracking entities created in tests.
EventTestTrait: Helper for event tests.
FormTrait: Trait for writing tests interacting with QuickForm.
GuzzleTestTrait: Class GuzzleTestTrait
LocaleTestTrait: Define helpers for testing multiple locales.
PageTrait: Trait for writing tests interacting with QuickForm Pages.
QueueTestTrait: Helper functions for testing queues.
WorkflowMessageTestTrait
AddressingTrait: Define the $to, $from, $replyTo, $cc, and $bcc fields to a WorkflowMessage class.
CustomFieldTrait: Adds a block of custom fields, as traditionally used in back office receipts.
FinalHelperTrait: Define a series of high-level, non-extensible helpers for WorkflowMessages, such as `renderTemplate()` or `sendTemplate()`.
LocalizationTrait
ReflectiveWorkflowTrait: The ReflectiveWorkflowTrait makes it easier to define workflow-messages using conventional PHP class-modeling. Thus:
TemplateTrait
CRM_Activity_Form_ActivityFormTrait: Trait implements functions to retrieve activity related values.
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_Form_ContactFormTrait: Trait implements getContactValue + overridable getContactID functions.
CRM_Contact_Import_MetadataTrait: Trait CRM_Contact_Import_MetadataTrait
CRM_Contribute_Form_ContributeFormTrait: Trait implements functions to retrieve contribution related values.
CRM_Contribute_WorkflowMessage_ContributionTrait
CRM_Contribute_WorkflowMessage_RecurringTrait
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_PaymentProcessorFormTrait: Trait implements functions to retrieve payment processor related values.
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_SQL_EscapeStringTrait
AfformEventEntityTrait
CiviCaseSaveTrait
ContributionSaveTrait: Code shared by Contribution create/update/save actions
MailingSaveTrait
ImportProcessTrait: Code shared by Import Save/Update actions.
ImportSaveTrait: Code shared by Import Save/Update actions.
IsActiveTrait: class \Civi\FlexMailer\Listener\IsActiveTrait
RolePermissionSaveTrait
WriteTrait
CheckAccessTrait: Define an implementation of `civi.api4.authorizeRecord` in which access-control decisions are based on a predefined list. For example:
CryptoTestTrait
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
ADDRESS_EXPORT_FMT = 'rfc822'
ADDRESS_STORAGE_FMT = 'rfc822'
AFFORM_HTML_MONACO = 'bower_components/monaco-editor/min/vs'
API_V3_EXTENSION_DELIMITER = ','
BACKDROP_ROOT = getcwd()
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 = '/'
DRUPAL_ROOT = getcwd()
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"

Functions

_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_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_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_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_permissions() : array<string|int, mixed>: Decide what permissions to check for an api call
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_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_simpleActivityContacts() : string: Get details for the target and assignee contact of an activity.
smarty_modifier_crmRSSPubDate() : string: Format the given date to RSS pubDate RFC822 format, http://www.w3.org/Protocols/rfc822/#z28
smarty_modifier_mb_truncate() : string: Smarty mb_truncate modifier plugin
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_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().
_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.
http_build_query() : string: Generates URL-encoded query string.
makeDAOs() : void
loadClass() : mixed
_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
_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_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

ADDRESS_EXPORT_FMT


    public
        mixed
    ADDRESS_EXPORT_FMT
    = 'rfc822'

ADDRESS_STORAGE_FMT


    public
        mixed
    ADDRESS_STORAGE_FMT
    = 'rfc822'

AFFORM_HTML_MONACO


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

API_V3_EXTENSION_DELIMITER


    public
        mixed
    API_V3_EXTENSION_DELIMITER
    = ','

BACKDROP_ROOT


    public
        mixed
    BACKDROP_ROOT
    = getcwd()

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
    = '/'

DRUPAL_ROOT


    public
        mixed
    DRUPAL_ROOT
    = getcwd()

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"

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

_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!`

http_build_query()

Generates URL-encoded query string.


    
                    http_build_query(object|array<string|int, mixed> $data[, string|null $numeric_prefix = '' ][, string|null $arg_separator = '&' ][, int $encoding_type = PHP_QUERY_RFC1738 ]) : string

This shim exists to make Guzzle 6 PHP 8.1 compatible.

Parameters

$data : object|array<string|int, mixed>: May be an array or object containing properties.
$numeric_prefix : string|null = '': (optional) If numeric indices are used in the base array and this parameter is provided, it will be prepended to the numeric index for elements in the base array only.
$arg_separator : string|null = '&': [optional]
(optional) arg_separator.output is used to separate arguments, unless this parameter is specified, and is then used.
$encoding_type : int = PHP_QUERY_RFC1738: (optional) By default, PHP_QUERY_RFC1738.

Return values

string —

A URL-encoded string.

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.

loadClass()


    
                    loadClass(string $class) : mixed

Parameters

$class : string

_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

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

Application

Table of Contents

Interfaces

Classes

Traits

Constants

Functions

Constants

_CIVICRM_FAKE_SESSION

ADDRESS_EXPORT_FMT

ADDRESS_STORAGE_FMT

AFFORM_HTML_MONACO

API_V3_EXTENSION_DELIMITER

BACKDROP_ROOT

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

DRUPAL_ROOT

RECAPTCHA_API_SECURE_SERVER

RECAPTCHA_API_SERVER

RECAPTCHA_VERIFY_SERVER

Functions

_civicrm_api3_cxn_register_spec()

Parameters

civicrm_api3_cxn_register()

Parameters

Tags

Return values

_civicrm_api3_cxn_unregister_spec()

Parameters

civicrm_api3_cxn_unregister()

Parameters

Return values

_civicrm_api3_cxn_parseCxnId()

Parameters

Tags

Return values

_civicrm_api3_cxn_get_spec()

Parameters

civicrm_api3_cxn_get()

Parameters

Return values

_civicrm_api3_cxn_getlink_spec()

Parameters

civicrm_api3_cxn_getlink()

Parameters

Tags

Return values

civicrm_api3_cxn_getcfg()

Parameters

Tags

Return values

civicrm_api3_cxn_create()

Parameters

Tags

Return values

_civicrm_api3_cxn_app_get_spec()

Parameters