ilPDFGeneratorUtils Class Reference

Class ilPDFGeneratorUtils. More...

Collaboration diagram for ilPDFGeneratorUtils:

Static Public Member Functions
static	prepareGenerationRequest ($service, $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 ($path)
static	removeWrongPathFromStyleFiles ($path)
static	setCheckedIfTrue (\ilPropertyFormGUI $form)
static	getPurposeMap ()
static	getSelectionMap ()
static	getRenderers ()
static	updateRendererSelection ($service, $purpose, $renderer)
static	removeRendererConfig ($service, $purpose, $renderer)

Static Protected Member Functions
static	isRendererPlugin ($path)

Detailed Description

Class ilPDFGeneratorUtils.

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

Member Function Documentation

getPurposeMap()

static ilPDFGeneratorUtils::getPurposeMap ( )

static

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

References $DIC, $ilDB, and $result.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $purposes = array();

        $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:

getRenderers()

static ilPDFGeneratorUtils::getRenderers ( )

static

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

References $DIC, $ilDB, and $result.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $renderers = array();
        $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

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

References $DIC, $ilDB, and $result.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $mappings = array();
        $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 27 of file class.ilPDFGeneratorUtils.php.

References CLIENT_ID.

    {
        $iliasPDFTestPath = 'data/' . CLIENT_ID . '/pdf_service/';
        if (!file_exists($iliasPDFTestPath)) {
            mkdir($iliasPDFTestPath);
        }
        return $iliasPDFTestPath;
    }

isRendererPlugin()

static ilPDFGeneratorUtils::isRendererPlugin (   $path )

staticprotected

Parameters

$path

Returns

bool

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

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

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

prepareGenerationRequest()

static ilPDFGeneratorUtils::prepareGenerationRequest (   $service,   $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.

Parameters

string	$service
string	$purpose

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

References Vendor\Package\$e, and $service.

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

    {
        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 (   $path )

static

Parameters

string

$path

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

References $filename.

    {
        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 (   $service,   $purpose,   $renderer  )

static

Parameters

string	$service
string	$purpose
string	$renderer

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

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

Referenced by ilObjPDFGenerationGUI\resetSettings().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $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 (   $path )

static

Parameters

string

$path

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

References $filename.

    {
        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);
        }
    }

setCheckedIfTrue()

static ilPDFGeneratorUtils::setCheckedIfTrue ( \ilPropertyFormGUI  $form )

static

Parameters

ilPropertyFormGUI

$form

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

References ilPropertyFormGUI\getItems().

Referenced by ilWkhtmlToPdfConfigFormGUI\populateForm().

    {
        foreach ($form->getItems() as $item) {
            if ($item instanceof ilCheckboxInputGUI) {
                if ($item->getChecked() != null && ($item->getValue() == true || $item->getValue() == '1')) {
                    $item->setChecked(true);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateRendererSelection()

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

static

Parameters

string	$service
string	$purpose
string	$renderer

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

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

Referenced by ilObjPDFGenerationGUI\saveSettings().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $ilDB->update(
            'pdfgen_map',
            array( 'selected' => array('text', $renderer) ),
            array(
                             'service' => array('text', $service),
                             'purpose' => array('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