You are here

class views_plugin_style_xhtml in Views Datasource 6

Same name and namespace in other branches
  1. 7 views/plugins/views_plugin_style_xhtml.inc \views_plugin_style_xhtml

Implementation of views_plugin_style

Hierarchy

Expanded class hierarchy of views_plugin_style_xhtml

1 string reference to 'views_plugin_style_xhtml'
views_xhtml_views_plugins in ./views_xhtml.views.inc
Implementation of hook_views_plugin().

File

./views_plugin_style_xhtml.inc, line 12
Implementation of views_plugin_style for views_xhtml

View source
class views_plugin_style_xhtml extends views_plugin_style {

  /**
   * Set default options
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['format'] = array(
      'default' => 'hcard',
      '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['escape_as_CDATA'] = array(
      'default' => 'no',
      'translatable' => FALSE,
    );
    $options['content_type'] = array(
      'default' => 'text/xhtml',
      'translatable' => FALSE,
    );
    $options['header'] = array(
      'default' => NULL,
      'translatable' => FALSE,
    );
    $options['author'] = array(
      'default' => $user->name,
      '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.
   *
   * @param $form
   * @param $form_state
   */
  function options_form(&$form, &$form_state) {
    $form['format'] = array(
      '#type' => 'radios',
      '#title' => 'Microformat',
      '#options' => array(
        'hcard' => 'hCard',
        'hcalendar' => 'hCalendar',
      ),
      '#default_value' => $this->options['format'],
    );
    $form['field_output'] = array(
      '#type' => 'radios',
      '#title' => 'Field output',
      '#description' => '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' => 'Normal',
        'raw' => 'Raw',
      ),
      '#default_value' => $this->options['field_output'],
    );
    $form['plaintext_output'] = array(
      '#type' => 'checkbox',
      '#title' => 'Plaintext output',
      '#default_value' => $this->options['plaintext_output'],
      '#description' => 'For each row in the view, strip all markup from the field output.',
    );

    /*
        $form['skip_empty_fields'] = array(
          '#type'           => 'checkbox',
          '#title'          => ('Skip adding fields that are empty.'),
          '#default_value'  => $this->options['skip_empty_fields'],
          '#description'    => ('For each row in the view, skip adding a field if the field value is NULL or blank.'),
        );*/
    $form['escape_as_CDATA'] = array(
      '#type' => 'radios',
      '#title' => 'Escape row content as CDATA',
      '#description' => 'For each row in the view, escape the row field content as XML CDATA sections.',
      '#options' => array(
        'yes' => 'Yes',
        'no' => 'No',
      ),
      '#default_value' => $this->options['escape_as_CDATA'],
    );
    $form['header'] = array(
      '#type' => 'textarea',
      '#title' => 'XML document header',
      '#description' => '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' => 'Content-Type',
      '#options' => array(
        'default' => "Default: text/xhtml",
        'text/xml' => 'text/xml',
        'text/html' => 'text/html',
      ),
      '#default_value' => $this->options['content_type'],
      '#description' => 'The Content-Type header that will be sent with the XHTML output.',
    );
    $form['author'] = array(
      '#type' => 'textfield',
      '#title' => 'View author',
      '#description' => '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' => 'Views API mode',
      '#default_value' => $this->options['using_views_api_mode'],
      '#description' => 'Not using View API mode means the JSON 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.',
    );
  }

  /**
   * 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;
    if ($options['format'] == 'hcard') {
      $hook = 'views_views_xhtml_style_hcard';
    }
    if ($options['format'] == 'hcalendar') {
      $hook = 'views_views_xhtml_style_hcalendar';
    }
    return views_theme_functions($hook, $this->view, $this->display);
  }

  /**
   * Implementation of 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 $row) {
      $rows[] = _views_xhtml_render_fields($view, $row);
    }
    return theme($this
      ->theme_functions(), $this->view, $this->options, $rows);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_plugin_style_xhtml::additional_theme_functions function Implementation of views_style_plugin::additional_theme_functions(). Returns empty array.
views_plugin_style_xhtml::options_form function Provide a form for setting options.
views_plugin_style_xhtml::option_definition function Set default options
views_plugin_style_xhtml::render function Implementation of view_style_plugin::render()
views_plugin_style_xhtml::theme_functions function Implementation of views_style_plugin::theme_functions(). Returns an array of theme functions to use. for the current style plugin