textfield.inc in Webform 7.4
Same filename and directory in other branches
Webform module textfield component.
File
components/textfield.incView source
<?php
/**
* @file
* Webform module textfield component.
*/
/**
* Implements _webform_defaults_component().
*/
function _webform_defaults_textfield() {
return array(
'name' => '',
'form_key' => NULL,
'pid' => 0,
'weight' => 0,
'value' => '',
'required' => 0,
'extra' => array(
'width' => '',
'maxlength' => '',
'minlength' => '',
'field_prefix' => '',
'field_suffix' => '',
'disabled' => 0,
'unique' => 0,
'title_display' => 0,
'description' => '',
'description_above' => FALSE,
'placeholder' => '',
'attributes' => array(),
'private' => FALSE,
'analysis' => FALSE,
),
);
}
/**
* Implements _webform_theme_component().
*/
function _webform_theme_textfield() {
return array(
'webform_display_textfield' => array(
'render element' => 'element',
'file' => 'components/textfield.inc',
),
);
}
/**
* Implements _webform_edit_component().
*/
function _webform_edit_textfield($component) {
$form = array();
$form['value'] = array(
'#type' => 'textfield',
'#title' => t('Default value'),
'#default_value' => $component['value'],
'#description' => t('The default value of the field.') . ' ' . theme('webform_token_help'),
'#size' => 60,
'#maxlength' => 1024,
'#weight' => 0,
);
$form['display']['width'] = array(
'#type' => 'textfield',
'#title' => t('Width'),
'#default_value' => $component['extra']['width'],
'#description' => t('Width of the textfield.') . ' ' . t('Leaving blank will use the default size.'),
'#size' => 5,
'#maxlength' => 10,
'#weight' => 0,
'#parents' => array(
'extra',
'width',
),
);
$form['display']['placeholder'] = array(
'#type' => 'textfield',
'#title' => t('Placeholder'),
'#default_value' => $component['extra']['placeholder'],
'#description' => t('The placeholder will be shown in the field until the user starts entering a value.'),
'#weight' => 1,
'#parents' => array(
'extra',
'placeholder',
),
);
$form['display']['field_prefix'] = array(
'#type' => 'textfield',
'#title' => t('Prefix text placed to the left of the textfield'),
'#default_value' => $component['extra']['field_prefix'],
'#description' => t('Examples: $, #, -.'),
'#size' => 20,
'#maxlength' => 127,
'#weight' => 2.1,
'#parents' => array(
'extra',
'field_prefix',
),
);
$form['display']['field_suffix'] = array(
'#type' => 'textfield',
'#title' => t('Postfix text placed to the right of the textfield'),
'#default_value' => $component['extra']['field_suffix'],
'#description' => t('Examples: lb, kg, %.'),
'#size' => 20,
'#maxlength' => 127,
'#weight' => 2.2,
'#parents' => array(
'extra',
'field_suffix',
),
);
$form['display']['disabled'] = array(
'#type' => 'checkbox',
'#title' => t('Disabled'),
'#return_value' => 1,
'#description' => t('Make this field non-editable. Useful for displaying default value. Changeable via JavaScript or developer tools.'),
'#weight' => 11,
'#default_value' => $component['extra']['disabled'],
'#parents' => array(
'extra',
'disabled',
),
);
$form['validation']['unique'] = array(
'#type' => 'checkbox',
'#title' => t('Unique'),
'#return_value' => 1,
'#description' => t('Check that all entered values for this field are unique. The same value is not allowed to be used twice.'),
'#weight' => 1,
'#default_value' => $component['extra']['unique'],
'#parents' => array(
'extra',
'unique',
),
);
$form['validation']['maxlength'] = array(
'#type' => 'textfield',
'#title' => t('Maxlength'),
'#default_value' => $component['extra']['maxlength'],
'#description' => t('Maximum length of the textfield value.'),
'#size' => 5,
'#maxlength' => 10,
'#weight' => 2,
'#parents' => array(
'extra',
'maxlength',
),
);
$form['validation']['minlength'] = array(
'#type' => 'textfield',
'#title' => t('Minlength'),
'#default_value' => $component['extra']['minlength'],
'#description' => t('Minimum length of the textfield value. The component may still be empty unless it is set as Required.'),
'#size' => 5,
'#maxlength' => 10,
'#weight' => 3,
'#parents' => array(
'extra',
'minlength',
),
);
return $form;
}
/**
* Implements _webform_render_component().
*/
function _webform_render_textfield($component, $value = NULL, $filter = TRUE, $submission = NULL) {
$node = isset($component['nid']) ? node_load($component['nid']) : NULL;
$element = array(
'#type' => 'textfield',
'#title' => $filter ? webform_filter_xss($component['name']) : $component['name'],
'#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
'#default_value' => $filter ? webform_replace_tokens($component['value'], $node) : $component['value'],
'#required' => $component['required'],
'#weight' => $component['weight'],
'#field_prefix' => empty($component['extra']['field_prefix']) ? NULL : ($filter ? webform_filter_xss($component['extra']['field_prefix']) : $component['extra']['field_prefix']),
'#field_suffix' => empty($component['extra']['field_suffix']) ? NULL : ($filter ? webform_filter_xss($component['extra']['field_suffix']) : $component['extra']['field_suffix']),
'#description' => $filter ? webform_filter_descriptions($component['extra']['description'], $node) : $component['extra']['description'],
'#attributes' => $component['extra']['attributes'],
'#theme_wrappers' => array(
'webform_element',
),
'#translatable' => array(
'title',
'description',
'field_prefix',
'field_suffix',
'placeholder',
),
);
if ($component['required']) {
$element['#attributes']['required'] = 'required';
}
if ($component['extra']['placeholder']) {
$element['#attributes']['placeholder'] = $component['extra']['placeholder'];
}
if ($component['extra']['disabled']) {
if ($filter) {
$element['#attributes']['readonly'] = 'readonly';
}
else {
$element['#disabled'] = TRUE;
}
}
// Enforce uniqueness.
if ($component['extra']['unique']) {
$element['#element_validate'][] = 'webform_validate_unique';
}
// Change the 'width' option to the correct 'size' option.
if ($component['extra']['width'] > 0) {
$element['#size'] = $component['extra']['width'];
}
if ($component['extra']['maxlength'] > 0) {
$element['#maxlength'] = $component['extra']['maxlength'];
}
if ($component['extra']['minlength'] > 0) {
$element['#minlength'] = $component['extra']['minlength'];
}
if (isset($value[0])) {
$element['#default_value'] = $value[0];
}
return $element;
}
/**
* Implements _webform_display_component().
*/
function _webform_display_textfield($component, $value, $format = 'html', $submission = array()) {
return array(
'#title' => $component['name'],
'#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
'#weight' => $component['weight'],
'#theme' => 'webform_display_textfield',
'#theme_wrappers' => $format == 'html' ? array(
'webform_element',
) : array(
'webform_element_text',
),
'#field_prefix' => $component['extra']['field_prefix'],
'#field_suffix' => $component['extra']['field_suffix'],
'#format' => $format,
'#value' => isset($value[0]) ? $value[0] : '',
'#translatable' => array(
'title',
'field_prefix',
'field_suffix',
'placeholder',
),
);
}
/**
* Format the output of data for this component.
*/
function theme_webform_display_textfield($variables) {
$element = $variables['element'];
$prefix = $element['#format'] == 'html' ? '' : $element['#field_prefix'];
$suffix = $element['#format'] == 'html' ? '' : $element['#field_suffix'];
$value = $element['#format'] == 'html' ? check_plain($element['#value']) : $element['#value'];
return $value !== '' ? $prefix . $value . $suffix : ' ';
}
/**
* Implements _webform_analysis_component().
*/
function _webform_analysis_textfield($component, $sids = array(), $single = FALSE, $join = NULL) {
$query = db_select('webform_submitted_data', 'wsd', array(
'fetch' => PDO::FETCH_ASSOC,
))
->fields('wsd', array(
'data',
))
->condition('wsd.nid', $component['nid'])
->condition('wsd.cid', $component['cid']);
if (count($sids)) {
$query
->condition('wsd.sid', $sids, 'IN');
}
if ($join) {
$query
->innerJoin($join, 'ws2_', 'wsd.sid = ws2_.sid');
}
$nonblanks = 0;
$submissions = 0;
$wordcount = 0;
$result = $query
->execute();
foreach ($result as $data) {
if (drupal_strlen(trim($data['data'])) > 0) {
$nonblanks++;
$wordcount += str_word_count(trim($data['data']));
}
$submissions++;
}
$rows[0] = array(
t('Left Blank'),
$submissions - $nonblanks,
);
$rows[1] = array(
t('User entered value'),
$nonblanks,
);
$other[] = array(
t('Average submission length in words (ex blanks)'),
$nonblanks != 0 ? number_format($wordcount / $nonblanks, 2) : '0',
);
return array(
'table_rows' => $rows,
'other_data' => $other,
);
}
/**
* Implements _webform_table_component().
*/
function _webform_table_textfield($component, $value) {
return check_plain(empty($value[0]) ? '' : $value[0]);
}
/**
* Implements _webform_action_set_component().
*/
function _webform_action_set_textfield($component, &$element, &$form_state, $value) {
$element['#value'] = $value;
form_set_value($element, $value, $form_state);
}
/**
* Implements _webform_csv_headers_component().
*/
function _webform_csv_headers_textfield($component, $export_options) {
$header = array();
$header[0] = '';
$header[1] = '';
$header[2] = $export_options['header_keys'] ? $component['form_key'] : $component['name'];
return $header;
}
/**
* Implements _webform_csv_data_component().
*/
function _webform_csv_data_textfield($component, $export_options, $value) {
return !isset($value[0]) ? '' : $value[0];
}
Functions
Name | Description |
---|---|
theme_webform_display_textfield | Format the output of data for this component. |
_webform_action_set_textfield | Implements _webform_action_set_component(). |
_webform_analysis_textfield | Implements _webform_analysis_component(). |
_webform_csv_data_textfield | Implements _webform_csv_data_component(). |
_webform_csv_headers_textfield | Implements _webform_csv_headers_component(). |
_webform_defaults_textfield | Implements _webform_defaults_component(). |
_webform_display_textfield | Implements _webform_display_component(). |
_webform_edit_textfield | Implements _webform_edit_component(). |
_webform_render_textfield | Implements _webform_render_component(). |
_webform_table_textfield | Implements _webform_table_component(). |
_webform_theme_textfield | Implements _webform_theme_component(). |