You are here

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

class views_plugin_style_xml_test in Views Datasource 7

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

Implements views_plugin_style

Hierarchy

Expanded class hierarchy of views_plugin_style_xml_test

File

views/plugins/views_plugin_style_xml_test.inc, line 11
Implementation of views_plugin_style for views_xml

View source 
class views_plugin_style_xml_test extends views_plugin_style {
  function option_definition() {
    $options = parent::option_definition();
    $options['schema'] = array(
      'default' => 'raw',
      'translatable' => TRUE,
    );
    $options['root_element'] = array(
      'default' => 'node',
      'translatable' => TRUE,
    );
    $options['field_output'] = array(
      'default' => 'normal',
      'translatable' => TRUE,
    );
    $options['element_output'] = array(
      'default' => 'nested',
      'translatable' => TRUE,
    );
    $options['escape_as_CDATA'] = array(
      'default' => 'yes',
      'translatable' => TRUE,
    );
    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' => array(
        'raw' => t('Raw XML'),
        'opml' => t('OPML'),
        'atom' => t('Atom'),
      ),
      '#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 the XML document.'),
    );
    $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['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 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'],
    );
  }
  function render() {
    $view =& $this->view;
    $options = $this->options;
    $field = $view->field;

    //views_xml_test_debug_stop($view->result);

    //views_xml_test_debug_stop($field["body"]->options["label"]);

    //view_xml_test_debug($field["body"]-)

    /*
    if (empty($this->row_plugin)) {
      vpr('views_plugin_style_xml_test: Views XML: The row plugin for this style must be the XML element plugin.');
      drupal_set_message('<b style="color:red">Views XML: The row plugin for this style must be the XML element plugin.</b>');
      return;
    }

    if (get_class($this->row_plugin) !== 'views_plugin_row_xml_test') {
      vpr('views_plugin_style_xml_test: The row plugin for this style must be the XML element plugin.');
      drupal_set_message('<b style="color:red">Views XML: The row plugin for this style must be the XML element plugin.</b>');
      return;
    }
    */
    $rows = array();
    foreach ($view->result as $row) {

      //views_xml_test_debug_stop($row);
      $rows[] = _views_xml_test_render_fields($view, $row);
    }

    //views_xml_test_debug_stop($rows);
    return theme($this
      ->theme_functions(), array(
      'view' => $this->view,
      'options' => $this->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::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
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::theme_functions public function Provide a full list of possible theme templates used by this style.
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_test::options_form function Provide a form for setting options. Overrides views_plugin_style::options_form
views_plugin_style_xml_test::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
views_plugin_style_xml_test::render function Render the display in this style. Overrides views_plugin_style::render