ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Public Member Functions | Protected Attributes
ilTCPDFRenderer Class Reference
+ Inheritance diagram for ilTCPDFRenderer:
+ Collaboration diagram for ilTCPDFRenderer:

Public Member Functions

 __construct ()
 from ilPlugin More...
 
 addConfigElementsToForm (\ilPropertyFormGUI $form, $service, $purpose)
 from ilRendererConfig More...
 
 populateConfigElementsInForm (\ilPropertyFormGUI $form, $service, $purpose, $config)
 from ilRendererConfig More...
 
 validateConfigInForm (\ilPropertyFormGUI $form, $service, $purpose)
 from ilRendererConfig More...
 
 getConfigFromForm (\ilPropertyFormGUI $form, $service, $purpose)
 from ilRendererConfig More...
 
 getDefaultConfig ($service, $purpose)
 from ilRendererConfig More...
 
 prepareGenerationRequest ($service, $purpose)
 Prepare the content processing at the beginning of a PDF generation request Should be used to initialize the processing of latex code The PDF renderers require different image formats generated by the MathJax service. More...
 
 generatePDF ($service, $purpose, $config, $job)
 from ilPDFRenderer More...
 

Protected Attributes

 $lng
 

Detailed Description

Definition at line 6 of file class.ilTCPDFRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

ilTCPDFRenderer::__construct ( )

from ilPlugin

ilDummyRendererPlugin constructor.

Definition at line 16 of file class.ilTCPDFRenderer.php.

References $DIC.

17  {
18  global $DIC;
19  $this->lng = $DIC['lng'];
20  }
$DIC
global $DIC
Definition: saml.php:7

Member Function Documentation

◆ addConfigElementsToForm()

ilTCPDFRenderer::addConfigElementsToForm ( \ilPropertyFormGUI  $form,
  $service,
  $purpose 
)

from ilRendererConfig

Parameters
\ilPropertyFormGUI$form
string$service
string$purpose
Returns
|void

Implements ilRendererConfig.

Definition at line 31 of file class.ilTCPDFRenderer.php.

References ilPropertyFormGUI\addItem().

32  {
33  $margin_left = new ilTextInputGUI($this->lng->txt('margin_left'), 'margin_left');
34  $form->addItem($margin_left);
35 
36  $margin_top = new ilTextInputGUI($this->lng->txt('margin_top'), 'margin_top');
37  $form->addItem($margin_top);
38 
39  $margin_right = new ilTextInputGUI($this->lng->txt('margin_right'), 'margin_right');
40  $form->addItem($margin_right);
41 
42  $margin_bottom = new ilTextInputGUI($this->lng->txt('margin_bottom'), 'margin_bottom');
43  $form->addItem($margin_bottom);
44 
45  $image_scale = new ilTextInputGUI($this->lng->txt('image_scale'), 'image_scale');
46  $form->addItem($image_scale);
47  }
$form
if(isset($_POST['submit'])) $form
Definition: registry.edit.php:63
ilTextInputGUI
This class represents a text property in a property form.
Definition: class.ilTextInputGUI.php:16
+ Here is the call graph for this function:

◆ generatePDF()

ilTCPDFRenderer::generatePDF (   $service,
  $purpose,
  $config,
  $job 
)

from ilPDFRenderer

Parameters
string$service
string$purpose
array$config
\ilPDFGenerationJob$job

Implements ilPDFRenderer.

Definition at line 154 of file class.ilTCPDFRenderer.php.

References $config, $pdf, $result, exit, PDF_FONT_MONOSPACED, PDF_FONT_NAME_DATA, PDF_FONT_NAME_MAIN, PDF_FONT_SIZE_DATA, PDF_FONT_SIZE_MAIN, PDF_MARGIN_FOOTER, PDF_MARGIN_HEADER, PDF_PAGE_FORMAT, PDF_PAGE_ORIENTATION, and PDF_UNIT.

155  {
156  require_once 'libs/composer/vendor/autoload.php';
157 
158  // create new PDF document
159  $pdf = new TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
160 
161  $pdf->SetMargins($config['margin_left'], $config['margin_top'], $config['margin_right']);
162  $pdf->SetAutoPageBreak('auto', $config['margin_buttom']);
163  $pdf->setImageScale($config['image_scale']);
164 
165  $pdf->setHeaderFont(array(PDF_FONT_NAME_MAIN, '', PDF_FONT_SIZE_MAIN));
166  $pdf->setFooterFont(array(PDF_FONT_NAME_DATA, '', PDF_FONT_SIZE_DATA));
167  $pdf->SetDefaultMonospacedFont(PDF_FONT_MONOSPACED);
168  $pdf->SetHeaderMargin(PDF_MARGIN_HEADER);
169  $pdf->SetFooterMargin(PDF_MARGIN_FOOTER);
170  $pdf->SetFont('dejavusans', '', 10);
171  $pdf->setSpacesRE('/[^\S\xa0]/'); // Fixing unicode/PCRE-mess #17547
172 
173  foreach ($job->getPages() as $page) {
174  $page = ' ' . $page;
175  $pdf->AddPage();
176  $pdf->writeHTML($page, true, false, true, false, '');
177  }
178  $result = $pdf->Output(basename($job->getFilename()), $job->getOutputMode()); // (I - Inline, D - Download, F - File)
179 
180  if (in_array($job->getOutputMode(), array('I', 'D'))) {
181  exit();
182  }
183  }
PDF_MARGIN_HEADER
const PDF_MARGIN_HEADER
Header margin.
Definition: tcpdf_config.php:127
$config
$config
Definition: bootstrap.php:15
$result
$result
Definition: CleanUpTest.php:463
PDF_FONT_SIZE_MAIN
const PDF_FONT_SIZE_MAIN
Default main font size.
Definition: tcpdf_config.php:162
$pdf
$pdf
Definition: example_001.php:31
PDF_FONT_SIZE_DATA
const PDF_FONT_SIZE_DATA
Default data font size.
Definition: tcpdf_config.php:172
PDF_FONT_NAME_MAIN
const PDF_FONT_NAME_MAIN
Default main font name.
Definition: tcpdf_config.php:157
TCPDF
PHP class for generating PDF documents without requiring external extensions.
Definition: tcpdf.php:134
PDF_UNIT
const PDF_UNIT
Document unit of measure [pt=point, mm=millimeter, cm=centimeter, in=inch].
Definition: tcpdf_config.php:122
PDF_PAGE_ORIENTATION
const PDF_PAGE_ORIENTATION
Page orientation (P=portrait, L=landscape).
Definition: tcpdf_config.php:97
exit
exit
Definition: backend.php:16
PDF_FONT_NAME_DATA
const PDF_FONT_NAME_DATA
Default data font name.
Definition: tcpdf_config.php:167
PDF_PAGE_FORMAT
const PDF_PAGE_FORMAT
Page format.
Definition: tcpdf_config.php:92
PDF_FONT_MONOSPACED
const PDF_FONT_MONOSPACED
Default monospaced font name.
Definition: tcpdf_config.php:177
PDF_MARGIN_FOOTER
const PDF_MARGIN_FOOTER
Footer margin.
Definition: tcpdf_config.php:132

◆ getConfigFromForm()

ilTCPDFRenderer::getConfigFromForm ( \ilPropertyFormGUI  $form,
  $service,
  $purpose 
)

from ilRendererConfig

Parameters
\ilPropertyFormGUI$form
string$service
string$purpose
Returns
array

Implements ilRendererConfig.

Definition at line 93 of file class.ilTCPDFRenderer.php.

References ilPropertyFormGUI\getItemByPostVar().

94  {
95  $retval = array(
96  'margin_left' => $form->getItemByPostVar('margin_left')->getValue(),
97  'margin_right' => $form->getItemByPostVar('margin_right')->getValue(),
98  'margin_top' => $form->getItemByPostVar('margin_top')->getValue(),
99  'margin_bottom' => $form->getItemByPostVar('margin_bottom')->getValue(),
100  'image_scale' => $form->getItemByPostVar('image_scale')->getValue(),
101  );
102 
103  return $retval;
104  }
$form
if(isset($_POST['submit'])) $form
Definition: registry.edit.php:63
+ Here is the call graph for this function:

◆ getDefaultConfig()

ilTCPDFRenderer::getDefaultConfig (   $service,
  $purpose 
)

from ilRendererConfig

Parameters
string$service
string$purpose
Returns
array

Implements ilRendererConfig.

Definition at line 115 of file class.ilTCPDFRenderer.php.

116  {
117  $retval = array(
118  'margin_left' => '10',
119  'margin_top' => '10',
120  'margin_right' => '10',
121  'margin_bottom' => '10',
122  'image_scale' => '1',
123  );
124 
125  return $retval;
126  }

◆ populateConfigElementsInForm()

ilTCPDFRenderer::populateConfigElementsInForm ( \ilPropertyFormGUI  $form,
  $service,
  $purpose,
  $config 
)

from ilRendererConfig

Parameters
\ilPropertyFormGUI$form
string$service
string$purpose
array$config
Returns
|void

Implements ilRendererConfig.

Definition at line 59 of file class.ilTCPDFRenderer.php.

References $config, and ilPropertyFormGUI\getItemByPostVar().

60  {
61  $form->getItemByPostVar('margin_left')->setValue($config['margin_left']);
62  $form->getItemByPostVar('margin_right')->setValue($config['margin_right']);
63  $form->getItemByPostVar('margin_top')->setValue($config['margin_top']);
64  $form->getItemByPostVar('margin_bottom')->setValue($config['margin_bottom']);
65  $form->getItemByPostVar('image_scale')->setValue($config['image_scale']);
66  }
$config
$config
Definition: bootstrap.php:15
$form
if(isset($_POST['submit'])) $form
Definition: registry.edit.php:63
+ Here is the call graph for this function:

◆ prepareGenerationRequest()

ilTCPDFRenderer::prepareGenerationRequest (   $service,
  $purpose 
)

Prepare the content processing at the beginning of a PDF generation request Should be used to initialize the processing of latex code The PDF renderers require different image formats generated by the MathJax service.

Parameters
string$service
string$purpose
Returns
void

Implements ilPDFRenderer.

Definition at line 137 of file class.ilTCPDFRenderer.php.

References ilMathJax\getInstance(), ilMathJax\PURPOSE_PDF, and ilMathJax\RENDER_PNG_AS_IMG_EMBED.

138  {
139  ilMathJax::getInstance()
140  ->init(ilMathJax::PURPOSE_PDF)
141  ->setRendering(ilMathJax::RENDER_PNG_AS_IMG_EMBED)
142  ->setDpi(600)
143  ->setZoomFactor(0.17);
144  }
ilMathJax\RENDER_PNG_AS_IMG_EMBED
const RENDER_PNG_AS_IMG_EMBED
Definition: class.ilMathJax.php:27
ilMathJax\PURPOSE_PDF
const PURPOSE_PDF
Definition: class.ilMathJax.php:13
ilMathJax\getInstance
static getInstance()
Singleton: get instance.
Definition: class.ilMathJax.php:155
+ Here is the call graph for this function:

◆ validateConfigInForm()

ilTCPDFRenderer::validateConfigInForm ( \ilPropertyFormGUI  $form,
  $service,
  $purpose 
)

from ilRendererConfig

Parameters
\ilPropertyFormGUI$form
string$service
string$purpose
Returns
bool

Implements ilRendererConfig.

Definition at line 77 of file class.ilTCPDFRenderer.php.

78  {
79  if (true) {
80  return true;
81  }
82  }

Field Documentation

◆ $lng

ilTCPDFRenderer::$lng
protected

Definition at line 9 of file class.ilTCPDFRenderer.php.

The documentation for this class was generated from the following file: