3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
30 * @package CiviCRM_Hook
31 * @copyright CiviCRM LLC (c) 2004-2015
33 abstract class CRM_Utils_Hook
{
35 // Allowed values for dashboard hook content placement
36 // Default - place content below activity list
37 const DASHBOARD_BELOW
= 1;
38 // Place content above activity list
39 const DASHBOARD_ABOVE
= 2;
40 // Don't display activity list at all
41 const DASHBOARD_REPLACE
= 3;
43 // by default - place content below existing content
44 const SUMMARY_BELOW
= 1;
45 // pace hook content above
46 const SUMMARY_ABOVE
= 2;
47 // create your own summarys
48 const SUMMARY_REPLACE
= 3;
50 static $_nullObject = NULL;
53 * We only need one instance of this object. So we use the singleton
54 * pattern and cache the instance in this variable
58 static private $_singleton = NULL;
63 private $commonIncluded = FALSE;
68 private $commonCiviModules = array();
71 * Constructor and getter for the singleton instance.
76 * An instance of $config->userHookClass
78 public static function singleton($fresh = FALSE) {
79 if (self
::$_singleton == NULL ||
$fresh) {
80 $config = CRM_Core_Config
::singleton();
81 $class = $config->userHookClass
;
82 self
::$_singleton = new $class();
84 return self
::$_singleton;
90 * @param int $numParams
91 * Number of parameters to pass to the hook.
93 * Parameter to be passed to the hook.
95 * Parameter to be passed to the hook.
97 * Parameter to be passed to the hook.
99 * Parameter to be passed to the hook.
101 * Parameter to be passed to the hook.
103 * Parameter to be passed to the hook.
104 * @param string $fnSuffix
105 * Function suffix, this is effectively the hook name.
109 public abstract function invoke(
111 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
116 * @param array $numParams
128 public function commonInvoke(
130 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
134 $this->commonBuildModuleList($fnPrefix);
136 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
137 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
142 * Build the list of modules to be processed for hooks.
144 * @param string $fnPrefix
146 public function commonBuildModuleList($fnPrefix) {
147 if (!$this->commonIncluded
) {
148 // include external file
149 $this->commonIncluded
= TRUE;
151 $config = CRM_Core_Config
::singleton();
152 if (!empty($config->customPHPPathDir
) &&
153 file_exists("{$config->customPHPPathDir}/civicrmHooks.php")
155 @include_once
"civicrmHooks.php";
158 if (!empty($fnPrefix)) {
159 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
162 $this->requireCiviModules($this->commonCiviModules
);
167 * @param $civiModules
169 * @param array $numParams
179 public function runHooks(
180 $civiModules, $fnSuffix, $numParams,
181 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
183 // $civiModules is *not* passed by reference because runHooks
184 // must be reentrant. PHP is finicky about running
185 // multiple loops over the same variable. The circumstances
186 // to reproduce the issue are pretty intricate.
189 if ($civiModules !== NULL) {
190 foreach ($civiModules as $module) {
191 $fnName = "{$module}_{$fnSuffix}";
192 if (function_exists($fnName)) {
194 switch ($numParams) {
196 $fResult = $fnName();
200 $fResult = $fnName($arg1);
204 $fResult = $fnName($arg1, $arg2);
208 $fResult = $fnName($arg1, $arg2, $arg3);
212 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
216 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
220 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
224 CRM_Core_Error
::fatal(ts('Invalid hook invocation'));
228 if (!empty($fResult) &&
231 $result = array_merge($result, $fResult);
237 return empty($result) ?
TRUE : $result;
243 public function requireCiviModules(&$moduleList) {
244 $civiModules = CRM_Core_PseudoConstant
::getModuleExtensions();
245 foreach ($civiModules as $civiModule) {
246 if (!file_exists($civiModule['filePath'])) {
247 CRM_Core_Session
::setStatus(
248 ts('Error loading module file (%1). Please restore the file or disable the module.',
249 array(1 => $civiModule['filePath'])),
250 ts('Warning'), 'error');
253 include_once $civiModule['filePath'];
254 $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
259 * This hook is called before a db write on some core objects.
260 * This hook does not allow the abort of the operation
263 * The type of operation being performed.
264 * @param string $objectName
265 * The name of the object.
267 * The object id if available.
268 * @param array $params
269 * The parameters used for object creation / editing.
272 * the return value is ignored
274 public static function pre($op, $objectName, $id, &$params) {
275 $event = new \Civi\Core\Event\
PreEvent($op, $objectName, $id, $params);
276 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_pre", $event);
277 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_pre::$objectName", $event);
278 return self
::singleton()
279 ->invoke(4, $op, $objectName, $id, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_pre');
283 * This hook is called after a db write on some core objects.
286 * The type of operation being performed.
287 * @param string $objectName
288 * The name of the object.
289 * @param int $objectId
290 * The unique identifier for the object.
291 * @param object $objectRef
292 * The reference to the object if available.
295 * based on op. pre-hooks return a boolean or
296 * an error message which aborts the operation
298 public static function post($op, $objectName, $objectId, &$objectRef) {
299 $event = new \Civi\Core\Event\
PostEvent($op, $objectName, $objectId, $objectRef);
300 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_post", $event);
301 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_post::$objectName", $event);
302 return self
::singleton()
303 ->invoke(4, $op, $objectName, $objectId, $objectRef, self
::$_nullObject, self
::$_nullObject, 'civicrm_post');
307 * This hook retrieves links from other modules and injects it into.
308 * the view contact tabs
311 * The type of operation being performed.
312 * @param string $objectName
313 * The name of the object.
314 * @param int $objectId
315 * The unique identifier for the object.
316 * @param array $links
317 * (optional) the links array (introduced in v3.2).
319 * (optional) the bitmask to show/hide links.
320 * @param array $values
321 * (optional) the values to fill the links.
324 * the return value is ignored
326 public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = array()) {
327 return self
::singleton()->invoke(6, $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
331 * This hook is invoked during the CiviCRM form preProcess phase.
333 * @param string $formName
334 * The name of the form.
335 * @param CRM_Core_Form $form
336 * Reference to the form object.
339 * the return value is ignored
341 public static function preProcess($formName, &$form) {
342 return self
::singleton()
343 ->invoke(2, $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_preProcess');
347 * This hook is invoked when building a CiviCRM form. This hook should also
348 * be used to set the default values of a form element
350 * @param string $formName
351 * The name of the form.
352 * @param CRM_Core_Form $form
353 * Reference to the form object.
356 * the return value is ignored
358 public static function buildForm($formName, &$form) {
359 return self
::singleton()->invoke(2, $formName, $form,
360 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
366 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
367 * any form elements, this hook should save the values in the database
369 * @param string $formName
370 * The name of the form.
371 * @param CRM_Core_Form $form
372 * Reference to the form object.
375 * the return value is ignored
377 public static function postProcess($formName, &$form) {
378 return self
::singleton()->invoke(2, $formName, $form,
379 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
380 'civicrm_postProcess'
385 * This hook is invoked during all CiviCRM form validation. An array of errors
386 * detected is returned. Else we assume validation succeeded.
388 * @param string $formName
389 * The name of the form.
390 * @param array &$fields the POST parameters as filtered by QF
391 * @param array &$files the FILES parameters as sent in by POST
392 * @param array &$form the form object
393 * @param array &$errors the array of errors.
396 * formRule hooks return a boolean or
397 * an array of error messages which display a QF Error
399 public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
400 return self
::singleton()
401 ->invoke(5, $formName, $fields, $files, $form, $errors, self
::$_nullObject, 'civicrm_validateForm');
405 * This hook is called after a db write on a custom table.
408 * The type of operation being performed.
409 * @param string $groupID
410 * The custom group ID.
411 * @param object $entityID
412 * The entityID of the row in the custom table.
413 * @param array $params
414 * The parameters that were sent into the calling function.
417 * the return value is ignored
419 public static function custom($op, $groupID, $entityID, &$params) {
420 return self
::singleton()
421 ->invoke(4, $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_custom');
425 * This hook is called when composing the ACL where clause to restrict
426 * visibility of contacts to the logged in user
429 * The type of permission needed.
430 * @param array $tables
431 * (reference ) add the tables that are needed for the select clause.
432 * @param array $whereTables
433 * (reference ) add the tables that are needed for the where clause.
434 * @param int $contactID
435 * The contactID for whom the check is made.
436 * @param string $where
437 * The currrent where clause.
440 * the return value is ignored
442 public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
443 return self
::singleton()
444 ->invoke(5, $type, $tables, $whereTables, $contactID, $where, self
::$_nullObject, 'civicrm_aclWhereClause');
448 * This hook is called when composing the ACL where clause to restrict
449 * visibility of contacts to the logged in user
452 * The type of permission needed.
453 * @param int $contactID
454 * The contactID for whom the check is made.
455 * @param string $tableName
456 * The tableName which is being permissioned.
457 * @param array $allGroups
458 * The set of all the objects for the above table.
459 * @param array $currentGroups
460 * The set of objects that are currently permissioned for this contact.
463 * the return value is ignored
465 public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
466 return self
::singleton()
467 ->invoke(5, $type, $contactID, $tableName, $allGroups, $currentGroups, self
::$_nullObject, 'civicrm_aclGroup');
471 * This hook is called when building the menu table.
473 * @param array $files
474 * The current set of files to process.
477 * the return value is ignored
479 public static function xmlMenu(&$files) {
480 return self
::singleton()->invoke(1, $files,
481 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
487 * This hook is called for declaring managed entities via API.
489 * @param array $entities
490 * List of pending entities. Each entity is an array with keys:
491 * + 'module': string; for module-extensions, this is the fully-qualifed name (e.g. "com.example.mymodule"); for CMS modules, the name is prefixed by the CMS (e.g. "drupal.mymodule")
492 * + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
493 * + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
494 * + 'params': array, the entity data as supported by the CiviCRM API
495 * + 'update' (v4.5+): string, a policy which describes when to update records
496 * - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
497 * - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
498 * + 'cleanup' (v4.5+): string, a policy which describes whether to cleanup the record when it becomes orphaned (ie when $entities no longer references the record)
499 * - 'always' (default): always delete orphaned records
500 * - 'never': never delete orphaned records
501 * - 'unused': only delete orphaned records if there are no other references to it in the DB. (This is determined by calling the API's "getrefcount" action.)
504 * the return value is ignored
506 public static function managed(&$entities) {
507 return self
::singleton()->invoke(1, $entities,
508 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
514 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
516 * @param int $contactID
517 * The contactID for whom the dashboard is being rendered.
518 * @param int $contentPlacement
519 * (output parameter) where should the hook content be displayed.
520 * relative to the activity list
523 * the html snippet to include in the dashboard
525 public static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
526 $retval = self
::singleton()->invoke(2, $contactID, $contentPlacement,
527 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
532 * Note we need this seemingly unnecessary code because in the event that the implementation
533 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
534 * though we have a default value in this function's declaration above.
536 if (!isset($contentPlacement)) {
537 $contentPlacement = self
::DASHBOARD_BELOW
;
544 * This hook is called before storing recently viewed items.
546 * @param array $recentArray
547 * An array of recently viewed or processed items, for in place modification.
551 public static function recent(&$recentArray) {
552 return self
::singleton()->invoke(1, $recentArray,
553 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
559 * Determine how many other records refer to a given record.
561 * @param CRM_Core_DAO $dao
562 * The item for which we want a reference count.
563 * @param array $refCounts
564 * Each item in the array is an Array with keys:
565 * - name: string, eg "sql:civicrm_email:contact_id"
566 * - type: string, eg "sql"
567 * - count: int, eg "5" if there are 5 email addresses that refer to $dao
570 * Return is not really intended to be used.
572 public static function referenceCounts($dao, &$refCounts) {
573 return self
::singleton()->invoke(2, $dao, $refCounts,
574 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
575 'civicrm_referenceCounts'
580 * This hook is called when building the amount structure for a Contribution or Event Page.
582 * @param int $pageType
583 * Is this a contribution or event page.
584 * @param CRM_Core_Form $form
585 * Reference to the form object.
586 * @param array $amount
587 * The amount structure to be displayed.
591 public static function buildAmount($pageType, &$form, &$amount) {
592 return self
::singleton()->invoke(3, $pageType, $form, $amount, self
::$_nullObject,
593 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildAmount');
597 * This hook is called when building the state list for a particular country.
599 * @param array $countryID
600 * The country id whose states are being selected.
605 public static function buildStateProvinceForCountry($countryID, &$states) {
606 return self
::singleton()->invoke(2, $countryID, $states,
607 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
608 'civicrm_buildStateProvinceForCountry'
613 * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
616 * The array of tabs that will be displayed.
617 * @param int $contactID
618 * The contactID for whom the dashboard is being rendered.
622 public static function tabs(&$tabs, $contactID) {
623 return self
::singleton()->invoke(2, $tabs, $contactID,
624 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabs'
629 * This hook is called when rendering the tabs used for events and potentially
630 * contribution pages, etc.
632 * @param string $tabsetName
633 * Name of the screen or visual element.
635 * Tabs that will be displayed.
636 * @param array $context
637 * Extra data about the screen or context in which the tab is used.
641 public static function tabset($tabsetName, &$tabs, $context) {
642 return self
::singleton()->invoke(3, $tabsetName, $tabs,
643 $context, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
648 * This hook is called when sending an email / printing labels
650 * @param array $tokens
651 * The list of tokens that can be used for the contact.
655 public static function tokens(&$tokens) {
656 return self
::singleton()->invoke(1, $tokens,
657 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
662 * This hook is called when sending an email / printing labels to get the values for all the
663 * tokens returned by the 'tokens' hook
665 * @param array $details
666 * The array to store the token values indexed by contactIDs (unless it a single).
667 * @param array $contactIDs
668 * An array of contactIDs.
670 * The jobID if this is associated with a CiviMail mailing.
671 * @param array $tokens
672 * The list of tokens associated with the content.
673 * @param string $className
674 * The top level className from where the hook is invoked.
678 public static function tokenValues(
685 return self
::singleton()
686 ->invoke(5, $details, $contactIDs, $jobID, $tokens, $className, self
::$_nullObject, 'civicrm_tokenValues');
690 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
693 * @param object $page
694 * The page that will be rendered.
698 public static function pageRun(&$page) {
699 return self
::singleton()->invoke(1, $page,
700 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
706 * This hook is called after a copy of an object has been made. The current objects are
707 * Event, Contribution Page and UFGroup
709 * @param string $objectName
710 * Name of the object.
711 * @param object $object
712 * Reference to the copy.
716 public static function copy($objectName, &$object) {
717 return self
::singleton()->invoke(2, $objectName, $object,
718 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
724 * This hook is called when a contact unsubscribes from a mailing. It allows modules
725 * to override what the contacts are removed from.
729 * @param int $mailingId
730 * The id of the mailing to unsub from
731 * @param int $contactId
732 * The id of the contact who is unsubscribing
733 * @param array|int $groups
734 * Groups the contact will be removed from.
735 * @param array|int $baseGroups
736 * Base groups (used in smart mailings) the contact will be removed from.
741 public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
742 return self
::singleton()
743 ->invoke(5, $op, $mailingId, $contactId, $groups, $baseGroups, self
::$_nullObject, 'civicrm_unsubscribeGroups');
747 * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox,
750 * @param int $customFieldID
751 * The custom field ID.
752 * @param array $options
753 * The current set of options for that custom field.
754 * You can add/remove existing options.
755 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
756 * to be careful to not overwrite the array.
757 * Only add/edit/remove the specific field options you intend to affect.
758 * @param bool $detailedFormat
760 * the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
761 * @param array $selectAttributes
762 * Contain select attribute(s) if any.
766 public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = array()) {
767 return self
::singleton()->invoke(3, $customFieldID, $options, $detailedFormat,
768 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
769 'civicrm_customFieldOptions'
775 * This hook is called to display the list of actions allowed after doing a search.
776 * This allows the module developer to inject additional actions or to remove existing actions.
778 * @param string $objectType
779 * The object type for this search.
780 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
781 * @param array $tasks
782 * The current set of tasks for that custom field.
783 * You can add/remove existing tasks.
784 * Each task needs to have a title (eg 'title' => ts( 'Group - add contacts')) and a class
785 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
786 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
787 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
788 * found in CRM/$objectType/Task.php.
792 public static function searchTasks($objectType, &$tasks) {
793 return self
::singleton()->invoke(2, $objectType, $tasks,
794 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
795 'civicrm_searchTasks'
801 * @param array $params
805 public static function eventDiscount(&$form, &$params) {
806 return self
::singleton()->invoke(2, $form, $params,
807 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
808 'civicrm_eventDiscount'
813 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
816 * The form object for which groups / mailings being displayed
817 * @param array $groups
818 * The list of groups being included / excluded
819 * @param array $mailings
820 * The list of mailings being included / excluded
824 public static function mailingGroups(&$form, &$groups, &$mailings) {
825 return self
::singleton()->invoke(3, $form, $groups, $mailings,
826 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
827 'civicrm_mailingGroups'
832 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
834 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
835 * You can use it to alter the membership types when first loaded, or after submission
836 * (for example if you want to gather data in the form and use it to alter the fees).
839 * The form object that is presenting the page
840 * @param array $membershipTypes
841 * The array of membership types and their amount
845 public static function membershipTypeValues(&$form, &$membershipTypes) {
846 return self
::singleton()->invoke(2, $form, $membershipTypes,
847 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
848 'civicrm_membershipTypeValues'
853 * This hook is called when rendering the contact summary.
855 * @param int $contactID
856 * The contactID for whom the summary is being rendered
857 * @param mixed $content
858 * @param int $contentPlacement
859 * Specifies where the hook content should be displayed relative to the
863 * The html snippet to include in the contact summary
865 public static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
866 return self
::singleton()->invoke(3, $contactID, $content, $contentPlacement,
867 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
873 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
874 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
875 * If you want to limit the contacts returned to a specific group, or some other criteria
876 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
877 * The hook is called when the query is executed to get the list of contacts to display.
879 * @param mixed $query
880 * - the query that will be executed (input and output parameter);.
881 * It's important to realize that the ACL clause is built prior to this hook being fired,
882 * so your query will ignore any ACL rules that may be defined.
883 * Your query must return two columns:
884 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
886 * @param string $name
887 * The name string to execute the query against (this is the value being typed in by the user).
888 * @param string $context
889 * The context in which this ajax call is being made (for example: 'customfield', 'caseview').
891 * The id of the object for which the call is being made.
892 * For custom fields, it will be the custom field id
896 public static function contactListQuery(&$query, $name, $context, $id) {
897 return self
::singleton()->invoke(4, $query, $name, $context, $id,
898 self
::$_nullObject, self
::$_nullObject,
899 'civicrm_contactListQuery'
904 * Hook definition for altering payment parameters before talking to a payment processor back end.
906 * Definition will look like this:
908 * function hook_civicrm_alterPaymentProcessorParams(
914 * @param CRM_Core_Payment $paymentObj
915 * Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
916 * See discussion in CRM-16224 as to whether $paymentObj should be passed by reference.
917 * @param array &$rawParams
918 * array of params as passed to to the processor
919 * @param array &$cookedParams
920 * params after the processor code has translated them into its own key/value pairs
923 * This return is not really intended to be used.
925 public static function alterPaymentProcessorParams(
930 return self
::singleton()->invoke(3, $paymentObj, $rawParams, $cookedParams,
931 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
932 'civicrm_alterPaymentProcessorParams'
937 * This hook is called when an email is about to be sent by CiviCRM.
939 * @param array $params
940 * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
941 * returnPath, replyTo, headers, attachments (array)
942 * @param string $context
943 * The context in which the hook is being invoked, eg 'civimail'.
947 public static function alterMailParams(&$params, $context = NULL) {
948 return self
::singleton()->invoke(2, $params, $context,
949 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
950 'civicrm_alterMailParams'
955 * This hook is called when membership status is being calculated.
957 * @param array $membershipStatus
958 * Membership status details as determined - alter if required.
959 * @param array $arguments
960 * Arguments passed in to calculate date.
965 * - 'exclude_is_admin'
966 * - 'membership_type_id'
967 * @param array $membership
968 * Membership details from the calling function.
972 public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
973 return self
::singleton()->invoke(3, $membershipStatus, $arguments,
974 $membership, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
975 'civicrm_alterCalculatedMembershipStatus'
980 * This hook is called when rendering the Manage Case screen.
986 * Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
987 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
989 public static function caseSummary($caseID) {
990 return self
::singleton()->invoke(1, $caseID,
991 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
992 'civicrm_caseSummary'
997 * This hook is called when locating CiviCase types.
999 * @param array $caseTypes
1003 public static function caseTypes(&$caseTypes) {
1004 return self
::singleton()
1005 ->invoke(1, $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
1009 * This hook is called soon after the CRM_Core_Config object has ben initialized.
1010 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
1012 * @param CRM_Core_Config|array $config
1017 public static function config(&$config) {
1018 return self
::singleton()->invoke(1, $config,
1019 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1025 * This hooks allows to change option values.
1027 * @param array $options
1028 * Associated array of option values / id
1029 * @param string $name
1034 public static function optionValues(&$options, $name) {
1035 return self
::singleton()->invoke(2, $options, $name,
1036 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1037 'civicrm_optionValues'
1042 * This hook allows modification of the navigation menu.
1044 * @param array $params
1045 * Associated array of navigation menu entry to Modify/Add
1049 public static function navigationMenu(&$params) {
1050 return self
::singleton()->invoke(1, $params,
1051 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1052 'civicrm_navigationMenu'
1057 * This hook allows modification of the data used to perform merging of duplicates.
1059 * @param string $type
1060 * The type of data being passed (cidRefs|eidRefs|relTables|sqls).
1061 * @param array $data
1062 * The data, as described in $type.
1063 * @param int $mainId
1064 * Contact_id of the contact that survives the merge.
1065 * @param int $otherId
1066 * Contact_id of the contact that will be absorbed and deleted.
1067 * @param array $tables
1068 * When $type is "sqls", an array of tables as it may have been handed to the calling function.
1072 public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
1073 return self
::singleton()->invoke(5, $type, $data, $mainId, $otherId, $tables, self
::$_nullObject, 'civicrm_merge');
1077 * This hook provides a way to override the default privacy behavior for notes.
1079 * @param array &$noteValues
1080 * Associative array of values for this note
1084 public static function notePrivacy(&$noteValues) {
1085 return self
::singleton()->invoke(1, $noteValues,
1086 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1087 'civicrm_notePrivacy'
1092 * This hook is called before record is exported as CSV.
1094 * @param string $exportTempTable
1095 * Name of the temporary export table used during export.
1096 * @param array $headerRows
1097 * Header rows for output.
1098 * @param array $sqlColumns
1100 * @param int $exportMode
1101 * Export mode ( contact, contribution, etc...).
1105 public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode) {
1106 return self
::singleton()->invoke(4, $exportTempTable, $headerRows, $sqlColumns, $exportMode,
1107 self
::$_nullObject, self
::$_nullObject,
1113 * This hook allows modification of the queries constructed from dupe rules.
1115 * @param string $obj
1116 * Object of rulegroup class.
1117 * @param string $type
1118 * Type of queries e.g table / threshold.
1119 * @param array $query
1124 public static function dupeQuery($obj, $type, &$query) {
1125 return self
::singleton()->invoke(3, $obj, $type, $query,
1126 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1132 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1134 * @param string $type
1135 * Type of mail processed: 'activity' OR 'mailing'.
1136 * @param array &$params the params that were sent to the CiviCRM API function
1137 * @param object $mail
1138 * The mail object which is an ezcMail class.
1139 * @param array &$result the result returned by the api call
1140 * @param string $action
1141 * (optional ) the requested action to be performed if the types was 'mailing'.
1145 public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1146 return self
::singleton()
1147 ->invoke(5, $type, $params, $mail, $result, $action, self
::$_nullObject, 'civicrm_emailProcessor');
1151 * This hook is called after a row has been processed and the
1152 * record (and associated records imported
1154 * @param string $object
1155 * Object being imported (for now Contact only, later Contribution, Activity,.
1156 * Participant and Member)
1157 * @param string $usage
1158 * Hook usage/location (for now process only, later mapping and others).
1159 * @param string $objectRef
1160 * Import record object.
1161 * @param array $params
1162 * Array with various key values: currently.
1163 * contactID - contact id
1164 * importID - row id in temp table
1165 * importTempTable - name of tempTable
1166 * fieldHeaders - field headers
1167 * fields - import fields
1171 public static function import($object, $usage, &$objectRef, &$params) {
1172 return self
::singleton()->invoke(4, $object, $usage, $objectRef, $params,
1173 self
::$_nullObject, self
::$_nullObject,
1179 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1180 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1182 * @param string $entity
1183 * The API entity (like contact).
1184 * @param string $action
1185 * The API action (like get).
1186 * @param array &$params the API parameters
1187 * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1191 public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1192 return self
::singleton()->invoke(4, $entity, $action, $params, $permissions,
1193 self
::$_nullObject, self
::$_nullObject,
1194 'civicrm_alterAPIPermissions'
1199 * @param CRM_Core_DAO $dao
1203 public static function postSave(&$dao) {
1204 $hookName = 'civicrm_postSave_' . $dao->getTableName();
1205 return self
::singleton()->invoke(1, $dao,
1206 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1212 * This hook allows user to customize context menu Actions on contact summary page.
1214 * @param array $actions
1215 * Array of all Actions in contextmenu.
1216 * @param int $contactID
1217 * ContactID for the summary page.
1221 public static function summaryActions(&$actions, $contactID = NULL) {
1222 return self
::singleton()->invoke(2, $actions, $contactID,
1223 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1224 'civicrm_summaryActions'
1229 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1230 * This enables us hook implementors to modify both the headers and the rows
1232 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1233 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1235 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1236 * you want displayed. This is a hackish, but avoids template modification.
1238 * @param string $objectName
1239 * The component name that we are doing the search.
1240 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1241 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1242 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1243 * @param array $selector
1244 * the selector object. Allows you access to the context of the search
1247 * modify the header and values object to pass the data u need
1249 public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1250 return self
::singleton()->invoke(4, $objectName, $headers, $rows, $selector,
1251 self
::$_nullObject, self
::$_nullObject,
1252 'civicrm_searchColumns'
1257 * This hook is called when uf groups are being built for a module.
1259 * @param string $moduleName
1261 * @param array $ufGroups
1262 * Array of ufgroups for a module.
1266 public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1267 return self
::singleton()->invoke(2, $moduleName, $ufGroups,
1268 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1269 'civicrm_buildUFGroupsForModule'
1274 * This hook is called when we are determining the contactID for a specific
1277 * @param string $email
1278 * The email address.
1279 * @param int $contactID
1280 * The contactID that matches this email address, IF it exists.
1281 * @param array $result
1282 * (reference) has two fields.
1283 * contactID - the new (or same) contactID
1284 * action - 3 possible values:
1285 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1286 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1287 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1291 public static function emailProcessorContact($email, $contactID, &$result) {
1292 return self
::singleton()->invoke(3, $email, $contactID, $result,
1293 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1294 'civicrm_emailProcessorContact'
1299 * Hook definition for altering the generation of Mailing Labels.
1301 * @param array $args
1302 * An array of the args in the order defined for the tcpdf multiCell api call.
1303 * with the variable names below converted into string keys (ie $w become 'w'
1304 * as the first key for $args)
1305 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1306 * float $h Cell minimum height. The cell extends automatically if needed.
1307 * string $txt String to print
1308 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1309 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1310 * a string containing some or all of the following characters (in any order):
1311 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1312 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1313 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1314 * (default value when $ishtml=false)</li></ul>
1315 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1316 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1317 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1318 * float $x x position in user units
1319 * float $y y position in user units
1320 * boolean $reseth if true reset the last cell height (default true).
1321 * int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1322 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1323 * necessary</li><li>4 = forced character spacing</li></ul>
1324 * boolean $ishtml set to true if $txt is HTML content (default = false).
1325 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1326 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1327 * or 0 for disable this feature. This feature works only when $ishtml=false.
1331 public static function alterMailingLabelParams(&$args) {
1332 return self
::singleton()->invoke(1, $args,
1333 self
::$_nullObject, self
::$_nullObject,
1334 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1335 'civicrm_alterMailingLabelParams'
1340 * This hooks allows alteration of generated page content.
1343 * Previously generated content.
1345 * Context of content - page or form.
1347 * The file name of the tpl.
1349 * A reference to the page or form object.
1353 public static function alterContent(&$content, $context, $tplName, &$object) {
1354 return self
::singleton()->invoke(4, $content, $context, $tplName, $object,
1355 self
::$_nullObject, self
::$_nullObject,
1356 'civicrm_alterContent'
1361 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1362 * altercontent hook as the content has already been rendered through the tpl at that point
1365 * Previously generated content.
1367 * Reference to the form object.
1369 * Context of content - page or form.
1371 * Reference the file name of the tpl.
1375 public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1376 return self
::singleton()->invoke(4, $formName, $form, $context, $tplName,
1377 self
::$_nullObject, self
::$_nullObject,
1378 'civicrm_alterTemplateFile'
1383 * This hook collects the trigger definition from all components.
1386 * @param string $tableName
1387 * (optional) the name of the table that we are interested in only.
1389 * @internal param \reference $triggerInfo to an array of trigger information
1390 * each element has 4 fields:
1391 * table - array of tableName
1392 * when - BEFORE or AFTER
1393 * event - array of eventName - INSERT OR UPDATE OR DELETE
1394 * sql - array of statements optionally terminated with a ;
1395 * a statement can use the tokes {tableName} and {eventName}
1396 * to do token replacement with the table / event. This allows
1397 * templatizing logging and other hooks
1400 public static function triggerInfo(&$info, $tableName = NULL) {
1401 return self
::singleton()->invoke(2, $info, $tableName,
1402 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1404 'civicrm_triggerInfo'
1409 * This hook is called when a module-extension is installed.
1410 * Each module will receive hook_civicrm_install during its own installation (but not during the
1411 * installation of unrelated modules).
1413 public static function install() {
1414 return self
::singleton()->invoke(0, self
::$_nullObject,
1415 self
::$_nullObject, self
::$_nullObject,
1416 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1422 * This hook is called when a module-extension is uninstalled.
1423 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1424 * uninstallation of unrelated modules).
1426 public static function uninstall() {
1427 return self
::singleton()->invoke(0, self
::$_nullObject,
1428 self
::$_nullObject, self
::$_nullObject,
1429 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1435 * This hook is called when a module-extension is re-enabled.
1436 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1437 * re-enablement of unrelated modules).
1439 public static function enable() {
1440 return self
::singleton()->invoke(0, self
::$_nullObject,
1441 self
::$_nullObject, self
::$_nullObject,
1442 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1448 * This hook is called when a module-extension is disabled.
1449 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1450 * disablement of unrelated modules).
1452 public static function disable() {
1453 return self
::singleton()->invoke(0, self
::$_nullObject,
1454 self
::$_nullObject, self
::$_nullObject,
1455 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1467 public static function alterReportVar($varType, &$var, &$object) {
1468 return self
::singleton()->invoke(3, $varType, $var, $object,
1470 self
::$_nullObject, self
::$_nullObject,
1471 'civicrm_alterReportVar'
1476 * This hook is called to drive database upgrades for extension-modules.
1479 * The type of operation being performed; 'check' or 'enqueue'.
1480 * @param CRM_Queue_Queue $queue
1481 * (for 'enqueue') the modifiable list of pending up upgrade tasks.
1484 * NULL, if $op is 'enqueue'.
1485 * TRUE, if $op is 'check' and upgrades are pending.
1486 * FALSE, if $op is 'check' and upgrades are not pending.
1488 public static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1489 return self
::singleton()->invoke(2, $op, $queue,
1490 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1497 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1499 * @param array $params
1500 * The mailing parameters. Array fields include: groupName, from, toName,
1501 * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1502 * attachments (array)
1506 public static function postEmailSend(&$params) {
1507 return self
::singleton()->invoke(1, $params,
1508 self
::$_nullObject, self
::$_nullObject,
1509 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1510 'civicrm_postEmailSend'
1515 * This hook is called when Settings specifications are loaded.
1517 * @param array $settingsFolders
1518 * List of paths from which to derive metadata
1522 public static function alterSettingsFolders(&$settingsFolders) {
1523 return self
::singleton()->invoke(1, $settingsFolders,
1524 self
::$_nullObject, self
::$_nullObject,
1525 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1526 'civicrm_alterSettingsFolders'
1531 * This hook is called when Settings have been loaded from the xml
1532 * It is an opportunity for hooks to alter the data
1534 * @param array $settingsMetaData
1535 * Settings Metadata.
1536 * @param int $domainID
1537 * @param mixed $profile
1541 public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1542 return self
::singleton()->invoke(3, $settingsMetaData,
1543 $domainID, $profile,
1544 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1545 'civicrm_alterSettingsMetaData'
1550 * This hook is called before running an api call.
1552 * @param API_Wrapper[] $wrappers
1553 * (see CRM_Utils_API_ReloadOption as an example)
1554 * @param mixed $apiRequest
1557 * The return value is ignored
1559 public static function apiWrappers(&$wrappers, $apiRequest) {
1560 return self
::singleton()
1561 ->invoke(2, $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1562 self
::$_nullObject, 'civicrm_apiWrappers'
1567 * This hook is called before running pending cron jobs.
1569 * @param CRM_Core_JobManager $jobManager
1572 * The return value is ignored.
1574 public static function cron($jobManager) {
1575 return self
::singleton()->invoke(1,
1576 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1582 * This hook is called when loading CMS permissions; use this hook to modify
1583 * the array of system permissions for CiviCRM.
1585 * @param array $permissions
1586 * Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1587 * the format of this array.
1590 * The return value is ignored
1592 public static function permission(&$permissions) {
1593 return self
::singleton()->invoke(1, $permissions,
1594 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1595 'civicrm_permission'
1600 * @param CRM_Core_Exception Exception $exception
1601 * @param mixed $request
1602 * Reserved for future use.
1604 public static function unhandledException($exception, $request = NULL) {
1606 ->invoke(2, $exception, $request, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_unhandled_exception');
1608 //$event = new stdClass();
1609 //$event->exception = $exception;
1610 //CRM_Core_LegacyErrorHandler::handleException($event);
1613 $event = new \Civi\Core\Event\
UnhandledExceptionEvent($exception, self
::$_nullObject);
1614 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_unhandled_exception", $event);
1618 * This hook is called for declaring managed entities via API.
1620 * @param array[] $entityTypes
1621 * List of entity types; each entity-type is an array with keys:
1622 * - name: string, a unique short name (e.g. "ReportInstance")
1623 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1624 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
1627 * The return value is ignored
1629 public static function entityTypes(&$entityTypes) {
1630 return self
::singleton()->invoke(1, $entityTypes, self
::$_nullObject, self
::$_nullObject,
1631 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
1636 * This hook is called while preparing a profile form.
1638 * @param string $name
1641 public static function buildProfile($name) {
1642 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1643 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildProfile');
1647 * This hook is called while validating a profile form submission.
1649 * @param string $name
1652 public static function validateProfile($name) {
1653 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1654 self
::$_nullObject, self
::$_nullObject, 'civicrm_validateProfile');
1658 * This hook is called processing a valid profile form submission.
1660 * @param string $name
1663 public static function processProfile($name) {
1664 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1665 self
::$_nullObject, self
::$_nullObject, 'civicrm_processProfile');
1669 * This hook is called while preparing a read-only profile screen
1671 * @param string $name
1674 public static function viewProfile($name) {
1675 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1676 self
::$_nullObject, self
::$_nullObject, 'civicrm_viewProfile');
1680 * This hook is called while preparing a list of contacts (based on a profile)
1682 * @param string $name
1685 public static function searchProfile($name) {
1686 return self
::singleton()->invoke(1, $name, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1687 self
::$_nullObject, self
::$_nullObject, 'civicrm_searchProfile');
1691 * This hook is invoked when building a CiviCRM name badge.
1693 * @param string $labelName
1694 * String referencing name of badge format.
1695 * @param object $label
1696 * Reference to the label object.
1697 * @param array $format
1698 * Array of format data.
1699 * @param array $participant
1700 * Array of participant values.
1703 * the return value is ignored
1705 public static function alterBadge($labelName, &$label, &$format, &$participant) {
1706 return self
::singleton()
1707 ->invoke(4, $labelName, $label, $format, $participant, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBadge');
1712 * This hook is called before encoding data in barcode.
1714 * @param array $data
1715 * Associated array of values available for encoding.
1716 * @param string $type
1717 * Type of barcode, classic barcode or QRcode.
1718 * @param string $context
1719 * Where this hooks is invoked.
1723 public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') {
1724 return self
::singleton()->invoke(3, $data, $type, $context, self
::$_nullObject,
1725 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBarcode');
1729 * Modify or replace the Mailer object used for outgoing mail.
1731 * @param object $mailer
1732 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
1733 * @param string $driver
1734 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
1735 * @param array $params
1736 * The default mailer config options
1739 * @see Mail::factory
1741 public static function alterMail(&$mailer, $driver, $params) {
1742 return self
::singleton()
1743 ->invoke(3, $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
1747 * This hook is called while building the core search query,
1748 * so hook implementers can provide their own query objects which alters/extends core search.
1750 * @param array $queryObjects
1751 * @param string $type
1755 public static function queryObjects(&$queryObjects, $type = 'Contact') {
1756 return self
::singleton()
1757 ->invoke(2, $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
1761 * This hook is called while viewing contact dashboard.
1763 * @param array $availableDashlets
1764 * List of dashlets; each is formatted per api/v3/Dashboard
1765 * @param array $defaultDashlets
1766 * List of dashlets; each is formatted per api/v3/DashboardContact
1770 public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
1771 return self
::singleton()
1772 ->invoke(2, $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');
1776 * This hook is called before a case merge (or a case reassign)
1778 * @param int $mainContactId
1779 * @param int $mainCaseId
1780 * @param int $otherContactId
1781 * @param int $otherCaseId
1782 * @param bool $changeClient
1786 public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1787 return self
::singleton()
1788 ->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_pre_case_merge');
1792 * This hook is called after a case merge (or a case reassign)
1794 * @param int $mainContactId
1795 * @param int $mainCaseId
1796 * @param int $otherContactId
1797 * @param int $otherCaseId
1798 * @param bool $changeClient
1802 public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1803 return self
::singleton()
1804 ->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_post_case_merge');
1809 * Add a hook for altering the display name
1811 * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
1813 * @param string $displayName
1814 * @param int $contactId
1815 * @param object $dao
1816 * The contact object.
1820 public static function alterDisplayName(&$displayName, $contactId, $dao) {
1821 return self
::singleton()->invoke(3,
1822 $displayName, $contactId, $dao, self
::$_nullObject, self
::$_nullObject,
1823 self
::$_nullObject, 'civicrm_contact_get_displayname'
1828 * EXPERIMENTAL: This hook allows one to register additional Angular modules
1830 * @param array $angularModules
1833 * the return value is ignored
1836 * function mymod_civicrm_angularModules(&$angularModules) {
1837 * $angularModules['myAngularModule'] = array(
1838 * 'ext' => 'org.example.mymod',
1839 * 'js' => array('js/myAngularModule.js'),
1841 * $angularModules['myBigAngularModule'] = array(
1842 * 'ext' => 'org.example.mymod',
1843 * 'js' => array('js/part1.js', 'js/part2.js'),
1844 * 'css' => array('css/myAngularModule.css'),
1845 * 'partials' => array('partials/myBigAngularModule'),
1850 public static function angularModules(&$angularModules) {
1851 return self
::singleton()->invoke(1, $angularModules,
1852 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1853 'civicrm_angularModules'
1858 * This hook fires whenever a record in a case changes.
1860 * @param \Civi\CCase\Analyzer $analyzer
1862 public static function caseChange(\Civi\CCase\Analyzer
$analyzer) {
1863 $event = new \Civi\CCase\Event\
CaseChangeEvent($analyzer);
1864 \Civi\Core\Container
::singleton()->get('dispatcher')->dispatch("hook_civicrm_caseChange", $event);
1866 return self
::singleton()->invoke(1, $angularModules,
1867 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1868 'civicrm_caseChange'
1873 * Generate a default CRUD URL for an entity.
1875 * @param array $spec
1877 * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
1878 * - entity_table: string
1880 * @param CRM_Core_DAO $bao
1881 * @param array $link
1882 * To define the link, add these keys to $link:.
1886 * - url: string (used in lieu of "path"/"query")
1887 * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
1890 public static function crudLink($spec, $bao, &$link) {
1891 return self
::singleton()->invoke(3, $spec, $bao, $link,
1892 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1898 * @param array <CRM_Core_FileSearchInterface> $fileSearches
1901 public static function fileSearches(&$fileSearches) {
1902 return self
::singleton()->invoke(1, $fileSearches,
1903 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1904 'civicrm_fileSearches'
1909 * Check system status.
1911 * @param array $messages
1912 * Array<CRM_Utils_Check_Message>. A list of messages regarding system status.
1915 public static function check(&$messages) {
1916 return self
::singleton()
1917 ->invoke(1, $messages, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_check');
1921 * This hook is called when a query string of the CSV Batch export is generated.
1923 public static function batchQuery(&$query) {
1924 return self
::singleton()->invoke(1, $query, self
::$_nullObject,
1925 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1926 'civicrm_batchQuery'
1931 * This hook is called when the entries of the CSV Batch export are mapped.
1933 public static function batchItems(&$results, &$items) {
1934 return self
::singleton()->invoke(2, $results, $items,
1935 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1936 'civicrm_batchItems'
1941 * This hook is called when core resources are being loaded
1943 * @see CRM_Core_Resources::coreResourceList
1945 * @param array $list
1946 * @param string $region
1948 public static function coreResourceList(&$list, $region) {
1949 // First allow the cms integration to add to the list
1950 CRM_Core_Config
::singleton()->userSystem
->appendCoreResources($list);
1952 self
::singleton()->invoke(2, $list, $region,
1953 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1954 'civicrm_coreResourceList'