You are here

Home » API reference » Views Datasource 7 » views_plugin_style_xml.inc

class views_plugin_style_xml in Views Datasource 7

Same name and namespace in other branches
  1. 6 views_plugin_style_xml.inc \views_plugin_style_xml

Implements views_plugin_style

Hierarchy

Expanded class hierarchy of views_plugin_style_xml

1 string reference to 'views_plugin_style_xml'
views_xml_views_plugins in views/views_xml.views.inc
Implements hook_views_plugins().

File

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

View source 
class views_plugin_style_xml extends views_plugin_style {

  /**
   * Implementation of views_plugin_style::option_definition
   */
  function option_definition() {
    $options = parent::option_definition();
    $author_default = isset($GLOBALS['user']->name) ? $GLOBALS['user']->name : variable_get('anonymous', t('Anonymous'));
    $options['schema'] = array(
      'default' => 'raw',
      'translatable' => FALSE,
    );
    $options['root_element'] = array(
      'default' => 'node',
      'translatable' => FALSE,
    );
    $options['top_child_object'] = array(
      'default' => 'node',
      'translatable' => FALSE,
    );
    $options['field_output'] = array(
      'default' => 'normal',
      'translatable' => FALSE,
    );
    $options['plaintext_output'] = array(
      'default' => TRUE,
      'translatable' => FALSE,
    );

    //$options['skip_empty_fields'] = array('default' => TRUE, 'translatable' => FALSE);
    $options['element_output'] = array(
      'default' => 'nested',
      'translatable' => FALSE,
    );
    $options['escape_as_CDATA'] = array(
      'default' => 'no',
      'translatable' => FALSE,
    );
    $options['content_type'] = array(
      'default' => 'text/xml',
      'translatable' => FALSE,
    );
    $options['header'] = array(
      'default' => NULL,
      'translatable' => FALSE,
    );
    $options['author'] = array(
      'default' => $author_default,
      'translatable' => FALSE,
    );
    $options['using_views_api_mode'] = array(
      'default' => FALSE,
      'translatable' => FALSE,
    );

    //$options['action_on_missing_field'] = array('default' => 'none', 'translatable' => FALSE);
    return $options;
  }

  /**
   * Provide a form for setting options.
   */
  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.'),
        );*/
  }

  /**
   * Implementation of views_style_plugin::theme_functions(). Returns an array of theme functions to use.
   * for the current style plugin
   * @return array
   */
  function theme_functions() {
    $options = $this->options;
    $hook = 'views_views_xml_style_' . $options['schema'];
    return views_theme_functions($hook, $this->view, $this->display);
  }

  /**
   * Implements views_style_plugin::additional_theme_functions(). Returns empty array.
   * @return array
   */
  function additional_theme_functions() {
    return array();
  }

  /**
   * Implementation of view_style_plugin::render()
   */
  function render() {
    $view = $this->view;
    $options = $this->options;
    $field = $view->field;
    $rows = array();
    foreach ($view->result as $count => $row) {
      $view->row_index = $count;
      $rows[] = _views_xml_render_fields($view, $row);
    }
    unset($view->row_index);
    return theme($this
      ->theme_functions(), array(
      'view' => $view,
      'options' => $options,
      'rows' => $rows,
    ));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::options_submit public function Handle any special handling on the validate form. 9
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
views_plugin_style::build_sort_post public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::init public function Initialize a style plugin.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping public function Group records as needed for rendering.
views_plugin_style::render_grouping_sets public function Render the grouping sets.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.
views_plugin_style::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate
views_plugin_style_xml::additional_theme_functions function Implements views_style_plugin::additional_theme_functions(). Returns empty array. Overrides views_plugin::additional_theme_functions
views_plugin_style_xml::options_form function Provide a form for setting options. Overrides views_plugin_style::options_form
views_plugin_style_xml::option_definition function Implementation of views_plugin_style::option_definition Overrides views_plugin_style::option_definition
views_plugin_style_xml::render function Implementation of view_style_plugin::render() Overrides views_plugin_style::render
views_plugin_style_xml::theme_functions function Implementation of views_style_plugin::theme_functions(). Returns an array of theme functions to use. for the current style plugin Overrides views_plugin::theme_functions