class Fields in Views PDF 8
This class contains all the functionality of the field PDF style.
Hierarchy
- class \Fields extends \views_plugin_row
Expanded class hierarchy of Fields
1 string reference to 'Fields'
- views_pdf_views_plugins in ./
views_pdf.views.inc - Implements hook_views_plugins().
File
- src/
Plugin/ views/ row/ Fields.php, line 18 - Contains \Drupal\views_pdf\Plugin\views\row\Fields.
View source
class Fields extends views_plugin_row {
/**
* Renders the rows.
*/
function render($row) {
$options = $this
->option_definition();
// Header of a record.
$path = $this->view->pdf
->getTemplatePath($this->options['leading_template']);
$this->view->pdf
->addPdfDocument($path);
// Set row page template.
$path = $this->view->pdf
->getTemplatePath($this->options['template'], $row, $this->view);
$this->view->pdf
->setDefaultPageTemplate($path, 'row', 'row');
// Due of limitations of field renderer, we invoke them
// here and not in the field render function.
foreach ($this->view->field as $id => $field) {
if (isset($this->options['formats'][$id])) {
$options = $this->options['formats'][$id];
}
else {
$options = array();
}
$this->view->pdf
->drawContent($row, $options, $this->view, $id);
// Set or update header / footer options per row
// this ensures that we write the last record for each page
// in the cache.
$this->view->pdf
->setHeaderFooter($row, $this->options, $this->view);
}
// Footer of a record.
$path = $this->view->pdf
->getTemplatePath($this->options['succeed_template']);
$this->view->pdf
->addPdfDocument($path);
// Reset the row page number.
$this->view->pdf
->resetRowPageNumber();
}
/**
* Option definitions.
*/
function option_definition() {
$options = parent::option_definition();
$options['formats'] = array(
'default' => array(),
);
$options['leading_template'] = array(
'default' => '',
);
$options['template'] = array(
'default' => '',
);
$options['succeed_template'] = array(
'default' => '',
);
return $options;
}
/**
* Provide a form for setting options.
*/
function options_form(&$form, &$form_state) {
$options = $this->display->handler
->get_field_labels();
$fields = $this->display->handler
->get_option('fields');
$fonts = array_merge(array(
'default' => t('-- Default --'),
), \Drupal\views_pdf\ViewsPdfBase::getAvailableFontsCleanList());
$font_styles = array(
'b' => t('Bold'),
'i' => t('Italic'),
'u' => t('Underline'),
'd' => t('Line through'),
'o' => t('Overline'),
);
$templates = array_merge(array(
t('-- None --'),
), \Drupal\views_pdf\ViewsPdfBase::getAvailableTemplates());
$file_fields = array();
foreach ($this->display->handler
->get_handlers('field') as $id => $handler) {
$info = field_read_field($id);
if (isset($info['type']) && $info['type'] == 'file') {
$file_fields[$id] = $info['field_name'];
}
}
$row_templates = array_merge($templates, $file_fields);
$relative_elements = array(
'page' => t('Page'),
'header_footer' => t('In header / footer'),
'last_position' => t('Last Writing Position'),
'self' => t('Field: Self'),
);
$align = array(
'L' => t('Left'),
'C' => t('Center'),
'R' => t('Right'),
'J' => t('Justify'),
);
$hyphenate = array(
'none' => t('None'),
'auto' => t('Detect automatically'),
);
$hyphenate = array_merge($hyphenate, \Drupal\views_pdf\ViewsPdfBase::getAvailableHyphenatePatterns());
if (empty($this->options['inline'])) {
$this->options['inline'] = array();
}
$form['formats'] = array(
'#prefix' => '<div class="description form-item">',
'#suffix' => '</div>',
'#value' => t('Here you can define some style settings for each field.'),
);
foreach ($options as $field => $option) {
if (isset($fields[$field]['exclude']) && $fields[$field]['exclude'] == 1) {
continue;
}
$form['formats'][$field] = array(
'#type' => 'fieldset',
'#title' => check_plain($option),
'#collapsed' => TRUE,
'#collapsible' => TRUE,
);
$form['formats'][$field]['position'] = array(
'#type' => 'fieldset',
'#title' => t('Position Settings'),
'#collapsed' => FALSE,
'#collapsible' => TRUE,
);
$form['formats'][$field]['position']['object'] = array(
'#type' => 'select',
'#title' => t('Position relative to'),
'#required' => FALSE,
'#options' => $relative_elements,
'#default_value' => !empty($this->options['formats'][$field]['position']['object']) ? $this->options['formats'][$field]['position']['object'] : 'last_position',
);
$form['formats'][$field]['position']['corner'] = array(
'#type' => 'radios',
'#title' => t('Position relative to corner'),
'#required' => FALSE,
'#options' => array(
'top_left' => t('Top Left'),
'top_right' => t('Top Right'),
'bottom_left' => t('Bottom Left'),
'bottom_right' => t('Bottom Right'),
),
'#default_value' => !empty($this->options['formats'][$field]['position']['corner']) ? $this->options['formats'][$field]['position']['corner'] : 'top_left',
);
$relative_elements['field_' . $field] = t('Field: !field', array(
'!field' => $option,
));
$form['formats'][$field]['position']['x'] = array(
'#type' => 'textfield',
'#title' => t('Position X'),
'#required' => FALSE,
'#default_value' => !empty($this->options['formats'][$field]['position']['x']) ? $this->options['formats'][$field]['position']['x'] : '',
);
$form['formats'][$field]['position']['y'] = array(
'#type' => 'textfield',
'#title' => t('Position Y'),
'#required' => FALSE,
'#default_value' => !empty($this->options['formats'][$field]['position']['y']) ? $this->options['formats'][$field]['position']['y'] : '',
);
$form['formats'][$field]['position']['width'] = array(
'#type' => 'textfield',
'#title' => t('Width'),
'#required' => FALSE,
'#default_value' => !empty($this->options['formats'][$field]['position']['width']) ? $this->options['formats'][$field]['position']['width'] : '',
);
$form['formats'][$field]['position']['height'] = array(
'#type' => 'textfield',
'#title' => t('Height'),
'#required' => FALSE,
'#default_value' => !empty($this->options['formats'][$field]['position']['height']) ? $this->options['formats'][$field]['position']['height'] : '',
);
$form['formats'][$field]['text'] = array(
'#type' => 'fieldset',
'#title' => t('Text Settings'),
'#collapsed' => FALSE,
'#collapsible' => TRUE,
);
$form['formats'][$field]['text']['font_size'] = array(
'#type' => 'textfield',
'#title' => t('Font Size'),
'#size' => 10,
'#default_value' => isset($this->options['formats'][$field]['text']['font_size']) ? $this->options['formats'][$field]['text']['font_size'] : '',
);
$form['formats'][$field]['text']['font_family'] = array(
'#type' => 'select',
'#title' => t('Font Family'),
'#required' => TRUE,
'#options' => $fonts,
'#size' => 5,
'#default_value' => isset($this->options['formats'][$field]['text']['font_family']) ? $this->options['formats'][$field]['text']['font_family'] : 'default',
);
$form['formats'][$field]['text']['font_style'] = array(
'#type' => 'checkboxes',
'#title' => t('Font Style'),
'#options' => $font_styles,
'#size' => 10,
'#default_value' => !isset($this->options['formats'][$field]['text']['font_style']) ? $this->display->handler
->get_option('default_font_style') : $this->options['formats'][$field]['text']['font_style'],
);
$form['formats'][$field]['text']['align'] = array(
'#type' => 'radios',
'#title' => t('Alignment'),
'#options' => $align,
'#default_value' => !isset($this->options['formats'][$field]['text']['align']) ? $this->display->handler
->get_option('default_text_align') : $this->options['formats'][$field]['text']['align'],
);
$form['formats'][$field]['text']['hyphenate'] = array(
'#type' => 'select',
'#title' => t('Text Hyphenation'),
'#options' => $hyphenate,
'#description' => t('If you want to use hyphenation, then you need to download from <a href="@url">ctan.org</a> your needed pattern set. Then upload it to the dir "hyphenate_patterns" in the TCPDF lib directory. Perhaps you need to create the dir first. If you select the automated detection, then we try to get the language of the current node and select an appropriate hyphenation pattern.', array(
'@url' => 'http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/tex',
)),
'#default_value' => !isset($this->options['formats'][$field]['text']['hyphenate']) ? $this->display->handler
->get_option('default_text_hyphenate') : $this->options['formats'][$field]['text']['hyphenate'],
);
$form['formats'][$field]['text']['color'] = array(
'#type' => 'textfield',
'#title' => t('Text Color'),
'#description' => t('If a value is entered without a comma, it will be interpreted as a hexadecimal RGB color. Normal RGB can be used by separating the components by a comma. e.g 255,255,255 for white. A CMYK color can be entered in the same way as RGB. e.g. 0,100,0,0 for magenta.'),
'#size' => 20,
'#default_value' => !isset($this->options['formats'][$field]['text']['color']) ? $this->display->handler
->get_option('default_text_color') : $this->options['formats'][$field]['text']['color'],
);
$form['formats'][$field]['render'] = array(
'#type' => 'fieldset',
'#title' => t('Render Settings'),
'#collapsed' => FALSE,
'#collapsible' => TRUE,
);
$form['formats'][$field]['render']['is_html'] = array(
'#type' => 'checkbox',
'#title' => t('Render As HTML'),
'#default_value' => isset($this->options['formats'][$field]['render']['is_html']) ? $this->options['formats'][$field]['render']['is_html'] : 1,
);
$form['formats'][$field]['render']['minimal_space'] = array(
'#type' => 'textfield',
'#title' => t('Minimal Space'),
'#description' => t('Specify here the minimal space, which is needed on the page, that the content is placed on the page.'),
'#default_value' => isset($this->options['formats'][$field]['render']['minimal_space']) ? $this->options['formats'][$field]['render']['minimal_space'] : 0,
);
$form['formats'][$field]['render']['eval_before'] = array(
'#type' => 'textarea',
'#title' => t('PHP Code Before Output'),
'#default_value' => isset($this->options['formats'][$field]['render']['eval_before']) ? $this->options['formats'][$field]['render']['eval_before'] : '',
);
$form['formats'][$field]['render']['bypass_eval_before'] = array(
'#type' => 'checkbox',
'#title' => t('Use the PHP eval function instead php_eval.'),
'#description' => t("WARNING: If you don't know the risk of using eval leave as it."),
'#default_value' => !empty($this->options['formats'][$field]['render']['bypass_eval_before']) ? $this->options['formats'][$field]['render']['bypass_eval_before'] : FALSE,
);
$form['formats'][$field]['render']['eval_after'] = array(
'#type' => 'textarea',
'#title' => t('PHP Code After Output'),
'#default_value' => isset($this->options['formats'][$field]['render']['eval_after']) ? $this->options['formats'][$field]['render']['eval_after'] : '',
);
$form['formats'][$field]['render']['bypass_eval_after'] = array(
'#type' => 'checkbox',
'#title' => t('Use the PHP eval function instead php_eval.'),
'#description' => t("WARNING: If you don't know the risk of using eval leave as it."),
'#default_value' => !empty($this->options['formats'][$field]['render']['bypass_eval_after']) ? $this->options['formats'][$field]['render']['bypass_eval_after'] : FALSE,
);
}
$form['leading_template'] = array(
'#type' => 'select',
'#options' => $templates,
'#title' => t('Leading PDF Template'),
'#required' => FALSE,
'#description' => t('Here you specify a PDF file to be printed in front of every row.'),
'#default_value' => $this->options['leading_template'],
);
$form['template'] = array(
'#type' => 'select',
'#options' => $row_templates,
'#title' => t('Template PDF'),
'#description' => t('Here you specify a PDF file on which the content is printed. The first page of this document is used for the first page, in the target document. The second page is used for the second page in the target document and so on. If the target document has more that this template file, the last page of the template will be repeated. The leading document has no effect on the order of the pages. This option does not override the same option for the whole document. This template will be applyed addtionaly. The page format is defined by the document template, if it is defined.'),
'#default_value' => $this->options['template'],
);
$form['succeed_template'] = array(
'#type' => 'select',
'#options' => $templates,
'#title' => t('Succeed PDF Template'),
'#required' => FALSE,
'#description' => t('Here you specify a PDF file to be printed after the main content.'),
'#default_value' => $this->options['succeed_template'],
);
$form['template_file'] = array(
'#type' => 'file',
'#title' => t('Upload New Template File'),
);
}
/**
* Stores the options.
*/
function options_submit(&$form, &$form_state) {
$default = $this->display->handler
->get_option('default_font_style');
foreach ($form_state['values']['row_options']['formats'] as $id => $field) {
// Reset to default, if the elements are equal to the default settings.
if (count(array_diff($default, $field['text']['font_style'])) == 0 && count(array_diff($field['text']['font_style'], $default)) == 0) {
$form_state['values']['row_options']['formats'][$id]['text']['font_style'] = NULL;
}
if ($field['text']['align'] == $this->display->handler
->get_option('default_text_align')) {
$form_state['values']['row_options']['formats'][$id]['text']['align'] = NULL;
}
if ($field['text']['hyphenate'] == $this->display->handler
->get_option('default_text_hyphenate')) {
$form_state['values']['row_options']['formats'][$id]['text']['hyphenate'] = NULL;
}
}
// Save new file:
// Note: The jQuery update is required to use Ajax for file upload. With
// default Drupal jQuery it will not work.
// For upload with Ajax a iFrame is open and upload in it, because
// normal forms are not allowed to handle directly.
$destination = variable_get('views_pdf_template_stream', 'public://views_pdf_templates');
if (file_prepare_directory($destination, FILE_CREATE_DIRECTORY)) {
// The file field is not called "template_file" as expected, it calls
// "row_options". The reason for that is not clear.
$file = file_save_upload('row_options', array(), $destination);
if (is_object($file)) {
$file_name = basename($file->destination, '.pdf');
$form_state['values']['row_options']['template'] = $file_name;
$file->status |= FILE_STATUS_PERMANENT;
$file = file_save($file);
}
}
if ($form_state['values']['row_options']['leading_template'] == t('-- None --')) {
$form_state['values']['row_options']['leading_template'] = '';
}
if ($form_state['values']['row_options']['template'] == t('-- None --')) {
$form_state['values']['row_options']['template'] = '';
}
if ($form_state['values']['row_options']['succeed_template'] == t('-- None --')) {
$form_state['values']['row_options']['succeed_template'] = '';
}
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
Fields:: |
function | Provide a form for setting options. | ||
|
Fields:: |
function | Stores the options. | ||
|
Fields:: |
function | Option definitions. | ||
|
Fields:: |
function | Renders the rows. |