diff --git a/components/pagebreak.inc b/components/pagebreak.inc
index a85eba0..81f5e02 100644
--- a/components/pagebreak.inc
+++ b/components/pagebreak.inc
@@ -54,8 +54,8 @@ function _webform_edit_pagebreak($component) {
);
$form['extra']['prev_page_label'] = array(
'#type' => 'textfield',
- '#title' => t('Prev page button label'),
- '#description' => t('This is used for the Prev Page button on the page after this page break. Default: < Prev Page'),
+ '#title' => t('Previous page button label'),
+ '#description' => t('This is used for the Previous Page button on the page after this page break. Default: < Prev Page'),
'#default_value' => $component['extra']['prev_page_label'],
'#size' => 30,
);
diff --git a/includes/webform.pages.inc b/includes/webform.pages.inc
index 5aeaf3a..bfa0a38 100644
--- a/includes/webform.pages.inc
+++ b/includes/webform.pages.inc
@@ -238,7 +238,75 @@ function webform_configure_form($form, &$form_state, $node) {
),
),
);
- /* End progress Bar settings form */
+ /* End progress bar settings form */
+
+ /* Preview page settings form */
+ $form['preview'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Preview page'),
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ '#weight' => 18,
+ '#id' => 'webform-preview-fieldset',
+ );
+
+ $form['preview']['preview'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Enable preview page'),
+ '#description' => t('Add a page for previewing the form before submitting.'),
+ '#default_value' => $node->webform['preview'],
+ '#id' => 'webform-preview-enable'
+ );
+ $form['preview']['settings'] = array(
+ '#type' => 'container',
+ '#states' => array(
+ 'visible' => array(
+ '#webform-preview-enable' => array('checked' => TRUE),
+ ),
+ ),
+ '#id' => 'webform-preview-settings',
+ '#theme_wrappers' => array('container'),
+ );
+ $form['preview']['settings']['preview_title'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Preview page title'),
+ '#default_value' => $node->webform['preview_title'],
+ '#description' => t('The page title will be used in the progress bar (if enabled). If left blank, the default title %preview will be used.', array('%preview' => t('Preview'))),
+ );
+ $form['preview']['settings']['preview_next_button_label'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Preview button label'),
+ '#default_value' => $node->webform['preview_next_button_label'],
+ '#description' => t('The text for the button that will proceed to the preview page. If left blank, the default label %preview will be used.', array('%preview' => t('Preview'))),
+ '#size' => 20,
+ );
+ $form['preview']['settings']['preview_prev_button_label'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Previous page button label'),
+ '#default_value' => $node->webform['preview_prev_button_label'],
+ '#description' => t('The text for the button to go backwards from the preview page. If left blank, the default label %previous will be used.', array('%previous' => t('< Previous'))),
+ '#size' => 20,
+ );
+ $submit_button_text = $node->webform['submit_text'] ? t($node->webform['submit_text']) : t('Submit');
+ $preview_default_message = t('Please review your submission. Your submission is not complete until you press the "@button" button!', array('@button' => $submit_button_text));
+ $form['preview']['settings']['preview_message'] = array(
+ '#type' => 'text_format',
+ '#title' => t('Preview message'),
+ '#default_value' => $node->webform['preview_message'],
+ '#format' => $node->webform['preview_message_format'],
+ '#description' => t('A message to be displayed on the preview page. If left blank, the message "!default" will be used. Supports Webform token replacements.', array('!default' => $preview_default_message)) . ' ' . theme('webform_token_help', array('groups' => array('node', 'submission'))),
+ );
+ $form['preview']['settings']['preview_components'] = array(
+ '#type' => 'select',
+ '#title' => t('Included preview values'),
+ '#options' => webform_component_list($node, 'email', TRUE),
+ '#default_value' => array_diff(array_keys($node->webform['components']), $node->webform['preview_excluded_components']),
+ '#multiple' => TRUE,
+ '#size' => 10,
+ '#description' => t('If you wish to include only parts of the submission in the preview, select the components that should be included.'),
+ '#process' => array('webform_component_select'),
+ );
+ /* End preview page settings form */
/* Start advanced settings form */
$form['advanced'] = array(
@@ -275,9 +343,10 @@ function webform_configure_form($form, &$form_state, $node) {
);
$form['advanced']['submit_text'] = array(
'#type' => 'textfield',
- '#title' => t('Submit button text'),
+ '#title' => t('Submit button label'),
'#default_value' => $node->webform['submit_text'],
'#description' => t('By default the submit button on this form will have the label Submit. Enter a new title here to override the default.'),
+ '#size' => 20,
);
/* End Advanced Settings Form */
@@ -389,6 +458,21 @@ function webform_configure_form_submit($form, &$form_state) {
$node->webform['progressbar_label_first'] = $form_state['values']['progressbar_label_first'];
$node->webform['progressbar_label_confirmation'] = $form_state['values']['progressbar_label_confirmation'];
+ // Set the preview settings.
+ $node->webform['preview'] = (int) $form_state['values']['preview'];
+ $node->webform['preview_next_button_label'] = $form_state['values']['preview_next_button_label'];
+ $node->webform['preview_prev_button_label'] = $form_state['values']['preview_prev_button_label'];
+ $node->webform['preview_title'] = $form_state['values']['preview_title'];
+ $node->webform['preview_message'] = $form_state['values']['preview_message']['value'];
+ $node->webform['preview_message_format'] = $form_state['values']['preview_message']['format'];
+
+ // Save the list of included preview components.
+ // We actually maintain an *exclusion* list, so any new components will
+ // default to being included in the preview until unchecked.
+ $included = array_keys(array_filter((array) $form_state['values']['preview_components']));
+ $excluded = array_diff(array_keys($node->webform['components']), $included);
+ $node->webform['preview_excluded_components'] = $excluded;
+
// Set submit notice.
$node->webform['submit_notice'] = $form_state['values']['submit_notice'];
diff --git a/includes/webform.submissions.inc b/includes/webform.submissions.inc
index 5698693..9501e57 100644
--- a/includes/webform.submissions.inc
+++ b/includes/webform.submissions.inc
@@ -39,6 +39,23 @@ function webform_submission_data($node, $submitted) {
}
/**
+ * Given set of $form_state values, prepare a psuedo-submission.
+ */
+function webform_submission_create($node, $account, $form_state) {
+ $submission = (object) array(
+ 'nid' => $node->nid,
+ 'uid' => $account->uid,
+ 'submitted' => REQUEST_TIME,
+ 'remote_addr' => ip_address(),
+ 'is_draft' => TRUE,
+ 'preview' => FALSE,
+ 'data' => webform_submission_data($node, $form_state['values']['submitted']),
+ );
+ drupal_alter('webform_submission_create', $submission, $node, $account, $form_state);
+ return $submission;
+}
+
+/**
* Update a webform submission entry in the database.
*
* @param $node
@@ -567,11 +584,10 @@ function theme_webform_submission_resend($variables) {
/**
* Print a Webform submission for display on a page or in an e-mail.
*/
-function webform_submission_render($node, $submission, $email, $format) {
+function webform_submission_render($node, $submission, $email, $format, $excluded_components = array()) {
$component_tree = array();
$renderable = array();
$page_count = 1;
- $excluded_components = isset($email) ? $email['excluded_components'] : array();
// Meta data that may be useful for modules implementing
// hook_webform_submission_render_alter().
@@ -681,6 +697,7 @@ function webform_get_submissions($filters = array(), $header = NULL, $pager_coun
$submissions[$row->sid]->uid = $row->uid;
$submissions[$row->sid]->name = $row->name;
$submissions[$row->sid]->is_draft = $row->is_draft;
+ $submissions[$row->sid]->preview = FALSE;
$submissions[$row->sid]->data = array();
}
diff --git a/templates/webform-form.tpl.php b/templates/webform-form.tpl.php
index 7edc895..e7be60a 100644
--- a/templates/webform-form.tpl.php
+++ b/templates/webform-form.tpl.php
@@ -15,16 +15,27 @@
* The $form array contains two main pieces:
* - $form['submitted']: The main content of the user-created form.
* - $form['details']: Internal information stored by Webform.
+ *
+ * If a preview is enabled, these keys will be available on the preview page:
+ * - $form['preview_message']: The preview message renderable.
+ * - $form['preview']: A renderable representing the entire submission preview.
*/
?>
';
+ print drupal_render($form['preview_message']);
+ print '';
+ }
+
// 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']);
// Always print out the entire $form. This renders the remaining pieces of the
- // form that haven't yet been rendered above.
+ // form that haven't yet been rendered above (buttons, hidden elements, etc).
print drupal_render_children($form);
diff --git a/webform.api.php b/webform.api.php
index 344053a..9adddcf 100644
--- a/webform.api.php
+++ b/webform.api.php
@@ -105,6 +105,31 @@ function hook_webform_submission_load(&$submissions) {
}
/**
+ * Respond to the creation of a new submission from form values.
+ *
+ * This hook is called when a user has completed a submission to initialize the
+ * submission object. After this object has its values populated, it will be
+ * saved by webform_submission_insert(). Note that this hook is only called for
+ * new submissions, not for submissions being edited. If responding to the
+ * saving of all submissions, it's recommended to use
+ * hook_webform_submission_presave().
+ *
+ * @param $submission
+ * The submission object that has been created.
+ * @param $node
+ * The Webform node for which this submission is being saved.
+ * @param $account
+ * The user account that is creating the submission.
+ * @param $form_state
+ * The contents of form state that is the basis for this submission.
+ *
+ * @see webform_submission_create()
+ */
+function hook_webform_submission_create($submission, $node, $account, $form_state) {
+ $submission->new_property = TRUE;
+}
+
+/**
* Modify a Webform submission, prior to saving it in the database.
*
* @param $node
diff --git a/webform.install b/webform.install
index 0fd7b92..4103485 100644
--- a/webform.install
+++ b/webform.install
@@ -147,6 +147,43 @@ function webform_schema() {
'type' => 'varchar',
'length' => 255,
),
+ 'preview' => array(
+ 'description' => 'Boolean value indicating if this form includes a page for previewing the submission.',
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'preview_next_button_label' => array(
+ 'description' => 'The text for the button that will proceed to the preview page.',
+ 'type' => 'varchar',
+ 'length' => 255,
+ ),
+ 'preview_prev_button_label' => array(
+ 'description' => 'The text for the button to go backwards from the preview page.',
+ 'type' => 'varchar',
+ 'length' => 255,
+ ),
+ 'preview_title' => array(
+ 'description' => 'The title of the preview page, as used by the progress bar.',
+ 'type' => 'varchar',
+ 'length' => 255,
+ ),
+ 'preview_message' => array(
+ 'description' => 'Text shown on the preview page of the form.',
+ 'type' => 'text',
+ 'not null' => TRUE,
+ ),
+ 'preview_message_format' => array(
+ 'description' => 'The {filter_format}.format of the preview page message.',
+ 'type' => 'varchar',
+ 'length' => 255,
+ ),
+ 'preview_excluded_components' => array(
+ 'description' => 'Comma-separated list of component IDs that should not be included in this form\'s confirmation page.',
+ 'type' => 'text',
+ 'not null' => TRUE,
+ ),
),
'primary key' => array('nid'),
);
@@ -1612,3 +1649,49 @@ function webform_update_7412() {
}
variable_del('webform_node_types');
}
+
+/**
+ * Add preview page columns to the webform table.
+ */
+function webform_update_7413() {
+ if (!db_field_exists('webform', 'preview')) {
+ $int_schema = array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ );
+ $varchar_schema = array(
+ 'type' => 'varchar',
+ 'length' => 255,
+ );
+ $text_schema = array(
+ 'type' => 'text',
+ 'not null' => TRUE,
+ 'initial' => '',
+ );
+
+ $int_schema['description'] = 'Boolean value indicating if this form includes a page for previewing the submission.';
+ db_add_field('webform', 'preview', $int_schema);
+
+ $varchar_schema['description'] = 'The text for the button that will proceed to the preview page.';
+ db_add_field('webform', 'preview_next_button_label', $varchar_schema);
+
+ $varchar_schema['description'] = 'The text for the button to go backwards from the preview page.';
+ db_add_field('webform', 'preview_prev_button_label', $varchar_schema);
+
+ $varchar_schema['description'] = 'The title of the preview page, as used by the progress bar.';
+ db_add_field('webform', 'preview_title', $varchar_schema);
+
+ $text_schema['description'] = 'Text shown on the preview page of the form.';
+ db_add_field('webform', 'preview_message', $text_schema);
+
+ $varchar_schema['description'] = 'The {filter_format}.format of the preview page message.';
+ db_add_field('webform', 'preview_message_format', $varchar_schema);
+
+ $text_schema['description'] = 'Comma-separated list of component IDs that should not be included in this form\'s confirmation page.';
+ db_add_field('webform', 'preview_excluded_components', $text_schema);
+
+ return t('New webform columns added.');
+ }
+}
diff --git a/webform.module b/webform.module
index fb4f694..df728da 100644
--- a/webform.module
+++ b/webform.module
@@ -1315,9 +1315,13 @@ function webform_node_insert($node) {
module_load_include('inc', 'webform', 'includes/webform.conditionals');
module_load_include('inc', 'webform', 'includes/webform.emails');
+ // Prepare the record for writing.
+ $webform_record = $node->webform;
+ $webform_record['preview_excluded_components'] = implode(',', $webform_record['preview_excluded_components']);
+
// Insert the webform.
$node->webform['nid'] = $node->nid;
- $node->webform['record_exists'] = (bool) drupal_write_record('webform', $node->webform);
+ $node->webform['record_exists'] = (bool) drupal_write_record('webform', $webform_record);
// Insert the components into the database. Used with clone.module.
if (isset($node->webform['components']) && !empty($node->webform['components'])) {
@@ -1374,9 +1378,13 @@ function webform_node_update($node) {
return;
}
- // Update the webform entry.
+ // Prepare the record for writing.
$node->webform['nid'] = $node->nid;
- drupal_write_record('webform', $node->webform, array('nid'));
+ $webform_record = $node->webform;
+ $webform_record['preview_excluded_components'] = implode(',', $webform_record['preview_excluded_components']);
+
+ // Update the webform entry.
+ drupal_write_record('webform', $webform_record, array('nid'));
// Compare the webform components and don't do anything if it's not needed.
$original = $node->original;
@@ -1513,6 +1521,13 @@ function webform_node_defaults() {
'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'),
+ 'preview' => 0,
+ 'preview_next_button_label' => '',
+ 'preview_prev_button_label' => '',
+ 'preview_title' => '',
+ 'preview_message' => '',
+ 'preview_message_format' => NULL,
+ 'preview_excluded_components' => array(),
'status' => '1',
'record_exists' => FALSE,
'roles' => array('1', '2'),
@@ -1557,6 +1572,9 @@ function webform_node_load($nodes, $types) {
// Load the basic information for each node.
$nodes[$nid]->webform = $webform;
$nodes[$nid]->webform['record_exists'] = TRUE;
+
+ // Expand the list of excluded preview components.
+ $nodes[$nid]->webform['preview_excluded_components'] = array_filter(explode(',', $webform['preview_excluded_components']));
}
// Load the components, emails, and defaults for all webform-enabled nodes.
@@ -2196,6 +2214,11 @@ function webform_client_form($form, &$form_state, $node, $submission, $is_draft
$form_state['webform']['page_count'] = 1;
$form_state['webform']['page_num'] = 1;
_webform_components_tree_build($node->webform['components'], $form_state['webform']['component_tree'], 0, $form_state['webform']['page_count']);
+
+ // If preview is enabled, increase the page count by one.
+ if ($node->webform['preview']) {
+ $form_state['webform']['page_count']++;
+ }
}
else {
$form_state['webform']['component_tree'] = $form_state['storage']['component_tree'];
@@ -2226,12 +2249,13 @@ function webform_client_form($form, &$form_state, $node, $submission, $is_draft
}
if ($page_count > 1) {
+ $page_labels = webform_page_labels($node);
$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),
+ '#page_count' => count($page_labels),
+ '#page_labels' => $page_labels,
'#weight' => -100
);
}
@@ -2248,6 +2272,29 @@ function webform_client_form($form, &$form_state, $node, $submission, $is_draft
_webform_client_form_add_component($node, $component, $component_value, $form['submitted'], $form, $input_values, 'form', $page_num, $filter);
}
}
+ if ($node->webform['preview']) {
+ $next_page_labels[] = $node->webform['preview_next_button_label'] ? t($node->webform['preview_next_button_label']) : t('Preview');
+ $prev_page_labels[] = $node->webform['preview_prev_button_label'] ? t($node->webform['preview_prev_button_label']) : t('< Previous');
+ }
+
+ // Add the preview if needed.
+ if ($node->webform['preview'] && $page_num === $page_count) {
+ $preview_submission = webform_submission_create($node, $user, $form_state);
+ $preview_submission->preview = TRUE;
+ $preview_message = $node->webform['preview_message'];
+ $submit_button_text = empty($node->webform['submit_text']) ? t('Submit') : t($node->webform['submit_text']);
+ if (strlen(trim(strip_tags($preview_message))) === 0) {
+ $preview_message = t('Please review your submission. Your submission is not complete until you press the "!button" button!', array('!button' => $submit_button_text));
+ }
+ $preview_message = webform_replace_tokens($preview_message, $node, $submission);
+ $preview_message = check_markup($preview_message, $node->webform['preview_message_format']);
+ $form['preview_message'] = array(
+ '#type' => 'markup',
+ '#markup' => $preview_message,
+ );
+
+ $form['preview'] = webform_submission_render($node, $preview_submission, NULL, 'html', $node->webform['preview_excluded_components']);
+ }
// These form details help managing data upon submission.
$form['details']['nid'] = array(
@@ -2820,9 +2867,10 @@ function webform_client_form_pages($form, &$form_state) {
if (end($form_state['clicked_button']['#parents']) == 'next') {
$direction = 1;
}
- else {
+ elseif (end($form_state['clicked_button']['#parents']) == 'previous') {
$direction = 0;
}
+ $current_page = $form_state['storage']['page_num'];
// If the next page has no components that need to be displayed, skip it.
if (isset($direction)) {
@@ -2849,6 +2897,14 @@ function webform_client_form_pages($form, &$form_state) {
}
}
}
+
+ // The preview page is not represented by a pagebreak, if no movement has
+ // yet happened, move the form in the intended direction one page.
+ if ($node->webform['preview'] && ($direction === 0 && isset($form['preview']) || $current_page === $form_state['storage']['page_num'])) {
+ // The "Previous" button over-shoots backwards by one page. The "Next"
+ // button doesn't advance at all, so in both cases, we increment by one.
+ $form_state['storage']['page_num']++;
+ }
}
// The form is done if the page number is greater than the page count.
@@ -2906,14 +2962,8 @@ function webform_client_form_submit($form, &$form_state) {
if (!$sid) {
// Create a new submission object.
- $submission = (object) array(
- 'nid' => $node->nid,
- 'uid' => $form_state['values']['details']['uid'],
- 'submitted' => REQUEST_TIME,
- 'remote_addr' => ip_address(),
- 'is_draft' => $is_draft,
- 'data' => webform_submission_data($node, $form_state['values']['submitted']),
- );
+ $submission = webform_submission_create($node, $user, $form_state);
+ $submission->is_draft = $is_draft;
}
else {
// To maintain time and user information, load the existing submission.
@@ -3607,6 +3657,9 @@ function webform_page_labels($node) {
$page_count++;
}
}
+ if ($node->webform['preview']) {
+ $page_labels[] = $node->webform['preview_title'] ? t($node->webform['preview_title']) : t('Preview');
+ }
if ($node->webform['progressbar_include_confirmation']) {
$page_labels[] = t($node->webform['progressbar_label_confirmation']);
}
@@ -3658,6 +3711,13 @@ function webform_variable_get($variable) {
return $result;
}
+/**
+ * Output the contents of token help used throughout Webform.
+ *
+ * In earlier versions of Token, a fieldset is used to show all the tokens.
+ * Later versions now use a modal dialog that is accessed through a link. If
+ * Token module is not available, a message should be displayed.
+ */
function theme_webform_token_help($variables) {
$groups = $variables['groups'];
diff --git a/webform.tokens.inc b/webform.tokens.inc
index 24b95fb..e2d4baf 100644
--- a/webform.tokens.inc
+++ b/webform.tokens.inc
@@ -71,8 +71,10 @@ function webform_tokens($type, $tokens, array $data = array(), array $options =
$submission = $data['webform-submission'];
$node = isset($data['node']) ? $data['node'] : node_load($submission->nid);
$email = isset($data['webform-email']) ? $data['webform-email'] : NULL;
+ $excluded_components = isset($email['excluded_components']) ? $email['excluded_components'] : array();
$format = $sanitize ? 'html' : 'text';
- $submission_renderable = webform_submission_render($node, $submission, $email, $format);
+
+ $submission_renderable = webform_submission_render($node, $submission, $email, $format, $excluded_components);
// Replace individual tokens that have an exact replacement.
foreach ($tokens as $name => $original) {