class pdf_export_views_handler_area in PDF Export 7
PDF export area text handler.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_area
- class \views_handler
Expanded class hierarchy of pdf_export_views_handler_area
1 string reference to 'pdf_export_views_handler_area'
- pdf_export_views_views_data in pdf_export_views/
pdf_export_views.views.inc - Implements hook_views_data().
File
- pdf_export_views/
pdf_export_views_handler_area.inc, line 12 - Definition of pdf_export_views_handler_area.
View source
class pdf_export_views_handler_area extends views_handler_area {
/**
* {@inheritdoc}
*/
public function option_definition() {
$options = parent::option_definition();
$options['button_label'] = array(
'default' => 'Export as PDF',
);
$options['button_classes'] = array(
'default' => 'btn',
);
$options['pdf_name'] = array(
'default' => NULL,
);
$options['pdf_content_selector'] = array(
'default' => '.view',
);
$options['css_theme'] = array(
'default' => NULL,
);
$options['css_files'] = array(
'default' => NULL,
);
return $options;
}
/**
* {@inheritdoc}
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['button_label'] = array(
'#title' => t('Button label'),
'#type' => 'textfield',
'#default_value' => $this->options['button_label'],
);
$form['button_classes'] = array(
'#title' => t('CSS classes'),
'#type' => 'textfield',
'#default_value' => $this->options['button_classes'],
);
$form['pdf_name'] = array(
'#title' => t('PDF name'),
'#description' => t("Let this field empty if you want to use the view's name. If you enter a name, you should append the .pdf at the end."),
'#type' => 'textfield',
'#default_value' => $this->options['pdf_name'],
);
$form['pdf_content_selector'] = array(
'#title' => t('PDF content selector'),
'#description' => t('Use the selector for the content you would like to display on PDF, you can separate it with comma and the order passed will be respected.'),
'#type' => 'textfield',
'#required' => TRUE,
'#default_value' => $this->options['pdf_content_selector'],
);
$themes = list_themes();
$themes_options = array();
foreach ($themes as $theme_name => $theme_obj) {
if (1 == $theme_obj->status) {
$themes_options[$theme_name] = $theme_name;
}
}
$form['css_theme'] = array(
'#title' => t('CSS theme'),
'#description' => t('The theme where the css file is.'),
'#type' => 'select',
'#options' => $themes_options,
'#default_value' => $this->options['css_theme'],
);
$form['css_files'] = array(
'#title' => t('CSS file'),
'#description' => t('The path to the css file relative to the theme path. You can include multiple paths separated by an space.'),
'#type' => 'textfield',
'#default_value' => $this->options['css_files'],
);
}
/**
* {@inheritdoc}
*/
public function render($empty = FALSE) {
// Don't show export button when view is empty and "Display even if view has
// no result" is unchecked
if ($empty && !$this->options['empty']) {
return '';
}
$button_classes = explode(' ', $this->options['button_classes']);
$pdf_name = $this->view->name . '.pdf';
if (!empty($this->options['pdf_name'])) {
$pdf_name = $this->options['pdf_name'];
}
return theme('pdf_export_button', array(
'attributes' => array(
'class' => $button_classes,
),
'label' => $this->options['button_label'],
'file_name' => $pdf_name,
'css_paths' => $this->options['css_files'],
'theme_name' => $this->options['css_theme'],
'css_selector' => $this->options['pdf_content_selector'],
));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
pdf_export_views_handler_area:: |
public | function |
Default options form that provides the label widget that all fields should
have. Overrides views_handler_area:: |
|
pdf_export_views_handler_area:: |
public | function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_area:: |
|
pdf_export_views_handler_area:: |
public | function |
Render the area. Overrides views_handler_area:: |
|
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
views_handler:: |
public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
views_handler:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 5 |
views_handler:: |
public | function | Validate the options form. | 4 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_area:: |
public | function |
Provide extra data to the administration form. Overrides views_handler:: |
|
views_handler_area:: |
public | function |
Init the handler with necessary data. Overrides views_handler:: |
|
views_handler_area:: |
public | function | ||
views_handler_area:: |
public | function | Don't run a query. | 1 |
views_handler_area:: |
public | function |
Area handlers shouldn't have groupby. Overrides views_handler:: |
|
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 | Destructor. | 2 |
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 |