diff --git a/templates/webform-form.tpl.php b/templates/webform-form.tpl.php
index d839083..7edc895 100644
--- a/templates/webform-form.tpl.php
+++ b/templates/webform-form.tpl.php
@@ -18,6 +18,9 @@
*/
?>
+
diff --git a/webform.install b/webform.install
index 3627125..ccfe517 100644
--- a/webform.install
+++ b/webform.install
@@ -109,6 +109,51 @@
'not null' => TRUE,
'default' => -1,
),
+ 'progressbar_bar' => array(
+ 'description' => 'Boolean value indicating if the bar should be shown as part of the progress bar.',
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'progressbar_page_number' => array(
+ 'description' => 'Boolean value indicating if the page number should be shown as part of the progress bar.',
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'progressbar_percent' => array(
+ 'description' => 'Boolean value indicating if the percentage complete should be shown as part of the progress bar.',
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'progressbar_pagebreak_labels' => array(
+ 'description' => 'Boolean value indicating if the pagebreak labels should be included as part of the progress bar.',
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'progressbar_include_confirmation' => array(
+ 'description' => 'Boolean value indicating if the confirmation page should count as a page in the progress bar.',
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'progressbar_label_first' => array(
+ 'description' => 'Label for the first page of the progress bar.',
+ 'type' => 'varchar',
+ 'length' => 255,
+ ),
+ 'progressbar_label_confirmation' => array(
+ 'description' => 'Label for the last page of the progress bar.',
+ 'type' => 'varchar',
+ 'length' => 255,
+ ),
),
'primary key' => array('nid'),
);
@@ -1422,3 +1467,42 @@
);
db_change_field('webform_component', 'mandatory', 'required', $spec);
}
+
+/**
+ * Add progress bar display on and off fields to the webform table.
+ */
+function webform_update_7409() {
+ if (!db_field_exists('webform', 'progressbar_bar')) {
+ $int_schema = array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ );
+ $varchar_schema = array(
+ 'type' => 'varchar',
+ 'length' => 255,
+ );
+
+ $int_schema['description'] = 'Boolean value indicating if the bar should be shown as part of the progress bar.';
+ db_add_field('webform', 'progressbar_bar', $int_schema);
+
+ $int_schema['description'] = 'Boolean value indicating if the page number should be shown as part of the progress bar.';
+ db_add_field('webform', 'progressbar_page_number', $int_schema);
+
+ $int_schema['description'] = 'Boolean value indicating if the percentage complete should be shown as part of the progress bar.';
+ db_add_field('webform', 'progressbar_percent', $int_schema);
+
+ $int_schema['description'] = 'Boolean value indicating if the pagebreak labels should be included as part of the progress bar.';
+ db_add_field('webform', 'progressbar_pagebreak_labels', $int_schema);
+
+ $int_schema['description'] = 'Boolean value indicating if the confirmation page should count as a page in the progress bar.';
+ db_add_field('webform', 'progressbar_include_confirmation', $int_schema);
+
+ $varchar_schema['description'] = 'Label for the first page of the progress bar.';
+ db_add_field('webform', 'progressbar_label_first', $varchar_schema);
+
+ $varchar_schema['description'] = 'Label for the last page of the progress bar.';
+ db_add_field('webform', 'progressbar_label_confirmation', $varchar_schema);
+ }
+}
diff --git a/webform.module b/webform.module
index 3344166..e7e8fee 100644
--- a/webform.module
+++ b/webform.module
@@ -649,6 +649,10 @@
'webform_inline_radio_label' => array(
'render element' => 'element',
),
+ 'webform_progressbar' => array(
+ 'variables' => array('node' => NULL, 'page_num' => NULL, 'page_count' => NULL, 'page_labels' => array()),
+ 'template' => 'templates/webform-progressbar',
+ ),
'webform_mail_message' => array(
'variables' => array('node' => NULL, 'submission' => NULL, 'email' => NULL),
'template' => 'templates/webform-mail',
@@ -1438,6 +1442,7 @@
* Default settings for a newly created webform node.
*/
function webform_node_defaults() {
+ $progress_bar_defaults = webform_variable_get('webform_progressbar_style');
$defaults = array(
'confirmation' => '',
'confirmation_format' => NULL,
@@ -1452,6 +1457,13 @@
'submit_interval' => '-1',
'total_submit_limit' => '-1',
'total_submit_interval' => '-1',
+ 'progressbar_page_number' => in_array('progressbar_page_number', $progress_bar_defaults) ? '1' : '0',
+ 'progressbar_percent' => in_array('progressbar_percent', $progress_bar_defaults) ? '1' : '0',
+ 'progressbar_bar' => in_array('progressbar_bar', $progress_bar_defaults) ? '1' : '0',
+ 'progressbar_pagebreak_labels' => in_array('progressbar_pagebreak_labels', $progress_bar_defaults) ? '1' : '0',
+ 'progressbar_include_confirmation' => in_array('progressbar_include_confirmation', $progress_bar_defaults) ? '1' : '0',
+ 'progressbar_label_first' => webform_variable_get('webform_progressbar_label_first'),
+ 'progressbar_label_confirmation' => webform_variable_get('webform_progressbar_label_confirmation'),
'status' => '1',
'record_exists' => FALSE,
'roles' => array('1', '2'),
@@ -2148,6 +2160,17 @@
foreach ($form_state['values']['submitted'] as $cid => $data) {
$input_values[$cid] = is_array($data) ? $data : array($data);
}
+ }
+
+ if ($page_count > 1) {
+ $form['progressbar'] = array(
+ '#theme' => 'webform_progressbar',
+ '#node' => $node,
+ '#page_num' => $page_num,
+ '#page_count' => $page_count + ($node->webform['progressbar_include_confirmation'] ? 1 : 0),
+ '#page_labels' => webform_page_labels($node),
+ '#weight' => -100
+ );
}
// Recursively add components to the form. The unfiltered version of the
@@ -3002,6 +3025,33 @@
// Strip out empty tags added by WYSIWYG editors if needed.
$vars['confirmation_message'] = strlen(trim(strip_tags($confirmation))) ? $confirmation : '';
+
+ // Progress bar.
+ $vars['progressbar'] = '';
+ if ($vars['node']->webform['progressbar_include_confirmation']) {
+ $page_labels = webform_page_labels($vars['node']);
+ $vars['progressbar'] = theme('webform_progressbar', array(
+ 'node' => $vars['node'],
+ 'page_num' => count($page_labels),
+ 'page_count' => count($page_labels),
+ 'page_labels' => $page_labels,
+ ));
+ }
+}
+
+/**
+ * Prepare for theming of the webform progressbar.
+ */
+function template_preprocess_webform_progressbar(&$vars) {
+ // Add CSS used by the progress bar.
+ drupal_add_css(drupal_get_path('module', 'webform') . '/css/webform.css');
+
+ $vars['progressbar_page_number'] = $vars['node']->webform['progressbar_page_number'];
+ $vars['progressbar_percent'] = $vars['node']->webform['progressbar_percent'];
+ $vars['progressbar_bar'] = $vars['node']->webform['progressbar_bar'];
+ $vars['progressbar_pagebreak_labels'] = $vars['node']->webform['progressbar_pagebreak_labels'];
+ $vars['progressbar_include_confirmation'] = $vars['node']->webform['progressbar_include_confirmation'];
+ $vars['percent'] = ($vars['page_num'] - 1) / ($vars['page_count'] - 1) * 100;
}
/**
@@ -3342,7 +3392,6 @@
return filter_xss($string, $allowed_tags);
}
-
/**
* Utility function to ensure that a webform record exists in the database.
*
@@ -3413,7 +3462,31 @@
}
/**
- * Retreive a Drupal variable with the appropriate default value.
+ * Find the label of a given page based on page breaks.
+ *
+ * @param $webform
+ * The webform node.
+ * @return array
+ * An array of all page labels, indexed by page number.
+ */
+function webform_page_labels($node) {
+ $page_count = 1;
+ $page_labels = array();
+ $page_labels[0] = t($node->webform['progressbar_label_first']);
+ foreach ($node->webform['components'] as $component) {
+ if ($component['type'] == 'pagebreak') {
+ $page_labels[$page_count] = $component['name'];
+ $page_count++;
+ }
+ }
+ if ($node->webform['progressbar_include_confirmation']) {
+ $page_labels[] = t($node->webform['progressbar_label_confirmation']);
+ }
+ return $page_labels;
+}
+
+/**
+ * Retrieve a Drupal variable with the appropriate default value.
*/
function webform_variable_get($variable) {
switch ($variable) {
@@ -3441,6 +3514,15 @@
case 'webform_csv_delimiter':
$result = variable_get('webform_csv_delimiter', '\t');
break;
+ case 'webform_progressbar_style':
+ $result = variable_get('webform_progressbar_style', array('progressbar_bar', 'progressbar_pagebreak_labels', 'progressbar_include_confirmation'));
+ break;
+ case 'webform_progressbar_label_first':
+ $result = variable_get('webform_progressbar_label_first', t('Start'));
+ break;
+ case 'webform_progressbar_label_confirmation':
+ $result = variable_get('webform_progressbar_label_confirmation', t('Complete'));
+ break;
}
return $result;
}