function format_xml_elements in Drupal 7

Same name and namespace in other branches

1. 4 includes/common.inc \format_xml_elements()
2. 5 includes/common.inc \format_xml_elements()
3. 6 includes/common.inc \format_xml_elements()

Formats XML elements.

Parameters

$array: An array where each item represents an element and is either a:

• (key => value) pair (<key>value</key>)
• Associative array with fields:
  • 'key': element name
  • 'value': element contents
  • 'attributes': associative array of element attributes
  • 'encoded': TRUE if 'value' is already encoded

In both cases, 'value' can be a simple string, or it can be another array with the same format as $array itself for nesting.

If 'encoded' is TRUE it is up to the caller to ensure that 'value' is either entity-encoded or CDATA-escaped. Using this option is not recommended when working with untrusted user input, since failing to escape the data correctly has security implications.

Related topics

4 calls to format_xml_elements()

format_rss_channel in includes/common.inc

Formats an RSS channel.

format_rss_item in includes/common.inc

Formats a single RSS item.

NodeRSSContentTestCase::testNodeRSSContent in modules/node/node.test

Ensures that a new node includes the custom data when added to an RSS feed.

TaxonomyRSSTestCase::testTaxonomyRSS in modules/taxonomy/taxonomy.test

Tests that terms added to nodes are displayed in core RSS feed.

File

includes/common.inc, line 1810

Common functions that many Drupal modules will need to reference.

Code

function format_xml_elements($array) {
  $output = '';
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
      if ($value['key']) {
        $output .= ' <' . $value['key'];
        if (isset($value['attributes']) && is_array($value['attributes'])) {
          $output .= drupal_attributes($value['attributes']);
        }
        if (isset($value['value']) && $value['value'] != '') {
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : (!empty($value['encoded']) ? $value['value'] : check_plain($value['value']))) . '</' . $value['key'] . ">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</{$key}>\n";
    }
  }
  return $output;
}