3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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
80 * An instance of $config->userHookClass
82 public static function singleton($fresh = FALSE) {
83 if (self
::$_singleton == NULL ||
$fresh) {
84 $config = CRM_Core_Config
::singleton();
85 $class = $config->userHookClass
;
86 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $config->userHookClass
) . '.php');
87 self
::$_singleton = new $class();
89 return self
::$_singleton;
95 * @param int $numParams Number of parameters to pass to the hook
96 * @param mixed $arg1 parameter to be passed to the hook
97 * @param mixed $arg2 parameter to be passed to the hook
98 * @param mixed $arg3 parameter to be passed to the hook
99 * @param mixed $arg4 parameter to be passed to the hook
100 * @param mixed $arg5 parameter to be passed to the hook
101 * @param mixed $arg6 parameter to be passed to the hook
102 * @param string $fnSuffix function suffix, this is effectively the hook name
106 abstract function invoke($numParams,
107 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
112 * @param array $numParams
124 function commonInvoke($numParams,
125 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
129 $this->commonBuildModuleList($fnPrefix);
131 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
132 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
137 * Build the list of modules to be processed for hooks.
139 * @param string $fnPrefix
141 public function commonBuildModuleList($fnPrefix) {
142 if (!$this->commonIncluded
) {
143 // include external file
144 $this->commonIncluded
= TRUE;
146 $config = CRM_Core_Config
::singleton();
147 if (!empty($config->customPHPPathDir
) &&
148 file_exists("{$config->customPHPPathDir}/civicrmHooks.php")
150 @include_once
("civicrmHooks.php");
153 if (!empty($fnPrefix)) {
154 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
157 $this->requireCiviModules($this->commonCiviModules
);
162 * @param $civiModules
164 * @param array $numParams
174 function runHooks($civiModules, $fnSuffix, $numParams,
175 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
177 // $civiModules is *not* passed by reference because runHooks
178 // must be reentrant. PHP is finicky about running
179 // multiple loops over the same variable. The circumstances
180 // to reproduce the issue are pretty intricate.
183 if ($civiModules !== NULL) {
184 foreach ($civiModules as $module) {
185 $fnName = "{$module}_{$fnSuffix}";
186 if (function_exists($fnName)) {
188 switch ($numParams) {
190 $fResult = $fnName();
194 $fResult = $fnName($arg1);
198 $fResult = $fnName($arg1, $arg2);
202 $fResult = $fnName($arg1, $arg2, $arg3);
206 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
210 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
214 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
218 CRM_Core_Error
::fatal(ts('Invalid hook invocation'));
222 if (!empty($fResult) &&
223 is_array($fResult)) {
224 $result = array_merge($result, $fResult);
230 return empty($result) ?
TRUE : $result;
236 public function requireCiviModules(&$moduleList) {
237 $civiModules = CRM_Core_PseudoConstant
::getModuleExtensions();
238 foreach ($civiModules as $civiModule) {
239 if (!file_exists($civiModule['filePath'])) {
240 CRM_Core_Session
::setStatus(
241 ts( 'Error loading module file (%1). Please restore the file or disable the module.',
242 array(1 => $civiModule['filePath']) ),
243 ts( 'Warning'), 'error');
246 include_once $civiModule['filePath'];
247 $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
252 * This hook is called before a db write on some core objects.
253 * This hook does not allow the abort of the operation
255 * @param string $op the type of operation being performed
256 * @param string $objectName the name of the object
257 * @param int $id the object id if available
258 * @param array $params the parameters used for object creation / editing
260 * @return null the return value is ignored
262 public static function pre($op, $objectName, $id, &$params) {
263 $event = new \Civi\Core\Event\
PreEvent($op, $objectName, $id, $params);
264 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_pre", $event);
265 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_pre::$objectName", $event);
266 return self
::singleton()->invoke(4, $op, $objectName, $id, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_pre');
270 * This hook is called after a db write on some core objects.
272 * @param string $op the type of operation being performed
273 * @param string $objectName the name of the object
274 * @param int $objectId the unique identifier for the object
275 * @param object $objectRef the reference to the object if available
277 * @return mixed based on op. pre-hooks return a boolean or
278 * an error message which aborts the operation
280 public static function post($op, $objectName, $objectId, &$objectRef) {
281 $event = new \Civi\Core\Event\
PostEvent($op, $objectName, $objectId, $objectRef);
282 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_post", $event);
283 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_post::$objectName", $event);
284 return self
::singleton()->invoke(4, $op, $objectName, $objectId, $objectRef, self
::$_nullObject, self
::$_nullObject, 'civicrm_post');
288 * This hook retrieves links from other modules and injects it into
289 * the view contact tabs
291 * @param string $op the type of operation being performed
292 * @param string $objectName the name of the object
293 * @param int $objectId the unique identifier for the object
294 * @param array $links (optional) the links array (introduced in v3.2)
295 * @param int $mask (optional) the bitmask to show/hide links
296 * @param array $values (optional) the values to fill the links
298 * @return null the return value is ignored
300 public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = array()) {
301 return self
::singleton()->invoke(6, $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
305 * This hook is invoked during the CiviCRM form preProcess phase.
307 * @param string $formName the name of the form
308 * @param CRM_Core_Form $form reference to the form object
310 * @return null the return value is ignored
312 public static function preProcess($formName, &$form) {
313 return self
::singleton()->invoke(2, $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_preProcess');
317 * This hook is invoked when building a CiviCRM form. This hook should also
318 * be used to set the default values of a form element
320 * @param string $formName the name of the form
321 * @param CRM_Core_Form $form reference to the form object
323 * @return null the return value is ignored
325 public static function buildForm($formName, &$form) {
326 return self
::singleton()->invoke(2, $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_buildForm');
330 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
331 * any form elements, this hook should save the values in the database
333 * @param string $formName the name of the form
334 * @param CRM_Core_Form $form reference to the form object
336 * @return null the return value is ignored
338 public static function postProcess($formName, &$form) {
339 return self
::singleton()->invoke(2, $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_postProcess');
343 * This hook is invoked during all CiviCRM form validation. An array of errors
344 * detected is returned. Else we assume validation succeeded.
346 * @param string $formName the name of the form
347 * @param array &$fields the POST parameters as filtered by QF
348 * @param array &$files the FILES parameters as sent in by POST
349 * @param array &$form the form object
351 * @return mixed formRule hooks return a boolean or
352 * an array of error messages which display a QF Error
354 public static function validate($formName, &$fields, &$files, &$form) {
355 return self
::singleton()->invoke(4, $formName, $fields, $files, $form, self
::$_nullObject, self
::$_nullObject, 'civicrm_validate');
359 * This hook is invoked during all CiviCRM form validation. An array of errors
360 * detected is returned. Else we assume validation succeeded.
362 * @param string $formName the name of the form
363 * @param array &$fields the POST parameters as filtered by QF
364 * @param array &$files the FILES parameters as sent in by POST
365 * @param array &$form the form object
366 * @param array &$errors the array of errors.
368 * @return mixed formRule hooks return a boolean or
369 * an array of error messages which display a QF Error
371 public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
372 return self
::singleton()->invoke(5, $formName, $fields, $files, $form, $errors, self
::$_nullObject, 'civicrm_validateForm');
376 * This hook is called before a db write on a custom table
378 * @param string $op the type of operation being performed
379 * @param string $groupID the custom group ID
380 * @param object $entityID the entityID of the row in the custom table
381 * @param array $params the parameters that were sent into the calling function
383 * @return null the return value is ignored
385 public static function custom($op, $groupID, $entityID, &$params) {
386 return self
::singleton()->invoke(4, $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_custom');
390 * This hook is called when composing the ACL where clause to restrict
391 * visibility of contacts to the logged in user
393 * @param int $type the type of permission needed
394 * @param array $tables (reference ) add the tables that are needed for the select clause
395 * @param array $whereTables (reference ) add the tables that are needed for the where clause
396 * @param int $contactID the contactID for whom the check is made
397 * @param string $where the currrent where clause
399 * @return null the return value is ignored
401 public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
402 return self
::singleton()->invoke(5, $type, $tables, $whereTables, $contactID, $where, self
::$_nullObject, 'civicrm_aclWhereClause');
406 * This hook is called when composing the ACL where clause to restrict
407 * visibility of contacts to the logged in user
409 * @param int $type the type of permission needed
410 * @param int $contactID the contactID for whom the check is made
411 * @param string $tableName the tableName which is being permissioned
412 * @param array $allGroups the set of all the objects for the above table
413 * @param array $currentGroups the set of objects that are currently permissioned for this contact
415 * @return null the return value is ignored
417 public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
418 return self
::singleton()->invoke(5, $type, $contactID, $tableName, $allGroups, $currentGroups, self
::$_nullObject, 'civicrm_aclGroup');
422 * This hook is called when building the menu table
424 * @param array $files The current set of files to process
426 * @return null the return value is ignored
428 public static function xmlMenu(&$files) {
429 return self
::singleton()->invoke(1, $files,
430 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
436 * This hook is called for declaring managed entities via API
438 * @param array $entities List of pending entities
440 * @return null the return value is ignored
442 public static function managed(&$entities) {
443 return self
::singleton()->invoke(1, $entities,
444 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
450 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
452 * @param int $contactID - the contactID for whom the dashboard is being rendered
453 * @param int $contentPlacement - (output parameter) where should the hook content be displayed
454 * relative to the activity list
456 * @return string the html snippet to include in the dashboard
458 public static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
459 $retval = self
::singleton()->invoke(2, $contactID, $contentPlacement,
460 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
465 * Note we need this seemingly unnecessary code because in the event that the implementation
466 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
467 * though we have a default value in this function's declaration above.
469 if (!isset($contentPlacement)) {
470 $contentPlacement = self
::DASHBOARD_BELOW
;
477 * This hook is called before storing recently viewed items.
479 * @param array $recentArray - an array of recently viewed or processed items, for in place modification
483 public static function recent(&$recentArray) {
484 return self
::singleton()->invoke(1, $recentArray,
485 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
491 * Determine how many other records refer to a given record
493 * @param CRM_Core_DAO $dao the item for which we want a reference count
494 * @param array $refCounts each item in the array is an array with keys:
495 * - name: string, eg "sql:civicrm_email:contact_id"
496 * - type: string, eg "sql"
497 * - count: int, eg "5" if there are 5 email addresses that refer to $dao
500 public static function referenceCounts($dao, &$refCounts) {
501 return self
::singleton()->invoke(2, $dao, $refCounts,
502 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
503 'civicrm_referenceCounts'
508 * This hook is called when building the amount structure for a Contribution or Event Page
510 * @param int $pageType - is this a contribution or event page
511 * @param CRM_Core_Form $form - reference to the form object
512 * @param array $amount - the amount structure to be displayed
516 public static function buildAmount($pageType, &$form, &$amount) {
517 return self
::singleton()->invoke(3, $pageType, $form, $amount, self
::$_nullObject,
518 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildAmount');
522 * This hook is called when building the state list for a particular country.
524 * @param array $countryID
525 * The country id whose states are being selected.
530 public static function buildStateProvinceForCountry($countryID, &$states) {
531 return self
::singleton()->invoke(2, $countryID, $states,
532 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
533 'civicrm_buildStateProvinceForCountry'
538 * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
540 * @param array $tabs - the array of tabs that will be displayed
541 * @param int $contactID - the contactID for whom the dashboard is being rendered
545 public static function tabs(&$tabs, $contactID) {
546 return self
::singleton()->invoke(2, $tabs, $contactID,
547 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabs'
552 * This hook is called when rendering the tabs used for events and potentially
553 * contribution pages, etc.
555 * @param string $tabsetName
556 * Name of the screen or visual element.
558 * Tabs that will be displayed.
559 * @param array $context
560 * Extra data about the screen or context in which the tab is used.
564 public static function tabset($tabsetName, &$tabs, $context) {
565 return self
::singleton()->invoke(3, $tabsetName, $tabs,
566 $context, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
571 * This hook is called when sending an email / printing labels
573 * @param array $tokens - the list of tokens that can be used for the contact
577 public static function tokens(&$tokens) {
578 return self
::singleton()->invoke(1, $tokens,
579 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
584 * This hook is called when sending an email / printing labels to get the values for all the
585 * tokens returned by the 'tokens' hook
587 * @param array $details - the array to store the token values indexed by contactIDs (unless it a single)
588 * @param array $contactIDs - an array of contactIDs
589 * @param int $jobID - the jobID if this is associated with a CiviMail mailing
590 * @param array $tokens - the list of tokens associated with the content
591 * @param string $className - the top level className from where the hook is invoked
595 static function tokenValues(&$details,
601 return self
::singleton()->invoke(5, $details, $contactIDs, $jobID, $tokens, $className, self
::$_nullObject, 'civicrm_tokenValues');
605 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
608 * @param object $page - the page that will be rendered
612 public static function pageRun(&$page) {
613 return self
::singleton()->invoke(1, $page,
614 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
620 * This hook is called after a copy of an object has been made. The current objects are
621 * Event, Contribution Page and UFGroup
623 * @param string $objectName - name of the object
624 * @param object $object - reference to the copy
628 public static function copy($objectName, &$object) {
629 return self
::singleton()->invoke(2, $objectName, $object,
630 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
636 * This hook is called when a contact unsubscribes from a mailing. It allows modules
637 * to override what the contacts are removed from.
641 * @param int $mailingId
642 * The id of the mailing to unsub from
643 * @param int $contactId
644 * The id of the contact who is unsubscribing
645 * @param array|int $groups
646 * Groups the contact will be removed from.
647 * @param array|int $baseGroups
648 * Base groups (used in smart mailings) the contact will be removed from.
653 public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
654 return self
::singleton()->invoke(5, $op, $mailingId, $contactId, $groups, $baseGroups, self
::$_nullObject, 'civicrm_unsubscribeGroups');
658 * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox,
661 * @param int $customFieldID - the custom field ID
662 * @param array $options - the current set of options for that custom field.
663 * You can add/remove existing options.
664 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
665 * to be careful to not overwrite the array.
666 * Only add/edit/remove the specific field options you intend to affect.
667 * @param boolean $detailedFormat - if true,
668 * the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
669 * @param array $selectAttributes contain select attribute(s) if any
673 public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = array()) {
674 return self
::singleton()->invoke(3, $customFieldID, $options, $detailedFormat,
675 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
676 'civicrm_customFieldOptions'
682 * This hook is called to display the list of actions allowed after doing a search.
683 * This allows the module developer to inject additional actions or to remove existing actions.
685 * @param string $objectType - the object type for this search
686 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
687 * @param array $tasks - the current set of tasks for that custom field.
688 * You can add/remove existing tasks.
689 * Each task needs to have a title (eg 'title' => ts( 'Add Contacts to Group')) and a class
690 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
691 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
692 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
693 * found in CRM/$objectType/Task.php.
697 public static function searchTasks($objectType, &$tasks) {
698 return self
::singleton()->invoke(2, $objectType, $tasks,
699 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
700 'civicrm_searchTasks'
706 * @param array $params
710 public static function eventDiscount(&$form, &$params) {
711 return self
::singleton()->invoke(2, $form, $params,
712 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
713 'civicrm_eventDiscount'
718 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
721 * The form object for which groups / mailings being displayed
722 * @param array $groups
723 * The list of groups being included / excluded
724 * @param array $mailings
725 * The list of mailings being included / excluded
729 public static function mailingGroups(&$form, &$groups, &$mailings) {
730 return self
::singleton()->invoke(3, $form, $groups, $mailings,
731 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
732 'civicrm_mailingGroups'
737 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
739 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
740 * You can use it to alter the membership types when first loaded, or after submission
741 * (for example if you want to gather data in the form and use it to alter the fees).
744 * The form object that is presenting the page
745 * @param array $membershipTypes
746 * The array of membership types and their amount
750 public static function membershipTypeValues(&$form, &$membershipTypes) {
751 return self
::singleton()->invoke(2, $form, $membershipTypes,
752 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
753 'civicrm_membershipTypeValues'
758 * This hook is called when rendering the contact summary
760 * @param int $contactID
761 * The contactID for whom the summary is being rendered
762 * @param mixed $content
763 * @param int $contentPlacement
764 * Specifies where the hook content should be displayed relative to the
768 * The html snippet to include in the contact summary
770 public static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
771 return self
::singleton()->invoke(3, $contactID, $content, $contentPlacement,
772 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
778 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
779 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
780 * If you want to limit the contacts returned to a specific group, or some other criteria
781 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
782 * The hook is called when the query is executed to get the list of contacts to display.
784 * @param mixed $query - - the query that will be executed (input and output parameter);
785 * It's important to realize that the ACL clause is built prior to this hook being fired,
786 * so your query will ignore any ACL rules that may be defined.
787 * Your query must return two columns:
788 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
790 * @param string $name - the name string to execute the query against (this is the value being typed in by the user)
791 * @param string $context - the context in which this ajax call is being made (for example: 'customfield', 'caseview')
792 * @param int $id - the id of the object for which the call is being made.
793 * For custom fields, it will be the custom field id
797 public static function contactListQuery(&$query, $name, $context, $id) {
798 return self
::singleton()->invoke(4, $query, $name, $context, $id,
799 self
::$_nullObject, self
::$_nullObject,
800 'civicrm_contactListQuery'
805 * Hook definition for altering payment parameters before talking to a payment processor back end.
807 * Definition will look like this:
809 * function hook_civicrm_alterPaymentProcessorParams($paymentObj,
810 * &$rawParams, &$cookedParams);
812 * @param string $paymentObj
813 * instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
814 * @param array &$rawParams
815 * array of params as passed to to the processor
816 * @param array &$cookedParams
817 * params after the processor code has translated them into its own key/value pairs
821 static function alterPaymentProcessorParams($paymentObj,
825 return self
::singleton()->invoke(3, $paymentObj, $rawParams, $cookedParams,
826 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
827 'civicrm_alterPaymentProcessorParams'
832 * This hook is called when an email is about to be sent by CiviCRM.
834 * @param array $params
835 * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
836 * returnPath, replyTo, headers, attachments (array)
837 * @param string $context - the context in which the hook is being invoked, eg 'civimail'
841 public static function alterMailParams(&$params, $context = NULL) {
842 return self
::singleton()->invoke(2, $params, $context,
843 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
844 'civicrm_alterMailParams'
849 * This hook is called when membership status is being calculated
851 * @param array $membershipStatus membership status details as determined - alter if required
852 * @param array $arguments arguments passed in to calculate date
857 * - 'exclude_is_admin'
858 * - 'membership_type_id'
859 * @param array $membership membership details from the calling function
863 public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
864 return self
::singleton()->invoke(3, $membershipStatus, $arguments,
865 $membership, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
866 'civicrm_alterCalculatedMembershipStatus'
871 * This hook is called when rendering the Manage Case screen
873 * @param int $caseID - the case ID
875 * @return array of data to be displayed, where the key is a unique id to be used for styling (div id's)
876 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
878 public static function caseSummary($caseID) {
879 return self
::singleton()->invoke(1, $caseID,
880 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
881 'civicrm_caseSummary'
886 * This hook is called when locating CiviCase types.
888 * @param array $caseTypes
892 public static function caseTypes(&$caseTypes) {
893 return self
::singleton()->invoke(1, $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
897 * This hook is called soon after the CRM_Core_Config object has ben initialized.
898 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
900 * @param CRM_Core_Config|array $config
905 public static function config(&$config) {
906 return self
::singleton()->invoke(1, $config,
907 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
914 * @param int $recordID
919 public static function enableDisable($recordBAO, $recordID, $isActive) {
920 return self
::singleton()->invoke(3, $recordBAO, $recordID, $isActive,
921 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
922 'civicrm_enableDisable'
927 * This hooks allows to change option values
929 * @param array $options
930 * Associated array of option values / id
931 * @param string $name
936 public static function optionValues(&$options, $name) {
937 return self
::singleton()->invoke(2, $options, $name,
938 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
939 'civicrm_optionValues'
944 * This hook allows modification of the navigation menu.
946 * @param array $params
947 * Associated array of navigation menu entry to Modify/Add
951 public static function navigationMenu(&$params) {
952 return self
::singleton()->invoke(1, $params,
953 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
954 'civicrm_navigationMenu'
959 * This hook allows modification of the data used to perform merging of duplicates.
961 * @param string $type the type of data being passed (cidRefs|eidRefs|relTables|sqls)
962 * @param array $data the data, as described in $type
963 * @param int $mainId contact_id of the contact that survives the merge
964 * @param int $otherId contact_id of the contact that will be absorbed and deleted
965 * @param array $tables when $type is "sqls", an array of tables as it may have been handed to the calling function
969 public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
970 return self
::singleton()->invoke(5, $type, $data, $mainId, $otherId, $tables, self
::$_nullObject, 'civicrm_merge');
974 * This hook provides a way to override the default privacy behavior for notes.
976 * @param array &$noteValues
977 * Associative array of values for this note
981 public static function notePrivacy(&$noteValues) {
982 return self
::singleton()->invoke(1, $noteValues,
983 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
984 'civicrm_notePrivacy'
989 * This hook is called before record is exported as CSV
991 * @param string $exportTempTable - name of the temporary export table used during export
992 * @param array $headerRows - header rows for output
993 * @param array $sqlColumns - SQL columns
994 * @param int $exportMode - export mode ( contact, contribution, etc...)
998 public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode) {
999 return self
::singleton()->invoke(4, $exportTempTable, $headerRows, $sqlColumns, $exportMode,
1000 self
::$_nullObject, self
::$_nullObject,
1006 * This hook allows modification of the queries constructed from dupe rules.
1008 * @param string $obj object of rulegroup class
1009 * @param string $type type of queries e.g table / threshold
1010 * @param array $query set of queries
1014 public static function dupeQuery($obj, $type, &$query) {
1015 return self
::singleton()->invoke(3, $obj, $type, $query,
1016 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1022 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1024 * @param string $type type of mail processed: 'activity' OR 'mailing'
1025 * @param array &$params the params that were sent to the CiviCRM API function
1026 * @param object $mail the mail object which is an ezcMail class
1027 * @param array &$result the result returned by the api call
1028 * @param string $action (optional ) the requested action to be performed if the types was 'mailing'
1032 public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1033 return self
::singleton()->invoke(5, $type, $params, $mail, $result, $action, self
::$_nullObject, 'civicrm_emailProcessor');
1037 * This hook is called after a row has been processed and the
1038 * record (and associated records imported
1040 * @param string $object - object being imported (for now Contact only, later Contribution, Activity,
1041 * Participant and Member)
1042 * @param string $usage - hook usage/location (for now process only, later mapping and others)
1043 * @param string $objectRef - import record object
1044 * @param array $params - array with various key values: currently
1045 * contactID - contact id
1046 * importID - row id in temp table
1047 * importTempTable - name of tempTable
1048 * fieldHeaders - field headers
1049 * fields - import fields
1053 public static function import($object, $usage, &$objectRef, &$params) {
1054 return self
::singleton()->invoke(4, $object, $usage, $objectRef, $params,
1055 self
::$_nullObject, self
::$_nullObject,
1061 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1062 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1064 * @param string $entity the API entity (like contact)
1065 * @param string $action the API action (like get)
1066 * @param array &$params the API parameters
1067 * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1071 public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1072 return self
::singleton()->invoke(4, $entity, $action, $params, $permissions,
1073 self
::$_nullObject, self
::$_nullObject,
1074 'civicrm_alterAPIPermissions'
1079 * @param CRM_Core_DAO $dao
1083 public static function postSave(&$dao) {
1084 $hookName = 'civicrm_postSave_' . $dao->getTableName();
1085 return self
::singleton()->invoke(1, $dao,
1086 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1092 * This hook allows user to customize context menu Actions on contact summary page.
1094 * @param array $actions Array of all Actions in contextmenu.
1095 * @param int $contactID ContactID for the summary page
1099 public static function summaryActions(&$actions, $contactID = NULL) {
1100 return self
::singleton()->invoke(2, $actions, $contactID,
1101 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1102 'civicrm_summaryActions'
1107 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1108 * This enables us hook implementors to modify both the headers and the rows
1110 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1111 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1113 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1114 * you want displayed. This is a hackish, but avoids template modification.
1116 * @param string $objectName the component name that we are doing the search
1117 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1118 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1119 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1122 * @internal param array $seletor the selector object. Allows you access to the context of the search
1124 * @return void modify the header and values object to pass the data u need
1126 public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1127 return self
::singleton()->invoke(4, $objectName, $headers, $rows, $selector,
1128 self
::$_nullObject, self
::$_nullObject,
1129 'civicrm_searchColumns'
1134 * This hook is called when uf groups are being built for a module.
1136 * @param string $moduleName module name.
1137 * @param array $ufGroups array of ufgroups for a module.
1141 public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1142 return self
::singleton()->invoke(2, $moduleName, $ufGroups,
1143 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1144 'civicrm_buildUFGroupsForModule'
1149 * This hook is called when we are determining the contactID for a specific
1152 * @param string $email the email address
1153 * @param int $contactID the contactID that matches this email address, IF it exists
1154 * @param array $result (reference) has two fields
1155 * contactID - the new (or same) contactID
1156 * action - 3 possible values:
1157 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1158 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1159 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1163 public static function emailProcessorContact($email, $contactID, &$result) {
1164 return self
::singleton()->invoke(3, $email, $contactID, $result,
1165 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1166 'civicrm_emailProcessorContact'
1171 * Hook definition for altering the generation of Mailing Labels
1173 * @param array $args an array of the args in the order defined for the tcpdf multiCell api call
1174 * with the variable names below converted into string keys (ie $w become 'w'
1175 * as the first key for $args)
1176 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1177 * float $h Cell minimum height. The cell extends automatically if needed.
1178 * string $txt String to print
1179 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1180 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1181 * a string containing some or all of the following characters (in any order):
1182 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1183 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1184 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1185 * (default value when $ishtml=false)</li></ul>
1186 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1187 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1188 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1189 * float $x x position in user units
1190 * float $y y position in user units
1191 * boolean $reseth if true reset the last cell height (default true).
1192 * int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1193 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1194 * necessary</li><li>4 = forced character spacing</li></ul>
1195 * boolean $ishtml set to true if $txt is HTML content (default = false).
1196 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1197 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1198 * or 0 for disable this feature. This feature works only when $ishtml=false.
1202 public static function alterMailingLabelParams(&$args) {
1203 return self
::singleton()->invoke(1, $args,
1204 self
::$_nullObject, self
::$_nullObject,
1205 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1206 'civicrm_alterMailingLabelParams'
1211 * This hooks allows alteration of generated page content
1213 * @param $content previously generated content
1214 * @param $context context of content - page or form
1215 * @param $tplName the file name of the tpl
1216 * @param $object a reference to the page or form object
1220 public static function alterContent(&$content, $context, $tplName, &$object) {
1221 return self
::singleton()->invoke(4, $content, $context, $tplName, $object,
1222 self
::$_nullObject, self
::$_nullObject,
1223 'civicrm_alterContent'
1228 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1229 * altercontent hook as the content has already been rendered through the tpl at that point
1231 * @param $formName previously generated content
1232 * @param $form reference to the form object
1233 * @param $context context of content - page or form
1234 * @param $tplName reference the file name of the tpl
1238 public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1239 return self
::singleton()->invoke(4, $formName, $form, $context, $tplName,
1240 self
::$_nullObject, self
::$_nullObject,
1241 'civicrm_alterTemplateFile'
1246 * This hook collects the trigger definition from all components
1249 * @param string $tableName (optional) the name of the table that we are interested in only
1251 * @internal param \reference $triggerInfo to an array of trigger information
1252 * each element has 4 fields:
1253 * table - array of tableName
1254 * when - BEFORE or AFTER
1255 * event - array of eventName - INSERT OR UPDATE OR DELETE
1256 * sql - array of statements optionally terminated with a ;
1257 * a statement can use the tokes {tableName} and {eventName}
1258 * to do token replacement with the table / event. This allows
1259 * templatizing logging and other hooks
1262 public static function triggerInfo(&$info, $tableName = NULL) {
1263 return self
::singleton()->invoke(2, $info, $tableName,
1264 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1266 'civicrm_triggerInfo'
1271 * This hook is called when a module-extension is installed.
1272 * Each module will receive hook_civicrm_install during its own installation (but not during the
1273 * installation of unrelated modules).
1275 public static function install() {
1276 return self
::singleton()->invoke(0, self
::$_nullObject,
1277 self
::$_nullObject, self
::$_nullObject,
1278 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1284 * This hook is called when a module-extension is uninstalled.
1285 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1286 * uninstallation of unrelated modules).
1288 public static function uninstall() {
1289 return self
::singleton()->invoke(0, self
::$_nullObject,
1290 self
::$_nullObject, self
::$_nullObject,
1291 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1297 * This hook is called when a module-extension is re-enabled.
1298 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1299 * re-enablement of unrelated modules).
1301 public static function enable() {
1302 return self
::singleton()->invoke(0, self
::$_nullObject,
1303 self
::$_nullObject, self
::$_nullObject,
1304 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1310 * This hook is called when a module-extension is disabled.
1311 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1312 * disablement of unrelated modules).
1314 public static function disable() {
1315 return self
::singleton()->invoke(0, self
::$_nullObject,
1316 self
::$_nullObject, self
::$_nullObject,
1317 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1329 public static function alterReportVar($varType, &$var, &$object) {
1330 return self
::singleton()->invoke(3, $varType, $var, $object,
1332 self
::$_nullObject, self
::$_nullObject,
1333 'civicrm_alterReportVar'
1338 * This hook is called to drive database upgrades for extension-modules.
1341 * The type of operation being performed; 'check' or 'enqueue'.
1342 * @param CRM_Queue_Queue $queue
1343 * (for 'enqueue') the modifiable list of pending up upgrade tasks.
1346 * NULL, if $op is 'enqueue'.
1347 * TRUE, if $op is 'check' and upgrades are pending.
1348 * FALSE, if $op is 'check' and upgrades are not pending.
1350 public static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1351 return self
::singleton()->invoke(2, $op, $queue,
1352 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1359 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1361 * @param array $params
1362 * The mailing parameters. Array fields include: groupName, from, toName,
1363 * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1364 * attachments (array)
1368 public static function postEmailSend(&$params) {
1369 return self
::singleton()->invoke(1, $params,
1370 self
::$_nullObject, self
::$_nullObject,
1371 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1372 'civicrm_postEmailSend'
1377 * This hook is called when Settings specifications are loaded
1379 * @param array $settingsFolders
1380 * List of paths from which to derive metadata
1384 public static function alterSettingsFolders(&$settingsFolders) {
1385 return self
::singleton()->invoke(1, $settingsFolders,
1386 self
::$_nullObject, self
::$_nullObject,
1387 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1388 'civicrm_alterSettingsFolders'
1393 * This hook is called when Settings have been loaded from the xml
1394 * It is an opportunity for hooks to alter the data
1396 * @param array $settingsMetaData - Settings Metadata
1397 * @param int $domainID
1398 * @param mixed $profile
1402 public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1403 return self
::singleton()->invoke(3, $settingsMetaData,
1404 $domainID, $profile,
1405 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1406 'civicrm_alterSettingsMetaData'
1411 * This hook is called before running an api call.
1413 * @param API_Wrapper[] $wrappers
1414 * (see CRM_Utils_API_ReloadOption as an example)
1415 * @param mixed $apiRequest
1418 * The return value is ignored
1420 public static function apiWrappers(&$wrappers, $apiRequest) {
1421 return self
::singleton()
1422 ->invoke(2, $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1423 self
::$_nullObject, 'civicrm_apiWrappers'
1428 * This hook is called before running pending cron jobs.
1430 * @param CRM_Core_JobManager $jobManager
1433 * The return value is ignored.
1435 public static function cron($jobManager) {
1436 return self
::singleton()->invoke(1,
1437 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1443 * This hook is called when loading CMS permissions; use this hook to modify
1444 * the array of system permissions for CiviCRM.
1446 * @param array $permissions
1447 * Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1448 * the format of this array.
1451 * The return value is ignored
1453 public static function permission(&$permissions) {
1454 return self
::singleton()->invoke(1, $permissions,
1455 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1456 'civicrm_permission'
1461 * @param CRM_Core_Exception Exception $exception
1462 * @param mixed $request reserved for future use
1464 static function unhandledException($exception, $request = NULL) {
1465 self
::singleton()->invoke(2, $exception, $request, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,'civicrm_unhandled_exception');
1467 //$event = new stdClass();
1468 //$event->exception = $exception;
1469 //CRM_Core_LegacyErrorHandler::handleException($event);
1472 $event = new \Civi\Core\Event\
UnhandledExceptionEvent($exception, self
::$_nullObject);
1473 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_unhandled_exception", $event);
1477 * This hook is called for declaring managed entities via API
1479 * @param array[] $entityTypes
1480 * List of entity types; each entity-type is an array with keys:
1481 * - name: string, a unique short name (e.g. "ReportInstance")
1482 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1483 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
1486 * The return value is ignored
1488 public static function entityTypes(&$entityTypes) {
1489 return self
::singleton()->invoke(1, $entityTypes, self
::$_nullObject, self
::$_nullObject,
1490 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
1495 * This hook is called while preparing a profile form
1497 * @param string $name
1500 public static function buildProfile($name) {
1501 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1502 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildProfile');
1506 * This hook is called while validating a profile form submission
1508 * @param string $name
1511 public static function validateProfile($name) {
1512 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1513 self
::$_nullObject, self
::$_nullObject, 'civicrm_validateProfile');
1517 * This hook is called processing a valid profile form submission
1519 * @param string $name
1522 public static function processProfile($name) {
1523 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1524 self
::$_nullObject, self
::$_nullObject, 'civicrm_processProfile');
1528 * This hook is called while preparing a read-only profile screen
1530 * @param string $name
1533 public static function viewProfile($name) {
1534 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1535 self
::$_nullObject, self
::$_nullObject, 'civicrm_viewProfile');
1539 * This hook is called while preparing a list of contacts (based on a profile)
1541 * @param string $name
1544 public static function searchProfile($name) {
1545 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1546 self
::$_nullObject, self
::$_nullObject, 'civicrm_searchProfile');
1550 * This hook is invoked when building a CiviCRM name badge.
1552 * @param string $labelName string referencing name of badge format
1553 * @param object $label reference to the label object
1554 * @param array $format array of format data
1555 * @param array $participant array of participant values
1557 * @return null the return value is ignored
1559 public static function alterBadge($labelName, &$label, &$format, &$participant) {
1560 return self
::singleton()->invoke(4, $labelName, $label, $format, $participant, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBadge');
1565 * This hook is called before encoding data in barcode
1567 * @param array $data associated array of values available for encoding
1568 * @param string $type type of barcode, classic barcode or QRcode
1569 * @param string $context where this hooks is invoked.
1573 public static function alterBarcode( &$data, $type = 'barcode', $context = 'name_badge' ) {
1574 return self
::singleton()->invoke(3, $data, $type, $context, self
::$_nullObject,
1575 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBarcode');
1579 * Modify or replace the Mailer object used for outgoing mail.
1581 * @param object $mailer
1582 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
1583 * @param string $driver
1584 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
1585 * @param array $params
1586 * The default mailer config options
1589 * @see Mail::factory
1591 public static function alterMail(&$mailer, $driver, $params) {
1592 return self
::singleton()
1593 ->invoke(3, $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
1597 * This hook is called while building the core search query,
1598 * so hook implementers can provide their own query objects which alters/extends core search.
1600 * @param array $queryObjects
1601 * @param string $type
1605 public static function queryObjects(&$queryObjects, $type = 'Contact') {
1606 return self
::singleton()->invoke(2, $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
1610 * This hook is called while viewing contact dashboard
1612 * @param array $availableDashlets
1613 * List of dashlets; each is formatted per api/v3/Dashboard
1614 * @param array $defaultDashlets
1615 * List of dashlets; each is formatted per api/v3/DashboardContact
1619 public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
1620 return self
::singleton()->invoke(2, $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');
1624 * This hook is called before a case merge (or a case reassign)
1626 * @param integer $mainContactId
1627 * @param integer $mainCaseId
1628 * @param integer $otherContactId
1629 * @param integer $otherCaseId
1630 * @param bool $changeClient
1634 public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1635 return self
::singleton()->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_pre_case_merge');
1639 * This hook is called after a case merge (or a case reassign)
1641 * @param integer $mainContactId
1642 * @param integer $mainCaseId
1643 * @param integer $otherContactId
1644 * @param integer $otherCaseId
1645 * @param bool $changeClient
1649 public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1650 return self
::singleton()->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_post_case_merge');
1655 * Add a hook for altering the display name
1657 * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
1659 * @param string $displayName
1660 * @param int $contactId
1661 * @param object $dao the contact object
1665 public static function alterDisplayName($displayName, $contactId, $dao) {
1666 return self
::singleton()->invoke(3,
1667 $displayName, $contactId, $dao, self
::$_nullObject, self
::$_nullObject,
1668 self
::$_nullObject, 'civicrm_contact_get_displayname'
1673 * EXPERIMENTAL: This hook allows one to register additional Angular modules
1675 * @param array $angularModules list of modules
1676 * @return null the return value is ignored
1679 * function mymod_civicrm_angularModules(&$angularModules) {
1680 * $angularModules['myAngularModule'] = array('ext' => 'org.example.mymod', 'js' => array('js/myAngularModule.js'));
1681 * $angularModules['myBigAngularModule'] = array('ext' => 'org.example.mymod', 'js' => array('js/part1.js', 'js/part2.js'), 'css' => array('css/myAngularModule.css'));
1685 public static function angularModules(&$angularModules) {
1686 return self
::singleton()->invoke(1, $angularModules,
1687 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1688 'civicrm_angularModules'
1693 * This hook fires whenever a record in a case changes.
1695 * @param \Civi\CCase\Analyzer $analyzer
1697 public static function caseChange(\Civi\CCase\Analyzer
$analyzer) {
1698 $event = new \Civi\CCase\Event\
CaseChangeEvent($analyzer);
1699 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_caseChange", $event);
1701 return self
::singleton()->invoke(1, $angularModules,
1702 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1703 'civicrm_caseChange'
1708 * Generate a default CRUD URL for an entity
1710 * @param array $spec with keys:
1711 * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
1712 * - entity_table: string
1714 * @param CRM_Core_DAO $bao
1715 * @param array $link to define the link, add these keys to $link:
1719 * - url: string (used in lieu of "path"/"query")
1720 * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
1723 public static function crudLink($spec, $bao, &$link) {
1724 return self
::singleton()->invoke(3, $spec, $bao, $link,
1725 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1731 * @param array<CRM_Core_FileSearchInterface> $fileSearches
1734 public static function fileSearches(&$fileSearches) {
1735 return self
::singleton()->invoke(1, $fileSearches,
1736 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1737 'civicrm_fileSearches'