fieldset.inc in Webform 7.4

Webform module fieldset component.

File

components/fieldset.inc

<?php

/**
 * @file
 * Webform module fieldset component.
 */

/**
 * Implements _webform_defaults_component().
 */
function _webform_defaults_fieldset() {
  return array(
    'name' => '',
    'form_key' => NULL,
    'pid' => 0,
    'weight' => 0,
    'extra' => array(
      'title_display' => 0,
      'collapsible' => 0,
      'collapsed' => 0,
      'description' => '',
      'description_above' => FALSE,
      'private' => FALSE,
    ),
  );
}

/**
 * Implements _webform_edit_component().
 */
function _webform_edit_fieldset($component) {
  $form = array();
  $form['display']['collapsible'] = array(
    '#type' => 'checkbox',
    '#title' => t('Collapsible'),
    '#default_value' => $component['extra']['collapsible'],
    '#description' => t('If this fieldset is collapsible, the user may open or close the fieldset.'),
    '#weight' => 0,
    '#parents' => array(
      'extra',
      'collapsible',
    ),
  );
  $form['display']['collapsed'] = array(
    '#type' => 'checkbox',
    '#title' => t('Collapsed by Default'),
    '#default_value' => $component['extra']['collapsed'],
    '#description' => t('Collapsible fieldsets are "open" by default. Select this option to default the fieldset to "closed."'),
    '#weight' => 3,
    '#parents' => array(
      'extra',
      'collapsed',
    ),
  );
  return $form;
}

/**
 * Implements _webform_render_component().
 */
function _webform_render_fieldset($component, $value = NULL, $filter = TRUE, $submission = NULL) {
  $node = isset($component['nid']) ? node_load($component['nid']) : NULL;
  $element = array(
    '#type' => 'fieldset',
    '#title' => $filter ? webform_filter_xss($component['name']) : $component['name'],
    '#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : NULL,
    '#weight' => $component['weight'],
    '#description' => $filter ? webform_filter_descriptions($component['extra']['description'], $node) : $component['extra']['description'],
    '#collapsible' => $component['extra']['collapsible'],
    '#collapsed' => $component['extra']['collapsed'],
    '#attributes' => array(
      'class' => array(
        'webform-component-fieldset',
      ),
    ),
    '#pre_render' => array(
      'webform_fieldset_prerender',
      'webform_element_title_display',
    ),
    '#translatable' => array(
      'title',
      'description',
    ),
  );
  return $element;
}

/**
 * Pre-render function to set a unique fieldset class name.
 */
function webform_fieldset_prerender($element) {
  $element['#id'] = NULL;
  $element['#attributes']['class'][] = 'webform-component--' . str_replace('_', '-', implode('--', array_slice($element['#parents'], 1)));
  return $element;
}

/**
 * Implements _webform_display_component().
 */
function _webform_display_fieldset($component, $value, $format = 'html', $submission = array()) {
  if ($format == 'text') {
    $element = array(
      '#title' => $component['name'],
      '#weight' => $component['weight'],
      '#theme_wrappers' => array(
        'webform_element_text',
      ),
      '#translatable' => array(
        'title',
      ),
    );
  }
  else {
    $element = _webform_render_fieldset($component, $value);
  }
  $element['#format'] = $format;
  return $element;
}

Functions

Name	Description
webform_fieldset_prerender	Pre-render function to set a unique fieldset class name.
_webform_defaults_fieldset	Implements _webform_defaults_component().
_webform_display_fieldset	Implements _webform_display_component().
_webform_edit_fieldset	Implements _webform_edit_component().
_webform_render_fieldset	Implements _webform_render_component().