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...
	addConfigElementsToForm (\ilPropertyFormGUI $form, $service, $purpose)
	populateConfigElementsInForm (\ilPropertyFormGUI $form, $service, $purpose, $config)
	validateConfigInForm (\ilPropertyFormGUI $form, $service, $purpose)
	getConfigFromForm (\ilPropertyFormGUI $form, $service, $purpose)
	getDefaultConfig ($service, $purpose)
	generatePDF ($service, $purpose, $config, $job)
	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...

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.

    {
        global $DIC;
        $this->lng = $DIC['lng'];
    }

References $DIC.

Member Function Documentation

addConfigElementsToForm()

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

from ilRendererConfig

Parameters

\ilPropertyFormGUI	$form
string	$service
string	$purpose

Returns

\ilPropertyFormGUI|void

Implements ilRendererConfig.

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

    {
        $margin_left = new ilTextInputGUI($this->lng->txt('margin_left'), 'margin_left');
        $form->addItem($margin_left);
 
        $margin_top = new ilTextInputGUI($this->lng->txt('margin_top'), 'margin_top');
        $form->addItem($margin_top);
 
        $margin_right = new ilTextInputGUI($this->lng->txt('margin_right'), 'margin_right');
        $form->addItem($margin_right);
 
        $margin_bottom = new ilTextInputGUI($this->lng->txt('margin_bottom'), 'margin_bottom');
        $form->addItem($margin_bottom);
 
        $image_scale = new ilTextInputGUI($this->lng->txt('image_scale'), 'image_scale');
        $form->addItem($image_scale);
    }

References ilPropertyFormGUI\addItem().

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.

    {
        require_once 'libs/composer/vendor/autoload.php';
 
        // create new PDF document
        $pdf = new TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
 
        $pdf->SetMargins($config['margin_left'], $config['margin_top'], $config['margin_right']);
        $pdf->SetAutoPageBreak('auto', $config['margin_buttom']);
        $pdf->setImageScale($config['image_scale']);
 
        $pdf->setHeaderFont(array(PDF_FONT_NAME_MAIN, '', PDF_FONT_SIZE_MAIN));
        $pdf->setFooterFont(array(PDF_FONT_NAME_DATA, '', PDF_FONT_SIZE_DATA));
        $pdf->SetDefaultMonospacedFont(PDF_FONT_MONOSPACED);
        $pdf->SetHeaderMargin(PDF_MARGIN_HEADER);
        $pdf->SetFooterMargin(PDF_MARGIN_FOOTER);
        $pdf->SetFont('dejavusans', '', 10);
        $pdf->setSpacesRE('/[^\S\xa0]/'); // Fixing unicode/PCRE-mess #17547
 
        foreach ($job->getPages() as $page) {
            $page = ' ' . $page;
            $pdf->AddPage();
            $pdf->writeHTML($page, true, false, true, false, '');
        }
        $result = $pdf->Output(basename($job->getFilename()), $job->getOutputMode()); // (I - Inline, D - Download, F - File)
 
        if (in_array($job->getOutputMode(), array('I', 'D'))) {
            exit();
        }
    }

References $config, $result, and exit.

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.

    {
        $retval = array(
            'margin_left' => $form->getItemByPostVar('margin_left')->getValue(),
            'margin_right' => $form->getItemByPostVar('margin_right')->getValue(),
            'margin_top' => $form->getItemByPostVar('margin_top')->getValue(),
            'margin_bottom' => $form->getItemByPostVar('margin_bottom')->getValue(),
            'image_scale' => $form->getItemByPostVar('image_scale')->getValue(),
        );
 
        return $retval;
    }

References ilPropertyFormGUI\getItemByPostVar().

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.

    {
        $retval = array(
            'margin_left' => '10',
            'margin_top' => '10',
            'margin_right' => '10',
            'margin_bottom' => '10',
            'image_scale' => '1',
        );
 
        return $retval;
    }

populateConfigElementsInForm()

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

from ilRendererConfig

Parameters

\ilPropertyFormGUI	$form
string	$service
string	$purpose
array	$config

Returns

\ilPropertyFormGUI|void

Implements ilRendererConfig.

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

    {
        $form->getItemByPostVar('margin_left')->setValue($config['margin_left']);
        $form->getItemByPostVar('margin_right')->setValue($config['margin_right']);
        $form->getItemByPostVar('margin_top')->setValue($config['margin_top']);
        $form->getItemByPostVar('margin_bottom')->setValue($config['margin_bottom']);
        $form->getItemByPostVar('image_scale')->setValue($config['image_scale']);
    }

References $config, and ilPropertyFormGUI\getItemByPostVar().

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.

    {
        ilMathJax::getInstance()
            ->init(ilMathJax::PURPOSE_PDF)
            ->setRendering(ilMathJax::RENDER_PNG_AS_IMG_EMBED)
            ->setDpi(600)
            ->setZoomFactor(0.17);
    }

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

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.

    {
        if (true) {
            return true;
        }
    }

Field Documentation

$lng

ilLanguage ilTCPDFRenderer::$lng

protected

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

---

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

• Services/PDFGeneration/classes/renderer/tcpdf/class.ilTCPDFRenderer.php