class ViewsPdfBase in Views PDF 8
The main class to generate the PDF.
Hierarchy
- class \Drupal\views_pdf\ViewsPdfBase extends \setasign\Fpdi\Fpdi uses Utility
Expanded class hierarchy of ViewsPdfBase
1 file declares its use of ViewsPdfBase
- Page.php in src/
Plugin/ views/ display/ Page.php - Contains \Drupal\views_pdf\Plugin\views\display\Page.
File
- src/
ViewsPdfBase.php, line 16 - Contains \Drupal\views_pdf\ViewsPdfTemplate.
Namespace
Drupal\views_pdfView source
class ViewsPdfBase extends Fpdi {
use Utility;
/**
* List with the available fonts.
*
* @var array
*/
protected static $fontList = NULL;
/**
* Clean font list.
*
* @var array
*/
protected static $fontListClean = NULL;
/**
* List with the uploaded templates.
*
* @var array
*/
protected static $templateList = NULL;
/**
* Hyphenate.
*
* @var array
*/
protected static $hyphenatePatterns = NULL;
protected $defaultFontStyle = '';
protected $defaultFontFamily = 'Helvetica';
protected $defaultFontSize = '11';
protected $defaultTextAlign = 'L';
protected $defaultFontColor = '000000';
protected $defaultPageTemplateFiles = [];
protected $mainContentPageNumber = 0;
protected $rowContentPageNumber = 0;
protected $defaultOrientation = 'P';
protected $defaultFormat = 'A4';
protected $addNewPageBeforeNextContent = FALSE;
protected $elements = [];
protected $headerFooterData = [];
protected $viewsHeader = '';
protected $view = NULL;
protected $viewsFooter = '';
protected $headerFooterOptions = [];
protected $lastWritingPage = 1;
protected $lastWritingPositions;
protected static $defaultFontList = [
'almohanad' => 'AlMohanad',
'arialunicid0' => 'ArialUnicodeMS',
'courier' => 'Courier',
'courierb' => 'Courier Bold',
'courierbi' => 'Courier Bold Italic',
'courieri' => 'Courier Italic',
'dejavusans' => 'DejaVuSans',
'dejavusansb' => 'DejaVuSans-Bold',
'dejavusansbi' => 'DejaVuSans-BoldOblique',
'dejavusansi' => 'DejaVuSans-Oblique',
'dejavusanscondensed' => 'DejaVuSansCondensed',
'dejavusanscondensedb' => 'DejaVuSansCondensed-Bold',
'dejavusanscondensedbi' => 'DejaVuSansCondensed-BoldOblique',
'dejavusanscondensedi' => 'DejaVuSansCondensed-Oblique',
'dejavusansmono' => 'DejaVuSansMono',
'dejavusansmonob' => 'DejaVuSansMono-Bold',
'dejavusansmonobi' => 'DejaVuSansMono-BoldOblique',
'dejavusansmonoi' => 'DejaVuSansMono-Oblique',
'dejavuserif' => 'DejaVuSerif',
'dejavuserifb' => 'DejaVuSerif-Bold',
'dejavuserifbi' => 'DejaVuSerif-BoldItalic',
'dejavuserifi' => 'DejaVuSerif-Italic',
'dejavuserifcondensed' => 'DejaVuSerifCondensed',
'dejavuserifcondensedb' => 'DejaVuSerifCondensed-Bold',
'dejavuserifcondensedbi' => 'DejaVuSerifCondensed-BoldItalic',
'dejavuserifcondensedi' => 'DejaVuSerifCondensed-Italic',
'freemono' => 'FreeMono',
'freemonob' => 'FreeMonoBold',
'freemonobi' => 'FreeMonoBoldOblique',
'freemonoi' => 'FreeMonoOblique',
'freesans' => 'FreeSans',
'freesansb' => 'FreeSansBold',
'freesansbi' => 'FreeSansBoldOblique',
'freesansi' => 'FreeSansOblique',
'freeserif' => 'FreeSerif',
'freeserifb' => 'FreeSerifBold',
'freeserifbi' => 'FreeSerifBoldItalic',
'freeserifi' => 'FreeSerifItalic',
'hysmyeongjostdmedium' => 'HYSMyeongJoStd-Medium-Acro',
'helvetica' => 'Helvetica',
'helveticab' => 'Helvetica Bold',
'helveticabi' => 'Helvetica Bold Italic',
'helveticai' => 'Helvetica Italic',
'kozgopromedium' => 'KozGoPro-Medium-Acro',
'kozminproregular' => 'KozMinPro-Regular-Acro',
'msungstdlight' => 'MSungStd-Light-Acro',
'stsongstdlight' => 'STSongStd-Light-Acro',
'symbol' => 'Symbol',
'times' => 'Times New Roman',
'timesb' => 'Times New Roman Bold',
'timesbi' => 'Times New Roman Bold Italic',
'timesi' => 'Times New Roman Italic',
'zapfdingbats' => 'Zapf Dingbats',
'zarbold' => 'ZarBold',
];
/**
* This method overrides the parent constructor method.
* this is need to reset the default values.
*/
public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4', $unicode = TRUE, $encoding = 'UTF-8', $diskcache = FALSE) {
parent::__construct($orientation, $unit, $format, $unicode, $encoding, $diskcache);
$this->defaultOrientation = $orientation;
$this->defaultFormat = $format;
}
public function setDefaultFontSize($size) {
$this->defaultFontSize = $size;
}
public function setDefaultFontFamily($family) {
$this->defaultFontFamily = $family;
}
public function setDefaultFontStyle($style) {
$this->defaultFontStyle = $style;
}
public function setDefaultTextAlign($style) {
$this->defaultTextAlign = $style;
}
public function setDefaultFontColor($color) {
$this->defaultFontColor = $color;
}
public function setDefaultPageTemplate($path, $key, $pageNumbering = 'main') {
$this->defaultPageTemplateFiles[$key] = [
'path' => $path,
'numbering' => $pageNumbering,
];
}
public function setViewsHeader($header) {
$this->views_header = $header;
}
/**
* Get the page format list.
*
* @return mixed
* All formats avilable
*/
public function getPageFormat() {
$format['custom'] = t('Custom');
$format['4A0'] = '4A0';
$format['2A0'] = '2A0';
$format['A0'] = 'A0';
$format['A1'] = 'A1';
$format['A2'] = 'A2';
$format['A3'] = 'A3';
$format['A4'] = 'A4';
$format['A5'] = 'A5';
$format['A6'] = 'A6';
$format['A7'] = 'A7';
$format['A8'] = 'A8';
$format['A9'] = 'A9';
$format['A10'] = 'A10';
$format['B0'] = 'B0';
$format['B1'] = 'B1';
$format['B2'] = 'B2';
$format['B3'] = 'B3';
$format['B4'] = 'B4';
$format['B5'] = 'B5';
$format['B6'] = 'B6';
$format['B7'] = 'B7';
$format['B8'] = 'B8';
$format['B9'] = 'B9';
$format['B10'] = 'B10';
$format['C0'] = 'C0';
$format['C1'] = 'C1';
$format['C2'] = 'C2';
$format['C3'] = 'C3';
$format['C4'] = 'C4';
$format['C5'] = 'C5';
$format['C6'] = 'C6';
$format['C7'] = 'C7';
$format['C8'] = 'C8';
$format['C9'] = 'C9';
$format['C10'] = 'C10';
$format['RA0'] = 'RA0';
$format['RA1'] = 'RA1';
$format['RA2'] = 'RA2';
$format['RA3'] = 'RA3';
$format['RA4'] = 'RA4';
$format['SRA0'] = 'SRA0';
$format['SRA1'] = 'SRA1';
$format['SRA2'] = 'SRA2';
$format['SRA3'] = 'SRA3';
$format['SRA4'] = 'SRA4';
$format['LETTER'] = 'LETTER';
$format['LEGAL'] = 'LEGAL';
$format['EXECUTIVE'] = 'EXECUTIVE';
$format['FOLIO'] = 'FOLIO';
$format['MEMO'] = 'MEMO';
return $format;
}
/**
* This method must be overriden, in the other case, some
* output is printed to the header.
*/
function Header() {
if (!empty($this->views_header)) {
$this
->writeHTML($this->views_header);
}
}
public function setViewsFooter($footer) {
$this->views_footer = $footer;
}
/**
* This method must be overriden, in the other case, some
* output is printed to the footer.
*/
function Footer() {
$this
->SetY(-$this->bMargin);
if (!empty($this->views_footer)) {
$this
->writeHTML($this->views_footer);
}
}
/**
* Converts a hex color into an array with RGB colors.
*/
public function convertHexColorToArray($hex) {
if (drupal_strlen($hex) == 6) {
$r = drupal_substr($hex, 0, 2);
$g = drupal_substr($hex, 2, 2);
$b = drupal_substr($hex, 4, 2);
return [
hexdec($r),
hexdec($g),
hexdec($b),
];
}
elseif (drupal_strlen($hex) == 3) {
$r = drupal_substr($hex, 0, 1);
$g = drupal_substr($hex, 1, 1);
$b = drupal_substr($hex, 2, 1);
return [
hexdec($r),
hexdec($g),
hexdec($b),
];
}
else {
return [];
}
}
/**
* Parse color input into an array.
*
* @param string $color Color entered by the user
*
* @return array color as an array
*/
public function parseColor($color) {
$color = trim($color, ', ');
$components = explode(',', $color);
if (count($components) == 1) {
return $this
->convertHexColorToArray($color);
}
else {
// Remove white spaces from comonents:
foreach ($components as $id => $component) {
$components[$id] = trim($component);
}
return $components;
}
}
/**
* This method draws a field on the PDF.
*/
public function drawContent($row, $options, &$view = NULL, $key = NULL, $printLabels = TRUE) {
if (!is_array($options)) {
$options = [];
}
// Set defaults:
$options += [
'position' => [],
'text' => [],
'render' => [],
];
$options['position'] += [
'corner' => 'top_left',
'x' => 0,
'y' => 0,
'object' => 'last_position',
'width' => 0,
'height' => 0,
];
$options['text'] += [
'font_family' => 'default',
'font_style' => '',
];
$options['render'] += [
'minimal_space' => '',
'eval_before' => '',
'eval_after' => '',
'bypass_eval_before' => FALSE,
'bypass_eval_after' => FALSE,
];
$x = $y = 0;
// Get the page dimensions
$pageDim = $this
->getPageDimensions();
// Check if there is a minimum space defined. If so, then ensure
// that we have enough space left on this page. If not force adding
// a new one.
if (isset($options['render']['minimal_space'])) {
$enoughtSpace = $this->y + $this->bMargin + $options['render']['minimal_space'] < $pageDim['hk'];
}
else {
$enoughtSpace = TRUE;
}
// Check if there is a page, if not add it:
if (!$enoughtSpace or $this
->getPage() == 0 or $this->addNewPageBeforeNextContent == TRUE) {
$this->addNewPageBeforeNextContent = FALSE;
$this
->addPage();
}
// Get the page dimenstions again, because it can be that a new
// page was added with new dimensions.
$pageDim = $this
->getPageDimensions();
// Determine the last writting y coordinate, if we are on a new
// page we need to reset it back to the top margin.
if ($this->lastWritingPage != $this
->getPage() or $this->y + $this->bMargin > $pageDim['hk']) {
$last_writing_y_position = $this->tMargin;
}
else {
$last_writing_y_position = $this->y;
}
// Determin the x and y coordinates
if ($options['position']['object'] == 'last_position') {
$x = $this->x + $options['position']['x'];
$y = $this->y + $options['position']['y'];
}
elseif ($options['position']['object'] == 'page') {
switch ($options['position']['corner']) {
default:
case 'top_left':
$x = $options['position']['x'] + $this->lMargin;
$y = $options['position']['y'] + $this->tMargin;
break;
case 'top_right':
$x = $options['position']['x'] + $pageDim['wk'] - $this->rMargin;
$y = $options['position']['y'] + $this->tMargin;
break;
case 'bottom_left':
$x = $options['position']['x'] + $this->rMargin;
$y = $options['position']['y'] + $pageDim['hk'] - $this->bMargin;
break;
case 'bottom_right':
$x = $options['position']['x'] + $pageDim['wk'] - $this->rMargin;
$y = $options['position']['y'] + $pageDim['hk'] - $this->bMargin;
break;
}
}
elseif ($options['position']['object'] == 'self' or preg_match('/field\\_(.*)/', $options['position']['object'], $rs)) {
if ($options['position']['object'] == 'last') {
$relative_to_element = $this->lastWritingElement;
}
elseif ($options['position']['object'] == 'self') {
$relative_to_element = $key;
}
else {
$relative_to_element = $rs[1];
}
if (isset($this->elements[$relative_to_element])) {
switch ($options['position']['corner']) {
default:
case 'top_left':
$x = $options['position']['x'] + $this->elements[$relative_to_element]['x'];
$y = $options['position']['y'] + $this->elements[$relative_to_element]['y'];
break;
case 'top_right':
$x = $options['position']['x'] + $this->elements[$relative_to_element]['x'] + $this->elements[$relative_to_element]['width'];
$y = $options['position']['y'] + $this->elements[$relative_to_element]['y'];
break;
case 'bottom_left':
$x = $options['position']['x'] + $this->elements[$relative_to_element]['x'];
$y = $options['position']['y'] + $this->elements[$relative_to_element]['y'] + $this->elements[$relative_to_element]['height'];
break;
case 'bottom_right':
$x = $options['position']['x'] + $this->elements[$relative_to_element]['x'] + $this->elements[$relative_to_element]['width'];
$y = $options['position']['y'] + $this->elements[$relative_to_element]['y'] + $this->elements[$relative_to_element]['height'];
break;
}
// Handle if the relative element is on another page. So using the
// the last writing position instead for y.
if ($this
->getPage() != $this->elements[$relative_to_element]['page'] && $options['position']['object'] != 'self') {
$this
->setPage($this->elements[$relative_to_element]['page']);
}
elseif ($this
->getPage() != $this->elements[$relative_to_element]['page'] && $options['position']['object'] == 'self') {
$y = $y - $this->elements[$relative_to_element]['y'] + $last_writing_y_position;
$this
->SetPage($this->lastWritingPage);
}
}
else {
$x = $this->x;
$y = $last_writing_y_position;
}
}
else {
// No position match (for example header/footer)
// Render or return
if (is_object($view) && $key != NULL) {
$content = $view->field[$key]
->theme($row);
}
else {
return;
}
}
if ($key !== NULL && $view->field[$key]
->theme($row) || !empty($row)) {
$this
->SetX($x);
$this
->SetY($y);
$this
->renderRow($x, $y, $row, $options, $view, $key, $printLabels);
}
}
protected function renderRow($x, $y, $row, $options, &$view = NULL, $key = NULL, $printLabels = TRUE) {
$pageDim = $this
->getPageDimensions();
// Render the content if it is not already:
if (is_object($view) && $key != NULL && isset($view->field[$key]) && is_object($view->field[$key])) {
$content = $view->field[$key]
->theme($row);
}
elseif (is_string($row)) {
$content = $row;
}
else {
// We got bad data. So return.
return;
}
if (!empty($view->field[$key]->options['exclude']) || empty($content) && $view->field[$key]->options['hide_empty']) {
return '';
}
// Apply the hyphenation patterns to the content:
if (!isset($options['text']['hyphenate']) && is_object($view) && is_object($view->display_handler)) {
$options['text']['hyphenate'] = $view->display_handler
->get_option('default_text_hyphenate');
}
if (isset($options['text']['hyphenate']) && $options['text']['hyphenate'] != 'none') {
$patternFile = $options['text']['hyphenate'];
if ($options['text']['hyphenate'] == 'auto' && is_object($row)) {
// Workaround:
// Since "$nodeLanguage = $row->node_language;" does not work anymore,
// we using this:
if (isset($row->_field_data['nid']['entity']->language)) {
$nodeLanguage = $row->_field_data['nid']['entity']->language;
foreach (self::getAvailableHyphenatePatterns() as $file => $pattern) {
if (stristr($pattern, $nodeLanguage) !== FALSE) {
$patternFile = $file;
break;
}
}
}
}
$patternFile = views_pdf_get_library('tcpdf') . '/hyphenate_patterns/' . $patternFile;
if (file_exists($patternFile)) {
if (method_exists('TCPDF_STATIC', 'getHyphenPatternsFromTEX')) {
$hyphen_patterns = TCPDF_STATIC::getHyphenPatternsFromTEX($patternFile);
}
else {
$hyphen_patterns = $this
->getHyphenPatternsFromTEX($patternFile);
}
// Bugfix if you like to print some html code to the PDF, we
// need to prevent the replacement of this tags.
$content = str_replace('>', '&gt;', $content);
$content = str_replace('<', '&lt;', $content);
$content = $this
->hyphenateText($content, $hyphen_patterns);
}
}
// Set css variable
if (is_object($view) && is_object($view->display_handler)) {
$css_file = $view->display_handler
->get_option('css_file');
}
// Render Labels
$prefix = '';
if ($printLabels && !empty($view->field[$key]->options['label'])) {
$prefix = $view->field[$key]->options['label'];
if ($view->field[$key]->options['element_label_colon']) {
$prefix .= ':';
}
$prefix .= ' ';
}
$font_size = empty($options['text']['font_size']) ? $this->defaultFontSize : $options['text']['font_size'];
$font_family = $options['text']['font_family'] == 'default' || empty($options['text']['font_family']) ? $this->defaultFontFamily : $options['text']['font_family'];
$font_style = is_array($options['text']['font_style']) ? $options['text']['font_style'] : $this->defaultFontStyle;
$textColor = !empty($options['text']['color']) ? $this
->parseColor($options['text']['color']) : $this
->parseColor($this->defaultFontColor);
$w = $options['position']['width'];
$h = $options['position']['height'];
$border = 0;
$align = isset($options['text']['align']) ? $options['text']['align'] : $this->defaultTextAlign;
$fill = 0;
$ln = 1;
$reseth = TRUE;
$stretch = 0;
$ishtml = isset($options['render']['is_html']) ? $options['render']['is_html'] : 1;
$stripHTML = !$ishtml;
$autopadding = TRUE;
$maxh = 0;
$valign = 'T';
$fitcell = FALSE;
// Run eval before.
if ($options['render']['bypass_eval_before'] && !empty($options['render']['eval_before'])) {
eval($options['render']['eval_before']);
}
elseif (!empty($options['render']['eval_before'])) {
$content = php_eval($options['render']['eval_before']);
}
// Add css if there is a css file set and stripHTML is not active.
if (!empty($css_file) && is_string($css_file) && !$stripHTML && $ishtml && !empty($content)) {
$content = '<link type="text/css" rel="stylesheet" media="all" href="' . $css_file . '" />' . PHP_EOL . $content;
}
// Set Text Color.
$this
->SetTextColorArray($textColor);
// Set font.
$this
->SetFont($font_family, implode('', $font_style), $font_size);
// Save the last page before starting writing, this
// is needed to dected if we write over a page. Then we need
// to reset the y coordinate for the 'last_writing' position option.
$this->lastWritingPage = $this
->getPage();
if ($stripHTML) {
$content = strip_tags($content);
}
// Write the content of a field to the pdf file:
$this
->MultiCell($w, $h, $prefix . $content, $border, $align, $fill, $ln, $x, $y, $reseth, $stretch, $ishtml, $autopadding, $maxh, $valign, $fitcell);
// Reset font to default.
$this
->SetFont($this->defaultFontFamily, implode('', $this->defaultFontStyle), $this->defaultFontSize);
// Run eval after.
if ($options['render']['bypass_eval_after'] && !empty($options['render']['eval_alter'])) {
eval($options['render']['eval_after']);
}
elseif (!empty($options['render']['eval_alter'])) {
$content = php_eval($options['render']['eval_after']);
}
// Write Coordinates of element.
$this->elements[$key] = [
'x' => $x,
'y' => $y,
'width' => empty($w) ? $pageDim['wk'] - $this->rMargin - $x : $w,
'height' => $this->y - $y,
'page' => $this->lastWritingPage,
];
$this->lastWritingElement = $key;
}
/**
* This method draws a table on the PDF.
*/
public function drawTable(&$view, $options) {
$rows = $view->result;
$columns = $view->field;
$pageDim = $this
->getPageDimensions();
// Set draw point to the indicated position:
if (empty($options['position']['x'])) {
$options['position']['x'] = 0;
}
if (empty($options['position']['y'])) {
$options['position']['y'] = 0;
}
if (isset($options['position']['last_writing_position']) && $options['position']['last_writing_position']) {
$y = $options['position']['y'] + $this->y;
$x = $options['position']['x'] + $this->x;
}
else {
$y = $options['position']['y'];
$x = $options['position']['x'];
}
if (isset($options['position']['width']) && !empty($options['position']['width'])) {
$width = $options['position']['width'];
}
else {
$width = $pageDim['wk'] - $this->rMargin - $x;
}
$sumWidth = 0;
$numberOfColumnsWithoutWidth = 0;
// Set the definitiv width of a column
foreach ($columns as $id => $columnName) {
if (isset($options['info'][$id]['position']['width']) && !empty($options['info'][$id]['position']['width'])) {
$sumWidth += $options['info'][$id]['position']['width'];
}
else {
$numberOfColumnsWithoutWidth++;
}
}
if ($numberOfColumnsWithoutWidth > 0) {
$defaultColumnWidth = ($width - $sumWidth) / $numberOfColumnsWithoutWidth;
}
else {
$defaultColumnWidth = 0;
}
// Print header:
$rowX = $x;
$page = $this
->getPage();
if ($page == 0) {
$this
->addPage();
$page = $this
->getPage();
}
if (!isset($options['position']['row_height']) || empty($options['position']['row_height'])) {
$options['position']['row_height'] = 0;
}
foreach ($columns as $id => $column) {
if (!empty($column->options['exclude'])) {
continue;
}
if (!is_array($options['info'][$id])) {
$options['info'][$id] = [];
}
$options['info'][$id] += [
'header_style' => [],
'body_style' => [],
];
$options['info'][$id]['header_style'] += [
'position' => [],
'text' => [],
'render' => [],
];
$options['info'][$id]['header_style']['position'] += [
'corner' => 'top_left',
'x' => NULL,
'y' => NULL,
'object' => '',
'width' => NULL,
'height' => NULL,
];
$options['info'][$id]['header_style']['text'] += [
'font_family' => 'default',
'font_style' => '',
];
$options['info'][$id]['header_style']['text'] += [
'eval_before' => '',
'eval_after' => '',
];
$options['info'][$id]['body_style'] += [
'position' => [],
'text' => [],
'render' => [],
];
$options['info'][$id]['body_style']['position'] += [
'corner' => 'top_left',
'x' => NULL,
'y' => NULL,
'object' => '',
'width' => NULL,
'height' => NULL,
];
$options['info'][$id]['body_style']['text'] += [
'font_family' => 'default',
'font_style' => '',
];
$options['info'][$id]['body_style']['text'] += [
'eval_before' => '',
'eval_after' => '',
];
$headerOptions = $options['info'][$id]['header_style'];
if (isset($options['info'][$id]['position']['width']) && !empty($options['info'][$id]['position']['width'])) {
$headerOptions['position']['width'] = $options['info'][$id]['position']['width'];
}
else {
$headerOptions['position']['width'] = $defaultColumnWidth;
}
$headerOptions['position']['object'] = 'last_position_without_reset';
$this
->SetY($y);
$this
->SetX($x);
$this
->setPage($page);
$this
->renderRow($x, $y, $column->options['label'], $headerOptions);
$x += $headerOptions['position']['width'];
}
$rowY = $this->y;
if (!isset($options['position']['row_height']) || empty($options['position']['row_height'])) {
$options['position']['row_height'] = 0;
}
foreach ($rows as $row) {
$x = $rowX;
// Get the page dimensions
$pageDim = $this
->getPageDimensions();
if ($rowY + $this->bMargin + $options['position']['row_height'] > $pageDim['hk']) {
$rowY = $this->tMargin;
$this
->addPage();
}
if ($this->lastWritingPage != $this
->getPage()) {
$rowY = $this->y;
// $rowY - $pageDim['hk']
}
$y = $rowY;
$page = $this
->getPage();
foreach ($columns as $id => $column) {
if (!empty($column->options['exclude']) && is_object($view->field[$id])) {
// Render the element, but dont print the output. This
// is required to allow the use of tokens in other fields.
$view->field[$id]
->theme($row);
continue;
}
$bodyOptions = $options['info'][$id]['body_style'];
if (isset($options['info'][$id]['position']['width']) && !empty($options['info'][$id]['position']['width'])) {
$bodyOptions['position']['width'] = $options['info'][$id]['position']['width'];
}
else {
$bodyOptions['position']['width'] = $defaultColumnWidth;
}
$bodyOptions['position']['object'] = 'last_position';
$this
->setPage($page);
$this
->SetY($y);
$this
->SetX($x);
$bodyOptions['position']['height'] = 0;
$this
->renderRow($x, $y, $row, $bodyOptions, $view, $id, FALSE);
$x += $bodyOptions['position']['width'];
// If the cell is writting over the row, we need to adjust the
// row y position.
if ($rowY + $options['position']['row_height'] < $this->y) {
$rowY = $this->y - $options['position']['row_height'];
}
}
$rowY += $options['position']['row_height'];
}
$this
->SetY($rowY + $options['position']['row_height']);
}
/**
* This method adds a existing PDF document to the current document. If
* the file does not exists this method will return 0. In all other cases
* it will returns the number of the added pages.
*
* @param $path string Path to the file
*
* @return integer Number of added pages
*/
public function addPdfDocument($path) {
if (empty($path) || !file_exists($path)) {
return 0;
}
$numberOfPages = $this
->setSourceFile($path);
for ($i = 1; $i <= $numberOfPages; $i++) {
$dim = $this
->getTemplateSize($i);
$format[0] = $dim['w'];
$format[1] = $dim['h'];
if ($dim['w'] > $dim['h']) {
$orientation = 'L';
}
else {
$orientation = 'P';
}
$this
->setPageFormat($format, $orientation);
parent::addPage();
// Ensure that all new content is printed to a new page
$this->y = 0;
$page = $this
->importPage($i);
$this
->useTemplate($page, 0, 0);
$this->addNewPageBeforeNextContent = TRUE;
}
return $numberOfPages;
}
/**
* This method resets the page number. This is useful if you want to start
* the numbering by zero.
*/
public function resetRowPageNumber() {
$this->rowContentPageNumber = 0;
}
/**
* This method adds a new page to the PDF.
*/
public function addPage($path = NULL, $reset = FALSE, $numbering = 'main', $tocpage = FALSE) {
// Do not add any new page, if we are writing
// in the footer or header.
if ($this->InFooter) {
return;
}
$this->mainContentPageNumber++;
$this->rowContentPageNumber++;
// Prevent a reset without any template
if ($reset == TRUE && (empty($path) || !file_exists($path))) {
parent::addPage();
$this
->setPageFormat($this->defaultFormat, $this->defaultOrientation);
return;
}
$files = $this->defaultPageTemplateFiles;
// Reset with new template
if ($reset) {
$files = [];
}
if ($path != NULL) {
$files[] = [
'path' => $path,
'numbering' => $numbering,
];
}
$format = FALSE;
foreach ($files as $file) {
if (!empty($file['path']) && file_exists($file['path'])) {
$path = realpath($file['path']);
$numberOfPages = $this
->setSourceFile($path);
if ($file['numbering'] == 'row') {
$index = min($this->rowContentPageNumber, $numberOfPages);
}
else {
$index = min($this->mainContentPageNumber, $numberOfPages);
}
$page = $this
->importPage($index);
// ajust the page format (only for the first template)
if ($format == FALSE) {
$dim = $this
->getTemplateSize($index);
$format[0] = $dim['w'];
$format[1] = $dim['h'];
//$this->setPageFormat($format);
if ($dim['w'] > $dim['h']) {
$orientation = 'L';
}
else {
$orientation = 'P';
}
$this
->setPageFormat($format, $orientation);
parent::addPage();
}
// Apply the template
$this
->useTemplate($page, 0, 0);
}
}
// if all paths were empty, ensure that at least the page is added
if ($format == FALSE) {
parent::addPage();
$this
->setPageFormat($this->defaultFormat, $this->defaultOrientation);
}
}
/**
* Sets the current header and footer of the page.
*/
public function setHeaderFooter($record, $options, $view) {
//if ($this->getPage() > 0 && !isset($this->headerFooterData[$this->getPage()])) {
$this->headerFooterData[$this
->getPage()] = $record;
//}
$this->headerFooterOptions = $options;
$this->view =& $view;
}
/**
* Close the document. This is called automatically by
* \TCPDF::Output().
*/
public function Close() {
// Print the Header & Footer
for ($page = 1; $page <= $this
->getNumPages(); $page++) {
$this
->setPage($page);
if (isset($this->headerFooterData[$page])) {
$record = $this->headerFooterData[$page];
if (is_array($this->headerFooterOptions['formats'])) {
foreach ($this->headerFooterOptions['formats'] as $id => $options) {
if ($options['position']['object'] == 'header_footer') {
$fieldOptions = $options;
$fieldOptions['position']['object'] = 'page';
$this->InFooter = TRUE;
// backup margins
$ml = $this->lMargin;
$mr = $this->rMargin;
$mt = $this->tMargin;
$this
->SetMargins(0, 0, 0);
$this
->drawContent($record, $fieldOptions, $this->view, $id);
$this->InFooter = FALSE;
// restore margins
$this
->SetMargins($ml, $mt, $mr);
}
}
}
}
}
// call parent:
parent::Close();
}
/**
* This method returns a list of current uploaded files.
*/
public static function getAvailableTemplates() {
if (self::$templateList != NULL) {
return self::$templateList;
}
$files_path = drupal_realpath('public://');
$template_dir = variable_get('views_pdf_template_path', 'views_pdf_templates');
$dir = $files_path . '/' . $template_dir;
$templatesFiles = file_scan_directory($dir, '/.pdf$/', [
'nomask' => '/(\\.\\.?|CVS)$/',
], 1);
$templates = [];
foreach ($templatesFiles as $file) {
$templates[$file->filename] = $file->name;
}
self::$templateList = $templates;
return $templates;
}
/**
* This method returns the path to a specific template.
*/
public static function getTemplatePath($template, $row = NULL, $view = NULL) {
if (empty($template)) {
return '';
}
if ($row != NULL && $view != NULL && !preg_match('/\\.pdf/', $template)) {
return drupal_realpath($row->field_data_field_file_node_values[0]['uri']);
}
$template_dir = variable_get('views_pdf_template_stream', 'public://views_pdf_templates');
return drupal_realpath($template_dir . '/' . $template);
}
/**
* This method returns a list of available fonts.
*/
public static function getAvailableFonts() {
if (self::$fontList !== NULL) {
return self::$fontList;
}
// Get all pdf files with the font list: K_PATH_FONTS
$fonts = file_scan_directory(self::getKPathFonts(), '/.php$/', [
'nomask' => '/(\\.\\.?|CVS)$/',
'recurse' => FALSE,
], 1);
$cache = \Drupal::cache()
->get('views_pdf_cached_fonts');
$cached_font_mapping = NULL;
if (is_object($cache)) {
$cached_font_mapping = $cache->data;
}
if (is_array($cached_font_mapping)) {
$font_mapping = array_merge(self::$defaultFontList, $cached_font_mapping);
}
else {
$font_mapping = self::$defaultFontList;
}
foreach ($fonts as $font) {
$name = self::getFontNameByFileName($font->uri);
if (isset($name)) {
$font_mapping[$font->name] = $name;
}
}
asort($font_mapping);
\Drupal::cache()
->set('views_pdf_cached_fonts', $font_mapping);
// Remove all fonts without name
foreach ($font_mapping as $key => $font) {
if (empty($font)) {
unset($font_mapping[$key]);
}
}
self::$fontList = $font_mapping;
return $font_mapping;
}
/**
* This method returns a cleaned up version of the font list.
*/
public static function getAvailableFontsCleanList() {
if (self::$fontListClean != NULL) {
return self::$fontListClean;
}
$clean = self::getAvailableFonts();
foreach ($clean as $key => $font) {
// Unset bold, italic, italic/bold fonts
unset($clean[$key . 'b']);
unset($clean[$key . 'bi']);
unset($clean[$key . 'i']);
}
self::$fontListClean = $clean;
return $clean;
}
/**
* This method returns a list of hyphenation patterns, that are
* available.
*/
public static function getAvailableHyphenatePatterns() {
if (self::$hyphenatePatterns != NULL) {
return self::$hyphenatePatterns;
}
self::$hyphenatePatterns = [];
$files = file_scan_directory(libraries_get_path('tcpdf') . '/hyphenate_patterns', '/.tex$/', [
'nomask' => '/(\\.\\.?|CVS)$/',
], 1);
foreach ($files as $file) {
self::$hyphenatePatterns[basename($file->uri)] = str_replace('hyph-', '', $file->name);
}
return self::$hyphenatePatterns;
}
/**
* This method returns the name of a given font.
*/
protected static function getFontNameByFileName($path) {
include $path;
if (isset($name)) {
return $name;
}
else {
return NULL;
}
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
Utility:: |
protected static | function | Help to get the Fonts path from TCPDF. | |
|
Utility:: |
protected static | function | Help to get the TCPDF path. | |
|
Utility:: |
private static | function | Create a new reflection class. | |
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected static | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected static | property | List with the available fonts. | |
|
ViewsPdfBase:: |
protected static | property | Clean font list. | |
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected static | property | Hyphenate. | |
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected static | property | List with the uploaded templates. | |
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
protected | property | ||
|
ViewsPdfBase:: |
public | function | This method adds a new page to the PDF. | |
|
ViewsPdfBase:: |
public | function | This method adds a existing PDF document to the current document. If the file does not exists this method will return 0. In all other cases it will returns the number of the added pages. | |
|
ViewsPdfBase:: |
public | function | Close the document. This is called automatically by \TCPDF::Output(). | |
|
ViewsPdfBase:: |
public | function | Converts a hex color into an array with RGB colors. | |
|
ViewsPdfBase:: |
public | function | This method draws a field on the PDF. | |
|
ViewsPdfBase:: |
public | function | This method draws a table on the PDF. | |
|
ViewsPdfBase:: |
function | This method must be overriden, in the other case, some output is printed to the footer. | ||
|
ViewsPdfBase:: |
public static | function | This method returns a list of available fonts. | |
|
ViewsPdfBase:: |
public static | function | This method returns a cleaned up version of the font list. | |
|
ViewsPdfBase:: |
public static | function | This method returns a list of hyphenation patterns, that are available. | |
|
ViewsPdfBase:: |
public static | function | This method returns a list of current uploaded files. | |
|
ViewsPdfBase:: |
protected static | function | This method returns the name of a given font. | |
|
ViewsPdfBase:: |
public | function | Get the page format list. | |
|
ViewsPdfBase:: |
public static | function | This method returns the path to a specific template. | |
|
ViewsPdfBase:: |
function | This method must be overriden, in the other case, some output is printed to the header. | ||
|
ViewsPdfBase:: |
public | function | Parse color input into an array. | |
|
ViewsPdfBase:: |
protected | function | ||
|
ViewsPdfBase:: |
public | function | This method resets the page number. This is useful if you want to start the numbering by zero. | |
|
ViewsPdfBase:: |
public | function | ||
|
ViewsPdfBase:: |
public | function | ||
|
ViewsPdfBase:: |
public | function | ||
|
ViewsPdfBase:: |
public | function | ||
|
ViewsPdfBase:: |
public | function | ||
|
ViewsPdfBase:: |
public | function | ||
|
ViewsPdfBase:: |
public | function | Sets the current header and footer of the page. | |
|
ViewsPdfBase:: |
public | function | ||
|
ViewsPdfBase:: |
public | function | ||
|
ViewsPdfBase:: |
public | function | This method overrides the parent constructor method. this is need to reset the default values. |