Merge pull request #18320 from civicrm/5.29
[civicrm-core.git] / ext / financialacls / financialacls.php
1 <?php
2
3 require_once 'financialacls.civix.php';
4 // phpcs:disable
5 use CRM_Financialacls_ExtensionUtil as E;
6 // phpcs:enable
7
8 /**
9 * Implements hook_civicrm_config().
10 *
11 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/
12 */
13 function financialacls_civicrm_config(&$config) {
14 _financialacls_civix_civicrm_config($config);
15 }
16
17 /**
18 * Implements hook_civicrm_xmlMenu().
19 *
20 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
21 */
22 function financialacls_civicrm_xmlMenu(&$files) {
23 _financialacls_civix_civicrm_xmlMenu($files);
24 }
25
26 /**
27 * Implements hook_civicrm_install().
28 *
29 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
30 */
31 function financialacls_civicrm_install() {
32 _financialacls_civix_civicrm_install();
33 }
34
35 /**
36 * Implements hook_civicrm_postInstall().
37 *
38 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
39 */
40 function financialacls_civicrm_postInstall() {
41 _financialacls_civix_civicrm_postInstall();
42 }
43
44 /**
45 * Implements hook_civicrm_uninstall().
46 *
47 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
48 */
49 function financialacls_civicrm_uninstall() {
50 _financialacls_civix_civicrm_uninstall();
51 }
52
53 /**
54 * Implements hook_civicrm_enable().
55 *
56 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
57 */
58 function financialacls_civicrm_enable() {
59 _financialacls_civix_civicrm_enable();
60 }
61
62 /**
63 * Implements hook_civicrm_disable().
64 *
65 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
66 */
67 function financialacls_civicrm_disable() {
68 _financialacls_civix_civicrm_disable();
69 }
70
71 /**
72 * Implements hook_civicrm_upgrade().
73 *
74 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
75 */
76 function financialacls_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
77 return _financialacls_civix_civicrm_upgrade($op, $queue);
78 }
79
80 /**
81 * Implements hook_civicrm_managed().
82 *
83 * Generate a list of entities to create/deactivate/delete when this module
84 * is installed, disabled, uninstalled.
85 *
86 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
87 */
88 function financialacls_civicrm_managed(&$entities) {
89 _financialacls_civix_civicrm_managed($entities);
90 }
91
92 /**
93 * Implements hook_civicrm_caseTypes().
94 *
95 * Generate a list of case-types.
96 *
97 * Note: This hook only runs in CiviCRM 4.4+.
98 *
99 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
100 */
101 function financialacls_civicrm_caseTypes(&$caseTypes) {
102 _financialacls_civix_civicrm_caseTypes($caseTypes);
103 }
104
105 /**
106 * Implements hook_civicrm_angularModules().
107 *
108 * Generate a list of Angular modules.
109 *
110 * Note: This hook only runs in CiviCRM 4.5+. It may
111 * use features only available in v4.6+.
112 *
113 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
114 */
115 function financialacls_civicrm_angularModules(&$angularModules) {
116 _financialacls_civix_civicrm_angularModules($angularModules);
117 }
118
119 /**
120 * Implements hook_civicrm_alterSettingsFolders().
121 *
122 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
123 */
124 function financialacls_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
125 _financialacls_civix_civicrm_alterSettingsFolders($metaDataFolders);
126 }
127
128 /**
129 * Implements hook_civicrm_entityTypes().
130 *
131 * Declare entity types provided by this module.
132 *
133 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
134 */
135 function financialacls_civicrm_entityTypes(&$entityTypes) {
136 _financialacls_civix_civicrm_entityTypes($entityTypes);
137 }
138
139 /**
140 * Implements hook_civicrm_thems().
141 */
142 function financialacls_civicrm_themes(&$themes) {
143 _financialacls_civix_civicrm_themes($themes);
144 }
145
146 /**
147 * Intervene to prevent deletion, where permissions block it.
148 *
149 * @param \CRM_Core_DAO $op
150 * @param string $objectName
151 * @param int|null $id
152 * @param array $params
153 *
154 * @throws \API_Exception
155 * @throws \CRM_Core_Exception
156 */
157 function financialacls_civicrm_pre($op, $objectName, $id, &$params) {
158 if ($objectName === 'LineItem' && $op === 'delete' && !empty($params['check_permissions'])) {
159 if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
160 CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, CRM_Core_Action::DELETE);
161 if (empty($params['financial_type_id'])) {
162 $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_LineItem', $params['id'], 'financial_type_id');
163 }
164 if (!in_array($params['financial_type_id'], array_keys($types))) {
165 throw new API_Exception('You do not have permission to delete this line item');
166 }
167 }
168 }
169 }
170
171 /**
172 * Implements hook_civicrm_selectWhereClause().
173 *
174 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_selectWhereClause
175 */
176 function financialacls_civicrm_selectWhereClause($entity, &$clauses) {
177 if ($entity === 'LineItem') {
178 if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
179 $types = [];
180 CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types);
181 if ($types) {
182 $clauses['financial_type_id'] = 'IN (' . implode(',', array_keys($types)) . ')';
183 }
184 else {
185 $clauses['financial_type_id'] = '= 0';
186 }
187 }
188 }
189
190 }
191
192 // --- Functions below this ship commented out. Uncomment as required. ---
193
194 /**
195 * Implements hook_civicrm_preProcess().
196 *
197 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_preProcess
198 */
199 //function financialacls_civicrm_preProcess($formName, &$form) {
200 //
201 //}
202
203 /**
204 * Implements hook_civicrm_navigationMenu().
205 *
206 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_navigationMenu
207 */
208 //function financialacls_civicrm_navigationMenu(&$menu) {
209 // _financialacls_civix_insert_navigation_menu($menu, 'Mailings', array(
210 // 'label' => E::ts('New subliminal message'),
211 // 'name' => 'mailing_subliminal_message',
212 // 'url' => 'civicrm/mailing/subliminal',
213 // 'permission' => 'access CiviMail',
214 // 'operator' => 'OR',
215 // 'separator' => 0,
216 // ));
217 // _financialacls_civix_navigationMenu($menu);
218 //}