CRM/Utils/Hook.php

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