function _webform_display_phone in Webform Phone Number 7.2

Same name and namespace in other branches

1. 7 webform_phone.components.inc \_webform_display_phone()

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

$component: A Webform component array.

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

$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

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

./webform_phone.components.inc, line 244

Webform Component information for a phone number field type

Code

function _webform_display_phone($component, $value, $format = 'html') {
  $rendered_value = _webform_phone_render_value($component, $value);
  return array(
    '#title' => $component['name'],
    '#weight' => $component['weight'],
    '#theme' => 'webform_display_phonefield',
    '#theme_wrappers' => $format == 'html' ? array(
      'webform_element',
    ) : array(
      'webform_element_text',
    ),
    '#post_render' => array(
      'webform_element_wrapper',
    ),
    '#component' => $component,
    '#format' => $format,
    '#markup' => $rendered_value,
  );
}