You are here

function _webform_display_addressfield in Addressfield Tokens 7

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.

Parameters

mixed $component: A Webform component array.

mixed $value: An array of information containing the submission result, directly correlating to the webform_submitted_data database table schema.

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 value

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).

File

./addressfield_tokens.components.inc, line 272
Webform Component information for an address field type.

Code

function _webform_display_addressfield($component, $value, $format = 'html') {
  $address = _addressfield_tokens_expand_value($value);
  return array(
    '#title' => $component['name'],
    '#weight' => $component['weight'],
    '#theme' => $format == 'html' ? 'addressfield_formatter' : 'addressfield_formatter__linear',
    '#theme_wrappers' => $format == 'html' ? array(
      'webform_element',
    ) : array(
      'webform_element_text',
    ),
    '#post_render' => array(
      'webform_element_wrapper',
    ),
    '#component' => $component,
    '#format' => $format,
    '#address' => $address ? $address : NULL,
    '#handlers' => $component['extra']['format_handlers'],
  );
}