developer/examples/multipage_form_example.module

<?php

// $Id: multipage_form_example.module,v 1.8 2006/04/08 03:35:39 drumm Exp $

/**
 * Implementation of hook_help().
 */
function multipage_form_example_help($section) {
  switch ($section) {
    case 'admin/modules#description':
      return t('An example module showing how to handle multipage forms in FAPI.');
    case 'node/add#multipage_form_example':
      return t('This will show you an example multipage form submission.');
  }
}

/**
 * Implementation of hook_menu().
 */
function multipage_form_example_menu($may_cache) {
  $items = array();

  if (!$may_cache) {

    $items[] = array('title'    => t('multipage form example'),
                     'path'     => 'node/add/multipage_form_example',
                     'access'   => TRUE,
    );
  }

  return $items;
}

/**
 * Implementation of hook_access().
 */
function multipage_form_example_access($op, $node) {
  return TRUE;
}

/**
 * Implementation of hook_node_info().
 */
function multipage_form_example_node_info() {
  return array('multipage_form_example' => array('name' => t('multipage form example'), 'base' => 'multipage_form_example'));
}

/**
 * Implementation of hook_form() for multipage_form_example. We don't set ANY
 * #required attributes here - we leave that up to multipage_form_example_pre_render().
 */
function multipage_form_example_form(&$node) {
  $form = array();

  // 'checkboxes' elements are just ridiculously hard--i recommend just
  //  using a bunch of individual checkbox elements instead.
  //  I suspect that multiselects would also be pretty difficult...

  // Here's a new form element, which enables you to store hidden values
  // in an array.  Check out the element definition functions at the bottom
  // if you want to use this in a module.  Keys show up in the
  // $_POST/$form_values like:
  // $_POST['edit']['test_hidden_array']['n'] = 'north'
  // $form_values['test_hidden_array']['n'] = 'north'

  $form['test_hidden_array'] = array(
    '#type'          => 'hidden_array',
    '#values'        => array('n' => 'north', 'e' => 'east', 'w' => 'west', 's' => 'south', ),
  );


  // Helper for our multipage - does field switching, sets options
  // based on validated $form_values instead of $_POST, and so forth.
  $form['#pre_render'] = array('multipage_form_example_pre_render');

  // Title and body, page 1
  $form['title'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Title'),
    '#default_value' => isset($node->title) ? $node->title : NULL,
    '#description'   => t("Enter a title for your favorites section."),
    '#size'          => 60,
    '#maxlength'     => 128,
    '#required'      => TRUE,
  );
  $form['body'] = array(
    '#type'          => 'textarea',
    '#title'         => t('Description'),
    '#default_value' => isset($node->body) ? $node->body : NULL,
    '#description'   => t('Add any additional info about your favorites.'),
    '#rows'          => 20,
  );

  // Person, page 2
  $form['person'] = array(
    '#type'          => 'fieldset',
    '#title'         => t('Your favorite person'),
  );
  $form['person']['fav_person'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Name'),
    '#default_value' => isset($node->fav_person) ? $node->fav_person : NULL,
    '#description'   => t('Enter their real name, or their code name if they like to fly stealth.'),
    '#required'      => TRUE,
  );
  $form['person']['fav_person_desc'] = array(
    '#type'          => 'textarea',
    '#title'         => t('Description'),
    '#default_value' => isset($node->fav_person_desc) ? $node->fav_person_desc : NULL,
    '#description'   => t('Juicy details go here...'),
    '#required'      => TRUE,
  );
  $form['person']['fav_gummi'] = array(
    '#type'          => 'checkbox',
    '#default_value' => isset($node->fav_gummi) ? $node->fav_gummi : 0,
    '#title'         => t('Do they like gummi bears?'),
  );

  // Color and number, page 3
  $form['fav_color'] = array(
    '#type'          => 'select',
    '#title'         => t('Favorite color'),
    '#default_value' => isset($node->fav_color) ? $node->fav_color : 'red',
    '#options'       => array('red' => t('Red'), 'green' => t('Green'), 'blue' => t('Blue'), 'yellow' => t('Yellow')),
    '#required'      => TRUE,
  );
  $form['fav_number'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Favorite number'),
    '#default_value' => isset($node->fav_number) ? $node->fav_number : NULL,
    '#required'      => TRUE,
  );

  // Movie and tv show, page 4
  $form['fav_movie'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Favorite movie'),
    '#default_value' => isset($node->fav_movie) ? $node->fav_movie : NULL,
    '#required'      => TRUE,
  );
  $form['fav_tv'] = array(
    '#type'          => 'radios',
    '#title'         => t('How often do you watch your favorite tv show?'),
    '#default_value' => isset($node->fav_tv) ? $node->fav_tv : 'daily',
    '#options'       => array('daily' => t('Daily'), 'weekly' => t('Weekly'), 'monthly' => t('Monthly'),),
    '#required'      => TRUE,
  );

  // Add a back button
  $form['back'] = array(
    '#type'          => 'button',
    '#value'         => t('Back'),
    '#weight'        => 35,
  );

  return $form;
}

function theme_multipage_form_example_node_form($form) {
  $content = '';

  if (in_array($form['page']['#value'], array(3,4))) {
    $content .= '<p>'. t('Your favorite person is %person, and they %like gummi bears.', array('%person' => check_plain($form['person']['fav_person']['#value']), '%like' => ($form['person']['fav_gummi']['#value'] ? t('like') : t('don\'t like')))) .'</p>';
  }

  if (in_array($form['page']['#value'], array(4))) {
    $content .= '<p>'. t('Your favorite color is %color, and your favorite number is %number.', array('%color' => check_plain($form['fav_color']['#value']), '%number' => check_plain($form['fav_number']['#value'])));
  }

  foreach (element_children($form) as $key) {
    $content .= form_render($form[$key]);
  }
  return $content;
}

/**
 * Implementation of hook_form_alter(). Here, we set up the 'page' field,
 * which keeps track of what stage the form is in.
 */
function multipage_form_example_form_alter($form_id, &$form) {
  // Make sure it's our multipage form.
  if ($form_id == 'multipage_form_example_node_form') {

    // Determine which page of the multipage form we're on. We don't do
    // any incrementing here - that's something that our #pre_render'er
    // will do when this page of the form has successfully validated.
    $form['page'] = array(
      '#type' => 'hidden',
      '#value' => isset($_POST['edit']['page']) ? $_POST['edit']['page'] : 1,
    );

    // If back button is pressed, back up the form stage, Also, if preview
    // is hit we need to decrement the counter here to keep us on the same page.
    if ($_POST['op'] == t('Back')) {
      $form['page']['#value']--;
    }

    // This modifies the form for validation purposes. once validation is
    // completed, it'll be called one more time (through Drupal's Form API)
    // at which point it'll advance the form to the next page.
    multipage_form_example_pre_render($form_id, $form, FALSE);

    // Here we're augmenting the regular node form validation/submission with
    // some of our own.  Note that these are inside the conditional check for
    // this particular form.
    $form['#validate'] = array_merge($form['#validate'], array('multipage_form_example_custom_validate' => array()));
    $form['#submit'] = array_merge($form['#submit'], array('multipage_form_example_custom_submit' => array()));
  }

  return $form;
}

/**
 * Validate our form.
 */
function multipage_form_example_custom_validate() {
  global $form_values;
  // validate our number, but don't bother if the back button was hit
  if (($form_values['page'] ==  3 ) && !is_numeric($form_values['fav_number']) && ($_POST['op'] != t('Back'))) {
    form_set_error('fav_number', t('Favorite number is a <em>number</em>, dummy!'));
  }
}

/**
 * The #pre_render of a form allows us to make changes AFTER validation (unlike
 * hook_form_alter()), but BEFORE the form has actually been displayed. We use
 * it to control which form elements are shown, which are hidden, and which values
 * to set based on validate elements, not $_POST. This is a necessity for our
 * complicated multipage example form.
 */
function multipage_form_example_pre_render($form_id, &$form, $next_page = TRUE) {
  global $form_values;

  // Make sure it's our multipage form.
  if ($form_id == 'multipage_form_example_node_form') {
    // Are we ready for the next page in our form?
    if ($next_page && isset($_POST['edit']['page']) && ($_POST['op'] != t('Back')) && ($_POST['op'] != t('Preview'))) {
      $form['page']['#value'] = $form['page']['#value'] + 1;
    }

    // Validation errors? Show previous page for correcting.
    if (form_get_errors()) {
      $form['page']['#value']--;
    }

    // Modify the #required/#type values depending on our current page.
    // The arrays tell us the pages the changes should take place in.

    // Title/body, stage 1
    multipage_form_set_element_visibility($form['title'],                     in_array($form['page']['#value'], array(1)));
    multipage_form_set_element_visibility($form['body'],                      in_array($form['page']['#value'], array(1)));

    // Person, stage 2
    multipage_form_set_element_visibility($form['person'],                    in_array($form['page']['#value'], array(2)));
    multipage_form_set_element_visibility($form['person']['fav_person'],      in_array($form['page']['#value'], array(2)));
    multipage_form_set_element_visibility($form['person']['fav_person_desc'], in_array($form['page']['#value'], array(2)));
    multipage_form_set_element_visibility($form['person']['fav_gummi'],       in_array($form['page']['#value'], array(2)), $next_page);

    // Color and number, page 3
    multipage_form_set_element_visibility($form['fav_color'],                 in_array($form['page']['#value'], array(3)));
    multipage_form_set_element_visibility($form['fav_number'],                in_array($form['page']['#value'], array(3)));

    // Movie and tv show, page 4
    multipage_form_set_element_visibility($form['fav_movie'],                 in_array($form['page']['#value'], array(4)));
    multipage_form_set_element_visibility($form['fav_tv'],                    in_array($form['page']['#value'], array(4)), $next_page);

    // Buttons
    multipage_form_set_element_visibility($form['back'],                      in_array($form['page']['#value'], array(2, 3, 4)), $next_page);
    multipage_form_set_element_visibility($form['preview'],                   in_array($form['page']['#value'], array(4)), $next_page);
    multipage_form_set_element_visibility($form['submit'],                    in_array($form['page']['#value'], array(4)), $next_page);

    // The button text actually helps determine if a form has actually been
    // submitted because the name is also the value of a clicked button. By
    // changing it for building, but not rendering, the form is not fully
    // sumbitted until we name it 'Submit', the usual value.
    if ($next_page) {
      $submit_text = array(NULL, t('Next (person)'), t('Next (color/number)'), t('Next (tv/movie)'), t('Submit'));
      $form['submit']['#value'] = $submit_text[$form['page']['#value']];
    }
  }
}

// Handles form submission.  We're just throwing our data into the variable
// table to keep things simple
function multipage_form_example_custom_submit() {
  global $form_values;
  foreach ($form_values as $key => $value) {
    if (in_array($key, array('fav_person', 'fav_person_desc', 'fav_gummi', 'fav_color', 'fav_number', 'fav_movie', 'fav_tv',))) {
      $array[$key] = $value;
    }
  }

    // A little hack so we can save new node info properly to the variable table
  if (isset($form_values['nid'])) {
    $nid = $form_values['nid'];
  }
  else {
    $nid = db_result(db_query("SELECT id FROM {sequences} WHERE name = 'node_nid'"));
  }

  variable_set('multipage_form_example_'. $nid, $array);
}

/**
 * Implementation of hook_load().
 *
 * Now that we've defined how to manage the node data in the database, We
 * need to tell Drupal how to get the node back out. This hook is called
 * every time a node is loaded, and allows us to do some loading of our own.
 */
function multipage_form_example_load($node) {
  $additions = variable_get('multipage_form_example_'. $node->nid, NULL);
  $additions = (object) $additions;
  return $additions;
}

/**
 * Implementation of hook_delete().
 *
 * Clean up our data in variable table.
 */
function multipage_form_example_delete($node) {
  // Notice that we're matching all revision, by using the node's nid.
  variable_del('multipage_form_example_'. $node->nid);
}

/**
 * Implementation of hook_view().
 *
 * This is a typical implementation that simply runs the node text through
 * the output filters.
 */
function multipage_form_example_view(&$node, $teaser = FALSE, $page = FALSE) {
  $node = node_prepare($node, $teaser);
  $favorites = theme('multipage_form_example', $node);
  $node->body .= $favorites;
  $node->teaser .= $favorites;
}

/**
 * A custom theme function.
 *
 * By using this function to format our node-specific information, themes
 * can override this presentation if they wish. We also wrap the default
 * presentation in a CSS class that is prefixed by the module name. This
 * way, style sheets can modify the output without requiring theme code.
 */
function theme_multipage_form_example($node) {
  $person_display = t('Your favorite person is %person, and they %like gummi bears. <br \>', array('%person' => check_plain($node->fav_person), '%like' => ($node->fav_gummi ? t('like') : t('don\'t like'))));
  $color_number_display = t('Your favorite color is %color, and your favorite number is %number. <br \>', array('%color' => check_plain($node->fav_color), '%number' => check_plain($node->fav_number)));
  $tv_movie_display = t('Your favorite movie is %movie, and you watch your favorite tv show %watch.', array('%movie' => check_plain($node->fav_movie), '%watch' => check_plain($node->fav_tv)));

  $output = '<div class="multipage_form_example">';
  $output .= $person_display . $color_number_display . $tv_movie_display;
  $output .= '</div>';

  return $output;
}

/**
 * Set an element's visibility. Elements are gnerally changed to hidden
 * elements. Visibility may be set and reset any number of times.
 *
 * @param $element
 *   The form element array to modify.
 * @param $visible
 *   The desired visibity of the form element.
 * @param $next_page
 *   Boolean value, TRUE if the next page is about to be rendered, FALSE otherwise.
 */
function multipage_form_set_element_visibility(&$element, $visible, $next_page = TRUE) {
  multipage_form_restore_attributes($element);
  if (!$visible) {
    switch ($element['#type']) {
      case 'textfield':
      case 'textarea':
      case 'select':
        multipage_form_set_attribute($element, '#type', 'hidden');
        multipage_form_set_attribute($element, '#required', FALSE);
        break;

      case 'radios':
        // Radios elements cannot be hidden unless they have been processed.
        if ($next_page) {
          multipage_form_set_attribute($element, '#type', 'hidden');
          multipage_form_set_attribute($element, '#required', FALSE);
        }
        break;

      case 'radio':
      case 'checkbox':
        // We can't change these to hidden until right before the next page is rendered, otherwise
        // the value is lost sometimes.
        if ($next_page) {
          multipage_form_set_attribute($element, '#type', 'hidden');
        }
        break;

      case 'fieldset':
        multipage_form_set_attribute($element, '#type', NULL);
        break;

      case 'button':
        if ($next_page) {
          multipage_form_set_attribute($element, '#type', 'value');
        }
        break;

      case 'submit':
        if ($next_page) {
          multipage_form_set_attribute($element, '#type', 'button');
        }
        break;
    }
  }

  foreach (element_children($element) as $key) {
    multipage_form_set_element_visibility($element[$key], $visible, $next_page);
  }
}

/**
 * Set an attribute on an element array with storing the previous value which
 * may be reverted to using multipage_form_restore_attributes().
 *
 * @param $element
 *   The form element array to modify.
 * @param $key
 *   A key of the form element array.
 * @param $new_value
 *   The new value for the attribute.
 */
function multipage_form_set_attribute(&$element, $key, $new_value) {
  $element['#multipage_form_original_'. $key] = $element[$key];
  $element[$key] = $new_value;
}

/**
 * Restore any form attributes which have been set using
 * multipage_form_set_attribute().
 *
 * @param $element
 *   The form element array to restore.
 */
function multipage_form_restore_attributes(&$element) {
  foreach (array_filter(array_keys($element), create_function('$key', 'return (strpos($key, "#multipage_form_original_") === 0);')) as $key) {
    $element[str_replace('#multipage_form_original_', '', $key)] = $element[$key];
  }
}

/**
 * Playing around here with a new form element to enable storing hidden values in an array fashion.
 * Seems to work fine.  Check out $form['test_hidden_array'] above for how to structure the form
 * element
 */
function multipage_form_example_elements() {
  $type['hidden_array'] = array('#input' => TRUE, '#process' => array('expand_hidden_array' => array()), '#tree' => TRUE);
  return $type;
}

function expand_hidden_array($element) {
  $values = is_array($element['#values']) ? $element['#values'] : array();
  $element['#tree'] = TRUE;
  foreach ($values as $key => $value) {
    $element[$key] = array('#type' => 'hidden', '#processed' => TRUE, '#value' => $value);
  }
  return $element;
}

function theme_hidden_array($element) {
  return $element['#children'];
}
1	jvandyk	1.1	<?php
2
3	davereid	1.9	// $Id: multipage_form_example.module,v 1.8 2006/04/08 03:35:39 drumm Exp $
4	jvandyk	1.1
5			/**
6			* Implementation of hook_help().
7			*/
8			function multipage_form_example_help($section) {
9			switch ($section) {
10			case 'admin/modules#description':
11			return t('An example module showing how to handle multipage forms in FAPI.');
12			case 'node/add#multipage_form_example':
13			return t('This will show you an example multipage form submission.');
14			}
15			}
16
17			/**
18			* Implementation of hook_menu().
19			*/
20			function multipage_form_example_menu($may_cache) {
21			$items = array();
22
23			if (!$may_cache) {
24
25			$items[] = array('title' => t('multipage form example'),
26			'path' => 'node/add/multipage_form_example',
27			'access' => TRUE,
28			);
29			}
30
31			return $items;
32			}
33
34			/**
35			* Implementation of hook_access().
36			*/
37			function multipage_form_example_access($op, $node) {
38			return TRUE;
39			}
40
41			/**
42			* Implementation of hook_node_info().
43			*/
44			function multipage_form_example_node_info() {
45			return array('multipage_form_example' => array('name' => t('multipage form example'), 'base' => 'multipage_form_example'));
46			}
47
48			/**
49			* Implementation of hook_form() for multipage_form_example. We don't set ANY
50			* #required attributes here - we leave that up to multipage_form_example_pre_render().
51			*/
52			function multipage_form_example_form(&$node) {
53			$form = array();
54
55			// 'checkboxes' elements are just ridiculously hard--i recommend just
56			// using a bunch of individual checkbox elements instead.
57			// I suspect that multiselects would also be pretty difficult...
58
59			// Here's a new form element, which enables you to store hidden values
60			// in an array. Check out the element definition functions at the bottom
61			// if you want to use this in a module. Keys show up in the
62			// $_POST/$form_values like:
63			// $_POST['edit']['test_hidden_array']['n'] = 'north'
64			// $form_values['test_hidden_array']['n'] = 'north'
65
66			$form['test_hidden_array'] = array(
67			'#type' => 'hidden_array',
68			'#values' => array('n' => 'north', 'e' => 'east', 'w' => 'west', 's' => 'south', ),
69			);
70
71
72
73			// Helper for our multipage - does field switching, sets options
74			// based on validated $form_values instead of $_POST, and so forth.
75			$form['#pre_render'] = array('multipage_form_example_pre_render');
76
77	drumm	1.2	// Title and body, page 1
78	jvandyk	1.1	$form['title'] = array(
79			'#type' => 'textfield',
80			'#title' => t('Title'),
81			'#default_value' => isset($node->title) ? $node->title : NULL,
82			'#description' => t("Enter a title for your favorites section."),
83			'#size' => 60,
84			'#maxlength' => 128,
85	drumm	1.2	'#required' => TRUE,
86	jvandyk	1.1	);
87			$form['body'] = array(
88			'#type' => 'textarea',
89			'#title' => t('Description'),
90			'#default_value' => isset($node->body) ? $node->body : NULL,
91			'#description' => t('Add any additional info about your favorites.'),
92			'#rows' => 20,
93			);
94
95			// Person, page 2
96			$form['person'] = array(
97	drumm	1.2	'#type' => 'fieldset',
98	jvandyk	1.1	'#title' => t('Your favorite person'),
99	drumm	1.2	);
100	jvandyk	1.1	$form['person']['fav_person'] = array(
101			'#type' => 'textfield',
102			'#title' => t('Name'),
103			'#default_value' => isset($node->fav_person) ? $node->fav_person : NULL,
104			'#description' => t('Enter their real name, or their code name if they like to fly stealth.'),
105	drumm	1.2	'#required' => TRUE,
106	jvandyk	1.1	);
107			$form['person']['fav_person_desc'] = array(
108			'#type' => 'textarea',
109			'#title' => t('Description'),
110			'#default_value' => isset($node->fav_person_desc) ? $node->fav_person_desc : NULL,
111			'#description' => t('Juicy details go here...'),
112	drumm	1.2	'#required' => TRUE,
113	jvandyk	1.1	);
114			$form['person']['fav_gummi'] = array(
115			'#type' => 'checkbox',
116			'#default_value' => isset($node->fav_gummi) ? $node->fav_gummi : 0,
117			'#title' => t('Do they like gummi bears?'),
118			);
119
120			// Color and number, page 3
121			$form['fav_color'] = array(
122			'#type' => 'select',
123			'#title' => t('Favorite color'),
124			'#default_value' => isset($node->fav_color) ? $node->fav_color : 'red',
125			'#options' => array('red' => t('Red'), 'green' => t('Green'), 'blue' => t('Blue'), 'yellow' => t('Yellow')),
126	drumm	1.2	'#required' => TRUE,
127	jvandyk	1.1	);
128			$form['fav_number'] = array(
129			'#type' => 'textfield',
130			'#title' => t('Favorite number'),
131			'#default_value' => isset($node->fav_number) ? $node->fav_number : NULL,
132	drumm	1.2	'#required' => TRUE,
133	jvandyk	1.1	);
134
135			// Movie and tv show, page 4
136			$form['fav_movie'] = array(
137			'#type' => 'textfield',
138			'#title' => t('Favorite movie'),
139			'#default_value' => isset($node->fav_movie) ? $node->fav_movie : NULL,
140	drumm	1.2	'#required' => TRUE,
141	jvandyk	1.1	);
142			$form['fav_tv'] = array(
143			'#type' => 'radios',
144			'#title' => t('How often do you watch your favorite tv show?'),
145			'#default_value' => isset($node->fav_tv) ? $node->fav_tv : 'daily',
146			'#options' => array('daily' => t('Daily'), 'weekly' => t('Weekly'), 'monthly' => t('Monthly'),),
147	drumm	1.2	'#required' => TRUE,
148	jvandyk	1.1	);
149
150			// Add a back button
151			$form['back'] = array(
152			'#type' => 'button',
153			'#value' => t('Back'),
154	drumm	1.2	'#weight' => 35,
155	jvandyk	1.1	);
156
157			return $form;
158			}
159
160	drumm	1.3	function theme_multipage_form_example_node_form($form) {
161			$content = '';
162
163			if (in_array($form['page']['#value'], array(3,4))) {
164			$content .= '<p>'. t('Your favorite person is %person, and they %like gummi bears.', array('%person' => check_plain($form['person']['fav_person']['#value']), '%like' => ($form['person']['fav_gummi']['#value'] ? t('like') : t('don\'t like')))) .'</p>';
165			}
166
167			if (in_array($form['page']['#value'], array(4))) {
168			$content .= '<p>'. t('Your favorite color is %color, and your favorite number is %number.', array('%color' => check_plain($form['fav_color']['#value']), '%number' => check_plain($form['fav_number']['#value'])));
169			}
170
171			foreach (element_children($form) as $key) {
172			$content .= form_render($form[$key]);
173			}
174			return $content;
175			}
176
177	jvandyk	1.1	/**
178			* Implementation of hook_form_alter(). Here, we set up the 'page' field,
179			* which keeps track of what stage the form is in.
180			*/
181			function multipage_form_example_form_alter($form_id, &$form) {
182			// Make sure it's our multipage form.
183			if ($form_id == 'multipage_form_example_node_form') {
184
185			// Determine which page of the multipage form we're on. We don't do
186			// any incrementing here - that's something that our #pre_render'er
187			// will do when this page of the form has successfully validated.
188	drumm	1.3	$form['page'] = array(
189			'#type' => 'hidden',
190			'#value' => isset($_POST['edit']['page']) ? $_POST['edit']['page'] : 1,
191			);
192	jvandyk	1.1
193			// If back button is pressed, back up the form stage, Also, if preview
194			// is hit we need to decrement the counter here to keep us on the same page.
195	thehunmonkgroup	1.6	if ($_POST['op'] == t('Back')) {
196	drumm	1.3	$form['page']['#value']--;
197			}
198	jvandyk	1.1
199			// This modifies the form for validation purposes. once validation is
200			// completed, it'll be called one more time (through Drupal's Form API)
201			// at which point it'll advance the form to the next page.
202			multipage_form_example_pre_render($form_id, $form, FALSE);
203
204			// Here we're augmenting the regular node form validation/submission with
205			// some of our own. Note that these are inside the conditional check for
206			// this particular form.
207	thehunmonkgroup	1.6	$form['#validate'] = array_merge($form['#validate'], array('multipage_form_example_custom_validate' => array()));
208			$form['#submit'] = array_merge($form['#submit'], array('multipage_form_example_custom_submit' => array()));
209	jvandyk	1.1	}
210
211			return $form;
212			}
213
214			/**
215			* Validate our form.
216			*/
217	thehunmonkgroup	1.6	function multipage_form_example_custom_validate() {
218	jvandyk	1.1	global $form_values;
219			// validate our number, but don't bother if the back button was hit
220			if (($form_values['page'] == 3 ) && !is_numeric($form_values['fav_number']) && ($_POST['op'] != t('Back'))) {
221			form_set_error('fav_number', t('Favorite number is a <em>number</em>, dummy!'));
222			}
223			}
224
225			/**
226			* The #pre_render of a form allows us to make changes AFTER validation (unlike
227			* hook_form_alter()), but BEFORE the form has actually been displayed. We use
228			* it to control which form elements are shown, which are hidden, and which values
229			* to set based on validate elements, not $_POST. This is a necessity for our
230			* complicated multipage example form.
231			*/
232			function multipage_form_example_pre_render($form_id, &$form, $next_page = TRUE) {
233			global $form_values;
234
235			// Make sure it's our multipage form.
236			if ($form_id == 'multipage_form_example_node_form') {
237			// Are we ready for the next page in our form?
238	thehunmonkgroup	1.6	if ($next_page && isset($_POST['edit']['page']) && ($_POST['op'] != t('Back')) && ($_POST['op'] != t('Preview'))) {
239	jvandyk	1.1	$form['page']['#value'] = $form['page']['#value'] + 1;
240			}
241
242			// Validation errors? Show previous page for correcting.
243	drumm	1.2	if (form_get_errors()) {
244			$form['page']['#value']--;
245			}
246	jvandyk	1.1
247			// Modify the #required/#type values depending on our current page.
248			// The arrays tell us the pages the changes should take place in.
249
250			// Title/body, stage 1
251	drumm	1.2	multipage_form_set_element_visibility($form['title'], in_array($form['page']['#value'], array(1)));
252			multipage_form_set_element_visibility($form['body'], in_array($form['page']['#value'], array(1)));
253	jvandyk	1.1
254			// Person, stage 2
255	drumm	1.2	multipage_form_set_element_visibility($form['person'], in_array($form['page']['#value'], array(2)));
256			multipage_form_set_element_visibility($form['person']['fav_person'], in_array($form['page']['#value'], array(2)));
257			multipage_form_set_element_visibility($form['person']['fav_person_desc'], in_array($form['page']['#value'], array(2)));
258	thehunmonkgroup	1.7	multipage_form_set_element_visibility($form['person']['fav_gummi'], in_array($form['page']['#value'], array(2)), $next_page);
259	jvandyk	1.1
260			// Color and number, page 3
261	drumm	1.2	multipage_form_set_element_visibility($form['fav_color'], in_array($form['page']['#value'], array(3)));
262			multipage_form_set_element_visibility($form['fav_number'], in_array($form['page']['#value'], array(3)));
263	jvandyk	1.1
264			// Movie and tv show, page 4
265	drumm	1.2	multipage_form_set_element_visibility($form['fav_movie'], in_array($form['page']['#value'], array(4)));
266	drumm	1.8	multipage_form_set_element_visibility($form['fav_tv'], in_array($form['page']['#value'], array(4)), $next_page);
267	jvandyk	1.1
268	drumm	1.8	// Buttons
269			multipage_form_set_element_visibility($form['back'], in_array($form['page']['#value'], array(2, 3, 4)), $next_page);
270			multipage_form_set_element_visibility($form['preview'], in_array($form['page']['#value'], array(4)), $next_page);
271			multipage_form_set_element_visibility($form['submit'], in_array($form['page']['#value'], array(4)), $next_page);
272
273			// The button text actually helps determine if a form has actually been
274			// submitted because the name is also the value of a clicked button. By
275			// changing it for building, but not rendering, the form is not fully
276			// sumbitted until we name it 'Submit', the usual value.
277	jvandyk	1.1	if ($next_page) {
278			$submit_text = array(NULL, t('Next (person)'), t('Next (color/number)'), t('Next (tv/movie)'), t('Submit'));
279	drumm	1.2	$form['submit']['#value'] = $submit_text[$form['page']['#value']];
280	jvandyk	1.1	}
281			}
282			}
283
284			// Handles form submission. We're just throwing our data into the variable
285			// table to keep things simple
286	thehunmonkgroup	1.6	function multipage_form_example_custom_submit() {
287	jvandyk	1.1	global $form_values;
288			foreach ($form_values as $key => $value) {
289			if (in_array($key, array('fav_person', 'fav_person_desc', 'fav_gummi', 'fav_color', 'fav_number', 'fav_movie', 'fav_tv',))) {
290			$array[$key] = $value;
291			}
292			}
293	thehunmonkgroup	1.6
294			// A little hack so we can save new node info properly to the variable table
295			if (isset($form_values['nid'])) {
296			$nid = $form_values['nid'];
297			}
298			else {
299			$nid = db_result(db_query("SELECT id FROM {sequences} WHERE name = 'node_nid'"));
300			}
301
302			variable_set('multipage_form_example_'. $nid, $array);
303	jvandyk	1.1	}
304
305			/**
306			* Implementation of hook_load().
307			*
308			* Now that we've defined how to manage the node data in the database, We
309			* need to tell Drupal how to get the node back out. This hook is called
310			* every time a node is loaded, and allows us to do some loading of our own.
311			*/
312			function multipage_form_example_load($node) {
313			$additions = variable_get('multipage_form_example_'. $node->nid, NULL);
314			$additions = (object) $additions;
315			return $additions;
316			}
317
318			/**
319			* Implementation of hook_delete().
320			*
321			* Clean up our data in variable table.
322			*/
323			function multipage_form_example_delete($node) {
324			// Notice that we're matching all revision, by using the node's nid.
325			variable_del('multipage_form_example_'. $node->nid);
326			}
327
328			/**
329			* Implementation of hook_view().
330			*
331			* This is a typical implementation that simply runs the node text through
332			* the output filters.
333			*/
334			function multipage_form_example_view(&$node, $teaser = FALSE, $page = FALSE) {
335			$node = node_prepare($node, $teaser);
336			$favorites = theme('multipage_form_example', $node);
337			$node->body .= $favorites;
338			$node->teaser .= $favorites;
339			}
340
341			/**
342			* A custom theme function.
343			*
344			* By using this function to format our node-specific information, themes
345			* can override this presentation if they wish. We also wrap the default
346			* presentation in a CSS class that is prefixed by the module name. This
347			* way, style sheets can modify the output without requiring theme code.
348			*/
349			function theme_multipage_form_example($node) {
350			$person_display = t('Your favorite person is %person, and they %like gummi bears. <br \>', array('%person' => check_plain($node->fav_person), '%like' => ($node->fav_gummi ? t('like') : t('don\'t like'))));
351			$color_number_display = t('Your favorite color is %color, and your favorite number is %number. <br \>', array('%color' => check_plain($node->fav_color), '%number' => check_plain($node->fav_number)));
352			$tv_movie_display = t('Your favorite movie is %movie, and you watch your favorite tv show %watch.', array('%movie' => check_plain($node->fav_movie), '%watch' => check_plain($node->fav_tv)));
353
354			$output = '<div class="multipage_form_example">';
355			$output .= $person_display . $color_number_display . $tv_movie_display;
356			$output .= '</div>';
357	drumm	1.2
358	jvandyk	1.1	return $output;
359			}
360
361			/**
362	drumm	1.5	* Set an element's visibility. Elements are gnerally changed to hidden
363			* elements. Visibility may be set and reset any number of times.
364			*
365			* @param $element
366			* The form element array to modify.
367			* @param $visible
368			* The desired visibity of the form element.
369	thehunmonkgroup	1.7	* @param $next_page
370			* Boolean value, TRUE if the next page is about to be rendered, FALSE otherwise.
371	jvandyk	1.1	*/
372	thehunmonkgroup	1.7	function multipage_form_set_element_visibility(&$element, $visible, $next_page = TRUE) {
373	drumm	1.2	multipage_form_restore_attributes($element);
374			if (!$visible) {
375			switch ($element['#type']) {
376			case 'textfield':
377			case 'textarea':
378			case 'select':
379			multipage_form_set_attribute($element, '#type', 'hidden');
380			multipage_form_set_attribute($element, '#required', FALSE);
381			break;
382
383	drumm	1.8	case 'radios':
384			// Radios elements cannot be hidden unless they have been processed.
385			if ($next_page) {
386			multipage_form_set_attribute($element, '#type', 'hidden');
387			multipage_form_set_attribute($element, '#required', FALSE);
388			}
389			break;
390
391	drumm	1.2	case 'radio':
392			case 'checkbox':
393	thehunmonkgroup	1.7	// We can't change these to hidden until right before the next page is rendered, otherwise
394			// the value is lost sometimes.
395			if ($next_page) {
396			multipage_form_set_attribute($element, '#type', 'hidden');
397			}
398	drumm	1.2	break;
399
400			case 'fieldset':
401			multipage_form_set_attribute($element, '#type', NULL);
402			break;
403
404			case 'button':
405	drumm	1.8	if ($next_page) {
406			multipage_form_set_attribute($element, '#type', 'value');
407			}
408	drumm	1.2	break;
409
410			case 'submit':
411	drumm	1.8	if ($next_page) {
412			multipage_form_set_attribute($element, '#type', 'button');
413			}
414	drumm	1.2	break;
415			}
416			}
417
418	jvandyk	1.1	foreach (element_children($element) as $key) {
419	drumm	1.8	multipage_form_set_element_visibility($element[$key], $visible, $next_page);
420	drumm	1.2	}
421			}
422
423			/**
424	drumm	1.4	* Set an attribute on an element array with storing the previous value which
425			* may be reverted to using multipage_form_restore_attributes().
426	drumm	1.2	*
427			* @param $element
428	drumm	1.4	* The form element array to modify.
429			* @param $key
430			* A key of the form element array.
431	drumm	1.2	* @param $new_value
432	drumm	1.4	* The new value for the attribute.
433	drumm	1.2	*/
434			function multipage_form_set_attribute(&$element, $key, $new_value) {
435			$element['#multipage_form_original_'. $key] = $element[$key];
436			$element[$key] = $new_value;
437			}
438
439	drumm	1.4	/**
440			* Restore any form attributes which have been set using
441			* multipage_form_set_attribute().
442			*
443			* @param $element
444			* The form element array to restore.
445			*/
446	drumm	1.2	function multipage_form_restore_attributes(&$element) {
447			foreach (array_filter(array_keys($element), create_function('$key', 'return (strpos($key, "#multipage_form_original_") === 0);')) as $key) {
448			$element[str_replace('#multipage_form_original_', '', $key)] = $element[$key];
449	jvandyk	1.1	}
450			}
451
452			/**
453			* Playing around here with a new form element to enable storing hidden values in an array fashion.
454			* Seems to work fine. Check out $form['test_hidden_array'] above for how to structure the form
455			* element
456			*/
457			function multipage_form_example_elements() {
458	davereid	1.9	$type['hidden_array'] = array('#input' => TRUE, '#process' => array('expand_hidden_array' => array()), '#tree' => TRUE);
459			return $type;
460	jvandyk	1.1	}
461
462			function expand_hidden_array($element) {
463			$values = is_array($element['#values']) ? $element['#values'] : array();
464			$element['#tree'] = TRUE;
465			foreach ($values as $key => $value) {
466			$element[$key] = array('#type' => 'hidden', '#processed' => TRUE, '#value' => $value);
467			}
468			return $element;
469			}
470
471	drumm	1.2	function theme_hidden_array($element) {
472	jvandyk	1.1	return $element['#children'];
473			}