| 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 | */ |
| 644 | public static function tabs(&$tabs, $contactID) { |
| 645 | return self::singleton()->invoke(2, $tabs, $contactID, |
| 646 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tabs' |
| 647 | ); |
| 648 | } |
| 649 | |
| 650 | /** |
| 651 | * This hook is called when rendering the tabs used for events and potentially |
| 652 | * contribution pages, etc. |
| 653 | * |
| 654 | * @param string $tabsetName |
| 655 | * Name of the screen or visual element. |
| 656 | * @param array $tabs |
| 657 | * Tabs that will be displayed. |
| 658 | * @param array $context |
| 659 | * Extra data about the screen or context in which the tab is used. |
| 660 | * |
| 661 | * @return null |
| 662 | */ |
| 663 | public static function tabset($tabsetName, &$tabs, $context) { |
| 664 | return self::singleton()->invoke(3, $tabsetName, $tabs, |
| 665 | $context, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tabset' |
| 666 | ); |
| 667 | } |
| 668 | |
| 669 | /** |
| 670 | * This hook is called when sending an email / printing labels |
| 671 | * |
| 672 | * @param array $tokens |
| 673 | * The list of tokens that can be used for the contact. |
| 674 | * |
| 675 | * @return null |
| 676 | */ |
| 677 | public static function tokens(&$tokens) { |
| 678 | return self::singleton()->invoke(1, $tokens, |
| 679 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_tokens' |
| 680 | ); |
| 681 | } |
| 682 | |
| 683 | /** |
| 684 | * This hook is called when sending an email / printing labels to get the values for all the |
| 685 | * tokens returned by the 'tokens' hook |
| 686 | * |
| 687 | * @param array $details |
| 688 | * The array to store the token values indexed by contactIDs (unless it a single). |
| 689 | * @param array $contactIDs |
| 690 | * An array of contactIDs. |
| 691 | * @param int $jobID |
| 692 | * The jobID if this is associated with a CiviMail mailing. |
| 693 | * @param array $tokens |
| 694 | * The list of tokens associated with the content. |
| 695 | * @param string $className |
| 696 | * The top level className from where the hook is invoked. |
| 697 | * |
| 698 | * @return null |
| 699 | */ |
| 700 | public static function tokenValues( |
| 701 | &$details, |
| 702 | $contactIDs, |
| 703 | $jobID = NULL, |
| 704 | $tokens = array(), |
| 705 | $className = NULL |
| 706 | ) { |
| 707 | return self::singleton() |
| 708 | ->invoke(5, $details, $contactIDs, $jobID, $tokens, $className, self::$_nullObject, 'civicrm_tokenValues'); |
| 709 | } |
| 710 | |
| 711 | /** |
| 712 | * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables |
| 713 | * in a template |
| 714 | * |
| 715 | * @param object $page |
| 716 | * The page that will be rendered. |
| 717 | * |
| 718 | * @return null |
| 719 | */ |
| 720 | public static function pageRun(&$page) { |
| 721 | return self::singleton()->invoke(1, $page, |
| 722 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 723 | 'civicrm_pageRun' |
| 724 | ); |
| 725 | } |
| 726 | |
| 727 | /** |
| 728 | * This hook is called after a copy of an object has been made. The current objects are |
| 729 | * Event, Contribution Page and UFGroup |
| 730 | * |
| 731 | * @param string $objectName |
| 732 | * Name of the object. |
| 733 | * @param object $object |
| 734 | * Reference to the copy. |
| 735 | * |
| 736 | * @return null |
| 737 | */ |
| 738 | public static function copy($objectName, &$object) { |
| 739 | return self::singleton()->invoke(2, $objectName, $object, |
| 740 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 741 | 'civicrm_copy' |
| 742 | ); |
| 743 | } |
| 744 | |
| 745 | /** |
| 746 | * This hook is called when a contact unsubscribes from a mailing. It allows modules |
| 747 | * to override what the contacts are removed from. |
| 748 | * |
| 749 | * @param string $op |
| 750 | * Ignored for now |
| 751 | * @param int $mailingId |
| 752 | * The id of the mailing to unsub from |
| 753 | * @param int $contactId |
| 754 | * The id of the contact who is unsubscribing |
| 755 | * @param array|int $groups |
| 756 | * Groups the contact will be removed from. |
| 757 | * @param array|int $baseGroups |
| 758 | * Base groups (used in smart mailings) the contact will be removed from. |
| 759 | * |
| 760 | * |
| 761 | * @return mixed |
| 762 | */ |
| 763 | public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) { |
| 764 | return self::singleton() |
| 765 | ->invoke(5, $op, $mailingId, $contactId, $groups, $baseGroups, self::$_nullObject, 'civicrm_unsubscribeGroups'); |
| 766 | } |
| 767 | |
| 768 | /** |
| 769 | * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox, |
| 770 | * adv multiselect) |
| 771 | * |
| 772 | * @param int $customFieldID |
| 773 | * The custom field ID. |
| 774 | * @param array $options |
| 775 | * The current set of options for that custom field. |
| 776 | * You can add/remove existing options. |
| 777 | * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important |
| 778 | * to be careful to not overwrite the array. |
| 779 | * Only add/edit/remove the specific field options you intend to affect. |
| 780 | * @param bool $detailedFormat |
| 781 | * If true,. |
| 782 | * the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format |
| 783 | * @param array $selectAttributes |
| 784 | * Contain select attribute(s) if any. |
| 785 | * |
| 786 | * @return mixed |
| 787 | */ |
| 788 | public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = array()) { |
| 789 | return self::singleton()->invoke(3, $customFieldID, $options, $detailedFormat, |
| 790 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 791 | 'civicrm_customFieldOptions' |
| 792 | ); |
| 793 | } |
| 794 | |
| 795 | /** |
| 796 | * |
| 797 | * This hook is called to display the list of actions allowed after doing a search. |
| 798 | * This allows the module developer to inject additional actions or to remove existing actions. |
| 799 | * |
| 800 | * @param string $objectType |
| 801 | * The object type for this search. |
| 802 | * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported. |
| 803 | * @param array $tasks |
| 804 | * The current set of tasks for that custom field. |
| 805 | * You can add/remove existing tasks. |
| 806 | * Each task needs to have a title (eg 'title' => ts( 'Group - add contacts')) and a class |
| 807 | * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup'). |
| 808 | * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ). |
| 809 | * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be |
| 810 | * found in CRM/$objectType/Task.php. |
| 811 | * |
| 812 | * @return mixed |
| 813 | */ |
| 814 | public static function searchTasks($objectType, &$tasks) { |
| 815 | return self::singleton()->invoke(2, $objectType, $tasks, |
| 816 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 817 | 'civicrm_searchTasks' |
| 818 | ); |
| 819 | } |
| 820 | |
| 821 | /** |
| 822 | * @param mixed $form |
| 823 | * @param array $params |
| 824 | * |
| 825 | * @return mixed |
| 826 | */ |
| 827 | public static function eventDiscount(&$form, &$params) { |
| 828 | return self::singleton()->invoke(2, $form, $params, |
| 829 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 830 | 'civicrm_eventDiscount' |
| 831 | ); |
| 832 | } |
| 833 | |
| 834 | /** |
| 835 | * This hook is called when composing a mailing. You can include / exclude other groups as needed. |
| 836 | * |
| 837 | * @param mixed $form |
| 838 | * The form object for which groups / mailings being displayed |
| 839 | * @param array $groups |
| 840 | * The list of groups being included / excluded |
| 841 | * @param array $mailings |
| 842 | * The list of mailings being included / excluded |
| 843 | * |
| 844 | * @return mixed |
| 845 | */ |
| 846 | public static function mailingGroups(&$form, &$groups, &$mailings) { |
| 847 | return self::singleton()->invoke(3, $form, $groups, $mailings, |
| 848 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 849 | 'civicrm_mailingGroups' |
| 850 | ); |
| 851 | } |
| 852 | |
| 853 | /** |
| 854 | * This hook is called when composing the array of membershipTypes and their cost during a membership registration |
| 855 | * (new or renewal). |
| 856 | * Note the hook is called on initial page load and also reloaded after submit (PRG pattern). |
| 857 | * You can use it to alter the membership types when first loaded, or after submission |
| 858 | * (for example if you want to gather data in the form and use it to alter the fees). |
| 859 | * |
| 860 | * @param mixed $form |
| 861 | * The form object that is presenting the page |
| 862 | * @param array $membershipTypes |
| 863 | * The array of membership types and their amount |
| 864 | * |
| 865 | * @return mixed |
| 866 | */ |
| 867 | public static function membershipTypeValues(&$form, &$membershipTypes) { |
| 868 | return self::singleton()->invoke(2, $form, $membershipTypes, |
| 869 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 870 | 'civicrm_membershipTypeValues' |
| 871 | ); |
| 872 | } |
| 873 | |
| 874 | /** |
| 875 | * This hook is called when rendering the contact summary. |
| 876 | * |
| 877 | * @param int $contactID |
| 878 | * The contactID for whom the summary is being rendered |
| 879 | * @param mixed $content |
| 880 | * @param int $contentPlacement |
| 881 | * Specifies where the hook content should be displayed relative to the |
| 882 | * existing content |
| 883 | * |
| 884 | * @return string |
| 885 | * The html snippet to include in the contact summary |
| 886 | */ |
| 887 | public static function summary($contactID, &$content, &$contentPlacement = self::SUMMARY_BELOW) { |
| 888 | return self::singleton()->invoke(3, $contactID, $content, $contentPlacement, |
| 889 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 890 | 'civicrm_summary' |
| 891 | ); |
| 892 | } |
| 893 | |
| 894 | /** |
| 895 | * Use this hook to populate the list of contacts returned by Contact Reference custom fields. |
| 896 | * By default, Contact Reference fields will search on and return all CiviCRM contacts. |
| 897 | * If you want to limit the contacts returned to a specific group, or some other criteria |
| 898 | * - you can override that behavior by providing a SQL query that returns some subset of your contacts. |
| 899 | * The hook is called when the query is executed to get the list of contacts to display. |
| 900 | * |
| 901 | * @param mixed $query |
| 902 | * - the query that will be executed (input and output parameter);. |
| 903 | * It's important to realize that the ACL clause is built prior to this hook being fired, |
| 904 | * so your query will ignore any ACL rules that may be defined. |
| 905 | * Your query must return two columns: |
| 906 | * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data') |
| 907 | * the contact IDs |
| 908 | * @param string $name |
| 909 | * The name string to execute the query against (this is the value being typed in by the user). |
| 910 | * @param string $context |
| 911 | * The context in which this ajax call is being made (for example: 'customfield', 'caseview'). |
| 912 | * @param int $id |
| 913 | * The id of the object for which the call is being made. |
| 914 | * For custom fields, it will be the custom field id |
| 915 | * |
| 916 | * @return mixed |
| 917 | */ |
| 918 | public static function contactListQuery(&$query, $name, $context, $id) { |
| 919 | return self::singleton()->invoke(4, $query, $name, $context, $id, |
| 920 | self::$_nullObject, self::$_nullObject, |
| 921 | 'civicrm_contactListQuery' |
| 922 | ); |
| 923 | } |
| 924 | |
| 925 | /** |
| 926 | * Hook definition for altering payment parameters before talking to a payment processor back end. |
| 927 | * |
| 928 | * Definition will look like this: |
| 929 | * |
| 930 | * function hook_civicrm_alterPaymentProcessorParams( |
| 931 | * $paymentObj, |
| 932 | * &$rawParams, |
| 933 | * &$cookedParams |
| 934 | * ); |
| 935 | * |
| 936 | * @param CRM_Core_Payment $paymentObj |
| 937 | * Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy') |
| 938 | * See discussion in CRM-16224 as to whether $paymentObj should be passed by reference. |
| 939 | * @param array &$rawParams |
| 940 | * array of params as passed to to the processor |
| 941 | * @param array &$cookedParams |
| 942 | * params after the processor code has translated them into its own key/value pairs |
| 943 | * |
| 944 | * @return mixed |
| 945 | * This return is not really intended to be used. |
| 946 | */ |
| 947 | public static function alterPaymentProcessorParams( |
| 948 | $paymentObj, |
| 949 | &$rawParams, |
| 950 | &$cookedParams |
| 951 | ) { |
| 952 | return self::singleton()->invoke(3, $paymentObj, $rawParams, $cookedParams, |
| 953 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 954 | 'civicrm_alterPaymentProcessorParams' |
| 955 | ); |
| 956 | } |
| 957 | |
| 958 | /** |
| 959 | * This hook is called when an email is about to be sent by CiviCRM. |
| 960 | * |
| 961 | * @param array $params |
| 962 | * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html, |
| 963 | * returnPath, replyTo, headers, attachments (array) |
| 964 | * @param string $context |
| 965 | * The context in which the hook is being invoked, eg 'civimail'. |
| 966 | * |
| 967 | * @return mixed |
| 968 | */ |
| 969 | public static function alterMailParams(&$params, $context = NULL) { |
| 970 | return self::singleton()->invoke(2, $params, $context, |
| 971 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 972 | 'civicrm_alterMailParams' |
| 973 | ); |
| 974 | } |
| 975 | |
| 976 | /** |
| 977 | * This hook is called when membership status is being calculated. |
| 978 | * |
| 979 | * @param array $membershipStatus |
| 980 | * Membership status details as determined - alter if required. |
| 981 | * @param array $arguments |
| 982 | * Arguments passed in to calculate date. |
| 983 | * - 'start_date' |
| 984 | * - 'end_date' |
| 985 | * - 'status_date' |
| 986 | * - 'join_date' |
| 987 | * - 'exclude_is_admin' |
| 988 | * - 'membership_type_id' |
| 989 | * @param array $membership |
| 990 | * Membership details from the calling function. |
| 991 | * |
| 992 | * @return mixed |
| 993 | */ |
| 994 | public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) { |
| 995 | return self::singleton()->invoke(3, $membershipStatus, $arguments, |
| 996 | $membership, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 997 | 'civicrm_alterCalculatedMembershipStatus' |
| 998 | ); |
| 999 | } |
| 1000 | |
| 1001 | /** |
| 1002 | * This hook is called after getting the content of the mail and before tokenizing it. |
| 1003 | * |
| 1004 | * @param array $content |
| 1005 | * Array fields include: html, text, subject |
| 1006 | * |
| 1007 | * @return mixed |
| 1008 | */ |
| 1009 | public static function alterMailContent(&$content) { |
| 1010 | return self::singleton()->invoke(1, $content, |
| 1011 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1012 | 'civicrm_alterMailContent' |
| 1013 | ); |
| 1014 | } |
| 1015 | |
| 1016 | /** |
| 1017 | * This hook is called when rendering the Manage Case screen. |
| 1018 | * |
| 1019 | * @param int $caseID |
| 1020 | * The case ID. |
| 1021 | * |
| 1022 | * @return array |
| 1023 | * Array of data to be displayed, where the key is a unique id to be used for styling (div id's) |
| 1024 | * and the value is an array with keys 'label' and 'value' specifying label/value pairs |
| 1025 | */ |
| 1026 | public static function caseSummary($caseID) { |
| 1027 | return self::singleton()->invoke(1, $caseID, |
| 1028 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1029 | 'civicrm_caseSummary' |
| 1030 | ); |
| 1031 | } |
| 1032 | |
| 1033 | /** |
| 1034 | * This hook is called when locating CiviCase types. |
| 1035 | * |
| 1036 | * @param array $caseTypes |
| 1037 | * |
| 1038 | * @return mixed |
| 1039 | */ |
| 1040 | public static function caseTypes(&$caseTypes) { |
| 1041 | return self::singleton() |
| 1042 | ->invoke(1, $caseTypes, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_caseTypes'); |
| 1043 | } |
| 1044 | |
| 1045 | /** |
| 1046 | * This hook is called soon after the CRM_Core_Config object has ben initialized. |
| 1047 | * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically. |
| 1048 | * |
| 1049 | * @param CRM_Core_Config|array $config |
| 1050 | * The config object |
| 1051 | * |
| 1052 | * @return mixed |
| 1053 | */ |
| 1054 | public static function config(&$config) { |
| 1055 | return self::singleton()->invoke(1, $config, |
| 1056 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1057 | 'civicrm_config' |
| 1058 | ); |
| 1059 | } |
| 1060 | |
| 1061 | /** |
| 1062 | * This hooks allows to change option values. |
| 1063 | * |
| 1064 | * @param array $options |
| 1065 | * Associated array of option values / id |
| 1066 | * @param string $name |
| 1067 | * Option group name |
| 1068 | * |
| 1069 | * @return mixed |
| 1070 | */ |
| 1071 | public static function optionValues(&$options, $name) { |
| 1072 | return self::singleton()->invoke(2, $options, $name, |
| 1073 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1074 | 'civicrm_optionValues' |
| 1075 | ); |
| 1076 | } |
| 1077 | |
| 1078 | /** |
| 1079 | * This hook allows modification of the navigation menu. |
| 1080 | * |
| 1081 | * @param array $params |
| 1082 | * Associated array of navigation menu entry to Modify/Add |
| 1083 | * |
| 1084 | * @return mixed |
| 1085 | */ |
| 1086 | public static function navigationMenu(&$params) { |
| 1087 | return self::singleton()->invoke(1, $params, |
| 1088 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1089 | 'civicrm_navigationMenu' |
| 1090 | ); |
| 1091 | } |
| 1092 | |
| 1093 | /** |
| 1094 | * This hook allows modification of the data used to perform merging of duplicates. |
| 1095 | * |
| 1096 | * @param string $type |
| 1097 | * The type of data being passed (cidRefs|eidRefs|relTables|sqls). |
| 1098 | * @param array $data |
| 1099 | * The data, as described in $type. |
| 1100 | * @param int $mainId |
| 1101 | * Contact_id of the contact that survives the merge. |
| 1102 | * @param int $otherId |
| 1103 | * Contact_id of the contact that will be absorbed and deleted. |
| 1104 | * @param array $tables |
| 1105 | * When $type is "sqls", an array of tables as it may have been handed to the calling function. |
| 1106 | * |
| 1107 | * @return mixed |
| 1108 | */ |
| 1109 | public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) { |
| 1110 | return self::singleton()->invoke(5, $type, $data, $mainId, $otherId, $tables, self::$_nullObject, 'civicrm_merge'); |
| 1111 | } |
| 1112 | |
| 1113 | /** |
| 1114 | * This hook provides a way to override the default privacy behavior for notes. |
| 1115 | * |
| 1116 | * @param array &$noteValues |
| 1117 | * Associative array of values for this note |
| 1118 | * |
| 1119 | * @return mixed |
| 1120 | */ |
| 1121 | public static function notePrivacy(&$noteValues) { |
| 1122 | return self::singleton()->invoke(1, $noteValues, |
| 1123 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1124 | 'civicrm_notePrivacy' |
| 1125 | ); |
| 1126 | } |
| 1127 | |
| 1128 | /** |
| 1129 | * This hook is called before record is exported as CSV. |
| 1130 | * |
| 1131 | * @param string $exportTempTable |
| 1132 | * Name of the temporary export table used during export. |
| 1133 | * @param array $headerRows |
| 1134 | * Header rows for output. |
| 1135 | * @param array $sqlColumns |
| 1136 | * SQL columns. |
| 1137 | * @param int $exportMode |
| 1138 | * Export mode ( contact, contribution, etc...). |
| 1139 | * |
| 1140 | * @return mixed |
| 1141 | */ |
| 1142 | public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode) { |
| 1143 | return self::singleton()->invoke(4, $exportTempTable, $headerRows, $sqlColumns, $exportMode, |
| 1144 | self::$_nullObject, self::$_nullObject, |
| 1145 | 'civicrm_export' |
| 1146 | ); |
| 1147 | } |
| 1148 | |
| 1149 | /** |
| 1150 | * This hook allows modification of the queries constructed from dupe rules. |
| 1151 | * |
| 1152 | * @param string $obj |
| 1153 | * Object of rulegroup class. |
| 1154 | * @param string $type |
| 1155 | * Type of queries e.g table / threshold. |
| 1156 | * @param array $query |
| 1157 | * Set of queries. |
| 1158 | * |
| 1159 | * @return mixed |
| 1160 | */ |
| 1161 | public static function dupeQuery($obj, $type, &$query) { |
| 1162 | return self::singleton()->invoke(3, $obj, $type, $query, |
| 1163 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1164 | 'civicrm_dupeQuery' |
| 1165 | ); |
| 1166 | } |
| 1167 | |
| 1168 | /** |
| 1169 | * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php |
| 1170 | * |
| 1171 | * @param string $type |
| 1172 | * Type of mail processed: 'activity' OR 'mailing'. |
| 1173 | * @param array &$params the params that were sent to the CiviCRM API function |
| 1174 | * @param object $mail |
| 1175 | * The mail object which is an ezcMail class. |
| 1176 | * @param array &$result the result returned by the api call |
| 1177 | * @param string $action |
| 1178 | * (optional ) the requested action to be performed if the types was 'mailing'. |
| 1179 | * |
| 1180 | * @return mixed |
| 1181 | */ |
| 1182 | public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) { |
| 1183 | return self::singleton() |
| 1184 | ->invoke(5, $type, $params, $mail, $result, $action, self::$_nullObject, 'civicrm_emailProcessor'); |
| 1185 | } |
| 1186 | |
| 1187 | /** |
| 1188 | * This hook is called after a row has been processed and the |
| 1189 | * record (and associated records imported |
| 1190 | * |
| 1191 | * @param string $object |
| 1192 | * Object being imported (for now Contact only, later Contribution, Activity,. |
| 1193 | * Participant and Member) |
| 1194 | * @param string $usage |
| 1195 | * Hook usage/location (for now process only, later mapping and others). |
| 1196 | * @param string $objectRef |
| 1197 | * Import record object. |
| 1198 | * @param array $params |
| 1199 | * Array with various key values: currently. |
| 1200 | * contactID - contact id |
| 1201 | * importID - row id in temp table |
| 1202 | * importTempTable - name of tempTable |
| 1203 | * fieldHeaders - field headers |
| 1204 | * fields - import fields |
| 1205 | * |
| 1206 | * @return mixed |
| 1207 | */ |
| 1208 | public static function import($object, $usage, &$objectRef, &$params) { |
| 1209 | return self::singleton()->invoke(4, $object, $usage, $objectRef, $params, |
| 1210 | self::$_nullObject, self::$_nullObject, |
| 1211 | 'civicrm_import' |
| 1212 | ); |
| 1213 | } |
| 1214 | |
| 1215 | /** |
| 1216 | * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission() |
| 1217 | * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php). |
| 1218 | * |
| 1219 | * @param string $entity |
| 1220 | * The API entity (like contact). |
| 1221 | * @param string $action |
| 1222 | * The API action (like get). |
| 1223 | * @param array &$params the API parameters |
| 1224 | * @param array &$permissions the associative permissions array (probably to be altered by this hook) |
| 1225 | * |
| 1226 | * @return mixed |
| 1227 | */ |
| 1228 | public static function alterAPIPermissions($entity, $action, &$params, &$permissions) { |
| 1229 | return self::singleton()->invoke(4, $entity, $action, $params, $permissions, |
| 1230 | self::$_nullObject, self::$_nullObject, |
| 1231 | 'civicrm_alterAPIPermissions' |
| 1232 | ); |
| 1233 | } |
| 1234 | |
| 1235 | /** |
| 1236 | * @param CRM_Core_DAO $dao |
| 1237 | * |
| 1238 | * @return mixed |
| 1239 | */ |
| 1240 | public static function postSave(&$dao) { |
| 1241 | $hookName = 'civicrm_postSave_' . $dao->getTableName(); |
| 1242 | return self::singleton()->invoke(1, $dao, |
| 1243 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1244 | $hookName |
| 1245 | ); |
| 1246 | } |
| 1247 | |
| 1248 | /** |
| 1249 | * This hook allows user to customize context menu Actions on contact summary page. |
| 1250 | * |
| 1251 | * @param array $actions |
| 1252 | * Array of all Actions in contextmenu. |
| 1253 | * @param int $contactID |
| 1254 | * ContactID for the summary page. |
| 1255 | * |
| 1256 | * @return mixed |
| 1257 | */ |
| 1258 | public static function summaryActions(&$actions, $contactID = NULL) { |
| 1259 | return self::singleton()->invoke(2, $actions, $contactID, |
| 1260 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1261 | 'civicrm_summaryActions' |
| 1262 | ); |
| 1263 | } |
| 1264 | |
| 1265 | /** |
| 1266 | * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go. |
| 1267 | * This enables us hook implementors to modify both the headers and the rows |
| 1268 | * |
| 1269 | * The BIGGEST drawback with this hook is that you may need to modify the result template to include your |
| 1270 | * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl |
| 1271 | * |
| 1272 | * However, if you use the same number of columns, you can overwrite the existing columns with the values that |
| 1273 | * you want displayed. This is a hackish, but avoids template modification. |
| 1274 | * |
| 1275 | * @param string $objectName |
| 1276 | * The component name that we are doing the search. |
| 1277 | * activity, campaign, case, contact, contribution, event, grant, membership, and pledge |
| 1278 | * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order ) |
| 1279 | * @param array &$rows the list of values, an associate array with fields that are displayed for that component |
| 1280 | * @param array $selector |
| 1281 | * the selector object. Allows you access to the context of the search |
| 1282 | * |
| 1283 | * @return mixed |
| 1284 | * modify the header and values object to pass the data you need |
| 1285 | */ |
| 1286 | public static function searchColumns($objectName, &$headers, &$rows, &$selector) { |
| 1287 | return self::singleton()->invoke(4, $objectName, $headers, $rows, $selector, |
| 1288 | self::$_nullObject, self::$_nullObject, |
| 1289 | 'civicrm_searchColumns' |
| 1290 | ); |
| 1291 | } |
| 1292 | |
| 1293 | /** |
| 1294 | * This hook is called when uf groups are being built for a module. |
| 1295 | * |
| 1296 | * @param string $moduleName |
| 1297 | * Module name. |
| 1298 | * @param array $ufGroups |
| 1299 | * Array of ufgroups for a module. |
| 1300 | * |
| 1301 | * @return null |
| 1302 | */ |
| 1303 | public static function buildUFGroupsForModule($moduleName, &$ufGroups) { |
| 1304 | return self::singleton()->invoke(2, $moduleName, $ufGroups, |
| 1305 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1306 | 'civicrm_buildUFGroupsForModule' |
| 1307 | ); |
| 1308 | } |
| 1309 | |
| 1310 | /** |
| 1311 | * This hook is called when we are determining the contactID for a specific |
| 1312 | * email address |
| 1313 | * |
| 1314 | * @param string $email |
| 1315 | * The email address. |
| 1316 | * @param int $contactID |
| 1317 | * The contactID that matches this email address, IF it exists. |
| 1318 | * @param array $result |
| 1319 | * (reference) has two fields. |
| 1320 | * contactID - the new (or same) contactID |
| 1321 | * action - 3 possible values: |
| 1322 | * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record |
| 1323 | * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID |
| 1324 | * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address |
| 1325 | * |
| 1326 | * @return null |
| 1327 | */ |
| 1328 | public static function emailProcessorContact($email, $contactID, &$result) { |
| 1329 | return self::singleton()->invoke(3, $email, $contactID, $result, |
| 1330 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1331 | 'civicrm_emailProcessorContact' |
| 1332 | ); |
| 1333 | } |
| 1334 | |
| 1335 | /** |
| 1336 | * Hook definition for altering the generation of Mailing Labels. |
| 1337 | * |
| 1338 | * @param array $args |
| 1339 | * An array of the args in the order defined for the tcpdf multiCell api call. |
| 1340 | * with the variable names below converted into string keys (ie $w become 'w' |
| 1341 | * as the first key for $args) |
| 1342 | * float $w Width of cells. If 0, they extend up to the right margin of the page. |
| 1343 | * float $h Cell minimum height. The cell extends automatically if needed. |
| 1344 | * string $txt String to print |
| 1345 | * mixed $border Indicates if borders must be drawn around the cell block. The value can |
| 1346 | * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or |
| 1347 | * a string containing some or all of the following characters (in any order): |
| 1348 | * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> |
| 1349 | * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: |
| 1350 | * left align</li><li>C: center</li><li>R: right align</li><li>J: justification |
| 1351 | * (default value when $ishtml=false)</li></ul> |
| 1352 | * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. |
| 1353 | * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: |
| 1354 | * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul> |
| 1355 | * float $x x position in user units |
| 1356 | * float $y y position in user units |
| 1357 | * boolean $reseth if true reset the last cell height (default true). |
| 1358 | * int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if |
| 1359 | * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if |
| 1360 | * necessary</li><li>4 = forced character spacing</li></ul> |
| 1361 | * boolean $ishtml set to true if $txt is HTML content (default = false). |
| 1362 | * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width. |
| 1363 | * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page, |
| 1364 | * or 0 for disable this feature. This feature works only when $ishtml=false. |
| 1365 | * |
| 1366 | * @return mixed |
| 1367 | */ |
| 1368 | public static function alterMailingLabelParams(&$args) { |
| 1369 | return self::singleton()->invoke(1, $args, |
| 1370 | self::$_nullObject, self::$_nullObject, |
| 1371 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1372 | 'civicrm_alterMailingLabelParams' |
| 1373 | ); |
| 1374 | } |
| 1375 | |
| 1376 | /** |
| 1377 | * This hooks allows alteration of generated page content. |
| 1378 | * |
| 1379 | * @param $content |
| 1380 | * Previously generated content. |
| 1381 | * @param $context |
| 1382 | * Context of content - page or form. |
| 1383 | * @param $tplName |
| 1384 | * The file name of the tpl. |
| 1385 | * @param $object |
| 1386 | * A reference to the page or form object. |
| 1387 | * |
| 1388 | * @return mixed |
| 1389 | */ |
| 1390 | public static function alterContent(&$content, $context, $tplName, &$object) { |
| 1391 | return self::singleton()->invoke(4, $content, $context, $tplName, $object, |
| 1392 | self::$_nullObject, self::$_nullObject, |
| 1393 | 'civicrm_alterContent' |
| 1394 | ); |
| 1395 | } |
| 1396 | |
| 1397 | /** |
| 1398 | * This hooks allows alteration of the tpl file used to generate content. It differs from the |
| 1399 | * altercontent hook as the content has already been rendered through the tpl at that point |
| 1400 | * |
| 1401 | * @param $formName |
| 1402 | * Previously generated content. |
| 1403 | * @param $form |
| 1404 | * Reference to the form object. |
| 1405 | * @param $context |
| 1406 | * Context of content - page or form. |
| 1407 | * @param $tplName |
| 1408 | * Reference the file name of the tpl. |
| 1409 | * |
| 1410 | * @return mixed |
| 1411 | */ |
| 1412 | public static function alterTemplateFile($formName, &$form, $context, &$tplName) { |
| 1413 | return self::singleton()->invoke(4, $formName, $form, $context, $tplName, |
| 1414 | self::$_nullObject, self::$_nullObject, |
| 1415 | 'civicrm_alterTemplateFile' |
| 1416 | ); |
| 1417 | } |
| 1418 | |
| 1419 | /** |
| 1420 | * This hook collects the trigger definition from all components. |
| 1421 | * |
| 1422 | * @param $info |
| 1423 | * @param string $tableName |
| 1424 | * (optional) the name of the table that we are interested in only. |
| 1425 | * |
| 1426 | * @internal param \reference $triggerInfo to an array of trigger information |
| 1427 | * each element has 4 fields: |
| 1428 | * table - array of tableName |
| 1429 | * when - BEFORE or AFTER |
| 1430 | * event - array of eventName - INSERT OR UPDATE OR DELETE |
| 1431 | * sql - array of statements optionally terminated with a ; |
| 1432 | * a statement can use the tokes {tableName} and {eventName} |
| 1433 | * to do token replacement with the table / event. This allows |
| 1434 | * templatizing logging and other hooks |
| 1435 | * @return mixed |
| 1436 | */ |
| 1437 | public static function triggerInfo(&$info, $tableName = NULL) { |
| 1438 | return self::singleton()->invoke(2, $info, $tableName, |
| 1439 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1440 | self::$_nullObject, |
| 1441 | 'civicrm_triggerInfo' |
| 1442 | ); |
| 1443 | } |
| 1444 | |
| 1445 | /** |
| 1446 | * This hook is called when a module-extension is installed. |
| 1447 | * Each module will receive hook_civicrm_install during its own installation (but not during the |
| 1448 | * installation of unrelated modules). |
| 1449 | */ |
| 1450 | public static function install() { |
| 1451 | return self::singleton()->invoke(0, self::$_nullObject, |
| 1452 | self::$_nullObject, self::$_nullObject, |
| 1453 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1454 | 'civicrm_install' |
| 1455 | ); |
| 1456 | } |
| 1457 | |
| 1458 | /** |
| 1459 | * This hook is called when a module-extension is uninstalled. |
| 1460 | * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the |
| 1461 | * uninstallation of unrelated modules). |
| 1462 | */ |
| 1463 | public static function uninstall() { |
| 1464 | return self::singleton()->invoke(0, self::$_nullObject, |
| 1465 | self::$_nullObject, self::$_nullObject, |
| 1466 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1467 | 'civicrm_uninstall' |
| 1468 | ); |
| 1469 | } |
| 1470 | |
| 1471 | /** |
| 1472 | * This hook is called when a module-extension is re-enabled. |
| 1473 | * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the |
| 1474 | * re-enablement of unrelated modules). |
| 1475 | */ |
| 1476 | public static function enable() { |
| 1477 | return self::singleton()->invoke(0, self::$_nullObject, |
| 1478 | self::$_nullObject, self::$_nullObject, |
| 1479 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1480 | 'civicrm_enable' |
| 1481 | ); |
| 1482 | } |
| 1483 | |
| 1484 | /** |
| 1485 | * This hook is called when a module-extension is disabled. |
| 1486 | * Each module will receive hook_civicrm_disable during its own disablement (but not during the |
| 1487 | * disablement of unrelated modules). |
| 1488 | */ |
| 1489 | public static function disable() { |
| 1490 | return self::singleton()->invoke(0, self::$_nullObject, |
| 1491 | self::$_nullObject, self::$_nullObject, |
| 1492 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1493 | 'civicrm_disable' |
| 1494 | ); |
| 1495 | } |
| 1496 | |
| 1497 | /** |
| 1498 | * @param $varType |
| 1499 | * @param $var |
| 1500 | * @param $object |
| 1501 | * |
| 1502 | * @return mixed |
| 1503 | */ |
| 1504 | public static function alterReportVar($varType, &$var, &$object) { |
| 1505 | return self::singleton()->invoke(3, $varType, $var, $object, |
| 1506 | self::$_nullObject, |
| 1507 | self::$_nullObject, self::$_nullObject, |
| 1508 | 'civicrm_alterReportVar' |
| 1509 | ); |
| 1510 | } |
| 1511 | |
| 1512 | /** |
| 1513 | * This hook is called to drive database upgrades for extension-modules. |
| 1514 | * |
| 1515 | * @param string $op |
| 1516 | * The type of operation being performed; 'check' or 'enqueue'. |
| 1517 | * @param CRM_Queue_Queue $queue |
| 1518 | * (for 'enqueue') the modifiable list of pending up upgrade tasks. |
| 1519 | * |
| 1520 | * @return bool|null |
| 1521 | * NULL, if $op is 'enqueue'. |
| 1522 | * TRUE, if $op is 'check' and upgrades are pending. |
| 1523 | * FALSE, if $op is 'check' and upgrades are not pending. |
| 1524 | */ |
| 1525 | public static function upgrade($op, CRM_Queue_Queue $queue = NULL) { |
| 1526 | return self::singleton()->invoke(2, $op, $queue, |
| 1527 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1528 | self::$_nullObject, |
| 1529 | 'civicrm_upgrade' |
| 1530 | ); |
| 1531 | } |
| 1532 | |
| 1533 | /** |
| 1534 | * This hook is called when an email has been successfully sent by CiviCRM, but not on an error. |
| 1535 | * |
| 1536 | * @param array $params |
| 1537 | * The mailing parameters. Array fields include: groupName, from, toName, |
| 1538 | * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers, |
| 1539 | * attachments (array) |
| 1540 | * |
| 1541 | * @return mixed |
| 1542 | */ |
| 1543 | public static function postEmailSend(&$params) { |
| 1544 | return self::singleton()->invoke(1, $params, |
| 1545 | self::$_nullObject, self::$_nullObject, |
| 1546 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1547 | 'civicrm_postEmailSend' |
| 1548 | ); |
| 1549 | } |
| 1550 | |
| 1551 | /** |
| 1552 | * This hook is called when Settings specifications are loaded. |
| 1553 | * |
| 1554 | * @param array $settingsFolders |
| 1555 | * List of paths from which to derive metadata |
| 1556 | * |
| 1557 | * @return mixed |
| 1558 | */ |
| 1559 | public static function alterSettingsFolders(&$settingsFolders) { |
| 1560 | return self::singleton()->invoke(1, $settingsFolders, |
| 1561 | self::$_nullObject, self::$_nullObject, |
| 1562 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1563 | 'civicrm_alterSettingsFolders' |
| 1564 | ); |
| 1565 | } |
| 1566 | |
| 1567 | /** |
| 1568 | * This hook is called when Settings have been loaded from the xml |
| 1569 | * It is an opportunity for hooks to alter the data |
| 1570 | * |
| 1571 | * @param array $settingsMetaData |
| 1572 | * Settings Metadata. |
| 1573 | * @param int $domainID |
| 1574 | * @param mixed $profile |
| 1575 | * |
| 1576 | * @return mixed |
| 1577 | */ |
| 1578 | public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) { |
| 1579 | return self::singleton()->invoke(3, $settingsMetaData, |
| 1580 | $domainID, $profile, |
| 1581 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1582 | 'civicrm_alterSettingsMetaData' |
| 1583 | ); |
| 1584 | } |
| 1585 | |
| 1586 | /** |
| 1587 | * This hook is called before running an api call. |
| 1588 | * |
| 1589 | * @param API_Wrapper[] $wrappers |
| 1590 | * (see CRM_Utils_API_ReloadOption as an example) |
| 1591 | * @param mixed $apiRequest |
| 1592 | * |
| 1593 | * @return null |
| 1594 | * The return value is ignored |
| 1595 | */ |
| 1596 | public static function apiWrappers(&$wrappers, $apiRequest) { |
| 1597 | return self::singleton() |
| 1598 | ->invoke(2, $wrappers, $apiRequest, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1599 | self::$_nullObject, 'civicrm_apiWrappers' |
| 1600 | ); |
| 1601 | } |
| 1602 | |
| 1603 | /** |
| 1604 | * This hook is called before running pending cron jobs. |
| 1605 | * |
| 1606 | * @param CRM_Core_JobManager $jobManager |
| 1607 | * |
| 1608 | * @return null |
| 1609 | * The return value is ignored. |
| 1610 | */ |
| 1611 | public static function cron($jobManager) { |
| 1612 | return self::singleton()->invoke(1, |
| 1613 | $jobManager, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1614 | 'civicrm_cron' |
| 1615 | ); |
| 1616 | } |
| 1617 | |
| 1618 | /** |
| 1619 | * This hook is called when loading CMS permissions; use this hook to modify |
| 1620 | * the array of system permissions for CiviCRM. |
| 1621 | * |
| 1622 | * @param array $permissions |
| 1623 | * Array of permissions. See CRM_Core_Permission::getCorePermissions() for |
| 1624 | * the format of this array. |
| 1625 | * |
| 1626 | * @return null |
| 1627 | * The return value is ignored |
| 1628 | */ |
| 1629 | public static function permission(&$permissions) { |
| 1630 | return self::singleton()->invoke(1, $permissions, |
| 1631 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1632 | 'civicrm_permission' |
| 1633 | ); |
| 1634 | } |
| 1635 | |
| 1636 | /** |
| 1637 | * @param CRM_Core_Exception Exception $exception |
| 1638 | * @param mixed $request |
| 1639 | * Reserved for future use. |
| 1640 | */ |
| 1641 | public static function unhandledException($exception, $request = NULL) { |
| 1642 | self::singleton() |
| 1643 | ->invoke(2, $exception, $request, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_unhandled_exception'); |
| 1644 | // == 4.4 == |
| 1645 | // $event = new stdClass(); |
| 1646 | // $event->exception = $exception; |
| 1647 | // CRM_Core_LegacyErrorHandler::handleException($event); |
| 1648 | |
| 1649 | // == 4.5+ == |
| 1650 | $event = new \Civi\Core\Event\UnhandledExceptionEvent($exception, self::$_nullObject); |
| 1651 | \Civi::service('dispatcher')->dispatch("hook_civicrm_unhandled_exception", $event); |
| 1652 | } |
| 1653 | |
| 1654 | /** |
| 1655 | * This hook is called for declaring managed entities via API. |
| 1656 | * |
| 1657 | * @param array[] $entityTypes |
| 1658 | * List of entity types; each entity-type is an array with keys: |
| 1659 | * - name: string, a unique short name (e.g. "ReportInstance") |
| 1660 | * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance") |
| 1661 | * - table: string, a SQL table name (e.g. "civicrm_report_instance") |
| 1662 | * |
| 1663 | * @return null |
| 1664 | * The return value is ignored |
| 1665 | */ |
| 1666 | public static function entityTypes(&$entityTypes) { |
| 1667 | return self::singleton()->invoke(1, $entityTypes, self::$_nullObject, self::$_nullObject, |
| 1668 | self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_entityTypes' |
| 1669 | ); |
| 1670 | } |
| 1671 | |
| 1672 | /** |
| 1673 | * This hook is called while preparing a profile form. |
| 1674 | * |
| 1675 | * @param string $name |
| 1676 | * @return mixed |
| 1677 | */ |
| 1678 | public static function buildProfile($name) { |
| 1679 | return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1680 | self::$_nullObject, self::$_nullObject, 'civicrm_buildProfile'); |
| 1681 | } |
| 1682 | |
| 1683 | /** |
| 1684 | * This hook is called while validating a profile form submission. |
| 1685 | * |
| 1686 | * @param string $name |
| 1687 | * @return mixed |
| 1688 | */ |
| 1689 | public static function validateProfile($name) { |
| 1690 | return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1691 | self::$_nullObject, self::$_nullObject, 'civicrm_validateProfile'); |
| 1692 | } |
| 1693 | |
| 1694 | /** |
| 1695 | * This hook is called processing a valid profile form submission. |
| 1696 | * |
| 1697 | * @param string $name |
| 1698 | * @return mixed |
| 1699 | */ |
| 1700 | public static function processProfile($name) { |
| 1701 | return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1702 | self::$_nullObject, self::$_nullObject, 'civicrm_processProfile'); |
| 1703 | } |
| 1704 | |
| 1705 | /** |
| 1706 | * This hook is called while preparing a read-only profile screen |
| 1707 | * |
| 1708 | * @param string $name |
| 1709 | * @return mixed |
| 1710 | */ |
| 1711 | public static function viewProfile($name) { |
| 1712 | return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1713 | self::$_nullObject, self::$_nullObject, 'civicrm_viewProfile'); |
| 1714 | } |
| 1715 | |
| 1716 | /** |
| 1717 | * This hook is called while preparing a list of contacts (based on a profile) |
| 1718 | * |
| 1719 | * @param string $name |
| 1720 | * @return mixed |
| 1721 | */ |
| 1722 | public static function searchProfile($name) { |
| 1723 | return self::singleton()->invoke(1, $name, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1724 | self::$_nullObject, self::$_nullObject, 'civicrm_searchProfile'); |
| 1725 | } |
| 1726 | |
| 1727 | /** |
| 1728 | * This hook is invoked when building a CiviCRM name badge. |
| 1729 | * |
| 1730 | * @param string $labelName |
| 1731 | * String referencing name of badge format. |
| 1732 | * @param object $label |
| 1733 | * Reference to the label object. |
| 1734 | * @param array $format |
| 1735 | * Array of format data. |
| 1736 | * @param array $participant |
| 1737 | * Array of participant values. |
| 1738 | * |
| 1739 | * @return null |
| 1740 | * the return value is ignored |
| 1741 | */ |
| 1742 | public static function alterBadge($labelName, &$label, &$format, &$participant) { |
| 1743 | return self::singleton() |
| 1744 | ->invoke(4, $labelName, $label, $format, $participant, self::$_nullObject, self::$_nullObject, 'civicrm_alterBadge'); |
| 1745 | } |
| 1746 | |
| 1747 | |
| 1748 | /** |
| 1749 | * This hook is called before encoding data in barcode. |
| 1750 | * |
| 1751 | * @param array $data |
| 1752 | * Associated array of values available for encoding. |
| 1753 | * @param string $type |
| 1754 | * Type of barcode, classic barcode or QRcode. |
| 1755 | * @param string $context |
| 1756 | * Where this hooks is invoked. |
| 1757 | * |
| 1758 | * @return mixed |
| 1759 | */ |
| 1760 | public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') { |
| 1761 | return self::singleton()->invoke(3, $data, $type, $context, self::$_nullObject, |
| 1762 | self::$_nullObject, self::$_nullObject, 'civicrm_alterBarcode'); |
| 1763 | } |
| 1764 | |
| 1765 | /** |
| 1766 | * Modify or replace the Mailer object used for outgoing mail. |
| 1767 | * |
| 1768 | * @param object $mailer |
| 1769 | * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory) |
| 1770 | * @param string $driver |
| 1771 | * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool") |
| 1772 | * @param array $params |
| 1773 | * The default mailer config options |
| 1774 | * |
| 1775 | * @return mixed |
| 1776 | * @see Mail::factory |
| 1777 | */ |
| 1778 | public static function alterMail(&$mailer, $driver, $params) { |
| 1779 | return self::singleton() |
| 1780 | ->invoke(3, $mailer, $driver, $params, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_alterMailer'); |
| 1781 | } |
| 1782 | |
| 1783 | /** |
| 1784 | * This hook is called while building the core search query, |
| 1785 | * so hook implementers can provide their own query objects which alters/extends core search. |
| 1786 | * |
| 1787 | * @param array $queryObjects |
| 1788 | * @param string $type |
| 1789 | * |
| 1790 | * @return mixed |
| 1791 | */ |
| 1792 | public static function queryObjects(&$queryObjects, $type = 'Contact') { |
| 1793 | return self::singleton() |
| 1794 | ->invoke(2, $queryObjects, $type, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_queryObjects'); |
| 1795 | } |
| 1796 | |
| 1797 | /** |
| 1798 | * This hook is called while viewing contact dashboard. |
| 1799 | * |
| 1800 | * @param array $availableDashlets |
| 1801 | * List of dashlets; each is formatted per api/v3/Dashboard |
| 1802 | * @param array $defaultDashlets |
| 1803 | * List of dashlets; each is formatted per api/v3/DashboardContact |
| 1804 | * |
| 1805 | * @return mixed |
| 1806 | */ |
| 1807 | public static function dashboard_defaults($availableDashlets, &$defaultDashlets) { |
| 1808 | return self::singleton() |
| 1809 | ->invoke(2, $availableDashlets, $defaultDashlets, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_dashboard_defaults'); |
| 1810 | } |
| 1811 | |
| 1812 | /** |
| 1813 | * This hook is called before a case merge (or a case reassign) |
| 1814 | * |
| 1815 | * @param int $mainContactId |
| 1816 | * @param int $mainCaseId |
| 1817 | * @param int $otherContactId |
| 1818 | * @param int $otherCaseId |
| 1819 | * @param bool $changeClient |
| 1820 | * |
| 1821 | * @return mixed |
| 1822 | */ |
| 1823 | public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) { |
| 1824 | return self::singleton() |
| 1825 | ->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self::$_nullObject, 'civicrm_pre_case_merge'); |
| 1826 | } |
| 1827 | |
| 1828 | /** |
| 1829 | * This hook is called after a case merge (or a case reassign) |
| 1830 | * |
| 1831 | * @param int $mainContactId |
| 1832 | * @param int $mainCaseId |
| 1833 | * @param int $otherContactId |
| 1834 | * @param int $otherCaseId |
| 1835 | * @param bool $changeClient |
| 1836 | * |
| 1837 | * @return mixed |
| 1838 | */ |
| 1839 | public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) { |
| 1840 | return self::singleton() |
| 1841 | ->invoke(5, $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self::$_nullObject, 'civicrm_post_case_merge'); |
| 1842 | } |
| 1843 | |
| 1844 | /** |
| 1845 | * Issue CRM-14276 |
| 1846 | * Add a hook for altering the display name |
| 1847 | * |
| 1848 | * hook_civicrm_contact_get_displayname(&$display_name, $objContact) |
| 1849 | * |
| 1850 | * @param string $displayName |
| 1851 | * @param int $contactId |
| 1852 | * @param object $dao |
| 1853 | * The contact object. |
| 1854 | * |
| 1855 | * @return mixed |
| 1856 | */ |
| 1857 | public static function alterDisplayName(&$displayName, $contactId, $dao) { |
| 1858 | return self::singleton()->invoke(3, |
| 1859 | $displayName, $contactId, $dao, self::$_nullObject, self::$_nullObject, |
| 1860 | self::$_nullObject, 'civicrm_contact_get_displayname' |
| 1861 | ); |
| 1862 | } |
| 1863 | |
| 1864 | /** |
| 1865 | * EXPERIMENTAL: This hook allows one to register additional Angular modules |
| 1866 | * |
| 1867 | * @param array $angularModules |
| 1868 | * List of modules. |
| 1869 | * @return null |
| 1870 | * the return value is ignored |
| 1871 | * |
| 1872 | * @code |
| 1873 | * function mymod_civicrm_angularModules(&$angularModules) { |
| 1874 | * $angularModules['myAngularModule'] = array( |
| 1875 | * 'ext' => 'org.example.mymod', |
| 1876 | * 'js' => array('js/myAngularModule.js'), |
| 1877 | * ); |
| 1878 | * $angularModules['myBigAngularModule'] = array( |
| 1879 | * 'ext' => 'org.example.mymod', |
| 1880 | * 'js' => array('js/part1.js', 'js/part2.js'), |
| 1881 | * 'css' => array('css/myAngularModule.css'), |
| 1882 | * 'partials' => array('partials/myBigAngularModule'), |
| 1883 | * ); |
| 1884 | * } |
| 1885 | * @endcode |
| 1886 | */ |
| 1887 | public static function angularModules(&$angularModules) { |
| 1888 | return self::singleton()->invoke(1, $angularModules, |
| 1889 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1890 | 'civicrm_angularModules' |
| 1891 | ); |
| 1892 | } |
| 1893 | |
| 1894 | /** |
| 1895 | * This hook fires whenever a record in a case changes. |
| 1896 | * |
| 1897 | * @param \Civi\CCase\Analyzer $analyzer |
| 1898 | * A bundle of data about the case (such as the case and activity records). |
| 1899 | */ |
| 1900 | public static function caseChange(\Civi\CCase\Analyzer $analyzer) { |
| 1901 | $event = new \Civi\CCase\Event\CaseChangeEvent($analyzer); |
| 1902 | \Civi::service('dispatcher')->dispatch("hook_civicrm_caseChange", $event); |
| 1903 | |
| 1904 | self::singleton()->invoke(1, $analyzer, |
| 1905 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1906 | 'civicrm_caseChange' |
| 1907 | ); |
| 1908 | } |
| 1909 | |
| 1910 | /** |
| 1911 | * Generate a default CRUD URL for an entity. |
| 1912 | * |
| 1913 | * @param array $spec |
| 1914 | * With keys:. |
| 1915 | * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE |
| 1916 | * - entity_table: string |
| 1917 | * - entity_id: int |
| 1918 | * @param CRM_Core_DAO $bao |
| 1919 | * @param array $link |
| 1920 | * To define the link, add these keys to $link:. |
| 1921 | * - title: string |
| 1922 | * - path: string |
| 1923 | * - query: array |
| 1924 | * - url: string (used in lieu of "path"/"query") |
| 1925 | * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false |
| 1926 | * @return mixed |
| 1927 | */ |
| 1928 | public static function crudLink($spec, $bao, &$link) { |
| 1929 | return self::singleton()->invoke(3, $spec, $bao, $link, |
| 1930 | self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1931 | 'civicrm_crudLink' |
| 1932 | ); |
| 1933 | } |
| 1934 | |
| 1935 | /** |
| 1936 | * Modify the CiviCRM container - add new services, parameters, extensions, etc. |
| 1937 | * |
| 1938 | * @code |
| 1939 | * use Symfony\Component\Config\Resource\FileResource; |
| 1940 | * use Symfony\Component\DependencyInjection\Definition; |
| 1941 | * |
| 1942 | * function mymodule_civicrm_container($container) { |
| 1943 | * $container->addResource(new FileResource(__FILE__)); |
| 1944 | * $container->setDefinition('mysvc', new Definition('My\Class', array())); |
| 1945 | * } |
| 1946 | * @endcode |
| 1947 | * |
| 1948 | * Tip: The container configuration will be compiled/cached. The default cache |
| 1949 | * behavior is aggressive. When you first implement the hook, be sure to |
| 1950 | * flush the cache. Additionally, you should relax caching during development. |
| 1951 | * In `civicrm.settings.php`, set define('CIVICRM_CONTAINER_CACHE', 'auto'). |
| 1952 | * |
| 1953 | * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container |
| 1954 | * @see http://symfony.com/doc/current/components/dependency_injection/index.html |
| 1955 | */ |
| 1956 | public static function container(\Symfony\Component\DependencyInjection\ContainerBuilder $container) { |
| 1957 | self::singleton()->invoke(1, $container, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_container'); |
| 1958 | } |
| 1959 | |
| 1960 | /** |
| 1961 | * @param array <CRM_Core_FileSearchInterface> $fileSearches |
| 1962 | * @return mixed |
| 1963 | */ |
| 1964 | public static function fileSearches(&$fileSearches) { |
| 1965 | return self::singleton()->invoke(1, $fileSearches, |
| 1966 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1967 | 'civicrm_fileSearches' |
| 1968 | ); |
| 1969 | } |
| 1970 | |
| 1971 | /** |
| 1972 | * Check system status. |
| 1973 | * |
| 1974 | * @param array $messages |
| 1975 | * Array<CRM_Utils_Check_Message>. A list of messages regarding system status. |
| 1976 | * @return mixed |
| 1977 | */ |
| 1978 | public static function check(&$messages) { |
| 1979 | return self::singleton() |
| 1980 | ->invoke(1, $messages, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_check'); |
| 1981 | } |
| 1982 | |
| 1983 | /** |
| 1984 | * This hook is called when a query string of the CSV Batch export is generated. |
| 1985 | * |
| 1986 | * @param string $query |
| 1987 | * |
| 1988 | * @return mixed |
| 1989 | */ |
| 1990 | public static function batchQuery(&$query) { |
| 1991 | return self::singleton()->invoke(1, $query, self::$_nullObject, |
| 1992 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 1993 | 'civicrm_batchQuery' |
| 1994 | ); |
| 1995 | } |
| 1996 | |
| 1997 | /** |
| 1998 | * This hook is called when the entries of the CSV Batch export are mapped. |
| 1999 | * |
| 2000 | * @param array $results |
| 2001 | * @param array $items |
| 2002 | * |
| 2003 | * @return mixed |
| 2004 | */ |
| 2005 | public static function batchItems(&$results, &$items) { |
| 2006 | return self::singleton()->invoke(2, $results, $items, |
| 2007 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 2008 | 'civicrm_batchItems' |
| 2009 | ); |
| 2010 | } |
| 2011 | |
| 2012 | /** |
| 2013 | * This hook is called when core resources are being loaded |
| 2014 | * |
| 2015 | * @see CRM_Core_Resources::coreResourceList |
| 2016 | * |
| 2017 | * @param array $list |
| 2018 | * @param string $region |
| 2019 | */ |
| 2020 | public static function coreResourceList(&$list, $region) { |
| 2021 | // First allow the cms integration to add to the list |
| 2022 | CRM_Core_Config::singleton()->userSystem->appendCoreResources($list); |
| 2023 | |
| 2024 | self::singleton()->invoke(2, $list, $region, |
| 2025 | self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, |
| 2026 | 'civicrm_coreResourceList' |
| 2027 | ); |
| 2028 | } |
| 2029 | |
| 2030 | } |