3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
30 * @package CiviCRM_Hook
31 * @copyright CiviCRM LLC (c) 2004-2015
35 abstract class CRM_Utils_Hook
{
37 // Allowed values for dashboard hook content placement
38 // Default - place content below activity list
39 const DASHBOARD_BELOW
= 1;
40 // Place content above activity list
41 const DASHBOARD_ABOVE
= 2;
42 // Don't display activity list at all
43 const DASHBOARD_REPLACE
= 3;
45 // by default - place content below existing content
46 const SUMMARY_BELOW
= 1;
47 // pace hook content above
48 const SUMMARY_ABOVE
= 2;
49 // create your own summarys
50 const SUMMARY_REPLACE
= 3;
52 static $_nullObject = NULL;
55 * We only need one instance of this object. So we use the singleton
56 * pattern and cache the instance in this variable
60 static private $_singleton = NULL;
65 private $commonIncluded = FALSE;
70 private $commonCiviModules = array();
73 * Constructor and getter for the singleton instance.
78 * An instance of $config->userHookClass
80 public static function singleton($fresh = FALSE) {
81 if (self
::$_singleton == NULL ||
$fresh) {
82 $config = CRM_Core_Config
::singleton();
83 $class = $config->userHookClass
;
84 require_once str_replace('_', DIRECTORY_SEPARATOR
, $config->userHookClass
) . '.php';
85 self
::$_singleton = new $class();
87 return self
::$_singleton;
93 * @param int $numParams
94 * Number of parameters to pass to the hook.
96 * Parameter to be passed to the hook.
98 * Parameter to be passed to the hook.
100 * Parameter to be passed to the hook.
102 * Parameter to be passed to the hook.
104 * Parameter to be passed to the hook.
106 * Parameter to be passed to the hook.
107 * @param string $fnSuffix
108 * Function suffix, this is effectively the hook name.
112 public abstract function invoke(
114 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
119 * @param array $numParams
131 public function commonInvoke(
133 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
137 $this->commonBuildModuleList($fnPrefix);
139 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
140 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
145 * Build the list of modules to be processed for hooks.
147 * @param string $fnPrefix
149 public function commonBuildModuleList($fnPrefix) {
150 if (!$this->commonIncluded
) {
151 // include external file
152 $this->commonIncluded
= TRUE;
154 $config = CRM_Core_Config
::singleton();
155 if (!empty($config->customPHPPathDir
) &&
156 file_exists("{$config->customPHPPathDir}/civicrmHooks.php")
158 @include_once
"civicrmHooks.php";
161 if (!empty($fnPrefix)) {
162 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
165 $this->requireCiviModules($this->commonCiviModules
);
170 * @param $civiModules
172 * @param array $numParams
182 public function runHooks(
183 $civiModules, $fnSuffix, $numParams,
184 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
186 // $civiModules is *not* passed by reference because runHooks
187 // must be reentrant. PHP is finicky about running
188 // multiple loops over the same variable. The circumstances
189 // to reproduce the issue are pretty intricate.
192 if ($civiModules !== NULL) {
193 foreach ($civiModules as $module) {
194 $fnName = "{$module}_{$fnSuffix}";
195 if (function_exists($fnName)) {
197 switch ($numParams) {
199 $fResult = $fnName();
203 $fResult = $fnName($arg1);
207 $fResult = $fnName($arg1, $arg2);
211 $fResult = $fnName($arg1, $arg2, $arg3);
215 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
219 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
223 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
227 CRM_Core_Error
::fatal(ts('Invalid hook invocation'));
231 if (!empty($fResult) &&
234 $result = array_merge($result, $fResult);
240 return empty($result) ?
TRUE : $result;
246 public function requireCiviModules(&$moduleList) {
247 $civiModules = CRM_Core_PseudoConstant
::getModuleExtensions();
248 foreach ($civiModules as $civiModule) {
249 if (!file_exists($civiModule['filePath'])) {
250 CRM_Core_Session
::setStatus(
251 ts('Error loading module file (%1). Please restore the file or disable the module.',
252 array(1 => $civiModule['filePath'])),
253 ts('Warning'), 'error');
256 include_once $civiModule['filePath'];
257 $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
262 * This hook is called before a db write on some core objects.
263 * This hook does not allow the abort of the operation
266 * The type of operation being performed.
267 * @param string $objectName
268 * The name of the object.
270 * The object id if available.
271 * @param array $params
272 * The parameters used for object creation / editing.
275 * the return value is ignored
277 public static function pre($op, $objectName, $id, &$params) {
278 $event = new \Civi\Core\Event\
PreEvent($op, $objectName, $id, $params);
279 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_pre", $event);
280 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_pre::$objectName", $event);
281 return self
::singleton()
282 ->invoke(4, $op, $objectName, $id, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_pre');
286 * This hook is called after a db write on some core objects.
289 * The type of operation being performed.
290 * @param string $objectName
291 * The name of the object.
292 * @param int $objectId
293 * The unique identifier for the object.
294 * @param object $objectRef
295 * The reference to the object if available.
298 * based on op. pre-hooks return a boolean or
299 * an error message which aborts the operation
301 public static function post($op, $objectName, $objectId, &$objectRef) {
302 $event = new \Civi\Core\Event\
PostEvent($op, $objectName, $objectId, $objectRef);
303 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_post", $event);
304 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_post::$objectName", $event);
305 return self
::singleton()
306 ->invoke(4, $op, $objectName, $objectId, $objectRef, self
::$_nullObject, self
::$_nullObject, 'civicrm_post');
310 * This hook retrieves links from other modules and injects it into.
311 * the view contact tabs
314 * The type of operation being performed.
315 * @param string $objectName
316 * The name of the object.
317 * @param int $objectId
318 * The unique identifier for the object.
319 * @param array $links
320 * (optional) the links array (introduced in v3.2).
322 * (optional) the bitmask to show/hide links.
323 * @param array $values
324 * (optional) the values to fill the links.
327 * the return value is ignored
329 public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = array()) {
330 return self
::singleton()->invoke(6, $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
334 * This hook is invoked during the CiviCRM form preProcess phase.
336 * @param string $formName
337 * The name of the form.
338 * @param CRM_Core_Form $form
339 * Reference to the form object.
342 * the return value is ignored
344 public static function preProcess($formName, &$form) {
345 return self
::singleton()
346 ->invoke(2, $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_preProcess');
350 * This hook is invoked when building a CiviCRM form. This hook should also
351 * be used to set the default values of a form element
353 * @param string $formName
354 * The name of the form.
355 * @param CRM_Core_Form $form
356 * Reference to the form object.
359 * the return value is ignored
361 public static function buildForm($formName, &$form) {
362 return self
::singleton()->invoke(2, $formName, $form,
363 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
369 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
370 * any form elements, this hook should save the values in the database
372 * @param string $formName
373 * The name of the form.
374 * @param CRM_Core_Form $form
375 * Reference to the form object.
378 * the return value is ignored
380 public static function postProcess($formName, &$form) {
381 return self
::singleton()->invoke(2, $formName, $form,
382 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
383 'civicrm_postProcess'
388 * This hook is invoked during all CiviCRM form validation. An array of errors
389 * detected is returned. Else we assume validation succeeded.
391 * @param string $formName
392 * The name of the form.
393 * @param array &$fields the POST parameters as filtered by QF
394 * @param array &$files the FILES parameters as sent in by POST
395 * @param array &$form the form object
398 * formRule hooks return a boolean or
399 * an array of error messages which display a QF Error
401 public static function validate($formName, &$fields, &$files, &$form) {
402 return self
::singleton()
403 ->invoke(4, $formName, $fields, $files, $form, self
::$_nullObject, self
::$_nullObject, 'civicrm_validate');
407 * This hook is invoked during all CiviCRM form validation. An array of errors
408 * detected is returned. Else we assume validation succeeded.
410 * @param string $formName
411 * The name of the form.
412 * @param array &$fields the POST parameters as filtered by QF
413 * @param array &$files the FILES parameters as sent in by POST
414 * @param array &$form the form object
415 * @param array &$errors the array of errors.
418 * formRule hooks return a boolean or
419 * an array of error messages which display a QF Error
421 public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
422 return self
::singleton()
423 ->invoke(5, $formName, $fields, $files, $form, $errors, self
::$_nullObject, 'civicrm_validateForm');
427 * This hook is called after a db write on a custom table.
430 * The type of operation being performed.
431 * @param string $groupID
432 * The custom group ID.
433 * @param object $entityID
434 * The entityID of the row in the custom table.
435 * @param array $params
436 * The parameters that were sent into the calling function.
439 * the return value is ignored
441 public static function custom($op, $groupID, $entityID, &$params) {
442 return self
::singleton()
443 ->invoke(4, $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_custom');
447 * This hook is called when composing the ACL where clause to restrict
448 * visibility of contacts to the logged in user
451 * The type of permission needed.
452 * @param array $tables
453 * (reference ) add the tables that are needed for the select clause.
454 * @param array $whereTables
455 * (reference ) add the tables that are needed for the where clause.
456 * @param int $contactID
457 * The contactID for whom the check is made.
458 * @param string $where
459 * The currrent where clause.
462 * the return value is ignored
464 public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
465 return self
::singleton()
466 ->invoke(5, $type, $tables, $whereTables, $contactID, $where, self
::$_nullObject, 'civicrm_aclWhereClause');
470 * This hook is called when composing the ACL where clause to restrict
471 * visibility of contacts to the logged in user
474 * The type of permission needed.
475 * @param int $contactID
476 * The contactID for whom the check is made.
477 * @param string $tableName
478 * The tableName which is being permissioned.
479 * @param array $allGroups
480 * The set of all the objects for the above table.
481 * @param array $currentGroups
482 * The set of objects that are currently permissioned for this contact.
485 * the return value is ignored
487 public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
488 return self
::singleton()
489 ->invoke(5, $type, $contactID, $tableName, $allGroups, $currentGroups, self
::$_nullObject, 'civicrm_aclGroup');
493 * This hook is called when building the menu table.
495 * @param array $files
496 * The current set of files to process.
499 * the return value is ignored
501 public static function xmlMenu(&$files) {
502 return self
::singleton()->invoke(1, $files,
503 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
509 * This hook is called for declaring managed entities via API.
511 * @param array $entities
512 * List of pending entities. Each entity is an array with keys:
513 * + '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")
514 * + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
515 * + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
516 * + 'params': array, the entity data as supported by the CiviCRM API
517 * + 'update' (v4.5+): string, a policy which describes when to update records
518 * - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
519 * - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
520 * + '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)
521 * - 'always' (default): always delete orphaned records
522 * - 'never': never delete orphaned records
523 * - '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.)
526 * the return value is ignored
528 public static function managed(&$entities) {
529 return self
::singleton()->invoke(1, $entities,
530 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
536 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
538 * @param int $contactID
539 * The contactID for whom the dashboard is being rendered.
540 * @param int $contentPlacement
541 * (output parameter) where should the hook content be displayed.
542 * relative to the activity list
545 * the html snippet to include in the dashboard
547 public static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
548 $retval = self
::singleton()->invoke(2, $contactID, $contentPlacement,
549 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
554 * Note we need this seemingly unnecessary code because in the event that the implementation
555 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
556 * though we have a default value in this function's declaration above.
558 if (!isset($contentPlacement)) {
559 $contentPlacement = self
::DASHBOARD_BELOW
;
566 * This hook is called before storing recently viewed items.
568 * @param array $recentArray
569 * An array of recently viewed or processed items, for in place modification.
573 public static function recent(&$recentArray) {
574 return self
::singleton()->invoke(1, $recentArray,
575 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
581 * Determine how many other records refer to a given record.
583 * @param CRM_Core_DAO $dao
584 * The item for which we want a reference count.
585 * @param array $refCounts
586 * Each item in the array is an Array with keys:
587 * - name: string, eg "sql:civicrm_email:contact_id"
588 * - type: string, eg "sql"
589 * - count: int, eg "5" if there are 5 email addresses that refer to $dao
592 * Return is not really intended to be used.
594 public static function referenceCounts($dao, &$refCounts) {
595 return self
::singleton()->invoke(2, $dao, $refCounts,
596 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
597 'civicrm_referenceCounts'
602 * This hook is called when building the amount structure for a Contribution or Event Page.
604 * @param int $pageType
605 * Is this a contribution or event page.
606 * @param CRM_Core_Form $form
607 * Reference to the form object.
608 * @param array $amount
609 * The amount structure to be displayed.
613 public static function buildAmount($pageType, &$form, &$amount) {
614 return self
::singleton()->invoke(3, $pageType, $form, $amount, self
::$_nullObject,
615 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildAmount');
619 * This hook is called when building the state list for a particular country.
621 * @param array $countryID
622 * The country id whose states are being selected.
627 public static function buildStateProvinceForCountry($countryID, &$states) {
628 return self
::singleton()->invoke(2, $countryID, $states,
629 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
630 'civicrm_buildStateProvinceForCountry'
635 * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
638 * The array of tabs that will be displayed.
639 * @param int $contactID
640 * The contactID for whom the dashboard is being rendered.
644 public static function tabs(&$tabs, $contactID) {
645 return self
::singleton()->invoke(2, $tabs, $contactID,
646 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabs'
651 * This hook is called when rendering the tabs used for events and potentially
652 * contribution pages, etc.
654 * @param string $tabsetName
655 * Name of the screen or visual element.
657 * Tabs that will be displayed.
658 * @param array $context
659 * Extra data about the screen or context in which the tab is used.
663 public static function tabset($tabsetName, &$tabs, $context) {
664 return self
::singleton()->invoke(3, $tabsetName, $tabs,
665 $context, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
670 * This hook is called when sending an email / printing labels
672 * @param array $tokens
673 * The list of tokens that can be used for the contact.
677 public static function tokens(&$tokens) {
678 return self
::singleton()->invoke(1, $tokens,
679 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
684 * This hook is called when sending an email / printing labels to get the values for all the
685 * tokens returned by the 'tokens' hook
687 * @param array $details
688 * The array to store the token values indexed by contactIDs (unless it a single).
689 * @param array $contactIDs
690 * An array of contactIDs.
692 * The jobID if this is associated with a CiviMail mailing.
693 * @param array $tokens
694 * The list of tokens associated with the content.
695 * @param string $className
696 * The top level className from where the hook is invoked.
700 public static function tokenValues(
707 return self
::singleton()
708 ->invoke(5, $details, $contactIDs, $jobID, $tokens, $className, self
::$_nullObject, 'civicrm_tokenValues');
712 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
715 * @param object $page
716 * The page that will be rendered.
720 public static function pageRun(&$page) {
721 return self
::singleton()->invoke(1, $page,
722 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
728 * This hook is called after a copy of an object has been made. The current objects are
729 * Event, Contribution Page and UFGroup
731 * @param string $objectName
732 * Name of the object.
733 * @param object $object
734 * Reference to the copy.
738 public static function copy($objectName, &$object) {
739 return self
::singleton()->invoke(2, $objectName, $object,
740 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
746 * This hook is called when a contact unsubscribes from a mailing. It allows modules
747 * to override what the contacts are removed from.
751 * @param int $mailingId
752 * The id of the mailing to unsub from
753 * @param int $contactId
754 * The id of the contact who is unsubscribing
755 * @param array|int $groups
756 * Groups the contact will be removed from.
757 * @param array|int $baseGroups
758 * Base groups (used in smart mailings) the contact will be removed from.
763 public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
764 return self
::singleton()
765 ->invoke(5, $op, $mailingId, $contactId, $groups, $baseGroups, self
::$_nullObject, 'civicrm_unsubscribeGroups');
769 * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox,
772 * @param int $customFieldID
773 * The custom field ID.
774 * @param array $options
775 * The current set of options for that custom field.
776 * You can add/remove existing options.
777 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
778 * to be careful to not overwrite the array.
779 * Only add/edit/remove the specific field options you intend to affect.
780 * @param bool $detailedFormat
782 * the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
783 * @param array $selectAttributes
784 * Contain select attribute(s) if any.
788 public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = array()) {
789 return self
::singleton()->invoke(3, $customFieldID, $options, $detailedFormat,
790 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
791 'civicrm_customFieldOptions'
797 * This hook is called to display the list of actions allowed after doing a search.
798 * This allows the module developer to inject additional actions or to remove existing actions.
800 * @param string $objectType
801 * The object type for this search.
802 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
803 * @param array $tasks
804 * The current set of tasks for that custom field.
805 * You can add/remove existing tasks.
806 * Each task needs to have a title (eg 'title' => ts( 'Add Contacts to Group')) and a class
807 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
808 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
809 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
810 * found in CRM/$objectType/Task.php.
814 public static function searchTasks($objectType, &$tasks) {
815 return self
::singleton()->invoke(2, $objectType, $tasks,
816 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
817 'civicrm_searchTasks'
823 * @param array $params
827 public static function eventDiscount(&$form, &$params) {
828 return self
::singleton()->invoke(2, $form, $params,
829 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
830 'civicrm_eventDiscount'
835 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
838 * The form object for which groups / mailings being displayed
839 * @param array $groups
840 * The list of groups being included / excluded
841 * @param array $mailings
842 * The list of mailings being included / excluded
846 public static function mailingGroups(&$form, &$groups, &$mailings) {
847 return self
::singleton()->invoke(3, $form, $groups, $mailings,
848 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
849 'civicrm_mailingGroups'
854 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
856 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
857 * You can use it to alter the membership types when first loaded, or after submission
858 * (for example if you want to gather data in the form and use it to alter the fees).
861 * The form object that is presenting the page
862 * @param array $membershipTypes
863 * The array of membership types and their amount
867 public static function membershipTypeValues(&$form, &$membershipTypes) {
868 return self
::singleton()->invoke(2, $form, $membershipTypes,
869 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
870 'civicrm_membershipTypeValues'
875 * This hook is called when rendering the contact summary.
877 * @param int $contactID
878 * The contactID for whom the summary is being rendered
879 * @param mixed $content
880 * @param int $contentPlacement
881 * Specifies where the hook content should be displayed relative to the
885 * The html snippet to include in the contact summary
887 public static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
888 return self
::singleton()->invoke(3, $contactID, $content, $contentPlacement,
889 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
895 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
896 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
897 * If you want to limit the contacts returned to a specific group, or some other criteria
898 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
899 * The hook is called when the query is executed to get the list of contacts to display.
901 * @param mixed $query
902 * - the query that will be executed (input and output parameter);.
903 * It's important to realize that the ACL clause is built prior to this hook being fired,
904 * so your query will ignore any ACL rules that may be defined.
905 * Your query must return two columns:
906 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
908 * @param string $name
909 * The name string to execute the query against (this is the value being typed in by the user).
910 * @param string $context
911 * The context in which this ajax call is being made (for example: 'customfield', 'caseview').
913 * The id of the object for which the call is being made.
914 * For custom fields, it will be the custom field id
918 public static function contactListQuery(&$query, $name, $context, $id) {
919 return self
::singleton()->invoke(4, $query, $name, $context, $id,
920 self
::$_nullObject, self
::$_nullObject,
921 'civicrm_contactListQuery'
926 * Hook definition for altering payment parameters before talking to a payment processor back end.
928 * Definition will look like this:
930 * function hook_civicrm_alterPaymentProcessorParams(
936 * @param CRM_Core_Payment $paymentObj
937 * Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
938 * See discussion in CRM-16224 as to whether $paymentObj should be passed by reference.
939 * @param array &$rawParams
940 * array of params as passed to to the processor
941 * @param array &$cookedParams
942 * params after the processor code has translated them into its own key/value pairs
945 * This return is not really intended to be used.
947 public static function alterPaymentProcessorParams(
952 return self
::singleton()->invoke(3, $paymentObj, $rawParams, $cookedParams,
953 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
954 'civicrm_alterPaymentProcessorParams'
959 * This hook is called when an email is about to be sent by CiviCRM.
961 * @param array $params
962 * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
963 * returnPath, replyTo, headers, attachments (array)
964 * @param string $context
965 * The context in which the hook is being invoked, eg 'civimail'.
969 public static function alterMailParams(&$params, $context = NULL) {
970 return self
::singleton()->invoke(2, $params, $context,
971 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
972 'civicrm_alterMailParams'
977 * This hook is called when membership status is being calculated.
979 * @param array $membershipStatus
980 * Membership status details as determined - alter if required.
981 * @param array $arguments
982 * Arguments passed in to calculate date.
987 * - 'exclude_is_admin'
988 * - 'membership_type_id'
989 * @param array $membership
990 * Membership details from the calling function.
994 public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
995 return self
::singleton()->invoke(3, $membershipStatus, $arguments,
996 $membership, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
997 'civicrm_alterCalculatedMembershipStatus'
1002 * This hook is called when rendering the Manage Case screen.
1004 * @param int $caseID
1008 * Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
1009 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
1011 public static function caseSummary($caseID) {
1012 return self
::singleton()->invoke(1, $caseID,
1013 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1014 'civicrm_caseSummary'
1019 * This hook is called when locating CiviCase types.
1021 * @param array $caseTypes
1025 public static function caseTypes(&$caseTypes) {
1026 return self
::singleton()
1027 ->invoke(1, $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
1031 * This hook is called soon after the CRM_Core_Config object has ben initialized.
1032 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
1034 * @param CRM_Core_Config|array $config
1039 public static function config(&$config) {
1040 return self
::singleton()->invoke(1, $config,
1041 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1047 * This hooks allows to change option values.
1049 * @param array $options
1050 * Associated array of option values / id
1051 * @param string $name
1056 public static function optionValues(&$options, $name) {
1057 return self
::singleton()->invoke(2, $options, $name,
1058 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1059 'civicrm_optionValues'
1064 * This hook allows modification of the navigation menu.
1066 * @param array $params
1067 * Associated array of navigation menu entry to Modify/Add
1071 public static function navigationMenu(&$params) {
1072 return self
::singleton()->invoke(1, $params,
1073 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1074 'civicrm_navigationMenu'
1079 * This hook allows modification of the data used to perform merging of duplicates.
1081 * @param string $type
1082 * The type of data being passed (cidRefs|eidRefs|relTables|sqls).
1083 * @param array $data
1084 * The data, as described in $type.
1085 * @param int $mainId
1086 * Contact_id of the contact that survives the merge.
1087 * @param int $otherId
1088 * Contact_id of the contact that will be absorbed and deleted.
1089 * @param array $tables
1090 * When $type is "sqls", an array of tables as it may have been handed to the calling function.
1094 public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
1095 return self
::singleton()->invoke(5, $type, $data, $mainId, $otherId, $tables, self
::$_nullObject, 'civicrm_merge');
1099 * This hook provides a way to override the default privacy behavior for notes.
1101 * @param array &$noteValues
1102 * Associative array of values for this note
1106 public static function notePrivacy(&$noteValues) {
1107 return self
::singleton()->invoke(1, $noteValues,
1108 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1109 'civicrm_notePrivacy'
1114 * This hook is called before record is exported as CSV.
1116 * @param string $exportTempTable
1117 * Name of the temporary export table used during export.
1118 * @param array $headerRows
1119 * Header rows for output.
1120 * @param array $sqlColumns
1122 * @param int $exportMode
1123 * Export mode ( contact, contribution, etc...).
1127 public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode) {
1128 return self
::singleton()->invoke(4, $exportTempTable, $headerRows, $sqlColumns, $exportMode,
1129 self
::$_nullObject, self
::$_nullObject,
1135 * This hook allows modification of the queries constructed from dupe rules.
1137 * @param string $obj
1138 * Object of rulegroup class.
1139 * @param string $type
1140 * Type of queries e.g table / threshold.
1141 * @param array $query
1146 public static function dupeQuery($obj, $type, &$query) {
1147 return self
::singleton()->invoke(3, $obj, $type, $query,
1148 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1154 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1156 * @param string $type
1157 * Type of mail processed: 'activity' OR 'mailing'.
1158 * @param array &$params the params that were sent to the CiviCRM API function
1159 * @param object $mail
1160 * The mail object which is an ezcMail class.
1161 * @param array &$result the result returned by the api call
1162 * @param string $action
1163 * (optional ) the requested action to be performed if the types was 'mailing'.
1167 public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1168 return self
::singleton()
1169 ->invoke(5, $type, $params, $mail, $result, $action, self
::$_nullObject, 'civicrm_emailProcessor');
1173 * This hook is called after a row has been processed and the
1174 * record (and associated records imported
1176 * @param string $object
1177 * Object being imported (for now Contact only, later Contribution, Activity,.
1178 * Participant and Member)
1179 * @param string $usage
1180 * Hook usage/location (for now process only, later mapping and others).
1181 * @param string $objectRef
1182 * Import record object.
1183 * @param array $params
1184 * Array with various key values: currently.
1185 * contactID - contact id
1186 * importID - row id in temp table
1187 * importTempTable - name of tempTable
1188 * fieldHeaders - field headers
1189 * fields - import fields
1193 public static function import($object, $usage, &$objectRef, &$params) {
1194 return self
::singleton()->invoke(4, $object, $usage, $objectRef, $params,
1195 self
::$_nullObject, self
::$_nullObject,
1201 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1202 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1204 * @param string $entity
1205 * The API entity (like contact).
1206 * @param string $action
1207 * The API action (like get).
1208 * @param array &$params the API parameters
1209 * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1213 public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1214 return self
::singleton()->invoke(4, $entity, $action, $params, $permissions,
1215 self
::$_nullObject, self
::$_nullObject,
1216 'civicrm_alterAPIPermissions'
1221 * @param CRM_Core_DAO $dao
1225 public static function postSave(&$dao) {
1226 $hookName = 'civicrm_postSave_' . $dao->getTableName();
1227 return self
::singleton()->invoke(1, $dao,
1228 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1234 * This hook allows user to customize context menu Actions on contact summary page.
1236 * @param array $actions
1237 * Array of all Actions in contextmenu.
1238 * @param int $contactID
1239 * ContactID for the summary page.
1243 public static function summaryActions(&$actions, $contactID = NULL) {
1244 return self
::singleton()->invoke(2, $actions, $contactID,
1245 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1246 'civicrm_summaryActions'
1251 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1252 * This enables us hook implementors to modify both the headers and the rows
1254 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1255 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1257 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1258 * you want displayed. This is a hackish, but avoids template modification.
1260 * @param string $objectName
1261 * The component name that we are doing the search.
1262 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1263 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1264 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1265 * @param array $selector
1266 * the selector object. Allows you access to the context of the search
1269 * modify the header and values object to pass the data u need
1271 public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1272 return self
::singleton()->invoke(4, $objectName, $headers, $rows, $selector,
1273 self
::$_nullObject, self
::$_nullObject,
1274 'civicrm_searchColumns'
1279 * This hook is called when uf groups are being built for a module.
1281 * @param string $moduleName
1283 * @param array $ufGroups
1284 * Array of ufgroups for a module.
1288 public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1289 return self
::singleton()->invoke(2, $moduleName, $ufGroups,
1290 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1291 'civicrm_buildUFGroupsForModule'
1296 * This hook is called when we are determining the contactID for a specific
1299 * @param string $email
1300 * The email address.
1301 * @param int $contactID
1302 * The contactID that matches this email address, IF it exists.
1303 * @param array $result
1304 * (reference) has two fields.
1305 * contactID - the new (or same) contactID
1306 * action - 3 possible values:
1307 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1308 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1309 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1313 public static function emailProcessorContact($email, $contactID, &$result) {
1314 return self
::singleton()->invoke(3, $email, $contactID, $result,
1315 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1316 'civicrm_emailProcessorContact'
1321 * Hook definition for altering the generation of Mailing Labels.
1323 * @param array $args
1324 * An array of the args in the order defined for the tcpdf multiCell api call.
1325 * with the variable names below converted into string keys (ie $w become 'w'
1326 * as the first key for $args)
1327 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1328 * float $h Cell minimum height. The cell extends automatically if needed.
1329 * string $txt String to print
1330 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1331 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1332 * a string containing some or all of the following characters (in any order):
1333 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1334 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1335 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1336 * (default value when $ishtml=false)</li></ul>
1337 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1338 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1339 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1340 * float $x x position in user units
1341 * float $y y position in user units
1342 * boolean $reseth if true reset the last cell height (default true).
1343 * int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1344 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1345 * necessary</li><li>4 = forced character spacing</li></ul>
1346 * boolean $ishtml set to true if $txt is HTML content (default = false).
1347 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1348 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1349 * or 0 for disable this feature. This feature works only when $ishtml=false.
1353 public static function alterMailingLabelParams(&$args) {
1354 return self
::singleton()->invoke(1, $args,
1355 self
::$_nullObject, self
::$_nullObject,
1356 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1357 'civicrm_alterMailingLabelParams'
1362 * This hooks allows alteration of generated page content.
1365 * Previously generated content.
1367 * Context of content - page or form.
1369 * The file name of the tpl.
1371 * A reference to the page or form object.
1375 public static function alterContent(&$content, $context, $tplName, &$object) {
1376 return self
::singleton()->invoke(4, $content, $context, $tplName, $object,
1377 self
::$_nullObject, self
::$_nullObject,
1378 'civicrm_alterContent'
1383 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1384 * altercontent hook as the content has already been rendered through the tpl at that point
1387 * Previously generated content.
1389 * Reference to the form object.
1391 * Context of content - page or form.
1393 * Reference the file name of the tpl.
1397 public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1398 return self
::singleton()->invoke(4, $formName, $form, $context, $tplName,
1399 self
::$_nullObject, self
::$_nullObject,
1400 'civicrm_alterTemplateFile'
1405 * This hook collects the trigger definition from all components.
1408 * @param string $tableName
1409 * (optional) the name of the table that we are interested in only.
1411 * @internal param \reference $triggerInfo to an array of trigger information
1412 * each element has 4 fields:
1413 * table - array of tableName
1414 * when - BEFORE or AFTER
1415 * event - array of eventName - INSERT OR UPDATE OR DELETE
1416 * sql - array of statements optionally terminated with a ;
1417 * a statement can use the tokes {tableName} and {eventName}
1418 * to do token replacement with the table / event. This allows
1419 * templatizing logging and other hooks
1422 public static function triggerInfo(&$info, $tableName = NULL) {
1423 return self
::singleton()->invoke(2, $info, $tableName,
1424 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1426 'civicrm_triggerInfo'
1431 * This hook is called when a module-extension is installed.
1432 * Each module will receive hook_civicrm_install during its own installation (but not during the
1433 * installation of unrelated modules).
1435 public static function install() {
1436 return self
::singleton()->invoke(0, self
::$_nullObject,
1437 self
::$_nullObject, self
::$_nullObject,
1438 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1444 * This hook is called when a module-extension is uninstalled.
1445 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1446 * uninstallation of unrelated modules).
1448 public static function uninstall() {
1449 return self
::singleton()->invoke(0, self
::$_nullObject,
1450 self
::$_nullObject, self
::$_nullObject,
1451 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1457 * This hook is called when a module-extension is re-enabled.
1458 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1459 * re-enablement of unrelated modules).
1461 public static function enable() {
1462 return self
::singleton()->invoke(0, self
::$_nullObject,
1463 self
::$_nullObject, self
::$_nullObject,
1464 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1470 * This hook is called when a module-extension is disabled.
1471 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1472 * disablement of unrelated modules).
1474 public static function disable() {
1475 return self
::singleton()->invoke(0, self
::$_nullObject,
1476 self
::$_nullObject, self
::$_nullObject,
1477 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1489 public static function alterReportVar($varType, &$var, &$object) {
1490 return self
::singleton()->invoke(3, $varType, $var, $object,
1492 self
::$_nullObject, self
::$_nullObject,
1493 'civicrm_alterReportVar'
1498 * This hook is called to drive database upgrades for extension-modules.
1501 * The type of operation being performed; 'check' or 'enqueue'.
1502 * @param CRM_Queue_Queue $queue
1503 * (for 'enqueue') the modifiable list of pending up upgrade tasks.
1506 * NULL, if $op is 'enqueue'.
1507 * TRUE, if $op is 'check' and upgrades are pending.
1508 * FALSE, if $op is 'check' and upgrades are not pending.
1510 public static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1511 return self
::singleton()->invoke(2, $op, $queue,
1512 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1519 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1521 * @param array $params
1522 * The mailing parameters. Array fields include: groupName, from, toName,
1523 * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1524 * attachments (array)
1528 public static function postEmailSend(&$params) {
1529 return self
::singleton()->invoke(1, $params,
1530 self
::$_nullObject, self
::$_nullObject,
1531 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1532 'civicrm_postEmailSend'
1537 * This hook is called when Settings specifications are loaded.
1539 * @param array $settingsFolders
1540 * List of paths from which to derive metadata
1544 public static function alterSettingsFolders(&$settingsFolders) {
1545 return self
::singleton()->invoke(1, $settingsFolders,
1546 self
::$_nullObject, self
::$_nullObject,
1547 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1548 'civicrm_alterSettingsFolders'
1553 * This hook is called when Settings have been loaded from the xml
1554 * It is an opportunity for hooks to alter the data
1556 * @param array $settingsMetaData
1557 * Settings Metadata.
1558 * @param int $domainID
1559 * @param mixed $profile
1563 public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1564 return self
::singleton()->invoke(3, $settingsMetaData,
1565 $domainID, $profile,
1566 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1567 'civicrm_alterSettingsMetaData'
1572 * This hook is called before running an api call.
1574 * @param API_Wrapper[] $wrappers
1575 * (see CRM_Utils_API_ReloadOption as an example)
1576 * @param mixed $apiRequest
1579 * The return value is ignored
1581 public static function apiWrappers(&$wrappers, $apiRequest) {
1582 return self
::singleton()
1583 ->invoke(2, $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1584 self
::$_nullObject, 'civicrm_apiWrappers'
1589 * This hook is called before running pending cron jobs.
1591 * @param CRM_Core_JobManager $jobManager
1594 * The return value is ignored.
1596 public static function cron($jobManager) {
1597 return self
::singleton()->invoke(1,
1598 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1604 * This hook is called when loading CMS permissions; use this hook to modify
1605 * the array of system permissions for CiviCRM.
1607 * @param array $permissions
1608 * Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1609 * the format of this array.
1612 * The return value is ignored
1614 public static function permission(&$permissions) {
1615 return self
::singleton()->invoke(1, $permissions,
1616 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1617 'civicrm_permission'
1622 * @param CRM_Core_Exception Exception $exception
1623 * @param mixed $request
1624 * Reserved for future use.
1626 public static function unhandledException($exception, $request = NULL) {
1628 ->invoke(2, $exception, $request, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_unhandled_exception');
1630 //$event = new stdClass();
1631 //$event->exception = $exception;
1632 //CRM_Core_LegacyErrorHandler::handleException($event);
1635 $event = new \Civi\Core\Event\
UnhandledExceptionEvent($exception, self
::$_nullObject);
1636 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_unhandled_exception", $event);
1640 * This hook is called for declaring managed entities via API.
1642 * @param array[] $entityTypes
1643 * List of entity types; each entity-type is an array with keys:
1644 * - name: string, a unique short name (e.g. "ReportInstance")
1645 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1646 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
1649 * The return value is ignored
1651 public static function entityTypes(&$entityTypes) {
1652 return self
::singleton()->invoke(1, $entityTypes, self
::$_nullObject, self
::$_nullObject,
1653 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
1658 * This hook is called while preparing a profile form.
1660 * @param string $name
1663 public static function buildProfile($name) {
1664 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1665 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildProfile');
1669 * This hook is called while validating a profile form submission.
1671 * @param string $name
1674 public static function validateProfile($name) {
1675 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1676 self
::$_nullObject, self
::$_nullObject, 'civicrm_validateProfile');
1680 * This hook is called processing a valid profile form submission.
1682 * @param string $name
1685 public static function processProfile($name) {
1686 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1687 self
::$_nullObject, self
::$_nullObject, 'civicrm_processProfile');
1691 * This hook is called while preparing a read-only profile screen
1693 * @param string $name
1696 public static function viewProfile($name) {
1697 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1698 self
::$_nullObject, self
::$_nullObject, 'civicrm_viewProfile');
1702 * This hook is called while preparing a list of contacts (based on a profile)
1704 * @param string $name
1707 public static function searchProfile($name) {
1708 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1709 self
::$_nullObject, self
::$_nullObject, 'civicrm_searchProfile');
1713 * This hook is invoked when building a CiviCRM name badge.
1715 * @param string $labelName
1716 * String referencing name of badge format.
1717 * @param object $label
1718 * Reference to the label object.
1719 * @param array $format
1720 * Array of format data.
1721 * @param array $participant
1722 * Array of participant values.
1725 * the return value is ignored
1727 public static function alterBadge($labelName, &$label, &$format, &$participant) {
1728 return self
::singleton()
1729 ->invoke(4, $labelName, $label, $format, $participant, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBadge');
1734 * This hook is called before encoding data in barcode.
1736 * @param array $data
1737 * Associated array of values available for encoding.
1738 * @param string $type
1739 * Type of barcode, classic barcode or QRcode.
1740 * @param string $context
1741 * Where this hooks is invoked.
1745 public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') {
1746 return self
::singleton()->invoke(3, $data, $type, $context, self
::$_nullObject,
1747 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBarcode');
1751 * Modify or replace the Mailer object used for outgoing mail.
1753 * @param object $mailer
1754 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
1755 * @param string $driver
1756 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
1757 * @param array $params
1758 * The default mailer config options
1761 * @see Mail::factory
1763 public static function alterMail(&$mailer, $driver, $params) {
1764 return self
::singleton()
1765 ->invoke(3, $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
1769 * This hook is called while building the core search query,
1770 * so hook implementers can provide their own query objects which alters/extends core search.
1772 * @param array $queryObjects
1773 * @param string $type
1777 public static function queryObjects(&$queryObjects, $type = 'Contact') {
1778 return self
::singleton()
1779 ->invoke(2, $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
1783 * This hook is called while viewing contact dashboard.
1785 * @param array $availableDashlets
1786 * List of dashlets; each is formatted per api/v3/Dashboard
1787 * @param array $defaultDashlets
1788 * List of dashlets; each is formatted per api/v3/DashboardContact
1792 public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
1793 return self
::singleton()
1794 ->invoke(2, $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');
1798 * This hook is called before a case merge (or a case reassign)
1800 * @param int $mainContactId
1801 * @param int $mainCaseId
1802 * @param int $otherContactId
1803 * @param int $otherCaseId
1804 * @param bool $changeClient
1808 public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1809 return self
::singleton()
1810 ->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_pre_case_merge');
1814 * This hook is called after a case merge (or a case reassign)
1816 * @param int $mainContactId
1817 * @param int $mainCaseId
1818 * @param int $otherContactId
1819 * @param int $otherCaseId
1820 * @param bool $changeClient
1824 public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1825 return self
::singleton()
1826 ->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_post_case_merge');
1831 * Add a hook for altering the display name
1833 * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
1835 * @param string $displayName
1836 * @param int $contactId
1837 * @param object $dao
1838 * The contact object.
1842 public static function alterDisplayName(&$displayName, $contactId, $dao) {
1843 return self
::singleton()->invoke(3,
1844 $displayName, $contactId, $dao, self
::$_nullObject, self
::$_nullObject,
1845 self
::$_nullObject, 'civicrm_contact_get_displayname'
1850 * EXPERIMENTAL: This hook allows one to register additional Angular modules
1852 * @param array $angularModules
1855 * the return value is ignored
1858 * function mymod_civicrm_angularModules(&$angularModules) {
1859 * $angularModules['myAngularModule'] = array(
1860 * 'ext' => 'org.example.mymod',
1861 * 'js' => array('js/myAngularModule.js'),
1863 * $angularModules['myBigAngularModule'] = array(
1864 * 'ext' => 'org.example.mymod',
1865 * 'js' => array('js/part1.js', 'js/part2.js'),
1866 * 'css' => array('css/myAngularModule.css'),
1867 * 'partials' => array('partials/myBigAngularModule'),
1872 public static function angularModules(&$angularModules) {
1873 return self
::singleton()->invoke(1, $angularModules,
1874 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1875 'civicrm_angularModules'
1880 * This hook fires whenever a record in a case changes.
1882 * @param \Civi\CCase\Analyzer $analyzer
1884 public static function caseChange(\Civi\CCase\Analyzer
$analyzer) {
1885 $event = new \Civi\CCase\Event\
CaseChangeEvent($analyzer);
1886 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_caseChange", $event);
1888 return self
::singleton()->invoke(1, $angularModules,
1889 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1890 'civicrm_caseChange'
1895 * Generate a default CRUD URL for an entity.
1897 * @param array $spec
1899 * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
1900 * - entity_table: string
1902 * @param CRM_Core_DAO $bao
1903 * @param array $link
1904 * To define the link, add these keys to $link:.
1908 * - url: string (used in lieu of "path"/"query")
1909 * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
1912 public static function crudLink($spec, $bao, &$link) {
1913 return self
::singleton()->invoke(3, $spec, $bao, $link,
1914 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1920 * @param array <CRM_Core_FileSearchInterface> $fileSearches
1923 public static function fileSearches(&$fileSearches) {
1924 return self
::singleton()->invoke(1, $fileSearches,
1925 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1926 'civicrm_fileSearches'
1931 * Check system status.
1933 * @param array $messages
1934 * Array<CRM_Utils_Check_Message>. A list of messages regarding system status.
1937 public static function check(&$messages) {
1938 return self
::singleton()
1939 ->invoke(1, $messages, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_check');
1943 * This hook is called when a query string of the CSV Batch export is generated.
1945 public static function batchQuery(&$query) {
1946 return self
::singleton()->invoke(1, $query, self
::$_nullObject,
1947 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1948 'civicrm_batchQuery'
1953 * This hook is called when the entries of the CSV Batch export are mapped.
1955 public static function batchItems(&$results, &$items) {
1956 return self
::singleton()->invoke(2, $results, $items,
1957 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1958 'civicrm_batchItems'