CRM/Utils/Hook.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CiviCRM_Hook
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id: $
  33  *
  34  */
  35
  36 abstract class CRM_Utils_Hook {
  37
  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;
  45
  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;
  52
  53   static $_nullObject = NULL;
  54
  55   /**
  56    * We only need one instance of this object. So we use the singleton
  57    * pattern and cache the instance in this variable
  58    *
  59    * @var object
  60    * @static
  61    */
  62   static private $_singleton = NULL;
  63
  64   /**
  65    * @var bool
  66    */
  67   private $commonIncluded = FALSE;
  68
  69   /**
  70    * @var array(string)
  71    */
  72   private $commonCiviModules = array();
  73
  74   /**
  75    * Constructor and getter for the singleton instance
  76    *
  77    * @param bool $fresh
  78    *
  79    * @return self
  80    *   An instance of $config->userHookClass
  81    */
  82   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();
  88     }
  89     return self::$_singleton;
  90   }
  91
  92   /**
  93    *Invoke hooks
  94    *
  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
 103    *
 104    * @return mixed
 105    */
 106   abstract function invoke($numParams,
 107     &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
 108     $fnSuffix
 109   );
 110
 111   function commonInvoke($numParams,
 112     &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
 113     $fnSuffix, $fnPrefix
 114   ) {
 115
 116     $this->commonBuildModuleList($fnPrefix);
 117
 118     return $this->runHooks($this->commonCiviModules, $fnSuffix,
 119       $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
 120     );
 121   }
 122
 123   /**
 124    * Build the list of modules to be processed for hooks.
 125    *
 126    * @param string $fnPrefix
 127    */
 128   function commonBuildModuleList($fnPrefix) {
 129     if (!$this->commonIncluded) {
 130       // include external file
 131       $this->commonIncluded = TRUE;
 132
 133       $config = CRM_Core_Config::singleton();
 134       if (!empty($config->customPHPPathDir) &&
 135         file_exists("{$config->customPHPPathDir}/civicrmHooks.php")
 136       ) {
 137         @include_once ("civicrmHooks.php");
 138       }
 139
 140       if (!empty($fnPrefix)) {
 141         $this->commonCiviModules[$fnPrefix] = $fnPrefix;
 142       }
 143
 144       $this->requireCiviModules($this->commonCiviModules);
 145     }
 146   }
 147
 148   /**
 149    * @param $civiModules
 150    * @param $fnSuffix
 151    * @param $numParams
 152    * @param $arg1
 153    * @param $arg2
 154    * @param $arg3
 155    * @param $arg4
 156    * @param $arg5
 157    * @param $arg6
 158    *
 159    * @return array|bool
 160    */
 161   function runHooks($civiModules, $fnSuffix, $numParams,
 162     &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
 163   ) {
 164     // $civiModules is *not* passed by reference because runHooks
 165     // must be reentrant. PHP is finicky about running
 166     // multiple loops over the same variable. The circumstances
 167     // to reproduce the issue are pretty intricate.
 168     $result = $fResult = array();
 169
 170     if ($civiModules !== NULL) {
 171       foreach ($civiModules as $module) {
 172         $fnName = "{$module}_{$fnSuffix}";
 173         if (function_exists($fnName)) {
 174           switch ($numParams) {
 175             case 0:
 176               $fResult = $fnName();
 177               break;
 178
 179             case 1:
 180               $fResult = $fnName($arg1);
 181               break;
 182
 183             case 2:
 184               $fResult = $fnName($arg1, $arg2);
 185               break;
 186
 187             case 3:
 188               $fResult = $fnName($arg1, $arg2, $arg3);
 189               break;
 190
 191             case 4:
 192               $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
 193               break;
 194
 195             case 5:
 196               $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
 197               break;
 198
 199             case 6:
 200               $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
 201               break;
 202
 203             default:
 204               CRM_Core_Error::fatal(ts('Invalid hook invocation'));
 205               break;
 206           }
 207         }
 208
 209         if (!empty($fResult) &&
 210           is_array($fResult)) {
 211           $result = array_merge($result, $fResult);
 212         }
 213       }
 214     }
 215
 216     return empty($result) ? TRUE : $result;
 217   }
 218
 219   function requireCiviModules(&$moduleList) {
 220     $civiModules = CRM_Core_PseudoConstant::getModuleExtensions();
 221     foreach ($civiModules as $civiModule) {
 222       if (!file_exists($civiModule['filePath'])) {
 223         CRM_Core_Session::setStatus(
 224           ts( 'Error loading module file (%1). Please restore the file or disable the module.',
 225             array(1 => $civiModule['filePath']) ),
 226           ts( 'Warning'), 'error');
 227         continue;
 228       }
 229       include_once $civiModule['filePath'];
 230       $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
 231       }
 232     }
 233
 234   /**
 235    * This hook is called before a db write on some core objects.
 236    * This hook does not allow the abort of the operation
 237    *
 238    * @param string $op         the type of operation being performed
 239    * @param string $objectName the name of the object
 240    * @param object $id         the object id if available
 241    * @param array  $params     the parameters used for object creation / editing
 242    *
 243    * @return null the return value is ignored
 244    */
 245   static function pre($op, $objectName, $id, &$params) {
 246     return self::singleton()->invoke(4, $op, $objectName, $id, $params, self::$_nullObject, self::$_nullObject, 'civicrm_pre');
 247   }
 248
 249   /**
 250    * This hook is called after a db write on some core objects.
 251    *
 252    * @param string $op         the type of operation being performed
 253    * @param string $objectName the name of the object
 254    * @param int    $objectId   the unique identifier for the object
 255    * @param object $objectRef  the reference to the object if available
 256    *
 257    * @return mixed             based on op. pre-hooks return a boolean or
 258    *                           an error message which aborts the operation
 259    * @access public
 260    */
 261   static function post($op, $objectName, $objectId, &$objectRef) {
 262     return self::singleton()->invoke(4, $op, $objectName, $objectId, $objectRef, self::$_nullObject, self::$_nullObject, 'civicrm_post');
 263   }
 264
 265   /**
 266    * This hook retrieves links from other modules and injects it into
 267    * the view contact tabs
 268    *
 269    * @param string $op         the type of operation being performed
 270    * @param string $objectName the name of the object
 271    * @param int    $objectId   the unique identifier for the object
 272    * @param array  $links      (optional) the links array (introduced in v3.2)
 273    * @param int    $mask       (optional) the bitmask to show/hide links
 274    * @param array  $values     (optional) the values to fill the links
 275    *
 276    * @return null  the return value is ignored
 277    */
 278   static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = array()) {
 279     return self::singleton()->invoke(6, $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
 280   }
 281
 282   /**
 283    * This hook is invoked when building a CiviCRM form. This hook should also
 284    * be used to set the default values of a form element
 285    *
 286    * @param string $formName the name of the form
 287    * @param object $form     reference to the form object
 288    *
 289    * @return null the return value is ignored
 290    */
 291   static function buildForm($formName, &$form) {
 292     return self::singleton()->invoke(2, $formName, $form, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_buildForm');
 293   }
 294
 295   /**
 296    * This hook is invoked when a CiviCRM form is submitted. If the module has injected
 297    * any form elements, this hook should save the values in the database
 298    *
 299    * @param string $formName the name of the form
 300    * @param object $form     reference to the form object
 301    *
 302    * @return null the return value is ignored
 303    */
 304   static function postProcess($formName, &$form) {
 305     return self::singleton()->invoke(2, $formName, $form, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_postProcess');
 306   }
 307
 308   /**
 309    * This hook is invoked during all CiviCRM form validation. An array of errors
 310    * detected is returned. Else we assume validation succeeded.
 311    *
 312    * @param string $formName the name of the form
 313    * @param array  &$fields   the POST parameters as filtered by QF
 314    * @param array  &$files    the FILES parameters as sent in by POST
 315    * @param array  &$form     the form object
 316    *
 317    * @return mixed             formRule hooks return a boolean or
 318    *                           an array of error messages which display a QF Error
 319    */
 320   static function validate($formName, &$fields, &$files, &$form) {
 321     return self::singleton()->invoke(4, $formName, $fields, $files, $form, self::$_nullObject, self::$_nullObject, 'civicrm_validate');
 322   }
 323
 324   /**
 325    * This hook is invoked during all CiviCRM form validation. An array of errors
 326    * detected is returned. Else we assume validation succeeded.
 327    *
 328    * @param string $formName  the name of the form
 329    * @param array  &$fields   the POST parameters as filtered by QF
 330    * @param array  &$files    the FILES parameters as sent in by POST
 331    * @param array  &$form     the form object
 332    * @param array &$errors    the array of errors.
 333    *
 334    * @return mixed             formRule hooks return a boolean or
 335    *                           an array of error messages which display a QF Error
 336    */
 337   static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
 338     return self::singleton()->invoke(5, $formName, $fields, $files, $form, $errors, self::$_nullObject, 'civicrm_validateForm');
 339   }
 340
 341   /**
 342    * This hook is called before a db write on a custom table
 343    *
 344    * @param string $op         the type of operation being performed
 345    * @param string $groupID    the custom group ID
 346    * @param object $entityID   the entityID of the row in the custom table
 347    * @param array  $params     the parameters that were sent into the calling function
 348    *
 349    * @return null the return value is ignored
 350    */
 351   static function custom($op, $groupID, $entityID, &$params) {
 352     return self::singleton()->invoke(4, $op, $groupID, $entityID, $params, self::$_nullObject, self::$_nullObject, 'civicrm_custom');
 353   }
 354
 355   /**
 356    * This hook is called when composing the ACL where clause to restrict
 357    * visibility of contacts to the logged in user
 358    *
 359    * @param int $type the type of permission needed
 360    * @param array $tables (reference ) add the tables that are needed for the select clause
 361    * @param array $whereTables (reference ) add the tables that are needed for the where clause
 362    * @param int    $contactID the contactID for whom the check is made
 363    * @param string $where the currrent where clause
 364    *
 365    * @return null the return value is ignored
 366    */
 367   static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
 368     return self::singleton()->invoke(5, $type, $tables, $whereTables, $contactID, $where, self::$_nullObject, 'civicrm_aclWhereClause');
 369   }
 370
 371   /**
 372    * This hook is called when composing the ACL where clause to restrict
 373    * visibility of contacts to the logged in user
 374    *
 375    * @param int    $type          the type of permission needed
 376    * @param int    $contactID     the contactID for whom the check is made
 377    * @param string $tableName     the tableName which is being permissioned
 378    * @param array  $allGroups     the set of all the objects for the above table
 379    * @param array  $currentGroups the set of objects that are currently permissioned for this contact
 380    *
 381    * @return null the return value is ignored
 382    */
 383   static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
 384     return self::singleton()->invoke(5, $type, $contactID, $tableName, $allGroups, $currentGroups, self::$_nullObject, 'civicrm_aclGroup');
 385   }
 386
 387   /**
 388    * This hook is called when building the menu table
 389    *
 390    * @param array $files The current set of files to process
 391    *
 392    * @return null the return value is ignored
 393    */
 394   static function xmlMenu(&$files) {
 395     return self::singleton()->invoke(1, $files,
 396       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 397       'civicrm_xmlMenu'
 398     );
 399   }
 400
 401   /**
 402    * This hook is called for declaring managed entities via API
 403    *
 404    * @param array $entities List of pending entities
 405    *
 406    * @return null the return value is ignored
 407    * @access public
 408    */
 409   static function managed(&$entities) {
 410     return self::singleton()->invoke(1, $entities,
 411       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 412       'civicrm_managed'
 413     );
 414   }
 415
 416   /**
 417    * This hook is called when rendering the dashboard (q=civicrm/dashboard)
 418    *
 419    * @param int $contactID - the contactID for whom the dashboard is being rendered
 420    * @param int $contentPlacement - (output parameter) where should the hook content be displayed
 421    * relative to the activity list
 422    *
 423    * @return string the html snippet to include in the dashboard
 424    * @access public
 425    */
 426   static function dashboard($contactID, &$contentPlacement = self::DASHBOARD_BELOW) {
 427     $retval = self::singleton()->invoke(2, $contactID, $contentPlacement,
 428       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 429       'civicrm_dashboard'
 430     );
 431
 432     /*
 433      * Note we need this seemingly unnecessary code because in the event that the implementation
 434      * of the hook declares the second parameter but doesn't set it, then it comes back unset even
 435      * though we have a default value in this function's declaration above.
 436      */
 437     if (!isset($contentPlacement)) {
 438       $contentPlacement = self::DASHBOARD_BELOW;
 439     }
 440
 441     return $retval;
 442   }
 443
 444   /**
 445    * This hook is called before storing recently viewed items.
 446    *
 447    * @param array $recentArray - an array of recently viewed or processed items, for in place modification
 448    *
 449    * @return array
 450    * @access public
 451    */
 452   static function recent(&$recentArray) {
 453     return self::singleton()->invoke(1, $recentArray,
 454       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 455       'civicrm_recent'
 456     );
 457   }
 458
 459   /**
 460    * This hook is called when building the amount structure for a Contribution or Event Page
 461    *
 462    * @param int    $pageType - is this a contribution or event page
 463    * @param object $form     - reference to the form object
 464    * @param array  $amount   - the amount structure to be displayed
 465    *
 466    * @return null
 467    * @access public
 468    */
 469   static function buildAmount($pageType, &$form, &$amount) {
 470     return self::singleton()->invoke(3, $pageType, $form, $amount, self::$_nullObject,
 471       self::$_nullObject, self::$_nullObject, 'civicrm_buildAmount');
 472   }
 473
 474   /**
 475    * This hook is called when building the state list for a particular country.
 476    *
 477    * @param array $countryID
 478    *   The country id whose states are being selected.
 479    * @param $states
 480    *
 481    * @return null
 482    */
 483   static function buildStateProvinceForCountry($countryID, &$states) {
 484     return self::singleton()->invoke(2, $countryID, $states,
 485       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 486       'civicrm_buildStateProvinceForCountry'
 487     );
 488   }
 489
 490   /**
 491    * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
 492    *
 493    * @param array $tabs      - the array of tabs that will be displayed
 494    * @param int   $contactID - the contactID for whom the dashboard is being rendered
 495    *
 496    * @return null
 497    */
 498   static function tabs(&$tabs, $contactID) {
 499     return self::singleton()->invoke(2, $tabs, $contactID,
 500       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tabs'
 501     );
 502   }
 503
 504   /**
 505    * This hook is called when rendering the tabs used for events and potentially
 506    * contribution pages, etc.
 507    *
 508    * @param string $tabsetName
 509    *   Name of the screen or visual element.
 510    * @param array $tabs
 511    *   Tabs that will be displayed.
 512    * @param array $context
 513    *   Extra data about the screen or context in which the tab is used.
 514    *
 515    * @return null
 516    */
 517   static function tabset($tabsetName, &$tabs, $context) {
 518     return self::singleton()->invoke(3, $tabsetName, $tabs,
 519       $context, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tabset'
 520     );
 521   }
 522
 523   /**
 524    * This hook is called when sending an email / printing labels
 525    *
 526    * @param array $tokens    - the list of tokens that can be used for the contact
 527    *
 528    * @return null
 529    * @access public
 530    */
 531   static function tokens(&$tokens) {
 532     return self::singleton()->invoke(1, $tokens,
 533       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tokens'
 534     );
 535   }
 536
 537   /**
 538    * This hook is called when sending an email / printing labels to get the values for all the
 539    * tokens returned by the 'tokens' hook
 540    *
 541    * @param array  $details    - the array to store the token values indexed by contactIDs (unless it a single)
 542    * @param array  $contactIDs - an array of contactIDs
 543    * @param int    $jobID      - the jobID if this is associated with a CiviMail mailing
 544    * @param array  $tokens     - the list of tokens associated with the content
 545    * @param string $className  - the top level className from where the hook is invoked
 546    *
 547    * @return null
 548    * @access public
 549    */
 550   static function tokenValues(&$details,
 551     $contactIDs,
 552     $jobID     = NULL,
 553     $tokens    = array(),
 554     $className = NULL
 555   ) {
 556     return self::singleton()->invoke(5, $details, $contactIDs, $jobID, $tokens, $className, self::$_nullObject, 'civicrm_tokenValues');
 557   }
 558
 559   /**
 560    * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
 561    * in a  template
 562    *
 563    * @param object $page - the page that will be rendered
 564    *
 565    * @return null
 566    * @access public
 567    */
 568   static function pageRun(&$page) {
 569     return self::singleton()->invoke(1, $page,
 570       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 571       'civicrm_pageRun'
 572     );
 573   }
 574
 575   /**
 576    * This hook is called after a copy of an object has been made. The current objects are
 577    * Event, Contribution Page and UFGroup
 578    *
 579    * @param string $objectName - name of the object
 580    * @param object $object     - reference to the copy
 581    *
 582    * @return null
 583    * @access public
 584    */
 585   static function copy($objectName, &$object) {
 586     return self::singleton()->invoke(2, $objectName, $object,
 587       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 588       'civicrm_copy'
 589     );
 590   }
 591
 592   /**
 593    * This hook is called when a contact unsubscribes from a mailing.  It allows modules
 594    * to override what the contacts are removed from.
 595    *
 596    * @param string $op
 597    *   Ignored for now
 598    * @param int $mailingId
 599    *   The id of the mailing to unsub from
 600    * @param int $contactId
 601    *   The id of the contact who is unsubscribing
 602    * @param array|int $groups
 603    *   Groups the contact will be removed from.
 604    * @param array|int $baseGroups
 605    *   Base groups (used in smart mailings) the contact will be removed from.
 606    *
 607    *
 608    * @return mixed
 609    */
 610   static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
 611     return self::singleton()->invoke(5, $op, $mailingId, $contactId, $groups, $baseGroups, self::$_nullObject, 'civicrm_unsubscribeGroups');
 612   }
 613
 614   /**
 615    * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox,
 616    * adv multiselect)
 617    *
 618    * @param int $customFieldID - the custom field ID
 619    * @param array $options - the current set of options for that custom field.
 620    *   You can add/remove existing options.
 621    *   Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
 622    *              to be careful to not overwrite the array.
 623    *   Only add/edit/remove the specific field options you intend to affect.
 624    * @param boolean $detailedFormat - if true,
 625    *                the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
 626    * @param array $selectAttributes contain select attribute(s) if any
 627    *
 628    * @return mixed
 629    */
 630   static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = array()) {
 631     return self::singleton()->invoke(3, $customFieldID, $options, $detailedFormat,
 632       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 633       'civicrm_customFieldOptions'
 634     );
 635   }
 636
 637   /**
 638    *
 639    * This hook is called to display the list of actions allowed after doing a search.
 640    * This allows the module developer to inject additional actions or to remove existing actions.
 641    *
 642    * @param string $objectType - the object type for this search
 643    *   - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
 644    * @param array $tasks - the current set of tasks for that custom field.
 645    *   You can add/remove existing tasks.
 646    *   Each task needs to have a title (eg 'title'  => ts( 'Add Contacts to Group')) and a class
 647    *   (eg 'class'  => 'CRM_Contact_Form_Task_AddToGroup').
 648    *   Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
 649    *   The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
 650    *   found in CRM/$objectType/Task.php.
 651    *
 652    * @return mixed
 653    */
 654   static function searchTasks($objectType, &$tasks) {
 655     return self::singleton()->invoke(2, $objectType, $tasks,
 656       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 657       'civicrm_searchTasks'
 658     );
 659   }
 660
 661   /**
 662    * @param mixed $form
 663    * @param array $params
 664    *
 665    * @return mixed
 666    */
 667   static function eventDiscount(&$form, &$params) {
 668     return self::singleton()->invoke(2, $form, $params,
 669       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 670       'civicrm_eventDiscount'
 671     );
 672   }
 673
 674   /**
 675    * This hook is called when composing a mailing. You can include / exclude other groups as needed.
 676    *
 677    * @param mixed $form
 678    *   The form object for which groups / mailings being displayed
 679    * @param array $groups
 680    *   The list of groups being included / excluded
 681    * @param array $mailings
 682    *   The list of mailings being included / excluded
 683    *
 684    * @return mixed
 685    */
 686   static function mailingGroups(&$form, &$groups, &$mailings) {
 687     return self::singleton()->invoke(3, $form, $groups, $mailings,
 688       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 689       'civicrm_mailingGroups'
 690     );
 691   }
 692
 693   /**
 694    * This hook is called when composing the array of membershipTypes and their cost during a membership registration
 695    * (new or renewal).
 696    * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
 697    * You can use it to alter the membership types when first loaded, or after submission
 698    * (for example if you want to gather data in the form and use it to alter the fees).
 699    *
 700    * @param mixed $form
 701    *   The form object that is presenting the page
 702    * @param array $membershipTypes
 703    *   The array of membership types and their amount
 704    *
 705    * @return mixed
 706    */
 707   static function membershipTypeValues(&$form, &$membershipTypes) {
 708     return self::singleton()->invoke(2, $form, $membershipTypes,
 709       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 710       'civicrm_membershipTypeValues'
 711     );
 712   }
 713
 714   /**
 715    * This hook is called when rendering the contact summary
 716    *
 717    * @param int $contactID
 718    *   The contactID for whom the summary is being rendered
 719    * @param mixed $content
 720    * @param int $contentPlacement
 721    *   Specifies where the hook content should be displayed relative to the
 722    *   existing content
 723    *
 724    * @return string
 725    *   The html snippet to include in the contact summary
 726    */
 727   static function summary($contactID, &$content, &$contentPlacement = self::SUMMARY_BELOW) {
 728     return self::singleton()->invoke(3, $contactID, $content, $contentPlacement,
 729       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 730       'civicrm_summary'
 731     );
 732   }
 733
 734   /**
 735    * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
 736    * By default, Contact Reference fields will search on and return all CiviCRM contacts.
 737    * If you want to limit the contacts returned to a specific group, or some other criteria
 738    * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
 739    * The hook is called when the query is executed to get the list of contacts to display.
 740    *
 741    * @param mixed $query - - the query that will be executed (input and output parameter);
 742    *   It's important to realize that the ACL clause is built prior to this hook being fired,
 743    *   so your query will ignore any ACL rules that may be defined.
 744    *   Your query must return two columns:
 745    *     the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
 746    *     the contact IDs
 747    * @param string $name - the name string to execute the query against (this is the value being typed in by the user)
 748    * @param string $context - the context in which this ajax call is being made (for example: 'customfield', 'caseview')
 749    * @param int $id - the id of the object for which the call is being made.
 750    *   For custom fields, it will be the custom field id
 751    *
 752    * @return mixed
 753    */
 754   static function contactListQuery(&$query, $name, $context, $id) {
 755     return self::singleton()->invoke(4, $query, $name, $context, $id,
 756       self::$_nullObject, self::$_nullObject,
 757       'civicrm_contactListQuery'
 758     );
 759   }
 760
 761   /**
 762    * Hook definition for altering payment parameters before talking to a payment processor back end.
 763    *
 764    * Definition will look like this:
 765    *
 766    *   function hook_civicrm_alterPaymentProcessorParams($paymentObj,
 767    *                                                     &$rawParams, &$cookedParams);
 768    *
 769    * @param string $paymentObj
 770    *    instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
 771    * @param array &$rawParams
 772    *    array of params as passed to to the processor
 773    * @param array &$cookedParams
 774    *     params after the processor code has translated them into its own key/value pairs
 775    *
 776    * @return mixed
 777    */
 778   static function alterPaymentProcessorParams($paymentObj,
 779     &$rawParams,
 780     &$cookedParams
 781   ) {
 782     return self::singleton()->invoke(3, $paymentObj, $rawParams, $cookedParams,
 783       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 784       'civicrm_alterPaymentProcessorParams'
 785     );
 786   }
 787
 788   /**
 789    * This hook is called when an email is about to be sent by CiviCRM.
 790    *
 791    * @param array $params
 792    *   Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
 793    * returnPath, replyTo, headers, attachments (array)
 794    * @param string $context - the context in which the hook is being invoked, eg 'civimail'
 795    *
 796    * @return mixed
 797    */
 798   static function alterMailParams(&$params, $context = NULL) {
 799     return self::singleton()->invoke(2, $params, $context,
 800       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 801       'civicrm_alterMailParams'
 802     );
 803   }
 804
 805   /**
 806    * This hook is called when membership status is being calculated
 807    *
 808    * @param array $membershipStatus membership status details as determined - alter if required
 809    * @param array $arguments arguments passed in to calculate date
 810    * - 'start_date'
 811    * - 'end_date'
 812    * - 'status_date'
 813    * - 'join_date'
 814    * - 'exclude_is_admin'
 815    * - 'membership_type_id'
 816    * @param array $membership membership details from the calling function
 817    *
 818    * @return mixed
 819    */
 820   static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
 821     return self::singleton()->invoke(3, $membershipStatus, $arguments,
 822       $membership, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 823       'civicrm_alterCalculatedMembershipStatus'
 824     );
 825   }
 826
 827   /**
 828    * This hook is called when rendering the Manage Case screen
 829    *
 830    * @param int $caseID - the case ID
 831    *
 832    * @return array of data to be displayed, where the key is a unique id to be used for styling (div id's)
 833    * and the value is an array with keys 'label' and 'value' specifying label/value pairs
 834    * @access public
 835    */
 836   static function caseSummary($caseID) {
 837     return self::singleton()->invoke(1, $caseID,
 838       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 839       'civicrm_caseSummary'
 840     );
 841   }
 842
 843   /**
 844    * This hook is called when locating CiviCase types.
 845    *
 846    * @param array $caseTypes
 847    *
 848    * @return mixed
 849    */
 850   static function caseTypes(&$caseTypes) {
 851     return self::singleton()->invoke(1, $caseTypes, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_caseTypes');
 852   }
 853
 854   /**
 855    * This hook is called soon after the CRM_Core_Config object has ben initialized.
 856    * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
 857    *
 858    * @param CRM_Core_Config|array $config
 859    *   The config object
 860    *
 861    * @return mixed
 862    */
 863   static function config(&$config) {
 864     return self::singleton()->invoke(1, $config,
 865       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 866       'civicrm_config'
 867     );
 868   }
 869
 870   static function enableDisable($recordBAO, $recordID, $isActive) {
 871     return self::singleton()->invoke(3, $recordBAO, $recordID, $isActive,
 872       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 873       'civicrm_enableDisable'
 874     );
 875   }
 876
 877   /**
 878    * This hooks allows to change option values
 879    *
 880    * @param array $options
 881    *   Associated array of option values / id
 882    * @param string $name
 883    *   Option group name
 884    *
 885    * @return mixed
 886    */
 887   static function optionValues(&$options, $name) {
 888     return self::singleton()->invoke(2, $options, $name,
 889       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 890       'civicrm_optionValues'
 891     );
 892   }
 893
 894   /**
 895    * This hook allows modification of the navigation menu.
 896    *
 897    * @param array $params
 898    *   Associated array of navigation menu entry to Modify/Add
 899    *
 900    * @return mixed
 901    */
 902   static function navigationMenu(&$params) {
 903     return self::singleton()->invoke(1, $params,
 904       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 905       'civicrm_navigationMenu'
 906     );
 907   }
 908
 909   /**
 910    * This hook allows modification of the data used to perform merging of duplicates.
 911    *
 912    * @param string $type the type of data being passed (cidRefs|eidRefs|relTables|sqls)
 913    * @param array $data the data, as described in $type
 914    * @param int $mainId contact_id of the contact that survives the merge
 915    * @param int $otherId contact_id of the contact that will be absorbed and deleted
 916    * @param array $tables when $type is "sqls", an array of tables as it may have been handed to the calling function
 917    *
 918    * @return mixed
 919    */
 920   static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
 921     return self::singleton()->invoke(5, $type, $data, $mainId, $otherId, $tables, self::$_nullObject, 'civicrm_merge');
 922   }
 923
 924   /**
 925    * This hook provides a way to override the default privacy behavior for notes.
 926    *
 927    * @param array &$noteValues
 928    *   Associative array of values for this note
 929    *
 930    * @return mixed
 931    */
 932   static function notePrivacy(&$noteValues) {
 933     return self::singleton()->invoke(1, $noteValues,
 934       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 935       'civicrm_notePrivacy'
 936     );
 937   }
 938
 939   /**
 940    * This hook is called before record is exported as CSV
 941    *
 942    * @param string $exportTempTable - name of the temporary export table used during export
 943    * @param array  $headerRows      - header rows for output
 944    * @param array  $sqlColumns      - SQL columns
 945    * @param int    $exportMode      - export mode ( contact, contribution, etc...)
 946    *
 947    * @return mixed
 948    */
 949   static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode) {
 950     return self::singleton()->invoke(4, $exportTempTable, $headerRows, $sqlColumns, $exportMode,
 951       self::$_nullObject, self::$_nullObject,
 952       'civicrm_export'
 953     );
 954   }
 955
 956   /**
 957    * This hook allows modification of the queries constructed from dupe rules.
 958    *
 959    * @param string $obj object of rulegroup class
 960    * @param string $type type of queries e.g table / threshold
 961    * @param array $query set of queries
 962    *
 963    * @return mixed
 964    * @access public
 965    */
 966   static function dupeQuery($obj, $type, &$query) {
 967     return self::singleton()->invoke(3, $obj, $type, $query,
 968       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 969       'civicrm_dupeQuery'
 970     );
 971   }
 972
 973   /**
 974    * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
 975    *
 976    * @param string $type type of mail processed: 'activity' OR 'mailing'
 977    * @param array &$params the params that were sent to the CiviCRM API function
 978    * @param object $mail the mail object which is an ezcMail class
 979    * @param array &$result the result returned by the api call
 980    * @param string $action (optional ) the requested action to be performed if the types was 'mailing'
 981    *
 982    * @return mixed
 983    * @access public
 984    */
 985   static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
 986     return self::singleton()->invoke(5, $type, $params, $mail, $result, $action, self::$_nullObject, 'civicrm_emailProcessor');
 987   }
 988
 989   /**
 990    * This hook is called after a row has been processed and the
 991    * record (and associated records imported
 992    *
 993    * @param string  $object     - object being imported (for now Contact only, later Contribution, Activity,
 994    *                               Participant and Member)
 995    * @param string  $usage      - hook usage/location (for now process only, later mapping and others)
 996    * @param string  $objectRef  - import record object
 997    * @param array   $params     - array with various key values: currently
 998    *                  contactID       - contact id
 999    *                  importID        - row id in temp table
1000    *                  importTempTable - name of tempTable
1001    *                  fieldHeaders    - field headers
1002    *                  fields          - import fields
1003    *
1004    * @return void
1005    * @access public
1006    */
1007   static function import($object, $usage, &$objectRef, &$params) {
1008     return self::singleton()->invoke(4, $object, $usage, $objectRef, $params,
1009       self::$_nullObject, self::$_nullObject,
1010       'civicrm_import'
1011     );
1012   }
1013
1014   /**
1015    * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1016    * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1017    *
1018    * @param string $entity the API entity (like contact)
1019    * @param string $action the API action (like get)
1020    * @param array &$params the API parameters
1021    * @param $permissions
1022    *
1023    * @return mixed
1024    * @internal param array $permisisons the associative permissions array (probably to be altered by this hook)
1025    */
1026   static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1027     return self::singleton()->invoke(4, $entity, $action, $params, $permissions,
1028       self::$_nullObject, self::$_nullObject,
1029       'civicrm_alterAPIPermissions'
1030     );
1031   }
1032
1033   static function postSave(&$dao) {
1034     $hookName = 'civicrm_postSave_' . $dao->getTableName();
1035     return self::singleton()->invoke(1, $dao,
1036       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1037       $hookName
1038     );
1039   }
1040
1041   /**
1042    * This hook allows user to customize context menu Actions on contact summary page.
1043    *
1044    * @param array $actions Array of all Actions in contextmenu.
1045    * @param int $contactID ContactID for the summary page
1046    *
1047    * @return mixed
1048    */
1049   static function summaryActions(&$actions, $contactID = NULL) {
1050     return self::singleton()->invoke(2, $actions, $contactID,
1051       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1052       'civicrm_summaryActions'
1053     );
1054   }
1055
1056   /**
1057    * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1058    * This enables us hook implementors to modify both the headers and the rows
1059    *
1060    * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1061    * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1062    *
1063    * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1064    * you want displayed. This is a hackish, but avoids template modification.
1065    *
1066    * @param string $objectName the component name that we are doing the search
1067    *                           activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1068    * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1069    * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1070    * @param $selector
1071    *
1072    * @internal param array $seletor the selector object. Allows you access to the context of the search
1073    *
1074    * @return void  modify the header and values object to pass the data u need
1075    */
1076   static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1077     return self::singleton()->invoke(4, $objectName, $headers, $rows, $selector,
1078       self::$_nullObject, self::$_nullObject,
1079       'civicrm_searchColumns'
1080     );
1081   }
1082
1083   /**
1084    * This hook is called when uf groups are being built for a module.
1085    *
1086    * @param string $moduleName module name.
1087    * @param array $ufGroups array of ufgroups for a module.
1088    *
1089    * @return null
1090    * @access public
1091    */
1092   static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1093     return self::singleton()->invoke(2, $moduleName, $ufGroups,
1094       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1095       'civicrm_buildUFGroupsForModule'
1096     );
1097   }
1098
1099   /**
1100    * This hook is called when we are determining the contactID for a specific
1101    * email address
1102    *
1103    * @param string $email     the email address
1104    * @param int    $contactID the contactID that matches this email address, IF it exists
1105    * @param array  $result (reference) has two fields
1106    *                          contactID - the new (or same) contactID
1107    *                          action - 3 possible values:
1108    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1109    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1110    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE   - skip this email address
1111    *
1112    * @return null
1113    * @access public
1114    */
1115   static function emailProcessorContact($email, $contactID, &$result) {
1116     return self::singleton()->invoke(3, $email, $contactID, $result,
1117       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1118       'civicrm_emailProcessorContact'
1119     );
1120   }
1121
1122   /**
1123    * Hook definition for altering the generation of Mailing Labels
1124    *
1125    * @param array $args an array of the args in the order defined for the tcpdf multiCell api call
1126    *                    with the variable names below converted into string keys (ie $w become 'w'
1127    *                    as the first key for $args)
1128    *   float $w Width of cells. If 0, they extend up to the right margin of the page.
1129    *   float $h Cell minimum height. The cell extends automatically if needed.
1130    *   string $txt String to print
1131    *   mixed $border Indicates if borders must be drawn around the cell block. The value can
1132    *                 be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1133    *                 a string containing some or all of the following characters (in any order):
1134    *                 <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1135    *   string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1136    *                 left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1137    *                 (default value when $ishtml=false)</li></ul>
1138    *   int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1139    *   int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1140    *           to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1141    *   float $x x position in user units
1142    *   float $y y position in user units
1143    *   boolean $reseth if true reset the last cell height (default true).
1144    *   int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1145    *                necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1146    *                necessary</li><li>4 = forced character spacing</li></ul>
1147    *   boolean $ishtml set to true if $txt is HTML content (default = false).
1148    *   boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1149    *   float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1150    *               or 0 for disable this feature. This feature works only when $ishtml=false.
1151    *
1152    * @return mixed
1153    */
1154   static function alterMailingLabelParams(&$args) {
1155     return self::singleton()->invoke(1, $args,
1156       self::$_nullObject, self::$_nullObject,
1157       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1158       'civicrm_alterMailingLabelParams'
1159     );
1160   }
1161
1162   /**
1163    * This hooks allows alteration of generated page content
1164    *
1165    * @param $content  previously generated content
1166    * @param $context  context of content - page or form
1167    * @param $tplName  the file name of the tpl
1168    * @param $object   a reference to the page or form object
1169    *
1170    * @return mixed
1171    * @access public
1172    */
1173   static function alterContent(&$content, $context, $tplName, &$object) {
1174     return self::singleton()->invoke(4, $content, $context, $tplName, $object,
1175       self::$_nullObject, self::$_nullObject,
1176       'civicrm_alterContent'
1177     );
1178   }
1179
1180   /**
1181    * This hooks allows alteration of the tpl file used to generate content. It differs from the
1182    * altercontent hook as the content has already been rendered through the tpl at that point
1183    *
1184    * @param $formName  previously generated content
1185    * @param $form reference to the form object
1186    * @param $context  context of content - page or form
1187    * @param $tplName reference the file name of the tpl
1188    *
1189    * @return mixed
1190    * @access public
1191    */
1192   static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1193     return self::singleton()->invoke(4, $formName, $form, $context, $tplName,
1194       self::$_nullObject, self::$_nullObject,
1195       'civicrm_alterTemplateFile'
1196     );
1197   }
1198
1199   /**
1200    * This hook collects the trigger definition from all components
1201    *
1202    * @param $info
1203    * @param string $tableName (optional) the name of the table that we are interested in only
1204    *
1205    * @internal param \reference $triggerInfo to an array of trigger information
1206    *   each element has 4 fields:
1207    *     table - array of tableName
1208    *     when  - BEFORE or AFTER
1209    *     event - array of eventName - INSERT OR UPDATE OR DELETE
1210    *     sql   - array of statements optionally terminated with a ;
1211    *             a statement can use the tokes {tableName} and {eventName}
1212    *             to do token replacement with the table / event. This allows
1213    *             templatizing logging and other hooks
1214    * @return mixed
1215    */
1216   static function triggerInfo(&$info, $tableName = NULL) {
1217     return self::singleton()->invoke(2, $info, $tableName,
1218       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1219       self::$_nullObject,
1220       'civicrm_triggerInfo'
1221     );
1222   }
1223
1224   /**
1225    * This hook is called when a module-extension is installed.
1226    * Each module will receive hook_civicrm_install during its own installation (but not during the
1227    * installation of unrelated modules).
1228    */
1229   static function install() {
1230     return self::singleton()->invoke(0, self::$_nullObject,
1231       self::$_nullObject, self::$_nullObject,
1232       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1233       'civicrm_install'
1234     );
1235   }
1236
1237   /**
1238    * This hook is called when a module-extension is uninstalled.
1239    * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1240    * uninstallation of unrelated modules).
1241    */
1242   static function uninstall() {
1243     return self::singleton()->invoke(0, self::$_nullObject,
1244       self::$_nullObject, self::$_nullObject,
1245       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1246       'civicrm_uninstall'
1247     );
1248   }
1249
1250   /**
1251    * This hook is called when a module-extension is re-enabled.
1252    * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1253    * re-enablement of unrelated modules).
1254    */
1255   static function enable() {
1256     return self::singleton()->invoke(0, self::$_nullObject,
1257       self::$_nullObject, self::$_nullObject,
1258       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1259       'civicrm_enable'
1260     );
1261   }
1262
1263   /**
1264    * This hook is called when a module-extension is disabled.
1265    * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1266    * disablement of unrelated modules).
1267    */
1268   static function disable() {
1269     return self::singleton()->invoke(0, self::$_nullObject,
1270       self::$_nullObject, self::$_nullObject,
1271       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1272       'civicrm_disable'
1273     );
1274   }
1275
1276   static function alterReportVar($varType, &$var, &$object) {
1277     return self::singleton()->invoke(3, $varType, $var, $object,
1278       self::$_nullObject,
1279       self::$_nullObject, self::$_nullObject,
1280       'civicrm_alterReportVar'
1281     );
1282   }
1283
1284   /**
1285    * This hook is called to drive database upgrades for extension-modules.
1286    *
1287    * @param string $op
1288    *   The type of operation being performed; 'check' or 'enqueue'.
1289    * @param CRM_Queue_Queue $queue
1290    *   (for 'enqueue') the modifiable list of pending up upgrade tasks.
1291    *
1292    * @return bool|null
1293    *   NULL, if $op is 'enqueue'.
1294    *   TRUE, if $op is 'check' and upgrades are pending.
1295    *   FALSE, if $op is 'check' and upgrades are not pending.
1296    */
1297   static function upgrade($op, CRM_Queue_Queue $queue = NULL) {
1298     return self::singleton()->invoke(2, $op, $queue,
1299       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1300       self::$_nullObject,
1301       'civicrm_upgrade'
1302     );
1303   }
1304
1305   /**
1306    * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1307    *
1308    * @param array $params
1309    *   The mailing parameters. Array fields include: groupName, from, toName,
1310    *   toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1311    *   attachments (array)
1312    *
1313    * @return mixed
1314    */
1315   static function postEmailSend(&$params) {
1316     return self::singleton()->invoke(1, $params,
1317       self::$_nullObject, self::$_nullObject,
1318       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1319       'civicrm_postEmailSend'
1320     );
1321   }
1322
1323   /**
1324    * This hook is called when Settings specifications are loaded
1325    *
1326    * @param array $settingsFolders
1327    *   List of paths from which to derive metadata
1328    *
1329    * @return mixed
1330    */
1331   static function alterSettingsFolders(&$settingsFolders) {
1332     return self::singleton()->invoke(1, $settingsFolders,
1333         self::$_nullObject, self::$_nullObject,
1334         self::$_nullObject, self::$_nullObject, self::$_nullObject,
1335         'civicrm_alterSettingsFolders'
1336     );
1337   }
1338
1339   /**
1340    * This hook is called when Settings have been loaded from the xml
1341    * It is an opportunity for hooks to alter the data
1342    *
1343    * @param array $settingsMetaData - Settings Metadata
1344    * @param int $domainID
1345    * @param mixed $profile
1346    *
1347    * @return mixed
1348    */
1349   static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1350     return self::singleton()->invoke(3, $settingsMetaData,
1351         $domainID, $profile,
1352         self::$_nullObject, self::$_nullObject, self::$_nullObject,
1353         'civicrm_alterSettingsMetaData'
1354     );
1355   }
1356
1357   /**
1358    * This hook is called before running an api call.
1359    *
1360    * @param API_Wrapper[] $wrappers
1361    *   (see CRM_Utils_API_ReloadOption as an example)
1362    * @param mixed $apiRequest
1363    *
1364    * @return null
1365    *   The return value is ignored
1366    */
1367   static function apiWrappers(&$wrappers, $apiRequest) {
1368     return self::singleton()
1369       ->invoke(2, $wrappers, $apiRequest, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1370       self::$_nullObject, 'civicrm_apiWrappers'
1371     );
1372   }
1373
1374   /**
1375    * This hook is called before running pending cron jobs.
1376    *
1377    * @param CRM_Core_JobManager $jobManager
1378    *
1379    * @return null
1380    *   The return value is ignored.
1381    */
1382   static function cron($jobManager) {
1383     return self::singleton()->invoke(1,
1384       $jobManager, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1385       'civicrm_cron'
1386     );
1387   }
1388
1389   /**
1390    * This hook is called when loading CMS permissions; use this hook to modify
1391    * the array of system permissions for CiviCRM.
1392    *
1393    * @param array $permissions
1394    *   Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1395    *   the format of this array.
1396    *
1397    * @return null
1398    *   The return value is ignored
1399    */
1400   static function permission(&$permissions) {
1401     return self::singleton()->invoke(1, $permissions,
1402       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1403       'civicrm_permission'
1404     );
1405   }
1406
1407
1408   /**
1409    * This hook is called for declaring managed entities via API
1410    *
1411    * @param array[] $entityTypes
1412    *   List of entity types; each entity-type is an array with keys:
1413    *   - name: string, a unique short name (e.g. "ReportInstance")
1414    *   - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1415    *   - table: string, a SQL table name (e.g. "civicrm_report_instance")
1416    *
1417    * @return null
1418    *   The return value is ignored
1419    */
1420   static function entityTypes(&$entityTypes) {
1421     return self::singleton()->invoke(1, $entityTypes, self::$_nullObject, self::$_nullObject,
1422       self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_entityTypes'
1423     );
1424   }
1425
1426   /**
1427    * This hook is called while preparing a profile form
1428    *
1429    * @param string $name
1430    * @return mixed
1431    */
1432   static function buildProfile($name) {
1433     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1434       self::$_nullObject, self::$_nullObject, 'civicrm_buildProfile');
1435   }
1436
1437   /**
1438    * This hook is called while validating a profile form submission
1439    *
1440    * @param string $name
1441    * @return mixed
1442    */
1443   static function validateProfile($name) {
1444     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1445       self::$_nullObject, self::$_nullObject, 'civicrm_validateProfile');
1446   }
1447
1448   /**
1449    * This hook is called processing a valid profile form submission
1450    *
1451    * @param string $name
1452    * @return mixed
1453    */
1454   static function processProfile($name) {
1455     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1456       self::$_nullObject, self::$_nullObject, 'civicrm_processProfile');
1457   }
1458
1459   /**
1460    * This hook is called while preparing a read-only profile screen
1461    *
1462    * @param string $name
1463    * @return mixed
1464    */
1465   static function viewProfile($name) {
1466     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1467       self::$_nullObject, self::$_nullObject, 'civicrm_viewProfile');
1468   }
1469
1470   /**
1471    * This hook is called while preparing a list of contacts (based on a profile)
1472    *
1473    * @param string $name
1474    * @return mixed
1475    */
1476   static function searchProfile($name) {
1477     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1478       self::$_nullObject, self::$_nullObject, 'civicrm_searchProfile');
1479   }
1480
1481   /**
1482    * This hook is invoked when building a CiviCRM name badge.
1483    *
1484    * @param string $labelName string referencing name of badge format
1485    * @param object $label    reference to the label object
1486    * @param array  $format   array of format data
1487    * @param array  $participant array of participant values
1488    *
1489    * @return null the return value is ignored
1490    */
1491   static function alterBadge($labelName, &$label, &$format, &$participant) {
1492     return self::singleton()->invoke(4, $labelName, $label, $format, $participant, self::$_nullObject, self::$_nullObject, 'civicrm_alterBadge');
1493   }
1494
1495
1496   /**
1497    * This hook is called before encoding data in barcode
1498    *
1499    * @param array  $data associated array of values available for encoding
1500    * @param string $type type of barcode, classic barcode or QRcode
1501    * @param string $context where this hooks is invoked.
1502    *
1503    * @return mixed
1504    */
1505   static function alterBarcode( &$data, $type = 'barcode', $context = 'name_badge' ) {
1506     return self::singleton()->invoke(3, $data, $type, $context, self::$_nullObject,
1507       self::$_nullObject, self::$_nullObject, 'civicrm_alterBarcode');
1508   }
1509
1510   /**
1511    * Modify or replace the Mailer object used for outgoing mail.
1512    *
1513    * @param object $mailer
1514    *   The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
1515    * @param string $driver
1516    *   The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
1517    * @param array $params
1518    *   The default mailer config options
1519    *
1520    * @return mixed
1521    * @see Mail::factory
1522    */
1523   static function alterMail(&$mailer, $driver, $params) {
1524     return self::singleton()
1525       ->invoke(3, $mailer, $driver, $params, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_alterMailer');
1526   }
1527
1528   /**
1529    * This hook is called while building the core search query,
1530    * so hook implementers can provide their own query objects which alters/extends core search.
1531    *
1532    * @param array $queryObjects
1533    * @param string $type
1534    *
1535    * @return mixed
1536    */
1537   static function queryObjects(&$queryObjects, $type = 'Contact') {
1538     return self::singleton()->invoke(2, $queryObjects, $type, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_queryObjects');
1539   }
1540
1541   /**
1542    * This hook is called while viewing contact dashboard
1543    *
1544    * @param array $availableDashlets
1545    *   List of dashlets; each is formatted per api/v3/Dashboard
1546    * @param array $defaultDashlets
1547    *   List of dashlets; each is formatted per api/v3/DashboardContact
1548    *
1549    * @return mixed
1550    */
1551   static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
1552     return self::singleton()->invoke(2, $availableDashlets, $defaultDashlets, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_dashboard_defaults');
1553   }
1554
1555   /**
1556    * This hook is called before a case merge (or a case reassign)
1557    *
1558    * @param type $mainContactId
1559    * @param type $mainCaseId
1560    * @param type $otherContactId
1561    * @param type $otherCaseId
1562    * @param bool|\type $changeClient
1563    *
1564    * @return void
1565    */
1566   static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1567     return self::singleton()->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, 'civicrm_pre_case_merge');
1568   }
1569
1570   /**
1571    * This hook is called after a case merge (or a case reassign)
1572    *
1573    * @param type $mainContactId
1574    * @param type $mainCaseId
1575    * @param type $otherContactId
1576    * @param type $otherCaseId
1577    * @param bool|\type $changeClient
1578    *
1579    * @return void
1580    */
1581   static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1582     return self::singleton()->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, 'civicrm_post_case_merge');
1583   }
1584
1585   /**
1586    * Issue CRM-14276
1587    * Add a hook for altering the display name
1588    *
1589    * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
1590    *
1591    * @param string $displayName
1592    * @param int $contactId
1593    * @param object $dao the contact object
1594    *
1595    * @return mixed
1596    */
1597   static function alterDisplayName($displayName, $contactId, $dao) {
1598     return self::singleton()->invoke(3,
1599       $displayName, $contactId, $dao, self::$_nullObject, self::$_nullObject,
1600       self::$_nullObject, 'civicrm_contact_get_displayname'
1601     );
1602   }
1603 }