3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
36 abstract class CRM_Utils_Hook
{
38 // Allowed values for dashboard hook content placement
39 // Default - place content below activity list
40 CONST DASHBOARD_BELOW
= 1;
41 // Place content above activity list
42 CONST DASHBOARD_ABOVE
= 2;
43 // Don't display activity list at all
44 CONST DASHBOARD_REPLACE
= 3;
46 // by default - place content below existing content
47 CONST SUMMARY_BELOW
= 1;
48 // pace hook content above
49 CONST SUMMARY_ABOVE
= 2;
50 // create your own summarys
51 CONST SUMMARY_REPLACE
= 3;
53 static $_nullObject = NULL;
56 * We only need one instance of this object. So we use the singleton
57 * pattern and cache the instance in this variable
62 static private $_singleton = NULL;
67 private $commonIncluded = FALSE;
72 private $commonCiviModules = array();
75 * Constructor and getter for the singleton instance
77 * @return instance of $config->userHookClass
79 static function singleton($fresh = FALSE) {
80 if (self
::$_singleton == NULL ||
$fresh) {
81 $config = CRM_Core_Config
::singleton();
82 $class = $config->userHookClass
;
83 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $config->userHookClass
) . '.php');
84 self
::$_singleton = new $class();
86 return self
::$_singleton;
89 abstract function invoke($numParams,
90 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5,
94 function commonInvoke($numParams,
95 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5,
99 $this->commonBuildModuleList($fnPrefix);
101 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
102 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5
107 * Build the list of modules to be processed for hooks.
109 function commonBuildModuleList($fnPrefix) {
110 if (!$this->commonIncluded
) {
111 // include external file
112 $this->commonIncluded
= TRUE;
114 $config = CRM_Core_Config
::singleton();
115 if (!empty($config->customPHPPathDir
) &&
116 file_exists("{$config->customPHPPathDir}/civicrmHooks.php")
118 @include_once
("civicrmHooks.php");
121 if (!empty($fnPrefix)) {
122 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
125 $this->requireCiviModules($this->commonCiviModules
);
129 function runHooks($civiModules, $fnSuffix, $numParams,
130 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5
132 // $civiModules is *not* passed by reference because runHooks
133 // must be reentrant. PHP is finicky about running
134 // multiple loops over the same variable. The circumstances
135 // to reproduce the issue are pretty intricate.
136 $result = $fResult = array();
138 if ($civiModules !== NULL) {
139 foreach ($civiModules as $module) {
140 $fnName = "{$module}_{$fnSuffix}";
141 if (function_exists($fnName)) {
142 switch ($numParams) {
144 $fResult = $fnName();
148 $fResult = $fnName($arg1);
152 $fResult = $fnName($arg1, $arg2);
156 $fResult = $fnName($arg1, $arg2, $arg3);
160 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
164 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
168 CRM_Core_Error
::fatal(ts('Invalid hook invocation'));
173 if (!empty($fResult) &&
174 is_array($fResult)) {
175 $result = array_merge($result, $fResult);
180 return empty($result) ?
TRUE : $result;
183 function requireCiviModules(&$moduleList) {
184 $civiModules = CRM_Core_PseudoConstant
::getModuleExtensions();
185 foreach ($civiModules as $civiModule) {
186 if (!file_exists($civiModule['filePath'])) {
187 CRM_Core_Session
::setStatus(
188 ts( 'Error loading module file (%1). Please restore the file or disable the module.',
189 array(1 => $civiModule['filePath']) ),
190 ts( 'Warning'), 'error');
193 include_once $civiModule['filePath'];
194 $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
199 * This hook is called before a db write on some core objects.
200 * This hook does not allow the abort of the operation
202 * @param string $op the type of operation being performed
203 * @param string $objectName the name of the object
204 * @param object $id the object id if available
205 * @param array $params the parameters used for object creation / editing
207 * @return null the return value is ignored
210 static function pre($op, $objectName, $id, &$params) {
211 return self
::singleton()->invoke(4, $op, $objectName, $id, $params, $op, 'civicrm_pre');
215 * This hook is called after a db write on some core objects.
217 * @param string $op the type of operation being performed
218 * @param string $objectName the name of the object
219 * @param int $objectId the unique identifier for the object
220 * @param object $objectRef the reference to the object if available
222 * @return mixed based on op. pre-hooks return a boolean or
223 * an error message which aborts the operation
226 static function post($op, $objectName, $objectId, &$objectRef) {
227 return self
::singleton()->invoke(4, $op, $objectName, $objectId, $objectRef, $op, 'civicrm_post');
231 * This hook retrieves links from other modules and injects it into
232 * the view contact tabs
234 * @param string $op the type of operation being performed
235 * @param string $objectName the name of the object
236 * @param int $objectId the unique identifier for the object
237 * @params array $links (optional ) the links array (introduced in v3.2)
239 * @return array|null an array of arrays, each element is a tuple consisting of id, url, img, title, weight
243 static function links($op, $objectName, &$objectId, &$links, &$mask = NULL) {
244 return self
::singleton()->invoke(5, $op, $objectName, $objectId, $links, $mask, 'civicrm_links');
248 * This hook is invoked when building a CiviCRM form. This hook should also
249 * be used to set the default values of a form element
251 * @param string $formName the name of the form
252 * @param object $form reference to the form object
254 * @return null the return value is ignored
256 static function buildForm($formName, &$form) {
257 return self
::singleton()->invoke(2, $formName, $form, $formName, $formName, $formName, 'civicrm_buildForm');
261 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
262 * any form elements, this hook should save the values in the database
264 * @param string $formName the name of the form
265 * @param object $form reference to the form object
267 * @return null the return value is ignored
269 static function postProcess($formName, &$form) {
270 return self
::singleton()->invoke(2, $formName, $form, $formName, $formName, $formName, 'civicrm_postProcess');
274 * This hook is invoked during all CiviCRM form validation. An array of errors
275 * detected is returned. Else we assume validation succeeded.
277 * @param string $formName the name of the form
278 * @param array &$fields the POST parameters as filtered by QF
279 * @param array &$files the FILES parameters as sent in by POST
280 * @param array &$form the form object
282 * @return mixed formRule hooks return a boolean or
283 * an array of error messages which display a QF Error
286 static function validate($formName, &$fields, &$files, &$form) {
287 return self
::singleton()->invoke(4, $formName, $fields, $files, $form, $formName, 'civicrm_validate');
291 * This hook is invoked during all CiviCRM form validation. An array of errors
292 * detected is returned. Else we assume validation succeeded.
294 * @param string $formName the name of the form
295 * @param array &$fields the POST parameters as filtered by QF
296 * @param array &$files the FILES parameters as sent in by POST
297 * @param array &$form the form object
298 * @param array &$errors the array of errors.
300 * @return mixed formRule hooks return a boolean or
301 * an array of error messages which display a QF Error
304 static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
305 return self
::singleton()->invoke(5, $formName, $fields, $files, $form, $errors, 'civicrm_validateForm');
309 * This hook is called before a db write on a custom table
311 * @param string $op the type of operation being performed
312 * @param string $groupID the custom group ID
313 * @param object $entityID the entityID of the row in the custom table
314 * @param array $params the parameters that were sent into the calling function
316 * @return null the return value is ignored
319 static function custom($op, $groupID, $entityID, &$params) {
320 return self
::singleton()->invoke(4, $op, $groupID, $entityID, $params, $op, 'civicrm_custom');
324 * This hook is called when composing the ACL where clause to restrict
325 * visibility of contacts to the logged in user
327 * @param int $type the type of permission needed
328 * @param array $tables (reference ) add the tables that are needed for the select clause
329 * @param array $whereTables (reference ) add the tables that are needed for the where clause
330 * @param int $contactID the contactID for whom the check is made
331 * @param string $where the currrent where clause
333 * @return null the return value is ignored
336 static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
337 return self
::singleton()->invoke(5, $type, $tables, $whereTables, $contactID, $where, 'civicrm_aclWhereClause');
341 * This hook is called when composing the ACL where clause to restrict
342 * visibility of contacts to the logged in user
344 * @param int $type the type of permission needed
345 * @param int $contactID the contactID for whom the check is made
346 * @param string $tableName the tableName which is being permissioned
347 * @param array $allGroups the set of all the objects for the above table
348 * @param array $currentGroups the set of objects that are currently permissioned for this contact
350 * @return null the return value is ignored
353 static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
354 return self
::singleton()->invoke(5, $type, $contactID, $tableName, $allGroups, $currentGroups, 'civicrm_aclGroup');
358 * This hook is called when building the menu table
360 * @param array $files The current set of files to process
362 * @return null the return value is ignored
365 static function xmlMenu(&$files) {
366 return self
::singleton()->invoke(1, $files,
367 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
373 * This hook is called for declaring managed entities via API
375 * @param array $entities List of pending entities
377 * @return null the return value is ignored
380 static function managed(&$entities) {
381 return self
::singleton()->invoke(1, $entities,
382 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
388 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
390 * @param int $contactID - the contactID for whom the dashboard is being rendered
391 * @param int $contentPlacement - (output parameter) where should the hook content be displayed
392 * relative to the activity list
394 * @return string the html snippet to include in the dashboard
397 static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
398 $retval = self
::singleton()->invoke(2, $contactID, $contentPlacement,
399 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
404 * Note we need this seemingly unnecessary code because in the event that the implementation
405 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
406 * though we have a default value in this function's declaration above.
408 if (!isset($contentPlacement)) {
409 $contentPlacement = self
::DASHBOARD_BELOW
;
416 * This hook is called before storing recently viewed items.
418 * @param array $recentArray - an array of recently viewed or processed items, for in place modification
423 static function recent(&$recentArray) {
424 return self
::singleton()->invoke(1, $recentArray,
425 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
431 * This hook is called when building the amount structure for a Contribution or Event Page
433 * @param int $pageType - is this a contribution or event page
434 * @param object $form - reference to the form object
435 * @param array $amount - the amount structure to be displayed
440 static function buildAmount($pageType, &$form, &$amount) {
441 return self
::singleton()->invoke(3, $pageType, $form, $amount, self
::$_nullObject,
442 self
::$_nullObject, 'civicrm_buildAmount');
446 * This hook is called when building the state list for a particular country.
448 * @param array $countryID - the country id whose states are being selected.
453 static function buildStateProvinceForCountry($countryID, &$states) {
454 return self
::singleton()->invoke(2, $countryID, $states,
455 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
456 'civicrm_buildStateProvinceForCountry'
461 * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
463 * @param array $tabs - the array of tabs that will be displayed
464 * @param int $contactID - the contactID for whom the dashboard is being rendered
469 static function tabs(&$tabs, $contactID) {
470 return self
::singleton()->invoke(2, $tabs, $contactID,
471 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabs'
476 * This hook is called when rendering the tabs
477 * used for events and potentially contribution pages, etc
478 * @param string $tabset - name of the screen or visual element
479 * @param array $tabs - the array of tabs that will be displayed
480 * @param array $context - extra data about the screen or context in which the tab is used
485 static function tabset($tabsetName, &$tabs, $context) {
486 return self
::singleton()->invoke(3, $tabsetName, $tabs,
487 $context, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
492 * This hook is called when sending an email / printing labels
494 * @param array $tokens - the list of tokens that can be used for the contact
499 static function tokens(&$tokens) {
500 return self
::singleton()->invoke(1, $tokens,
501 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
506 * This hook is called when sending an email / printing labels to get the values for all the
507 * tokens returned by the 'tokens' hook
509 * @param array $details - the array to store the token values indexed by contactIDs (unless it a single)
510 * @param array $contactIDs - an array of contactIDs
511 * @param int $jobID - the jobID if this is associated with a CiviMail mailing
512 * @param array $tokens - the list of tokens associated with the content
513 * @param string $className - the top level className from where the hook is invoked
518 static function tokenValues(&$details,
524 return self
::singleton()->invoke(5, $details, $contactIDs, $jobID, $tokens, $className, 'civicrm_tokenValues');
528 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
531 * @param object $page - the page that will be rendered
536 static function pageRun(&$page) {
537 return self
::singleton()->invoke(1, $page,
538 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
544 * This hook is called after a copy of an object has been made. The current objects are
545 * Event, Contribution Page and UFGroup
547 * @param string $objectName - name of the object
548 * @param object $object - reference to the copy
553 static function copy($objectName, &$object) {
554 return self
::singleton()->invoke(2, $objectName, $object,
555 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
561 * This hook is called when a contact unsubscribes from a mailing. It allows modules
562 * to override what the contacts are removed from.
564 * @param string $op - ignored for now
565 * @param int $mailing_id - the id of the mailing to unsub from
566 * @param int $contact_id - the id of the contact who is unsubscribing
567 * @param array / int $groups - array of groups the contact will be removed from
568 * @param array / int $baseGroups - array of base groups (used in smart mailings) the contact will be removed from
571 static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
572 return self
::singleton()->invoke(5, $op, $mailingId, $contactId, $groups, $baseGroups, 'civicrm_unsubscribeGroups');
576 * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox,
579 * @param int $customFieldID - the custom field ID
580 * @param array $options - the current set of options for that custom field.
581 * You can add/remove existing options.
582 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
583 * to be careful to not overwrite the array.
584 * Only add/edit/remove the specific field options you intend to affect.
585 * @param boolean $detailedFormat - if true,
586 * the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
588 static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE) {
589 return self
::singleton()->invoke(3, $customFieldID, $options, $detailedFormat,
590 self
::$_nullObject, self
::$_nullObject,
591 'civicrm_customFieldOptions'
597 * This hook is called to display the list of actions allowed after doing a search.
598 * This allows the module developer to inject additional actions or to remove existing actions.
600 * @param string $objectType - the object type for this search
601 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
602 * @param array $tasks - the current set of tasks for that custom field.
603 * You can add/remove existing tasks.
604 * Each task needs to have a title (eg 'title' => ts( 'Add Contacts to Group')) and a class
605 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
606 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
607 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
608 * found in CRM/$objectType/Task.php.
610 static function searchTasks($objectType, &$tasks) {
611 return self
::singleton()->invoke(2, $objectType, $tasks,
612 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
613 'civicrm_searchTasks'
617 static function eventDiscount(&$form, &$params) {
618 return self
::singleton()->invoke(2, $form, $params,
619 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
620 'civicrm_eventDiscount'
625 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
627 * @param unknown_type $form - the form object for which groups / mailings being displayed
628 * @param array $groups - the list of groups being included / excluded
629 * @param array $mailings - the list of mailings being included / excluded
631 static function mailingGroups(&$form, &$groups, &$mailings) {
632 return self
::singleton()->invoke(3, $form, $groups, $mailings,
633 self
::$_nullObject, self
::$_nullObject,
634 'civicrm_mailingGroups'
639 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
641 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
642 * You can use it to alter the membership types when first loaded, or after submission
643 * (for example if you want to gather data in the form and use it to alter the fees).
645 * @param unknown_type $form - the form object that is presenting the page
646 * @param array $membershipTypes - the array of membership types and their amount
648 static function membershipTypeValues(&$form, &$membershipTypes) {
649 return self
::singleton()->invoke(2, $form, $membershipTypes,
650 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
651 'civicrm_membershipTypeValues'
656 * This hook is called when rendering the contact summary
658 * @param int $contactID - the contactID for whom the summary is being rendered
659 * @param int $contentPlacement - (output parameter) where should the hook content be displayed relative to
660 * the existing content
662 * @return string the html snippet to include in the contact summary
665 static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
666 return self
::singleton()->invoke(3, $contactID, $content, $contentPlacement,
667 self
::$_nullObject, self
::$_nullObject,
673 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
674 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
675 * If you want to limit the contacts returned to a specific group, or some other criteria
676 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
677 * The hook is called when the query is executed to get the list of contacts to display.
679 * @param unknown_type $query - - the query that will be executed (input and output parameter);
680 * It's important to realize that the ACL clause is built prior to this hook being fired,
681 * so your query will ignore any ACL rules that may be defined.
682 * Your query must return two columns:
683 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
685 * @param string $name - the name string to execute the query against (this is the value being typed in by the user)
686 * @param string $context - the context in which this ajax call is being made (for example: 'customfield', 'caseview')
687 * @param int $id - the id of the object for which the call is being made.
688 * For custom fields, it will be the custom field id
690 static function contactListQuery(&$query, $name, $context, $id) {
691 return self
::singleton()->invoke(4, $query, $name, $context, $id,
693 'civicrm_contactListQuery'
698 * Hook definition for altering payment parameters before talking to a payment processor back end.
700 * Definition will look like this:
702 * function hook_civicrm_alterPaymentProcessorParams($paymentObj,
703 * &$rawParams, &$cookedParams);
705 * @param string $paymentObj
706 * instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
707 * @param array &$rawParams
708 * array of params as passed to to the processor
709 * @params array &$cookedParams
710 * params after the processor code has translated them into its own key/value pairs
714 static function alterPaymentProcessorParams($paymentObj,
718 return self
::singleton()->invoke(3, $paymentObj, $rawParams, $cookedParams,
719 self
::$_nullObject, self
::$_nullObject,
720 'civicrm_alterPaymentProcessorParams'
725 * This hook is called when an email is about to be sent by CiviCRM.
727 * @param array $params - array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
728 * returnPath, replyTo, headers, attachments (array)
729 * @param string $context - the context in which the hook is being invoked, eg 'civimail'
731 static function alterMailParams(&$params, $context = NULL) {
732 return self
::singleton()->invoke(2, $params, $context,
733 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
734 'civicrm_alterMailParams'
739 * This hook is called when rendering the Manage Case screen
741 * @param int $caseID - the case ID
743 * @return array of data to be displayed, where the key is a unique id to be used for styling (div id's)
744 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
747 static function caseSummary($caseID) {
748 return self
::singleton()->invoke(1, $caseID,
749 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
750 'civicrm_caseSummary'
755 * This hook is called when locating CiviCase types.
757 * @param array $caseTypes
760 static function caseTypes(&$caseTypes) {
761 return self
::singleton()->invoke(1, $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
765 * This hook is called soon after the CRM_Core_Config object has ben initialized.
766 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
768 * @param array $config - the config object
770 static function config(&$config) {
771 return self
::singleton()->invoke(1, $config,
772 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
777 static function enableDisable($recordBAO, $recordID, $isActive) {
778 return self
::singleton()->invoke(3, $recordBAO, $recordID, $isActive,
779 self
::$_nullObject, self
::$_nullObject,
780 'civicrm_enableDisable'
785 * This hooks allows to change option values
787 * @param $options associated array of option values / id
788 * @param $name option group name
792 static function optionValues(&$options, $name) {
793 return self
::singleton()->invoke(2, $options, $name,
794 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
795 'civicrm_optionValues'
800 * This hook allows modification of the navigation menu.
802 * @param $params associated array of navigation menu entry to Modify/Add
805 static function navigationMenu(&$params) {
806 return self
::singleton()->invoke(1, $params,
807 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
808 'civicrm_navigationMenu'
813 * This hook allows modification of the data used to perform merging of duplicates.
815 * @param string $type the type of data being passed (cidRefs|eidRefs|relTables|sqls)
816 * @param array $data the data, as described in $type
817 * @param int $mainId contact_id of the contact that survives the merge
818 * @param int $otherId contact_id of the contact that will be absorbed and deleted
819 * @param array $tables when $type is "sqls", an array of tables as it may have been handed to the calling function
823 static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
824 return self
::singleton()->invoke(5, $type, $data, $mainId, $otherId, $tables, 'civicrm_merge');
828 * This hook provides a way to override the default privacy behavior for notes.
830 * @param array $note (reference) Associative array of values for this note
834 static function notePrivacy(&$noteValues) {
835 return self
::singleton()->invoke(1, $noteValues,
836 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
837 'civicrm_notePrivacy'
842 * This hook is called before record is exported as CSV
844 * @param string $exportTempTable - name of the temporary export table used during export
845 * @param array $headerRows - header rows for output
846 * @param array $sqlColumns - SQL columns
847 * @param int $exportMode - export mode ( contact, contribution, etc...)
852 static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode) {
853 return self
::singleton()->invoke(4, $exportTempTable, $headerRows, $sqlColumns, $exportMode,
860 * This hook allows modification of the queries constructed from dupe rules.
862 * @param string $obj object of rulegroup class
863 * @param string $type type of queries e.g table / threshold
864 * @param array $query set of queries
868 static function dupeQuery($obj, $type, &$query) {
869 return self
::singleton()->invoke(3, $obj, $type, $query,
870 self
::$_nullObject, self
::$_nullObject,
876 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
878 * @param string $type type of mail processed: 'activity' OR 'mailing'
879 * @param array &$params the params that were sent to the CiviCRM API function
880 * @param object $mail the mail object which is an ezcMail class
881 * @param array &$result the result returned by the api call
882 * @param string $action (optional ) the requested action to be performed if the types was 'mailing'
886 static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
887 return self
::singleton()->invoke(5, $type, $params, $mail, $result, $action, 'civicrm_emailProcessor');
891 * This hook is called after a row has been processed and the
892 * record (and associated records imported
894 * @param string $object - object being imported (for now Contact only, later Contribution, Activity,
895 * Participant and Member)
896 * @param string $usage - hook usage/location (for now process only, later mapping and others)
897 * @param string $objectRef - import record object
898 * @param array $params - array with various key values: currently
899 * contactID - contact id
900 * importID - row id in temp table
901 * importTempTable - name of tempTable
902 * fieldHeaders - field headers
903 * fields - import fields
908 static function import($object, $usage, &$objectRef, &$params) {
909 return self
::singleton()->invoke(4, $object, $usage, $objectRef, $params,
916 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
917 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
919 * @param string $entity the API entity (like contact)
920 * @param string $action the API action (like get)
921 * @param array &$params the API parameters
922 * @param array &$permisisons the associative permissions array (probably to be altered by this hook)
924 static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
925 return self
::singleton()->invoke(4, $entity, $action, $params, $permissions,
927 'civicrm_alterAPIPermissions'
931 static function postSave(&$dao) {
932 $hookName = 'civicrm_postSave_' . $dao->getTableName();
933 return self
::singleton()->invoke(1, $dao,
934 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
940 * This hook allows user to customize context menu Actions on contact summary page.
942 * @param array $actions Array of all Actions in contextmenu.
943 * @param int $contactID ContactID for the summary page
945 static function summaryActions(&$actions, $contactID = NULL) {
946 return self
::singleton()->invoke(2, $actions, $contactID,
947 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
948 'civicrm_summaryActions'
953 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
954 * This enables us hook implementors to modify both the headers and the rows
956 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
957 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
959 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
960 * you want displayed. This is a hackish, but avoids template modification.
962 * @param string $objectName the component name that we are doing the search
963 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
964 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
965 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
966 * @param array &$seletor the selector object. Allows you access to the context of the search
968 * @return void modify the header and values object to pass the data u need
970 static function searchColumns($objectName, &$headers, &$rows, &$selector) {
971 return self
::singleton()->invoke(4, $objectName, $headers, $rows, $selector,
973 'civicrm_searchColumns'
978 * This hook is called when uf groups are being built for a module.
980 * @param string $moduleName module name.
981 * @param array $ufGroups array of ufgroups for a module.
986 static function buildUFGroupsForModule($moduleName, &$ufGroups) {
987 return self
::singleton()->invoke(2, $moduleName, $ufGroups,
988 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
989 'civicrm_buildUFGroupsForModule'
994 * This hook is called when we are determining the contactID for a specific
997 * @param string $email the email address
998 * @param int $contactID the contactID that matches this email address, IF it exists
999 * @param array $result (reference) has two fields
1000 * contactID - the new (or same) contactID
1001 * action - 3 possible values:
1002 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1003 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1004 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1009 static function emailProcessorContact($email, $contactID, &$result) {
1010 return self
::singleton()->invoke(3, $email, $contactID, $result,
1011 self
::$_nullObject, self
::$_nullObject,
1012 'civicrm_emailProcessorContact'
1017 * Hook definition for altering the generation of Mailing Labels
1019 * @param array $args an array of the args in the order defined for the tcpdf multiCell api call
1020 * with the variable names below converted into string keys (ie $w become 'w'
1021 * as the first key for $args)
1022 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1023 * float $h Cell minimum height. The cell extends automatically if needed.
1024 * string $txt String to print
1025 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1026 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1027 * a string containing some or all of the following characters (in any order):
1028 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1029 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1030 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1031 * (default value when $ishtml=false)</li></ul>
1032 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1033 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1034 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1035 * float $x x position in user units
1036 * float $y y position in user units
1037 * boolean $reseth if true reset the last cell height (default true).
1038 * int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1039 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1040 * necessary</li><li>4 = forced character spacing</li></ul>
1041 * boolean $ishtml set to true if $txt is HTML content (default = false).
1042 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1043 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1044 * or 0 for disable this feature. This feature works only when $ishtml=false.
1047 static function alterMailingLabelParams(&$args) {
1048 return self
::singleton()->invoke(1, $args,
1049 self
::$_nullObject, self
::$_nullObject,
1050 self
::$_nullObject, self
::$_nullObject,
1051 'civicrm_alterMailingLabelParams'
1056 * This hooks allows alteration of generated page content
1058 * @param $content previously generated content
1059 * @param $context context of content - page or form
1060 * @param $tplName the file name of the tpl
1061 * @param $object a reference to the page or form object
1065 static function alterContent(&$content, $context, $tplName, &$object) {
1066 return self
::singleton()->invoke(4, $content, $context, $tplName, $object,
1068 'civicrm_alterContent'
1073 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1074 * altercontent hook as the content has already been rendered through the tpl at that point
1076 * @param $formName previously generated content
1077 * @param $form reference to the form object
1078 * @param $context context of content - page or form
1079 * @param $tplName reference the file name of the tpl
1083 static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1084 return self
::singleton()->invoke(4, $formName, $form, $context, $tplName,
1086 'civicrm_alterTemplateFile'
1090 * This hook collects the trigger definition from all components
1092 * @param $triggerInfo reference to an array of trigger information
1093 * each element has 4 fields:
1094 * table - array of tableName
1095 * when - BEFORE or AFTER
1096 * event - array of eventName - INSERT OR UPDATE OR DELETE
1097 * sql - array of statements optionally terminated with a ;
1098 * a statement can use the tokes {tableName} and {eventName}
1099 * to do token replacement with the table / event. This allows
1100 * templatizing logging and other hooks
1101 * @param string $tableName (optional) the name of the table that we are interested in only
1103 static function triggerInfo(&$info, $tableName = NULL) {
1104 return self
::singleton()->invoke(2, $info, $tableName,
1105 self
::$_nullObject, self
::$_nullObject,
1107 'civicrm_triggerInfo'
1112 * This hook is called when a module-extension is installed.
1113 * Each module will receive hook_civicrm_install during its own installation (but not during the
1114 * installation of unrelated modules).
1116 static function install() {
1117 return self
::singleton()->invoke(0, self
::$_nullObject,
1118 self
::$_nullObject, self
::$_nullObject,
1119 self
::$_nullObject, self
::$_nullObject,
1125 * This hook is called when a module-extension is uninstalled.
1126 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1127 * uninstallation of unrelated modules).
1129 static function uninstall() {
1130 return self
::singleton()->invoke(0, self
::$_nullObject,
1131 self
::$_nullObject, self
::$_nullObject,
1132 self
::$_nullObject, self
::$_nullObject,
1138 * This hook is called when a module-extension is re-enabled.
1139 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1140 * re-enablement of unrelated modules).
1142 static function enable() {
1143 return self
::singleton()->invoke(0, self
::$_nullObject,
1144 self
::$_nullObject, self
::$_nullObject,
1145 self
::$_nullObject, self
::$_nullObject,
1151 * This hook is called when a module-extension is disabled.
1152 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1153 * disablement of unrelated modules).
1155 static function disable() {
1156 return self
::singleton()->invoke(0, self
::$_nullObject,
1157 self
::$_nullObject, self
::$_nullObject,
1158 self
::$_nullObject, self
::$_nullObject,
1163 static function alterReportVar($varType, &$var, &$object) {
1164 return self
::singleton()->invoke(3, $varType, $var, $object,
1167 'civicrm_alterReportVar'
1172 * This hook is called to drive database upgrades for extension-modules.
1174 * @param string $op the type of operation being performed; 'check' or 'enqueue'
1175 * @param string $queue (for 'enqueue') the modifiable list of pending up upgrade tasks
1177 * @return mixed based on op. 'check' returns a array(boolean) (TRUE if upgrades are pending)
1178 * 'enqueue' returns void
1181 static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1182 return self
::singleton()->invoke(2, $op, $queue,
1183 self
::$_nullObject, self
::$_nullObject,
1190 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1192 * @param array $params - the mailing parameters array fields include: groupName, from, toName, toEmail,
1193 * subject, cc, bcc, text, html, returnPath, replyTo, headers, attachments (array)
1195 static function postEmailSend(&$params) {
1196 return self
::singleton()->invoke(1, $params,
1197 self
::$_nullObject, self
::$_nullObject,
1198 self
::$_nullObject, self
::$_nullObject,
1199 'civicrm_postEmailSend'
1204 * This hook is called when Settings specifications are loaded
1206 * @param array $settingsFolders - list of paths from which to derive metadata
1208 static function alterSettingsFolders(&$settingsFolders) {
1209 return self
::singleton()->invoke(1, $settingsFolders,
1210 self
::$_nullObject, self
::$_nullObject,
1211 self
::$_nullObject, self
::$_nullObject,
1212 'civicrm_alterSettingsFolders'
1217 * This hook is called when Settings have been loaded from the xml
1218 * It is an opportunity for hooks to alter the data
1220 * @param array $settingsMetaData - Settings Metadata
1221 * @domainID integer $domainID
1223 static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1224 return self
::singleton()->invoke(3, $settingsMetaData,
1225 $domainID, $profile,
1226 self
::$_nullObject, self
::$_nullObject,
1227 'civicrm_alterSettingsMetaData'
1232 * This hook is called before running an api call.
1234 * @param $wrappers array of implements API_Wrapper(see CRM/Utils/API/ReloadOption.php as an example)
1236 * @return null the return value is ignored
1239 static function apiWrappers(&$wrappers, $apiRequest) {
1240 return self
::singleton()
1241 ->invoke(2, $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1242 'civicrm_apiWrappers'
1247 * This hook is called before running pending cron jobs.
1249 * @param CRM_Core_JobManager $jobManager
1251 * @return null the return value is ignored
1254 static function cron($jobManager) {
1255 return self
::singleton()->invoke(1,
1256 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1262 * This hook is called when loading CMS permissions; use this hook to modify
1263 * the array of system permissions for CiviCRM.
1265 * @param Array $permissions Array of permissions. See CRM_Core_Permission::getCorePermissions()
1266 * for the format of this array.
1268 * @return null the return value is ignored
1271 static function permission(&$permissions) {
1272 return self
::singleton()->invoke(1, $permissions,
1273 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1274 'civicrm_permission'
1280 * This hook is called for declaring managed entities via API
1282 * @param array $entities List of entity types; each entity-type is an array with keys:
1283 * - name: string, a unique short name (e.g. "ReportInstance")
1284 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1285 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
1287 * @return null the return value is ignored
1290 static function entityTypes(&$entityTypes) {
1291 return self
::singleton()->invoke(1, $entityTypes, self
::$_nullObject, self
::$_nullObject,
1292 self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
1297 * This hook is called while preparing a profile form
1299 * @param string $name
1302 static function buildProfile($name) {
1303 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1304 self
::$_nullObject, 'civicrm_buildProfile');
1308 * This hook is called while validating a profile form submission
1310 * @param string $name
1313 static function validateProfile($name) {
1314 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1315 self
::$_nullObject, 'civicrm_validateProfile');
1319 * This hook is called processing a valid profile form submission
1321 * @param string $name
1324 static function processProfile($name) {
1325 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1326 self
::$_nullObject, 'civicrm_processProfile');
1330 * This hook is called while preparing a read-only profile screen
1332 * @param string $name
1335 static function viewProfile($name) {
1336 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1337 self
::$_nullObject, 'civicrm_viewProfile');
1341 * This hook is called while preparing a list of contacts (based on a profile)
1343 * @param string $name
1346 static function searchProfile($name) {
1347 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1348 self
::$_nullObject, 'civicrm_searchProfile');
1352 * This hook is called before encoding data in barcode
1354 * @param array $data associated array of values available for encoding
1355 * @param string $type type of barcode, classic barcode or QRcode
1356 * @param string $context where this hooks is invoked.
1360 static function alterBarcode( &$data, $type = 'barcode', $context = 'name_badge' ) {
1361 return self
::singleton()->invoke(3, $data, $type, $context, self
::$_nullObject,
1362 self
::$_nullObject, 'civicrm_alterBarcode');
1366 * Modify or replace the Mailer object used for outgoing mail.
1368 * @param object $mailer
1369 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
1370 * @param string $driver
1371 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
1372 * @param array $params
1373 * The default mailer config options
1374 * @see Mail::factory
1376 static function alterMail(&$mailer, $driver, $params) {
1377 return self
::singleton()
1378 ->invoke(3, $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
1382 * This hook is called while building the core search query,
1383 * so hook implementers can provide their own query objects which alters/extends core search.
1385 * @param Array $queryObjects
1388 static function queryObjects(&$queryObjects, $type = 'Contact') {
1389 return self
::singleton()->invoke(2, $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
1393 * This hook is called while viewing contact dashboard
1395 * @param array $availableDashlets list of dashlets; each is formatted per api/v3/Dashboard
1396 * @param array $activeDashlets list of dashlets; each is formatted per api/v3/DashboardContact
1398 static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
1399 return self
::singleton()->invoke(2, $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');