3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
14 * @package CiviCRM_Hook
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 abstract class CRM_Utils_Hook
{
19 // Allowed values for dashboard hook content placement
20 // Default - place content below activity list
21 const DASHBOARD_BELOW
= 1;
22 // Place content above activity list
23 const DASHBOARD_ABOVE
= 2;
24 // Don't display activity list at all
25 const DASHBOARD_REPLACE
= 3;
27 // by default - place content below existing content
28 const SUMMARY_BELOW
= 1;
29 // place hook content above
30 const SUMMARY_ABOVE
= 2;
32 *create your own summaries
34 const SUMMARY_REPLACE
= 3;
37 * Object to pass when an object is required to be passed by params.
39 * This is supposed to be a convenience but note that it is a bad
40 * pattern as it can get contaminated & result in hard-to-diagnose bugs.
44 public static $_nullObject = NULL;
47 * We only need one instance of this object. So we use the singleton
48 * pattern and cache the instance in this variable
52 static private $_singleton = NULL;
57 private $commonIncluded = FALSE;
62 private $commonCiviModules = [];
65 * @var CRM_Utils_Cache_Interface
70 * Constructor and getter for the singleton instance.
74 * @return CRM_Utils_Hook
75 * An instance of $config->userHookClass
77 public static function singleton($fresh = FALSE) {
78 if (self
::$_singleton == NULL ||
$fresh) {
79 $config = CRM_Core_Config
::singleton();
80 $class = $config->userHookClass
;
81 self
::$_singleton = new $class();
83 return self
::$_singleton;
87 * CRM_Utils_Hook constructor.
89 * @throws \CRM_Core_Exception
91 public function __construct() {
92 $this->cache
= CRM_Utils_Cache
::create([
94 'type' => ['ArrayCache'],
100 * Invoke a hook through the UF/CMS hook system and the extension-hook
103 * @param int $numParams
104 * Number of parameters to pass to the hook.
106 * Parameter to be passed to the hook.
108 * Parameter to be passed to the hook.
110 * Parameter to be passed to the hook.
112 * Parameter to be passed to the hook.
114 * Parameter to be passed to the hook.
116 * Parameter to be passed to the hook.
117 * @param string $fnSuffix
118 * Function suffix, this is effectively the hook name.
122 abstract public function invokeViaUF(
124 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
131 * This is a transitional adapter. It supports the legacy syntax
132 * but also accepts enough information to support Symfony Event
135 * @param array|int $names
136 * (Recommended) Array of parameter names, in order.
137 * Using an array is recommended because it enables full
138 * event-broadcasting behaviors.
139 * (Legacy) Number of parameters to pass to the hook.
140 * This is provided for transitional purposes.
147 * @param mixed $fnSuffix
150 public function invoke(
152 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
155 // Per https://github.com/civicrm/civicrm-core/pull/13551 we have had ongoing significant problems where hooks from modules are
156 // invoked during upgrade but not those from extensions. The issues are both that an incorrect module list & settings are cached and that
157 // some hooks REALLY need to run during upgrade - the loss of triggers during upgrade causes significant loss of data
158 // whereas loss of logTable hooks means that log tables are created for tables specifically excluded - e.g due to large
159 // quantities of low-importance data or the table not having an id field, which could cause a fatal error.
160 // Instead of not calling any hooks we only call those we know to be frequently important - if a particular extension wanted
161 // to avoid this they could do an early return on CRM_Core_Config::singleton()->isUpgradeMode
162 $upgradeFriendlyHooks = ['civicrm_alterSettingsFolders', 'civicrm_alterSettingsMetaData', 'civicrm_triggerInfo', 'civicrm_alterLogTables', 'civicrm_container'];
163 if (CRM_Core_Config
::singleton()->isUpgradeMode() && !in_array($fnSuffix, $upgradeFriendlyHooks)) {
166 if (is_array($names) && !defined('CIVICRM_FORCE_LEGACY_HOOK') && \Civi\Core\Container
::isContainerBooted()) {
167 $event = \Civi\Core\Event\GenericHookEvent
::createOrdered(
169 array(&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6)
171 \Civi
::dispatcher()->dispatch('hook_' . $fnSuffix, $event);
172 return $event->getReturnValues();
175 // We need to ensure tht we will still run known bootstrap related hooks even if the container is not booted.
176 $prebootContainerHooks = array_merge($upgradeFriendlyHooks, ['civicrm_entityTypes', 'civicrm_config']);
177 if (!\Civi\Core\Container
::isContainerBooted() && !in_array($fnSuffix, $prebootContainerHooks)) {
180 $count = is_array($names) ?
count($names) : $names;
181 return $this->invokeViaUF($count, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6, $fnSuffix);
186 * @param array $numParams
198 public function commonInvoke(
200 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
204 $this->commonBuildModuleList($fnPrefix);
206 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
207 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
212 * Build the list of modules to be processed for hooks.
214 * @param string $fnPrefix
216 public function commonBuildModuleList($fnPrefix) {
217 if (!$this->commonIncluded
) {
218 // include external file
219 $this->commonIncluded
= TRUE;
221 $config = CRM_Core_Config
::singleton();
222 if (!empty($config->customPHPPathDir
)) {
223 $civicrmHooksFile = CRM_Utils_File
::addTrailingSlash($config->customPHPPathDir
) . 'civicrmHooks.php';
224 if (file_exists($civicrmHooksFile)) {
225 @include_once
$civicrmHooksFile;
229 if (!empty($fnPrefix)) {
230 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
233 $this->requireCiviModules($this->commonCiviModules
);
240 * @param array $civiModules
241 * @param string $fnSuffix
242 * @param int $numParams
253 public function runHooks(
254 $civiModules, $fnSuffix, $numParams,
255 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
257 // $civiModules is *not* passed by reference because runHooks
258 // must be reentrant. PHP is finicky about running
259 // multiple loops over the same variable. The circumstances
260 // to reproduce the issue are pretty intricate.
263 $fnNames = $this->cache
->get($fnSuffix);
264 if (!is_array($fnNames)) {
266 if ($civiModules !== NULL) {
267 foreach ($civiModules as $module) {
268 $fnName = "{$module}_{$fnSuffix}";
269 if (function_exists($fnName)) {
270 $fnNames[] = $fnName;
273 $this->cache
->set($fnSuffix, $fnNames);
277 foreach ($fnNames as $fnName) {
279 switch ($numParams) {
281 $fResult = $fnName();
285 $fResult = $fnName($arg1);
289 $fResult = $fnName($arg1, $arg2);
293 $fResult = $fnName($arg1, $arg2, $arg3);
297 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
301 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
305 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
309 CRM_Core_Error
::fatal(ts('Invalid hook invocation'));
313 if (!empty($fResult) &&
316 $result = array_merge($result, $fResult);
320 return empty($result) ?
TRUE : $result;
326 public function requireCiviModules(&$moduleList) {
327 $civiModules = CRM_Core_PseudoConstant
::getModuleExtensions();
328 foreach ($civiModules as $civiModule) {
329 if (!file_exists($civiModule['filePath'])) {
330 CRM_Core_Session
::setStatus(
331 ts('Error loading module file (%1). Please restore the file or disable the module.',
332 [1 => $civiModule['filePath']]),
333 ts('Warning'), 'error');
336 include_once $civiModule['filePath'];
337 $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
342 * This hook is called before a db write on some core objects.
343 * This hook does not allow the abort of the operation
346 * The type of operation being performed.
347 * @param string $objectName
348 * The name of the object.
350 * The object id if available.
351 * @param array $params
352 * The parameters used for object creation / editing.
355 * the return value is ignored
357 public static function pre($op, $objectName, $id, &$params) {
358 $event = new \Civi\Core\Event\
PreEvent($op, $objectName, $id, $params);
359 \Civi
::dispatcher()->dispatch('hook_civicrm_pre', $event);
360 return $event->getReturnValues();
364 * This hook is called after a db write on some core objects.
367 * The type of operation being performed.
368 * @param string $objectName
369 * The name of the object.
370 * @param int $objectId
371 * The unique identifier for the object.
372 * @param object $objectRef
373 * The reference to the object if available.
376 * based on op. pre-hooks return a boolean or
377 * an error message which aborts the operation
379 public static function post($op, $objectName, $objectId, &$objectRef = NULL) {
380 $event = new \Civi\Core\Event\
PostEvent($op, $objectName, $objectId, $objectRef);
381 \Civi
::dispatcher()->dispatch('hook_civicrm_post', $event);
382 return $event->getReturnValues();
386 * This hook retrieves links from other modules and injects it into.
387 * the view contact tabs
390 * The type of operation being performed.
391 * @param string $objectName
392 * The name of the object.
393 * @param int $objectId
394 * The unique identifier for the object.
395 * @param array $links
396 * (optional) the links array (introduced in v3.2).
398 * (optional) the bitmask to show/hide links.
399 * @param array $values
400 * (optional) the values to fill the links.
403 * the return value is ignored
405 public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = []) {
406 return self
::singleton()->invoke(['op', 'objectName', 'objectId', 'links', 'mask', 'values'], $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
410 * This hook is invoked during the CiviCRM form preProcess phase.
412 * @param string $formName
413 * The name of the form.
414 * @param CRM_Core_Form $form
415 * Reference to the form object.
418 * the return value is ignored
420 public static function preProcess($formName, &$form) {
421 return self
::singleton()
422 ->invoke(['formName', 'form'], $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_preProcess');
426 * This hook is invoked when building a CiviCRM form. This hook should also
427 * be used to set the default values of a form element
429 * @param string $formName
430 * The name of the form.
431 * @param CRM_Core_Form $form
432 * Reference to the form object.
435 * the return value is ignored
437 public static function buildForm($formName, &$form) {
438 return self
::singleton()->invoke(['formName', 'form'], $formName, $form,
439 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
445 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
446 * any form elements, this hook should save the values in the database
448 * @param string $formName
449 * The name of the form.
450 * @param CRM_Core_Form $form
451 * Reference to the form object.
454 * the return value is ignored
456 public static function postProcess($formName, &$form) {
457 return self
::singleton()->invoke(['formName', 'form'], $formName, $form,
458 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
459 'civicrm_postProcess'
464 * This hook is invoked during all CiviCRM form validation. An array of errors
465 * detected is returned. Else we assume validation succeeded.
467 * @param string $formName
468 * The name of the form.
469 * @param array &$fields the POST parameters as filtered by QF
470 * @param array &$files the FILES parameters as sent in by POST
471 * @param array &$form the form object
472 * @param array &$errors the array of errors.
475 * formRule hooks return a boolean or
476 * an array of error messages which display a QF Error
478 public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
479 return self
::singleton()
480 ->invoke(['formName', 'fields', 'files', 'form', 'errors'],
481 $formName, $fields, $files, $form, $errors, self
::$_nullObject, 'civicrm_validateForm');
485 * This hook is called after a db write on a custom table.
488 * The type of operation being performed.
489 * @param string $groupID
490 * The custom group ID.
491 * @param object $entityID
492 * The entityID of the row in the custom table.
493 * @param array $params
494 * The parameters that were sent into the calling function.
497 * the return value is ignored
499 public static function custom($op, $groupID, $entityID, &$params) {
500 return self
::singleton()
501 ->invoke(['op', 'groupID', 'entityID', 'params'], $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_custom');
505 * This hook is called when composing the ACL where clause to restrict
506 * visibility of contacts to the logged in user
509 * The type of permission needed.
510 * @param array $tables
511 * (reference ) add the tables that are needed for the select clause.
512 * @param array $whereTables
513 * (reference ) add the tables that are needed for the where clause.
514 * @param int $contactID
515 * The contactID for whom the check is made.
516 * @param string $where
517 * The currrent where clause.
520 * the return value is ignored
522 public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
523 return self
::singleton()
524 ->invoke(['type', 'tables', 'whereTables', 'contactID', 'where'], $type, $tables, $whereTables, $contactID, $where, self
::$_nullObject, 'civicrm_aclWhereClause');
528 * This hook is called when composing the ACL where clause to restrict
529 * visibility of contacts to the logged in user
532 * The type of permission needed.
533 * @param int $contactID
534 * The contactID for whom the check is made.
535 * @param string $tableName
536 * The tableName which is being permissioned.
537 * @param array $allGroups
538 * The set of all the objects for the above table.
539 * @param array $currentGroups
540 * The set of objects that are currently permissioned for this contact.
543 * the return value is ignored
545 public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
546 return self
::singleton()
547 ->invoke(['type', 'contactID', 'tableName', 'allGroups', 'currentGroups'], $type, $contactID, $tableName, $allGroups, $currentGroups, self
::$_nullObject, 'civicrm_aclGroup');
551 * @param string|CRM_Core_DAO $entity
552 * @param array $clauses
555 public static function selectWhereClause($entity, &$clauses) {
556 $entityName = is_object($entity) ?
_civicrm_api_get_entity_name_from_dao($entity) : $entity;
557 return self
::singleton()->invoke(['entity', 'clauses'], $entityName, $clauses,
558 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
559 'civicrm_selectWhereClause'
564 * This hook is called when building the menu table.
566 * @param array $files
567 * The current set of files to process.
570 * the return value is ignored
572 public static function xmlMenu(&$files) {
573 return self
::singleton()->invoke(['files'], $files,
574 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
580 * (Experimental) This hook is called when build the menu table.
582 * @param array $items
583 * List of records to include in menu table.
585 * the return value is ignored
587 public static function alterMenu(&$items) {
588 return self
::singleton()->invoke(['items'], $items,
589 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
595 * A theme is a set of CSS files which are loaded on CiviCRM pages. To register a new
596 * theme, add it to the $themes array. Use these properties:
598 * - ext: string (required)
599 * The full name of the extension which defines the theme.
600 * Ex: "org.civicrm.themes.greenwich".
601 * - title: string (required)
603 * - help: string (optional)
604 * Description of the theme's appearance.
605 * - url_callback: mixed (optional)
606 * A function ($themes, $themeKey, $cssExt, $cssFile) which returns the URL(s) for a CSS resource.
607 * Returns either an array of URLs or PASSTHRU.
608 * Ex: \Civi\Core\Themes\Resolvers::simple (default)
609 * Ex: \Civi\Core\Themes\Resolvers::none
610 * - prefix: string (optional)
611 * A prefix within the extension folder to prepend to the file name.
612 * - search_order: array (optional)
613 * A list of themes to search.
614 * Generally, the last theme should be "*fallback*" (Civi\Core\Themes::FALLBACK).
615 * - excludes: array (optional)
616 * A list of files (eg "civicrm:css/bootstrap.css" or "$ext:$file") which should never
617 * be returned (they are excluded from display).
619 * @param array $themes
620 * List of themes, keyed by name.
622 * the return value is ignored
624 public static function themes(&$themes) {
625 return self
::singleton()->invoke(1, $themes,
626 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
632 * The activeTheme hook determines which theme is active.
634 * @param string $theme
635 * The identifier for the theme. Alterable.
637 * @param array $context
638 * Information about the current page-request. Includes some mix of:
639 * - page: the relative path of the current Civi page (Ex: 'civicrm/dashboard').
640 * - themes: an instance of the Civi\Core\Themes service.
642 * the return value is ignored
644 public static function activeTheme(&$theme, $context) {
645 return self
::singleton()->invoke(array('theme', 'context'), $theme, $context,
646 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
647 'civicrm_activeTheme'
652 * This hook is called for declaring managed entities via API.
654 * @param array $entities
655 * List of pending entities. Each entity is an array with keys:
656 * + 'module': string; for module-extensions, this is the fully-qualifed name (e.g. "com.example.mymodule"); for CMS modules, the name is prefixed by the CMS (e.g. "drupal.mymodule")
657 * + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
658 * + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
659 * + 'params': array, the entity data as supported by the CiviCRM API
660 * + 'update' (v4.5+): string, a policy which describes when to update records
661 * - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
662 * - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
663 * + 'cleanup' (v4.5+): string, a policy which describes whether to cleanup the record when it becomes orphaned (ie when $entities no longer references the record)
664 * - 'always' (default): always delete orphaned records
665 * - 'never': never delete orphaned records
666 * - 'unused': only delete orphaned records if there are no other references to it in the DB. (This is determined by calling the API's "getrefcount" action.)
669 * the return value is ignored
671 public static function managed(&$entities) {
672 return self
::singleton()->invoke(['entities'], $entities,
673 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
679 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
681 * @param int $contactID
682 * The contactID for whom the dashboard is being rendered.
683 * @param int $contentPlacement
684 * (output parameter) where should the hook content be displayed.
685 * relative to the activity list
688 * the html snippet to include in the dashboard
690 public static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
691 $retval = self
::singleton()->invoke(['contactID', 'contentPlacement'], $contactID, $contentPlacement,
692 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
697 * Note we need this seemingly unnecessary code because in the event that the implementation
698 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
699 * though we have a default value in this function's declaration above.
701 if (!isset($contentPlacement)) {
702 $contentPlacement = self
::DASHBOARD_BELOW
;
709 * This hook is called before storing recently viewed items.
711 * @param array $recentArray
712 * An array of recently viewed or processed items, for in place modification.
716 public static function recent(&$recentArray) {
717 return self
::singleton()->invoke(['recentArray'], $recentArray,
718 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
724 * Determine how many other records refer to a given record.
726 * @param CRM_Core_DAO $dao
727 * The item for which we want a reference count.
728 * @param array $refCounts
729 * Each item in the array is an Array with keys:
730 * - name: string, eg "sql:civicrm_email:contact_id"
731 * - type: string, eg "sql"
732 * - count: int, eg "5" if there are 5 email addresses that refer to $dao
735 * Return is not really intended to be used.
737 public static function referenceCounts($dao, &$refCounts) {
738 return self
::singleton()->invoke(['dao', 'refCounts'], $dao, $refCounts,
739 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
740 'civicrm_referenceCounts'
745 * This hook is called when building the amount structure for a Contribution or Event Page.
747 * @param int $pageType
748 * Is this a contribution or event page.
749 * @param CRM_Core_Form $form
750 * Reference to the form object.
751 * @param array $amount
752 * The amount structure to be displayed.
756 public static function buildAmount($pageType, &$form, &$amount) {
757 return self
::singleton()->invoke(['pageType', 'form', 'amount'], $pageType, $form, $amount, self
::$_nullObject,
758 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildAmount');
762 * This hook is called when building the state list for a particular country.
764 * @param array $countryID
765 * The country id whose states are being selected.
770 public static function buildStateProvinceForCountry($countryID, &$states) {
771 return self
::singleton()->invoke(['countryID', 'states'], $countryID, $states,
772 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
773 'civicrm_buildStateProvinceForCountry'
778 * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
781 * The array of tabs that will be displayed.
782 * @param int $contactID
783 * The contactID for whom the dashboard is being rendered.
786 * @deprecated Use tabset() instead.
788 public static function tabs(&$tabs, $contactID) {
789 return self
::singleton()->invoke(['tabs', 'contactID'], $tabs, $contactID,
790 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabs'
795 * This hook is called when rendering the tabs used for events and potentially
796 * contribution pages, etc.
798 * @param string $tabsetName
799 * Name of the screen or visual element.
801 * Tabs that will be displayed.
802 * @param array $context
803 * Extra data about the screen or context in which the tab is used.
807 public static function tabset($tabsetName, &$tabs, $context) {
808 return self
::singleton()->invoke(['tabsetName', 'tabs', 'context'], $tabsetName, $tabs,
809 $context, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
814 * This hook is called when sending an email / printing labels
816 * @param array $tokens
817 * The list of tokens that can be used for the contact.
821 public static function tokens(&$tokens) {
822 return self
::singleton()->invoke(['tokens'], $tokens,
823 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
828 * This hook allows modification of the admin panels
830 * @param array $panels
831 * Associated array of admin panels
835 public static function alterAdminPanel(&$panels) {
836 return self
::singleton()->invoke(array('panels'), $panels,
837 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
838 'civicrm_alterAdminPanel'
843 * This hook is called when sending an email / printing labels to get the values for all the
844 * tokens returned by the 'tokens' hook
846 * @param array $details
847 * The array to store the token values indexed by contactIDs (unless it a single).
848 * @param array $contactIDs
849 * An array of contactIDs.
851 * The jobID if this is associated with a CiviMail mailing.
852 * @param array $tokens
853 * The list of tokens associated with the content.
854 * @param string $className
855 * The top level className from where the hook is invoked.
859 public static function tokenValues(
866 return self
::singleton()
867 ->invoke(['details', 'contactIDs', 'jobID', 'tokens', 'className'], $details, $contactIDs, $jobID, $tokens, $className, self
::$_nullObject, 'civicrm_tokenValues');
871 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
874 * @param object $page
875 * The page that will be rendered.
879 public static function pageRun(&$page) {
880 return self
::singleton()->invoke(['page'], $page,
881 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
887 * This hook is called after a copy of an object has been made. The current objects are
888 * Event, Contribution Page and UFGroup
890 * @param string $objectName
891 * Name of the object.
892 * @param object $object
893 * Reference to the copy.
897 public static function copy($objectName, &$object) {
898 return self
::singleton()->invoke(['objectName', 'object'], $objectName, $object,
899 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
905 * This hook is called when a contact unsubscribes from a mailing. It allows modules
906 * to override what the contacts are removed from.
910 * @param int $mailingId
911 * The id of the mailing to unsub from
912 * @param int $contactId
913 * The id of the contact who is unsubscribing
914 * @param array|int $groups
915 * Groups the contact will be removed from.
916 * @param array|int $baseGroups
917 * Base groups (used in smart mailings) the contact will be removed from.
922 public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
923 return self
::singleton()
924 ->invoke(['op', 'mailingId', 'contactId', 'groups', 'baseGroups'], $op, $mailingId, $contactId, $groups, $baseGroups, self
::$_nullObject, 'civicrm_unsubscribeGroups');
928 * This hook is called when CiviCRM needs to edit/display a custom field with options
930 * @deprecated in favor of hook_civicrm_fieldOptions
932 * @param int $customFieldID
933 * The custom field ID.
934 * @param array $options
935 * The current set of options for that custom field.
936 * You can add/remove existing options.
937 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
938 * to be careful to not overwrite the array.
939 * Only add/edit/remove the specific field options you intend to affect.
940 * @param bool $detailedFormat
941 * If true, the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
942 * @param array $selectAttributes
943 * Contain select attribute(s) if any.
947 public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = []) {
948 // Weird: $selectAttributes is inputted but not outputted.
949 return self
::singleton()->invoke(['customFieldID', 'options', 'detailedFormat'], $customFieldID, $options, $detailedFormat,
950 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
951 'civicrm_customFieldOptions'
956 * Hook for modifying field options
958 * @param string $entity
959 * @param string $field
960 * @param array $options
961 * @param array $params
965 public static function fieldOptions($entity, $field, &$options, $params) {
966 return self
::singleton()->invoke(['entity', 'field', 'options', 'params'], $entity, $field, $options, $params,
967 self
::$_nullObject, self
::$_nullObject,
968 'civicrm_fieldOptions'
974 * This hook is called to display the list of actions allowed after doing a search.
975 * This allows the module developer to inject additional actions or to remove existing actions.
977 * @param string $objectType
978 * The object type for this search.
979 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
980 * @param array $tasks
981 * The current set of tasks for that custom field.
982 * You can add/remove existing tasks.
983 * Each task needs to have a title (eg 'title' => ts( 'Group - add contacts')) and a class
984 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
985 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
986 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
987 * found in CRM/$objectType/Task.php.
991 public static function searchTasks($objectType, &$tasks) {
992 return self
::singleton()->invoke(['objectType', 'tasks'], $objectType, $tasks,
993 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
994 'civicrm_searchTasks'
1000 * @param array $params
1004 public static function eventDiscount(&$form, &$params) {
1005 return self
::singleton()->invoke(['form', 'params'], $form, $params,
1006 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1007 'civicrm_eventDiscount'
1012 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
1014 * @param mixed $form
1015 * The form object for which groups / mailings being displayed
1016 * @param array $groups
1017 * The list of groups being included / excluded
1018 * @param array $mailings
1019 * The list of mailings being included / excluded
1023 public static function mailingGroups(&$form, &$groups, &$mailings) {
1024 return self
::singleton()->invoke(['form', 'groups', 'mailings'], $form, $groups, $mailings,
1025 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1026 'civicrm_mailingGroups'
1031 * (Experimental) Modify the list of template-types used for CiviMail composition.
1033 * @param array $types
1034 * Sequentially indexed list of template types. Each type specifies:
1036 * - editorUrl: string, Angular template URL
1037 * - weight: int, priority when picking a default value for new mailings
1040 public static function mailingTemplateTypes(&$types) {
1041 return self
::singleton()->invoke(['types'], $types, self
::$_nullObject, self
::$_nullObject,
1042 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1043 'civicrm_mailingTemplateTypes'
1048 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
1050 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
1051 * You can use it to alter the membership types when first loaded, or after submission
1052 * (for example if you want to gather data in the form and use it to alter the fees).
1054 * @param mixed $form
1055 * The form object that is presenting the page
1056 * @param array $membershipTypes
1057 * The array of membership types and their amount
1061 public static function membershipTypeValues(&$form, &$membershipTypes) {
1062 return self
::singleton()->invoke(['form', 'membershipTypes'], $form, $membershipTypes,
1063 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1064 'civicrm_membershipTypeValues'
1069 * This hook is called when rendering the contact summary.
1071 * @param int $contactID
1072 * The contactID for whom the summary is being rendered
1073 * @param mixed $content
1074 * @param int $contentPlacement
1075 * Specifies where the hook content should be displayed relative to the
1079 * The html snippet to include in the contact summary
1081 public static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
1082 return self
::singleton()->invoke(['contactID', 'content', 'contentPlacement'], $contactID, $content, $contentPlacement,
1083 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1089 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
1090 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
1091 * If you want to limit the contacts returned to a specific group, or some other criteria
1092 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
1093 * The hook is called when the query is executed to get the list of contacts to display.
1095 * @param mixed $query
1096 * - the query that will be executed (input and output parameter);.
1097 * It's important to realize that the ACL clause is built prior to this hook being fired,
1098 * so your query will ignore any ACL rules that may be defined.
1099 * Your query must return two columns:
1100 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
1102 * @param string $queryText
1103 * The name string to execute the query against (this is the value being typed in by the user).
1104 * @param string $context
1105 * The context in which this ajax call is being made (for example: 'customfield', 'caseview').
1107 * The id of the object for which the call is being made.
1108 * For custom fields, it will be the custom field id
1112 public static function contactListQuery(&$query, $queryText, $context, $id) {
1113 return self
::singleton()->invoke(['query', 'queryText', 'context', 'id'], $query, $queryText, $context, $id,
1114 self
::$_nullObject, self
::$_nullObject,
1115 'civicrm_contactListQuery'
1120 * Hook definition for altering payment parameters before talking to a payment processor back end.
1122 * Definition will look like this:
1124 * function hook_civicrm_alterPaymentProcessorParams(
1130 * @param CRM_Core_Payment $paymentObj
1131 * Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
1132 * See discussion in CRM-16224 as to whether $paymentObj should be passed by reference.
1133 * @param array &$rawParams
1134 * array of params as passed to to the processor
1135 * @param array &$cookedParams
1136 * params after the processor code has translated them into its own key/value pairs
1139 * This return is not really intended to be used.
1141 public static function alterPaymentProcessorParams(
1146 return self
::singleton()->invoke(['paymentObj', 'rawParams', 'cookedParams'], $paymentObj, $rawParams, $cookedParams,
1147 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1148 'civicrm_alterPaymentProcessorParams'
1153 * This hook is called when an email is about to be sent by CiviCRM.
1155 * @param array $params
1156 * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
1157 * returnPath, replyTo, headers, attachments (array)
1158 * @param string $context
1159 * The context in which the hook is being invoked, eg 'civimail'.
1163 public static function alterMailParams(&$params, $context = NULL) {
1164 return self
::singleton()->invoke(['params', 'context'], $params, $context,
1165 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1166 'civicrm_alterMailParams'
1171 * This hook is called when membership status is being calculated.
1173 * @param array $membershipStatus
1174 * Membership status details as determined - alter if required.
1175 * @param array $arguments
1176 * Arguments passed in to calculate date.
1181 * - 'exclude_is_admin'
1182 * - 'membership_type_id'
1183 * @param array $membership
1184 * Membership details from the calling function.
1188 public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
1189 return self
::singleton()->invoke(['membershipStatus', 'arguments', 'membership'], $membershipStatus, $arguments,
1190 $membership, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1191 'civicrm_alterCalculatedMembershipStatus'
1196 * This hook is called after getting the content of the mail and before tokenizing it.
1198 * @param array $content
1199 * Array fields include: html, text, subject
1203 public static function alterMailContent(&$content) {
1204 return self
::singleton()->invoke(['content'], $content,
1205 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1206 'civicrm_alterMailContent'
1211 * This hook is called when rendering the Manage Case screen.
1213 * @param int $caseID
1217 * Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
1218 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
1220 public static function caseSummary($caseID) {
1221 return self
::singleton()->invoke(['caseID'], $caseID,
1222 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1223 'civicrm_caseSummary'
1228 * This hook is called when locating CiviCase types.
1230 * @param array $caseTypes
1234 public static function caseTypes(&$caseTypes) {
1235 return self
::singleton()
1236 ->invoke(['caseTypes'], $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
1240 * This hook is called soon after the CRM_Core_Config object has ben initialized.
1241 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
1243 * @param CRM_Core_Config|array $config
1248 public static function config(&$config) {
1249 return self
::singleton()->invoke(['config'], $config,
1250 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1256 * This hooks allows to change option values.
1258 * @deprecated in favor of hook_civicrm_fieldOptions
1260 * @param array $options
1261 * Associated array of option values / id
1262 * @param string $groupName
1267 public static function optionValues(&$options, $groupName) {
1268 return self
::singleton()->invoke(['options', 'groupName'], $options, $groupName,
1269 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1270 'civicrm_optionValues'
1275 * This hook allows modification of the navigation menu.
1277 * @param array $params
1278 * Associated array of navigation menu entry to Modify/Add
1282 public static function navigationMenu(&$params) {
1283 return self
::singleton()->invoke(['params'], $params,
1284 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1285 'civicrm_navigationMenu'
1290 * This hook allows modification of the data used to perform merging of duplicates.
1292 * @param string $type
1293 * The type of data being passed (cidRefs|eidRefs|relTables|sqls).
1294 * @param array $data
1295 * The data, as described in $type.
1296 * @param int $mainId
1297 * Contact_id of the contact that survives the merge.
1298 * @param int $otherId
1299 * Contact_id of the contact that will be absorbed and deleted.
1300 * @param array $tables
1301 * When $type is "sqls", an array of tables as it may have been handed to the calling function.
1305 public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
1306 return self
::singleton()->invoke(['type', 'data', 'mainId', 'otherId', 'tables'], $type, $data, $mainId, $otherId, $tables, self
::$_nullObject, 'civicrm_merge');
1310 * This hook allows modification of the data calculated for merging locations.
1312 * @param array $blocksDAO
1313 * Array of location DAO to be saved. These are arrays in 2 keys 'update' & 'delete'.
1314 * @param int $mainId
1315 * Contact_id of the contact that survives the merge.
1316 * @param int $otherId
1317 * Contact_id of the contact that will be absorbed and deleted.
1318 * @param array $migrationInfo
1319 * Calculated migration info, informational only.
1323 public static function alterLocationMergeData(&$blocksDAO, $mainId, $otherId, $migrationInfo) {
1324 return self
::singleton()->invoke(['blocksDAO', 'mainId', 'otherId', 'migrationInfo'], $blocksDAO, $mainId, $otherId, $migrationInfo, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterLocationMergeData');
1328 * This hook provides a way to override the default privacy behavior for notes.
1330 * @param array &$noteValues
1331 * Associative array of values for this note
1335 public static function notePrivacy(&$noteValues) {
1336 return self
::singleton()->invoke(['noteValues'], $noteValues,
1337 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1338 'civicrm_notePrivacy'
1343 * This hook is called before record is exported as CSV.
1345 * @param string $exportTempTable
1346 * Name of the temporary export table used during export.
1347 * @param array $headerRows
1348 * Header rows for output.
1349 * @param array $sqlColumns
1351 * @param int $exportMode
1352 * Export mode ( contact, contribution, etc...).
1353 * @param string $componentTable
1354 * Name of temporary table
1356 * Array of object's ids
1360 public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, $exportMode, $componentTable, $ids) {
1361 return self
::singleton()->invoke(['exportTempTable', 'headerRows', 'sqlColumns', 'exportMode', 'componentTable', 'ids'],
1362 $exportTempTable, $headerRows, $sqlColumns,
1363 $exportMode, $componentTable, $ids,
1369 * This hook allows modification of the queries constructed from dupe rules.
1371 * @param string $obj
1372 * Object of rulegroup class.
1373 * @param string $type
1374 * Type of queries e.g table / threshold.
1375 * @param array $query
1380 public static function dupeQuery($obj, $type, &$query) {
1381 return self
::singleton()->invoke(['obj', 'type', 'query'], $obj, $type, $query,
1382 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1388 * Check for duplicate contacts
1390 * @param array $dedupeParams
1391 * Array of params for finding duplicates: [
1392 * '{parameters returned by CRM_Dedupe_Finder::formatParams}
1393 * 'check_permission' => TRUE/FALSE;
1394 * 'contact_type' => $contactType;
1396 * 'rule_group_id' => $ruleGroupID;
1397 * 'excludedContactIDs' => $excludedContactIDs;
1398 * @param array $dedupeResults
1399 * Array of results ['handled' => TRUE/FALSE, 'ids' => array of IDs of duplicate contacts]
1400 * @param array $contextParams
1401 * The context if relevant, eg. ['event_id' => X]
1405 public static function findDuplicates($dedupeParams, &$dedupeResults, $contextParams) {
1406 return self
::singleton()
1407 ->invoke(['dedupeParams', 'dedupeResults', 'contextParams'], $dedupeParams, $dedupeResults, $contextParams, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_findDuplicates');
1411 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1413 * @param string $type
1414 * Type of mail processed: 'activity' OR 'mailing'.
1415 * @param array &$params the params that were sent to the CiviCRM API function
1416 * @param object $mail
1417 * The mail object which is an ezcMail class.
1418 * @param array &$result the result returned by the api call
1419 * @param string $action
1420 * (optional ) the requested action to be performed if the types was 'mailing'.
1424 public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1425 return self
::singleton()
1426 ->invoke(['type', 'params', 'mail', 'result', 'action'], $type, $params, $mail, $result, $action, self
::$_nullObject, 'civicrm_emailProcessor');
1430 * This hook is called after a row has been processed and the
1431 * record (and associated records imported
1433 * @param string $object
1434 * Object being imported (for now Contact only, later Contribution, Activity,.
1435 * Participant and Member)
1436 * @param string $usage
1437 * Hook usage/location (for now process only, later mapping and others).
1438 * @param string $objectRef
1439 * Import record object.
1440 * @param array $params
1441 * Array with various key values: currently.
1442 * contactID - contact id
1443 * importID - row id in temp table
1444 * importTempTable - name of tempTable
1445 * fieldHeaders - field headers
1446 * fields - import fields
1450 public static function import($object, $usage, &$objectRef, &$params) {
1451 return self
::singleton()->invoke(['object', 'usage', 'objectRef', 'params'], $object, $usage, $objectRef, $params,
1452 self
::$_nullObject, self
::$_nullObject,
1458 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1459 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1461 * @param string $entity
1462 * The API entity (like contact).
1463 * @param string $action
1464 * The API action (like get).
1465 * @param array &$params the API parameters
1466 * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1470 public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1471 return self
::singleton()->invoke(['entity', 'action', 'params', 'permissions'], $entity, $action, $params, $permissions,
1472 self
::$_nullObject, self
::$_nullObject,
1473 'civicrm_alterAPIPermissions'
1478 * @param CRM_Core_DAO $dao
1482 public static function postSave(&$dao) {
1483 $hookName = 'civicrm_postSave_' . $dao->getTableName();
1484 return self
::singleton()->invoke(['dao'], $dao,
1485 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1491 * This hook allows user to customize context menu Actions on contact summary page.
1493 * @param array $actions
1494 * Array of all Actions in contextmenu.
1495 * @param int $contactID
1496 * ContactID for the summary page.
1500 public static function summaryActions(&$actions, $contactID = NULL) {
1501 return self
::singleton()->invoke(['actions', 'contactID'], $actions, $contactID,
1502 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1503 'civicrm_summaryActions'
1508 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1509 * This enables us hook implementors to modify both the headers and the rows
1511 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1512 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1514 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1515 * you want displayed. This is a hackish, but avoids template modification.
1517 * @param string $objectName
1518 * The component name that we are doing the search.
1519 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1520 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1521 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1522 * @param array $selector
1523 * the selector object. Allows you access to the context of the search
1526 * modify the header and values object to pass the data you need
1528 public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1529 return self
::singleton()->invoke(['objectName', 'headers', 'rows', 'selector'], $objectName, $headers, $rows, $selector,
1530 self
::$_nullObject, self
::$_nullObject,
1531 'civicrm_searchColumns'
1536 * This hook is called when uf groups are being built for a module.
1538 * @param string $moduleName
1540 * @param array $ufGroups
1541 * Array of ufgroups for a module.
1545 public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1546 return self
::singleton()->invoke(['moduleName', 'ufGroups'], $moduleName, $ufGroups,
1547 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1548 'civicrm_buildUFGroupsForModule'
1553 * This hook is called when we are determining the contactID for a specific
1556 * @param string $email
1557 * The email address.
1558 * @param int $contactID
1559 * The contactID that matches this email address, IF it exists.
1560 * @param array $result
1561 * (reference) has two fields.
1562 * contactID - the new (or same) contactID
1563 * action - 3 possible values:
1564 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1565 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1566 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1570 public static function emailProcessorContact($email, $contactID, &$result) {
1571 return self
::singleton()->invoke(['email', 'contactID', 'result'], $email, $contactID, $result,
1572 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1573 'civicrm_emailProcessorContact'
1578 * Hook definition for altering the generation of Mailing Labels.
1580 * @param array $args
1581 * An array of the args in the order defined for the tcpdf multiCell api call.
1582 * with the variable names below converted into string keys (ie $w become 'w'
1583 * as the first key for $args)
1584 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1585 * float $h Cell minimum height. The cell extends automatically if needed.
1586 * string $txt String to print
1587 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1588 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1589 * a string containing some or all of the following characters (in any order):
1590 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1591 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1592 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1593 * (default value when $ishtml=false)</li></ul>
1594 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1595 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1596 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1597 * float $x x position in user units
1598 * float $y y position in user units
1599 * boolean $reseth if true reset the last cell height (default true).
1600 * int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1601 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1602 * necessary</li><li>4 = forced character spacing</li></ul>
1603 * boolean $ishtml set to true if $txt is HTML content (default = false).
1604 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1605 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1606 * or 0 for disable this feature. This feature works only when $ishtml=false.
1610 public static function alterMailingLabelParams(&$args) {
1611 return self
::singleton()->invoke(['args'], $args,
1612 self
::$_nullObject, self
::$_nullObject,
1613 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1614 'civicrm_alterMailingLabelParams'
1619 * This hooks allows alteration of generated page content.
1622 * Previously generated content.
1624 * Context of content - page or form.
1626 * The file name of the tpl.
1628 * A reference to the page or form object.
1632 public static function alterContent(&$content, $context, $tplName, &$object) {
1633 return self
::singleton()->invoke(['content', 'context', 'tplName', 'object'], $content, $context, $tplName, $object,
1634 self
::$_nullObject, self
::$_nullObject,
1635 'civicrm_alterContent'
1640 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1641 * altercontent hook as the content has already been rendered through the tpl at that point
1644 * Previously generated content.
1646 * Reference to the form object.
1648 * Context of content - page or form.
1650 * Reference the file name of the tpl.
1654 public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1655 return self
::singleton()->invoke(['formName', 'form', 'context', 'tplName'], $formName, $form, $context, $tplName,
1656 self
::$_nullObject, self
::$_nullObject,
1657 'civicrm_alterTemplateFile'
1662 * This hook collects the trigger definition from all components.
1665 * @param string $tableName
1666 * (optional) the name of the table that we are interested in only.
1668 * @internal param \reference $triggerInfo to an array of trigger information
1669 * each element has 4 fields:
1670 * table - array of tableName
1671 * when - BEFORE or AFTER
1672 * event - array of eventName - INSERT OR UPDATE OR DELETE
1673 * sql - array of statements optionally terminated with a ;
1674 * a statement can use the tokes {tableName} and {eventName}
1675 * to do token replacement with the table / event. This allows
1676 * templatizing logging and other hooks
1679 public static function triggerInfo(&$info, $tableName = NULL) {
1680 return self
::singleton()->invoke(['info', 'tableName'], $info, $tableName,
1681 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1683 'civicrm_triggerInfo'
1688 * This hook allows changes to the spec of which tables to log.
1690 * @param array $logTableSpec
1694 public static function alterLogTables(&$logTableSpec) {
1695 return self
::singleton()->invoke(['logTableSpec'], $logTableSpec, $_nullObject,
1696 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1698 'civicrm_alterLogTables'
1703 * This hook is called when a module-extension is installed.
1704 * Each module will receive hook_civicrm_install during its own installation (but not during the
1705 * installation of unrelated modules).
1707 public static function install() {
1708 return self
::singleton()->invoke(0, self
::$_nullObject,
1709 self
::$_nullObject, self
::$_nullObject,
1710 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1716 * This hook is called when a module-extension is uninstalled.
1717 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1718 * uninstallation of unrelated modules).
1720 public static function uninstall() {
1721 return self
::singleton()->invoke(0, self
::$_nullObject,
1722 self
::$_nullObject, self
::$_nullObject,
1723 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1729 * This hook is called when a module-extension is re-enabled.
1730 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1731 * re-enablement of unrelated modules).
1733 public static function enable() {
1734 return self
::singleton()->invoke(0, self
::$_nullObject,
1735 self
::$_nullObject, self
::$_nullObject,
1736 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1742 * This hook is called when a module-extension is disabled.
1743 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1744 * disablement of unrelated modules).
1746 public static function disable() {
1747 return self
::singleton()->invoke(0, self
::$_nullObject,
1748 self
::$_nullObject, self
::$_nullObject,
1749 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1757 * This hook is called when the browser is being re-directed and allows the url
1760 * @param \Psr\Http\Message\UriInterface $url
1761 * @param array $context
1762 * Additional information about context
1763 * - output - if this is 'json' then it will return json.
1766 * the return value is ignored
1768 public static function alterRedirect(&$url, &$context) {
1769 return self
::singleton()->invoke(['url', 'context'], $url,
1770 $context, self
::$_nullObject,
1771 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1772 'civicrm_alterRedirect'
1783 public static function alterReportVar($varType, &$var, &$object) {
1784 return self
::singleton()->invoke(['varType', 'var', 'object'], $varType, $var, $object,
1786 self
::$_nullObject, self
::$_nullObject,
1787 'civicrm_alterReportVar'
1792 * This hook is called to drive database upgrades for extension-modules.
1795 * The type of operation being performed; 'check' or 'enqueue'.
1796 * @param CRM_Queue_Queue $queue
1797 * (for 'enqueue') the modifiable list of pending up upgrade tasks.
1800 * NULL, if $op is 'enqueue'.
1801 * TRUE, if $op is 'check' and upgrades are pending.
1802 * FALSE, if $op is 'check' and upgrades are not pending.
1804 public static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1805 return self
::singleton()->invoke(['op', 'queue'], $op, $queue,
1806 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1813 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1815 * @param array $params
1816 * The mailing parameters. Array fields include: groupName, from, toName,
1817 * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1818 * attachments (array)
1822 public static function postEmailSend(&$params) {
1823 return self
::singleton()->invoke(['params'], $params,
1824 self
::$_nullObject, self
::$_nullObject,
1825 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1826 'civicrm_postEmailSend'
1831 * This hook is called when a CiviMail mailing has completed
1833 * @param int $mailingId
1838 public static function postMailing($mailingId) {
1839 return self
::singleton()->invoke(['mailingId'], $mailingId,
1840 self
::$_nullObject, self
::$_nullObject,
1841 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1842 'civicrm_postMailing'
1847 * This hook is called when Settings specifications are loaded.
1849 * @param array $settingsFolders
1850 * List of paths from which to derive metadata
1854 public static function alterSettingsFolders(&$settingsFolders) {
1855 return self
::singleton()->invoke(['settingsFolders'], $settingsFolders,
1856 self
::$_nullObject, self
::$_nullObject,
1857 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1858 'civicrm_alterSettingsFolders'
1863 * This hook is called when Settings have been loaded from the xml
1864 * It is an opportunity for hooks to alter the data
1866 * @param array $settingsMetaData
1867 * Settings Metadata.
1868 * @param int $domainID
1869 * @param mixed $profile
1873 public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1874 return self
::singleton()->invoke(['settingsMetaData', 'domainID', 'profile'], $settingsMetaData,
1875 $domainID, $profile,
1876 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1877 'civicrm_alterSettingsMetaData'
1882 * This hook is called before running an api call.
1884 * @param API_Wrapper[] $wrappers
1885 * (see CRM_Utils_API_ReloadOption as an example)
1886 * @param mixed $apiRequest
1889 * The return value is ignored
1891 public static function apiWrappers(&$wrappers, $apiRequest) {
1892 return self
::singleton()
1893 ->invoke(['wrappers', 'apiRequest'], $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1894 self
::$_nullObject, 'civicrm_apiWrappers'
1899 * This hook is called before running pending cron jobs.
1901 * @param CRM_Core_JobManager $jobManager
1904 * The return value is ignored.
1906 public static function cron($jobManager) {
1907 return self
::singleton()->invoke(['jobManager'],
1908 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1914 * This hook is called when loading CMS permissions; use this hook to modify
1915 * the array of system permissions for CiviCRM.
1917 * @param array $permissions
1918 * Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1919 * the format of this array.
1922 * The return value is ignored
1924 public static function permission(&$permissions) {
1925 return self
::singleton()->invoke(['permissions'], $permissions,
1926 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1927 'civicrm_permission'
1932 * This hook is called when checking permissions; use this hook to dynamically
1933 * escalate user permissions in certain use cases (cf. CRM-19256).
1935 * @param string $permission
1936 * The name of an atomic permission, ie. 'access deleted contacts'
1937 * @param bool $granted
1938 * Whether this permission is currently granted. The hook can change this value.
1939 * @param int $contactId
1940 * Contact whose permissions we are checking (if null, assume current user).
1943 * The return value is ignored
1945 public static function permission_check($permission, &$granted, $contactId) {
1946 return self
::singleton()->invoke(['permission', 'granted', 'contactId'], $permission, $granted, $contactId,
1947 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1948 'civicrm_permission_check'
1953 * @param CRM_Core_Exception $exception
1954 * @param mixed $request
1955 * Reserved for future use.
1957 public static function unhandledException($exception, $request = NULL) {
1958 $event = new \Civi\Core\Event\
UnhandledExceptionEvent($exception, self
::$_nullObject);
1959 \Civi
::dispatcher()->dispatch('hook_civicrm_unhandled_exception', $event);
1963 * This hook is called for declaring managed entities via API.
1965 * Note: This is a pre-boot hook. It will dispatch via the extension/module
1966 * subsystem but *not* the Symfony EventDispatcher.
1968 * @param array[] $entityTypes
1969 * List of entity types; each entity-type is an array with keys:
1970 * - name: string, a unique short name (e.g. "ReportInstance")
1971 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1972 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
1973 * - fields_callback: array, list of callables which manipulates field list
1974 * - links_callback: array, list of callables which manipulates fk list
1977 * The return value is ignored
1979 public static function entityTypes(&$entityTypes) {
1980 return self
::singleton()->invoke(['entityTypes'], $entityTypes, self
::$_nullObject, self
::$_nullObject,
1981 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
1986 * Build a description of available hooks.
1988 * @param \Civi\Core\CiviEventInspector $inspector
1990 public static function eventDefs($inspector) {
1991 $event = \Civi\Core\Event\GenericHookEvent
::create([
1992 'inspector' => $inspector,
1994 Civi
::dispatcher()->dispatch('hook_civicrm_eventDefs', $event);
1998 * This hook is called while preparing a profile form.
2000 * @param string $profileName
2003 public static function buildProfile($profileName) {
2004 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2005 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildProfile');
2009 * This hook is called while validating a profile form submission.
2011 * @param string $profileName
2014 public static function validateProfile($profileName) {
2015 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2016 self
::$_nullObject, self
::$_nullObject, 'civicrm_validateProfile');
2020 * This hook is called processing a valid profile form submission.
2022 * @param string $profileName
2025 public static function processProfile($profileName) {
2026 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2027 self
::$_nullObject, self
::$_nullObject, 'civicrm_processProfile');
2031 * This hook is called while preparing a read-only profile screen
2033 * @param string $profileName
2036 public static function viewProfile($profileName) {
2037 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2038 self
::$_nullObject, self
::$_nullObject, 'civicrm_viewProfile');
2042 * This hook is called while preparing a list of contacts (based on a profile)
2044 * @param string $profileName
2047 public static function searchProfile($profileName) {
2048 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2049 self
::$_nullObject, self
::$_nullObject, 'civicrm_searchProfile');
2053 * This hook is invoked when building a CiviCRM name badge.
2055 * @param string $labelName
2056 * String referencing name of badge format.
2057 * @param object $label
2058 * Reference to the label object.
2059 * @param array $format
2060 * Array of format data.
2061 * @param array $participant
2062 * Array of participant values.
2065 * the return value is ignored
2067 public static function alterBadge($labelName, &$label, &$format, &$participant) {
2068 return self
::singleton()
2069 ->invoke(['labelName', 'label', 'format', 'participant'], $labelName, $label, $format, $participant, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBadge');
2073 * This hook is called before encoding data in barcode.
2075 * @param array $data
2076 * Associated array of values available for encoding.
2077 * @param string $type
2078 * Type of barcode, classic barcode or QRcode.
2079 * @param string $context
2080 * Where this hooks is invoked.
2084 public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') {
2085 return self
::singleton()->invoke(['data', 'type', 'context'], $data, $type, $context, self
::$_nullObject,
2086 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBarcode');
2090 * Modify or replace the Mailer object used for outgoing mail.
2092 * @param object $mailer
2093 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
2094 * @param string $driver
2095 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
2096 * @param array $params
2097 * The default mailer config options
2100 * @see Mail::factory
2102 public static function alterMailer(&$mailer, $driver, $params) {
2103 return self
::singleton()
2104 ->invoke(['mailer', 'driver', 'params'], $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
2108 * Deprecated: Misnamed version of alterMailer(). Remove post-4.7.x.
2109 * Modify or replace the Mailer object used for outgoing mail.
2111 * @param object $mailer
2112 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
2113 * @param string $driver
2114 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
2115 * @param array $params
2116 * The default mailer config options
2119 * @see Mail::factory
2122 public static function alterMail(&$mailer, $driver, $params) {
2123 // This has been deprecated on the premise it MIGHT be called externally for a long time.
2124 // We don't have a clear policy on how much we support external extensions calling internal
2125 // hooks (ie. in general we say 'don't call internal functions', but some hooks like pre hooks
2126 // are expected to be called externally.
2127 // It's really really unlikely anyone uses this - but let's add deprecations for a couple
2128 // of releases first.
2129 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Utils_Hook::alterMailer');
2130 return CRM_Utils_Hook
::alterMailer($mailer, $driver, $params);
2134 * This hook is called while building the core search query,
2135 * so hook implementers can provide their own query objects which alters/extends core search.
2137 * @param array $queryObjects
2138 * @param string $type
2142 public static function queryObjects(&$queryObjects, $type = 'Contact') {
2143 return self
::singleton()
2144 ->invoke(['queryObjects', 'type'], $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
2148 * This hook is called while viewing contact dashboard.
2150 * @param array $availableDashlets
2151 * List of dashlets; each is formatted per api/v3/Dashboard
2152 * @param array $defaultDashlets
2153 * List of dashlets; each is formatted per api/v3/DashboardContact
2157 public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
2158 return self
::singleton()
2159 ->invoke(['availableDashlets', 'defaultDashlets'], $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');
2163 * This hook is called before a case merge (or a case reassign)
2165 * @param int $mainContactId
2166 * @param int $mainCaseId
2167 * @param int $otherContactId
2168 * @param int $otherCaseId
2169 * @param bool $changeClient
2173 public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2174 return self
::singleton()
2175 ->invoke(['mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'], $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_pre_case_merge');
2179 * This hook is called after a case merge (or a case reassign)
2181 * @param int $mainContactId
2182 * @param int $mainCaseId
2183 * @param int $otherContactId
2184 * @param int $otherCaseId
2185 * @param bool $changeClient
2189 public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2190 return self
::singleton()
2191 ->invoke(['mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'], $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_post_case_merge');
2196 * Add a hook for altering the display name
2198 * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
2200 * @param string $displayName
2201 * @param int $contactId
2202 * @param object $dao
2203 * The contact object.
2207 public static function alterDisplayName(&$displayName, $contactId, $dao) {
2208 return self
::singleton()->invoke(['displayName', 'contactId', 'dao'],
2209 $displayName, $contactId, $dao, self
::$_nullObject, self
::$_nullObject,
2210 self
::$_nullObject, 'civicrm_contact_get_displayname'
2215 * Modify the CRM_Core_Resources settings data.
2217 * @param array $data
2218 * @see CRM_Core_Resources::addSetting
2220 public static function alterResourceSettings(&$data) {
2221 $event = \Civi\Core\Event\GenericHookEvent
::create([
2224 Civi
::dispatcher()->dispatch('hook_civicrm_alterResourceSettings', $event);
2228 * EXPERIMENTAL: This hook allows one to register additional Angular modules
2230 * @param array $angularModules
2231 * List of modules. Each module defines:
2232 * - ext: string, the CiviCRM extension which hosts the files.
2233 * - js: array, list of JS files or globs.
2234 * - css: array, list of CSS files or globs.
2235 * - partials: array, list of base-dirs containing HTML.
2236 * - requires: array, list of required Angular modules.
2237 * - basePages: array, uncondtionally load this module onto the given Angular pages. [v4.7.21+]
2238 * If omitted, default to "array('civicrm/a')" for backward compat.
2239 * For a utility that should only be loaded on-demand, use "array()".
2240 * For a utility that should be loaded in all pages use, "array('*')".
2242 * the return value is ignored
2245 * function mymod_civicrm_angularModules(&$angularModules) {
2246 * $angularModules['myAngularModule'] = array(
2247 * 'ext' => 'org.example.mymod',
2248 * 'js' => array('js/myAngularModule.js'),
2250 * $angularModules['myBigAngularModule'] = array(
2251 * 'ext' => 'org.example.mymod',
2252 * 'js' => array('js/part1.js', 'js/part2.js', 'ext://other.ext.name/file.js', 'assetBuilder://dynamicAsset.js'),
2253 * 'css' => array('css/myAngularModule.css', 'ext://other.ext.name/file.css', 'assetBuilder://dynamicAsset.css'),
2254 * 'partials' => array('partials/myBigAngularModule'),
2255 * 'requires' => array('otherModuleA', 'otherModuleB'),
2256 * 'basePages' => array('civicrm/a'),
2261 public static function angularModules(&$angularModules) {
2262 return self
::singleton()->invoke(['angularModules'], $angularModules,
2263 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2264 'civicrm_angularModules'
2269 * Alter the definition of some Angular HTML partials.
2271 * @param \Civi\Angular\Manager $angular
2274 * function example_civicrm_alterAngular($angular) {
2275 * $changeSet = \Civi\Angular\ChangeSet::create('mychanges')
2276 * ->alterHtml('~/crmMailing/EditMailingCtrl/2step.html', function(phpQueryObject $doc) {
2277 * $doc->find('[ng-form="crmMailingSubform"]')->attr('cat-stevens', 'ts(\'wild world\')');
2280 * $angular->add($changeSet);
2284 public static function alterAngular($angular) {
2285 $event = \Civi\Core\Event\GenericHookEvent
::create([
2286 'angular' => $angular,
2288 Civi
::dispatcher()->dispatch('hook_civicrm_alterAngular', $event);
2292 * This hook is called when building a link to a semi-static asset.
2294 * @param string $asset
2295 * The name of the asset.
2296 * Ex: 'angular.json'
2297 * @param array $params
2298 * List of optional arguments which influence the content.
2300 * the return value is ignored
2302 public static function getAssetUrl(&$asset, &$params) {
2303 return self
::singleton()->invoke(['asset', 'params'],
2304 $asset, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2305 'civicrm_getAssetUrl'
2310 * This hook is called whenever the system builds a new copy of
2311 * semi-static asset.
2313 * @param string $asset
2314 * The name of the asset.
2315 * Ex: 'angular.json'
2316 * @param array $params
2317 * List of optional arguments which influence the content.
2318 * Note: Params are immutable because they are part of the cache-key.
2319 * @param string $mimeType
2320 * Initially, NULL. Modify to specify the mime-type.
2321 * @param string $content
2322 * Initially, NULL. Modify to specify the rendered content.
2324 * the return value is ignored
2326 public static function buildAsset($asset, $params, &$mimeType, &$content) {
2327 return self
::singleton()->invoke(['asset', 'params', 'mimeType', 'content'],
2328 $asset, $params, $mimeType, $content, self
::$_nullObject, self
::$_nullObject,
2329 'civicrm_buildAsset'
2334 * This hook fires whenever a record in a case changes.
2336 * @param \Civi\CCase\Analyzer $analyzer
2337 * A bundle of data about the case (such as the case and activity records).
2339 public static function caseChange(\Civi\CCase\Analyzer
$analyzer) {
2340 $event = new \Civi\CCase\Event\
CaseChangeEvent($analyzer);
2341 \Civi
::dispatcher()->dispatch('hook_civicrm_caseChange', $event);
2345 * Generate a default CRUD URL for an entity.
2347 * @param array $spec
2349 * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
2350 * - entity_table: string
2352 * @param CRM_Core_DAO $bao
2353 * @param array $link
2354 * To define the link, add these keys to $link:.
2358 * - url: string (used in lieu of "path"/"query")
2359 * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
2362 public static function crudLink($spec, $bao, &$link) {
2363 return self
::singleton()->invoke(['spec', 'bao', 'link'], $spec, $bao, $link,
2364 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2370 * Modify the CiviCRM container - add new services, parameters, extensions, etc.
2373 * use Symfony\Component\Config\Resource\FileResource;
2374 * use Symfony\Component\DependencyInjection\Definition;
2376 * function mymodule_civicrm_container($container) {
2377 * $container->addResource(new FileResource(__FILE__));
2378 * $container->setDefinition('mysvc', new Definition('My\Class', array()));
2382 * Tip: The container configuration will be compiled/cached. The default cache
2383 * behavior is aggressive. When you first implement the hook, be sure to
2384 * flush the cache. Additionally, you should relax caching during development.
2385 * In `civicrm.settings.php`, set define('CIVICRM_CONTAINER_CACHE', 'auto').
2387 * Note: This is a preboot hook. It will dispatch via the extension/module
2388 * subsystem but *not* the Symfony EventDispatcher.
2390 * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
2391 * @see http://symfony.com/doc/current/components/dependency_injection/index.html
2393 public static function container(\Symfony\Component\DependencyInjection\ContainerBuilder
$container) {
2394 self
::singleton()->invoke(['container'], $container, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_container');
2398 * @param array $fileSearches CRM_Core_FileSearchInterface
2401 public static function fileSearches(&$fileSearches) {
2402 return self
::singleton()->invoke(['fileSearches'], $fileSearches,
2403 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2404 'civicrm_fileSearches'
2409 * Check system status.
2411 * @param array $messages
2412 * Array<CRM_Utils_Check_Message>. A list of messages regarding system status.
2415 public static function check(&$messages) {
2416 return self
::singleton()
2417 ->invoke(['messages'], $messages, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_check');
2421 * This hook is called when a query string of the CSV Batch export is generated.
2423 * @param string $query
2427 public static function batchQuery(&$query) {
2428 return self
::singleton()->invoke(['query'], $query, self
::$_nullObject,
2429 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2430 'civicrm_batchQuery'
2435 * This hook is called to alter Deferred revenue item values just before they are
2436 * inserted in civicrm_financial_trxn table
2438 * @param array $deferredRevenues
2440 * @param array $contributionDetails
2442 * @param bool $update
2444 * @param string $context
2448 public static function alterDeferredRevenueItems(&$deferredRevenues, $contributionDetails, $update, $context) {
2449 return self
::singleton()->invoke(['deferredRevenues', 'contributionDetails', 'update', 'context'], $deferredRevenues, $contributionDetails, $update, $context,
2450 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterDeferredRevenueItems'
2455 * This hook is called when the entries of the CSV Batch export are mapped.
2457 * @param array $results
2458 * @param array $items
2462 public static function batchItems(&$results, &$items) {
2463 return self
::singleton()->invoke(['results', 'items'], $results, $items,
2464 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2465 'civicrm_batchItems'
2470 * This hook is called when core resources are being loaded
2472 * @see CRM_Core_Resources::coreResourceList
2474 * @param array $list
2475 * @param string $region
2477 public static function coreResourceList(&$list, $region) {
2478 self
::singleton()->invoke(['list', 'region'], $list, $region,
2479 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2480 'civicrm_coreResourceList'
2485 * Allows the list of filters on the EntityRef widget to be altered.
2487 * @see CRM_Core_Resources::entityRefFilters
2489 * @param array $filters
2490 * @param array $links
2492 public static function entityRefFilters(&$filters, &$links = NULL) {
2493 self
::singleton()->invoke(['filters', 'links'], $filters, $links, self
::$_nullObject,
2494 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2495 'civicrm_entityRefFilters'
2500 * This hook is called for bypass a few civicrm urls from IDS check.
2502 * @param array $skip list of civicrm urls
2506 public static function idsException(&$skip) {
2507 return self
::singleton()->invoke(['skip'], $skip, self
::$_nullObject,
2508 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2509 'civicrm_idsException'
2514 * This hook is called when a geocoder's format method is called.
2516 * @param string $geoProvider
2517 * @param array $values
2518 * @param SimpleXMLElement $xml
2522 public static function geocoderFormat($geoProvider, &$values, $xml) {
2523 return self
::singleton()->invoke(['geoProvider', 'values', 'xml'], $geoProvider, $values, $xml,
2524 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2525 'civicrm_geocoderFormat'
2530 * This hook is called before an inbound SMS is processed.
2532 * @param \CRM_SMS_Message $message
2533 * An SMS message received
2536 public static function inboundSMS(&$message) {
2537 return self
::singleton()->invoke(['message'], $message, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_inboundSMS');
2541 * This hook is called to modify api params of EntityRef form field
2543 * @param array $params
2544 * @param string $formName
2547 public static function alterEntityRefParams(&$params, $formName) {
2548 return self
::singleton()->invoke(['params', 'formName'], $params, $formName,
2549 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2550 'civicrm_alterEntityRefParams'
2555 * This hook is called before a scheduled job is executed
2557 * @param CRM_Core_DAO_Job $job
2558 * The job to be executed
2559 * @param array $params
2560 * The arguments to be given to the job
2562 public static function preJob($job, $params) {
2563 return self
::singleton()->invoke(['job', 'params'], $job, $params,
2564 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2570 * This hook is called after a scheduled job is executed
2572 * @param CRM_Core_DAO_Job $job
2573 * The job that was executed
2574 * @param array $params
2575 * The arguments given to the job
2576 * @param array $result
2577 * The result of the API call, or the thrown exception if any
2579 public static function postJob($job, $params, $result) {
2580 return self
::singleton()->invoke(['job', 'params', 'result'], $job, $params, $result,
2581 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2587 * This hook is called before and after constructing mail recipients.
2588 * Allows user to alter filter and/or search query to fetch mail recipients
2590 * @param CRM_Mailing_DAO_Mailing $mailingObject
2591 * @param array $criteria
2592 * A list of SQL criteria; you can add/remove/replace/modify criteria.
2593 * Array(string $name => CRM_Utils_SQL_Select $criterion).
2594 * Ex: array('do_not_email' => CRM_Utils_SQL_Select::fragment()->where("$contact.do_not_email = 0")).
2595 * @param string $context
2599 public static function alterMailingRecipients(&$mailingObject, &$criteria, $context) {
2600 return self
::singleton()->invoke(['mailingObject', 'params', 'context'],
2601 $mailingObject, $criteria, $context,
2602 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2603 'civicrm_alterMailingRecipients'
2608 * ALlow Extensions to custom process IPN hook data such as sending Google Analyitcs information based on the IPN
2609 * @param array $IPNData - Array of IPN Data
2612 public static function postIPNProcess(&$IPNData) {
2613 return self
::singleton()->invoke(['IPNData'],
2614 $IPNData, self
::$_nullObject, self
::$_nullObject,
2615 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2616 'civicrm_postIPNProcess'