From c40d6a45c91086ee410783ddb8147c55b2b5db67 Mon Sep 17 00:00:00 2001 From: Aaron Fulton Date: Tue, 1 Mar 2011 08:45:27 +1300 Subject: [PATCH] Issue #[258696] by [aaronfulton]: [Add support for a progress bar for multi-page forms]. --- css/webform.css | 12 ++++++++ includes/webform.admin.inc | 20 +++++++++++++ includes/webform.pages.inc | 37 ++++++++++++++++++++++++ templates/webform-form.tpl.php | 3 ++ templates/webform-progressbar.tpl.php | 48 +++++++++++++++++++++++++++++++ webform.install | 36 +++++++++++++++++++++++ webform.module | 51 ++++++++++++++++++++++++++++++++- 7 files changed, 206 insertions(+), 1 deletions(-) create mode 100644 templates/webform-progressbar.tpl.php diff --git a/css/webform.css b/css/webform.css index 2238101..a25d79c 100644 --- a/css/webform.css +++ b/css/webform.css @@ -11,3 +11,15 @@ input.webform-calendar { .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; +} diff --git a/includes/webform.admin.inc b/includes/webform.admin.inc index e8de281..b42a9bf 100644 --- a/includes/webform.admin.inc +++ b/includes/webform.admin.inc @@ -153,6 +153,26 @@ function webform_admin_settings() { '#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'; diff --git a/includes/webform.pages.inc b/includes/webform.pages.inc index 9f61d3d..dc6f8b9 100644 --- a/includes/webform.pages.inc +++ b/includes/webform.pages.inc @@ -195,6 +195,37 @@ function webform_configure_form(&$form_state, $node) { ); /* 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'), @@ -287,6 +318,12 @@ function webform_configure_form_submit($form, &$form_state) { // 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.')); diff --git a/templates/webform-form.tpl.php b/templates/webform-form.tpl.php index 0b02945..c3d46c0 100644 --- a/templates/webform-form.tpl.php +++ b/templates/webform-form.tpl.php @@ -24,6 +24,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']); diff --git a/templates/webform-progressbar.tpl.php b/templates/webform-progressbar.tpl.php new file mode 100644 index 0000000..208ae5a --- /dev/null +++ b/templates/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 '
 
'; + print '
'; +} + +print ''; +?> diff --git a/webform.install b/webform.install index d3dbe5b..bd7be18 100644 --- a/webform.install +++ b/webform.install @@ -98,6 +98,30 @@ function webform_schema() { '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'), ); @@ -1325,6 +1349,18 @@ function webform_update_6326() { } /** + * Add a progressbar style field to the webform table + */ +function webform_update_6327() { + $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. * diff --git a/webform.module b/webform.module index 42f2a95..7234688 100644 --- a/webform.module +++ b/webform.module @@ -480,6 +480,9 @@ function webform_init() { _admin_init_theme(); } } + + //add css for this module + drupal_add_css(drupal_get_path('module', 'webform') . '/css/webform.css'); } /** @@ -525,6 +528,10 @@ function webform_theme() { '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), ), @@ -1639,7 +1646,7 @@ function webform_client_form(&$form_state, $node, $submission, $is_draft = FALSE $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(); @@ -1658,6 +1665,14 @@ function webform_client_form(&$form_state, $node, $submission, $is_draft = FALSE $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'][$cid]) ? $form_state['values']['submitted'][$cid] : NULL; @@ -2323,6 +2338,17 @@ function template_preprocess_webform_confirmation(&$vars) { } /** + * 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) { @@ -3441,3 +3467,26 @@ function webform_mollom_form_info($form_id) { 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 -- 1.7.3.1.msysgit.0