You are here

function views_plugin_style_xml::options_form in Views Datasource 7

Same name and namespace in other branches
  1. 6 views_plugin_style_xml.inc \views_plugin_style_xml::options_form()

Provide a form for setting options.

Overrides views_plugin_style::options_form

File

views/plugins/views_plugin_style_xml.inc, line 63
Implements views_plugin_style for views_xml

Class

views_plugin_style_xml
Implements views_plugin_style

Code

function options_form(&$form, &$form_state) {
  $form['schema'] = array(
    '#type' => 'radios',
    '#title' => t('XML schema'),
    '#description' => t('The schema or format of the XML data document.'),
    '#options' => views_xml_views_formats(),
    '#default_value' => $this->options['schema'],
  );
  $form['root_element'] = array(
    '#type' => 'textfield',
    '#title' => t('Root element name'),
    '#default_value' => $this->options['root_element'],
    '#description' => t('The name of the root element in a raw XML document.'),
  );
  $form['top_child_object'] = array(
    '#type' => 'textfield',
    '#title' => t('Top-level child element name'),
    '#default_value' => $this->options['top_child_object'],
    '#description' => t('The name of each top-level child object in a raw XML document. e.g node or user or forum_post'),
  );
  $form['field_output'] = array(
    '#type' => 'radios',
    '#title' => t('Field output'),
    '#description' => t('For each row in the view, fields can be output as either the field rendered by Views, or by the raw content of the field.'),
    '#options' => array(
      'normal' => t('Normal'),
      'raw' => t('Raw'),
    ),
    '#default_value' => $this->options['field_output'],
  );
  $form['plaintext_output'] = array(
    '#type' => 'checkbox',
    '#title' => t('Plaintext output'),
    '#default_value' => $this->options['plaintext_output'],
    '#description' => t('For each row in the view, strip all markup from the field output.'),
  );

  /*
      $form['skip_empty_fields'] = array(
        '#type'           => 'checkbox',
        '#title'          => t('Skip adding fields that are empty.'),
        '#default_value'  => $this->options['skip_empty_fields'],
        '#description'    => t('For each row in the view, skip adding a field if the field value is NULL or blank.'),
      );*/
  $form['element_output'] = array(
    '#type' => 'radios',
    '#title' => t('Element output'),
    '#description' => t('For each row in the view, fields can be output as either nested XML child elements, or attributes of the raw XML element.'),
    '#options' => array(
      'nested' => t('Nested'),
      'attributes' => t('Attributes'),
    ),
    '#default_value' => $this->options['element_output'],
  );
  $form['escape_as_CDATA'] = array(
    '#type' => 'radios',
    '#title' => t('Escape row content as CDATA'),
    '#description' => t('For each row in the view, escape the row field content as XML CDATA sections.'),
    '#options' => array(
      'yes' => t('Yes'),
      'no' => t('No'),
    ),
    '#default_value' => $this->options['escape_as_CDATA'],
  );
  $form['header'] = array(
    '#type' => 'textarea',
    '#title' => t('XML document header'),
    '#description' => t('You can use this to place any additional lines you want after the document declaration (like !DOCTYPE.)'),
    '#default_value' => $this->options['header'],
  );
  $form['content_type'] = array(
    '#type' => 'radios',
    '#title' => t('Content-Type'),
    '#options' => array(
      'default' => t('Default: text/xml for raw documents, text/html for OPML, application/atom+xml for Atom.'),
      'text/xml' => t('text/xml'),
      'text/html' => t('text/html'),
      'text/x-opml' => t('text/x-opml'),
    ),
    '#default_value' => $this->options['content_type'],
    '#description' => t('The Content-Type header that will be sent with the XML output.'),
  );
  $form['author'] = array(
    '#type' => 'textfield',
    '#title' => t('View author'),
    '#description' => t('The Drupal user name of the person who authored this view.'),
    '#default_value' => $this->options['author'],
  );
  $form['using_views_api_mode'] = array(
    '#type' => 'checkbox',
    '#title' => t('Views API mode'),
    '#default_value' => $this->options['using_views_api_mode'],
    '#description' => t('Not using View API mode means the XML gets output directly and the server ceases normal page processing.  Using it means the server does not cease processing after outputting the JSON.  This allows the Views API to be used with the view without having to prematurely terminate page processing.'),
  );

  /*
      $form['action_on_missing_field'] = array(
        '#type'           => 'radios',
        '#title'          => t('Action on missing field'),
        '#options' => array('none' => t('Take no action if a required field is missing.'), 'warn' => t('Warn about the missing fields in preview mode.'), 'stop'=>t('Stop page processing and send an error message if a required field is missing.')),
        '#default_value'  => $this->options['action_on_missing_field'],
        '#description'    => t('Action to take if no field can be mapped to a required element or schema for the selected XML schema.'),
      );*/
}