You are here

class sheetnode_phpexcel_plugin_style in Sheetnode 7.2

Same name and namespace in other branches
  1. 5 modules/sheetnode_phpexcel/sheetnode_phpexcel_plugin_style.inc \sheetnode_phpexcel_plugin_style
  2. 6 modules/sheetnode_phpexcel/sheetnode_phpexcel_plugin_style.inc \sheetnode_phpexcel_plugin_style
  3. 7 modules/sheetnode_phpexcel/sheetnode_phpexcel_plugin_style.inc \sheetnode_phpexcel_plugin_style

@file Views plugin style to run through sheetnode_phpexcel.

Hierarchy

Expanded class hierarchy of sheetnode_phpexcel_plugin_style

1 string reference to 'sheetnode_phpexcel_plugin_style'
sheetnode_phpexcel_views_plugins in modules/sheetnode_phpexcel/sheetnode_phpexcel.views.inc
Implementation of hook_views_plugins().

File

modules/sheetnode_phpexcel/sheetnode_phpexcel_plugin_style.inc, line 7
Views plugin style to run through sheetnode_phpexcel.

View source
class sheetnode_phpexcel_plugin_style extends sheetnode_feed_plugin_style {
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options = NULL);
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['format'] = array(
      'default' => '',
    );
    return $options;
  }
  function options_form(&$form, &$form_values) {
    parent::options_form($form, $form_values);
    foreach (sheetnode_phpexcel_get_plugins('output') as $format => $plugin) {
      $options[$format] = $plugin['short-name'];
    }
    $form['format'] = array(
      '#type' => 'radios',
      '#title' => t('Export as'),
      '#options' => $options,
      '#default_value' => $this->options['format'],
    );
  }
  function attach_to($display_id, $path, $title) {
    $plugins = sheetnode_phpexcel_get_plugins();
    $this->feed_image = drupal_get_path('module', 'sheetnode_phpexcel') . "/images/{$this->options['format']}.png";
    if (!is_file($this->feed_image)) {
      $this->feed_image = drupal_get_path('module', 'sheetnode_phpexcel') . "/images/spreadsheet.png";
    }
    parent::attach_to($display_id, $path, $title);
  }
  function render() {
    if (!empty($this->view->live_preview)) {
      drupal_set_message(t('Spreadsheet file preview is not supported.'), 'warning');
      return;
    }
    module_load_include('inc', 'sheetnode_phpexcel', 'sheetnode_phpexcel.export');
    $title = $this->display->handler
      ->get_option('title');
    if (empty($title)) {
      $title = $this->view->name;
    }
    $this
      ->inherit_options();
    sheetnode_phpexcel_batch_export(array(
      $title => parent::render_sheet(),
    ), $title, $this->options['format']);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
sheetnode_feed_plugin_style::inherit_options function Set to inherit options from sheetnode plugin style.
sheetnode_phpexcel_plugin_style::attach_to function Attach sheetnode fields to plugin style. Overrides sheetnode_plugin_style::attach_to
sheetnode_phpexcel_plugin_style::init function Initialize a style plugin. Overrides views_plugin_style::init
sheetnode_phpexcel_plugin_style::options_form function Set sheetnod feed option form. Overrides sheetnode_feed_plugin_style::options_form
sheetnode_phpexcel_plugin_style::option_definition function Set sheetnode feed option definition. Overrides sheetnode_feed_plugin_style::option_definition
sheetnode_phpexcel_plugin_style::render function Render sheetnode plugin style. Overrides sheetnode_plugin_style::render
sheetnode_plugin_style::find_field function Find sheetnode fields.
sheetnode_plugin_style::merge_annotation function Merge sheetnode annotations to plugin style.
sheetnode_plugin_style::render_inject function Inject plugin style to render.
sheetnode_plugin_style::render_sheet function Render views plugin style.
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::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