class views_data_export_plugin_style_export in Views data export 7
Same name and namespace in other branches
- 6.3 plugins/views_data_export_plugin_style_export.inc \views_data_export_plugin_style_export
- 6 plugins/views_data_export_plugin_style_export.inc \views_data_export_plugin_style_export
- 6.2 plugins/views_data_export_plugin_style_export.inc \views_data_export_plugin_style_export
- 7.4 plugins/views_data_export_plugin_style_export.inc \views_data_export_plugin_style_export
- 7.3 plugins/views_data_export_plugin_style_export.inc \views_data_export_plugin_style_export
Generalized style plugin for export plugins.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of views_data_export_plugin_style_export
1 string reference to 'views_data_export_plugin_style_export'
- views_data_export_views_plugins in ./
views_data_export.views.inc - Implementation of hook_views_plugins().
File
- plugins/
views_data_export_plugin_style_export.inc, line 12 - Plugin include file for export style plugin.
View source
class views_data_export_plugin_style_export extends views_plugin_style {
/**
* Set options fields and default values.
*
* @return
* An array of options information.
*/
function option_definition() {
$options = parent::option_definition();
$options['attach_text'] = array(
'default' => $this->definition['export feed text'],
'translatable' => TRUE,
);
$options['provide_file'] = array(
'default' => FALSE,
'translatable' => FALSE,
);
$options['filename'] = array(
'default' => $this->definition['export feed file'],
'translatable' => FALSE,
);
$options['parent_sort'] = array(
'default' => FALSE,
'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) {
$form['attach_text'] = array(
'#type' => 'textfield',
'#title' => t('Attach text'),
'#default_value' => $this->options['attach_text'],
'#description' => t('This text is used in building the feed link. By default it is the "alt" text for the feed image.'),
);
$form['provide_file'] = array(
'#type' => 'checkbox',
'#title' => t('Provide as file'),
'#default_value' => $this->options['provide_file'],
'#description' => t('By deselecting this, the xml file will be provided as a feed instead of a file for download.'),
);
$form['filename'] = array(
'#type' => 'textfield',
'#title' => t('Filename'),
'#default_value' => $this->options['filename'],
'#description' => t('The filename that will be suggested to the browser for downloading purposes. %view will be replaced with the view name.'),
'#process' => array(
'ctools_dependent_process',
),
'#dependency' => array(
'edit-style-options-provide-file' => array(
TRUE,
),
),
);
$form['parent_sort'] = array(
'#type' => 'checkbox',
'#title' => t('Parent sort'),
'#default_value' => $this->options['parent_sort'],
'#description' => t('Try to apply any additional sorting from the attached display like table sorting to the exported feed.'),
);
}
/**
* Attach this view to another display as a feed.
*
* Provide basic functionality for all export style views like attaching a
* feed image link.
*/
function attach_to($display_id, $path, $title) {
$type = $this->definition['export feed type'];
$theme_pattern = array(
'views_data_export_feed_icon__' . $this->view->name . '__' . $display_id . '__' . $type,
'views_data_export_feed_icon__' . $this->view->name . '__' . $display_id,
'views_data_export_feed_icon__' . $this->view->name . '__' . $type,
'views_data_export_feed_icon__' . $display_id . '__' . $type,
'views_data_export_feed_icon__' . $display_id,
'views_data_export_feed_icon__' . $type,
'views_data_export_feed_icon',
);
$query = $this->view
->get_exposed_input();
// Stash the display id we're coming form in the url so we can hijack it later.
if ($this->options['parent_sort']) {
$query['attach'] = $display_id;
}
$this->view->feed_icon .= theme($theme_pattern, array(
'image_path' => $this->defintion['export feed icon'],
'url' => $this->view
->get_url(NULL, $path),
'query' => $query,
'text' => $this->options['attach_text'],
));
}
function build_sort() {
// Bypass doing any sort of testing if parent sorting is disabled.
if (!$this->options['parent_sort']) {
return parent::build_sort();
}
$displays = $this->display->handler
->get_option('displays');
// Here is later. We can get the passed argument and use it to know which
// display we can from and then do some addition processing.
// If the display exists and is attached these two tests will succeed.
if (isset($_GET['attach']) && isset($displays[$_GET['attach']]) && $displays[$_GET['attach']]) {
// Setup the second style we're going to be using to sort on.
$plugin_id = $displays[$_GET['attach']];
$parent_display = $this->view->display[$plugin_id];
$style_name = $parent_display->handler
->get_option('style_plugin');
$style_options = $parent_display->handler
->get_option('style_options');
$this->extra_style = views_get_plugin('style', $style_name);
$this->extra_style
->init($this->view, $parent_display, $style_options);
// Call the second styles sort funciton and return the value.
return $this->extra_style
->build_sort();
}
}
function build_sort_post() {
// If we found an extra style plugin earlier, pass off the build_sort_post call to it.
if (isset($this->extra_style)) {
return $this->extra_style
->build_sort_post();
}
else {
return parent::build_sort_post();
}
}
/**
* Render the display in this style.
*/
function render() {
if ($this
->uses_row_plugin() && empty($this->row_plugin)) {
vpr('views_plugin_style_default: Missing row plugin');
return;
}
$output = '';
$rows['header'] = $this
->render_header();
$rows['body'] = $this
->render_body();
$rows['footer'] = $this
->render_footer();
$title = '';
$output .= theme($this
->theme_functions(), array(
'view' => $this->view,
'options' => $this->options,
'rows' => $rows,
'title' => $title,
));
return $output;
}
function render_header() {
$rows = array();
$title = '';
$output = '';
$output .= theme($this->definition['additional themes base'] . '_header', array(
'view' => $this->view,
'options' => $this->options,
'rows' => $rows,
'title' => $title,
));
return $output;
}
function render_footer() {
$rows = array();
$title = '';
$output = '';
$output .= theme($this->definition['additional themes base'] . '_footer', array(
'view' => $this->view,
'options' => $this->options,
'rows' => $rows,
'title' => $title,
));
return $output;
}
function render_body() {
if ($this
->uses_row_plugin() && empty($this->row_plugin)) {
vpr('views_plugin_style_default: Missing row plugin');
return;
}
// Group the rows according to the grouping field, if specified.
$sets = $this
->render_grouping($this->view->result, $this->options['grouping']);
// Render each group separately and concatenate. Plugins may override this
// method if they wish some other way of handling grouping.
$output = '';
foreach ($sets as $title => $records) {
if ($this
->uses_row_plugin()) {
$rows = array();
foreach ($records as $row_index => $row) {
$this->view->row_index = $row_index;
$rows[] = $this->row_plugin
->render($row);
}
}
else {
$rows = $records;
}
$title = '';
$output .= theme($this->definition['additional themes base'] . '_body', array(
'view' => $this->view,
'options' => $this->options,
'rows' => $rows,
'title' => $title,
));
}
unset($this->view->row_index);
return $output;
}
/**
* Provide a full list of possible theme templates used by this style.
*/
function theme_functions($hook = NULL) {
if (is_null($hook)) {
$hook = $this->definition['theme'];
}
return views_theme_functions($hook, $this->view, $this->display);
}
/**
* Add any HTTP headers that this style plugin wants to.
*/
function add_http_headers() {
drupal_add_http_header('Cache-Control', 'max-age=60, must-revalidate');
if (!empty($this->definition['export headers'])) {
foreach ($this->definition['export headers'] as $name => $value) {
drupal_add_http_header($name, $value);
}
}
if (isset($this->options['filename']) && !empty($this->options['provide_file'])) {
$filename = strtr($this->options['filename'], array(
'%view' => check_plain($this->view->name),
));
if ($filename) {
drupal_add_http_header('Content-Disposition', 'attachment; filename="' . $filename . '"');
}
}
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_data_export_plugin_style_export:: |
function | Add any HTTP headers that this style plugin wants to. | ||
views_data_export_plugin_style_export:: |
function | Attach this view to another display as a feed. | ||
views_data_export_plugin_style_export:: |
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. Overrides views_plugin_style:: |
||
views_data_export_plugin_style_export:: |
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. Overrides views_plugin_style:: |
||
views_data_export_plugin_style_export:: |
function |
Options form mini callback. Overrides views_plugin_style:: |
2 | |
views_data_export_plugin_style_export:: |
function |
Set options fields and default values. Overrides views_plugin_style:: |
2 | |
views_data_export_plugin_style_export:: |
function |
Render the display in this style. Overrides views_plugin_style:: |
||
views_data_export_plugin_style_export:: |
function | |||
views_data_export_plugin_style_export:: |
function | |||
views_data_export_plugin_style_export:: |
function | |||
views_data_export_plugin_style_export:: |
function |
Provide a full list of possible theme templates used by this style. Overrides views_plugin:: |
||
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_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 |
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 | Initialize a style plugin. | |
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:: |