ilWkhtmlToPdfRenderer Class Reference

Inheritance diagram for ilWkhtmlToPdfRenderer:

Collaboration diagram for ilWkhtmlToPdfRenderer:

Public Member Functions
	__construct ($phpunit=false)
	ilWkhtmlToPdfRenderer constructor. 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)
	getHtmlTempName ()
	createPDFFileFromHTMLFile ($a_path_to_file, $config, $job)
	getPdfTempName ()
	prepareGenerationRequest ($service, $purpose)
Public Member Functions inherited from ilRendererConfig
	addConfigElementsToForm (\ilPropertyFormGUI $form, $service, $purpose)
	populateConfigElementsInForm (\ilPropertyFormGUI $form, $service, $purpose, $config)
	validateConfigInForm (\ilPropertyFormGUI $form, $service, $purpose)
	getConfigFromForm (\ilPropertyFormGUI $form, $service, $purpose)

Protected Member Functions
	setLanguage ($lng)
	getTempFileName ($file_type)
	runCommandLine ($a_path_to_file, $a_target, $config)
	redirectLog ()
	appendDefaultFontStyle ($a_path_to_file, $config)

Protected Attributes
	$config
	$lng

Static Protected Attributes
static	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilWkhtmlToPdfRenderer::__construct

(

$phpunit = false

)

ilWkhtmlToPdfRenderer constructor.

Parameters

bool

$phpunit

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

References $DIC, and setLanguage().

    {
        if (!$phpunit) {
            global $DIC;
            $this->setLanguage($DIC['lng']);
        }
    }

Here is the call graph for this function:

Member Function Documentation

addConfigElementsToForm()

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

Parameters

ilPropertyFormGUI	$form
string	$service
string	$purpose

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

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

appendDefaultFontStyle()

ilWkhtmlToPdfRenderer::appendDefaultFontStyle (   $a_path_to_file,   $config  )

protected

Parameters

	$a_path_to_file
ilWkhtmlToPdfConfig	$config

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

References $config.

Referenced by runCommandLine().

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

Here is the caller graph for this function:

createPDFFileFromHTMLFile()

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

Parameters

	$a_path_to_file
	$config
ilPDFGenerationJob	$job

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

References $config, and runCommandLine().

Referenced by generatePDF().

    {
        if (is_array($a_path_to_file)) {
            $files_list_as_string = ' ';
            foreach ($a_path_to_file as $file) {
                if (file_exists($file)) {
                    $files_list_as_string .= ' ' . $files_list_as_string;
                }
            }
            $this->runCommandLine($files_list_as_string, $job->getFilename(), $config);
        } else {
            if (file_exists($a_path_to_file)) {
                $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:

generatePDF()

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

Parameters

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

Implements ilPDFRenderer.

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

References $config, createPDFFileFromHTMLFile(), and getHtmlTempName().

    {
        $html_file = $this->getHtmlTempName();
        file_put_contents($html_file, implode('', $job->getPages()));
        $this->createPDFFileFromHTMLFile($html_file, $config, $job);
    }

Here is the call graph for this function:

getConfigFromForm()

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

Parameters

ilPropertyFormGUI	$form
string	$service
string	$purpose

Returns

array

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

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

getDefaultConfig()

ilWkhtmlToPdfRenderer::getDefaultConfig	(		$service,
			$purpose
	)

Parameters

string	$service
string	$purpose

Returns

ilWkhtmlToPdfConfig

Implements ilRendererConfig.

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

References $config.

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

getHtmlTempName()

ilWkhtmlToPdfRenderer::getHtmlTempName

(

)

Returns

string

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

References getTempFileName().

Referenced by generatePDF().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPdfTempName()

ilWkhtmlToPdfRenderer::getPdfTempName

(

)

Returns

string

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

References getTempFileName().

Referenced by runCommandLine().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getTempFileName()

ilWkhtmlToPdfRenderer::getTempFileName (   $file_type )

protected

Parameters

$file_type

Returns

string

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

References ilUtil\ilTempnam().

Referenced by getHtmlTempName(), and getPdfTempName().

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

Here is the call graph for this function:

Here is the caller graph for this function:

populateConfigElementsInForm()

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

Parameters

ilPropertyFormGUI	$form
string	$service
string	$purpose
ilWkhtmlToPdfConfig	$config

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

References $config.

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

prepareGenerationRequest()

ilWkhtmlToPdfRenderer::prepareGenerationRequest	(		$service,
			$purpose
	)

Parameters

string	$service
string	$purpose

Implements ilPDFRenderer.

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

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

    {
        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

Returns

string

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

Referenced by runCommandLine().

    {
        return $redirect_log = ' 2>&1 ';
    }

Here is the caller graph for this function:

runCommandLine()

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

protected

Parameters

$a_path_to_file
$a_target
$config

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

References $config, $DIC, $log, appendDefaultFontStyle(), ilUtil\execQuoted(), getPdfTempName(), and redirectLog().

Referenced by createPDFFileFromHTMLFile().

    {
        global $DIC;
        $log = $DIC['ilLog'];
        $config = new ilWkhtmlToPdfConfig($config);
        $temp_file = $this->getPdfTempName();
        $args = $config->getCommandLineConfig() . ' ' . $a_path_to_file . ' ' . $temp_file . $this->redirectLog();
        $this->appendDefaultFontStyle($a_path_to_file, $config);
        $return_value = ilUtil::execQuoted($config->getWKHTMLToPdfDefaultPath(), $args);
        $log->debug('ilWebkitHtmlToPdfTransformer command line config: ' . $args);
        foreach ($return_value as $key => $value) {
            $log->debug('ilWebkitHtmlToPdfTransformer return value line ' . $key . ' : ' . $value);
        }
        if (file_exists($temp_file)) {
            $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 {
            $log->info('ilWebkitHtmlToPdfTransformer error: ' . print_r($return_value, true));
        }
        unlink($a_path_to_file);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setLanguage()

ilWkhtmlToPdfRenderer::setLanguage (   $lng )

protected

Parameters

$lng

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

References $lng.

Referenced by __construct().

    {
        $this->lng = $lng;
    }

Here is the caller graph for this function:

validateConfigInForm()

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

Parameters

ilPropertyFormGUI	$form
string	$service
string	$purpose

Returns

bool

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

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

Field Documentation

$config

ilWkhtmlToPdfRenderer::$config

protected

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

Referenced by appendDefaultFontStyle(), createPDFFileFromHTMLFile(), generatePDF(), getDefaultConfig(), populateConfigElementsInForm(), and runCommandLine().

$instance

ilWkhtmlToPdfRenderer::$instance = null

staticprotected

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

$lng

ilWkhtmlToPdfRenderer::$lng

protected

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

Referenced by setLanguage().

---

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

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