CRM/Utils/Hook.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33 abstract class CRM_Utils_Hook {
  34
  35   // Allowed values for dashboard hook content placement
  36   // Default - place content below activity list
  37   const DASHBOARD_BELOW = 1;
  38   // Place content above activity list
  39   const DASHBOARD_ABOVE = 2;
  40   // Don't display activity list at all
  41   const DASHBOARD_REPLACE = 3;
  42
  43   // by default - place content below existing content
  44   const SUMMARY_BELOW = 1;
  45   // place hook content above
  46   const SUMMARY_ABOVE = 2;
  47   // create your own summaries
  48   const SUMMARY_REPLACE = 3;
  49
  50   static $_nullObject = NULL;
  51
  52   /**
  53    * We only need one instance of this object. So we use the singleton
  54    * pattern and cache the instance in this variable
  55    *
  56    * @var object
  57    */
  58   static private $_singleton = NULL;
  59
  60   /**
  61    * @var bool
  62    */
  63   private $commonIncluded = FALSE;
  64
  65   /**
  66    * @var array(string)
  67    */
  68   private $commonCiviModules = array();
  69
  70   /**
  71    * @var CRM_Utils_Cache_Interface
  72    */
  73   protected $cache;
  74
  75   /**
  76    * Constructor and getter for the singleton instance.
  77    *
  78    * @param bool $fresh
  79    *
  80    * @return self
  81    *   An instance of $config->userHookClass
  82    */
  83   public static function singleton($fresh = FALSE) {
  84     if (self::$_singleton == NULL || $fresh) {
  85       $config = CRM_Core_Config::singleton();
  86       $class = $config->userHookClass;
  87       self::$_singleton = new $class();
  88     }
  89     return self::$_singleton;
  90   }
  91
  92   public function __construct() {
  93     $this->cache = CRM_Utils_Cache::create(array(
  94       'name' => 'hooks',
  95       'type' => array('ArrayCache'),
  96       'prefetch' => 1,
  97     ));
  98   }
  99
 100   /**
 101    * Invoke hooks.
 102    *
 103    * @param int $numParams
 104    *   Number of parameters to pass to the hook.
 105    * @param mixed $arg1
 106    *   Parameter to be passed to the hook.
 107    * @param mixed $arg2
 108    *   Parameter to be passed to the hook.
 109    * @param mixed $arg3
 110    *   Parameter to be passed to the hook.
 111    * @param mixed $arg4
 112    *   Parameter to be passed to the hook.
 113    * @param mixed $arg5
 114    *   Parameter to be passed to the hook.
 115    * @param mixed $arg6
 116    *   Parameter to be passed to the hook.
 117    * @param string $fnSuffix
 118    *   Function suffix, this is effectively the hook name.
 119    *
 120    * @return mixed
 121    */
 122   public abstract function invoke(
 123     $numParams,
 124     &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
 125     $fnSuffix
 126   );
 127
 128   /**
 129    * @param array $numParams
 130    * @param $arg1
 131    * @param $arg2
 132    * @param $arg3
 133    * @param $arg4
 134    * @param $arg5
 135    * @param $arg6
 136    * @param $fnSuffix
 137    * @param $fnPrefix
 138    *
 139    * @return array|bool
 140    */
 141   public function commonInvoke(
 142     $numParams,
 143     &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
 144     $fnSuffix, $fnPrefix
 145   ) {
 146
 147     $this->commonBuildModuleList($fnPrefix);
 148
 149     return $this->runHooks($this->commonCiviModules, $fnSuffix,
 150       $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
 151     );
 152   }
 153
 154   /**
 155    * Build the list of modules to be processed for hooks.
 156    *
 157    * @param string $fnPrefix
 158    */
 159   public function commonBuildModuleList($fnPrefix) {
 160     if (!$this->commonIncluded) {
 161       // include external file
 162       $this->commonIncluded = TRUE;
 163
 164       $config = CRM_Core_Config::singleton();
 165       if (!empty($config->customPHPPathDir) &&
 166         file_exists("{$config->customPHPPathDir}/civicrmHooks.php")
 167       ) {
 168         @include_once "civicrmHooks.php";
 169       }
 170
 171       if (!empty($fnPrefix)) {
 172         $this->commonCiviModules[$fnPrefix] = $fnPrefix;
 173       }
 174
 175       $this->requireCiviModules($this->commonCiviModules);
 176     }
 177   }
 178
 179   /**
 180    * @param $civiModules
 181    * @param $fnSuffix
 182    * @param array $numParams
 183    * @param $arg1
 184    * @param $arg2
 185    * @param $arg3
 186    * @param $arg4
 187    * @param $arg5
 188    * @param $arg6
 189    *
 190    * @return array|bool
 191    */
 192   public function runHooks(
 193     $civiModules, $fnSuffix, $numParams,
 194     &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
 195   ) {
 196     // $civiModules is *not* passed by reference because runHooks
 197     // must be reentrant. PHP is finicky about running
 198     // multiple loops over the same variable. The circumstances
 199     // to reproduce the issue are pretty intricate.
 200     $result = array();
 201
 202     $fnNames = $this->cache->get($fnSuffix);
 203     if (!is_array($fnNames)) {
 204       $fnNames = array();
 205       if ($civiModules !== NULL) {
 206         foreach ($civiModules as $module) {
 207           $fnName = "{$module}_{$fnSuffix}";
 208           if (function_exists($fnName)) {
 209             $fnNames[] = $fnName;
 210           }
 211         }
 212         $this->cache->set($fnSuffix, $fnNames);
 213       }
 214     }
 215
 216     foreach ($fnNames as $fnName) {
 217       $fResult = array();
 218       switch ($numParams) {
 219         case 0:
 220           $fResult = $fnName();
 221           break;
 222
 223         case 1:
 224           $fResult = $fnName($arg1);
 225           break;
 226
 227         case 2:
 228           $fResult = $fnName($arg1, $arg2);
 229           break;
 230
 231         case 3:
 232           $fResult = $fnName($arg1, $arg2, $arg3);
 233           break;
 234
 235         case 4:
 236           $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
 237           break;
 238
 239         case 5:
 240           $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
 241           break;
 242
 243         case 6:
 244           $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
 245           break;
 246
 247         default:
 248           CRM_Core_Error::fatal(ts('Invalid hook invocation'));
 249           break;
 250       }
 251
 252       if (!empty($fResult) &&
 253         is_array($fResult)
 254       ) {
 255         $result = array_merge($result, $fResult);
 256       }
 257     }
 258
 259     return empty($result) ? TRUE : $result;
 260   }
 261
 262   /**
 263    * @param $moduleList
 264    */
 265   public function requireCiviModules(&$moduleList) {
 266     $civiModules = CRM_Core_PseudoConstant::getModuleExtensions();
 267     foreach ($civiModules as $civiModule) {
 268       if (!file_exists($civiModule['filePath'])) {
 269         CRM_Core_Session::setStatus(
 270           ts('Error loading module file (%1). Please restore the file or disable the module.',
 271             array(1 => $civiModule['filePath'])),
 272           ts('Warning'), 'error');
 273         continue;
 274       }
 275       include_once $civiModule['filePath'];
 276       $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
 277     }
 278   }
 279
 280   /**
 281    * This hook is called before a db write on some core objects.
 282    * This hook does not allow the abort of the operation
 283    *
 284    * @param string $op
 285    *   The type of operation being performed.
 286    * @param string $objectName
 287    *   The name of the object.
 288    * @param int $id
 289    *   The object id if available.
 290    * @param array $params
 291    *   The parameters used for object creation / editing.
 292    *
 293    * @return null
 294    *   the return value is ignored
 295    */
 296   public static function pre($op, $objectName, $id, &$params) {
 297     $event = new \Civi\Core\Event\PreEvent($op, $objectName, $id, $params);
 298     \Civi::service('dispatcher')->dispatch("hook_civicrm_pre", $event);
 299     \Civi::service('dispatcher')->dispatch("hook_civicrm_pre::$objectName", $event);
 300     return self::singleton()
 301       ->invoke(4, $op, $objectName, $id, $params, self::$_nullObject, self::$_nullObject, 'civicrm_pre');
 302   }
 303
 304   /**
 305    * This hook is called after a db write on some core objects.
 306    *
 307    * @param string $op
 308    *   The type of operation being performed.
 309    * @param string $objectName
 310    *   The name of the object.
 311    * @param int $objectId
 312    *   The unique identifier for the object.
 313    * @param object $objectRef
 314    *   The reference to the object if available.
 315    *
 316    * @return mixed
 317    *   based on op. pre-hooks return a boolean or
 318    *                           an error message which aborts the operation
 319    */
 320   public static function post($op, $objectName, $objectId, &$objectRef) {
 321     $event = new \Civi\Core\Event\PostEvent($op, $objectName, $objectId, $objectRef);
 322     \Civi::service('dispatcher')->dispatch("hook_civicrm_post", $event);
 323     \Civi::service('dispatcher')->dispatch("hook_civicrm_post::$objectName", $event);
 324     return self::singleton()
 325       ->invoke(4, $op, $objectName, $objectId, $objectRef, self::$_nullObject, self::$_nullObject, 'civicrm_post');
 326   }
 327
 328   /**
 329    * This hook retrieves links from other modules and injects it into.
 330    * the view contact tabs
 331    *
 332    * @param string $op
 333    *   The type of operation being performed.
 334    * @param string $objectName
 335    *   The name of the object.
 336    * @param int $objectId
 337    *   The unique identifier for the object.
 338    * @param array $links
 339    *   (optional) the links array (introduced in v3.2).
 340    * @param int $mask
 341    *   (optional) the bitmask to show/hide links.
 342    * @param array $values
 343    *   (optional) the values to fill the links.
 344    *
 345    * @return null
 346    *   the return value is ignored
 347    */
 348   public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = array()) {
 349     return self::singleton()->invoke(6, $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
 350   }
 351
 352   /**
 353    * This hook is invoked during the CiviCRM form preProcess phase.
 354    *
 355    * @param string $formName
 356    *   The name of the form.
 357    * @param CRM_Core_Form $form
 358    *   Reference to the form object.
 359    *
 360    * @return null
 361    *   the return value is ignored
 362    */
 363   public static function preProcess($formName, &$form) {
 364     return self::singleton()
 365       ->invoke(2, $formName, $form, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_preProcess');
 366   }
 367
 368   /**
 369    * This hook is invoked when building a CiviCRM form. This hook should also
 370    * be used to set the default values of a form element
 371    *
 372    * @param string $formName
 373    *   The name of the form.
 374    * @param CRM_Core_Form $form
 375    *   Reference to the form object.
 376    *
 377    * @return null
 378    *   the return value is ignored
 379    */
 380   public static function buildForm($formName, &$form) {
 381     return self::singleton()->invoke(2, $formName, $form,
 382       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 383       'civicrm_buildForm'
 384     );
 385   }
 386
 387   /**
 388    * This hook is invoked when a CiviCRM form is submitted. If the module has injected
 389    * any form elements, this hook should save the values in the database
 390    *
 391    * @param string $formName
 392    *   The name of the form.
 393    * @param CRM_Core_Form $form
 394    *   Reference to the form object.
 395    *
 396    * @return null
 397    *   the return value is ignored
 398    */
 399   public static function postProcess($formName, &$form) {
 400     return self::singleton()->invoke(2, $formName, $form,
 401       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 402       'civicrm_postProcess'
 403     );
 404   }
 405
 406   /**
 407    * This hook is invoked during all CiviCRM form validation. An array of errors
 408    * detected is returned. Else we assume validation succeeded.
 409    *
 410    * @param string $formName
 411    *   The name of the form.
 412    * @param array &$fields the POST parameters as filtered by QF
 413    * @param array &$files the FILES parameters as sent in by POST
 414    * @param array &$form the form object
 415    * @param array &$errors the array of errors.
 416    *
 417    * @return mixed
 418    *   formRule hooks return a boolean or
 419    *                           an array of error messages which display a QF Error
 420    */
 421   public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
 422     return self::singleton()
 423       ->invoke(5, $formName, $fields, $files, $form, $errors, self::$_nullObject, 'civicrm_validateForm');
 424   }
 425
 426   /**
 427    * This hook is called after a db write on a custom table.
 428    *
 429    * @param string $op
 430    *   The type of operation being performed.
 431    * @param string $groupID
 432    *   The custom group ID.
 433    * @param object $entityID
 434    *   The entityID of the row in the custom table.
 435    * @param array $params
 436    *   The parameters that were sent into the calling function.
 437    *
 438    * @return null
 439    *   the return value is ignored
 440    */
 441   public static function custom($op, $groupID, $entityID, &$params) {
 442     return self::singleton()
 443       ->invoke(4, $op, $groupID, $entityID, $params, self::$_nullObject, self::$_nullObject, 'civicrm_custom');
 444   }
 445
 446   /**
 447    * This hook is called when composing the ACL where clause to restrict
 448    * visibility of contacts to the logged in user
 449    *
 450    * @param int $type
 451    *   The type of permission needed.
 452    * @param array $tables
 453    *   (reference ) add the tables that are needed for the select clause.
 454    * @param array $whereTables
 455    *   (reference ) add the tables that are needed for the where clause.
 456    * @param int $contactID
 457    *   The contactID for whom the check is made.
 458    * @param string $where
 459    *   The currrent where clause.
 460    *
 461    * @return null
 462    *   the return value is ignored
 463    */
 464   public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
 465     return self::singleton()
 466       ->invoke(5, $type, $tables, $whereTables, $contactID, $where, self::$_nullObject, 'civicrm_aclWhereClause');
 467   }
 468
 469   /**
 470    * This hook is called when composing the ACL where clause to restrict
 471    * visibility of contacts to the logged in user
 472    *
 473    * @param int $type
 474    *   The type of permission needed.
 475    * @param int $contactID
 476    *   The contactID for whom the check is made.
 477    * @param string $tableName
 478    *   The tableName which is being permissioned.
 479    * @param array $allGroups
 480    *   The set of all the objects for the above table.
 481    * @param array $currentGroups
 482    *   The set of objects that are currently permissioned for this contact.
 483    *
 484    * @return null
 485    *   the return value is ignored
 486    */
 487   public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
 488     return self::singleton()
 489       ->invoke(5, $type, $contactID, $tableName, $allGroups, $currentGroups, self::$_nullObject, 'civicrm_aclGroup');
 490   }
 491
 492   /**
 493    * This hook is called when building the menu table.
 494    *
 495    * @param array $files
 496    *   The current set of files to process.
 497    *
 498    * @return null
 499    *   the return value is ignored
 500    */
 501   public static function xmlMenu(&$files) {
 502     return self::singleton()->invoke(1, $files,
 503       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 504       'civicrm_xmlMenu'
 505     );
 506   }
 507
 508   /**
 509    * This hook is called for declaring managed entities via API.
 510    *
 511    * @param array $entities
 512    *   List of pending entities. Each entity is an array with keys:
 513    *   + 'module': string; for module-extensions, this is the fully-qualifed name (e.g. "com.example.mymodule"); for CMS modules, the name is prefixed by the CMS (e.g. "drupal.mymodule")
 514    *   + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
 515    *   + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
 516    *   + 'params': array, the entity data as supported by the CiviCRM API
 517    *   + 'update' (v4.5+): string, a policy which describes when to update records
 518    *     - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
 519    *     - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
 520    *   + 'cleanup' (v4.5+): string, a policy which describes whether to cleanup the record when it becomes orphaned (ie when $entities no longer references the record)
 521    *     - 'always' (default): always delete orphaned records
 522    *     - 'never': never delete orphaned records
 523    *     - 'unused': only delete orphaned records if there are no other references to it in the DB. (This is determined by calling the API's "getrefcount" action.)
 524    *
 525    * @return null
 526    *   the return value is ignored
 527    */
 528   public static function managed(&$entities) {
 529     return self::singleton()->invoke(1, $entities,
 530       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 531       'civicrm_managed'
 532     );
 533   }
 534
 535   /**
 536    * This hook is called when rendering the dashboard (q=civicrm/dashboard)
 537    *
 538    * @param int $contactID
 539    *   The contactID for whom the dashboard is being rendered.
 540    * @param int $contentPlacement
 541    *   (output parameter) where should the hook content be displayed.
 542    * relative to the activity list
 543    *
 544    * @return string
 545    *   the html snippet to include in the dashboard
 546    */
 547   public static function dashboard($contactID, &$contentPlacement = self::DASHBOARD_BELOW) {
 548     $retval = self::singleton()->invoke(2, $contactID, $contentPlacement,
 549       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 550       'civicrm_dashboard'
 551     );
 552
 553     /*
 554      * Note we need this seemingly unnecessary code because in the event that the implementation
 555      * of the hook declares the second parameter but doesn't set it, then it comes back unset even
 556      * though we have a default value in this function's declaration above.
 557      */
 558     if (!isset($contentPlacement)) {
 559       $contentPlacement = self::DASHBOARD_BELOW;
 560     }
 561
 562     return $retval;
 563   }
 564
 565   /**
 566    * This hook is called before storing recently viewed items.
 567    *
 568    * @param array $recentArray
 569    *   An array of recently viewed or processed items, for in place modification.
 570    *
 571    * @return array
 572    */
 573   public static function recent(&$recentArray) {
 574     return self::singleton()->invoke(1, $recentArray,
 575       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 576       'civicrm_recent'
 577     );
 578   }
 579
 580   /**
 581    * Determine how many other records refer to a given record.
 582    *
 583    * @param CRM_Core_DAO $dao
 584    *   The item for which we want a reference count.
 585    * @param array $refCounts
 586    *   Each item in the array is an Array with keys:
 587    *   - name: string, eg "sql:civicrm_email:contact_id"
 588    *   - type: string, eg "sql"
 589    *   - count: int, eg "5" if there are 5 email addresses that refer to $dao
 590    *
 591    * @return mixed
 592    *   Return is not really intended to be used.
 593    */
 594   public static function referenceCounts($dao, &$refCounts) {
 595     return self::singleton()->invoke(2, $dao, $refCounts,
 596       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 597       'civicrm_referenceCounts'
 598     );
 599   }
 600
 601   /**
 602    * This hook is called when building the amount structure for a Contribution or Event Page.
 603    *
 604    * @param int $pageType
 605    *   Is this a contribution or event page.
 606    * @param CRM_Core_Form $form
 607    *   Reference to the form object.
 608    * @param array $amount
 609    *   The amount structure to be displayed.
 610    *
 611    * @return null
 612    */
 613   public static function buildAmount($pageType, &$form, &$amount) {
 614     return self::singleton()->invoke(3, $pageType, $form, $amount, self::$_nullObject,
 615       self::$_nullObject, self::$_nullObject, 'civicrm_buildAmount');
 616   }
 617
 618   /**
 619    * This hook is called when building the state list for a particular country.
 620    *
 621    * @param array $countryID
 622    *   The country id whose states are being selected.
 623    * @param $states
 624    *
 625    * @return null
 626    */
 627   public static function buildStateProvinceForCountry($countryID, &$states) {
 628     return self::singleton()->invoke(2, $countryID, $states,
 629       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 630       'civicrm_buildStateProvinceForCountry'
 631     );
 632   }
 633
 634   /**
 635    * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
 636    *
 637    * @param array $tabs
 638    *   The array of tabs that will be displayed.
 639    * @param int $contactID
 640    *   The contactID for whom the dashboard is being rendered.
 641    *
 642    * @return null
 643    * @deprecated Use tabset() instead.
 644    */
 645   public static function tabs(&$tabs, $contactID) {
 646     return self::singleton()->invoke(2, $tabs, $contactID,
 647       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tabs'
 648     );
 649   }
 650
 651   /**
 652    * This hook is called when rendering the tabs used for events and potentially
 653    * contribution pages, etc.
 654    *
 655    * @param string $tabsetName
 656    *   Name of the screen or visual element.
 657    * @param array $tabs
 658    *   Tabs that will be displayed.
 659    * @param array $context
 660    *   Extra data about the screen or context in which the tab is used.
 661    *
 662    * @return null
 663    */
 664   public static function tabset($tabsetName, &$tabs, $context) {
 665     return self::singleton()->invoke(3, $tabsetName, $tabs,
 666       $context, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tabset'
 667     );
 668   }
 669
 670   /**
 671    * This hook is called when sending an email / printing labels
 672    *
 673    * @param array $tokens
 674    *   The list of tokens that can be used for the contact.
 675    *
 676    * @return null
 677    */
 678   public static function tokens(&$tokens) {
 679     return self::singleton()->invoke(1, $tokens,
 680       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tokens'
 681     );
 682   }
 683
 684   /**
 685    * This hook is called when sending an email / printing labels to get the values for all the
 686    * tokens returned by the 'tokens' hook
 687    *
 688    * @param array $details
 689    *   The array to store the token values indexed by contactIDs (unless it a single).
 690    * @param array $contactIDs
 691    *   An array of contactIDs.
 692    * @param int $jobID
 693    *   The jobID if this is associated with a CiviMail mailing.
 694    * @param array $tokens
 695    *   The list of tokens associated with the content.
 696    * @param string $className
 697    *   The top level className from where the hook is invoked.
 698    *
 699    * @return null
 700    */
 701   public static function tokenValues(
 702     &$details,
 703     $contactIDs,
 704     $jobID = NULL,
 705     $tokens = array(),
 706     $className = NULL
 707   ) {
 708     return self::singleton()
 709       ->invoke(5, $details, $contactIDs, $jobID, $tokens, $className, self::$_nullObject, 'civicrm_tokenValues');
 710   }
 711
 712   /**
 713    * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
 714    * in a  template
 715    *
 716    * @param object $page
 717    *   The page that will be rendered.
 718    *
 719    * @return null
 720    */
 721   public static function pageRun(&$page) {
 722     return self::singleton()->invoke(1, $page,
 723       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 724       'civicrm_pageRun'
 725     );
 726   }
 727
 728   /**
 729    * This hook is called after a copy of an object has been made. The current objects are
 730    * Event, Contribution Page and UFGroup
 731    *
 732    * @param string $objectName
 733    *   Name of the object.
 734    * @param object $object
 735    *   Reference to the copy.
 736    *
 737    * @return null
 738    */
 739   public static function copy($objectName, &$object) {
 740     return self::singleton()->invoke(2, $objectName, $object,
 741       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 742       'civicrm_copy'
 743     );
 744   }
 745
 746   /**
 747    * This hook is called when a contact unsubscribes from a mailing.  It allows modules
 748    * to override what the contacts are removed from.
 749    *
 750    * @param string $op
 751    *   Ignored for now
 752    * @param int $mailingId
 753    *   The id of the mailing to unsub from
 754    * @param int $contactId
 755    *   The id of the contact who is unsubscribing
 756    * @param array|int $groups
 757    *   Groups the contact will be removed from.
 758    * @param array|int $baseGroups
 759    *   Base groups (used in smart mailings) the contact will be removed from.
 760    *
 761    *
 762    * @return mixed
 763    */
 764   public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
 765     return self::singleton()
 766       ->invoke(5, $op, $mailingId, $contactId, $groups, $baseGroups, self::$_nullObject, 'civicrm_unsubscribeGroups');
 767   }
 768
 769   /**
 770    * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox,
 771    * adv multiselect)
 772    *
 773    * @param int $customFieldID
 774    *   The custom field ID.
 775    * @param array $options
 776    *   The current set of options for that custom field.
 777    *   You can add/remove existing options.
 778    *   Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
 779    *              to be careful to not overwrite the array.
 780    *   Only add/edit/remove the specific field options you intend to affect.
 781    * @param bool $detailedFormat
 782    *   If true,.
 783    *                the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
 784    * @param array $selectAttributes
 785    *   Contain select attribute(s) if any.
 786    *
 787    * @return mixed
 788    */
 789   public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = array()) {
 790     return self::singleton()->invoke(3, $customFieldID, $options, $detailedFormat,
 791       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 792       'civicrm_customFieldOptions'
 793     );
 794   }
 795
 796   /**
 797    * Hook for modifying field options
 798    *
 799    * @param string $entity
 800    * @param string $field
 801    * @param array $options
 802    * @param array $params
 803    *
 804    * @return mixed
 805    */
 806   public static function fieldOptions($entity, $field, &$options, $params) {
 807     return self::singleton()->invoke(5, $entity, $field, $options, $params,
 808       self::$_nullObject, self::$_nullObject,
 809       'civicrm_fieldOptions'
 810     );
 811   }
 812
 813   /**
 814    *
 815    * This hook is called to display the list of actions allowed after doing a search.
 816    * This allows the module developer to inject additional actions or to remove existing actions.
 817    *
 818    * @param string $objectType
 819    *   The object type for this search.
 820    *   - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
 821    * @param array $tasks
 822    *   The current set of tasks for that custom field.
 823    *   You can add/remove existing tasks.
 824    *   Each task needs to have a title (eg 'title'  => ts( 'Group - add contacts')) and a class
 825    *   (eg 'class'  => 'CRM_Contact_Form_Task_AddToGroup').
 826    *   Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
 827    *   The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
 828    *   found in CRM/$objectType/Task.php.
 829    *
 830    * @return mixed
 831    */
 832   public static function searchTasks($objectType, &$tasks) {
 833     return self::singleton()->invoke(2, $objectType, $tasks,
 834       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 835       'civicrm_searchTasks'
 836     );
 837   }
 838
 839   /**
 840    * @param mixed $form
 841    * @param array $params
 842    *
 843    * @return mixed
 844    */
 845   public static function eventDiscount(&$form, &$params) {
 846     return self::singleton()->invoke(2, $form, $params,
 847       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 848       'civicrm_eventDiscount'
 849     );
 850   }
 851
 852   /**
 853    * This hook is called when composing a mailing. You can include / exclude other groups as needed.
 854    *
 855    * @param mixed $form
 856    *   The form object for which groups / mailings being displayed
 857    * @param array $groups
 858    *   The list of groups being included / excluded
 859    * @param array $mailings
 860    *   The list of mailings being included / excluded
 861    *
 862    * @return mixed
 863    */
 864   public static function mailingGroups(&$form, &$groups, &$mailings) {
 865     return self::singleton()->invoke(3, $form, $groups, $mailings,
 866       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 867       'civicrm_mailingGroups'
 868     );
 869   }
 870
 871   /**
 872    * This hook is called when composing the array of membershipTypes and their cost during a membership registration
 873    * (new or renewal).
 874    * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
 875    * You can use it to alter the membership types when first loaded, or after submission
 876    * (for example if you want to gather data in the form and use it to alter the fees).
 877    *
 878    * @param mixed $form
 879    *   The form object that is presenting the page
 880    * @param array $membershipTypes
 881    *   The array of membership types and their amount
 882    *
 883    * @return mixed
 884    */
 885   public static function membershipTypeValues(&$form, &$membershipTypes) {
 886     return self::singleton()->invoke(2, $form, $membershipTypes,
 887       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 888       'civicrm_membershipTypeValues'
 889     );
 890   }
 891
 892   /**
 893    * This hook is called when rendering the contact summary.
 894    *
 895    * @param int $contactID
 896    *   The contactID for whom the summary is being rendered
 897    * @param mixed $content
 898    * @param int $contentPlacement
 899    *   Specifies where the hook content should be displayed relative to the
 900    *   existing content
 901    *
 902    * @return string
 903    *   The html snippet to include in the contact summary
 904    */
 905   public static function summary($contactID, &$content, &$contentPlacement = self::SUMMARY_BELOW) {
 906     return self::singleton()->invoke(3, $contactID, $content, $contentPlacement,
 907       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 908       'civicrm_summary'
 909     );
 910   }
 911
 912   /**
 913    * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
 914    * By default, Contact Reference fields will search on and return all CiviCRM contacts.
 915    * If you want to limit the contacts returned to a specific group, or some other criteria
 916    * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
 917    * The hook is called when the query is executed to get the list of contacts to display.
 918    *
 919    * @param mixed $query
 920    *   - the query that will be executed (input and output parameter);.
 921    *   It's important to realize that the ACL clause is built prior to this hook being fired,
 922    *   so your query will ignore any ACL rules that may be defined.
 923    *   Your query must return two columns:
 924    *     the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
 925    *     the contact IDs
 926    * @param string $name
 927    *   The name string to execute the query against (this is the value being typed in by the user).
 928    * @param string $context
 929    *   The context in which this ajax call is being made (for example: 'customfield', 'caseview').
 930    * @param int $id
 931    *   The id of the object for which the call is being made.
 932    *   For custom fields, it will be the custom field id
 933    *
 934    * @return mixed
 935    */
 936   public static function contactListQuery(&$query, $name, $context, $id) {
 937     return self::singleton()->invoke(4, $query, $name, $context, $id,
 938       self::$_nullObject, self::$_nullObject,
 939       'civicrm_contactListQuery'
 940     );
 941   }
 942
 943   /**
 944    * Hook definition for altering payment parameters before talking to a payment processor back end.
 945    *
 946    * Definition will look like this:
 947    *
 948    *   function hook_civicrm_alterPaymentProcessorParams(
 949    *     $paymentObj,
 950    *     &$rawParams,
 951    *     &$cookedParams
 952    *   );
 953    *
 954    * @param CRM_Core_Payment $paymentObj
 955    *   Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
 956    *   See discussion in CRM-16224 as to whether $paymentObj should be passed by reference.
 957    * @param array &$rawParams
 958    *    array of params as passed to to the processor
 959    * @param array &$cookedParams
 960    *     params after the processor code has translated them into its own key/value pairs
 961    *
 962    * @return mixed
 963    *   This return is not really intended to be used.
 964    */
 965   public static function alterPaymentProcessorParams(
 966     $paymentObj,
 967     &$rawParams,
 968     &$cookedParams
 969   ) {
 970     return self::singleton()->invoke(3, $paymentObj, $rawParams, $cookedParams,
 971       self::$_nullObject, self::$_nullObject, self::$_nullObject,
 972       'civicrm_alterPaymentProcessorParams'
 973     );
 974   }
 975
 976   /**
 977    * This hook is called when an email is about to be sent by CiviCRM.
 978    *
 979    * @param array $params
 980    *   Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
 981    *   returnPath, replyTo, headers, attachments (array)
 982    * @param string $context
 983    *   The context in which the hook is being invoked, eg 'civimail'.
 984    *
 985    * @return mixed
 986    */
 987   public static function alterMailParams(&$params, $context = NULL) {
 988     return self::singleton()->invoke(2, $params, $context,
 989       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
 990       'civicrm_alterMailParams'
 991     );
 992   }
 993
 994   /**
 995    * This hook is called when membership status is being calculated.
 996    *
 997    * @param array $membershipStatus
 998    *   Membership status details as determined - alter if required.
 999    * @param array $arguments
1000    *   Arguments passed in to calculate date.
1001    * - 'start_date'
1002    * - 'end_date'
1003    * - 'status_date'
1004    * - 'join_date'
1005    * - 'exclude_is_admin'
1006    * - 'membership_type_id'
1007    * @param array $membership
1008    *   Membership details from the calling function.
1009    *
1010    * @return mixed
1011    */
1012   public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
1013     return self::singleton()->invoke(3, $membershipStatus, $arguments,
1014       $membership, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1015       'civicrm_alterCalculatedMembershipStatus'
1016     );
1017   }
1018
1019   /**
1020    * This hook is called after getting the content of the mail and before tokenizing it.
1021    *
1022    * @param array $content
1023    *   Array fields include: html, text, subject
1024    *
1025    * @return mixed
1026    */
1027   public static function alterMailContent(&$content) {
1028     return self::singleton()->invoke(1, $content,
1029       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1030       'civicrm_alterMailContent'
1031     );
1032   }
1033
1034   /**
1035    * This hook is called when rendering the Manage Case screen.
1036    *
1037    * @param int $caseID
1038    *   The case ID.
1039    *
1040    * @return array
1041    *   Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
1042    *   and the value is an array with keys 'label' and 'value' specifying label/value pairs
1043    */
1044   public static function caseSummary($caseID) {
1045     return self::singleton()->invoke(1, $caseID,
1046       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1047       'civicrm_caseSummary'
1048     );
1049   }
1050
1051   /**
1052    * This hook is called when locating CiviCase types.
1053    *
1054    * @param array $caseTypes
1055    *
1056    * @return mixed
1057    */
1058   public static function caseTypes(&$caseTypes) {
1059     return self::singleton()
1060       ->invoke(1, $caseTypes, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_caseTypes');
1061   }
1062
1063   /**
1064    * This hook is called soon after the CRM_Core_Config object has ben initialized.
1065    * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
1066    *
1067    * @param CRM_Core_Config|array $config
1068    *   The config object
1069    *
1070    * @return mixed
1071    */
1072   public static function config(&$config) {
1073     return self::singleton()->invoke(1, $config,
1074       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1075       'civicrm_config'
1076     );
1077   }
1078
1079   /**
1080    * This hooks allows to change option values.
1081    *
1082    * @param array $options
1083    *   Associated array of option values / id
1084    * @param string $name
1085    *   Option group name
1086    *
1087    * @return mixed
1088    */
1089   public static function optionValues(&$options, $name) {
1090     return self::singleton()->invoke(2, $options, $name,
1091       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1092       'civicrm_optionValues'
1093     );
1094   }
1095
1096   /**
1097    * This hook allows modification of the navigation menu.
1098    *
1099    * @param array $params
1100    *   Associated array of navigation menu entry to Modify/Add
1101    *
1102    * @return mixed
1103    */
1104   public static function navigationMenu(&$params) {
1105     return self::singleton()->invoke(1, $params,
1106       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1107       'civicrm_navigationMenu'
1108     );
1109   }
1110
1111   /**
1112    * This hook allows modification of the data used to perform merging of duplicates.
1113    *
1114    * @param string $type
1115    *   The type of data being passed (cidRefs|eidRefs|relTables|sqls).
1116    * @param array $data
1117    *   The data, as described in $type.
1118    * @param int $mainId
1119    *   Contact_id of the contact that survives the merge.
1120    * @param int $otherId
1121    *   Contact_id of the contact that will be absorbed and deleted.
1122    * @param array $tables
1123    *   When $type is "sqls", an array of tables as it may have been handed to the calling function.
1124    *
1125    * @return mixed
1126    */
1127   public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
1128     return self::singleton()->invoke(5, $type, $data, $mainId, $otherId, $tables, self::$_nullObject, 'civicrm_merge');
1129   }
1130
1131   /**
1132    * This hook provides a way to override the default privacy behavior for notes.
1133    *
1134    * @param array &$noteValues
1135    *   Associative array of values for this note
1136    *
1137    * @return mixed
1138    */
1139   public static function notePrivacy(&$noteValues) {
1140     return self::singleton()->invoke(1, $noteValues,
1141       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1142       'civicrm_notePrivacy'
1143     );
1144   }
1145
1146   /**
1147    * This hook is called before record is exported as CSV.
1148    *
1149    * @param string $exportTempTable
1150    *   Name of the temporary export table used during export.
1151    * @param array $headerRows
1152    *   Header rows for output.
1153    * @param array $sqlColumns
1154    *   SQL columns.
1155    * @param int $exportMode
1156    *   Export mode ( contact, contribution, etc...).
1157    *
1158    * @return mixed
1159    */
1160   public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode) {
1161     return self::singleton()->invoke(4, $exportTempTable, $headerRows, $sqlColumns, $exportMode,
1162       self::$_nullObject, self::$_nullObject,
1163       'civicrm_export'
1164     );
1165   }
1166
1167   /**
1168    * This hook allows modification of the queries constructed from dupe rules.
1169    *
1170    * @param string $obj
1171    *   Object of rulegroup class.
1172    * @param string $type
1173    *   Type of queries e.g table / threshold.
1174    * @param array $query
1175    *   Set of queries.
1176    *
1177    * @return mixed
1178    */
1179   public static function dupeQuery($obj, $type, &$query) {
1180     return self::singleton()->invoke(3, $obj, $type, $query,
1181       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1182       'civicrm_dupeQuery'
1183     );
1184   }
1185
1186   /**
1187    * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1188    *
1189    * @param string $type
1190    *   Type of mail processed: 'activity' OR 'mailing'.
1191    * @param array &$params the params that were sent to the CiviCRM API function
1192    * @param object $mail
1193    *   The mail object which is an ezcMail class.
1194    * @param array &$result the result returned by the api call
1195    * @param string $action
1196    *   (optional ) the requested action to be performed if the types was 'mailing'.
1197    *
1198    * @return mixed
1199    */
1200   public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1201     return self::singleton()
1202       ->invoke(5, $type, $params, $mail, $result, $action, self::$_nullObject, 'civicrm_emailProcessor');
1203   }
1204
1205   /**
1206    * This hook is called after a row has been processed and the
1207    * record (and associated records imported
1208    *
1209    * @param string $object
1210    *   Object being imported (for now Contact only, later Contribution, Activity,.
1211    *                               Participant and Member)
1212    * @param string $usage
1213    *   Hook usage/location (for now process only, later mapping and others).
1214    * @param string $objectRef
1215    *   Import record object.
1216    * @param array $params
1217    *   Array with various key values: currently.
1218    *                  contactID       - contact id
1219    *                  importID        - row id in temp table
1220    *                  importTempTable - name of tempTable
1221    *                  fieldHeaders    - field headers
1222    *                  fields          - import fields
1223    *
1224    * @return mixed
1225    */
1226   public static function import($object, $usage, &$objectRef, &$params) {
1227     return self::singleton()->invoke(4, $object, $usage, $objectRef, $params,
1228       self::$_nullObject, self::$_nullObject,
1229       'civicrm_import'
1230     );
1231   }
1232
1233   /**
1234    * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1235    * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1236    *
1237    * @param string $entity
1238    *   The API entity (like contact).
1239    * @param string $action
1240    *   The API action (like get).
1241    * @param array &$params the API parameters
1242    * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1243    *
1244    * @return mixed
1245    */
1246   public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1247     return self::singleton()->invoke(4, $entity, $action, $params, $permissions,
1248       self::$_nullObject, self::$_nullObject,
1249       'civicrm_alterAPIPermissions'
1250     );
1251   }
1252
1253   /**
1254    * @param CRM_Core_DAO $dao
1255    *
1256    * @return mixed
1257    */
1258   public static function postSave(&$dao) {
1259     $hookName = 'civicrm_postSave_' . $dao->getTableName();
1260     return self::singleton()->invoke(1, $dao,
1261       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1262       $hookName
1263     );
1264   }
1265
1266   /**
1267    * This hook allows user to customize context menu Actions on contact summary page.
1268    *
1269    * @param array $actions
1270    *   Array of all Actions in contextmenu.
1271    * @param int $contactID
1272    *   ContactID for the summary page.
1273    *
1274    * @return mixed
1275    */
1276   public static function summaryActions(&$actions, $contactID = NULL) {
1277     return self::singleton()->invoke(2, $actions, $contactID,
1278       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1279       'civicrm_summaryActions'
1280     );
1281   }
1282
1283   /**
1284    * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1285    * This enables us hook implementors to modify both the headers and the rows
1286    *
1287    * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1288    * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1289    *
1290    * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1291    * you want displayed. This is a hackish, but avoids template modification.
1292    *
1293    * @param string $objectName
1294    *   The component name that we are doing the search.
1295    *                           activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1296    * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1297    * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1298    * @param array $selector
1299    *   the selector object. Allows you access to the context of the search
1300    *
1301    * @return mixed
1302    *   modify the header and values object to pass the data you need
1303    */
1304   public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1305     return self::singleton()->invoke(4, $objectName, $headers, $rows, $selector,
1306       self::$_nullObject, self::$_nullObject,
1307       'civicrm_searchColumns'
1308     );
1309   }
1310
1311   /**
1312    * This hook is called when uf groups are being built for a module.
1313    *
1314    * @param string $moduleName
1315    *   Module name.
1316    * @param array $ufGroups
1317    *   Array of ufgroups for a module.
1318    *
1319    * @return null
1320    */
1321   public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1322     return self::singleton()->invoke(2, $moduleName, $ufGroups,
1323       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1324       'civicrm_buildUFGroupsForModule'
1325     );
1326   }
1327
1328   /**
1329    * This hook is called when we are determining the contactID for a specific
1330    * email address
1331    *
1332    * @param string $email
1333    *   The email address.
1334    * @param int $contactID
1335    *   The contactID that matches this email address, IF it exists.
1336    * @param array $result
1337    *   (reference) has two fields.
1338    *                          contactID - the new (or same) contactID
1339    *                          action - 3 possible values:
1340    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1341    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1342    *                          CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE   - skip this email address
1343    *
1344    * @return null
1345    */
1346   public static function emailProcessorContact($email, $contactID, &$result) {
1347     return self::singleton()->invoke(3, $email, $contactID, $result,
1348       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1349       'civicrm_emailProcessorContact'
1350     );
1351   }
1352
1353   /**
1354    * Hook definition for altering the generation of Mailing Labels.
1355    *
1356    * @param array $args
1357    *   An array of the args in the order defined for the tcpdf multiCell api call.
1358    *                    with the variable names below converted into string keys (ie $w become 'w'
1359    *                    as the first key for $args)
1360    *   float $w Width of cells. If 0, they extend up to the right margin of the page.
1361    *   float $h Cell minimum height. The cell extends automatically if needed.
1362    *   string $txt String to print
1363    *   mixed $border Indicates if borders must be drawn around the cell block. The value can
1364    *                 be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1365    *                 a string containing some or all of the following characters (in any order):
1366    *                 <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1367    *   string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1368    *                 left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1369    *                 (default value when $ishtml=false)</li></ul>
1370    *   int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1371    *   int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1372    *           to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1373    *   float $x x position in user units
1374    *   float $y y position in user units
1375    *   boolean $reseth if true reset the last cell height (default true).
1376    *   int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1377    *                necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1378    *                necessary</li><li>4 = forced character spacing</li></ul>
1379    *   boolean $ishtml set to true if $txt is HTML content (default = false).
1380    *   boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1381    *   float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1382    *               or 0 for disable this feature. This feature works only when $ishtml=false.
1383    *
1384    * @return mixed
1385    */
1386   public static function alterMailingLabelParams(&$args) {
1387     return self::singleton()->invoke(1, $args,
1388       self::$_nullObject, self::$_nullObject,
1389       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1390       'civicrm_alterMailingLabelParams'
1391     );
1392   }
1393
1394   /**
1395    * This hooks allows alteration of generated page content.
1396    *
1397    * @param $content
1398    *   Previously generated content.
1399    * @param $context
1400    *   Context of content - page or form.
1401    * @param $tplName
1402    *   The file name of the tpl.
1403    * @param $object
1404    *   A reference to the page or form object.
1405    *
1406    * @return mixed
1407    */
1408   public static function alterContent(&$content, $context, $tplName, &$object) {
1409     return self::singleton()->invoke(4, $content, $context, $tplName, $object,
1410       self::$_nullObject, self::$_nullObject,
1411       'civicrm_alterContent'
1412     );
1413   }
1414
1415   /**
1416    * This hooks allows alteration of the tpl file used to generate content. It differs from the
1417    * altercontent hook as the content has already been rendered through the tpl at that point
1418    *
1419    * @param $formName
1420    *   Previously generated content.
1421    * @param $form
1422    *   Reference to the form object.
1423    * @param $context
1424    *   Context of content - page or form.
1425    * @param $tplName
1426    *   Reference the file name of the tpl.
1427    *
1428    * @return mixed
1429    */
1430   public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1431     return self::singleton()->invoke(4, $formName, $form, $context, $tplName,
1432       self::$_nullObject, self::$_nullObject,
1433       'civicrm_alterTemplateFile'
1434     );
1435   }
1436
1437   /**
1438    * This hook collects the trigger definition from all components.
1439    *
1440    * @param $info
1441    * @param string $tableName
1442    *   (optional) the name of the table that we are interested in only.
1443    *
1444    * @internal param \reference $triggerInfo to an array of trigger information
1445    *   each element has 4 fields:
1446    *     table - array of tableName
1447    *     when  - BEFORE or AFTER
1448    *     event - array of eventName - INSERT OR UPDATE OR DELETE
1449    *     sql   - array of statements optionally terminated with a ;
1450    *             a statement can use the tokes {tableName} and {eventName}
1451    *             to do token replacement with the table / event. This allows
1452    *             templatizing logging and other hooks
1453    * @return mixed
1454    */
1455   public static function triggerInfo(&$info, $tableName = NULL) {
1456     return self::singleton()->invoke(2, $info, $tableName,
1457       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1458       self::$_nullObject,
1459       'civicrm_triggerInfo'
1460     );
1461   }
1462
1463   /**
1464    * This hook is called when a module-extension is installed.
1465    * Each module will receive hook_civicrm_install during its own installation (but not during the
1466    * installation of unrelated modules).
1467    */
1468   public static function install() {
1469     return self::singleton()->invoke(0, self::$_nullObject,
1470       self::$_nullObject, self::$_nullObject,
1471       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1472       'civicrm_install'
1473     );
1474   }
1475
1476   /**
1477    * This hook is called when a module-extension is uninstalled.
1478    * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1479    * uninstallation of unrelated modules).
1480    */
1481   public static function uninstall() {
1482     return self::singleton()->invoke(0, self::$_nullObject,
1483       self::$_nullObject, self::$_nullObject,
1484       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1485       'civicrm_uninstall'
1486     );
1487   }
1488
1489   /**
1490    * This hook is called when a module-extension is re-enabled.
1491    * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1492    * re-enablement of unrelated modules).
1493    */
1494   public static function enable() {
1495     return self::singleton()->invoke(0, self::$_nullObject,
1496       self::$_nullObject, self::$_nullObject,
1497       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1498       'civicrm_enable'
1499     );
1500   }
1501
1502   /**
1503    * This hook is called when a module-extension is disabled.
1504    * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1505    * disablement of unrelated modules).
1506    */
1507   public static function disable() {
1508     return self::singleton()->invoke(0, self::$_nullObject,
1509       self::$_nullObject, self::$_nullObject,
1510       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1511       'civicrm_disable'
1512     );
1513   }
1514
1515   /**
1516    * @param $varType
1517    * @param $var
1518    * @param $object
1519    *
1520    * @return mixed
1521    */
1522   public static function alterReportVar($varType, &$var, &$object) {
1523     return self::singleton()->invoke(3, $varType, $var, $object,
1524       self::$_nullObject,
1525       self::$_nullObject, self::$_nullObject,
1526       'civicrm_alterReportVar'
1527     );
1528   }
1529
1530   /**
1531    * This hook is called to drive database upgrades for extension-modules.
1532    *
1533    * @param string $op
1534    *   The type of operation being performed; 'check' or 'enqueue'.
1535    * @param CRM_Queue_Queue $queue
1536    *   (for 'enqueue') the modifiable list of pending up upgrade tasks.
1537    *
1538    * @return bool|null
1539    *   NULL, if $op is 'enqueue'.
1540    *   TRUE, if $op is 'check' and upgrades are pending.
1541    *   FALSE, if $op is 'check' and upgrades are not pending.
1542    */
1543   public static function upgrade($op, CRM_Queue_Queue $queue = NULL) {
1544     return self::singleton()->invoke(2, $op, $queue,
1545       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1546       self::$_nullObject,
1547       'civicrm_upgrade'
1548     );
1549   }
1550
1551   /**
1552    * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1553    *
1554    * @param array $params
1555    *   The mailing parameters. Array fields include: groupName, from, toName,
1556    *   toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1557    *   attachments (array)
1558    *
1559    * @return mixed
1560    */
1561   public static function postEmailSend(&$params) {
1562     return self::singleton()->invoke(1, $params,
1563       self::$_nullObject, self::$_nullObject,
1564       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1565       'civicrm_postEmailSend'
1566     );
1567   }
1568
1569   /**
1570    * This hook is called when Settings specifications are loaded.
1571    *
1572    * @param array $settingsFolders
1573    *   List of paths from which to derive metadata
1574    *
1575    * @return mixed
1576    */
1577   public static function alterSettingsFolders(&$settingsFolders) {
1578     return self::singleton()->invoke(1, $settingsFolders,
1579       self::$_nullObject, self::$_nullObject,
1580       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1581       'civicrm_alterSettingsFolders'
1582     );
1583   }
1584
1585   /**
1586    * This hook is called when Settings have been loaded from the xml
1587    * It is an opportunity for hooks to alter the data
1588    *
1589    * @param array $settingsMetaData
1590    *   Settings Metadata.
1591    * @param int $domainID
1592    * @param mixed $profile
1593    *
1594    * @return mixed
1595    */
1596   public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1597     return self::singleton()->invoke(3, $settingsMetaData,
1598       $domainID, $profile,
1599       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1600       'civicrm_alterSettingsMetaData'
1601     );
1602   }
1603
1604   /**
1605    * This hook is called before running an api call.
1606    *
1607    * @param API_Wrapper[] $wrappers
1608    *   (see CRM_Utils_API_ReloadOption as an example)
1609    * @param mixed $apiRequest
1610    *
1611    * @return null
1612    *   The return value is ignored
1613    */
1614   public static function apiWrappers(&$wrappers, $apiRequest) {
1615     return self::singleton()
1616       ->invoke(2, $wrappers, $apiRequest, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1617         self::$_nullObject, 'civicrm_apiWrappers'
1618       );
1619   }
1620
1621   /**
1622    * This hook is called before running pending cron jobs.
1623    *
1624    * @param CRM_Core_JobManager $jobManager
1625    *
1626    * @return null
1627    *   The return value is ignored.
1628    */
1629   public static function cron($jobManager) {
1630     return self::singleton()->invoke(1,
1631       $jobManager, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1632       'civicrm_cron'
1633     );
1634   }
1635
1636   /**
1637    * This hook is called when loading CMS permissions; use this hook to modify
1638    * the array of system permissions for CiviCRM.
1639    *
1640    * @param array $permissions
1641    *   Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1642    *   the format of this array.
1643    *
1644    * @return null
1645    *   The return value is ignored
1646    */
1647   public static function permission(&$permissions) {
1648     return self::singleton()->invoke(1, $permissions,
1649       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1650       'civicrm_permission'
1651     );
1652   }
1653
1654   /**
1655    * @param CRM_Core_Exception Exception $exception
1656    * @param mixed $request
1657    *   Reserved for future use.
1658    */
1659   public static function unhandledException($exception, $request = NULL) {
1660     self::singleton()
1661       ->invoke(2, $exception, $request, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_unhandled_exception');
1662     // == 4.4 ==
1663     // $event = new stdClass();
1664     // $event->exception = $exception;
1665     // CRM_Core_LegacyErrorHandler::handleException($event);
1666
1667     // == 4.5+ ==
1668     $event = new \Civi\Core\Event\UnhandledExceptionEvent($exception, self::$_nullObject);
1669     \Civi::service('dispatcher')->dispatch("hook_civicrm_unhandled_exception", $event);
1670   }
1671
1672   /**
1673    * This hook is called for declaring managed entities via API.
1674    *
1675    * @param array[] $entityTypes
1676    *   List of entity types; each entity-type is an array with keys:
1677    *   - name: string, a unique short name (e.g. "ReportInstance")
1678    *   - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1679    *   - table: string, a SQL table name (e.g. "civicrm_report_instance")
1680    *
1681    * @return null
1682    *   The return value is ignored
1683    */
1684   public static function entityTypes(&$entityTypes) {
1685     return self::singleton()->invoke(1, $entityTypes, self::$_nullObject, self::$_nullObject,
1686       self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_entityTypes'
1687     );
1688   }
1689
1690   /**
1691    * This hook is called while preparing a profile form.
1692    *
1693    * @param string $name
1694    * @return mixed
1695    */
1696   public static function buildProfile($name) {
1697     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1698       self::$_nullObject, self::$_nullObject, 'civicrm_buildProfile');
1699   }
1700
1701   /**
1702    * This hook is called while validating a profile form submission.
1703    *
1704    * @param string $name
1705    * @return mixed
1706    */
1707   public static function validateProfile($name) {
1708     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1709       self::$_nullObject, self::$_nullObject, 'civicrm_validateProfile');
1710   }
1711
1712   /**
1713    * This hook is called processing a valid profile form submission.
1714    *
1715    * @param string $name
1716    * @return mixed
1717    */
1718   public static function processProfile($name) {
1719     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1720       self::$_nullObject, self::$_nullObject, 'civicrm_processProfile');
1721   }
1722
1723   /**
1724    * This hook is called while preparing a read-only profile screen
1725    *
1726    * @param string $name
1727    * @return mixed
1728    */
1729   public static function viewProfile($name) {
1730     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1731       self::$_nullObject, self::$_nullObject, 'civicrm_viewProfile');
1732   }
1733
1734   /**
1735    * This hook is called while preparing a list of contacts (based on a profile)
1736    *
1737    * @param string $name
1738    * @return mixed
1739    */
1740   public static function searchProfile($name) {
1741     return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1742       self::$_nullObject, self::$_nullObject, 'civicrm_searchProfile');
1743   }
1744
1745   /**
1746    * This hook is invoked when building a CiviCRM name badge.
1747    *
1748    * @param string $labelName
1749    *   String referencing name of badge format.
1750    * @param object $label
1751    *   Reference to the label object.
1752    * @param array $format
1753    *   Array of format data.
1754    * @param array $participant
1755    *   Array of participant values.
1756    *
1757    * @return null
1758    *   the return value is ignored
1759    */
1760   public static function alterBadge($labelName, &$label, &$format, &$participant) {
1761     return self::singleton()
1762       ->invoke(4, $labelName, $label, $format, $participant, self::$_nullObject, self::$_nullObject, 'civicrm_alterBadge');
1763   }
1764
1765
1766   /**
1767    * This hook is called before encoding data in barcode.
1768    *
1769    * @param array $data
1770    *   Associated array of values available for encoding.
1771    * @param string $type
1772    *   Type of barcode, classic barcode or QRcode.
1773    * @param string $context
1774    *   Where this hooks is invoked.
1775    *
1776    * @return mixed
1777    */
1778   public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') {
1779     return self::singleton()->invoke(3, $data, $type, $context, self::$_nullObject,
1780       self::$_nullObject, self::$_nullObject, 'civicrm_alterBarcode');
1781   }
1782
1783   /**
1784    * Modify or replace the Mailer object used for outgoing mail.
1785    *
1786    * @param object $mailer
1787    *   The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
1788    * @param string $driver
1789    *   The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
1790    * @param array $params
1791    *   The default mailer config options
1792    *
1793    * @return mixed
1794    * @see Mail::factory
1795    */
1796   public static function alterMail(&$mailer, $driver, $params) {
1797     return self::singleton()
1798       ->invoke(3, $mailer, $driver, $params, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_alterMailer');
1799   }
1800
1801   /**
1802    * This hook is called while building the core search query,
1803    * so hook implementers can provide their own query objects which alters/extends core search.
1804    *
1805    * @param array $queryObjects
1806    * @param string $type
1807    *
1808    * @return mixed
1809    */
1810   public static function queryObjects(&$queryObjects, $type = 'Contact') {
1811     return self::singleton()
1812       ->invoke(2, $queryObjects, $type, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_queryObjects');
1813   }
1814
1815   /**
1816    * This hook is called while viewing contact dashboard.
1817    *
1818    * @param array $availableDashlets
1819    *   List of dashlets; each is formatted per api/v3/Dashboard
1820    * @param array $defaultDashlets
1821    *   List of dashlets; each is formatted per api/v3/DashboardContact
1822    *
1823    * @return mixed
1824    */
1825   public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
1826     return self::singleton()
1827       ->invoke(2, $availableDashlets, $defaultDashlets, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_dashboard_defaults');
1828   }
1829
1830   /**
1831    * This hook is called before a case merge (or a case reassign)
1832    *
1833    * @param int $mainContactId
1834    * @param int $mainCaseId
1835    * @param int $otherContactId
1836    * @param int $otherCaseId
1837    * @param bool $changeClient
1838    *
1839    * @return mixed
1840    */
1841   public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1842     return self::singleton()
1843       ->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self::$_nullObject, 'civicrm_pre_case_merge');
1844   }
1845
1846   /**
1847    * This hook is called after a case merge (or a case reassign)
1848    *
1849    * @param int $mainContactId
1850    * @param int $mainCaseId
1851    * @param int $otherContactId
1852    * @param int $otherCaseId
1853    * @param bool $changeClient
1854    *
1855    * @return mixed
1856    */
1857   public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
1858     return self::singleton()
1859       ->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self::$_nullObject, 'civicrm_post_case_merge');
1860   }
1861
1862   /**
1863    * Issue CRM-14276
1864    * Add a hook for altering the display name
1865    *
1866    * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
1867    *
1868    * @param string $displayName
1869    * @param int $contactId
1870    * @param object $dao
1871    *   The contact object.
1872    *
1873    * @return mixed
1874    */
1875   public static function alterDisplayName(&$displayName, $contactId, $dao) {
1876     return self::singleton()->invoke(3,
1877       $displayName, $contactId, $dao, self::$_nullObject, self::$_nullObject,
1878       self::$_nullObject, 'civicrm_contact_get_displayname'
1879     );
1880   }
1881
1882   /**
1883    * EXPERIMENTAL: This hook allows one to register additional Angular modules
1884    *
1885    * @param array $angularModules
1886    *   List of modules.
1887    * @return null
1888    *   the return value is ignored
1889    *
1890    * @code
1891    * function mymod_civicrm_angularModules(&$angularModules) {
1892    *   $angularModules['myAngularModule'] = array(
1893    *     'ext' => 'org.example.mymod',
1894    *     'js' => array('js/myAngularModule.js'),
1895    *   );
1896    *   $angularModules['myBigAngularModule'] = array(
1897    *     'ext' => 'org.example.mymod',
1898    *     'js' => array('js/part1.js', 'js/part2.js'),
1899    *     'css' => array('css/myAngularModule.css'),
1900    *     'partials' => array('partials/myBigAngularModule'),
1901    *   );
1902    * }
1903    * @endcode
1904    */
1905   public static function angularModules(&$angularModules) {
1906     return self::singleton()->invoke(1, $angularModules,
1907       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1908       'civicrm_angularModules'
1909     );
1910   }
1911
1912   /**
1913    * This hook fires whenever a record in a case changes.
1914    *
1915    * @param \Civi\CCase\Analyzer $analyzer
1916    *   A bundle of data about the case (such as the case and activity records).
1917    */
1918   public static function caseChange(\Civi\CCase\Analyzer $analyzer) {
1919     $event = new \Civi\CCase\Event\CaseChangeEvent($analyzer);
1920     \Civi::service('dispatcher')->dispatch("hook_civicrm_caseChange", $event);
1921
1922     self::singleton()->invoke(1, $analyzer,
1923       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1924       'civicrm_caseChange'
1925     );
1926   }
1927
1928   /**
1929    * Generate a default CRUD URL for an entity.
1930    *
1931    * @param array $spec
1932    *   With keys:.
1933    *   - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
1934    *   - entity_table: string
1935    *   - entity_id: int
1936    * @param CRM_Core_DAO $bao
1937    * @param array $link
1938    *   To define the link, add these keys to $link:.
1939    *   - title: string
1940    *   - path: string
1941    *   - query: array
1942    *   - url: string (used in lieu of "path"/"query")
1943    *      Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
1944    * @return mixed
1945    */
1946   public static function crudLink($spec, $bao, &$link) {
1947     return self::singleton()->invoke(3, $spec, $bao, $link,
1948       self::$_nullObject, self::$_nullObject, self::$_nullObject,
1949       'civicrm_crudLink'
1950     );
1951   }
1952
1953   /**
1954    * Modify the CiviCRM container - add new services, parameters, extensions, etc.
1955    *
1956    * @code
1957    * use Symfony\Component\Config\Resource\FileResource;
1958    * use Symfony\Component\DependencyInjection\Definition;
1959    *
1960    * function mymodule_civicrm_container($container) {
1961    *   $container->addResource(new FileResource(__FILE__));
1962    *   $container->setDefinition('mysvc', new Definition('My\Class', array()));
1963    * }
1964    * @endcode
1965    *
1966    * Tip: The container configuration will be compiled/cached. The default cache
1967    * behavior is aggressive. When you first implement the hook, be sure to
1968    * flush the cache. Additionally, you should relax caching during development.
1969    * In `civicrm.settings.php`, set define('CIVICRM_CONTAINER_CACHE', 'auto').
1970    *
1971    * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
1972    * @see http://symfony.com/doc/current/components/dependency_injection/index.html
1973    */
1974   public static function container(\Symfony\Component\DependencyInjection\ContainerBuilder $container) {
1975     self::singleton()->invoke(1, $container, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_container');
1976   }
1977
1978   /**
1979    * @param array <CRM_Core_FileSearchInterface> $fileSearches
1980    * @return mixed
1981    */
1982   public static function fileSearches(&$fileSearches) {
1983     return self::singleton()->invoke(1, $fileSearches,
1984       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
1985       'civicrm_fileSearches'
1986     );
1987   }
1988
1989   /**
1990    * Check system status.
1991    *
1992    * @param array $messages
1993    *   Array<CRM_Utils_Check_Message>. A list of messages regarding system status.
1994    * @return mixed
1995    */
1996   public static function check(&$messages) {
1997     return self::singleton()
1998       ->invoke(1, $messages, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_check');
1999   }
2000
2001   /**
2002    * This hook is called when a query string of the CSV Batch export is generated.
2003    *
2004    * @param string $query
2005    *
2006    * @return mixed
2007    */
2008   public static function batchQuery(&$query) {
2009     return self::singleton()->invoke(1, $query, self::$_nullObject,
2010       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
2011       'civicrm_batchQuery'
2012     );
2013   }
2014
2015   /**
2016    * This hook is called when the entries of the CSV Batch export are mapped.
2017    *
2018    * @param array $results
2019    * @param array $items
2020    *
2021    * @return mixed
2022    */
2023   public static function batchItems(&$results, &$items) {
2024     return self::singleton()->invoke(2, $results, $items,
2025       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
2026       'civicrm_batchItems'
2027     );
2028   }
2029
2030   /**
2031    * This hook is called when core resources are being loaded
2032    *
2033    * @see CRM_Core_Resources::coreResourceList
2034    *
2035    * @param array $list
2036    * @param string $region
2037    */
2038   public static function coreResourceList(&$list, $region) {
2039     // First allow the cms integration to add to the list
2040     CRM_Core_Config::singleton()->userSystem->appendCoreResources($list);
2041
2042     self::singleton()->invoke(2, $list, $region,
2043       self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
2044       'civicrm_coreResourceList'
2045     );
2046   }
2047
2048 }