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 if (!\Civi\Core\Container
::isContainerBooted()) {
156 $prebootHooks = ['civicrm_container', 'civicrm_entityTypes'];
157 // 'civicrm_config' ?
158 if (in_array($fnSuffix, $prebootHooks)) {
159 $count = is_array($names) ?
count($names) : $names;
160 return $this->invokeViaUF($count, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6, $fnSuffix);
163 // TODO: Emit a warning, eg
164 // error_log("Warning: hook_$fnSuffix fired prematurely. Dropped.");
169 if (!is_array($names)) {
170 // We were called with the old contract wherein $names is actually an int.
171 // Symfony dispatcher requires some kind of name.
172 // TODO: Emit a warning, eg
173 // error_log("Warning: hook_$fnSuffix does not give names for its parameters. It will present odd names to any Symfony event listeners.");
174 $compatNames = ['arg1', 'arg2', 'arg3', 'arg4', 'arg5', 'arg6'];
175 $names = array_slice($compatNames, 0, (int) $names);
178 $event = \Civi\Core\Event\GenericHookEvent
::createOrdered(
180 array(&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6)
182 \Civi
::dispatcher()->dispatch('hook_' . $fnSuffix, $event);
183 return $event->getReturnValues();
187 * @param array $numParams
199 public function commonInvoke(
201 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
205 $this->commonBuildModuleList($fnPrefix);
207 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
208 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
213 * Build the list of modules to be processed for hooks.
215 * @param string $fnPrefix
217 public function commonBuildModuleList($fnPrefix) {
218 if (!$this->commonIncluded
) {
219 // include external file
220 $this->commonIncluded
= TRUE;
222 $config = CRM_Core_Config
::singleton();
223 if (!empty($config->customPHPPathDir
)) {
224 $civicrmHooksFile = CRM_Utils_File
::addTrailingSlash($config->customPHPPathDir
) . 'civicrmHooks.php';
225 if (file_exists($civicrmHooksFile)) {
226 @include_once
$civicrmHooksFile;
230 if (!empty($fnPrefix)) {
231 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
234 $this->requireCiviModules($this->commonCiviModules
);
241 * @param array $civiModules
242 * @param string $fnSuffix
243 * @param int $numParams
252 * @throws \CRM_Core_Exception
254 public function runHooks(
255 $civiModules, $fnSuffix, $numParams,
256 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
258 // $civiModules is *not* passed by reference because runHooks
259 // must be reentrant. PHP is finicky about running
260 // multiple loops over the same variable. The circumstances
261 // to reproduce the issue are pretty intricate.
264 $fnNames = $this->cache
->get($fnSuffix);
265 if (!is_array($fnNames)) {
267 if ($civiModules !== NULL) {
268 foreach ($civiModules as $module) {
269 $fnName = "{$module}_{$fnSuffix}";
270 if (function_exists($fnName)) {
271 $fnNames[] = $fnName;
274 $this->cache
->set($fnSuffix, $fnNames);
278 foreach ($fnNames as $fnName) {
280 switch ($numParams) {
282 $fResult = $fnName();
286 $fResult = $fnName($arg1);
290 $fResult = $fnName($arg1, $arg2);
294 $fResult = $fnName($arg1, $arg2, $arg3);
298 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
302 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
306 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
310 throw new CRM_Core_Exception(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 is equivalent to post(), except that it is guaranteed to run
387 * outside of any SQL transaction. The objectRef is not modifiable.
389 * This hook is defined for two cases:
391 * 1. If the original action runs within a transaction, then the hook fires
392 * after the transaction commits.
393 * 2. If the original action runs outside a transaction, then the data was
394 * committed immediately, and we can run the hook immediately.
397 * The type of operation being performed.
398 * @param string $objectName
399 * The name of the object.
400 * @param int $objectId
401 * The unique identifier for the object.
402 * @param object $objectRef
403 * The reference to the object if available.
406 * based on op. pre-hooks return a boolean or
407 * an error message which aborts the operation
409 public static function postCommit($op, $objectName, $objectId, $objectRef = NULL) {
410 $event = new \Civi\Core\Event\
PostEvent($op, $objectName, $objectId, $objectRef);
411 \Civi
::dispatcher()->dispatch('hook_civicrm_postCommit', $event);
412 return $event->getReturnValues();
416 * This hook retrieves links from other modules and injects it into.
417 * the view contact tabs
420 * The type of operation being performed.
421 * @param string $objectName
422 * The name of the object.
423 * @param int $objectId
424 * The unique identifier for the object.
425 * @param array $links
426 * (optional) the links array (introduced in v3.2).
428 * (optional) the bitmask to show/hide links.
429 * @param array $values
430 * (optional) the values to fill the links.
433 * the return value is ignored
435 public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = []) {
436 return self
::singleton()->invoke(['op', 'objectName', 'objectId', 'links', 'mask', 'values'], $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
440 * This hook is invoked during the CiviCRM form preProcess phase.
442 * @param string $formName
443 * The name of the form.
444 * @param CRM_Core_Form $form
445 * Reference to the form object.
448 * the return value is ignored
450 public static function preProcess($formName, &$form) {
451 return self
::singleton()
452 ->invoke(['formName', 'form'], $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_preProcess');
456 * This hook is invoked when building a CiviCRM form. This hook should also
457 * be used to set the default values of a form element
459 * @param string $formName
460 * The name of the form.
461 * @param CRM_Core_Form $form
462 * Reference to the form object.
465 * the return value is ignored
467 public static function buildForm($formName, &$form) {
468 return self
::singleton()->invoke(['formName', 'form'], $formName, $form,
469 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
475 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
476 * any form elements, this hook should save the values in the database
478 * @param string $formName
479 * The name of the form.
480 * @param CRM_Core_Form $form
481 * Reference to the form object.
484 * the return value is ignored
486 public static function postProcess($formName, &$form) {
487 return self
::singleton()->invoke(['formName', 'form'], $formName, $form,
488 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
489 'civicrm_postProcess'
494 * This hook is invoked during all CiviCRM form validation. An array of errors
495 * detected is returned. Else we assume validation succeeded.
497 * @param string $formName
498 * The name of the form.
499 * @param array &$fields the POST parameters as filtered by QF
500 * @param array &$files the FILES parameters as sent in by POST
501 * @param array &$form the form object
502 * @param array &$errors the array of errors.
505 * formRule hooks return a boolean or
506 * an array of error messages which display a QF Error
508 public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
509 return self
::singleton()
510 ->invoke(['formName', 'fields', 'files', 'form', 'errors'],
511 $formName, $fields, $files, $form, $errors, self
::$_nullObject, 'civicrm_validateForm');
515 * This hook is called after a db write on a custom table.
518 * The type of operation being performed.
519 * @param string $groupID
520 * The custom group ID.
521 * @param object $entityID
522 * The entityID of the row in the custom table.
523 * @param array $params
524 * The parameters that were sent into the calling function.
527 * the return value is ignored
529 public static function custom($op, $groupID, $entityID, &$params) {
530 return self
::singleton()
531 ->invoke(['op', 'groupID', 'entityID', 'params'], $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_custom');
535 * This hook is called before a db write on a custom table.
538 * The type of operation being performed.
539 * @param string $groupID
540 * The custom group ID.
541 * @param object $entityID
542 * The entityID of the row in the custom table.
543 * @param array $params
544 * The parameters that were sent into the calling function.
547 * the return value is ignored
549 public static function customPre($op, $groupID, $entityID, &$params) {
550 return self
::singleton()
551 ->invoke(['op', 'groupID', 'entityID', 'params'], $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_customPre');
555 * This hook is called when composing the ACL where clause to restrict
556 * visibility of contacts to the logged in user
559 * The type of permission needed.
560 * @param array $tables
561 * (reference ) add the tables that are needed for the select clause.
562 * @param array $whereTables
563 * (reference ) add the tables that are needed for the where clause.
564 * @param int $contactID
565 * The contactID for whom the check is made.
566 * @param string $where
567 * The currrent where clause.
570 * the return value is ignored
572 public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
573 return self
::singleton()
574 ->invoke(['type', 'tables', 'whereTables', 'contactID', 'where'], $type, $tables, $whereTables, $contactID, $where, self
::$_nullObject, 'civicrm_aclWhereClause');
578 * This hook is called when composing the ACL where clause to restrict
579 * visibility of contacts to the logged in user
582 * The type of permission needed.
583 * @param int $contactID
584 * The contactID for whom the check is made.
585 * @param string $tableName
586 * The tableName which is being permissioned.
587 * @param array $allGroups
588 * The set of all the objects for the above table.
589 * @param array $currentGroups
590 * The set of objects that are currently permissioned for this contact.
593 * the return value is ignored
595 public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
596 return self
::singleton()
597 ->invoke(['type', 'contactID', 'tableName', 'allGroups', 'currentGroups'], $type, $contactID, $tableName, $allGroups, $currentGroups, self
::$_nullObject, 'civicrm_aclGroup');
601 * @param string|CRM_Core_DAO $entity
602 * @param array $clauses
605 public static function selectWhereClause($entity, &$clauses) {
606 $entityName = is_object($entity) ?
_civicrm_api_get_entity_name_from_dao($entity) : $entity;
607 return self
::singleton()->invoke(['entity', 'clauses'], $entityName, $clauses,
608 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
609 'civicrm_selectWhereClause'
614 * This hook is called when building the menu table.
616 * @param array $files
617 * The current set of files to process.
620 * the return value is ignored
622 public static function xmlMenu(&$files) {
623 return self
::singleton()->invoke(['files'], $files,
624 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
630 * (Experimental) This hook is called when build the menu table.
632 * @param array $items
633 * List of records to include in menu table.
635 * the return value is ignored
637 public static function alterMenu(&$items) {
638 return self
::singleton()->invoke(['items'], $items,
639 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
645 * A theme is a set of CSS files which are loaded on CiviCRM pages. To register a new
646 * theme, add it to the $themes array. Use these properties:
648 * - ext: string (required)
649 * The full name of the extension which defines the theme.
650 * Ex: "org.civicrm.themes.greenwich".
651 * - title: string (required)
653 * - help: string (optional)
654 * Description of the theme's appearance.
655 * - url_callback: mixed (optional)
656 * A function ($themes, $themeKey, $cssExt, $cssFile) which returns the URL(s) for a CSS resource.
657 * Returns either an array of URLs or PASSTHRU.
658 * Ex: \Civi\Core\Themes\Resolvers::simple (default)
659 * Ex: \Civi\Core\Themes\Resolvers::none
660 * - prefix: string (optional)
661 * A prefix within the extension folder to prepend to the file name.
662 * - search_order: array (optional)
663 * A list of themes to search.
664 * Generally, the last theme should be "*fallback*" (Civi\Core\Themes::FALLBACK).
665 * - excludes: array (optional)
666 * A list of files (eg "civicrm:css/bootstrap.css" or "$ext:$file") which should never
667 * be returned (they are excluded from display).
669 * @param array $themes
670 * List of themes, keyed by name.
672 * the return value is ignored
674 public static function themes(&$themes) {
675 return self
::singleton()->invoke(['themes'], $themes,
676 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
682 * The activeTheme hook determines which theme is active.
684 * @param string $theme
685 * The identifier for the theme. Alterable.
687 * @param array $context
688 * Information about the current page-request. Includes some mix of:
689 * - page: the relative path of the current Civi page (Ex: 'civicrm/dashboard').
690 * - themes: an instance of the Civi\Core\Themes service.
692 * the return value is ignored
694 public static function activeTheme(&$theme, $context) {
695 return self
::singleton()->invoke(array('theme', 'context'), $theme, $context,
696 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
697 'civicrm_activeTheme'
702 * This hook is called for declaring managed entities via API.
704 * @param array $entities
705 * List of pending entities. Each entity is an array with keys:
706 * + '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")
707 * + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
708 * + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
709 * + 'params': array, the entity data as supported by the CiviCRM API
710 * + 'update' (v4.5+): string, a policy which describes when to update records
711 * - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
712 * - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
713 * + '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)
714 * - 'always' (default): always delete orphaned records
715 * - 'never': never delete orphaned records
716 * - '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.)
719 * the return value is ignored
721 public static function managed(&$entities) {
722 return self
::singleton()->invoke(['entities'], $entities,
723 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
729 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
731 * @param int $contactID
732 * The contactID for whom the dashboard is being rendered.
733 * @param int $contentPlacement
734 * (output parameter) where should the hook content be displayed.
735 * relative to the activity list
738 * the html snippet to include in the dashboard
740 public static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
741 $retval = self
::singleton()->invoke(['contactID', 'contentPlacement'], $contactID, $contentPlacement,
742 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
747 * Note we need this seemingly unnecessary code because in the event that the implementation
748 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
749 * though we have a default value in this function's declaration above.
751 if (!isset($contentPlacement)) {
752 $contentPlacement = self
::DASHBOARD_BELOW
;
759 * This hook is called before storing recently viewed items.
761 * @param array $recentArray
762 * An array of recently viewed or processed items, for in place modification.
766 public static function recent(&$recentArray) {
767 return self
::singleton()->invoke(['recentArray'], $recentArray,
768 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
774 * Determine how many other records refer to a given record.
776 * @param CRM_Core_DAO $dao
777 * The item for which we want a reference count.
778 * @param array $refCounts
779 * Each item in the array is an Array with keys:
780 * - name: string, eg "sql:civicrm_email:contact_id"
781 * - type: string, eg "sql"
782 * - count: int, eg "5" if there are 5 email addresses that refer to $dao
785 * Return is not really intended to be used.
787 public static function referenceCounts($dao, &$refCounts) {
788 return self
::singleton()->invoke(['dao', 'refCounts'], $dao, $refCounts,
789 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
790 'civicrm_referenceCounts'
795 * This hook is called when building the amount structure for a Contribution or Event Page.
797 * @param int $pageType
798 * Is this a contribution or event page.
799 * @param CRM_Core_Form $form
800 * Reference to the form object.
801 * @param array $amount
802 * The amount structure to be displayed.
806 public static function buildAmount($pageType, &$form, &$amount) {
807 return self
::singleton()->invoke(['pageType', 'form', 'amount'], $pageType, $form, $amount, self
::$_nullObject,
808 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildAmount');
812 * This hook is called when building the state list for a particular country.
814 * @param array $countryID
815 * The country id whose states are being selected.
820 public static function buildStateProvinceForCountry($countryID, &$states) {
821 return self
::singleton()->invoke(['countryID', 'states'], $countryID, $states,
822 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
823 'civicrm_buildStateProvinceForCountry'
828 * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
831 * The array of tabs that will be displayed.
832 * @param int $contactID
833 * The contactID for whom the dashboard is being rendered.
836 * @deprecated Use tabset() instead.
838 public static function tabs(&$tabs, $contactID) {
839 return self
::singleton()->invoke(['tabs', 'contactID'], $tabs, $contactID,
840 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabs'
845 * This hook is called when rendering the tabs used for events and potentially
846 * contribution pages, etc.
848 * @param string $tabsetName
849 * Name of the screen or visual element.
851 * Tabs that will be displayed.
852 * @param array $context
853 * Extra data about the screen or context in which the tab is used.
857 public static function tabset($tabsetName, &$tabs, $context) {
858 return self
::singleton()->invoke(['tabsetName', 'tabs', 'context'], $tabsetName, $tabs,
859 $context, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
864 * This hook is called when sending an email / printing labels
866 * @param array $tokens
867 * The list of tokens that can be used for the contact.
871 public static function tokens(&$tokens) {
872 return self
::singleton()->invoke(['tokens'], $tokens,
873 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
878 * This hook allows modification of the admin panels
880 * @param array $panels
881 * Associated array of admin panels
885 public static function alterAdminPanel(&$panels) {
886 return self
::singleton()->invoke(array('panels'), $panels,
887 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
888 'civicrm_alterAdminPanel'
893 * This hook is called when sending an email / printing labels to get the values for all the
894 * tokens returned by the 'tokens' hook
896 * @param array $details
897 * The array to store the token values indexed by contactIDs.
898 * @param array $contactIDs
899 * An array of contactIDs.
901 * The jobID if this is associated with a CiviMail mailing.
902 * @param array $tokens
903 * The list of tokens associated with the content.
904 * @param string $className
905 * The top level className from where the hook is invoked.
909 public static function tokenValues(
916 return self
::singleton()
917 ->invoke(['details', 'contactIDs', 'jobID', 'tokens', 'className'], $details, $contactIDs, $jobID, $tokens, $className, self
::$_nullObject, 'civicrm_tokenValues');
921 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
924 * @param object $page
925 * The page that will be rendered.
929 public static function pageRun(&$page) {
930 return self
::singleton()->invoke(['page'], $page,
931 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
937 * This hook is called after a copy of an object has been made. The current objects are
938 * Event, Contribution Page and UFGroup
940 * @param string $objectName
941 * Name of the object.
942 * @param object $object
943 * Reference to the copy.
947 public static function copy($objectName, &$object) {
948 return self
::singleton()->invoke(['objectName', 'object'], $objectName, $object,
949 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
955 * This hook is called when a contact unsubscribes from a mailing. It allows modules
956 * to override what the contacts are removed from.
960 * @param int $mailingId
961 * The id of the mailing to unsub from
962 * @param int $contactId
963 * The id of the contact who is unsubscribing
964 * @param array|int $groups
965 * Groups the contact will be removed from.
966 * @param array|int $baseGroups
967 * Base groups (used in smart mailings) the contact will be removed from.
972 public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
973 return self
::singleton()
974 ->invoke(['op', 'mailingId', 'contactId', 'groups', 'baseGroups'], $op, $mailingId, $contactId, $groups, $baseGroups, self
::$_nullObject, 'civicrm_unsubscribeGroups');
978 * This hook is called when CiviCRM needs to edit/display a custom field with options
980 * @deprecated in favor of hook_civicrm_fieldOptions
982 * @param int $customFieldID
983 * The custom field ID.
984 * @param array $options
985 * The current set of options for that custom field.
986 * You can add/remove existing options.
987 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
988 * to be careful to not overwrite the array.
989 * Only add/edit/remove the specific field options you intend to affect.
990 * @param bool $detailedFormat
991 * If true, the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
992 * @param array $selectAttributes
993 * Contain select attribute(s) if any.
997 public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = []) {
998 // Weird: $selectAttributes is inputted but not outputted.
999 return self
::singleton()->invoke(['customFieldID', 'options', 'detailedFormat'], $customFieldID, $options, $detailedFormat,
1000 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1001 'civicrm_customFieldOptions'
1006 * Hook for modifying field options
1008 * @param string $entity
1009 * @param string $field
1010 * @param array $options
1011 * @param array $params
1015 public static function fieldOptions($entity, $field, &$options, $params) {
1016 return self
::singleton()->invoke(['entity', 'field', 'options', 'params'], $entity, $field, $options, $params,
1017 self
::$_nullObject, self
::$_nullObject,
1018 'civicrm_fieldOptions'
1024 * This hook is called to display the list of actions allowed after doing a search.
1025 * This allows the module developer to inject additional actions or to remove existing actions.
1027 * @param string $objectType
1028 * The object type for this search.
1029 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
1030 * @param array $tasks
1031 * The current set of tasks for that custom field.
1032 * You can add/remove existing tasks.
1033 * Each task needs to have a title (eg 'title' => ts( 'Group - add contacts')) and a class
1034 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
1035 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
1036 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
1037 * found in CRM/$objectType/Task.php.
1041 public static function searchTasks($objectType, &$tasks) {
1042 return self
::singleton()->invoke(['objectType', 'tasks'], $objectType, $tasks,
1043 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1044 'civicrm_searchTasks'
1049 * @param mixed $form
1050 * @param array $params
1054 public static function eventDiscount(&$form, &$params) {
1055 return self
::singleton()->invoke(['form', 'params'], $form, $params,
1056 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1057 'civicrm_eventDiscount'
1062 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
1064 * @param mixed $form
1065 * The form object for which groups / mailings being displayed
1066 * @param array $groups
1067 * The list of groups being included / excluded
1068 * @param array $mailings
1069 * The list of mailings being included / excluded
1073 public static function mailingGroups(&$form, &$groups, &$mailings) {
1074 return self
::singleton()->invoke(['form', 'groups', 'mailings'], $form, $groups, $mailings,
1075 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1076 'civicrm_mailingGroups'
1081 * (Experimental) Modify the list of template-types used for CiviMail composition.
1083 * @param array $types
1084 * Sequentially indexed list of template types. Each type specifies:
1086 * - editorUrl: string, Angular template URL
1087 * - weight: int, priority when picking a default value for new mailings
1090 public static function mailingTemplateTypes(&$types) {
1091 return self
::singleton()->invoke(['types'], $types, self
::$_nullObject, self
::$_nullObject,
1092 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1093 'civicrm_mailingTemplateTypes'
1098 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
1100 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
1101 * You can use it to alter the membership types when first loaded, or after submission
1102 * (for example if you want to gather data in the form and use it to alter the fees).
1104 * @param mixed $form
1105 * The form object that is presenting the page
1106 * @param array $membershipTypes
1107 * The array of membership types and their amount
1111 public static function membershipTypeValues(&$form, &$membershipTypes) {
1112 return self
::singleton()->invoke(['form', 'membershipTypes'], $form, $membershipTypes,
1113 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1114 'civicrm_membershipTypeValues'
1119 * This hook is called when rendering the contact summary.
1121 * @param int $contactID
1122 * The contactID for whom the summary is being rendered
1123 * @param mixed $content
1124 * @param int $contentPlacement
1125 * Specifies where the hook content should be displayed relative to the
1129 * The html snippet to include in the contact summary
1131 public static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
1132 return self
::singleton()->invoke(['contactID', 'content', 'contentPlacement'], $contactID, $content, $contentPlacement,
1133 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1139 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
1140 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
1141 * If you want to limit the contacts returned to a specific group, or some other criteria
1142 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
1143 * The hook is called when the query is executed to get the list of contacts to display.
1145 * @param mixed $query
1146 * - the query that will be executed (input and output parameter);.
1147 * It's important to realize that the ACL clause is built prior to this hook being fired,
1148 * so your query will ignore any ACL rules that may be defined.
1149 * Your query must return two columns:
1150 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
1152 * @param string $queryText
1153 * The name string to execute the query against (this is the value being typed in by the user).
1154 * @param string $context
1155 * The context in which this ajax call is being made (for example: 'customfield', 'caseview').
1157 * The id of the object for which the call is being made.
1158 * For custom fields, it will be the custom field id
1162 public static function contactListQuery(&$query, $queryText, $context, $id) {
1163 return self
::singleton()->invoke(['query', 'queryText', 'context', 'id'], $query, $queryText, $context, $id,
1164 self
::$_nullObject, self
::$_nullObject,
1165 'civicrm_contactListQuery'
1170 * Hook definition for altering payment parameters before talking to a payment processor back end.
1172 * Definition will look like this:
1174 * function hook_civicrm_alterPaymentProcessorParams(
1180 * @param CRM_Core_Payment $paymentObj
1181 * Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
1182 * See discussion in CRM-16224 as to whether $paymentObj should be passed by reference.
1183 * @param array &$rawParams
1184 * array of params as passed to to the processor
1185 * @param array|\Civi\Payment\PropertyBag &$cookedParams
1186 * params after the processor code has translated them into its own key/value pairs
1189 * This return is not really intended to be used.
1191 public static function alterPaymentProcessorParams(
1196 return self
::singleton()->invoke(['paymentObj', 'rawParams', 'cookedParams'], $paymentObj, $rawParams, $cookedParams,
1197 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1198 'civicrm_alterPaymentProcessorParams'
1203 * This hook is called when an email is about to be sent by CiviCRM.
1205 * @param array $params
1206 * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
1207 * returnPath, replyTo, headers, attachments (array)
1208 * @param string $context
1209 * The context in which the hook is being invoked, eg 'civimail'.
1213 public static function alterMailParams(&$params, $context = NULL) {
1214 return self
::singleton()->invoke(['params', 'context'], $params, $context,
1215 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1216 'civicrm_alterMailParams'
1221 * This hook is called when membership status is being calculated.
1223 * @param array $membershipStatus
1224 * Membership status details as determined - alter if required.
1225 * @param array $arguments
1226 * Arguments passed in to calculate date.
1231 * - 'exclude_is_admin'
1232 * - 'membership_type_id'
1233 * @param array $membership
1234 * Membership details from the calling function.
1238 public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
1239 return self
::singleton()->invoke(['membershipStatus', 'arguments', 'membership'], $membershipStatus, $arguments,
1240 $membership, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1241 'civicrm_alterCalculatedMembershipStatus'
1246 * This hook is called after getting the content of the mail and before tokenizing it.
1248 * @param array $content
1249 * Array fields include: html, text, subject
1253 public static function alterMailContent(&$content) {
1254 return self
::singleton()->invoke(['content'], $content,
1255 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1256 'civicrm_alterMailContent'
1261 * This hook is called when rendering the Manage Case screen.
1263 * @param int $caseID
1267 * Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
1268 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
1270 public static function caseSummary($caseID) {
1271 return self
::singleton()->invoke(['caseID'], $caseID,
1272 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1273 'civicrm_caseSummary'
1278 * This hook is called when locating CiviCase types.
1280 * @param array $caseTypes
1284 public static function caseTypes(&$caseTypes) {
1285 return self
::singleton()
1286 ->invoke(['caseTypes'], $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
1290 * This hook is called soon after the CRM_Core_Config object has ben initialized.
1291 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
1293 * @param CRM_Core_Config|array $config
1298 public static function config(&$config) {
1299 return self
::singleton()->invoke(['config'], $config,
1300 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1306 * This hooks allows to change option values.
1308 * @deprecated in favor of hook_civicrm_fieldOptions
1310 * @param array $options
1311 * Associated array of option values / id
1312 * @param string $groupName
1317 public static function optionValues(&$options, $groupName) {
1318 return self
::singleton()->invoke(['options', 'groupName'], $options, $groupName,
1319 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1320 'civicrm_optionValues'
1325 * This hook allows modification of the navigation menu.
1327 * @param array $params
1328 * Associated array of navigation menu entry to Modify/Add
1332 public static function navigationMenu(&$params) {
1333 return self
::singleton()->invoke(['params'], $params,
1334 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1335 'civicrm_navigationMenu'
1340 * This hook allows modification of the data used to perform merging of duplicates.
1342 * @param string $type
1343 * The type of data being passed (cidRefs|eidRefs|relTables|sqls).
1344 * @param array $data
1345 * The data, as described in $type.
1346 * @param int $mainId
1347 * Contact_id of the contact that survives the merge.
1348 * @param int $otherId
1349 * Contact_id of the contact that will be absorbed and deleted.
1350 * @param array $tables
1351 * When $type is "sqls", an array of tables as it may have been handed to the calling function.
1355 public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
1356 return self
::singleton()->invoke(['type', 'data', 'mainId', 'otherId', 'tables'], $type, $data, $mainId, $otherId, $tables, self
::$_nullObject, 'civicrm_merge');
1360 * This hook allows modification of the data calculated for merging locations.
1362 * @param array $blocksDAO
1363 * Array of location DAO to be saved. These are arrays in 2 keys 'update' & 'delete'.
1364 * @param int $mainId
1365 * Contact_id of the contact that survives the merge.
1366 * @param int $otherId
1367 * Contact_id of the contact that will be absorbed and deleted.
1368 * @param array $migrationInfo
1369 * Calculated migration info, informational only.
1373 public static function alterLocationMergeData(&$blocksDAO, $mainId, $otherId, $migrationInfo) {
1374 return self
::singleton()->invoke(['blocksDAO', 'mainId', 'otherId', 'migrationInfo'], $blocksDAO, $mainId, $otherId, $migrationInfo, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterLocationMergeData');
1378 * This hook provides a way to override the default privacy behavior for notes.
1380 * @param array &$noteValues
1381 * Associative array of values for this note
1385 public static function notePrivacy(&$noteValues) {
1386 return self
::singleton()->invoke(['noteValues'], $noteValues,
1387 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1388 'civicrm_notePrivacy'
1393 * This hook is called before record is exported as CSV.
1395 * @param string $exportTempTable
1396 * Name of the temporary export table used during export.
1397 * @param array $headerRows
1398 * Header rows for output.
1399 * @param array $sqlColumns
1401 * @param int $exportMode
1402 * Export mode ( contact, contribution, etc...).
1403 * @param string $componentTable
1404 * Name of temporary table
1406 * Array of object's ids
1410 public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, $exportMode, $componentTable, $ids) {
1411 return self
::singleton()->invoke(['exportTempTable', 'headerRows', 'sqlColumns', 'exportMode', 'componentTable', 'ids'],
1412 $exportTempTable, $headerRows, $sqlColumns,
1413 $exportMode, $componentTable, $ids,
1419 * This hook allows modification of the queries constructed from dupe rules.
1421 * @param string $obj
1422 * Object of rulegroup class.
1423 * @param string $type
1424 * Type of queries e.g table / threshold.
1425 * @param array $query
1430 public static function dupeQuery($obj, $type, &$query) {
1431 return self
::singleton()->invoke(['obj', 'type', 'query'], $obj, $type, $query,
1432 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1438 * Check for duplicate contacts
1440 * @param array $dedupeParams
1441 * Array of params for finding duplicates: [
1442 * '{parameters returned by CRM_Dedupe_Finder::formatParams}
1443 * 'check_permission' => TRUE/FALSE;
1444 * 'contact_type' => $contactType;
1446 * 'rule_group_id' => $ruleGroupID;
1447 * 'excludedContactIDs' => $excludedContactIDs;
1448 * @param array $dedupeResults
1449 * Array of results ['handled' => TRUE/FALSE, 'ids' => array of IDs of duplicate contacts]
1450 * @param array $contextParams
1451 * The context if relevant, eg. ['event_id' => X]
1455 public static function findDuplicates($dedupeParams, &$dedupeResults, $contextParams) {
1456 return self
::singleton()
1457 ->invoke(['dedupeParams', 'dedupeResults', 'contextParams'], $dedupeParams, $dedupeResults, $contextParams, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_findDuplicates');
1461 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1463 * @param string $type
1464 * Type of mail processed: 'activity' OR 'mailing'.
1465 * @param array &$params the params that were sent to the CiviCRM API function
1466 * @param object $mail
1467 * The mail object which is an ezcMail class.
1468 * @param array &$result the result returned by the api call
1469 * @param string $action
1470 * (optional ) the requested action to be performed if the types was 'mailing'.
1474 public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1475 return self
::singleton()
1476 ->invoke(['type', 'params', 'mail', 'result', 'action'], $type, $params, $mail, $result, $action, self
::$_nullObject, 'civicrm_emailProcessor');
1480 * This hook is called after a row has been processed and the
1481 * record (and associated records imported
1483 * @param string $object
1484 * Object being imported (for now Contact only, later Contribution, Activity,.
1485 * Participant and Member)
1486 * @param string $usage
1487 * Hook usage/location (for now process only, later mapping and others).
1488 * @param string $objectRef
1489 * Import record object.
1490 * @param array $params
1491 * Array with various key values: currently.
1492 * contactID - contact id
1493 * importID - row id in temp table
1494 * importTempTable - name of tempTable
1495 * fieldHeaders - field headers
1496 * fields - import fields
1500 public static function import($object, $usage, &$objectRef, &$params) {
1501 return self
::singleton()->invoke(['object', 'usage', 'objectRef', 'params'], $object, $usage, $objectRef, $params,
1502 self
::$_nullObject, self
::$_nullObject,
1508 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1509 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1511 * @param string $entity
1512 * The API entity (like contact).
1513 * @param string $action
1514 * The API action (like get).
1515 * @param array &$params the API parameters
1516 * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1520 public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1521 return self
::singleton()->invoke(['entity', 'action', 'params', 'permissions'], $entity, $action, $params, $permissions,
1522 self
::$_nullObject, self
::$_nullObject,
1523 'civicrm_alterAPIPermissions'
1528 * @param CRM_Core_DAO $dao
1532 public static function postSave(&$dao) {
1533 $hookName = 'civicrm_postSave_' . $dao->getTableName();
1534 return self
::singleton()->invoke(['dao'], $dao,
1535 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1541 * This hook allows user to customize context menu Actions on contact summary page.
1543 * @param array $actions
1544 * Array of all Actions in contextmenu.
1545 * @param int $contactID
1546 * ContactID for the summary page.
1550 public static function summaryActions(&$actions, $contactID = NULL) {
1551 return self
::singleton()->invoke(['actions', 'contactID'], $actions, $contactID,
1552 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1553 'civicrm_summaryActions'
1558 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1559 * This enables us hook implementors to modify both the headers and the rows
1561 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1562 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1564 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1565 * you want displayed. This is a hackish, but avoids template modification.
1567 * @param string $objectName
1568 * The component name that we are doing the search.
1569 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1570 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1571 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1572 * @param array $selector
1573 * the selector object. Allows you access to the context of the search
1576 * modify the header and values object to pass the data you need
1578 public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1579 return self
::singleton()->invoke(['objectName', 'headers', 'rows', 'selector'], $objectName, $headers, $rows, $selector,
1580 self
::$_nullObject, self
::$_nullObject,
1581 'civicrm_searchColumns'
1586 * This hook is called when uf groups are being built for a module.
1588 * @param string $moduleName
1590 * @param array $ufGroups
1591 * Array of ufgroups for a module.
1595 public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1596 return self
::singleton()->invoke(['moduleName', 'ufGroups'], $moduleName, $ufGroups,
1597 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1598 'civicrm_buildUFGroupsForModule'
1603 * This hook is called when we are determining the contactID for a specific
1606 * @param string $email
1607 * The email address.
1608 * @param int $contactID
1609 * The contactID that matches this email address, IF it exists.
1610 * @param array $result
1611 * (reference) has two fields.
1612 * contactID - the new (or same) contactID
1613 * action - 3 possible values:
1614 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1615 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1616 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1620 public static function emailProcessorContact($email, $contactID, &$result) {
1621 return self
::singleton()->invoke(['email', 'contactID', 'result'], $email, $contactID, $result,
1622 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1623 'civicrm_emailProcessorContact'
1628 * Hook definition for altering the generation of Mailing Labels.
1630 * @param array $args
1631 * An array of the args in the order defined for the tcpdf multiCell api call.
1632 * with the variable names below converted into string keys (ie $w become 'w'
1633 * as the first key for $args)
1634 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1635 * float $h Cell minimum height. The cell extends automatically if needed.
1636 * string $txt String to print
1637 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1638 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1639 * a string containing some or all of the following characters (in any order):
1640 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1641 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1642 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1643 * (default value when $ishtml=false)</li></ul>
1644 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1645 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1646 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1647 * float $x x position in user units
1648 * float $y y position in user units
1649 * boolean $reseth if true reset the last cell height (default true).
1650 * int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1651 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1652 * necessary</li><li>4 = forced character spacing</li></ul>
1653 * boolean $ishtml set to true if $txt is HTML content (default = false).
1654 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1655 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1656 * or 0 for disable this feature. This feature works only when $ishtml=false.
1660 public static function alterMailingLabelParams(&$args) {
1661 return self
::singleton()->invoke(['args'], $args,
1662 self
::$_nullObject, self
::$_nullObject,
1663 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1664 'civicrm_alterMailingLabelParams'
1669 * This hooks allows alteration of generated page content.
1672 * Previously generated content.
1674 * Context of content - page or form.
1676 * The file name of the tpl.
1678 * A reference to the page or form object.
1682 public static function alterContent(&$content, $context, $tplName, &$object) {
1683 return self
::singleton()->invoke(['content', 'context', 'tplName', 'object'], $content, $context, $tplName, $object,
1684 self
::$_nullObject, self
::$_nullObject,
1685 'civicrm_alterContent'
1690 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1691 * altercontent hook as the content has already been rendered through the tpl at that point
1694 * Previously generated content.
1696 * Reference to the form object.
1698 * Context of content - page or form.
1700 * Reference the file name of the tpl.
1704 public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1705 return self
::singleton()->invoke(['formName', 'form', 'context', 'tplName'], $formName, $form, $context, $tplName,
1706 self
::$_nullObject, self
::$_nullObject,
1707 'civicrm_alterTemplateFile'
1712 * This hook collects the trigger definition from all components.
1715 * @param string $tableName
1716 * (optional) the name of the table that we are interested in only.
1718 * @internal param \reference $triggerInfo to an array of trigger information
1719 * each element has 4 fields:
1720 * table - array of tableName
1721 * when - BEFORE or AFTER
1722 * event - array of eventName - INSERT OR UPDATE OR DELETE
1723 * sql - array of statements optionally terminated with a ;
1724 * a statement can use the tokes {tableName} and {eventName}
1725 * to do token replacement with the table / event. This allows
1726 * templatizing logging and other hooks
1729 public static function triggerInfo(&$info, $tableName = NULL) {
1730 return self
::singleton()->invoke(['info', 'tableName'], $info, $tableName,
1731 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1733 'civicrm_triggerInfo'
1738 * This hook allows changes to the spec of which tables to log.
1740 * @param array $logTableSpec
1744 public static function alterLogTables(&$logTableSpec) {
1745 return self
::singleton()->invoke(['logTableSpec'], $logTableSpec, $_nullObject,
1746 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1748 'civicrm_alterLogTables'
1753 * This hook is called when a module-extension is installed.
1754 * Each module will receive hook_civicrm_install during its own installation (but not during the
1755 * installation of unrelated modules).
1757 public static function install() {
1758 // Actually invoke via CRM_Extension_Manager_Module::callHook
1759 throw new \
RuntimeException(sprintf("The method %s::%s is just a documentation stub and should not be invoked directly.", __CLASS__
, __FUNCTION__
));
1763 * This hook is called when a module-extension is uninstalled.
1764 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1765 * uninstallation of unrelated modules).
1767 public static function uninstall() {
1768 // Actually invoke via CRM_Extension_Manager_Module::callHook
1769 throw new \
RuntimeException(sprintf("The method %s::%s is just a documentation stub and should not be invoked directly.", __CLASS__
, __FUNCTION__
));
1773 * This hook is called when a module-extension is re-enabled.
1774 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1775 * re-enablement of unrelated modules).
1777 public static function enable() {
1778 // Actually invoke via CRM_Extension_Manager_Module::callHook
1779 throw new \
RuntimeException(sprintf("The method %s::%s is just a documentation stub and should not be invoked directly.", __CLASS__
, __FUNCTION__
));
1783 * This hook is called when a module-extension is disabled.
1784 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1785 * disablement of unrelated modules).
1787 public static function disable() {
1788 // Actually invoke via CRM_Extension_Manager_Module::callHook
1789 throw new \
RuntimeException(sprintf("The method %s::%s is just a documentation stub and should not be invoked directly.", __CLASS__
, __FUNCTION__
));
1795 * This hook is called when the browser is being re-directed and allows the url
1798 * @param \Psr\Http\Message\UriInterface $url
1799 * @param array $context
1800 * Additional information about context
1801 * - output - if this is 'json' then it will return json.
1804 * the return value is ignored
1806 public static function alterRedirect(&$url, &$context) {
1807 return self
::singleton()->invoke(['url', 'context'], $url,
1808 $context, self
::$_nullObject,
1809 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1810 'civicrm_alterRedirect'
1821 public static function alterReportVar($varType, &$var, &$object) {
1822 return self
::singleton()->invoke(['varType', 'var', 'object'], $varType, $var, $object,
1824 self
::$_nullObject, self
::$_nullObject,
1825 'civicrm_alterReportVar'
1830 * This hook is called to drive database upgrades for extension-modules.
1833 * The type of operation being performed; 'check' or 'enqueue'.
1834 * @param CRM_Queue_Queue $queue
1835 * (for 'enqueue') the modifiable list of pending up upgrade tasks.
1838 * NULL, if $op is 'enqueue'.
1839 * TRUE, if $op is 'check' and upgrades are pending.
1840 * FALSE, if $op is 'check' and upgrades are not pending.
1842 public static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1843 return self
::singleton()->invoke(['op', 'queue'], $op, $queue,
1844 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1851 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1853 * @param array $params
1854 * The mailing parameters. Array fields include: groupName, from, toName,
1855 * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1856 * attachments (array)
1860 public static function postEmailSend(&$params) {
1861 return self
::singleton()->invoke(['params'], $params,
1862 self
::$_nullObject, self
::$_nullObject,
1863 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1864 'civicrm_postEmailSend'
1869 * This hook is called when a CiviMail mailing has completed
1871 * @param int $mailingId
1876 public static function postMailing($mailingId) {
1877 return self
::singleton()->invoke(['mailingId'], $mailingId,
1878 self
::$_nullObject, self
::$_nullObject,
1879 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1880 'civicrm_postMailing'
1885 * This hook is called when Settings specifications are loaded.
1887 * @param array $settingsFolders
1888 * List of paths from which to derive metadata
1892 public static function alterSettingsFolders(&$settingsFolders) {
1893 return self
::singleton()->invoke(['settingsFolders'], $settingsFolders,
1894 self
::$_nullObject, self
::$_nullObject,
1895 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1896 'civicrm_alterSettingsFolders'
1901 * This hook is called when Settings have been loaded from the xml
1902 * It is an opportunity for hooks to alter the data
1904 * @param array $settingsMetaData
1905 * Settings Metadata.
1906 * @param int $domainID
1907 * @param mixed $profile
1911 public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1912 return self
::singleton()->invoke(['settingsMetaData', 'domainID', 'profile'], $settingsMetaData,
1913 $domainID, $profile,
1914 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1915 'civicrm_alterSettingsMetaData'
1920 * This hook is called before running an api call.
1922 * @param API_Wrapper[] $wrappers
1923 * (see CRM_Utils_API_ReloadOption as an example)
1924 * @param mixed $apiRequest
1927 * The return value is ignored
1929 public static function apiWrappers(&$wrappers, $apiRequest) {
1930 return self
::singleton()
1931 ->invoke(['wrappers', 'apiRequest'], $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1932 self
::$_nullObject, 'civicrm_apiWrappers'
1937 * This hook is called before running pending cron jobs.
1939 * @param CRM_Core_JobManager $jobManager
1942 * The return value is ignored.
1944 public static function cron($jobManager) {
1945 return self
::singleton()->invoke(['jobManager'],
1946 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1952 * This hook is called when loading CMS permissions; use this hook to modify
1953 * the array of system permissions for CiviCRM.
1955 * @param array $permissions
1956 * Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1957 * the format of this array.
1960 * The return value is ignored
1962 public static function permission(&$permissions) {
1963 return self
::singleton()->invoke(['permissions'], $permissions,
1964 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1965 'civicrm_permission'
1970 * This hook is called when checking permissions; use this hook to dynamically
1971 * escalate user permissions in certain use cases (cf. CRM-19256).
1973 * @param string $permission
1974 * The name of an atomic permission, ie. 'access deleted contacts'
1975 * @param bool $granted
1976 * Whether this permission is currently granted. The hook can change this value.
1977 * @param int $contactId
1978 * Contact whose permissions we are checking (if null, assume current user).
1981 * The return value is ignored
1983 public static function permission_check($permission, &$granted, $contactId) {
1984 return self
::singleton()->invoke(['permission', 'granted', 'contactId'], $permission, $granted, $contactId,
1985 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1986 'civicrm_permission_check'
1991 * @param CRM_Core_Exception $exception
1992 * @param mixed $request
1993 * Reserved for future use.
1995 public static function unhandledException($exception, $request = NULL) {
1996 $event = new \Civi\Core\Event\
UnhandledExceptionEvent($exception, self
::$_nullObject);
1997 \Civi
::dispatcher()->dispatch('hook_civicrm_unhandled_exception', $event);
2001 * This hook is called for declaring managed entities via API.
2003 * Note: This is a pre-boot hook. It will dispatch via the extension/module
2004 * subsystem but *not* the Symfony EventDispatcher.
2006 * @param array[] $entityTypes
2007 * List of entity types; each entity-type is an array with keys:
2008 * - name: string, a unique short name (e.g. "ReportInstance")
2009 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
2010 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
2011 * - fields_callback: array, list of callables which manipulates field list
2012 * - links_callback: array, list of callables which manipulates fk list
2015 * The return value is ignored
2017 public static function entityTypes(&$entityTypes) {
2018 return self
::singleton()->invoke(['entityTypes'], $entityTypes, self
::$_nullObject, self
::$_nullObject,
2019 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
2024 * Build a description of available hooks.
2026 * @param \Civi\Core\CiviEventInspector $inspector
2028 public static function eventDefs($inspector) {
2029 $event = \Civi\Core\Event\GenericHookEvent
::create([
2030 'inspector' => $inspector,
2032 Civi
::dispatcher()->dispatch('hook_civicrm_eventDefs', $event);
2036 * This hook is called while preparing a profile form.
2038 * @param string $profileName
2041 public static function buildProfile($profileName) {
2042 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2043 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildProfile');
2047 * This hook is called while validating a profile form submission.
2049 * @param string $profileName
2052 public static function validateProfile($profileName) {
2053 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2054 self
::$_nullObject, self
::$_nullObject, 'civicrm_validateProfile');
2058 * This hook is called processing a valid profile form submission.
2060 * @param string $profileName
2063 public static function processProfile($profileName) {
2064 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2065 self
::$_nullObject, self
::$_nullObject, 'civicrm_processProfile');
2069 * This hook is called while preparing a read-only profile screen
2071 * @param string $profileName
2074 public static function viewProfile($profileName) {
2075 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2076 self
::$_nullObject, self
::$_nullObject, 'civicrm_viewProfile');
2080 * This hook is called while preparing a list of contacts (based on a profile)
2082 * @param string $profileName
2085 public static function searchProfile($profileName) {
2086 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2087 self
::$_nullObject, self
::$_nullObject, 'civicrm_searchProfile');
2091 * This hook is invoked when building a CiviCRM name badge.
2093 * @param string $labelName
2094 * String referencing name of badge format.
2095 * @param object $label
2096 * Reference to the label object.
2097 * @param array $format
2098 * Array of format data.
2099 * @param array $participant
2100 * Array of participant values.
2103 * the return value is ignored
2105 public static function alterBadge($labelName, &$label, &$format, &$participant) {
2106 return self
::singleton()
2107 ->invoke(['labelName', 'label', 'format', 'participant'], $labelName, $label, $format, $participant, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBadge');
2111 * This hook is called before encoding data in barcode.
2113 * @param array $data
2114 * Associated array of values available for encoding.
2115 * @param string $type
2116 * Type of barcode, classic barcode or QRcode.
2117 * @param string $context
2118 * Where this hooks is invoked.
2122 public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') {
2123 return self
::singleton()->invoke(['data', 'type', 'context'], $data, $type, $context, self
::$_nullObject,
2124 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBarcode');
2128 * Modify or replace the Mailer object used for outgoing mail.
2130 * @param object $mailer
2131 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
2132 * @param string $driver
2133 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
2134 * @param array $params
2135 * The default mailer config options
2138 * @see Mail::factory
2140 public static function alterMailer(&$mailer, $driver, $params) {
2141 return self
::singleton()
2142 ->invoke(['mailer', 'driver', 'params'], $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
2146 * This hook is called while building the core search query,
2147 * so hook implementers can provide their own query objects which alters/extends core search.
2149 * @param array $queryObjects
2150 * @param string $type
2154 public static function queryObjects(&$queryObjects, $type = 'Contact') {
2155 return self
::singleton()
2156 ->invoke(['queryObjects', 'type'], $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
2160 * This hook is called while viewing contact dashboard.
2162 * @param array $availableDashlets
2163 * List of dashlets; each is formatted per api/v3/Dashboard
2164 * @param array $defaultDashlets
2165 * List of dashlets; each is formatted per api/v3/DashboardContact
2169 public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
2170 return self
::singleton()
2171 ->invoke(['availableDashlets', 'defaultDashlets'], $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');
2175 * This hook is called before a case merge (or a case reassign)
2177 * @param int $mainContactId
2178 * @param int $mainCaseId
2179 * @param int $otherContactId
2180 * @param int $otherCaseId
2181 * @param bool $changeClient
2185 public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2186 return self
::singleton()
2187 ->invoke(['mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'], $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_pre_case_merge');
2191 * This hook is called after a case merge (or a case reassign)
2193 * @param int $mainContactId
2194 * @param int $mainCaseId
2195 * @param int $otherContactId
2196 * @param int $otherCaseId
2197 * @param bool $changeClient
2201 public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2202 return self
::singleton()
2203 ->invoke(['mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'], $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_post_case_merge');
2208 * Add a hook for altering the display name
2210 * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
2212 * @param string $displayName
2213 * @param int $contactId
2214 * @param object $dao
2215 * The contact object.
2219 public static function alterDisplayName(&$displayName, $contactId, $dao) {
2220 return self
::singleton()->invoke(['displayName', 'contactId', 'dao'],
2221 $displayName, $contactId, $dao, self
::$_nullObject, self
::$_nullObject,
2222 self
::$_nullObject, 'civicrm_contact_get_displayname'
2227 * Modify the CRM_Core_Resources settings data.
2229 * @param array $data
2230 * @see CRM_Core_Resources::addSetting
2232 public static function alterResourceSettings(&$data) {
2233 $event = \Civi\Core\Event\GenericHookEvent
::create([
2236 Civi
::dispatcher()->dispatch('hook_civicrm_alterResourceSettings', $event);
2240 * EXPERIMENTAL: This hook allows one to register additional Angular modules
2242 * @param array $angularModules
2243 * List of modules. Each module defines:
2244 * - ext: string, the CiviCRM extension which hosts the files.
2245 * - js: array, list of JS files or globs.
2246 * - css: array, list of CSS files or globs.
2247 * - partials: array, list of base-dirs containing HTML.
2248 * - partialsCallback: mixed, a callback function which generates a list of HTML
2249 * function(string $moduleName, array $moduleDefn) => array(string $file => string $html)
2250 * For future-proofing, use a serializable callback (e.g. string/array).
2251 * See also: Civi\Core\Resolver.
2252 * - requires: array, list of required Angular modules.
2253 * - basePages: array, uncondtionally load this module onto the given Angular pages. [v4.7.21+]
2254 * If omitted, default to "array('civicrm/a')" for backward compat.
2255 * For a utility that should only be loaded on-demand, use "array()".
2256 * For a utility that should be loaded in all pages use, "array('*')".
2259 * function mymod_civicrm_angularModules(&$angularModules) {
2260 * $angularModules['myAngularModule'] = array(
2261 * 'ext' => 'org.example.mymod',
2262 * 'js' => array('js/myAngularModule.js'),
2264 * $angularModules['myBigAngularModule'] = array(
2265 * 'ext' => 'org.example.mymod',
2266 * 'js' => array('js/part1.js', 'js/part2.js', 'ext://other.ext.name/file.js', 'assetBuilder://dynamicAsset.js'),
2267 * 'css' => array('css/myAngularModule.css', 'ext://other.ext.name/file.css', 'assetBuilder://dynamicAsset.css'),
2268 * 'partials' => array('partials/myBigAngularModule'),
2269 * 'requires' => array('otherModuleA', 'otherModuleB'),
2270 * 'basePages' => array('civicrm/a'),
2276 * the return value is ignored
2278 public static function angularModules(&$angularModules) {
2279 return self
::singleton()->invoke(['angularModules'], $angularModules,
2280 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2281 'civicrm_angularModules'
2286 * Alter the definition of some Angular HTML partials.
2288 * @param \Civi\Angular\Manager $angular
2291 * function example_civicrm_alterAngular($angular) {
2292 * $changeSet = \Civi\Angular\ChangeSet::create('mychanges')
2293 * ->alterHtml('~/crmMailing/EditMailingCtrl/2step.html', function(phpQueryObject $doc) {
2294 * $doc->find('[ng-form="crmMailingSubform"]')->attr('cat-stevens', 'ts(\'wild world\')');
2297 * $angular->add($changeSet);
2301 public static function alterAngular($angular) {
2302 $event = \Civi\Core\Event\GenericHookEvent
::create([
2303 'angular' => $angular,
2305 Civi
::dispatcher()->dispatch('hook_civicrm_alterAngular', $event);
2309 * This hook is called when building a link to a semi-static asset.
2311 * @param string $asset
2312 * The name of the asset.
2313 * Ex: 'angular.json'
2314 * @param array $params
2315 * List of optional arguments which influence the content.
2317 * the return value is ignored
2319 public static function getAssetUrl(&$asset, &$params) {
2320 return self
::singleton()->invoke(['asset', 'params'],
2321 $asset, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2322 'civicrm_getAssetUrl'
2327 * This hook is called whenever the system builds a new copy of
2328 * semi-static asset.
2330 * @param string $asset
2331 * The name of the asset.
2332 * Ex: 'angular.json'
2333 * @param array $params
2334 * List of optional arguments which influence the content.
2335 * Note: Params are immutable because they are part of the cache-key.
2336 * @param string $mimeType
2337 * Initially, NULL. Modify to specify the mime-type.
2338 * @param string $content
2339 * Initially, NULL. Modify to specify the rendered content.
2341 * the return value is ignored
2343 public static function buildAsset($asset, $params, &$mimeType, &$content) {
2344 return self
::singleton()->invoke(['asset', 'params', 'mimeType', 'content'],
2345 $asset, $params, $mimeType, $content, self
::$_nullObject, self
::$_nullObject,
2346 'civicrm_buildAsset'
2351 * This hook fires whenever a record in a case changes.
2353 * @param \Civi\CCase\Analyzer $analyzer
2354 * A bundle of data about the case (such as the case and activity records).
2356 public static function caseChange(\Civi\CCase\Analyzer
$analyzer) {
2357 $event = new \Civi\CCase\Event\
CaseChangeEvent($analyzer);
2358 \Civi
::dispatcher()->dispatch('hook_civicrm_caseChange', $event);
2362 * Generate a default CRUD URL for an entity.
2364 * @param array $spec
2366 * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
2367 * - entity_table: string
2369 * @param CRM_Core_DAO $bao
2370 * @param array $link
2371 * To define the link, add these keys to $link:.
2375 * - url: string (used in lieu of "path"/"query")
2376 * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
2379 public static function crudLink($spec, $bao, &$link) {
2380 return self
::singleton()->invoke(['spec', 'bao', 'link'], $spec, $bao, $link,
2381 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2387 * Modify the CiviCRM container - add new services, parameters, extensions, etc.
2390 * use Symfony\Component\Config\Resource\FileResource;
2391 * use Symfony\Component\DependencyInjection\Definition;
2393 * function mymodule_civicrm_container($container) {
2394 * $container->addResource(new FileResource(__FILE__));
2395 * $container->setDefinition('mysvc', new Definition('My\Class', array()));
2399 * Tip: The container configuration will be compiled/cached. The default cache
2400 * behavior is aggressive. When you first implement the hook, be sure to
2401 * flush the cache. Additionally, you should relax caching during development.
2402 * In `civicrm.settings.php`, set define('CIVICRM_CONTAINER_CACHE', 'auto').
2404 * Note: This is a preboot hook. It will dispatch via the extension/module
2405 * subsystem but *not* the Symfony EventDispatcher.
2407 * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
2408 * @see http://symfony.com/doc/current/components/dependency_injection/index.html
2410 public static function container(\Symfony\Component\DependencyInjection\ContainerBuilder
$container) {
2411 self
::singleton()->invoke(['container'], $container, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_container');
2415 * @param array $fileSearches CRM_Core_FileSearchInterface
2418 public static function fileSearches(&$fileSearches) {
2419 return self
::singleton()->invoke(['fileSearches'], $fileSearches,
2420 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2421 'civicrm_fileSearches'
2426 * Check system status.
2428 * @param array $messages
2429 * Array<CRM_Utils_Check_Message>. A list of messages regarding system status.
2432 public static function check(&$messages) {
2433 return self
::singleton()
2434 ->invoke(['messages'], $messages, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_check');
2438 * This hook is called when a query string of the CSV Batch export is generated.
2440 * @param string $query
2444 public static function batchQuery(&$query) {
2445 return self
::singleton()->invoke(['query'], $query, self
::$_nullObject,
2446 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2447 'civicrm_batchQuery'
2452 * This hook is called to alter Deferred revenue item values just before they are
2453 * inserted in civicrm_financial_trxn table
2455 * @param array $deferredRevenues
2457 * @param array $contributionDetails
2459 * @param bool $update
2461 * @param string $context
2465 public static function alterDeferredRevenueItems(&$deferredRevenues, $contributionDetails, $update, $context) {
2466 return self
::singleton()->invoke(['deferredRevenues', 'contributionDetails', 'update', 'context'], $deferredRevenues, $contributionDetails, $update, $context,
2467 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterDeferredRevenueItems'
2472 * This hook is called when the entries of the CSV Batch export are mapped.
2474 * @param array $results
2475 * @param array $items
2479 public static function batchItems(&$results, &$items) {
2480 return self
::singleton()->invoke(['results', 'items'], $results, $items,
2481 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2482 'civicrm_batchItems'
2487 * This hook is called when core resources are being loaded
2489 * @see CRM_Core_Resources::coreResourceList
2491 * @param array $list
2492 * @param string $region
2494 public static function coreResourceList(&$list, $region) {
2495 self
::singleton()->invoke(['list', 'region'], $list, $region,
2496 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2497 'civicrm_coreResourceList'
2502 * Allows the list of filters on the EntityRef widget to be altered.
2504 * @see CRM_Core_Resources::entityRefFilters
2506 * @param array $filters
2507 * @param array $links
2509 public static function entityRefFilters(&$filters, &$links = NULL) {
2510 self
::singleton()->invoke(['filters', 'links'], $filters, $links, self
::$_nullObject,
2511 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2512 'civicrm_entityRefFilters'
2517 * This hook is called for bypass a few civicrm urls from IDS check.
2519 * @param array $skip list of civicrm urls
2523 public static function idsException(&$skip) {
2524 return self
::singleton()->invoke(['skip'], $skip, self
::$_nullObject,
2525 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2526 'civicrm_idsException'
2531 * This hook is called when a geocoder's format method is called.
2533 * @param string $geoProvider
2534 * @param array $values
2535 * @param SimpleXMLElement $xml
2539 public static function geocoderFormat($geoProvider, &$values, $xml) {
2540 return self
::singleton()->invoke(['geoProvider', 'values', 'xml'], $geoProvider, $values, $xml,
2541 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2542 'civicrm_geocoderFormat'
2547 * This hook is called before an inbound SMS is processed.
2549 * @param \CRM_SMS_Message $message
2550 * An SMS message received
2553 public static function inboundSMS(&$message) {
2554 return self
::singleton()->invoke(['message'], $message, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_inboundSMS');
2558 * This hook is called to modify api params of EntityRef form field
2560 * @param array $params
2561 * @param string $formName
2564 public static function alterEntityRefParams(&$params, $formName) {
2565 return self
::singleton()->invoke(['params', 'formName'], $params, $formName,
2566 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2567 'civicrm_alterEntityRefParams'
2572 * This hook is called before a scheduled job is executed
2574 * @param CRM_Core_DAO_Job $job
2575 * The job to be executed
2576 * @param array $params
2577 * The arguments to be given to the job
2579 public static function preJob($job, $params) {
2580 return self
::singleton()->invoke(['job', 'params'], $job, $params,
2581 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2587 * This hook is called after a scheduled job is executed
2589 * @param CRM_Core_DAO_Job $job
2590 * The job that was executed
2591 * @param array $params
2592 * The arguments given to the job
2593 * @param array $result
2594 * The result of the API call, or the thrown exception if any
2596 public static function postJob($job, $params, $result) {
2597 return self
::singleton()->invoke(['job', 'params', 'result'], $job, $params, $result,
2598 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2604 * This hook is called before and after constructing mail recipients.
2605 * Allows user to alter filter and/or search query to fetch mail recipients
2607 * @param CRM_Mailing_DAO_Mailing $mailingObject
2608 * @param array $criteria
2609 * A list of SQL criteria; you can add/remove/replace/modify criteria.
2610 * Array(string $name => CRM_Utils_SQL_Select $criterion).
2611 * Ex: array('do_not_email' => CRM_Utils_SQL_Select::fragment()->where("$contact.do_not_email = 0")).
2612 * @param string $context
2616 public static function alterMailingRecipients(&$mailingObject, &$criteria, $context) {
2617 return self
::singleton()->invoke(['mailingObject', 'params', 'context'],
2618 $mailingObject, $criteria, $context,
2619 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2620 'civicrm_alterMailingRecipients'
2625 * ALlow Extensions to custom process IPN hook data such as sending Google Analyitcs information based on the IPN
2626 * @param array $IPNData - Array of IPN Data
2629 public static function postIPNProcess(&$IPNData) {
2630 return self
::singleton()->invoke(['IPNData'],
2631 $IPNData, self
::$_nullObject, self
::$_nullObject,
2632 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2633 'civicrm_postIPNProcess'
2638 * Allow extensions to modify the array of acceptable fields to be included on profiles
2639 * @param array $fields
2640 * format is [Entity => array of DAO fields]
2643 public static function alterUFFields(&$fields) {
2644 return self
::singleton()->invoke(['fields'],
2645 $fields, self
::$_nullObject, self
::$_nullObject,
2646 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2647 'civicrm_alterUFFields'
2652 * This hook is called to alter Custom field value before its displayed.
2654 * @param string $displayValue
2655 * @param mixed $value
2656 * @param int $entityId
2657 * @param array $fieldInfo
2661 public static function alterCustomFieldDisplayValue(&$displayValue, $value, $entityId, $fieldInfo) {
2662 return self
::singleton()->invoke(
2663 ['displayValue', 'value', 'entityId', 'fieldInfo'],
2664 $displayValue, $value, $entityId, $fieldInfo, self
::$_nullObject,
2665 self
::$_nullObject, 'civicrm_alterCustomFieldDisplayValue'