Collaboration diagram for ilPDFGeneratorUtils:

Static Public Member Functions
static	prepareGenerationRequest (string $service, string $purpose)
	Prepare the content processing for a PDF generation request This function should be called as in a request before any content is generated It sets the generation mode for Latex processing according the needs of the PDF renderer. More...

static	getTestPdfDir ()

static	removePrintMediaDefinitionsFromStyleFile (string $path)

static	removeWrongPathFromStyleFiles (string $path)

static	getPurposeMap ()

static	getSelectionMap ()

static	getRenderers ()

static	updateRendererSelection (string $service, string $purpose, string $renderer)

static	getRendererConfig (string $service, string $purpose, string $renderer)

static	getRendererDefaultConfig (string $service, string $purpose, string $renderer)

static	removeRendererConfig (string $service, string $purpose, string $renderer)

static	getRendererInstance (string $renderer)

static	saveRendererPurposeConfig (string $service, string $purpose, string $renderer, array $config)

static	getRendererMapForPurpose (string $service, string $purpose)

Static Protected Member Functions
static	isRendererPlugin (string $path)

Detailed Description

Deprecated:

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

Member Function Documentation

◆ getPurposeMap()

static ilPDFGeneratorUtils::getPurposeMap ( )

static

Returns: array<string, string[]>

Definition at line 73 of file class.ilPDFGeneratorUtils.php.

References $DIC, and $ilDB.

Referenced by ilObjPDFGenerationGUI\configForm(), and ilObjPDFGenerationGUI\saveSettings().

                                           : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $purposes = [];
 
         $result = $ilDB->query('SELECT service, purpose FROM pdfgen_purposes ORDER BY service, purpose');
 
         while ($row = $ilDB->fetchAssoc($result)) {
             $purposes[$row['service']][] = $row['purpose'];
         }
 
         return $purposes;
     }

Here is the caller graph for this function:

◆ getRendererConfig()

static ilPDFGeneratorUtils::getRendererConfig	(	string	$service,
		string	$purpose,
		string	$renderer
	)

static

Definition at line 141 of file class.ilPDFGeneratorUtils.php.

References $DIC, $ilDB, and $query.

Referenced by ilObjPDFGenerationGUI\buildConfigForm(), and ilHtmlToPdfTransformerFactory\deliverPDFFromHTMLString().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $query = 'SELECT config FROM pdfgen_conf WHERE renderer = ' . $ilDB->quote($renderer, 'text') .
             ' AND service = ' . $ilDB->quote($service, 'text') . ' AND purpose = ' . $ilDB->quote($purpose, 'text');
 
         $result = $ilDB->query($query);
         if ($ilDB->numRows($result) === 0) {
             return self::getRendererDefaultConfig($service, $purpose, $renderer);
         }
 
         $row = $ilDB->fetchAssoc($result);
         return json_decode($row['config'], true, 512, JSON_THROW_ON_ERROR);
     }

Here is the caller graph for this function:

◆ getRendererDefaultConfig()

static ilPDFGeneratorUtils::getRendererDefaultConfig	(	string	$service,
		string	$purpose,
		string	$renderer
	)

static

Exceptions

Exception

Definition at line 161 of file class.ilPDFGeneratorUtils.php.

     {
         $class_instance = self::getRendererInstance($renderer);
 
         return $class_instance->getDefaultConfig($service, $purpose);
     }

◆ getRendererInstance()

static ilPDFGeneratorUtils::getRendererInstance ( string $renderer )

static

Exceptions

Exception

Returns: ilRendererConfig&ilPDFRenderer

Definition at line 183 of file class.ilPDFGeneratorUtils.php.

References $DIC, and $ilDB.

Referenced by ilObjPDFGenerationGUI\buildConfigForm(), ilHtmlToPdfTransformerFactory\deliverPDFFromHTMLString(), and ilObjPDFGenerationGUI\saveConfig().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $result = $ilDB->query('SELECT path FROM pdfgen_renderer WHERE renderer = ' . $ilDB->quote($renderer, 'text'));
 
         if ($ilDB->numRows($result) === 0) {
             throw new Exception('No such renderer - given: ' . $renderer);
         }
         $row = $ilDB->fetchAssoc($result);
 
         $classname = 'il' . $renderer . 'Renderer';
         if (self::isRendererPlugin($row['path'])) {
             $classname = 'il' . $renderer . 'RendererPlugin';
         }
 
         return new $classname();
     }

Here is the caller graph for this function:

◆ getRendererMapForPurpose()

static ilPDFGeneratorUtils::getRendererMapForPurpose	(	string	$service,
		string	$purpose
	)

static

Parameters

string	$service
string	$purpose

Returns: array{selected: string, preferred: string}

Definition at line 238 of file class.ilPDFGeneratorUtils.php.

References $DIC, and $ilDB.

Referenced by ilHtmlToPdfTransformerFactory\deliverPDFFromHTMLString().

                                                                                      : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $result = $ilDB->query(
             'SELECT preferred, selected FROM pdfgen_map WHERE service = ' . $ilDB->quote($service, 'text') . ' ' .
             'AND purpose=' . $ilDB->quote($purpose, 'text')
         );
 
         if ($ilDB->numRows($result) === 0) {
             return ['selected' => 'TCPDF', 'preferred' => 'TCPDF'];
         }
 
         return $ilDB->fetchAssoc($result);
     }

Here is the caller graph for this function:

◆ getRenderers()

static ilPDFGeneratorUtils::getRenderers ( )

static

Returns: array<string, array<string, string[]>>

Definition at line 111 of file class.ilPDFGeneratorUtils.php.

References $DIC, and $ilDB.

Referenced by ilObjPDFGenerationGUI\buildConfigForm(), ilObjPDFGenerationGUI\configForm(), and ilObjPDFGenerationGUI\saveSettings().

                                          : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $renderers = [];
         $result = $ilDB->query('SELECT renderer, service, purpose FROM pdfgen_renderer_avail');
 
         while ($row = $ilDB->fetchAssoc($result)) {
             $renderers[$row['service']][$row['purpose']][] = $row['renderer'];
         }
 
         return $renderers;
     }

Here is the caller graph for this function:

◆ getSelectionMap()

static ilPDFGeneratorUtils::getSelectionMap ( )

static

Returns: array<string, array<string, array{selected: string, preferred: string}>>

Definition at line 92 of file class.ilPDFGeneratorUtils.php.

References $DIC, and $ilDB.

Referenced by ilObjPDFGenerationGUI\configForm(), and ilObjPDFGenerationGUI\saveSettings().

                                             : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $mappings = [];
         $result = $ilDB->query('SELECT service, purpose, preferred, selected FROM pdfgen_map');
 
         while ($row = $ilDB->fetchAssoc($result)) {
             $mappings[$row['service']][$row['purpose']]['selected'] = $row['selected'];
             $mappings[$row['service']][$row['purpose']]['preferred'] = $row['preferred'];
         }
 
         return $mappings;
     }

Here is the caller graph for this function:

◆ getTestPdfDir()

static ilPDFGeneratorUtils::getTestPdfDir ( )

static

Definition at line 42 of file class.ilPDFGeneratorUtils.php.

References CLIENT_ID.

                                           : string
     {
         $iliasPDFTestPath = 'data/' . CLIENT_ID . '/pdf_service/';
         if (!is_dir($iliasPDFTestPath) && !mkdir($iliasPDFTestPath) && !is_dir($iliasPDFTestPath)) {
             throw new RuntimeException(sprintf('Directory "%s" was not created', $iliasPDFTestPath));
         }
 
         return $iliasPDFTestPath;
     }

◆ isRendererPlugin()

static ilPDFGeneratorUtils::isRendererPlugin ( string $path )

staticprotected

Definition at line 204 of file class.ilPDFGeneratorUtils.php.

                                                             : bool
     {
         $needle = 'Plugin.php';
         $length = strlen($needle);
         return (substr($path, -$length) === $needle);
     }

◆ prepareGenerationRequest()

static ilPDFGeneratorUtils::prepareGenerationRequest	(	string	$service,
		string	$purpose
	)

static

Prepare the content processing for a PDF generation request This function should be called as in a request before any content is generated It sets the generation mode for Latex processing according the needs of the PDF renderer.

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

References Vendor\Package\$e.

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

                                                                                      : void
     {
         try {
             $map = self::getRendererMapForPurpose($service, $purpose);
             $renderer = self::getRendererInstance($map['selected']);
             $renderer->prepareGenerationRequest($service, $purpose);
         } catch (Exception $e) {
             return;
         }
     }

Here is the caller graph for this function:

◆ removePrintMediaDefinitionsFromStyleFile()

static ilPDFGeneratorUtils::removePrintMediaDefinitionsFromStyleFile ( string $path )

static

Definition at line 52 of file class.ilPDFGeneratorUtils.php.

References $filename.

                                                                                  : void
     {
         foreach (glob($path . '*.css') as $filename) {
             $content = file_get_contents($filename);
             $content = preg_replace('/@media[\s]* print/', '@media nothing', $content);
             file_put_contents($filename, $content);
         }
     }

◆ removeRendererConfig()

static ilPDFGeneratorUtils::removeRendererConfig	(	string	$service,
		string	$purpose,
		string	$renderer
	)

static

Definition at line 168 of file class.ilPDFGeneratorUtils.php.

References $DIC, $ilDB, and $query.

Referenced by ilObjPDFGenerationGUI\resetSettings().

                                                                                                    : void
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $query = 'DELETE FROM pdfgen_conf WHERE renderer = ' . $ilDB->quote($renderer, 'text') .
             ' AND service = ' . $ilDB->quote($service, 'text') . ' AND purpose = ' . $ilDB->quote($purpose, 'text');
 
         $ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ removeWrongPathFromStyleFiles()

static ilPDFGeneratorUtils::removeWrongPathFromStyleFiles ( string $path )

static

Definition at line 61 of file class.ilPDFGeneratorUtils.php.

References $filename.

                                                                       : void
     {
         foreach (glob($path . '*.css') as $filename) {
             $content = file_get_contents($filename);
             $content = preg_replace('/src:\surl\([\',\"](..\/)*(\S)/', "src: url(./$2", $content);
             file_put_contents($filename, $content);
         }
     }

◆ saveRendererPurposeConfig()

static ilPDFGeneratorUtils::saveRendererPurposeConfig	(	string	$service,
		string	$purpose,
		string	$renderer,
		array	$config
	)

static

Definition at line 211 of file class.ilPDFGeneratorUtils.php.

References $DIC, $ilDB, $query, and $service.

Referenced by ilObjPDFGenerationGUI\saveConfig().

                                                                                                                        : void
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $query = 'DELETE FROM pdfgen_conf WHERE renderer = ' . $ilDB->quote($renderer, 'text') .
             ' AND service = ' . $ilDB->quote($service, 'text') . ' AND purpose = ' . $ilDB->quote($purpose, 'text');
 
         $ilDB->manipulate($query);
 
         $ilDB->insert(
             'pdfgen_conf',
             [
                 'conf_id' => ['integer', $ilDB->nextId('pdfgen_conf')],
                 'renderer' => ['text', $renderer],
                 'service' => ['text', $service],
                 'purpose' => ['text', $purpose],
                 'config' => ['clob', json_encode($config, JSON_THROW_ON_ERROR)]
             ]
         );
     }

Here is the caller graph for this function:

◆ updateRendererSelection()

static ilPDFGeneratorUtils::updateRendererSelection	(	string	$service,
		string	$purpose,
		string	$renderer
	)

static

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

References $DIC, and $ilDB.

Referenced by ilObjPDFGenerationGUI\saveSettings().

                                                                                                       : void
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $ilDB->update(
             'pdfgen_map',
             ['selected' => ['text', $renderer]],
             [
                 'service' => ['text', $service],
                 'purpose' => ['text', $purpose]
             ]
         );
     }

Here is the caller graph for this function:

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

Services/PDFGeneration/classes/class.ilPDFGeneratorUtils.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ getPurposeMap()

◆ getRendererConfig()

◆ getRendererDefaultConfig()

◆ getRendererInstance()

◆ getRendererMapForPurpose()

◆ getRenderers()

◆ getSelectionMap()

◆ getTestPdfDir()

◆ isRendererPlugin()

◆ prepareGenerationRequest()

◆ removePrintMediaDefinitionsFromStyleFile()

◆ removeRendererConfig()

◆ removeWrongPathFromStyleFiles()

◆ saveRendererPurposeConfig()

◆ updateRendererSelection()