layout_box.inc in Webform Layout 7.2

Webform module layout_box component.

File

layout_box.inc

<?php

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

/**
 * Implements _webform_defaults_component().
 */
function _webform_defaults_layout_box() {
  return array(
    'name' => '',
    'form_key' => NULL,
    'pid' => 0,
    'weight' => 0,
    'extra' => array(
      'unique' => TRUE,
      'private' => FALSE,
      'align' => 'horiz',
    ),
  );
}

/**
 * Implements _webform_edit_component().
 */
function _webform_edit_layout_box($component) {
  $form = array();
  $form['display']['align'] = array(
    '#type' => 'select',
    '#title' => t('Alignment'),
    '#default_value' => $component['extra']['align'],
    '#description' => t('Controls how elements are arranged in this container. Choose "horizontal" to create a row, or "equal width" to create a row with equal column widths. The "vertical" option can be used to make columns within a horizontal box.'),
    '#parents' => array(
      'extra',
      'align',
    ),
    '#options' => array(
      'horiz' => t('Horizontal'),
      'equal' => t('Equal Width'),
      'vert' => t('Vertical'),
    ),
  );

  // Hide name, it's never shown
  $form['name']['#type'] = 'value';

  // Hack - name is required by webform but we don't expose it to the user. Instead we'll replace it with the value of form_key.
  $form['name']['#value'] = 'box';
  return $form;
}

/**
 * Implements _webform_render_component().
 */
function _webform_render_layout_box($component, $value = NULL, $filter = TRUE) {
  $element = array(
    '#title' => $filter ? _webform_filter_xss($component['name']) : $component['name'],
    '#weight' => $component['weight'],
    '#pre_render' => array(
      'webform_layout_box_prerender',
    ),
    '#webform_component' => $component,
    '#prefix' => '<div>',
    '#suffix' => '</div>',
    '#attached' => array(
      'css' => array(
        drupal_get_path('module', 'webform_layout') . '/layout_box.css',
      ),
    ),
  );
  if (module_exists('form_builder_webform')) {
    $is_form_build = arg(0) === 'admin' && arg(1) === 'build' && arg(2) === 'form-builder' || arg(0) === 'node' && arg(2) === 'webform';
    if ($is_form_build) {
      $element['#type'] = 'fieldset';
    }
  }
  return $element;
}

/**
 * Pre-render function to set a layout_box ID and classes.
 */
function webform_layout_box_prerender($element) {
  $attributes = empty($element['#attributes']) ? array(
    'class' => array(),
  ) : $element['#attributes'];
  $attributes['class'][] = 'webform-layout-box';
  $attributes['class'][] = $element['#webform_component']['extra']['align'];
  $attributes['class'][] = 'webform-component--' . str_replace('_', '-', implode('--', array_slice($element['#parents'], 1)));

  // css class for number of children
  $n = empty($element['#webform_component']['children']) ? 0 : count($element['#webform_component']['children']);
  if ($element['#webform_component']['extra']['align'] == 'equal' && $n > 1) {
    $attributes['class'][] = 'child-width-' . $n;
  }
  $element['#prefix'] = '<div ' . drupal_attributes($attributes) . '>';
  return $element;
}

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

// FORM builder specific hooks

/**
 * Implements _form_builder_webform_form_builder_types_component().
 */
function _form_builder_webform_form_builder_types_layout_box() {
  drupal_add_css(drupal_get_path('module', 'webform_layout') . '/form_builder.css');
  $fields = array();
  $fields['layout_box'] = array(
    'title' => t('Layout box'),
    'weight' => -20,
  );
  $component['name'] = t('Layout box');
  $fields['layout_box']['default'] = _form_builder_webform_default('layout_box', array(), $component);
  return $fields;
}

/**
 * Implements _form_builder_webform_form_builder_map_component().
 */
function _form_builder_webform_form_builder_map_layout_box() {
  return array(
    'form_builder_type' => 'layout_box',
    'properties' => array(
      'align' => array(
        'form_parents' => array(
          'display',
          'align',
        ),
        'storage_parents' => array(
          'extra',
          'align',
        ),
      ),
    ),
  );
}

/**
 * @see webform_layout_theme()
 */
function theme_webform_layout_empty_layout_box($variables) {
  $output = '';
  $output .= '<div class="form-builder-wrapper form-builder-empty-placeholder">';
  $output .= '<span>' . t('This layout box is empty. Drag a form element into it.') . '</span>';
  $output .= '</div>';
  return $output;
}

Functions

Name	Description
theme_webform_layout_empty_layout_box
webform_layout_box_prerender	Pre-render function to set a layout_box ID and classes.
_form_builder_webform_form_builder_map_layout_box	Implements _form_builder_webform_form_builder_map_component().
_form_builder_webform_form_builder_types_layout_box	Implements _form_builder_webform_form_builder_types_component().
_webform_defaults_layout_box	Implements _webform_defaults_component().
_webform_display_layout_box	Implements _webform_display_component().
_webform_edit_layout_box	Implements _webform_edit_component().
_webform_render_layout_box	Implements _webform_render_component().