class views_data_export_plugin_style_export_csv in Views data export 6

Generalized style plugin for export plugins.

Hierarchy

• class \views_data_export_plugin_style_export extends \views_plugin_style
  • class \views_data_export_plugin_style_export_csv

1 string reference to 'views_data_export_plugin_style_export_csv'

views_data_export_views_plugins in ./views_data_export.views.inc

Implementation of hook_views_plugins().

File

plugins/views_data_export_plugin_style_export_csv.inc, line 12

Plugin include file for export style plugin.

class views_data_export_plugin_style_export_csv extends views_data_export_plugin_style_export {

  /**
   * Set options fields and default values.
   *
   * @return
   * An array of options information.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['quote'] = array(
      'default' => TRUE,
      'translatable' => TRUE,
    );
    $options['separator'] = array(
      'default' => ',',
      'translatable' => TRUE,
    );
    $options['header'] = array(
      'default' => TRUE,
      'translatable' => FALSE,
    );
    return $options;
  }

  /**
   * Options form mini callback.
   *
   * @param $form
   * Form array to add additional fields to.
   * @param $form_state
   * State of the form.
   * @return
   * None.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['separator'] = array(
      '#type' => 'textfield',
      '#title' => t('Separator'),
      '#default_value' => !empty($this->options['separator']) ? $this->options['separator'] : ',',
      '#description' => t('This is the separator that is used to separate fields. CSV implies comma separated fields so this should not be changed unless you have specific requirements'),
    );
    $form['quote'] = array(
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['quote']),
      '#title' => t('Quote values. Useful for output that might contain your separator as part of one of the values.'),
    );
    $form['trim'] = array(
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['trim']),
      '#title' => t('Trim whitespace from rendered fields. Can be useful for some themes where output results in extra newlines.'),
    );
    $form['header'] = array(
      '#type' => 'checkbox',
      '#title' => t('Make first row a list of column headers.'),
      '#default_value' => !empty($this->options['header']),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_data_export_plugin_style_export::add_http_headers		function	Add any HTTP headers that this style plugin wants to.
views_data_export_plugin_style_export::attach_to		function	Attach this view to another display as a feed.
views_data_export_plugin_style_export::build_sort		function
views_data_export_plugin_style_export::build_sort_post		function
views_data_export_plugin_style_export::render		function	Render the display in this style.
views_data_export_plugin_style_export::render_body		function
views_data_export_plugin_style_export::render_footer		function
views_data_export_plugin_style_export::render_header		function
views_data_export_plugin_style_export::theme_functions		function	Provide a full list of possible theme templates used by this style.
views_data_export_plugin_style_export_csv::options_form		function	Options form mini callback. Overrides views_data_export_plugin_style_export::options_form
views_data_export_plugin_style_export_csv::option_definition		function	Set options fields and default values. Overrides views_data_export_plugin_style_export::option_definition