/
contactsegment.php
executable file
·254 lines (238 loc) · 8.2 KB
/
contactsegment.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
<?php
require_once 'contactsegment.civix.php';
/**
* Implements hook_civicrm_buildForm().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_buildForm
*/
function contactsegment_civicrm_buildForm($formName, &$form) {
if ($formName == 'CRM_Contactsegment_Form_ContactSegment') {
CRM_Core_Resources::singleton()->addScriptFile('org.civicoop.contactsegment', 'contactsegment.js');
}
}
/**
* Implements hook_civicrm_alterAPIPermissions().
*
* Set permission for Contact Segment APIs to
* 'access CiviCRM' instead of the default 'administer CiviCRM'.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterAPIPermissions
*/
function contactsegment_civicrm_alterAPIPermissions($entity, $action, $params, &$permissions) {
$permissions['segment']['get'] = array('access CiviCRM');
$permissions['segment']['create'] = array('access CiviCRM');
$permissions['segment']['delete'] = array('access CiviCRM');
$permissions['contactsegment']['get'] = array('access CiviCRM');
$permissions['contactsegment']['create'] = array('access CiviCRM');
$permissions['contactsegment']['delete'] = array('access CiviCRM');
$permissions['segmentsetting']['get'] = array('access CiviCRM');
$permissions['segmentsetting']['create'] = array('access CiviCRM');
}
/**
* Implements hook_civicrm_config().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
*/
function contactsegment_civicrm_config(&$config) {
_contactsegment_civix_civicrm_config($config);
}
/**
* Implements hook_civicrm_xmlMenu().
*
* @param $files array(string)
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
*/
function contactsegment_civicrm_xmlMenu(&$files) {
_contactsegment_civix_civicrm_xmlMenu($files);
}
/**
* Implements hook_civicrm_install().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
*/
function contactsegment_civicrm_install() {
_contactsegment_civix_civicrm_install();
}
/**
* Implements hook_civicrm_uninstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
*/
function contactsegment_civicrm_uninstall() {
require_once 'CRM/Contactsegment/Utils.php';
require_once 'CRM/Contactsegment/Config.php';
CRM_Contactsegment_Utils::removeRoleOptionGroup();
_contactsegment_civix_civicrm_uninstall();
}
/**
* Implements hook_civicrm_enable().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
*/
function contactsegment_civicrm_enable() {
// instantiate config to create option group if not exists
CRM_Contactsegment_Config::singleton();
_contactsegment_civix_civicrm_enable();
}
/**
* Implements hook_civicrm_disable().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
*/
function contactsegment_civicrm_disable() {
_contactsegment_civix_civicrm_disable();
}
/**
* Implements hook_civicrm_upgrade().
*
* @param $op string, the type of operation being performed; 'check' or 'enqueue'
* @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
*
* @return mixed
* Based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
* for 'enqueue', returns void
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
*/
function contactsegment_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _contactsegment_civix_civicrm_upgrade($op, $queue);
}
/**
* Implements hook_civicrm_managed().
*
* Generate a list of entities to create/deactivate/delete when this module
* is installed, disabled, uninstalled.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
*/
function contactsegment_civicrm_managed(&$entities) {
_contactsegment_civix_civicrm_managed($entities);
}
/**
* Implements hook_civicrm_caseTypes().
*
* Generate a list of case-types
*
* Note: This hook only runs in CiviCRM 4.4+.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
*/
function contactsegment_civicrm_caseTypes(&$caseTypes) {
_contactsegment_civix_civicrm_caseTypes($caseTypes);
}
/**
* Implements hook_civicrm_angularModules().
*
* Generate a list of Angular modules.
*
* Note: This hook only runs in CiviCRM 4.5+. It may
* use features only available in v4.6+.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
*/
function contactsegment_civicrm_angularModules(&$angularModules) {
_contactsegment_civix_civicrm_angularModules($angularModules);
}
/**
* Implements hook_civicrm_alterSettingsFolders().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
*/
function contactsegment_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
_contactsegment_civix_civicrm_alterSettingsFolders($metaDataFolders);
}
/**
* Implementation of hook civicrm_navigationMenu
* to add a contact segment menu item to the Administer/Customize Data and Screens menu
*
* @param array $params
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_navigationMenu
*/
function contactsegment_civicrm_navigationMenu( &$params ) {
$maxKey = CRM_Contactsegment_Utils::getMaxMenuKey($params);
$menuAdministerId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Navigation', 'Administer', 'id', 'name');
$menuParentId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Navigation', 'Customize Data and Screens', 'id', 'name');
$params[$menuAdministerId]['child'][$menuParentId]['child'][$maxKey+1] =
array (
'attributes' => array (
'label' => ts('Manage Contact Segments'),
'name' => ts('Manage Contact Segments'),
'url' => NULL,
'permission' => NULL,
'operator' => NULL,
'separator' => NULL,
'parentID' => $menuParentId,
'navID' => $maxKey+1,
'active' => 1
),
'child' => array(
1 => array(
'attributes' => array (
'label' => ts('Contact Segment Settings'),
'name' => ts('Contact Segment Settings'),
'url' => CRM_Utils_System::url('civicrm/segmentsetting', 'reset=1&type=parent', true),
'permission' => 'administer CiviCRM',
'operator' => NULL,
'separator' => NULL,
'parentID' => $maxKey+1,
'navID' => 1,
'active' => 1
),
),
2 => array(
'attributes' => array (
'label' => ts('Contact Segments'),
'name' => ts('Contact Segments'),
'url' => CRM_Utils_System::url('civicrm/segmentlist', 'force=1&crmRowCount=25', true),
'permission' => 'administer CiviCRM',
'operator' => NULL,
'separator' => NULL,
'parentID' => $maxKey+1,
'navID' => 2,
'active' => 1
))));
}
/**
* Implementation of hook civicrm_tabs
* to add a contact segment tab to the contact summary
*
* @param array $tabs
* @param int $contactID
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_tabs
*/
function contactsegment_civicrm_tabs(&$tabs, $contactID) {
$tabs[] = CRM_Contactsegment_BAO_ContactSegment::tabs($tabs, $contactID);
}
/**
* Implementation of hook civicrm_post
* to rebuild segment tree when segment is created or updated
*
* @param string $op
* @param string $objectName
* @param int $objectId
* @param object $objectRef
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_post
*/
function contactsegment_civicrm_post($op, $objectName, $objectId, &$objectRef) {
if ($objectName == "Segment") {
if ($op == "create" || $op == "edit") {
CRM_Contactsegment_BAO_Segment::buildSegmentTree();
}
}
}
/**
* Implementation of hook civicrm_pre
* to rebuild segment tree when segment is deleted
*
* @param string $op
* @param string $objectName
* @param int $objectId
* @param array $params
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_pre
*/
function contactsegment_civicrm_pre($op, $objectName, $objectId, &$params) {
if ($objectName == "Segment" && $op == "delete") {
CRM_Contactsegment_BAO_Segment::buildSegmentTree();
}
}