Collaboration diagram for ilTestPDFGenerator:

Static Public Member Functions
static	generatePDF ($pdf_output, $output_mode, $filename=null)

static	preprocessHTML ($html)

Data Fields
const	PDF_OUTPUT_DOWNLOAD = 'D'

const	PDF_OUTPUT_INLINE = 'I'

const	PDF_OUTPUT_FILE = 'F'

Static Protected Member Functions
static	getTemplatePath ($a_filename)

Static Private Member Functions
static	removeScriptElements ($html)

Detailed Description

Class ilTestPDFGenerator.

Class that handles PDF generation for test and assessment.

Author: Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

Definition at line 13 of file class.ilTestPDFGenerator.php.

Member Function Documentation

◆ generatePDF()

static ilTestPDFGenerator::generatePDF	(	$pdf_output,
		$output_mode,
		$filename = `null`
	)

static

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

        {
                $pdf_output = self::preprocessHTML($pdf_output);
                
                if (substr($filename, strlen($filename) - 4, 4) != '.pdf')
                {
                        $filename .= '.pdf';
                }
                
                require_once './Services/PDFGeneration/classes/class.ilPDFGeneration.php';
                
                $job = new ilPDFGenerationJob();
                $job->setAutoPageBreak(true)
                        ->setCreator('ILIAS Test')
                        ->setFilename($filename)
                        ->setMarginLeft('20')
                        ->setMarginRight('20')
                        ->setMarginTop('20')
                        ->setMarginBottom('20')
                        ->setOutputMode($output_mode)
                        ->addPage($pdf_output);
                
                ilPDFGeneration::doJob($job);
        }

References $filename, ilPDFGeneration\doJob(), and preprocessHTML().

Referenced by ilTestArchiveService\archiveActivesPass(), ilTestPlayerAbstractGUI\archiveParticipantSubmission(), ilObjTestGUI\createUserResults(), ilTestServiceGUI\getQuestionResultForTestUsers(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserPassDetails(), ilTestEvaluationGUI\outUserResultsOverview(), ilTestSubmissionReviewGUI\pdfDownload(), ilObjTestGUI\printobject(), ilTestScoring\recalculatePasses(), and ilTestArchiver\updateTestArchive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplatePath()

static ilTestPDFGenerator::getTemplatePath ( $a_filename )

staticprotected

Definition at line 91 of file class.ilTestPDFGenerator.php.

        {
                        $module_path = "Modules/Test/";
 
                        // use ilStyleDefinition instead of account to get the current skin
                        include_once "Services/Style/classes/class.ilStyleDefinition.php";
                        if (ilStyleDefinition::getCurrentSkin() != "default")
                        {
                                $fname = "./Customizing/global/skin/".
                                        ilStyleDefinition::getCurrentSkin()."/".$module_path.basename($a_filename);
                        }
 
                        if($fname == "" || !file_exists($fname))
                        {
                                $fname = "./".$module_path."templates/default/".basename($a_filename);
                        }
                return $fname;
        }

Referenced by preprocessHTML().

Here is the caller graph for this function:

◆ preprocessHTML()

static ilTestPDFGenerator::preprocessHTML ( $html )

static

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

        {
                $html = self::removeScriptElements($html);
                $pdf_css_path = self::getTemplatePath('test_pdf.css');
                return '<style>' . file_get_contents($pdf_css_path)     . '</style>' . $html;
        }

References getTemplatePath(), and removeScriptElements().

Referenced by generatePDF().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeScriptElements()

static ilTestPDFGenerator::removeScriptElements ( $html )

staticprivate

Parameters

$html

Returns: string

Definition at line 23 of file class.ilTestPDFGenerator.php.

        {
                if(!is_string($html) || !strlen(trim($html)))
                {
                        return $html;
                }
 
                $dom = new DOMDocument("1.0", "utf-8");
                if(!@$dom->loadHTML('<?xml encoding="UTF-8">' . $html))
                {
                        return $html;
                }
 
                $invalid_elements = array();
 
                $script_elements     = $dom->getElementsByTagName('script');
                foreach($script_elements as $elm)
                {
                        $invalid_elements[] = $elm;
                }
 
                foreach($invalid_elements as $elm)
                {
                        $elm->parentNode->removeChild($elm);
                }
 
                $dom->encoding = 'UTF-8';
                $cleaned_html = $dom->saveHTML();
                if(!$cleaned_html)
                {
                        return $html;
                }
 
                return $cleaned_html;
        }