ilWkhtmlToPdfRenderer Class Reference

Inheritance diagram for ilWkhtmlToPdfRenderer:

Collaboration diagram for ilWkhtmlToPdfRenderer:

Public Member Functions
	__construct (bool $phpunit=false)
	addConfigElementsToForm (ilPropertyFormGUI $form, string $service, string $purpose)
	populateConfigElementsInForm (ilPropertyFormGUI $form, string $service, string $purpose, $config)
	validateConfigInForm (ilPropertyFormGUI $form, string $service, string $purpose)
	getConfigFromForm (ilPropertyFormGUI $form, string $service, string $purpose)
	getDefaultConfig (string $service, string $purpose)
	generatePDF (string $service, string $purpose, $config, ilPDFGenerationJob $job)
	getHtmlTempName ()
	createPDFFileFromHTMLFile (string $a_path_to_file, $config, ilPDFGenerationJob $job)
	getPdfTempName ()
	prepareGenerationRequest (string $service, string $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...
Public Member Functions inherited from ilRendererConfig
	populateConfigElementsInForm (ilPropertyFormGUI $form, string $service, string $purpose, array $config)
Public Member Functions inherited from ilPDFRenderer
	generatePDF (string $service, string $purpose, array $config, ilPDFGenerationJob $job)

Protected Member Functions
	setLanguage (ilLanguage $lng)
	getTempFileName (string $file_type)
	runCommandLine (string $a_path_to_file, string $a_target, $config)
	redirectLog ()
	appendDefaultFontStyle (string $a_path_to_file, ilWkhtmlToPdfConfig $config)
	fixIconSizeForPatchedQt (string $a_path_to_file)
	Fix for an issue of WkhtmlToPdf with patched QT Without a fixed width the icons would be distorted and corrupt the hole PDF. More...
	checkReturnValueFromCommandLine (array $return_value, string $temp_file, string $a_target)

Protected Attributes
ilWkhtmlToPdfConfig	$config
ilLanguage	$lng
ilLogger	$log

Detailed Description

Deprecated:

Definition at line 24 of file class.ilWkhtmlToPdfRenderer.php.

Constructor & Destructor Documentation

__construct()

ilWkhtmlToPdfRenderer::__construct

(

bool

$phpunit = false

)

Definition at line 30 of file class.ilWkhtmlToPdfRenderer.php.

References $DIC, and setLanguage().

    {
        if (!$phpunit) {
            global $DIC;
            $this->setLanguage($DIC->language());
            $this->log = $DIC->logger()->root();
        }
    }

Here is the call graph for this function:

Member Function Documentation

addConfigElementsToForm()

ilWkhtmlToPdfRenderer::addConfigElementsToForm	(	ilPropertyFormGUI	$form,
		string	$service,
		string	$purpose
	)

Parameters

ilPropertyFormGUI	$form	The config form for the administration
string	$service	Service Title
string	$purpose	Purpose Title

Returns

void

Implements ilRendererConfig.

Definition at line 44 of file class.ilWkhtmlToPdfRenderer.php.

                                                                                                      : void
    {
        $gui = new ilWkhtmlToPdfConfigFormGUI();
        $gui->addConfigForm($form);
    }

appendDefaultFontStyle()

ilWkhtmlToPdfRenderer::appendDefaultFontStyle ( string  $a_path_to_file, ilWkhtmlToPdfConfig  $config  )

protected

Definition at line 122 of file class.ilWkhtmlToPdfRenderer.php.

References ilWkhtmlToPdfConfig\getOverwriteDefaultFont().

Referenced by runCommandLine().

                                                                                                  : void
    {
        $backupStyle = $config->getOverwriteDefaultFont(true);
        $originalFile = file_get_contents($a_path_to_file) . $backupStyle;
        file_put_contents($a_path_to_file, $originalFile);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkReturnValueFromCommandLine()

ilWkhtmlToPdfRenderer::checkReturnValueFromCommandLine ( array  $return_value, string  $temp_file, string  $a_target  )

protected

Definition at line 149 of file class.ilWkhtmlToPdfRenderer.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by runCommandLine().

                                                                                                                : void
    {
        foreach ($return_value as $key => $value) {
            $this->log->debug('ilWebkitHtmlToPdfTransformer return value line ' . $key . ' : ' . $value);
        }
        if (file_exists($temp_file)) {
            $this->log->debug('ilWebkitHtmlToPdfTransformer file exists: ' . $temp_file . ' file size is :' . filesize($temp_file) . ' bytes, will be renamed to ' . $a_target);
            rename($temp_file, $a_target);
        } else {
            $this->log->info('ilWebkitHtmlToPdfTransformer error: ' . print_r($return_value, true));
        }
    }

Here is the caller graph for this function:

createPDFFileFromHTMLFile()

ilWkhtmlToPdfRenderer::createPDFFileFromHTMLFile	(	string	$a_path_to_file,
			$config,
		ilPDFGenerationJob	$job
	)

Definition at line 94 of file class.ilWkhtmlToPdfRenderer.php.

References $config, ilPDFGenerationJob\getFilename(), and runCommandLine().

Referenced by generatePDF().

                                                                                                       : void
    {
        $this->runCommandLine($a_path_to_file, $job->getFilename(), $config);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fixIconSizeForPatchedQt()

ilWkhtmlToPdfRenderer::fixIconSizeForPatchedQt ( string  $a_path_to_file )

protected

Fix for an issue of WkhtmlToPdf with patched QT Without a fixed width the icons would be distorted and corrupt the hole PDF.

See also

https://mantis.ilias.de/view.php?id=36506

Definition at line 134 of file class.ilWkhtmlToPdfRenderer.php.

Referenced by runCommandLine().

                                                                      : void
    {
        $style = '<style>div.questionPrintview img.small {height: 20px; width: 20px;}</style>';
        $originalFile = file_get_contents($a_path_to_file) . $style;
        file_put_contents($a_path_to_file, $originalFile);
    }

Here is the caller graph for this function:

generatePDF()

ilWkhtmlToPdfRenderer::generatePDF	(	string	$service,
		string	$purpose,
			$config,
		ilPDFGenerationJob	$job
	)

Definition at line 75 of file class.ilWkhtmlToPdfRenderer.php.

References createPDFFileFromHTMLFile(), getHtmlTempName(), and ilPDFGenerationJob\getPages().

                                                                                                   : void
    {
        $html_file = $this->getHtmlTempName();
        $pages = $job->getPages();

        file_put_contents($html_file, implode('', $pages));
        $this->createPDFFileFromHTMLFile($html_file, $config, $job);
    }

Here is the call graph for this function:

getConfigFromForm()

ilWkhtmlToPdfRenderer::getConfigFromForm	(	ilPropertyFormGUI	$form,
		string	$service,
		string	$purpose
	)

Parameters

ilPropertyFormGUI	$form	The config form for the administration
string	$service	Service Title
string	$purpose	Purpose Title

Returns

array<string, mixed> KV-array with config

Implements ilRendererConfig.

Definition at line 63 of file class.ilWkhtmlToPdfRenderer.php.

                                                                                                : array
    {
        $gui = new ilWkhtmlToPdfConfigFormGUI();
        return $gui->getConfigFromForm($form);
    }

getDefaultConfig()

ilWkhtmlToPdfRenderer::getDefaultConfig	(	string	$service,
		string	$purpose
	)

Parameters

string	$service	Service Title
string	$purpose	Purpose Title

Returns

mixed KV-array with config or an config instance

Implements ilRendererConfig.

Definition at line 69 of file class.ilWkhtmlToPdfRenderer.php.

References $config.

                                                                      : ilWkhtmlToPdfConfig
    {
        $config = new ilWkhtmlToPdfConfig();
        return $config;
    }

getHtmlTempName()

ilWkhtmlToPdfRenderer::getHtmlTempName

(

)

Definition at line 84 of file class.ilWkhtmlToPdfRenderer.php.

References getTempFileName().

Referenced by generatePDF().

                                     : string
    {
        return $this->getTempFileName('html');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPdfTempName()

ilWkhtmlToPdfRenderer::getPdfTempName

(

)

Definition at line 112 of file class.ilWkhtmlToPdfRenderer.php.

References getTempFileName().

Referenced by runCommandLine().

                                    : string
    {
        return $this->getTempFileName('pdf');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTempFileName()

ilWkhtmlToPdfRenderer::getTempFileName ( string  $file_type )

protected

Definition at line 89 of file class.ilWkhtmlToPdfRenderer.php.

References ilFileUtils\ilTempnam().

Referenced by getHtmlTempName(), and getPdfTempName().

                                                         : string
    {
        return ilFileUtils::ilTempnam() . '.' . $file_type;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

populateConfigElementsInForm()

ilWkhtmlToPdfRenderer::populateConfigElementsInForm	(	ilPropertyFormGUI	$form,
		string	$service,
		string	$purpose,
			$config
	)

Definition at line 50 of file class.ilWkhtmlToPdfRenderer.php.

                                                                                                                    : void
    {
        $this->config = new ilWkhtmlToPdfConfig($config);
        $gui = new ilWkhtmlToPdfConfigFormGUI();
        $gui->populateForm($form, $this->config);
    }

prepareGenerationRequest()

ilWkhtmlToPdfRenderer::prepareGenerationRequest	(	string	$service,
		string	$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 142 of file class.ilWkhtmlToPdfRenderer.php.

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

                                                                              : void
    {
        ilMathJax::getInstance()
                 ->init(ilMathJax::PURPOSE_PDF)
                 ->setRendering(ilMathJax::RENDER_SVG_AS_XML_EMBED);
    }

Here is the call graph for this function:

redirectLog()

ilWkhtmlToPdfRenderer::redirectLog ( )

protected

Definition at line 117 of file class.ilWkhtmlToPdfRenderer.php.

Referenced by runCommandLine().

                                    : string
    {
        return ' 2>&1 ';
    }

Here is the caller graph for this function:

runCommandLine()

ilWkhtmlToPdfRenderer::runCommandLine ( string  $a_path_to_file, string  $a_target,   $config  )

protected

Definition at line 99 of file class.ilWkhtmlToPdfRenderer.php.

References appendDefaultFontStyle(), checkReturnValueFromCommandLine(), ilShellUtil\execQuoted(), fixIconSizeForPatchedQt(), getPdfTempName(), and redirectLog().

Referenced by createPDFFileFromHTMLFile().

                                                                                        : void
    {
        $wkConfig = new ilWkhtmlToPdfConfig($config);
        $temp_file = $this->getPdfTempName();
        $args = $wkConfig->getCommandLineConfig() . ' ' . $a_path_to_file . ' ' . $temp_file . $this->redirectLog();
        $this->appendDefaultFontStyle($a_path_to_file, $wkConfig);
        $this->fixIconSizeForPatchedQt($a_path_to_file);
        $return_value = ilShellUtil::execQuoted($wkConfig->getWKHTMLToPdfDefaultPath(), $args);
        $this->log->debug('ilWebkitHtmlToPdfTransformer command line config: ' . $args);
        $this->checkReturnValueFromCommandLine($return_value, $temp_file, $a_target);
        unlink($a_path_to_file);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setLanguage()

ilWkhtmlToPdfRenderer::setLanguage ( ilLanguage  $lng )

protected

Definition at line 39 of file class.ilWkhtmlToPdfRenderer.php.

References $lng, and ILIAS\Repository\lng().

Referenced by __construct().

                                                   : void
    {
        $this->lng = $lng;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateConfigInForm()

ilWkhtmlToPdfRenderer::validateConfigInForm	(	ilPropertyFormGUI	$form,
		string	$service,
		string	$purpose
	)

Parameters

ilPropertyFormGUI	$form	The config form for the administration
string	$service	Service Title
string	$purpose	Purpose Title

Returns

bool True, if the form holds a valid config

Implements ilRendererConfig.

Definition at line 57 of file class.ilWkhtmlToPdfRenderer.php.

                                                                                                   : bool
    {
        $gui = new ilWkhtmlToPdfConfigFormGUI();
        return $gui->validateForm($form);
    }

Field Documentation

$config

ilWkhtmlToPdfConfig ilWkhtmlToPdfRenderer::$config

protected

Definition at line 26 of file class.ilWkhtmlToPdfRenderer.php.

Referenced by createPDFFileFromHTMLFile(), and getDefaultConfig().

$lng

ilLanguage ilWkhtmlToPdfRenderer::$lng

protected

Definition at line 27 of file class.ilWkhtmlToPdfRenderer.php.

Referenced by setLanguage().

$log

ilLogger ilWkhtmlToPdfRenderer::$log

protected

Definition at line 28 of file class.ilWkhtmlToPdfRenderer.php.

---

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

• Services/PDFGeneration/classes/renderer/wkhtmltopdf/class.ilWkhtmlToPdfRenderer.php