-
-
Notifications
You must be signed in to change notification settings - Fork 814
/
Hook.php
3258 lines (3082 loc) · 111 KB
/
Hook.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC. All rights reserved. |
| |
| This work is published under the GNU AGPLv3 license with some |
| permitted exceptions and without any warranty. For full license |
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CiviCRM_Hook
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/
abstract class CRM_Utils_Hook {
// Allowed values for dashboard hook content placement
// Default - place content below activity list
const DASHBOARD_BELOW = 1;
// Place content above activity list
const DASHBOARD_ABOVE = 2;
// Don't display activity list at all
const DASHBOARD_REPLACE = 3;
// by default - place content below existing content
const SUMMARY_BELOW = 1;
// place hook content above
const SUMMARY_ABOVE = 2;
/**
*create your own summaries
*/
const SUMMARY_REPLACE = 3;
/**
* Object to pass when an object is required to be passed by params.
*
* This is supposed to be a convenience but note that it is a bad
* pattern as it can get contaminated & result in hard-to-diagnose bugs.
*
* @var null
* @deprecated
*/
public static $_nullObject = NULL;
/**
* We only need one instance of this object. So we use the singleton
* pattern and cache the instance in this variable
*
* @var CRM_Utils_Hook
*/
static private $_singleton;
/**
* @var bool
*/
private $commonIncluded = FALSE;
/**
* @var array|string
*/
private $commonCiviModules = [];
/**
* @var CRM_Utils_Cache_Interface
*/
protected $cache;
/**
* Constructor and getter for the singleton instance.
*
* @param bool $fresh
*
* @return CRM_Utils_Hook
* An instance of $config->userHookClass
*/
public static function singleton($fresh = FALSE): CRM_Utils_Hook {
if (self::$_singleton == NULL || $fresh) {
$config = CRM_Core_Config::singleton();
$class = $config->userHookClass;
self::$_singleton = new $class();
}
return self::$_singleton;
}
/**
* CRM_Utils_Hook constructor.
*
* @throws CRM_Core_Exception
*/
public function __construct() {
$this->cache = CRM_Utils_Cache::create([
'name' => 'hooks',
'type' => ['ArrayCache'],
'prefetch' => 1,
]);
}
/**
* Invoke a hook through the UF/CMS hook system and the extension-hook
* system.
*
* @param int $numParams
* Number of parameters to pass to the hook.
* @param mixed $arg1
* Parameter to be passed to the hook.
* @param mixed $arg2
* Parameter to be passed to the hook.
* @param mixed $arg3
* Parameter to be passed to the hook.
* @param mixed $arg4
* Parameter to be passed to the hook.
* @param mixed $arg5
* Parameter to be passed to the hook.
* @param mixed $arg6
* Parameter to be passed to the hook.
* @param string $fnSuffix
* Function suffix, this is effectively the hook name.
*
* @return mixed
*/
abstract public function invokeViaUF(
$numParams,
&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
$fnSuffix
);
/**
* Invoke a hook.
*
* This is a transitional adapter. It supports the legacy syntax
* but also accepts enough information to support Symfony Event
* dispatching.
*
* @param array $names
* (Recommended) Array of parameter names, in order.
* Using an array is recommended because it enables full
* event-broadcasting behaviors.
* (Legacy) Number of parameters to pass to the hook.
* This is provided for transitional purposes.
* @param mixed $arg1
* @param mixed $arg2
* @param mixed $arg3
* @param mixed $arg4
* @param mixed $arg5
* @param mixed $arg6
* @param mixed $fnSuffix
* @return mixed
*/
public function invoke(
$names,
&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
$fnSuffix
) {
if (!is_array($names)) {
// We were called with the old contract wherein $names is actually an int.
// Symfony dispatcher requires some kind of name.
CRM_Core_Error::deprecatedWarning("hook_$fnSuffix should be updated to pass an array of parameter names to CRM_Utils_Hook::invoke().");
$compatNames = ['arg1', 'arg2', 'arg3', 'arg4', 'arg5', 'arg6'];
$names = array_slice($compatNames, 0, (int) $names);
}
$event = \Civi\Core\Event\GenericHookEvent::createOrdered(
$names,
[&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6]
);
Civi::dispatcher()->dispatch('hook_' . $fnSuffix, $event);
return $event->getReturnValues();
}
/**
* @param array $numParams
* @param $arg1
* @param $arg2
* @param $arg3
* @param $arg4
* @param $arg5
* @param $arg6
* @param $fnSuffix
* @param $fnPrefix
*
* @return array|bool
* @throws CRM_Core_Exception
*/
public function commonInvoke(
$numParams,
&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
$fnSuffix, $fnPrefix
) {
$this->commonBuildModuleList($fnPrefix);
return $this->runHooks($this->commonCiviModules, $fnSuffix,
$numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
);
}
/**
* Build the list of modules to be processed for hooks.
*
* @param string $fnPrefix
*/
public function commonBuildModuleList($fnPrefix) {
if (!$this->commonIncluded) {
// include external file
$this->commonIncluded = TRUE;
$config = CRM_Core_Config::singleton();
if (!empty($config->customPHPPathDir)) {
$civicrmHooksFile = CRM_Utils_File::addTrailingSlash($config->customPHPPathDir) . 'civicrmHooks.php';
if (file_exists($civicrmHooksFile)) {
@include_once $civicrmHooksFile;
}
}
if (!empty($fnPrefix)) {
$this->commonCiviModules[$fnPrefix] = $fnPrefix;
}
$this->requireCiviModules($this->commonCiviModules);
}
}
/**
* Run hooks.
*
* @param array $civiModules
* @param string $fnSuffix
* @param int $numParams
* @param mixed $arg1
* @param mixed $arg2
* @param mixed $arg3
* @param mixed $arg4
* @param mixed $arg5
* @param mixed $arg6
*
* @return array|bool
* @throws \CRM_Core_Exception
*/
public function runHooks(
$civiModules, $fnSuffix, $numParams,
&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
) {
// $civiModules is *not* passed by reference because runHooks
// must be reentrant. PHP is finicky about running
// multiple loops over the same variable. The circumstances
// to reproduce the issue are pretty intricate.
$result = [];
$fnNames = $this->cache->get($fnSuffix);
if (!is_array($fnNames)) {
$fnNames = [];
if ($civiModules !== NULL) {
foreach ($civiModules as $module) {
$fnName = "{$module}_{$fnSuffix}";
if (function_exists($fnName)) {
$fnNames[] = $fnName;
}
}
$this->cache->set($fnSuffix, $fnNames);
}
}
foreach ($fnNames as $fnName) {
switch ($numParams) {
case 0:
$fResult = $fnName();
break;
case 1:
$fResult = $fnName($arg1);
break;
case 2:
$fResult = $fnName($arg1, $arg2);
break;
case 3:
$fResult = $fnName($arg1, $arg2, $arg3);
break;
case 4:
$fResult = $fnName($arg1, $arg2, $arg3, $arg4);
break;
case 5:
$fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
break;
case 6:
$fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
break;
default:
throw new CRM_Core_Exception(ts('Invalid hook invocation'));
}
if (!empty($fResult) && is_array($fResult)) {
$result = array_merge($result, $fResult);
}
}
return empty($result) ? TRUE : $result;
}
/**
* @param $moduleList
*/
public function requireCiviModules(&$moduleList) {
foreach ($GLOBALS['CIVICRM_FORCE_MODULES'] ?? [] as $prefix) {
$moduleList[$prefix] = $prefix;
}
$civiModules = CRM_Core_PseudoConstant::getModuleExtensions();
foreach ($civiModules as $civiModule) {
if (!file_exists($civiModule['filePath'] ?? '')) {
CRM_Core_Session::setStatus(
ts('Error loading module file (%1). Please restore the file or disable the module.',
[1 => $civiModule['filePath']]),
ts('Warning'), 'error');
continue;
}
include_once $civiModule['filePath'];
$moduleList[$civiModule['prefix']] = $civiModule['prefix'];
}
}
/**
* This hook is called before a db write on some core objects.
* This hook does not allow the abort of the operation
*
* @param string $op
* The type of operation being performed.
* @param string $objectName
* The name of the object.
* @param int|null $id
* The object id if available.
* @param array $params
* The parameters used for object creation / editing.
*
* @return null
* the return value is ignored
*/
public static function pre($op, $objectName, $id, &$params = []) {
$event = new \Civi\Core\Event\PreEvent($op, $objectName, $id, $params);
Civi::dispatcher()->dispatch('hook_civicrm_pre', $event);
return $event->getReturnValues();
}
/**
* This hook is called after a db write on some core objects.
*
* @param string $op
* The type of operation being performed.
* @param string $objectName
* The name of the object.
* @param int $objectId
* The unique identifier for the object.
* @param object $objectRef
* The reference to the object if available.
* @param array $params
* Original params used, if available
*
* @return mixed
* based on op. pre-hooks return a boolean or
* an error message which aborts the operation
*/
public static function post($op, $objectName, $objectId, &$objectRef = NULL, $params = NULL) {
$event = new \Civi\Core\Event\PostEvent($op, $objectName, $objectId, $objectRef, $params);
Civi::dispatcher()->dispatch('hook_civicrm_post', $event);
return $event->getReturnValues();
}
/**
* This hook is equivalent to post(), except that it is guaranteed to run
* outside of any SQL transaction. The objectRef is not modifiable.
*
* This hook is defined for two cases:
*
* 1. If the original action runs within a transaction, then the hook fires
* after the transaction commits.
* 2. If the original action runs outside a transaction, then the data was
* committed immediately, and we can run the hook immediately.
*
* @param string $op
* The type of operation being performed.
* @param string $objectName
* The name of the object.
* @param int $objectId
* The unique identifier for the object.
* @param object $objectRef
* The reference to the object if available.
*
* @return mixed
* based on op. pre-hooks return a boolean or
* an error message which aborts the operation
*/
public static function postCommit($op, $objectName, $objectId, $objectRef = NULL) {
$event = new \Civi\Core\Event\PostEvent($op, $objectName, $objectId, $objectRef);
Civi::dispatcher()->dispatch('hook_civicrm_postCommit', $event);
return $event->getReturnValues();
}
/**
* This hook retrieves links from other modules and injects it into.
* the view contact tabs
*
* @param string $op
* The type of operation being performed.
* @param string $objectName
* The name of the object. This is generally a CamelCase entity (eg `Contact` or `Activity`).
* Historical exceptions: 'CRM_Core_BAO_LocationType', 'CRM_Core_BAO_MessageTemplate'
* @param int $objectId
* The unique identifier for the object.
* @param array $links
* (optional) the links array (introduced in v3.2).
* Each of the links may have properties:
* - 'name' (string): the link text
* - 'url' (string): the link URL base path (like civicrm/contact/view, and fillable from $values)
* - 'qs' (string|array): the link URL query parameters to be used by sprintf() with $values (like reset=1&cid=%%id%% when $values['id'] is the contact ID)
* - 'title' (string) (optional): the text that appears when hovering over the link
* - 'extra' (optional): additional attributes for the <a> tag (fillable from $values)
* - 'bit' (optional): a binary number that will be filtered by $mask (sending nothing as $links['bit'] means the link will always display)
* - 'ref' (optional, recommended): a CSS class to apply to the <a> tag.
* - 'class' (string): Optional list of CSS classes
* - 'weight' (int): Weight is used to order the links. If not set 0 will be used but e-notices could occur. This was introduced in CiviCRM 5.63 so it will not have any impact on earlier versions of CiviCRM.
* - 'accessKey' (string) (optional): HTML access key. Single letter or empty string.
* - 'icon' (string) (optional): FontAwesome class name
*
* Depending on the specific screen, some fields (e.g. `icon`) may be ignored.
* If you have any idea of a clearer rule, then please update the docs.
* @param int|null $mask
* (optional) the bitmask to show/hide links.
* @param array $values
* (optional) the values to fill the links.
*
* @return null
* the return value is ignored
*/
public static function links($op, $objectName, $objectId, &$links, &$mask = NULL, &$values = []) {
return self::singleton()->invoke(['op', 'objectName', 'objectId', 'links', 'mask', 'values'], $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
}
/**
* Alter the contents of a resource bundle (ie a collection of JS/CSS/etc).
*
* TIP: $bundle->add*() and $bundle->filter() should be useful for
* adding/removing/updating items.
*
* @param CRM_Core_Resources_Bundle $bundle
* @return null
* @see CRM_Core_Resources_CollectionInterface::add()
* @see CRM_Core_Resources_CollectionInterface::filter()
*/
public static function alterBundle($bundle) {
$null = NULL;
return self::singleton()
->invoke(['bundle'], $bundle, $null, $null, $null, $null, $null, 'civicrm_alterBundle');
}
/**
* This hook is invoked during the CiviCRM form preProcess phase.
*
* @param string $formName
* The name of the form.
* @param CRM_Core_Form $form
* Reference to the form object.
*
* @return null
* the return value is ignored
*/
public static function preProcess($formName, &$form) {
$null = NULL;
return self::singleton()
->invoke(['formName', 'form'], $formName, $form, $null, $null, $null, $null, 'civicrm_preProcess');
}
/**
* This hook is invoked when building a CiviCRM form. This hook should also
* be used to set the default values of a form element
*
* @param string $formName
* The name of the form.
* @param CRM_Core_Form $form
* Reference to the form object.
*
* @return null
* the return value is ignored
*/
public static function buildForm($formName, &$form) {
$null = NULL;
return self::singleton()->invoke(['formName', 'form'], $formName, $form,
$null, $null, $null, $null,
'civicrm_buildForm'
);
}
/**
* This hook is invoked when a CiviCRM form is submitted. If the module has injected
* any form elements, this hook should save the values in the database
*
* @param string $formName
* The name of the form.
* @param CRM_Core_Form $form
* Reference to the form object.
*
* @return null
* the return value is ignored
*/
public static function postProcess($formName, &$form) {
$null = NULL;
return self::singleton()->invoke(['formName', 'form'], $formName, $form,
$null, $null, $null, $null,
'civicrm_postProcess'
);
}
/**
* This hook is invoked during all CiviCRM form validation. An array of errors
* detected is returned. Else we assume validation succeeded.
*
* @param string $formName
* The name of the form.
* @param array &$fields the POST parameters as filtered by QF
* @param array &$files the FILES parameters as sent in by POST
* @param CRM_Core_Form &$form the form object
* @param array &$errors the array of errors.
*
* @return mixed
* formRule hooks return a boolean or
* an array of error messages which display a QF Error
*/
public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
$null = NULL;
return self::singleton()
->invoke(['formName', 'fields', 'files', 'form', 'errors'],
$formName, $fields, $files, $form, $errors, $null, 'civicrm_validateForm');
}
/**
* This hook is called after a db write on a custom table.
*
* @param string $op
* The type of operation being performed.
* @param int $groupID
* The custom group ID.
* @param int $entityID
* The entityID of the row in the custom table.
* @param array $params
* The parameters that were sent into the calling function.
*
* @return null
* the return value is ignored
*/
public static function custom(string $op, int $groupID, int $entityID, &$params) {
$null = NULL;
return self::singleton()
->invoke(['op', 'groupID', 'entityID', 'params'], $op, $groupID, $entityID, $params, $null, $null, 'civicrm_custom');
}
/**
* This hook is called before a db write on a custom table.
*
* @param string $op
* The type of operation being performed.
* @param int $groupID
* The custom group ID.
* @param int $entityID
* The entityID of the row in the custom table.
* @param array $params
* The parameters that were sent into the calling function.
*
* @return null
* the return value is ignored
*/
public static function customPre(string $op, int $groupID, int $entityID, array &$params) {
$null = NULL;
return self::singleton()
->invoke(['op', 'groupID', 'entityID', 'params'], $op, $groupID, $entityID, $params, $null, $null, 'civicrm_customPre');
}
/**
* This hook is called when composing the ACL where clause to restrict
* visibility of contacts to the logged in user
*
* @param int $type
* Action being taken (CRM_Core_Permission::VIEW or CRM_Core_Permission::EDIT)
* @param array $tables
* (reference ) add the tables that are needed for the select clause.
* @param array $whereTables
* (reference ) add the tables that are needed for the where clause.
* @param int $contactID
* The contactID for whom the check is made.
* @param string $where
* The currrent where clause.
*
* @return null
* the return value is ignored
*/
public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
$null = NULL;
return self::singleton()
->invoke(['type', 'tables', 'whereTables', 'contactID', 'where'], $type, $tables, $whereTables, $contactID, $where, $null, 'civicrm_aclWhereClause');
}
/**
* Called when restricting access to contact-groups or custom_field-groups or profile-groups.
*
* Hook subscribers should alter the array of $currentGroups by reference.
*
* @param int $type
* Action type being performed e.g. CRM_ACL_API::VIEW or CRM_ACL_API::EDIT
* @param int $contactID
* User contactID for whom the check is made.
* @param string $tableName
* Table name of group, e.g. 'civicrm_group' or 'civicrm_uf_group' or 'civicrm_custom_group'.
* @param array $allGroups
* All groups from the above table, keyed by id.
* @param int[] $currentGroups
* Ids of allowed groups (corresponding to array keys of $allGroups) to be altered by reference.
*
* @return null
* the return value is ignored
*/
public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
$null = NULL;
// Legacy support for hooks that still expect 'civicrm_group' to be 'civicrm_saved_search'
// This was changed in 5.64
if ($tableName === 'civicrm_group') {
$initialValue = $currentGroups;
$legacyTableName = 'civicrm_saved_search';
self::singleton()
->invoke(['type', 'contactID', 'tableName', 'allGroups', 'currentGroups'], $type, $contactID, $legacyTableName, $allGroups, $currentGroups, $null, 'civicrm_aclGroup');
if ($initialValue != $currentGroups) {
CRM_Core_Error::deprecatedWarning('Since 5.64 hook_civicrm_aclGroup passes "civicrm_group" instead of "civicrm_saved_search" for the $tableName when referring to Groups. Hook listeners should be updated.');
}
}
return self::singleton()
->invoke(['type', 'contactID', 'tableName', 'allGroups', 'currentGroups'], $type, $contactID, $tableName, $allGroups, $currentGroups, $null, 'civicrm_aclGroup');
}
/**
* @param string|CRM_Core_DAO $entity
* @param array $clauses
* @param int|null $userId
* User contact id. NULL == current user.
* @param array $conditions
* Values from WHERE or ON clause
*/
public static function selectWhereClause($entity, array &$clauses, ?int $userId = NULL, array $conditions = []): void {
$entityName = is_object($entity) ? CRM_Core_DAO_AllCoreTables::getEntityNameForClass(get_class($entity)) : $entity;
$null = NULL;
$userId ??= (int) CRM_Core_Session::getLoggedInContactID();
self::singleton()->invoke(['entity', 'clauses', 'userId', 'conditions'],
$entityName, $clauses, $userId, $conditions,
$null, $null,
'civicrm_selectWhereClause'
);
}
/**
* This hook is called when building the menu table.
*
* @param array $files
* The current set of files to process.
*
* @return null
* the return value is ignored
*/
public static function xmlMenu(&$files) {
$null = NULL;
return self::singleton()->invoke(['files'], $files,
$null, $null, $null, $null, $null,
'civicrm_xmlMenu'
);
}
/**
* This hook is called when building the menu table.
*
* @param array $items
* List of records to include in menu table.
* @return null
* the return value is ignored
*/
public static function alterMenu(&$items) {
$null = NULL;
return self::singleton()->invoke(['items'], $items,
$null, $null, $null, $null, $null,
'civicrm_alterMenu'
);
}
/**
* A theme is a set of CSS files which are loaded on CiviCRM pages. To register a new
* theme, add it to the $themes array. Use these properties:
*
* - ext: string (required)
* The full name of the extension which defines the theme.
* Ex: "org.civicrm.themes.greenwich".
* - title: string (required)
* Visible title.
* - help: string (optional)
* Description of the theme's appearance.
* - url_callback: mixed (optional)
* A function ($themes, $themeKey, $cssExt, $cssFile) which returns the URL(s) for a CSS resource.
* Returns either an array of URLs or PASSTHRU.
* Ex: \Civi\Core\Themes\Resolvers::simple (default)
* Ex: \Civi\Core\Themes\Resolvers::none
* - prefix: string (optional)
* A prefix within the extension folder to prepend to the file name.
* - search_order: array (optional)
* A list of themes to search.
* Generally, the last theme should be "*fallback*" (Civi\Core\Themes::FALLBACK).
* - excludes: array (optional)
* A list of files (eg "civicrm:css/bootstrap.css" or "$ext:$file") which should never
* be returned (they are excluded from display).
*
* @param array $themes
* List of themes, keyed by name.
* @return null
* the return value is ignored
*/
public static function themes(&$themes) {
$null = NULL;
return self::singleton()->invoke(['themes'], $themes,
$null, $null, $null, $null, $null,
'civicrm_themes'
);
}
/**
* The activeTheme hook determines which theme is active.
*
* @param string $theme
* The identifier for the theme. Alterable.
* Ex: 'greenwich'.
* @param array $context
* Information about the current page-request. Includes some mix of:
* - page: the relative path of the current Civi page (Ex: 'civicrm/dashboard').
* - themes: an instance of the Civi\Core\Themes service.
* @return null
* the return value is ignored
*/
public static function activeTheme(&$theme, $context) {
$null = NULL;
return self::singleton()->invoke(['theme', 'context'], $theme, $context,
$null, $null, $null, $null,
'civicrm_activeTheme'
);
}
/**
* This hook is called for declaring managed entities via API.
*
* @code
* // Example: Optimal skeleton for backward/forward compatibility
* function example_civicrm_managed(&$entities, ?array $modules = NULL) {
* if ($modules !== NULL && !in_array(E::LONG_NAME, $modules, TRUE)) {
* return;
* }
* $entities[] = [
* 'module' => E::LONG_NAME,
* 'name' => 'my_option_value',
* 'entity' => 'OptionValue',
* 'params' => [...],
* ];
* }
* @endCode
*
* @param array $entities
* List of pending entities. Each entity is an array with keys:
* + '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")
* + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
* + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
* + 'params': array, the entity data as supported by the CiviCRM API
* + 'update' (v4.5+): string, a policy which describes when to update records
* - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
* - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
* + '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)
* - 'always' (default): always delete orphaned records
* - 'never': never delete orphaned records
* - '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.)
* @param array|NULL $modules
* (Added circa v5.50) If given, only report entities related to $modules. NULL is a wildcard ("all modules").
*
* This parameter is _advisory_ and is not supplied on older versions.
* Listeners SHOULD self-censor (only report entities which match the filter).
* However, all pre-existing listeners were unaware of this option, and they WILL over-report.
* Over-reported data will be discarded.
* @return null
* the return value is ignored
*/
public static function managed(array &$entities, ?array $modules = NULL) {
$null = NULL;
self::singleton()->invoke(['entities', 'modules'], $entities, $modules,
$null, $null, $null, $null,
'civicrm_managed'
);
if ($modules) {
$entities = array_filter($entities, function($entity) use ($modules) {
return in_array($entity['module'], $modules, TRUE);
});
}
}
/**
* This hook is called when rendering the dashboard (q=civicrm/dashboard)
*
* @param int $contactID
* The contactID for whom the dashboard is being rendered.
* @param int $contentPlacement
* (output parameter) where should the hook content be displayed.
* relative to the activity list
*
* @return string
* the html snippet to include in the dashboard
*/
public static function dashboard($contactID, &$contentPlacement = self::DASHBOARD_BELOW) {
$null = NULL;
$retval = self::singleton()->invoke(['contactID', 'contentPlacement'], $contactID, $contentPlacement,
$null, $null, $null, $null,
'civicrm_dashboard'
);
/*
* Note we need this seemingly unnecessary code because in the event that the implementation
* of the hook declares the second parameter but doesn't set it, then it comes back unset even
* though we have a default value in this function's declaration above.
*/
if (!isset($contentPlacement)) {
$contentPlacement = self::DASHBOARD_BELOW;
}
return $retval;
}
/**
* This hook is called before storing recently viewed items.
*
* @param array $recentArray
* An array of recently viewed or processed items, for in place modification.
*
* @return array
*/
public static function recent(&$recentArray) {
$null = NULL;
return self::singleton()->invoke(['recentArray'], $recentArray,
$null, $null, $null, $null, $null,
'civicrm_recent'
);
}
/**
* Determine how many other records refer to a given record.
*
* @param CRM_Core_DAO $dao
* The item for which we want a reference count.
* @param array $refCounts
* Each item in the array is an Array with keys:
* - name: string, eg "sql:civicrm_email:contact_id"
* - type: string, eg "sql"
* - count: int, eg "5" if there are 5 email addresses that refer to $dao
*
* @return mixed
* Return is not really intended to be used.
*/
public static function referenceCounts($dao, &$refCounts) {
$null = NULL;
return self::singleton()->invoke(['dao', 'refCounts'], $dao, $refCounts,
$null, $null, $null, $null,
'civicrm_referenceCounts'
);
}
/**
* This hook is called when building the amount structure for a Contribution or Event Page.
*
* @param int $pageType
* Is this a contribution or event page.
* @param CRM_Core_Form $form
* Reference to the form object.
* @param array $amount
* The amount structure to be displayed.
*
* @return null
*/
public static function buildAmount($pageType, &$form, &$amount) {
$null = NULL;
return self::singleton()->invoke(['pageType', 'form', 'amount'], $pageType, $form, $amount, $null,
$null, $null, 'civicrm_buildAmount');
}
/**
* This hook is called when building the state list for a particular country.
*
* @param array $countryID
* The country id whose states are being selected.
* @param $states
*
* @return null
*/
public static function buildStateProvinceForCountry($countryID, &$states) {
$null = NULL;
return self::singleton()->invoke(['countryID', 'states'], $countryID, $states,
$null, $null, $null, $null,
'civicrm_buildStateProvinceForCountry'
);
}
/**
* This hook is called when rendering the tabs used for events and potentially
* contribution pages, etc.
*
* @param string $tabsetName
* Name of the screen or visual element.
* @param array $tabs
* Tabs that will be displayed.
* @param array $context
* Extra data about the screen or context in which the tab is used.
*
* @return null
*/
public static function tabset($tabsetName, &$tabs, $context) {
$null = NULL;
return self::singleton()->invoke(['tabsetName', 'tabs', 'context'], $tabsetName, $tabs,
$context, $null, $null, $null, 'civicrm_tabset'
);
}
/**
* This hook is called when sending an email / printing labels
*
* @param array $tokens
* The list of tokens that can be used for the contact.
*
* @param bool $squashDeprecation
* Suppress the deprecation message - this should ONLY EVER BE CALLED
* from the backward compatibilty adapter in `evaluateLegacyHookTokens`.
* We are deprecating both this function, and the implementation of the hook
* but for now we ensure that the hook is still rendered for
* sites that implement it, via the TokenProcessor methodology
* https://docs.civicrm.org/dev/en/latest/framework/token/#compose-batch
*
* @return null
*/
public static function tokens(&$tokens, bool $squashDeprecation = FALSE) {
$null = NULL;
if (!$squashDeprecation) {
CRM_Core_Error::deprecatedFunctionWarning('call the token processor');
}
return self::singleton()->invoke(['tokens'], $tokens,
$null, $null, $null, $null, $null, 'civicrm_tokens'
);
}
/**
* This hook allows modification of the admin panels
*
* @param array $panels
* Associated array of admin panels
*
* @return mixed
*/
public static function alterAdminPanel(&$panels) {
$null = NULL;
return self::singleton()->invoke(['panels'], $panels,
$null, $null, $null, $null, $null,
'civicrm_alterAdminPanel'
);
}
/**
* This hook is called when sending an email / printing labels to get the values for all the
* tokens returned by the 'tokens' hook
*
* @param array $details
* The array to store the token values indexed by contactIDs.
* @param array $contactIDs
* An array of contactIDs.
* @param null $jobID
* The jobID if this is associated with a CiviMail mailing.
* @param array $tokens
* The list of tokens associated with the content.
* @param null $className
* The top level className from where the hook is invoked.
* @param bool $squashDeprecation
* Suppress the deprecation message - this should ONLY EVER BE CALLED
* from the backward compatibilty adapter in `evaluateLegacyHookTokens`.
* We are deprecating both this function, and the implementation of the hook
* but for now we ensure that the hook is still rendered for
* sites that implement it, via the TokenProcessor methodology
* https://docs.civicrm.org/dev/en/latest/framework/token/#compose-batch
*
* @return null
* @deprecated since 5.71 will be removed sometime after all core uses are fully removed.
*
*/
public static function tokenValues(