webform_references.term.inc in Webform References 7
Webform module term reference component.
File
webform_references.term.incView source
<?php
/**
* @file
* Webform module term reference component.
*/
/**
* Implements _webform_defaults_component().
*/
function _webform_defaults_term_reference() {
return array(
'name' => '',
'form_key' => NULL,
'required' => 0,
'mandatory' => 0,
'pid' => 0,
'weight' => 0,
'extra' => array(
'title_display' => 0,
'private' => FALSE,
'attributes' => array(),
'default_value' => NULL,
'description' => '',
'referenceable_types' => array(),
'widget_type' => '',
'empty_option' => 'None',
'multiple' => NULL,
'use_view' => FALSE,
'reference_view' => NULL,
'view_args' => NULL,
'sort' => array(
'sort_by' => 'name',
'order' => 'ASC',
),
),
);
}
/**
* Generate the form for editing a component.
*
* Create a set of form elements to be displayed on the form for editing this
* component. Use care naming the form items, as this correlates directly to the
* database schema. The component "Name" and "Description" fields are added to
* every component type and are not necessary to specify here (although they
* may be overridden if desired).
*
* @param array $component
* A Webform component array.
*
* @return array
* An array of form items to be displayed on the edit component page
*/
function _webform_edit_term_reference(array $component) {
$form = array();
$form['extra']['widget_type'] = array(
'#type' => 'select',
'#title' => t('Field Type'),
'#multiple' => FALSE,
'#default_value' => $component['extra']['widget_type'],
'#options' => array(
'select' => t('Select List'),
'checkbox_radio' => t('Checkbox/Radio'),
'autocomplete' => t('Autocomplete'),
),
'#required' => TRUE,
);
$form['extra']['multiple'] = array(
'#type' => 'checkbox',
'#title' => t('Multiple'),
'#default_value' => $component['extra']['multiple'],
'#description' => t('Check this option if the user should be allowed to choose multiple values.'),
'#states' => array(
// Hide this field when the widget_type is autocomplete.
'invisible' => array(
':input[name="extra[widget_type]"]' => array(
'value' => 'autocomplete',
),
),
),
);
$form['extra']['use_view'] = array(
'#type' => 'checkbox',
'#title' => t('Use a view'),
'#default_value' => $component['extra']['use_view'],
'#description' => t('Use an entity reference view to select options.'),
);
if (!module_exists('entityreference')) {
$form['extra']['use_view']['#disabled'] = 'disabled';
$form['extra']['use_view']['#description'] = t('The entityreference module must be enabled to use this feature.');
}
$voc_keys = array();
foreach (taxonomy_get_vocabularies() as $vid => $vocab) {
$voc_keys[$vid] = $vocab->name;
}
$form['extra']['referenceable_types'] = array(
'#type' => 'select',
'#title' => t('Select the vocabulary that can be referenced'),
'#multiple' => FALSE,
'#default_value' => $component['extra']['referenceable_types'],
'#options' => $voc_keys,
'#element_validate' => array(
'_webform_references_taxonomy_vocabularies_validate',
),
'#states' => array(
'invisible' => array(
':input[name="extra[use_view]"]' => array(
'checked' => TRUE,
),
),
'required' => array(
':input[name="extra[use_view]"]' => array(
'checked' => FALSE,
),
),
),
);
$displays = views_get_applicable_views('entityreference display');
// Filter views that list the entity type we want, and group the separate
// displays by view.
$options = array();
foreach ($displays as $data) {
list($view, $display_id) = $data;
if ($view->base_table == 'taxonomy_term_data') {
$options[$view->name . ':' . $display_id] = $view->name . ' - ' . $view->display[$display_id]->display_title;
}
}
$form['extra']['reference_view'] = array(
'#type' => 'select',
'#title' => t('Select a view'),
'#multiple' => FALSE,
'#default_value' => $component['extra']['reference_view'],
'#options' => $options,
'#element_validate' => array(
'_webform_references_taxonomy_reference_view_validate',
),
'#states' => array(
'visible' => array(
':input[name="extra[use_view]"]' => array(
'checked' => TRUE,
),
),
'required' => array(
':input[name="extra[use_view]"]' => array(
'checked' => TRUE,
),
),
),
);
$form['extra']['view_args'] = array(
'#type' => 'textfield',
'#title' => t('Arguments to pass to the view'),
'#description' => t('Arguments in the form arg1/arg2/arg3'),
'#default_value' => $component['extra']['view_args'],
'#states' => array(
'visible' => array(
':input[name="extra[use_view]"]' => array(
'checked' => TRUE,
),
),
),
);
$form['extra']['default_value'] = array(
'#type' => 'textfield',
'#title' => t('Default value'),
'#default_value' => $component['extra']['default_value'],
'#description' => t('The default value of the field.') . ' ' . theme('webform_token_help'),
);
$form['extra']['empty_option'] = array(
'#type' => 'textfield',
'#title' => t('Empty Option'),
'#default_value' => $component['extra']['empty_option'],
'#description' => t('Empty option value for select list.'),
'#states' => array(
'visible' => array(
':input[name="extra[widget_type]"]' => array(
'value' => 'select',
),
':input[name="extra[multiple]"]' => array(
'checked' => FALSE,
),
),
),
);
$form['extra']['sort'] = array(
'#type' => 'container',
'#attributes' => array(
'class' => array(
'container-inline',
),
),
'#states' => array(
'invisible' => array(
':input[name="extra[use_view]"]' => array(
'checked' => TRUE,
),
),
),
);
$form['extra']['sort']['sort_by'] = array(
'#type' => 'select',
'#title' => t('Sort By'),
'#multiple' => FALSE,
'#default_value' => $component['extra']['sort']['sort_by'],
'#options' => array(
'tid' => t('Term Id'),
'name' => t('Term Name'),
'weight' => t('Term Weight'),
),
'#required' => TRUE,
'#states' => array(
// Hide this field when the widget_type is autocomplete.
'invisible' => array(
':input[name="extra[widget_type]"]' => array(
'value' => 'autocomplete',
),
),
),
);
$form['extra']['sort']['order'] = array(
'#type' => 'select',
'#title' => t('Order'),
'#multiple' => FALSE,
'#default_value' => $component['extra']['sort']['order'],
'#options' => array(
'ASC' => t('Ascending'),
'DESC' => t('Descending'),
),
'#required' => TRUE,
'#states' => array(
// Hide this field when the widget_type is autocomplete.
'invisible' => array(
':input[name="extra[widget_type]"]' => array(
'value' => 'autocomplete',
),
),
),
);
return $form;
}
/**
* This is a workaround, because currently FAPI states 'required' only
* adds an asterisk but does not do validation. If we use the '#required'
* attribute on the element itself then validation will fail on the invisible
* referenceable type element
*
* @see _webform_edit_user_reference()
*/
function _webform_references_taxonomy_vocabularies_validate($element, &$form_state) {
$use_view = $form_state['complete form']['extra']['use_view']['#value'];
if (!$use_view && empty($element['#value'])) {
form_set_error($element['#name'], t('Please select any vocabulary to be referenced.'));
}
}
/**
* To validate the reference view element in case of empty list.
*/
function _webform_references_taxonomy_reference_view_validate($element, &$form_state) {
$use_view = $form_state['complete form']['extra']['use_view']['#value'];
if ($use_view && empty($element['#value'])) {
form_set_error($element['#name'], t('Please select any view to be referenced.'));
}
}
/**
* Render a Webform component to be part of a form.
*
* @param array $component
* A Webform component array.
* @param array $value
* If editing an existing submission or resuming a draft, this will contain
* an array of values to be shown instead of the default in the component
* configuration. This value will always be an array, keyed numerically for
* each value saved in this field.
* @param string $filter
* Whether or not to filter the contents of descriptions and values when
* rendering the component. Values need to be unfiltered to be editable by
* Form Builder.
*
* @see _webform_client_form_add_component()
*/
function _webform_render_term_reference(array $component, array $value = NULL, $filter = TRUE) {
$default_value = array(
$filter ? webform_replace_tokens($component['extra']['default_value']) : $component['extra']['default_value'],
);
switch ($component['extra']['widget_type']) {
case 'autocomplete':
if (!empty($component['extra']['use_view'])) {
$path = 'webform_references/view/autocomplete/taxonomy_term/' . str_replace(':', '/', $component['extra']['reference_view']);
if (!empty($component['extra']['view_args'])) {
$path .= '/' . $component['extra']['view_args'];
}
}
else {
$path = 'webform_references/term/autocomplete/' . $component['extra']['referenceable_types'];
}
$form_item = array(
'#type' => 'textfield',
'#autocomplete_path' => $path,
'#description' => $filter ? _webform_filter_descriptions($component['extra']['description']) : $component['extra']['description'],
'#required' => $component['required'] || $component['mandatory'],
// Either one being true will could as required...
// because webform changed in 4.x-alpha8
'#maxlength' => NULL,
'#title' => $filter ? _webform_filter_xss($component['name']) : $component['name'],
'#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
'#weight' => $component['weight'],
'#element_validate' => array(
'webform_references_validate_term_reference',
),
'#theme_wrappers' => array(
'webform_element',
),
'#translatable' => array(
'title',
'description',
),
);
if (isset($value)) {
$selected_term = taxonomy_term_load($value[0]);
$form_item['#default_value'] = $selected_term ? $selected_term->name : '';
}
elseif (isset($default_value)) {
$selected_term = taxonomy_term_load($default_value[0]);
$form_item['#default_value'] = $selected_term ? $selected_term->name : '';
}
break;
case 'checkbox_radio':
if (!$component['extra']['use_view']) {
$term_list = _webform_references_get_term_list($component['extra']['referenceable_types'], $component['extra']['sort']['sort_by'], $component['extra']['sort']['order']);
}
else {
$term_list = _webform_references_list_from_view($component['extra']['reference_view'], 'taxonomy_term', $component['extra']['view_args']);
}
$form_item = array(
'#type' => $component['extra']['multiple'] ? 'checkboxes' : 'radios',
'#description' => $filter ? _webform_filter_descriptions($component['extra']['description']) : $component['extra']['description'],
'#required' => $component['required'] || $component['mandatory'],
// Either one being true will could as required...
// because webform changed in 4.x-alpha8.
'#title' => $filter ? _webform_filter_xss($component['name']) : $component['name'],
'#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
'#options' => $term_list,
'#weight' => $component['weight'],
'#multiple' => $component['extra']['multiple'],
'#pre_render' => array(),
'#translatable' => array(
'title',
'description',
),
);
$form_item['#theme_wrappers'] = array(
$form_item['#type'],
'webform_element',
);
if (isset($value)) {
if ($form_item['#type'] == 'checkboxes') {
$form_item['#default_value'] = $value;
}
else {
$form_item['#default_value'] = $value[0];
}
}
elseif (isset($default_value)) {
if ($form_item['#type'] == 'checkboxes') {
$form_item['#default_value'] = $default_value;
}
else {
$form_item['#default_value'] = $default_value[0];
}
}
break;
default:
if (!$component['extra']['use_view']) {
$term_list = _webform_references_get_term_list($component['extra']['referenceable_types'], $component['extra']['sort']['sort_by'], $component['extra']['sort']['order']);
}
else {
$term_list = _webform_references_list_from_view($component['extra']['reference_view'], 'taxonomy_term', $component['extra']['view_args']);
}
$form_item = array(
'#type' => 'select',
'#description' => $filter ? _webform_filter_descriptions($component['extra']['description']) : $component['extra']['description'],
'#required' => $component['required'] || $component['mandatory'],
// Either one being true will could as required...
// because webform changed in 4.x-alpha8.
'#title' => $filter ? _webform_filter_xss($component['name']) : $component['name'],
'#title_display' => $component['extra']['title_display'] ? $component['extra']['title_display'] : 'before',
'#options' => $term_list,
'#empty_option' => trim($component['extra']['empty_option']) != '' ? $component['extra']['empty_option'] : t('No Value'),
'#weight' => $component['weight'],
'#multiple' => $component['extra']['multiple'],
'#theme_wrappers' => array(
'webform_element',
),
'#translatable' => array(
'title',
'description',
),
);
if (isset($value)) {
$form_item['#default_value'] = $value;
}
elseif (isset($default_value)) {
$form_item['#default_value'] = $default_value;
}
break;
}
return $form_item;
}
/**
* Validation Callback for term reference field.
*/
function webform_references_validate_term_reference($element, $form_state) {
$value = $element['#value'];
$tid = NULL;
if (!empty($value)) {
preg_match('/^(?:\\s*|(.*) )?\\[\\s*id\\s*:\\s*(\\d+)\\s*\\]$/', $value, $matches);
if (!empty($matches)) {
list(, $name, $tid) = $matches;
if (!empty($name)) {
$real_name = db_select('taxonomy_term_data', 't')
->fields('t', array(
'name',
))
->condition('t.tid', $tid)
->execute()
->fetchField();
if (trim($name) != trim($real_name)) {
form_error($element, t('Please check your selection.'));
}
}
}
else {
form_error($element, t('Please check your selection.'));
}
}
}
/**
* A hook for changing the input values before saving to the database.
*
* Note that Webform will save the result of this function directly into the
* database.
*
* @param array $component
* A Webform component array.
* @param string $value
* The POST data associated with the user input.
*
* @return string
* A string of value to be saved into the database.
*/
function _webform_submit_term_reference(array $component, $value) {
if ($component['extra']['widget_type'] == 'autocomplete') {
preg_match('/^(?:\\s*|(.*) )?\\[\\s*id\\s*:\\s*(\\d+)\\s*\\]$/', $value, $matches);
if (!empty($matches)) {
list(, , $tid) = $matches;
$value = $tid;
}
}
return $value;
}
/**
* Implements _webform_theme_component().
*/
function _webform_theme_term_reference() {
return array(
'webform_display_term_reference_field' => array(
'render element' => 'element',
),
);
}
/**
* Display the result of a submission for a component.
*
* The output of this function will be displayed under the "Results" tab then
* "Submissions". This should output the saved data in some reasonable manner.
*
* @param array $component
* A Webform component array.
* @param array $value
* An array of information containing the submission result, directly
* correlating to the webform_submitted_data database table schema.
* or NULL if no value submitted.
* @param string $format
* Either 'html' or 'text'. Defines the format that the content should be
* returned as. Make sure that returned content is run through check_plain()
* or other filtering functions when returning HTML.
*
* @return array
* A renderable element containing at the very least these properties:
* - #title
* - #weight
* - #component
* - #format
* - #value
* Webform also uses #theme_wrappers to output the end result to the user,
* which will properly format the label and content for use within an e-mail
* (such as wrapping the text) or as HTML (ensuring consistent output).
*/
function _webform_display_term_reference(array $component, $value, $format = 'html') {
$value = (array) $value;
return array(
'#title' => $component['name'],
'#weight' => $component['weight'],
'#theme' => 'webform_display_term_reference_field',
'#theme_wrappers' => $format == 'html' ? array(
'webform_element',
) : array(
'webform_element_text',
),
'#post_render' => array(
'webform_element_wrapper',
),
'#component' => $component,
'#format' => $format,
'#value' => array_filter($value),
);
}
/**
* Format the output of data for this component.
*/
function theme_webform_display_term_reference_field($variables) {
$values = (array) $variables['element']['#value'];
$items = array();
foreach (array_filter($values) as $value) {
$tid = check_plain($value);
if ($tid) {
$items[] = _webform_references_get_term_name($tid, TRUE);
}
}
$output = count($items) > 1 ? theme('item_list', array(
'items' => $items,
)) : (isset($items[0]) ? $items[0] : '');
return $output;
}
/**
* Implements _webform_table_component().
*/
function _webform_table_term_reference(array $component, $value) {
$value = (array) $value;
$items = array();
foreach (array_filter($value) as $tid) {
if ($tid) {
$items[] = _webform_references_get_term_name($tid, TRUE);
}
}
return !empty($items) ? implode('<br />', $items) : '';
}
/**
* Return the header for this component to be displayed in a CSV file.
*
* The output of this function will be displayed under the "Results" tab then
* "Download".
*
* @param array $component
* A Webform component array.
* @param array $export_options
* An array of options that may configure export of this field.
*
* @return array
* An array of data to be displayed in the first three rows of a CSV file, not
* including either prefixed or trailing commas.
*/
function _webform_csv_headers_term_reference(array $component, array $export_options) {
$header = array();
$header[0] = '';
$header[1] = '';
$header[2] = $component['name'];
return $header;
}
/**
* Format the submitted data of a component for CSV downloading.
*
* The output of this function will be displayed under the "Results" tab then
* "Download".
*
* @param array $component
* A Webform component array.
* @param array $export_options
* An array of options that may configure export of this field.
* @param array $value
* An array of information containing the submission result, directly
* correlating to the webform_submitted_data database schema.
* or NULL if no value submitted.
*
* @return string
* A string of item to be added to the CSV file.
*/
function _webform_csv_data_term_reference(array $component, array $export_options, $value) {
$return = array();
$value = (array) $value;
foreach (array_filter($value) as $tid) {
if ($tid) {
$return[] = _webform_references_get_term_name($tid);
}
}
return !empty($return) ? implode(', ', $return) : '';
}
/**
* Menu callback for the autocomplete results.
*/
function webform_references_term_autocomplete($vid, $string = '') {
$options = array(
'string' => $string,
'limit' => 10,
);
$query = db_select('taxonomy_term_data', 't');
$query
->addField('t', 'tid');
$term_title_alias = $query
->addField('t', 'name', 'term_name');
$query
->addTag('translatable')
->addTag('term_access');
$query
->condition('t.vid', $vid);
if ($options['string'] !== '') {
$query
->condition('t.name', '%' . $options['string'] . '%', 'LIKE');
}
if ($options['limit']) {
$query
->range(0, $options['limit']);
}
$query
->orderBy($term_title_alias);
$result = $query
->execute()
->fetchAll();
$references = array();
foreach ($result as $term) {
$references[] = array(
'id' => $term->tid,
'name' => $term->term_name,
);
}
$matches = array();
foreach ($references as $row) {
$matches[$row['name'] . " [id:" . $row['id'] . "]"] = check_plain($row['name']);
}
drupal_json_output($matches);
}
/**
* Helper function to get term list.
*/
function _webform_references_get_term_list($vid, $sort_by = 'name', $order = 'ASC', $tree = FALSE) {
$term_list = array();
$terms = taxonomy_get_tree($vid);
foreach ($terms as $term) {
$prefix = $tree ? str_repeat('-', $term->depth) : '';
$term_list[$term->tid] = $prefix . $term->name;
}
return $term_list;
}
/**
* Helper function to get title of term.
*
* @param int $tid
* Term Id.
* @param bool $link
* FALSE for plain text and TRUE for linked text.
*
* @return string
* Name of the term (Linked if $link parameter is set to TRUE).
*/
function _webform_references_get_term_name($tid, $link = FALSE) {
$name = NULL;
if ($term = taxonomy_term_load($tid)) {
$name = $link == TRUE ? l($term->name, 'taxonomy/term/' . $term->tid) : check_plain($term->name);
}
return $name;
}
/**
* Helper function to get tid of term.
*
* @param string $term_name
* Term Name.
* @param bool $link
* FALSE for plain text and TRUE for linked text.
*
* @return int
* Tid of the term.
*/
function _webform_references_get_term_tid($term_name, $vid) {
$tid = db_select('taxonomy_term_data', 't')
->fields('t', array(
'tid',
))
->condition('t.name', $term_name)
->condition('t.vid', $vid)
->execute()
->fetchField();
return $tid;
}Functions
Name |
Description |
|---|---|
| theme_webform_display_term_reference_field | Format the output of data for this component. |
| webform_references_term_autocomplete | Menu callback for the autocomplete results. |
| webform_references_validate_term_reference | Validation Callback for term reference field. |
| _webform_csv_data_term_reference | Format the submitted data of a component for CSV downloading. |
| _webform_csv_headers_term_reference | Return the header for this component to be displayed in a CSV file. |
| _webform_defaults_term_reference | Implements _webform_defaults_component(). |
| _webform_display_term_reference | Display the result of a submission for a component. |
| _webform_edit_term_reference | Generate the form for editing a component. |
| _webform_references_get_term_list | Helper function to get term list. |
| _webform_references_get_term_name | Helper function to get title of term. |
| _webform_references_get_term_tid | Helper function to get tid of term. |
| _webform_references_taxonomy_reference_view_validate | To validate the reference view element in case of empty list. |
| _webform_references_taxonomy_vocabularies_validate | This is a workaround, because currently FAPI states 'required' only adds an asterisk but does not do validation. If we use the '#required' attribute on the element itself then validation will fail on the invisible referenceable… |
| _webform_render_term_reference | Render a Webform component to be part of a form. |
| _webform_submit_term_reference | A hook for changing the input values before saving to the database. |
| _webform_table_term_reference | Implements _webform_table_component(). |
| _webform_theme_term_reference | Implements _webform_theme_component(). |