This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilTestPDFGenerator:

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

static	preprocessHTML ($html)

Data Fields
const	PDF_OUTPUT_DOWNLOAD = 'D'

const	PDF_OUTPUT_INLINE = 'I'

const	PDF_OUTPUT_FILE = 'F'

const	service = "Test"

Static Protected Member Functions
static	getTemplatePath ($a_filename, $module_path='Modules/Test/')

static	getCssContent ()

Static Private Member Functions
static	buildHtmlDocument ($contentHtml, $styleHtml)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 27 of file class.ilTestPDFGenerator.php.

Member Function Documentation

◆ buildHtmlDocument()

static ilTestPDFGenerator::buildHtmlDocument	(	$contentHtml,
		$styleHtml
	)

staticprivate

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

     {
         return "
                         <html>
                                 <head>
                                         <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />
                                         $styleHtml
                                 </head>
                                 <body>$contentHtml</body>
                         </html>
                 ";
     }

◆ generatePDF()

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

static

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

References $filename.

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

     {
         $pdf_output = self::preprocessHTML($pdf_output);
 
         if (substr($filename, strlen($filename) - 4, 4) != '.pdf') {
             $filename .= '.pdf';
         }
         $pdf_factory = new ilHtmlToPdfTransformerFactory();
 
         if (!$pdf_factory->deliverPDFFromHTMLString(
             $pdf_output,
             $filename,
             $output_mode,
             self::service,
             $purpose
         )) {
             throw new \Exception('could not write PDF');
         }
         return true;
     }

Here is the caller graph for this function:

◆ getCssContent()

static ilTestPDFGenerator::getCssContent ( )

staticprotected

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

     {
         $cssContent = file_get_contents(self::getTemplatePath('delos.css', ''));
         $cssContent .= file_get_contents(self::getTemplatePath('test_pdf.css'));
 
         return $cssContent;
     }

◆ getTemplatePath()

static ilTestPDFGenerator::getTemplatePath	(	$a_filename,
		$module_path = `'Modules/Test/'`
	)

staticprotected

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

References ilStyleDefinition\getCurrentSkin().

     {
         // use ilStyleDefinition instead of account to get the current skin
         include_once "Services/Style/System/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;
     }

Here is the call graph for this function:

◆ preprocessHTML()

static ilTestPDFGenerator::preprocessHTML ( $html )

static

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

     {
         $html = self::makeHtmlDocument($html, '<style>' . self::getCssContent() . '</style>');
 
         return $html;
     }

Field Documentation

◆ PDF_OUTPUT_DOWNLOAD

const ilTestPDFGenerator::PDF_OUTPUT_DOWNLOAD = 'D'

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

Referenced by ilParticipantsTestResultsGUI\createUserResults(), ilTestServiceGUI\getQuestionResultForTestUsers(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserPassDetails(), ilTestEvaluationGUI\outUserResultsOverview(), ilTestSubmissionReviewGUI\pdfDownload(), ilTestServiceGUI\populateContent(), ilObjTestGUI\printobject(), and ilObjTestGUI\reviewobject().

◆ PDF_OUTPUT_FILE

const ilTestPDFGenerator::PDF_OUTPUT_FILE = 'F'

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

Referenced by ilTestArchiveService\archiveActivesPass(), ilTestPlayerAbstractGUI\archiveParticipantSubmission(), ilTestExportGUI\createTestArchiveExport(), and ilTestArchiver\updateTestArchive().

◆ PDF_OUTPUT_INLINE

const ilTestPDFGenerator::PDF_OUTPUT_INLINE = 'I'

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

◆ service

const ilTestPDFGenerator::service = "Test"

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

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

Modules/Test/classes/class.ilTestPDFGenerator.php

Static Public Member Functions

Data Fields

Static Protected Member Functions

Static Private Member Functions