class sheetnode_phpexcel_plugin_style in Sheetnode 7.2
Same name and namespace in other branches
- 5 modules/sheetnode_phpexcel/sheetnode_phpexcel_plugin_style.inc \sheetnode_phpexcel_plugin_style
 - 6 modules/sheetnode_phpexcel/sheetnode_phpexcel_plugin_style.inc \sheetnode_phpexcel_plugin_style
 - 7 modules/sheetnode_phpexcel/sheetnode_phpexcel_plugin_style.inc \sheetnode_phpexcel_plugin_style
 
@file Views plugin style to run through sheetnode_phpexcel.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \sheetnode_plugin_style
 
 
 - class \views_plugin_style
 
 - class \views_plugin
 
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
| 
            Name | 
                  Modifiers | Type | Description | Overrides | 
|---|---|---|---|---|
| 
            sheetnode_feed_plugin_style:: | 
                  function | Set to inherit options from sheetnode plugin style. | ||
| 
            sheetnode_phpexcel_plugin_style:: | 
                  function | 
            Attach sheetnode fields to plugin style. Overrides sheetnode_plugin_style:: | 
                  ||
| 
            sheetnode_phpexcel_plugin_style:: | 
                  function | 
            Initialize a style plugin. Overrides views_plugin_style:: | 
                  ||
| 
            sheetnode_phpexcel_plugin_style:: | 
                  function | 
            Set sheetnod feed option form. Overrides sheetnode_feed_plugin_style:: | 
                  ||
| 
            sheetnode_phpexcel_plugin_style:: | 
                  function | 
            Set sheetnode feed option definition. Overrides sheetnode_feed_plugin_style:: | 
                  ||
| 
            sheetnode_phpexcel_plugin_style:: | 
                  function | 
            Render sheetnode plugin style. Overrides sheetnode_plugin_style:: | 
                  ||
| 
            sheetnode_plugin_style:: | 
                  function | Find sheetnode fields. | ||
| 
            sheetnode_plugin_style:: | 
                  function | Merge sheetnode annotations to plugin style. | ||
| 
            sheetnode_plugin_style:: | 
                  function | Inject plugin style to render. | ||
| 
            sheetnode_plugin_style:: | 
                  function | Render views plugin style. | ||
| 
            views_object:: | 
                  public | property | Handler's definition. | |
| 
            views_object:: | 
                  public | property | Except for displays, options for the object will be held here. | 1 | 
| 
            views_object:: | 
                  function | Collect this handler's option definition and alter them, ready for use. | ||
| 
            views_object:: | 
                  public | function | Views handlers use a special construct function. | 4 | 
| 
            views_object:: | 
                  public | function | 1 | |
| 
            views_object:: | 
                  public | function | ||
| 
            views_object:: | 
                  public | function | Always exports the option, regardless of the default value. | |
| 
            views_object:: | 
                  public | function | Set default options on this object. | 1 | 
| 
            views_object:: | 
                  public | function | Set default options. | |
| 
            views_object:: | 
                  public | function | Let the handler know what its full definition is. | |
| 
            views_object:: | 
                  public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
| 
            views_object:: | 
                  public | function | Unpack a single option definition. | |
| 
            views_object:: | 
                  public | function | Unpacks each handler to store translatable texts. | |
| 
            views_object:: | 
                  public | function | ||
| 
            views_plugin:: | 
                  public | property | The current used views display. | |
| 
            views_plugin:: | 
                  public | property | The plugin name of this plugin, for example table or full. | |
| 
            views_plugin:: | 
                  public | property | The plugin type of this plugin, for example style or query. | |
| 
            views_plugin:: | 
                  public | property | 
            The top object of a view. Overrides views_object:: | 
                  1 | 
| 
            views_plugin:: | 
                  public | function | Provide a list of additional theme functions for the theme info page. | |
| 
            views_plugin:: | 
                  public | function | Handle any special handling on the validate form. | 9 | 
| 
            views_plugin:: | 
                  public | function | Return the human readable name of the display. | |
| 
            views_plugin:: | 
                  public | function | Returns the summary of the settings in the display. | 8 | 
| 
            views_plugin:: | 
                  public | function | Provide a full list of possible theme templates used by this style. | |
| 
            views_plugin_style:: | 
                  public | property | The row plugin, if it's initialized and the style itself supports it. | |
| 
            views_plugin_style:: | 
                  public | property | Store all available tokens row rows. | |
| 
            views_plugin_style:: | 
                  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:: | 
                  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:: | 
                  public | function | 
            Destructor. Overrides views_object:: | 
                  |
| 
            views_plugin_style:: | 
                  public | function | Should the output of the style plugin be rendered even if it's empty. | 1 | 
| 
            views_plugin_style:: | 
                  public | function | Get a rendered field. | |
| 
            views_plugin_style:: | 
                  public | function | Get the raw field value. | |
| 
            views_plugin_style:: | 
                  public | function | Return the token replaced row class for the specified row. | |
| 
            views_plugin_style:: | 
                  public | function | 
            Validate the options form. Overrides views_plugin:: | 
                  |
| 
            views_plugin_style:: | 
                  public | function | Allow the style to do stuff before each row is rendered. | |
| 
            views_plugin_style:: | 
                  public | function | 
            Add anything to the query that we might need to. Overrides views_plugin:: | 
                  2 | 
| 
            views_plugin_style:: | 
                  public | function | Render all of the fields for a given style and store them on the object. | |
| 
            views_plugin_style:: | 
                  public | function | Group records as needed for rendering. | |
| 
            views_plugin_style:: | 
                  public | function | Render the grouping sets. | |
| 
            views_plugin_style:: | 
                  public | function | Take a value and apply token replacement logic to it. | |
| 
            views_plugin_style:: | 
                  public | function | Return TRUE if this style also uses fields. | |
| 
            views_plugin_style:: | 
                  public | function | Return TRUE if this style also uses a row plugin. | |
| 
            views_plugin_style:: | 
                  public | function | Return TRUE if this style also uses a row plugin. | |
| 
            views_plugin_style:: | 
                  public | function | Return TRUE if this style uses tokens. | |
| 
            views_plugin_style:: | 
                  public | function | 
            Validate that the plugin is correct and can be saved. Overrides views_plugin:: |