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