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    *
 627    * @return mixed
 628    */
 629   static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE) {
 630     return self::singleton()->invoke(3, $customFieldID, $options, $detailedFormat,
 631       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 632       'civicrm_customFieldOptions'
 633     );
 634   }
 635
 636   /**
 637    *
 638    * This hook is called to display the list of actions allowed after doing a search.
 639    * This allows the module developer to inject additional actions or to remove existing actions.
 640    *
 641    * @param string $objectType - the object type for this search
 642    *   - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
 643    * @param array $tasks - the current set of tasks for that custom field.
 644    *   You can add/remove existing tasks.
 645    *   Each task needs to have a title (eg 'title'  => ts( 'Add Contacts to Group')) and a class
 646    *   (eg 'class'  => 'CRM_Contact_Form_Task_AddToGroup').
 647    *   Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
 648    *   The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
 649    *   found in CRM/$objectType/Task.php.
 650    *
 651    * @return mixed
 652    */
 653   static function searchTasks($objectType, &$tasks) {
 654     return self::singleton()->invoke(2, $objectType, $tasks,
 655       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 656       'civicrm_searchTasks'
 657     );
 658   }
 659
 660   /**
 661    * @param mixed $form
 662    * @param array $params
 663    *
 664    * @return mixed
 665    */
 666   static function eventDiscount(&$form, &$params) {
 667     return self::singleton()->invoke(2, $form, $params,
 668       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 669       'civicrm_eventDiscount'
 670     );
 671   }
 672
 673   /**
 674    * This hook is called when composing a mailing. You can include / exclude other groups as needed.
 675    *
 676    * @param mixed $form
 677    *   The form object for which groups / mailings being displayed
 678    * @param array $groups
 679    *   The list of groups being included / excluded
 680    * @param array $mailings
 681    *   The list of mailings being included / excluded
 682    *
 683    * @return mixed
 684    */
 685   static function mailingGroups(&$form, &$groups, &$mailings) {
 686     return self::singleton()->invoke(3, $form, $groups, $mailings,
 687       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 688       'civicrm_mailingGroups'
 689     );
 690   }
 691
 692   /**
 693    * This hook is called when composing the array of membershipTypes and their cost during a membership registration
 694    * (new or renewal).
 695    * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
 696    * You can use it to alter the membership types when first loaded, or after submission
 697    * (for example if you want to gather data in the form and use it to alter the fees).
 698    *
 699    * @param mixed $form
 700    *   The form object that is presenting the page
 701    * @param array $membershipTypes
 702    *   The array of membership types and their amount
 703    *
 704    * @return mixed
 705    */
 706   static function membershipTypeValues(&$form, &$membershipTypes) {
 707     return self::singleton()->invoke(2, $form, $membershipTypes,
 708       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 709       'civicrm_membershipTypeValues'
 710     );
 711   }
 712
 713   /**
 714    * This hook is called when rendering the contact summary
 715    *
 716    * @param int $contactID
 717    *   The contactID for whom the summary is being rendered
 718    * @param mixed $content
 719    * @param int $contentPlacement
 720    *   Specifies where the hook content should be displayed relative to the
 721    *   existing content
 722    *
 723    * @return string
 724    *   The html snippet to include in the contact summary
 725    */
 726   static function summary($contactID, &$content, &$contentPlacement = self::SUMMARY_BELOW) {
 727     return self::singleton()->invoke(3, $contactID, $content, $contentPlacement,
 728       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 729       'civicrm_summary'
 730     );
 731   }
 732
 733   /**
 734    * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
 735    * By default, Contact Reference fields will search on and return all CiviCRM contacts.
 736    * If you want to limit the contacts returned to a specific group, or some other criteria
 737    * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
 738    * The hook is called when the query is executed to get the list of contacts to display.
 739    *
 740    * @param mixed $query - - the query that will be executed (input and output parameter);
 741    *   It's important to realize that the ACL clause is built prior to this hook being fired,
 742    *   so your query will ignore any ACL rules that may be defined.
 743    *   Your query must return two columns:
 744    *     the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
 745    *     the contact IDs
 746    * @param string $name - the name string to execute the query against (this is the value being typed in by the user)
 747    * @param string $context - the context in which this ajax call is being made (for example: 'customfield', 'caseview')
 748    * @param int $id - the id of the object for which the call is being made.
 749    *   For custom fields, it will be the custom field id
 750    *
 751    * @return mixed
 752    */
 753   static function contactListQuery(&$query, $name, $context, $id) {
 754     return self::singleton()->invoke(4, $query, $name, $context, $id,
 755       self::$_nullObject, self::$_nullObject,
 756       'civicrm_contactListQuery'
 757     );
 758   }
 759
 760   /**
 761    * Hook definition for altering payment parameters before talking to a payment processor back end.
 762    *
 763    * Definition will look like this:
 764    *
 765    *   function hook_civicrm_alterPaymentProcessorParams($paymentObj,
 766    *                                                     &$rawParams, &$cookedParams);
 767    *
 768    * @param string $paymentObj
 769    *    instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
 770    * @param array &$rawParams
 771    *    array of params as passed to to the processor
 772    * @param array &$cookedParams
 773    *     params after the processor code has translated them into its own key/value pairs
 774    *
 775    * @return mixed
 776    */
 777   static function alterPaymentProcessorParams($paymentObj,
 778     &$rawParams,
 779     &$cookedParams
 780   ) {
 781     return self::singleton()->invoke(3, $paymentObj, $rawParams, $cookedParams,
 782       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 783       'civicrm_alterPaymentProcessorParams'
 784     );
 785   }
 786
 787   /**
 788    * This hook is called when an email is about to be sent by CiviCRM.
 789    *
 790    * @param array $params
 791    *   Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
 792    * returnPath, replyTo, headers, attachments (array)
 793    * @param string $context - the context in which the hook is being invoked, eg 'civimail'
 794    *
 795    * @return mixed
 796    */
 797   static function alterMailParams(&$params, $context = NULL) {
 798     return self::singleton()->invoke(2, $params, $context,
 799       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 800       'civicrm_alterMailParams'
 801     );
 802   }
 803
 804   /**
 805    * This hook is called when membership status is being calculated
 806    *
 807    * @param array $membershipStatus membership status details as determined - alter if required
 808    * @param array $arguments arguments passed in to calculate date
 809    * - 'start_date'
 810    * - 'end_date'
 811    * - 'status_date'
 812    * - 'join_date'
 813    * - 'exclude_is_admin'
 814    * - 'membership_type_id'
 815    * @param array $membership membership details from the calling function
 816    */
 817   static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
 818     return self::singleton()->invoke(3, $membershipStatus, $arguments,
 819       $membership, self::$_nullObject, self::$_nullObject,
 820       'civicrm_alterCalculatedMembershipStatus'
 821     );
 822   }
 823
 824   /**
 825    * This hook is called when rendering the Manage Case screen
 826    *
 827    * @param int $caseID - the case ID
 828    *
 829    * @return array of data to be displayed, where the key is a unique id to be used for styling (div id's)
 830    * and the value is an array with keys 'label' and 'value' specifying label/value pairs
 831    * @access public
 832    */
 833   static function caseSummary($caseID) {
 834     return self::singleton()->invoke(1, $caseID,
 835       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 836       'civicrm_caseSummary'
 837     );
 838   }
 839
 840   /**
 841    * This hook is called when locating CiviCase types.
 842    *
 843    * @param array $caseTypes
 844    *
 845    * @return mixed
 846    */
 847   static function caseTypes(&$caseTypes) {
 848     return self::singleton()->invoke(1, $caseTypes, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_caseTypes');
 849   }
 850
 851   /**
 852    * This hook is called soon after the CRM_Core_Config object has ben initialized.
 853    * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
 854    *
 855    * @param CRM_Core_Config|array $config
 856    *   The config object
 857    *
 858    * @return mixed
 859    */
 860   static function config(&$config) {
 861     return self::singleton()->invoke(1, $config,
 862       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 863       'civicrm_config'
 864     );
 865   }
 866
 867   static function enableDisable($recordBAO, $recordID, $isActive) {
 868     return self::singleton()->invoke(3, $recordBAO, $recordID, $isActive,
 869       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 870       'civicrm_enableDisable'
 871     );
 872   }
 873
 874   /**
 875    * This hooks allows to change option values
 876    *
 877    * @param array $options
 878    *   Associated array of option values / id
 879    * @param string $name
 880    *   Option group name
 881    *
 882    * @return mixed
 883    */
 884   static function optionValues(&$options, $name) {
 885     return self::singleton()->invoke(2, $options, $name,
 886       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 887       'civicrm_optionValues'
 888     );
 889   }
 890
 891   /**
 892    * This hook allows modification of the navigation menu.
 893    *
 894    * @param array $params
 895    *   Associated array of navigation menu entry to Modify/Add
 896    *
 897    * @return mixed
 898    */
 899   static function navigationMenu(&$params) {
 900     return self::singleton()->invoke(1, $params,
 901       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 902       'civicrm_navigationMenu'
 903     );
 904   }
 905
 906   /**
 907    * This hook allows modification of the data used to perform merging of duplicates.
 908    *
 909    * @param string $type the type of data being passed (cidRefs|eidRefs|relTables|sqls)
 910    * @param array $data the data, as described in $type
 911    * @param int $mainId contact_id of the contact that survives the merge
 912    * @param int $otherId contact_id of the contact that will be absorbed and deleted
 913    * @param array $tables when $type is "sqls", an array of tables as it may have been handed to the calling function
 914    *
 915    * @return mixed
 916    */
 917   static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
 918     return self::singleton()->invoke(5, $type, $data, $mainId, $otherId, $tables, self::$_nullObject, 'civicrm_merge');
 919   }
 920
 921   /**
 922    * This hook provides a way to override the default privacy behavior for notes.
 923    *
 924    * @param array &$noteValues
 925    *   Associative array of values for this note
 926    *
 927    * @return mixed
 928    */
 929   static function notePrivacy(&$noteValues) {
 930     return self::singleton()->invoke(1, $noteValues,
 931       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 932       'civicrm_notePrivacy'
 933     );
 934   }
 935
 936   /**
 937    * This hook is called before record is exported as CSV
 938    *
 939    * @param string $exportTempTable - name of the temporary export table used during export
 940    * @param array  $headerRows      - header rows for output
 941    * @param array  $sqlColumns      - SQL columns
 942    * @param int    $exportMode      - export mode ( contact, contribution, etc...)
 943    *
 944    * @return mixed
 945    */
 946   static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode) {
 947     return self::singleton()->invoke(4, $exportTempTable, $headerRows, $sqlColumns, $exportMode,
 948       self::$_nullObject, self::$_nullObject,
 949       'civicrm_export'
 950     );
 951   }
 952
 953   /**
 954    * This hook allows modification of the queries constructed from dupe rules.
 955    *
 956    * @param string $obj object of rulegroup class
 957    * @param string $type type of queries e.g table / threshold
 958    * @param array  $query set of queries
 959    *
 960    * @access public
 961    */
 962   static function dupeQuery($obj, $type, &$query) {
 963     return self::singleton()->invoke(3, $obj, $type, $query,
 964       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 965       'civicrm_dupeQuery'
 966     );
 967   }
 968
 969   /**
 970    * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
 971    *
 972    * @param string  $type    type of mail processed: 'activity' OR 'mailing'
 973    * @param array  &$params  the params that were sent to the CiviCRM API function
 974    * @param object  $mail    the mail object which is an ezcMail class
 975    * @param array  &$result  the result returned by the api call
 976    * @param string  $action  (optional ) the requested action to be performed if the types was 'mailing'
 977    *
 978    * @access public
 979    */
 980   static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
 981     return self::singleton()->invoke(5, $type, $params, $mail, $result, $action, self::$_nullObject, 'civicrm_emailProcessor');
 982   }
 983
 984   /**
 985    * This hook is called after a row has been processed and the
 986    * record (and associated records imported
 987    *
 988    * @param string  $object     - object being imported (for now Contact only, later Contribution, Activity,
 989    *                               Participant and Member)
 990    * @param string  $usage      - hook usage/location (for now process only, later mapping and others)
 991    * @param string  $objectRef  - import record object
 992    * @param array   $params     - array with various key values: currently
 993    *                  contactID       - contact id
 994    *                  importID        - row id in temp table
 995    *                  importTempTable - name of tempTable
 996    *                  fieldHeaders    - field headers
 997    *                  fields          - import fields
 998    *
 999    * @return void
1000    * @access public
1001    */
1002   static function import($object, $usage, &$objectRef, &$params) {
1003     return self::singleton()->invoke(4, $object, $usage, $objectRef, $params,
1004       self::$_nullObject, self::$_nullObject,
1005       'civicrm_import'
1006     );
1007   }
1008
1009   /**
1010    * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1011    * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1012    *
1013    * @param string $entity       the API entity (like contact)
1014    * @param string $action       the API action (like get)
1015    * @param array &$params       the API parameters
1016    * @param array &$permisisons  the associative permissions array (probably to be altered by this hook)
1017    */
1018   static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1019     return self::singleton()->invoke(4, $entity, $action, $params, $permissions,
1020       self::$_nullObject, self::$_nullObject,
1021       'civicrm_alterAPIPermissions'
1022     );
1023   }
1024
1025   static function postSave(&$dao) {
1026     $hookName = 'civicrm_postSave_' . $dao->getTableName();
1027     return self::singleton()->invoke(1, $dao,
1028       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1029       $hookName
1030     );
1031   }
1032
1033   /**
1034    * This hook allows user to customize context menu Actions on contact summary page.
1035    *
1036    * @param array $actions       Array of all Actions in contextmenu.
1037    * @param int   $contactID     ContactID for the summary page
1038    */
1039   static function summaryActions(&$actions, $contactID = NULL) {
1040     return self::singleton()->invoke(2, $actions, $contactID,
1041       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1042       'civicrm_summaryActions'
1043     );
1044   }
1045
1046   /**
1047    * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1048    * This enables us hook implementors to modify both the headers and the rows
1049    *
1050    * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1051    * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1052    *
1053    * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1054    * you want displayed. This is a hackish, but avoids template modification.
1055    *
1056    * @param string $objectName the component name that we are doing the search
1057    *                           activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1058    * @param array  &$headers   the list of column headers, an associative array with keys: ( name, sort, order )
1059    * @param array  &$rows      the list of values, an associate array with fields that are displayed for that component
1060    * @param array  &$seletor   the selector object. Allows you access to the context of the search
1061    *
1062    * @return void  modify the header and values object to pass the data u need
1063    */
1064   static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1065     return self::singleton()->invoke(4, $objectName, $headers, $rows, $selector,
1066       self::$_nullObject, self::$_nullObject,
1067       'civicrm_searchColumns'
1068     );
1069   }
1070
1071   /**
1072    * This hook is called when uf groups are being built for a module.
1073    *
1074    * @param string $moduleName module name.
1075    * @param array $ufGroups array of ufgroups for a module.
1076    *
1077    * @return null
1078    * @access public
1079    */
1080   static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1081     return self::singleton()->invoke(2, $moduleName, $ufGroups,
1082       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1083       'civicrm_buildUFGroupsForModule'
1084     );
1085   }
1086
1087   /**
1088    * This hook is called when we are determining the contactID for a specific
1089    * email address
1090    *
1091    * @param string $email     the email address
1092    * @param int    $contactID the contactID that matches this email address, IF it exists
1093    * @param array  $result (reference) has two fields
1094    *                          contactID - the new (or same) contactID
1095    *                          action - 3 possible values:
1096    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1097    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1098    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE   - skip this email address
1099    *
1100    * @return null
1101    * @access public
1102    */
1103   static function emailProcessorContact($email, $contactID, &$result) {
1104     return self::singleton()->invoke(3, $email, $contactID, $result,
1105       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1106       'civicrm_emailProcessorContact'
1107     );
1108   }
1109
1110   /**
1111    * Hook definition for altering the generation of Mailing Labels
1112    *
1113    * @param array $args an array of the args in the order defined for the tcpdf multiCell api call
1114    *                    with the variable names below converted into string keys (ie $w become 'w'
1115    *                    as the first key for $args)
1116    *   float $w Width of cells. If 0, they extend up to the right margin of the page.
1117    *   float $h Cell minimum height. The cell extends automatically if needed.
1118    *   string $txt String to print
1119    *   mixed $border Indicates if borders must be drawn around the cell block. The value can
1120    *                 be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1121    *                 a string containing some or all of the following characters (in any order):
1122    *                 <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1123    *   string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1124    *                 left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1125    *                 (default value when $ishtml=false)</li></ul>
1126    *   int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1127    *   int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1128    *           to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1129    *   float $x x position in user units
1130    *   float $y y position in user units
1131    *   boolean $reseth if true reset the last cell height (default true).
1132    *   int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1133    *                necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1134    *                necessary</li><li>4 = forced character spacing</li></ul>
1135    *   boolean $ishtml set to true if $txt is HTML content (default = false).
1136    *   boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1137    *   float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1138    *               or 0 for disable this feature. This feature works only when $ishtml=false.
1139    *
1140    */
1141   static function alterMailingLabelParams(&$args) {
1142     return self::singleton()->invoke(1, $args,
1143       self::$_nullObject, self::$_nullObject,
1144       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1145       'civicrm_alterMailingLabelParams'
1146     );
1147   }
1148
1149   /**
1150    * This hooks allows alteration of generated page content
1151    *
1152    * @param $content  previously generated content
1153    * @param $context  context of content - page or form
1154    * @param $tplName  the file name of the tpl
1155    * @param $object   a reference to the page or form object
1156    *
1157    * @access public
1158    */
1159   static function alterContent(&$content, $context, $tplName, &$object) {
1160     return self::singleton()->invoke(4, $content, $context, $tplName, $object,
1161       self::$_nullObject, self::$_nullObject,
1162       'civicrm_alterContent'
1163     );
1164   }
1165
1166   /**
1167    * This hooks allows alteration of the tpl file used to generate content. It differs from the
1168    * altercontent hook as the content has already been rendered through the tpl at that point
1169    *
1170    * @param $formName  previously generated content
1171    * @param $form reference to the form object
1172    * @param $context  context of content - page or form
1173    * @param $tplName reference the file name of the tpl
1174    *
1175    * @access public
1176    */
1177   static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1178     return self::singleton()->invoke(4, $formName, $form, $context, $tplName,
1179       self::$_nullObject, self::$_nullObject,
1180       'civicrm_alterTemplateFile'
1181     );
1182   }
1183   /**
1184    * This hook collects the trigger definition from all components
1185    *
1186    * @param $triggerInfo reference to an array of trigger information
1187    *   each element has 4 fields:
1188    *     table - array of tableName
1189    *     when  - BEFORE or AFTER
1190    *     event - array of eventName - INSERT OR UPDATE OR DELETE
1191    *     sql   - array of statements optionally terminated with a ;
1192    *             a statement can use the tokes {tableName} and {eventName}
1193    *             to do token replacement with the table / event. This allows
1194    *             templatizing logging and other hooks
1195    * @param string $tableName (optional) the name of the table that we are interested in only
1196    */
1197   static function triggerInfo(&$info, $tableName = NULL) {
1198     return self::singleton()->invoke(2, $info, $tableName,
1199       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1200       self::$_nullObject,
1201       'civicrm_triggerInfo'
1202     );
1203   }
1204
1205   /**
1206    * This hook is called when a module-extension is installed.
1207    * Each module will receive hook_civicrm_install during its own installation (but not during the
1208    * installation of unrelated modules).
1209    */
1210   static function install() {
1211     return self::singleton()->invoke(0, self::$_nullObject,
1212       self::$_nullObject, self::$_nullObject,
1213       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1214       'civicrm_install'
1215     );
1216   }
1217
1218   /**
1219    * This hook is called when a module-extension is uninstalled.
1220    * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1221    * uninstallation of unrelated modules).
1222    */
1223   static function uninstall() {
1224     return self::singleton()->invoke(0, self::$_nullObject,
1225       self::$_nullObject, self::$_nullObject,
1226       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1227       'civicrm_uninstall'
1228     );
1229   }
1230
1231   /**
1232    * This hook is called when a module-extension is re-enabled.
1233    * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1234    * re-enablement of unrelated modules).
1235    */
1236   static function enable() {
1237     return self::singleton()->invoke(0, self::$_nullObject,
1238       self::$_nullObject, self::$_nullObject,
1239       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1240       'civicrm_enable'
1241     );
1242   }
1243
1244   /**
1245    * This hook is called when a module-extension is disabled.
1246    * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1247    * disablement of unrelated modules).
1248    */
1249   static function disable() {
1250     return self::singleton()->invoke(0, self::$_nullObject,
1251       self::$_nullObject, self::$_nullObject,
1252       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1253       'civicrm_disable'
1254     );
1255   }
1256
1257   static function alterReportVar($varType, &$var, &$object) {
1258     return self::singleton()->invoke(3, $varType, $var, $object,
1259       self::$_nullObject,
1260       self::$_nullObject, self::$_nullObject,
1261       'civicrm_alterReportVar'
1262     );
1263   }
1264
1265   /**
1266    * This hook is called to drive database upgrades for extension-modules.
1267    *
1268    * @param string $op
1269    *   The type of operation being performed; 'check' or 'enqueue'.
1270    * @param CRM_Queue_Queue $queue
1271    *   (for 'enqueue') the modifiable list of pending up upgrade tasks.
1272    *
1273    * @return bool|null
1274    *   NULL, if $op is 'enqueue'.
1275    *   TRUE, if $op is 'check' and upgrades are pending.
1276    *   FALSE, if $op is 'check' and upgrades are not pending.
1277    */
1278   static function upgrade($op, CRM_Queue_Queue $queue = NULL) {
1279     return self::singleton()->invoke(2, $op, $queue,
1280       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1281       self::$_nullObject,
1282       'civicrm_upgrade'
1283     );
1284   }
1285
1286   /**
1287    * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1288    *
1289    * @param array $params
1290    *   The mailing parameters. Array fields include: groupName, from, toName,
1291    *   toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1292    *   attachments (array)
1293    *
1294    * @return mixed
1295    */
1296   static function postEmailSend(&$params) {
1297     return self::singleton()->invoke(1, $params,
1298       self::$_nullObject, self::$_nullObject,
1299       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1300       'civicrm_postEmailSend'
1301     );
1302   }
1303
1304   /**
1305    * This hook is called when Settings specifications are loaded
1306    *
1307    * @param array $settingsFolders
1308    *   List of paths from which to derive metadata
1309    *
1310    * @return mixed
1311    */
1312   static function alterSettingsFolders(&$settingsFolders) {
1313     return self::singleton()->invoke(1, $settingsFolders,
1314         self::$_nullObject, self::$_nullObject,
1315         self::$_nullObject, self::$_nullObject, self::$_nullObject,
1316         'civicrm_alterSettingsFolders'
1317     );
1318   }
1319
1320   /**
1321    * This hook is called when Settings have been loaded from the xml
1322    * It is an opportunity for hooks to alter the data
1323    *
1324    * @param array $settingsMetaData - Settings Metadata
1325    * @param int $domainID
1326    * @param mixed $profile
1327    *
1328    * @return mixed
1329    */
1330   static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1331     return self::singleton()->invoke(3, $settingsMetaData,
1332         $domainID, $profile,
1333         self::$_nullObject, self::$_nullObject, self::$_nullObject,
1334         'civicrm_alterSettingsMetaData'
1335     );
1336   }
1337
1338   /**
1339    * This hook is called before running an api call.
1340    *
1341    * @param API_Wrapper[] $wrappers
1342    *   (see CRM_Utils_API_ReloadOption as an example)
1343    * @param mixed $apiRequest
1344    *
1345    * @return null
1346    *   The return value is ignored
1347    */
1348   static function apiWrappers(&$wrappers, $apiRequest) {
1349     return self::singleton()
1350       ->invoke(2, $wrappers, $apiRequest, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1351       self::$_nullObject, 'civicrm_apiWrappers'
1352     );
1353   }
1354
1355   /**
1356    * This hook is called before running pending cron jobs.
1357    *
1358    * @param CRM_Core_JobManager $jobManager
1359    *
1360    * @return null
1361    *   The return value is ignored.
1362    */
1363   static function cron($jobManager) {
1364     return self::singleton()->invoke(1,
1365       $jobManager, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1366       'civicrm_cron'
1367     );
1368   }
1369
1370   /**
1371    * This hook is called when loading CMS permissions; use this hook to modify
1372    * the array of system permissions for CiviCRM.
1373    *
1374    * @param array $permissions
1375    *   Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1376    *   the format of this array.
1377    *
1378    * @return null
1379    *   The return value is ignored
1380    */
1381   static function permission(&$permissions) {
1382     return self::singleton()->invoke(1, $permissions,
1383       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1384       'civicrm_permission'
1385     );
1386   }
1387
1388
1389   /**
1390    * This hook is called for declaring managed entities via API
1391    *
1392    * @param array[] $entityTypes
1393    *   List of entity types; each entity-type is an array with keys:
1394    *   - name: string, a unique short name (e.g. "ReportInstance")
1395    *   - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1396    *   - table: string, a SQL table name (e.g. "civicrm_report_instance")
1397    *
1398    * @return null
1399    *   The return value is ignored
1400    */
1401   static function entityTypes(&$entityTypes) {
1402     return self::singleton()->invoke(1, $entityTypes, self::$_nullObject, self::$_nullObject,
1403       self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_entityTypes'
1404     );
1405   }
1406
1407   /**
1408    * This hook is called while preparing a profile form
1409    *
1410    * @param string $name
1411    * @return mixed
1412    */
1413   static function buildProfile($name) {
1414     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1415       self::$_nullObject, self::$_nullObject, 'civicrm_buildProfile');
1416   }
1417
1418   /**
1419    * This hook is called while validating a profile form submission
1420    *
1421    * @param string $name
1422    * @return mixed
1423    */
1424   static function validateProfile($name) {
1425     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1426       self::$_nullObject, self::$_nullObject, 'civicrm_validateProfile');
1427   }
1428
1429   /**
1430    * This hook is called processing a valid profile form submission
1431    *
1432    * @param string $name
1433    * @return mixed
1434    */
1435   static function processProfile($name) {
1436     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1437       self::$_nullObject, self::$_nullObject, 'civicrm_processProfile');
1438   }
1439
1440   /**
1441    * This hook is called while preparing a read-only profile screen
1442    *
1443    * @param string $name
1444    * @return mixed
1445    */
1446   static function viewProfile($name) {
1447     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1448       self::$_nullObject, self::$_nullObject, 'civicrm_viewProfile');
1449   }
1450
1451   /**
1452    * This hook is called while preparing a list of contacts (based on a profile)
1453    *
1454    * @param string $name
1455    * @return mixed
1456    */
1457   static function searchProfile($name) {
1458     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1459       self::$_nullObject, self::$_nullObject, 'civicrm_searchProfile');
1460   }
1461
1462   /**
1463    * This hook is called before encoding data in barcode
1464    *
1465    * @param array  $data associated array of values available for encoding
1466    * @param string $type type of barcode, classic barcode or QRcode
1467    * @param string $context where this hooks is invoked.
1468    *
1469    * @return mixed
1470    */
1471   static function alterBarcode( &$data, $type = 'barcode', $context = 'name_badge' ) {
1472     return self::singleton()->invoke(3, $data, $type, $context, self::$_nullObject,
1473       self::$_nullObject, self::$_nullObject, 'civicrm_alterBarcode');
1474   }
1475
1476   /**
1477    * Modify or replace the Mailer object used for outgoing mail.
1478    *
1479    * @param object $mailer
1480    *   The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
1481    * @param string $driver
1482    *   The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
1483    * @param array $params
1484    *   The default mailer config options
1485    *
1486    * @return mixed
1487    * @see Mail::factory
1488    */
1489   static function alterMail(&$mailer, $driver, $params) {
1490     return self::singleton()
1491       ->invoke(3, $mailer, $driver, $params, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_alterMailer');
1492   }
1493
1494   /**
1495    * This hook is called while building the core search query,
1496    * so hook implementers can provide their own query objects which alters/extends core search.
1497    *
1498    * @param array $queryObjects
1499    * @param string $type
1500    *
1501    * @return mixed
1502    */
1503   static function queryObjects(&$queryObjects, $type = 'Contact') {
1504     return self::singleton()->invoke(2, $queryObjects, $type, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_queryObjects');
1505   }
1506
1507   /**
1508    * This hook is called while viewing contact dashboard
1509    *
1510    * @param array $availableDashlets
1511    *   List of dashlets; each is formatted per api/v3/Dashboard
1512    * @param array $defaultDashlets
1513    *   List of dashlets; each is formatted per api/v3/DashboardContact
1514    *
1515    * @return mixed
1516    */
1517   static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
1518     return self::singleton()->invoke(2, $availableDashlets, $defaultDashlets, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_dashboard_defaults');
1519   }
1520 }