Index: css/webform.css
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/webform/css/webform.css,v
retrieving revision 1.1.2.3
diff -u -r1.1.2.3 webform.css
--- css/webform.css 17 Oct 2010 18:53:09 -0000 1.1.2.3
+++ css/webform.css 8 Jan 2011 09:02:42 -0000
@@ -12,3 +12,15 @@
.webform-container-inline div.form-item {
display: inline;
}
+
+.webform-progressbar-inner {
+ height: 1em;
+ background-color: #000088;
+}
+
+.webform-progressbar-outer {
+ border: 1px solid #000000;
+ width: 100%;
+ height: 1em;
+ margin:0.35em 5px 0;
+}
Index: includes/webform.admin.inc
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/webform/includes/webform.admin.inc,v
retrieving revision 1.4.2.4
diff -u -r1.4.2.4 webform.admin.inc
--- includes/webform.admin.inc 30 Aug 2010 20:22:15 -0000 1.4.2.4
+++ includes/webform.admin.inc 8 Jan 2011 09:03:32 -0000
@@ -152,6 +152,26 @@
'#description' => t('By default, the configuration form for each webform allows the administrator to choose which roles may submit the form. You may want to allow users to always submit the form if you are using a separate node access module to control access to webform nodes themselves.'),
);
+ $form['progressbar'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Progress bar'),
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ );
+
+ $form['progressbar']['webform_progressbar_style'] = array(
+ '#type' => 'checkboxes',
+ '#title' => t('Progress bar style'),
+ '#options' => array(
+ 'progressbar_page_number' => t('Show page number as number of completed (i.e. Page 1 of 10)'),
+ 'progressbar_percent' => t('Show percentage completed (i.e. 10%)'),
+ 'progressbar_bar' => t('Show percentage completed bar.'),
+ 'progressbar_pagebreak_label' => t('Show the page break label in each page.'),
+ ),
+ '#default_value' => variable_get('webform_progressbar_style', array()),
+ '#description' => t('Choose how the progress bar should be displayed for multi-page forms.'),
+ );
+
$form = system_settings_form($form);
$form['#theme'] = 'webform_admin_settings';
$form['#submit'][] = 'webform_admin_settings_submit';
Index: includes/webform.pages.inc
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/webform/includes/webform.pages.inc,v
retrieving revision 1.10.2.5
diff -u -r1.10.2.5 webform.pages.inc
--- includes/webform.pages.inc 6 Jan 2011 18:35:00 -0000 1.10.2.5
+++ includes/webform.pages.inc 8 Jan 2011 09:03:58 -0000
@@ -190,6 +190,37 @@
);
/* End Advanced Settings Form */
+ /* End Progress Bar Settings Form*/
+ $progressbar_defaults = variable_get('webform_progressbar_style', array());
+ $form['progressbar'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Progress bar'),
+ '#description' => t('Choose how the progress bar should be displayed for multi-page forms.'),
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ );
+ $form['progressbar']['progressbar_page_number'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Show page number as number of completed (i.e. Page 1 of 10)'),
+ '#default_value' => isset($node->webform['progressbar_page_number']) ? $node->webform['progressbar_page_number'] : $progressbar_defaults['progressbar_page_number'],
+ );
+ $form['progressbar']['progressbar_percent'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Show percentage completed (i.e. 10%)'),
+ '#default_value' => isset($node->webform['progressbar_percent']) ? $node->webform['progressbar_percent'] : $progressbar_defaults['progressbar_percent'],
+ );
+ $form['progressbar']['progressbar_bar'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Show percentage completed bar.'),
+ '#default_value' => isset($node->webform['progressbar_bar']) ? $node->webform['progressbar_bar'] : $progressbar_defaults['progressbar_bar'],
+ );
+ $form['progressbar']['progressbar_pagebreak_label'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Show the page break label in each page.'),
+ '#default_value' => isset($node->webform['progressbar_pagebreak_label']) ? $node->webform['progressbar_pagebreak_label'] : $progressbar_defaults['progressbar_pagebreak_label'],
+ );
+ /* End Progress Bar Settings Form*/
+
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Save configuration'),
@@ -279,6 +310,12 @@
// Set submit button text.
$node->webform['submit_text'] = $form_state['values']['submit_text'];
+ //Set the progress bar preference
+ $node->webform['progressbar_page_number'] = $form_state['values']['progressbar_page_number'];
+ $node->webform['progressbar_percent'] = $form_state['values']['progressbar_percent'];
+ $node->webform['progressbar_bar'] = $form_state['values']['progressbar_bar'];
+ $node->webform['progressbar_pagebreak_label'] = $form_state['values']['progressbar_pagebreak_label'];
+
node_save($node);
drupal_set_message(t('The form settings have been updated.'));
Index: templates/webform-form.tpl.php
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/webform/templates/webform-form.tpl.php,v
retrieving revision 1.1
diff -u -r1.1 webform-form.tpl.php
--- templates/webform-form.tpl.php 22 May 2009 03:11:18 -0000 1.1
+++ templates/webform-form.tpl.php 8 Jan 2011 09:04:47 -0000
@@ -25,6 +25,9 @@
print drupal_render($form['submission_info']);
}
+ //Print out the progress bar at the top of the page
+ print drupal_render($form['progressbar']);
+
// Print out the main part of the form.
// Feel free to break this up and move the pieces within the array.
print drupal_render($form['submitted']);
Index: webform.install
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/webform/webform.install,v
retrieving revision 1.40.2.23
diff -u -r1.40.2.23 webform.install
--- webform.install 6 Jan 2011 18:34:59 -0000 1.40.2.23
+++ webform.install 8 Jan 2011 09:10:08 -0000
@@ -92,6 +92,30 @@
'not null' => TRUE,
'default' => -1,
),
+ 'progressbar_page_number' => array(
+ 'description' => 'Should the the page number be shown as part of the progress bar?',
+ 'type' => 'int',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'progressbar_percent' => array(
+ 'description' => 'Should the percentage complete be shown as part of the progress bar?',
+ 'type' => 'int',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'progressbar_bar' => array(
+ 'description' => 'Should the bar be shown as part of the progress bar?',
+ 'type' => 'int',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'progressbar_pagebreak_label' => array(
+ 'description' => 'Should the pagebreak label be shown as part of the progress bar?',
+ 'type' => 'int',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
),
'primary key' => array('nid'),
);
@@ -1277,6 +1301,18 @@
}
/**
+ * Add a progressbar style field to the webform table
+ */
+function webform_update_6324() {
+ $ret = array();
+ db_add_field($ret, 'webform', 'progressbar_page_number', array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'description' => 'Should the the page number be shown as part of the progress bar?'));
+ db_add_field($ret, 'webform', 'progressbar_percent', array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'description' => 'Should the percentage complete be shown as part of the progress bar?'));
+ db_add_field($ret, 'webform', 'progressbar_bar', array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'description' => 'Should the bar be shown as part of the progress bar?'));
+ db_add_field($ret, 'webform', 'progressbar_pagebreak_label', array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'description' => 'Should the pagebreak label be shown as part of the progress bar?'));
+ return $ret;
+}
+
+/**
* Recursively delete all files and folders in the specified filepath, then
* delete the containing folder.
*
Index: webform.module
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/webform/webform.module,v
retrieving revision 1.196.2.74
diff -u -r1.196.2.74 webform.module
--- webform.module 6 Jan 2011 18:34:59 -0000 1.196.2.74
+++ webform.module 8 Jan 2011 09:32:55 -0000
@@ -468,6 +468,9 @@
_admin_init_theme();
}
}
+
+ //add css for this module
+ drupal_add_css(drupal_get_path('module', 'webform') . '/css/webform.css');
}
/**
@@ -513,6 +516,10 @@
'webform_element_wrapper' => array(
'arguments' => array('element' => NULL, 'content' => NULL),
),
+ 'webform_progressbar' => array(
+ 'arguments' => array('webform' => NULL, 'page_number' => NULL, 'page_count' => NULL, 'page_label' => NULL),
+ 'template' => 'templates/webform-progressbar',
+ ),
'webform_element_text' => array(
'arguments' => array('element' => NULL, 'value' => NULL),
),
@@ -1560,7 +1567,7 @@
$form['details'] = array(
'#tree' => TRUE,
);
-
+
// Put the components into a tree structure.
if (!isset($form_state['storage']['component_tree'])) {
$form_state['webform']['component_tree'] = array();
@@ -1579,6 +1586,14 @@
$page_count = $form_state['webform']['page_count'];
$page_num = $form_state['webform']['page_num'];
+ if ($page_count > 1) {
+ $form['progressbar'] = array(
+ '#type' => 'markup',
+ '#value' => theme('webform_progressbar', $node->webform, $page_num, $page_count, webform_page_label($node->webform, $page_num)),
+ '#weight' => -100
+ );
+ }
+
// Recursively add components to the form.
foreach ($component_tree['children'] as $cid => $component) {
$component_value = isset($form_state['values']['submitted'][$component['form_key']]) ? $form_state['values']['submitted'][$component['form_key']] : NULL;
@@ -2340,6 +2355,17 @@
}
/**
+ * Prepare for theming of the webform progressbar.
+ */
+function template_preprocess_webform_progressbar(&$vars) {
+ $vars['progressbar_page_number'] = $vars['webform']['progressbar_page_number'];
+ $vars['progressbar_percent'] = $vars['webform']['progressbar_percent'];
+ $vars['progressbar_bar'] = $vars['webform']['progressbar_bar'];
+ $vars['progressbar_pagebreak_label'] = $vars['webform']['progressbar_pagebreak_label'];
+ $vars['percent'] = $vars['page_number'] / $vars['page_count'] * 100;
+}
+
+/**
* Prepare to theme the contents of e-mails sent by webform.
*/
function template_preprocess_webform_mail_message(&$vars) {
@@ -3382,3 +3408,26 @@
return $form_info;
}
+
+/**
+ * Find the label of a page
+ *
+ * @param $webform
+ * The webform object
+ * @param $page_number
+ * The page number of the page in question
+ * @return string
+ * The label of the page
+ */
+function webform_page_label($webform, $page_number) {
+ $page_count = 1;
+ foreach($webform['components'] as $component) {
+ if ($component['type'] == 'pagebreak') {
+ $page_count++;
+ if ($page_count == $page_number) {
+ return $component['name'];
+ }
+ }
+ }
+ return ''; //The default for the first page
+}
\ No newline at end of file
--- webform-progressbar.tpl.php
+++ webform-progressbar.tpl.php
@@ -0,0 +1,48 @@
+';
+
+if ($progressbar_pagebreak_label) { //Show the page break label in each page
+ print ' ';
+ print $page_label;
+ print '
';
+}
+
+if ($progressbar_percent) { //Show percentage completed (i.e. 10%)
+ print ' ';
+ print number_format($percent, 0);
+ print '%
';
+}
+
+if ($progressbar_page_number) { //Show page number as number of completed (i.e. Page 1 of 10)
+ print ' ';
+ print t('Page @start of @end', array('@start' => $page_number, '@end' => $page_count));
+ print '
';
+}
+
+if ($progressbar_bar) { //Show percentage completed bar
+ print ' ';
+}
+
+print '';
+?>