forked from TobiasLounsbury/civicrm-simple-workflow
/
workflow.php
249 lines (214 loc) · 8.96 KB
/
workflow.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
<?php
require_once 'workflow.civix.php';
require_once 'workflow.hook.php';
//Hijack the page content so we can add the notifcation container
function workflow_civicrm_alterContent( &$content, $context, $tplName, &$object ) {
if ($context == "form" && get_class($object) == "CRM_Contribute_Form_Contribution_Main") {
if (array_key_exists("workflow", $_GET) && $_GET['workflow'] == 0) {
return;
}
$allPages = CRM_Workflow_BAO_Workflow::getWorkflowPages(true);
if (array_key_exists($object->_id, $allPages)) {
$sm = CRM_Core_Smarty::singleton();
$pos = strrpos($content, "</div>");
if($pos !== false) {
$content = substr_replace($content, $sm->fetch("CRM/common/notifications.tpl")."</div>", $pos, strlen("</div>"));
}
}
}
}
/**
* Implementation of hook_civicrm_buildForm
*
* @param $formName string, the name of the form
* @param $form object, a reference to the form object
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_buildForm
*/
function workflow_civicrm_buildForm($formName, &$form) {
if ($formName == "CRM_Contribute_Form_Contribution_Main") {
if (array_key_exists("workflow", $_GET) && $_GET['workflow'] == 0) {
return;
}
$allPages = CRM_Workflow_BAO_Workflow::getWorkflowPages(true);
if (array_key_exists($form->_id, $allPages)) {
//We have a page to inject into so Load up the workflow
$workflow = CRM_Workflow_BAO_Workflow::getWorkflow($allPages[$form->_id]);
if ($workflow['is_active']) {
$steps = CRM_Workflow_BAO_Workflow::getWorkflowDetails($allPages[$form->_id], false);
//If we require login forward to workflow page and it will forward it back here.
if ($workflow['require_login']) {
//If the login form selected is also the first one in the list we can just load the page.
if ($steps[1]['entity_table'] == "Profile" && $steps[1]['entity_id'] == $workflow['login_form_id']) {
if ($form->_contactID) {
unset($steps[1]);
}
} else {
if (!$form->contactID) {
return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/workflow', 'reset=1&wid=' . $allPages[$form->_id]['workflow_id']));
}
}
}
//Inject the needed resources into the page
//Let the page know we are injecting into a page rather than loading a template.
CRM_Core_Resources::singleton()->addSetting(array('Workflow' => array('method' => "inject")));
//Add Stylesheet
CRM_Core_Resources::singleton()->addStyleFile('org.botany.workflow', 'workflow_execute.css');
//Add JS Libraries if we need them for notifications.
if (!CRM_Core_Permission::check('access CiviCRM')) {
$notiFile = CRM_Core_Resources::singleton()->getUrl('civicrm', "packages/jquery/plugins/jquery.notify.min.js", true);
CRM_Core_Resources::singleton()->addScriptUrl($notiFile, -2, 'html-header');
$blockFile = CRM_Core_Resources::singleton()->getUrl('civicrm', "packages/jquery/plugins/jquery.blockUI.min.js", true);
CRM_Core_Resources::singleton()->addScriptUrl($blockFile, -1, 'html-header');
}
//Add Javascript files and settings
CRM_Core_Resources::singleton()->addScriptFile('org.botany.workflow', 'workflow_execute.js', 20, 'page-footer');
CRM_Core_Resources::singleton()->addSetting(array('Workflow' => array('steps' => $steps)));
//Set the width for the step lis
$stepWidth = (empty($steps)) ? 98 : round(98 / sizeof($steps), 0, PHP_ROUND_HALF_DOWN);
CRM_Core_Resources::singleton()->addSetting(array('Workflow' => array('breadcrumWidth' => $stepWidth)));
$jquerySteps = "";
$lastStep = 1;
foreach($steps as $step) {
if ($step['entity_table'] == "jQuery") {
$jquerySteps[] = $step['entity_id'];
$lastStep = $step['order'];
}
}
$jqueryTotal = ($jquerySteps) ? implode(",", $jquerySteps) : false;
CRM_Core_Resources::singleton()->addSetting(array('Workflow' => array('allSelector' => $jqueryTotal)));
CRM_Core_Resources::singleton()->addSetting(array('Workflow' => array('lastStep' => $lastStep)));
//If we are returning to the form.
if (!empty($form->_submitValues)) {
CRM_Core_Resources::singleton()->addSetting(array('Workflow' => array('returning' => true)));
}
}
}
}
}
function workflow_workflow_test($params) {
error_log($params);
}
/**
* Implementation of hook_civicrm_config
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
*/
function workflow_civicrm_config(&$config) {
_workflow_civix_civicrm_config($config);
}
/**
* Implementation of hook_civicrm_xmlMenu
*
* @param $files array(string)
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
*/
function workflow_civicrm_xmlMenu(&$files) {
_workflow_civix_civicrm_xmlMenu($files);
}
/**
* Implementation of hook_civicrm_install
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
*/
function workflow_civicrm_install() {
return _workflow_civix_civicrm_install();
}
/**
* Implementation of hook_civicrm_uninstall
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
*/
function workflow_civicrm_uninstall() {
return _workflow_civix_civicrm_uninstall();
}
/**
* Implementation of hook_civicrm_enable
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
*/
function workflow_civicrm_enable() {
return _workflow_civix_civicrm_enable();
}
/**
* Implementation of hook_civicrm_disable
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
*/
function workflow_civicrm_disable() {
return _workflow_civix_civicrm_disable();
}
/**
* Implementation of 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 workflow_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _workflow_civix_civicrm_upgrade($op, $queue);
}
/**
* Implementation of 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 workflow_civicrm_managed(&$entities) {
return _workflow_civix_civicrm_managed($entities);
}
/**
* Implementation of 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 workflow_civicrm_caseTypes(&$caseTypes) {
_workflow_civix_civicrm_caseTypes($caseTypes);
}
/**
* Implementation of hook_civicrm_alterSettingsFolders
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
*/
function workflow_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
_workflow_civix_civicrm_alterSettingsFolders($metaDataFolders);
}
/**
* Add navigation for Workflowa under "Administer" menu
*
* @param $params associated array of navigation menus
*
*/
function workflow_civicrm_navigationMenu( &$params ) {
// get the id of Administer Menu
$administerMenuId = CRM_Core_DAO::getFieldValue('CRM_Core_BAO_Navigation', 'Administer', 'id', 'name');
// skip adding menu if there is no administer menu
if ($administerMenuId) {
// get the maximum key under adminster menu
$maxKey = max( array_keys($params[$administerMenuId]['child']));
$params[$administerMenuId]['child'][$maxKey+1] = array (
'attributes' => array (
'label' => 'CiviWorkflows',
'name' => 'CiviWorkflows',
'url' => 'civicrm/workflows?reset=1',
'permission' => 'administer CiviCRM',
'operator' => NULL,
'separator' => FALSE,
'parentID' => $administerMenuId,
'navID' => $maxKey+1,
'active' => 1
)
);
}
}