' . "\n";
- $required = !empty($element['#required']) ? theme('form_required_marker', array('element' => $element)) : '';
- if (!empty($element['#title']) && empty($element['#form_element_skip_title'])) {
- $title = $element['#title'];
- if (!empty($element['#id'])) {
- $output .= '
\n";
- }
- else {
- $output .= '
\n";
- }
+ // Place label & required mark in correct position, depending on #show_title.
+ $show_title = isset($element['#show_title']) ? $element['#show_title'] :
+ FORM_ELEMENT_SHOW_TITLE_BEFORE; // Default position is before.
+ switch ($show_title) {
+ case FORM_ELEMENT_SHOW_TITLE_BEFORE:
+ $output .= theme('form_element_label', $variables) . ' ' . $element['#children'] . "\n";
+ break;
+ case FORM_ELEMENT_SHOW_TITLE_ATTRIBUTE:
+ // Put a required mark after the element even though no title is added.
+ case FORM_ELEMENT_SHOW_TITLE_AFTER:
+ $output .= $element['#children'] . ' ' . theme('form_element_label', $variables) . "\n";
+ break;
+ case FORM_ELEMENT_SHOW_TITLE_NONE:
+ $output .= $element['#children'] . "\n";
+ break;
}
- $output .= " " . $element['#children'] . "\n";
-
if (!empty($element['#description'])) {
$output .= '
' . $element['#description'] . "
\n";
}
@@ -2811,6 +2815,50 @@ function theme_form_required_marker($var
}
/**
+ * Theme a form element label and required mark.
+ *
+ * @param $variables
+ * An associative array containing:
+ * - element: An associative array containing the properties of the element.
+ * Properties used: #required, #show_title, #title, #id, #value,
+ * #description.
+ * @return
+ * A string representing the form element label and/or required mark.
+ *
+ * @ingroup themeable
+ */
+function theme_form_element_label($variables) {
+ $element = $variables['element'];
+ // This is also used in the installer, pre-database setup.
+ $t = get_t();
+
+ // Output a required mark and/or label depending on #show_title.
+ $show_title = isset($element['#show_title']) ? $element['#show_title'] :
+ FORM_ELEMENT_SHOW_TITLE_BEFORE; // Default position is before.
+
+ $required = !empty($element['#required']) ? theme('form_required_marker', array('element' => $element)) : '';
+ // If there is no title or the title is not set to display we simply
+ // return any required mark here.
+ if (empty($element['#title']) ||
+ $show_title == FORM_ELEMENT_SHOW_TITLE_NONE ||
+ $show_title == FORM_ELEMENT_SHOW_TITLE_ATTRIBUTE) {
+ return $required;
+ }
+
+ // Show the title and required mark in the label.
+ $attributes = array();
+ if ($show_title == FORM_ELEMENT_SHOW_TITLE_AFTER) {
+ // Style the label as an option inline with the element.
+ $attributes['class'] = 'option';
+ }
+ if (!empty($element['#id'])) {
+ $attributes['for'] = $element['#id'];
+ }
+
+ return '
' . $t('!title !required', array('!title' => filter_xss_admin($element['#title']), '!required' => $required)) . "\n";
+}
+
+/**
* Sets a form element's class attribute.
*
* Adds 'required' and 'error' classes as needed.
Index: modules/comment/comment-node-form.js
===================================================================
RCS file: /cvs/drupal/drupal/modules/comment/comment-node-form.js,v
retrieving revision 1.3
diff -u -p -r1.3 comment-node-form.js
--- modules/comment/comment-node-form.js 21 Aug 2009 00:21:48 -0000 1.3
+++ modules/comment/comment-node-form.js 12 Nov 2009 21:29:26 -0000
@@ -5,7 +5,7 @@
Drupal.behaviors.commentFieldsetSummaries = {
attach: function (context) {
$('fieldset#edit-comment-settings', context).setSummary(function (context) {
- return Drupal.checkPlain($('input:checked', context).parent().text());
+ return Drupal.checkPlain($('input:checked', context).next('label').text());
});
// Provide the summary for the node type form.
$('fieldset#edit-comment', context).setSummary(function(context) {
@@ -15,7 +15,7 @@ Drupal.behaviors.commentFieldsetSummarie
vals.push($("select[name='comment'] option:selected", context).text());
// Threading.
- var threading = $("input[name='comment_default_mode']:checked", context).parent().text();
+ var threading = $("input[name='comment_default_mode']:checked", context).next('label').text();
if (threading) {
vals.push(threading);
}
Index: modules/node/content_types.js
===================================================================
RCS file: /cvs/drupal/drupal/modules/node/content_types.js,v
retrieving revision 1.7
diff -u -p -r1.7 content_types.js
--- modules/node/content_types.js 22 Aug 2009 23:18:28 -0000 1.7
+++ modules/node/content_types.js 12 Nov 2009 21:29:26 -0000
@@ -22,7 +22,7 @@ Drupal.behaviors.contentTypes = {
});
$('fieldset#edit-display', context).setSummary(function(context) {
var vals = [];
- $('input:checked', context).parent().each(function() {
+ $('input:checked', context).next('label').each(function() {
vals.push(Drupal.checkPlain($(this).text()));
});
if (!$('#edit-node-submitted', context).is(':checked')) {
Index: modules/simpletest/tests/form.test
===================================================================
RCS file: /cvs/drupal/drupal/modules/simpletest/tests/form.test,v
retrieving revision 1.23
diff -u -p -r1.23 form.test
--- modules/simpletest/tests/form.test 12 Nov 2009 20:07:06 -0000 1.23
+++ modules/simpletest/tests/form.test 12 Nov 2009 21:29:26 -0000
@@ -147,6 +147,77 @@ class FormsTestTypeCase extends DrupalUn
}
/**
+ * Test the form elements, labels and associated output for correctness.
+ */
+class FormsElementsLabelsTestCase extends DrupalWebTestCase {
+
+ public static function getInfo() {
+ return array(
+ 'name' => 'Form element and label output test',
+ 'description' => 'Test the form elements, labels and associated output for correctness.',
+ 'group' => 'Form API',
+ );
+ }
+
+ function setUp() {
+ parent::setUp('form_test');
+ }
+
+ /**
+ * Test form elements, labels, title attibutes and required marks output
+ * correctly and have the correct label option class if needed.
+ */
+ function testFormLabels() {
+ $this->drupalGet('form_test/form-labels');
+
+ // Check that the checkbox/radio processing is not interfering with
+ // basic placement.
+ $elements = $this->xpath('//input[@id="edit-form-checkboxes-test-thirdcheckbox"]/following-sibling::label[@for="edit-form-checkboxes-test-thirdcheckbox" and @class="option"]');
+ $this->assertTrue(isset($elements[0]), t("Label follows field and label option class correct for regular checkboxes."));
+
+ $elements = $this->xpath('//input[@id="edit-form-radios-test-secondradio"]/following-sibling::label[@for="edit-form-radios-test-secondradio" and @class="option"]');
+ $this->assertTrue(isset($elements[0]), t("Label follows field and label option class correct for regular radios."));
+
+ // Exercise various defaults for checkboxes and modifications to ensure
+ // appropriate override and correct behaviour.
+ $elements = $this->xpath('//input[@id="edit-form-checkbox-test"]/following-sibling::label[@for="edit-form-checkbox-test" and @class="option"]');
+ $this->assertTrue(isset($elements[0]), t("Label follows field and label option class correct for a checkbox by default."));
+
+ $elements = $this->xpath('//input[@id="edit-form-checkbox-test-attribute" and @title="Checkbox test with label as attribute"]');
+ $this->assertTrue(isset($elements[0]), t("Title as attribute for a checkbox is correct."));
+
+ $elements = $this->xpath('//input[@id="edit-form-checkbox-test-attribute"]/following-sibling::label');
+ $this->assertFalse(isset($elements[0]), t("Label does not follow title as attribute for a checkbox."));
+
+ $elements = $this->xpath('//input[@id="edit-form-checkbox-test-attribute"]/following-sibling::label[@for="edit-form-checkbox-test-attribute" and @class="option"]');
+ $this->assertFalse(isset($elements[0]), t("No label option class found for checkbox with title as attribute."));
+
+ // Exercise various defaults for textboxes and modifications to ensure
+ // appropriate override and correct behaviour.
+ $elements = $this->xpath('//label[@for="edit-form-textfield-test-title-and-required"]/child::span[@class="form-required"]/parent::*/following-sibling::input[@id="edit-form-textfield-test-title-and-required"]');
+ $this->assertTrue(isset($elements[0]), t("Label preceeds textfield, with required marker inside label."));
+
+ $elements = $this->xpath('//input[@id="edit-form-textfield-test-no-title-required"]/preceding-sibling::span[@class="form-required"]');
+ $this->assertTrue(isset($elements[0]), t("Required marker when required, preceeds textfield."));
+
+ $elements = $this->xpath('//label[@for="edit-form-textfield-test-no-title-required"]');
+ $this->assertFalse(isset($elements[0]), t("No label tag when no title set on field."));
+
+ $elements = $this->xpath('//input[@id="edit-form-textfield-test-title"]/preceding-sibling::span[@class="form-required"]');
+ $this->assertFalse(isset($elements[0]), t("No required marker on non-required field."));
+
+ $elements = $this->xpath('//input[@id="edit-form-textfield-test-title-attribute" and @title="Textfield test for title as attribute"]');
+ $this->assertTrue(isset($elements[0]), t("Title as attribute for a textfield is correct."));
+
+ $elements = $this->xpath('//input[@id="edit-form-textfield-test-title-after"]/following-sibling::label[@for="edit-form-textfield-test-title-after" and @class="option"]');
+ $this->assertTrue(isset($elements[0]), t("Label after field and label option class correct for text field."));
+
+ $elements = $this->xpath('//label[@for="edit-form-textfield-test-title-no-show"]');
+ $this->assertFalse(isset($elements[0]), t("No label tag when title set not to display."));
+ }
+}
+
+/**
* Test the tableselect form element for expected behavior.
*/
class FormsElementsTableSelectFunctionalTest extends DrupalWebTestCase {
Index: modules/simpletest/tests/form_test.module
===================================================================
RCS file: /cvs/drupal/drupal/modules/simpletest/tests/form_test.module,v
retrieving revision 1.13
diff -u -p -r1.13 form_test.module
--- modules/simpletest/tests/form_test.module 10 Nov 2009 17:27:53 -0000 1.13
+++ modules/simpletest/tests/form_test.module 12 Nov 2009 21:29:26 -0000
@@ -70,6 +70,14 @@ function form_test_menu() {
'type' => MENU_CALLBACK,
);
+ $items['form_test/form-labels'] = array(
+ 'title' => 'Form label test',
+ 'page callback' => 'drupal_get_form',
+ 'page arguments' => array('form_label_test_form'),
+ 'access arguments' => array('access content'),
+ 'type' => MENU_CALLBACK,
+ );
+
return $items;
}
@@ -342,6 +350,71 @@ function form_storage_test_form_submit($
drupal_set_message("Form constructions: ". $_SESSION['constructions']);
}
+ /**
+ * A form for testing form labels and required marks.
+ */
+function form_label_test_form(&$form_state) {
+ $form['form_checkboxes_test'] = array(
+ '#type' => 'checkboxes',
+ '#title' => t('Checkboxes test'),
+ '#options' => array(
+ 'firstcheckbox' => t('First Checkbox'),
+ 'secondcheckbox' => t('Second Checkbox'),
+ 'thirdcheckbox' => t('Third Checkbox'),
+ ),
+ );
+ $form['form_radios_test'] = array(
+ '#type' => 'radios',
+ '#title' => t('Radios test'),
+ '#options' => array(
+ 'firstradio' => t('First Radio'),
+ 'secondradio' => t('Second Radio'),
+ 'thirdradio' => t('Third Radio'),
+ ),
+ );
+ $form['form_checkbox_test'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Checkbox test'),
+ );
+ $form['form_checkbox_test_attribute'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Checkbox test with label as attribute'),
+ '#show_title' => FORM_ELEMENT_SHOW_TITLE_ATTRIBUTE,
+ );
+ $form['form_textfield_test_title_and_required'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Textfield test for required with title'),
+ '#required' => TRUE,
+ );
+ $form['form_textfield_test_no_title_required'] = array(
+ '#type' => 'textfield',
+ // No title.
+ '#required' => TRUE,
+ );
+ $form['form_textfield_test_title'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Textfield test for title only'),
+ // Not required.
+ );
+ $form['form_textfield_test_title_attribute'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Textfield test for title as attribute'),
+ '#show_title' => FORM_ELEMENT_SHOW_TITLE_ATTRIBUTE,
+ );
+ $form['form_textfield_test_title_after'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Textfield test for title after element'),
+ '#show_title' => FORM_ELEMENT_SHOW_TITLE_AFTER,
+ );
+ $form['form_textfield_test_title_no_show'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Textfield test for title set not to display'),
+ '#show_title' => FALSE,
+ );
+
+ return $form;
+}
+
/**
* Menu callback; Invokes a form builder function with a wrapper callback.
*/
Index: modules/system/system.api.php
===================================================================
RCS file: /cvs/drupal/drupal/modules/system/system.api.php,v
retrieving revision 1.102
diff -u -p -r1.102 system.api.php
--- modules/system/system.api.php 6 Nov 2009 03:59:06 -0000 1.102
+++ modules/system/system.api.php 12 Nov 2009 21:29:27 -0000
@@ -274,6 +274,8 @@ function hook_cron_queue_info() {
* - "#pre_render": array of callback functions taking $element and $form_state.
* - "#post_render": array of callback functions taking $element and $form_state.
* - "#submit": array of callback functions taking $form and $form_state.
+ * - "#show_title": optionally one of the FORM_ELEMENT_SHOW_TITLE_* constants
+ * indicating if and how the #title should be displayed.
*
* @see hook_element_info_alter()
* @see system_element_info()
Index: modules/system/system.module
===================================================================
RCS file: /cvs/drupal/drupal/modules/system/system.module,v
retrieving revision 1.840
diff -u -p -r1.840 system.module
--- modules/system/system.module 11 Nov 2009 17:14:59 -0000 1.840
+++ modules/system/system.module 12 Nov 2009 21:29:27 -0000
@@ -56,6 +56,34 @@ define('REGIONS_VISIBLE', 'visible');
*/
define('REGIONS_ALL', 'all');
+/**
+ *
+ * Output form element titles as labels before form elements.
+ * @see system_elements().
+ */
+define('FORM_ELEMENT_SHOW_TITLE_BEFORE', 'before');
+
+/**
+ *
+ * Output form element titles as labels after form elements.
+ * @see system_elements().
+ */
+define('FORM_ELEMENT_SHOW_TITLE_AFTER', 'after');
+
+/**
+ *
+ * Output form element titles as the title attribute of form elements.
+ * @see system_elements().
+ */
+define('FORM_ELEMENT_SHOW_TITLE_ATTRIBUTE', 'attribute');
+
+/**
+ *
+ * Do not output element titles as labels or attributes.
+ * @see system_elements().
+ */
+define('FORM_ELEMENT_SHOW_TITLE_NONE', 'none');
+
/**
* Implement hook_help().
@@ -392,7 +420,7 @@ function system_element_info() {
'#process' => array('ajax_process_form'),
'#theme' => 'radio',
'#theme_wrappers' => array('form_element'),
- '#form_element_skip_title' => TRUE,
+ '#show_title' => FORM_ELEMENT_SHOW_TITLE_AFTER,
);
$types['checkboxes'] = array(
'#input' => TRUE,
@@ -407,7 +435,7 @@ function system_element_info() {
'#process' => array('ajax_process_form'),
'#theme' => 'checkbox',
'#theme_wrappers' => array('form_element'),
- '#form_element_skip_title' => TRUE,
+ '#show_title' => FORM_ELEMENT_SHOW_TITLE_AFTER,
);
$types['select'] = array(
'#input' => TRUE,
Index: modules/user/user.pages.inc
===================================================================
RCS file: /cvs/drupal/drupal/modules/user/user.pages.inc,v
retrieving revision 1.61
diff -u -p -r1.61 user.pages.inc
--- modules/user/user.pages.inc 15 Oct 2009 16:18:46 -0000 1.61
+++ modules/user/user.pages.inc 12 Nov 2009 21:29:27 -0000
@@ -452,7 +452,6 @@ function user_cancel_methods() {
'#return_value' => $name,
'#default_value' => $default_method,
'#parents' => array('user_cancel_method'),
- '#required' => TRUE,
);
}
return $form;