Collaboration diagram for ilWkhtmlToPdfConfigFormGUI:

Public Member Functions
	__construct ()
	ilWkhtmlToPdfConfigFormGUI constructor. More...

	addConfigForm ($form)

	validateForm ()

	getConfigFromForm (ilPropertyFormGUI $form)

	populateForm ($form, $config)

Protected Member Functions
	setLanguage ($lng)

	translate ($txt)

	appendOutputOptionsForm (ilPropertyFormGUI $form)

	buildExternalLinksForm ()

	buildEnableFormsForm ()

	buildLowQualityForm ()

	buildGreyScaleForm ()

	buildPrintMediaTypeForm ()

	buildJavascriptDelayForm ()

	buildOverwriteDefaultFont ()

	appendPageSettingsForm (ilPropertyFormGUI $form)

	buildZoomForm ()

	buildOrientationsForm ()

	buildPageSizesForm ()

	buildMarginLeftForm ()

	buildMarginRightForm ()

	buildMarginTopForm ()

	buildMarginBottomForm ()

	buildHeaderForm ()

	buildHeaderTextForm ()

	buildHeaderHtmlForm ()

	buildFooterForm ()

	buildFooterTextForm ()

	buildFooterHtmlForm ()

	buildCheckboxSvgForm ()

	buildCheckedCheckboxSvgForm ()

	buildRadiobuttonSvgForm ()

	buildCheckedRadiobuttonSvgForm ()

	saveNewDefaultBinaryPath ($path)

Protected Attributes
	$lng

Private Member Functions
	isNotValidSize (array $sizes)

	isNotValidText (array $texts)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilWkhtmlToPdfConfigFormGUI::__construct ( )

ilWkhtmlToPdfConfigFormGUI constructor.

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

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

References $DIC, and setLanguage().

Here is the call graph for this function:

Member Function Documentation

◆ addConfigForm()

ilWkhtmlToPdfConfigFormGUI::addConfigForm ( $form )

Parameters

ilPropertyFormGUI $form

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

    {
        $path = new ilTextInputGUI($this->translate('path'), 'path');
        $form->addItem($path);
 
        $this->appendOutputOptionsForm($form);
        $this->appendPageSettingsForm($form);
    }

References appendOutputOptionsForm(), appendPageSettingsForm(), and translate().

Here is the call graph for this function:

◆ appendOutputOptionsForm()

ilWkhtmlToPdfConfigFormGUI::appendOutputOptionsForm ( ilPropertyFormGUI $form )

protected

Parameters

ilPropertyFormGUI $form

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

    {
        $section_header = new ilFormSectionHeaderGUI();
        $section_header->setTitle($this->translate('output_options'));
        $form->addItem($section_header);
 
        $form->addItem($this->buildExternalLinksForm());
        $form->addItem($this->buildEnableFormsForm());
        $form->addItem($this->buildLowQualityForm());
        $form->addItem($this->buildGreyScaleForm());
        $form->addItem($this->buildPrintMediaTypeForm());
        $form->addItem($this->buildJavascriptDelayForm());
        $form->addItem($this->buildCheckboxSvgForm());
        $form->addItem($this->buildCheckedCheckboxSvgForm());
        $form->addItem($this->buildRadiobuttonSvgForm());
        $form->addItem($this->buildCheckedRadiobuttonSvgForm());
        $form->addItem($this->buildOverwriteDefaultFont());
    }

References ilPropertyFormGUI\addItem(), buildCheckboxSvgForm(), buildCheckedCheckboxSvgForm(), buildCheckedRadiobuttonSvgForm(), buildEnableFormsForm(), buildExternalLinksForm(), buildGreyScaleForm(), buildJavascriptDelayForm(), buildLowQualityForm(), buildOverwriteDefaultFont(), buildPrintMediaTypeForm(), buildRadiobuttonSvgForm(), and translate().

Referenced by addConfigForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendPageSettingsForm()

ilWkhtmlToPdfConfigFormGUI::appendPageSettingsForm ( ilPropertyFormGUI $form )

protected

Parameters

ilPropertyFormGUI $form

Definition at line 144 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $section_header = new ilFormSectionHeaderGUI();
        $section_header->setTitle($this->translate('page_settings'));
        $form->addItem($section_header);
 
        $form->addItem($this->buildZoomForm());
        $form->addItem($this->buildOrientationsForm());
        $form->addItem($this->buildPageSizesForm());
        $form->addItem($this->buildMarginLeftForm());
        $form->addItem($this->buildMarginRightForm());
        $form->addItem($this->buildMarginTopForm());
        $form->addItem($this->buildMarginBottomForm());
        $form->addItem($this->buildHeaderForm());
        $form->addItem($this->buildFooterForm());
    }

References ilPropertyFormGUI\addItem(), buildFooterForm(), buildHeaderForm(), buildMarginBottomForm(), buildMarginLeftForm(), buildMarginRightForm(), buildMarginTopForm(), buildOrientationsForm(), buildPageSizesForm(), buildZoomForm(), and translate().

Referenced by addConfigForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildCheckboxSvgForm()

ilWkhtmlToPdfConfigFormGUI::buildCheckboxSvgForm ( )

protected

Definition at line 345 of file class.ilWkhtmlToPdfConfigFormGUI.php.

                                             : ilTextInputGUI
    {
        return new ilTextInputGUI($this->translate('checkbox_svg'), 'checkbox_svg');
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildCheckedCheckboxSvgForm()

ilWkhtmlToPdfConfigFormGUI::buildCheckedCheckboxSvgForm ( )

protected

Definition at line 350 of file class.ilWkhtmlToPdfConfigFormGUI.php.

                                                    : ilTextInputGUI
    {
        return new ilTextInputGUI($this->translate('checkbox_checked_svg'), 'checkbox_checked_svg');
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildCheckedRadiobuttonSvgForm()

ilWkhtmlToPdfConfigFormGUI::buildCheckedRadiobuttonSvgForm ( )

protected

Definition at line 360 of file class.ilWkhtmlToPdfConfigFormGUI.php.

                                                       : ilTextInputGUI
    {
        return new ilTextInputGUI($this->translate('radio_button_checked_svg'), 'radio_button_checked_svg');
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildEnableFormsForm()

ilWkhtmlToPdfConfigFormGUI::buildEnableFormsForm ( )

protected

Returns: ilCheckboxInputGUI

Definition at line 83 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $enable_forms = new ilCheckboxInputGUI($this->translate('enable_forms'), 'enable_forms');
        $enable_forms->setInfo($this->translate('enable_forms_info'));
        return $enable_forms;
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildExternalLinksForm()

ilWkhtmlToPdfConfigFormGUI::buildExternalLinksForm ( )

protected

Returns: ilCheckboxInputGUI

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

    {
        $external_links = new ilCheckboxInputGUI($this->translate('external_links'), 'external_links');
        $external_links->setInfo($this->translate('external_links_info'));
        return $external_links;
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFooterForm()

ilWkhtmlToPdfConfigFormGUI::buildFooterForm ( )

protected

Returns: ilRadioGroupInputGUI

Definition at line 292 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $footer_select = new ilRadioGroupInputGUI($this->translate('footer_type'), 'footer_select');
        $footer_select->addOption(new ilRadioOption($this->translate("none"), ilPDFGenerationConstants::FOOTER_NONE, ''));
        $footer_select->addOption($this->buildFooterTextForm());
        $footer_select->addOption($this->buildFooterHtmlForm());
 
        return $footer_select;
    }

References buildFooterHtmlForm(), buildFooterTextForm(), ilPDFGenerationConstants\FOOTER_NONE, and translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFooterHtmlForm()

ilWkhtmlToPdfConfigFormGUI::buildFooterHtmlForm ( )

protected

Returns: ilRadioOption

Definition at line 330 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $footer_html_option = new ilRadioOption($this->translate('html'), ilPDFGenerationConstants::FOOTER_HTML, '');
 
        $footer_html = new ilTextInputGUI($this->translate('footer_html'), 'footer_html');
        $footer_html_option->addSubItem($footer_html);
 
        $footer_html_spacing = new ilTextInputGUI($this->translate('spacing'), 'footer_html_spacing');
        $footer_html_option->addSubItem($footer_html_spacing);
 
        $footer_html_line = new ilCheckboxInputGUI($this->translate('footer_line'), 'footer_html_line');
        $footer_html_option->addSubItem($footer_html_line);
        return $footer_html_option;
    }

References ilPDFGenerationConstants\FOOTER_HTML, and translate().

Referenced by buildFooterForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFooterTextForm()

ilWkhtmlToPdfConfigFormGUI::buildFooterTextForm ( )

protected

Returns: ilRadioOption

Definition at line 305 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $footer_text_option = new ilRadioOption($this->translate('text'), ilPDFGenerationConstants::FOOTER_TEXT, '');
 
        $footer_text_left = new ilTextInputGUI($this->translate('footer_text_left'), 'footer_text_left');
        $footer_text_option->addSubItem($footer_text_left);
 
        $footer_text_center = new ilTextInputGUI($this->translate('footer_text_center'), 'footer_text_center');
        $footer_text_option->addSubItem($footer_text_center);
 
        $footer_text_right = new ilTextInputGUI($this->translate('footer_text_right'), 'footer_text_right');
        $footer_text_option->addSubItem($footer_text_right);
 
        $footer_text_spacing = new ilTextInputGUI($this->translate('spacing'), 'footer_text_spacing');
        $footer_text_option->addSubItem($footer_text_spacing);
 
        $footer_text_line = new ilCheckboxInputGUI($this->translate('footer_line'), 'footer_text_line');
 
        $footer_text_option->addSubItem($footer_text_line);
        return $footer_text_option;
    }

References ilPDFGenerationConstants\FOOTER_TEXT, and translate().

Referenced by buildFooterForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildGreyScaleForm()

ilWkhtmlToPdfConfigFormGUI::buildGreyScaleForm ( )

protected

Returns: ilCheckboxInputGUI

Definition at line 103 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $grey_scale = new ilCheckboxInputGUI($this->translate('greyscale'), 'greyscale');
        $grey_scale->setInfo($this->translate('greyscale_info'));
        return $grey_scale;
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeaderForm()

ilWkhtmlToPdfConfigFormGUI::buildHeaderForm ( )

protected

Returns: ilRadioGroupInputGUI

Definition at line 236 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $header_select = new ilRadioGroupInputGUI($this->translate('header_type'), 'header_select');
        $header_select->addOption(new ilRadioOption($this->translate('none'), ilPDFGenerationConstants::HEADER_NONE, ''));
        $header_select->addOption($this->buildHeaderTextForm());
        $header_select->addOption($this->buildHeaderHtmlForm());
 
        return $header_select;
    }

References buildHeaderHtmlForm(), buildHeaderTextForm(), ilPDFGenerationConstants\HEADER_NONE, and translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeaderHtmlForm()

ilWkhtmlToPdfConfigFormGUI::buildHeaderHtmlForm ( )

protected

Returns: ilRadioOption

Definition at line 274 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $header_html_option = new ilRadioOption($this->translate("html"), ilPDFGenerationConstants::HEADER_HTML, '');
 
        $header_html = new ilTextInputGUI($this->translate('html'), 'head_html');
        $header_html_option->addSubItem($header_html);
 
        $head_html_spacing = new ilTextInputGUI($this->translate('spacing'), 'head_html_spacing');
        $header_html_option->addSubItem($head_html_spacing);
 
        $head_html_line = new ilCheckboxInputGUI($this->translate('header_line'), 'head_html_line');
        $header_html_option->addSubItem($head_html_line);
        return $header_html_option;
    }

References ilPDFGenerationConstants\HEADER_HTML, and translate().

Referenced by buildHeaderForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeaderTextForm()

ilWkhtmlToPdfConfigFormGUI::buildHeaderTextForm ( )

protected

Returns: ilRadioOption

Definition at line 249 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $header_text_option = new ilRadioOption($this->translate('text'), ilPDFGenerationConstants::HEADER_TEXT, '');
 
        $header_text_left = new ilTextInputGUI($this->translate('header_text_left'), 'head_text_left');
        $header_text_option->addSubItem($header_text_left);
 
        $header_text_center = new ilTextInputGUI($this->translate('header_text_center'), 'head_text_center');
        $header_text_option->addSubItem($header_text_center);
 
        $header_text_right = new ilTextInputGUI($this->translate('header_text_right'), 'head_text_right');
        $header_text_option->addSubItem($header_text_right);
 
        $head_text_spacing = new ilTextInputGUI($this->translate('spacing'), 'head_text_spacing');
        $header_text_option->addSubItem($head_text_spacing);
 
        $head_text_line = new ilCheckboxInputGUI($this->translate('header_line'), 'head_text_line');
 
        $header_text_option->addSubItem($head_text_line);
        return $header_text_option;
    }

References ilPDFGenerationConstants\HEADER_TEXT, and translate().

Referenced by buildHeaderForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildJavascriptDelayForm()

ilWkhtmlToPdfConfigFormGUI::buildJavascriptDelayForm ( )

protected

Returns: ilTextInputGUI

Definition at line 123 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $javascript_delay = new ilNumberInputGUI($this->translate('javascript_delay'), 'javascript_delay');
        $javascript_delay->setMinValue(0);
        $javascript_delay->setInfo($this->translate('javascript_delay_info'));
        return $javascript_delay;
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildLowQualityForm()

ilWkhtmlToPdfConfigFormGUI::buildLowQualityForm ( )

protected

Returns: ilCheckboxInputGUI

Definition at line 93 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $low_quality = new ilCheckboxInputGUI($this->translate('low_quality'), 'low_quality');
        $low_quality->setInfo($this->translate('low_quality_info'));
        return $low_quality;
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildMarginBottomForm()

ilWkhtmlToPdfConfigFormGUI::buildMarginBottomForm ( )

protected

Returns: ilTextInputGUI

Definition at line 225 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $margin_bottom = new ilTextInputGUI($this->translate('margin_bottom'), 'margin_bottom');
        $margin_bottom->setValidationRegexp('/(\d)+?(\W)*(cm|mm)$/');
        $margin_bottom->setInfo($this->translate('margin_info'));
        return $margin_bottom;
    }

References translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildMarginLeftForm()

ilWkhtmlToPdfConfigFormGUI::buildMarginLeftForm ( )

protected

Returns: ilTextInputGUI

Definition at line 192 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $margin_left = new ilTextInputGUI($this->translate('margin_left'), 'margin_left');
        $margin_left->setValidationRegexp('/(\d)+?(\W)*(cm|mm)$/');
        $margin_left->setInfo($this->translate('margin_info'));
        return $margin_left;
    }

References translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildMarginRightForm()

ilWkhtmlToPdfConfigFormGUI::buildMarginRightForm ( )

protected

Returns: ilTextInputGUI

Definition at line 203 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $margin_right = new ilTextInputGUI($this->translate('margin_right'), 'margin_right');
        $margin_right->setValidationRegexp('/(\d)+?(\W)*(cm|mm)$/');
        $margin_right->setInfo($this->translate('margin_info'));
        return $margin_right;
    }

References translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildMarginTopForm()

ilWkhtmlToPdfConfigFormGUI::buildMarginTopForm ( )

protected

Returns: ilTextInputGUI

Definition at line 214 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $margin_top = new ilTextInputGUI($this->translate('margin_top'), 'margin_top');
        $margin_top->setValidationRegexp('/(\d)+?(\W)*(cm|mm)$/');
        $margin_top->setInfo($this->translate('margin_info'));
        return $margin_top;
    }

References translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOrientationsForm()

ilWkhtmlToPdfConfigFormGUI::buildOrientationsForm ( )

protected

Returns: ilSelectInputGUI

Definition at line 172 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $orientation = new ilSelectInputGUI($this->translate('orientation'), 'orientation');
        $orientation->setOptions(ilPDFGenerationConstants::getOrientations());
        return $orientation;
    }

References ilPDFGenerationConstants\getOrientations(), and translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOverwriteDefaultFont()

ilWkhtmlToPdfConfigFormGUI::buildOverwriteDefaultFont ( )

protected

Returns: ilTextInputGUI

Definition at line 134 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $overwrite_font = new ilSelectInputGUI($this->translate('overwrite_font'), 'overwrite_font');
        $overwrite_font->setOptions(ilPDFGenerationConstants::getFontStyles());
        return $overwrite_font;
    }

References ilPDFGenerationConstants\getFontStyles(), and translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPageSizesForm()

ilWkhtmlToPdfConfigFormGUI::buildPageSizesForm ( )

protected

Returns: ilSelectInputGUI

Definition at line 182 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $page_size = new ilSelectInputGUI($this->translate('page_size'), 'page_size');
        $page_size->setOptions(ilPDFGenerationConstants::getPageSizesNames());
        return $page_size;
    }

References ilPDFGenerationConstants\getPageSizesNames(), and translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPrintMediaTypeForm()

ilWkhtmlToPdfConfigFormGUI::buildPrintMediaTypeForm ( )

protected

Returns: ilCheckboxInputGUI

Definition at line 113 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $print_media = new ilCheckboxInputGUI($this->translate('print_media_type'), 'print_media_type');
        $print_media->setInfo($this->translate('print_media_info'));
        return $print_media;
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildRadiobuttonSvgForm()

ilWkhtmlToPdfConfigFormGUI::buildRadiobuttonSvgForm ( )

protected

Definition at line 355 of file class.ilWkhtmlToPdfConfigFormGUI.php.

                                                : ilTextInputGUI
    {
        return new ilTextInputGUI($this->translate('radio_button_svg'), 'radio_button_svg');
    }

References translate().

Referenced by appendOutputOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildZoomForm()

ilWkhtmlToPdfConfigFormGUI::buildZoomForm ( )

protected

Returns: ilNumberInputGUI

Definition at line 164 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        return new ilNumberInputGUI($this->translate('zoom'), 'zoom');
    }

References translate().

Referenced by appendPageSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConfigFromForm()

ilWkhtmlToPdfConfigFormGUI::getConfigFromForm ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Returns: array

Definition at line 486 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $orientation = ilUtil::stripSlashes($form->getItemByPostVar('orientation')->getValue());
        if(!in_array($orientation, ilPDFGenerationConstants::getOrientations())){
            $orientation = 'Portrait';
        }
        $purifier = new ilHtmlForumPostPurifier();
        return array(
            'path' => ilUtil::stripSlashes($form->getItemByPostVar('path')->getValue()),
            'zoom' => (float) $form->getItemByPostVar('zoom')->getValue(),
            'external_links' => (int) $form->getItemByPostVar('external_links')->getChecked(),
            'enable_forms' => (int) $form->getItemByPostVar('enable_forms')->getChecked(),
            'low_quality' => (int) $form->getItemByPostVar('low_quality')->getChecked(),
            'greyscale' => (int) $form->getItemByPostVar('greyscale')->getChecked(),
            'orientation' => $orientation,
            'page_size' => ilUtil::stripSlashes($form->getItemByPostVar('page_size')->getValue()),
            'margin_left' => ilUtil::stripSlashes($form->getItemByPostVar('margin_left')->getValue()),
            'margin_right' => ilUtil::stripSlashes($form->getItemByPostVar('margin_right')->getValue()),
            'margin_top' => ilUtil::stripSlashes($form->getItemByPostVar('margin_top')->getValue()),
            'margin_bottom' => ilUtil::stripSlashes($form->getItemByPostVar('margin_bottom')->getValue()),
            'print_media_type' => (int) $form->getItemByPostVar('print_media_type')->getChecked(),
            'javascript_delay' => (int) $form->getItemByPostVar('javascript_delay')->getValue(),
            'checkbox_svg' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('checkbox_svg')->getValue())),
            'checkbox_checked_svg' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('checkbox_checked_svg')->getValue())),
            'radio_button_svg' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('radio_button_svg')->getValue())),
            'radio_button_checked_svg' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('radio_button_checked_svg')->getValue())),
            'header_select' => (int) $form->getItemByPostVar('header_select')->getValue(),
            'head_text_left' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('head_text_left')->getValue())),
            'head_text_center' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('head_text_center')->getValue())),
            'head_text_right' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('head_text_right')->getValue())),
            'head_text_spacing' => ilUtil::stripSlashes($form->getItemByPostVar('head_text_spacing')->getValue()),
            'head_text_line' => ilUtil::stripSlashes($form->getItemByPostVar('head_text_line')->getValue()),
            'head_html_line' => (int) $form->getItemByPostVar('head_html_line')->getValue(),
            'head_html_spacing' => (int) $form->getItemByPostVar('head_html_spacing')->getValue(),
            'head_html' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('head_html')->getValue())),
            'footer_select' => ilUtil::stripSlashes($form->getItemByPostVar('footer_select')->getValue()),
            'footer_text_left' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('footer_text_left')->getValue())),
            'footer_text_right' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('footer_text_right')->getValue())),
            'footer_text_spacing' => ilUtil::stripSlashes($form->getItemByPostVar('footer_text_spacing')->getValue()),
            'footer_text_center' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('footer_text_center')->getValue())),
            'footer_text_line' => (int) $form->getItemByPostVar('footer_text_line')->getValue(),
            'footer_html' => $purifier->purify(ilUtil::stripSlashes($form->getItemByPostVar('footer_html')->getValue())),
            'footer_html_spacing' => (int) $form->getItemByPostVar('footer_html_spacing')->getValue(),
            'overwrite_font' => strtolower(ilUtil::stripSlashes($form->getItemByPostVar('overwrite_font')->getValue()))
        );
    }

References ilPropertyFormGUI\getItemByPostVar(), ilPDFGenerationConstants\getOrientations(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ isNotValidSize()

ilWkhtmlToPdfConfigFormGUI::isNotValidSize ( array $sizes )

private

Definition at line 451 of file class.ilWkhtmlToPdfConfigFormGUI.php.

                                                  {
        foreach($sizes as $size) {
            if(! preg_match('/(\d)+?(\W)*(cm|mm)$/', $size)){
                if($size !== 0 && $size !== null && $size !== "") {
                    return true;
                }
            }
        }
 
        return false;
    }

References $size.

Referenced by validateForm().

Here is the caller graph for this function:

◆ isNotValidText()

ilWkhtmlToPdfConfigFormGUI::isNotValidText ( array $texts )

private

Definition at line 463 of file class.ilWkhtmlToPdfConfigFormGUI.php.

                                                  {
        foreach($texts as $text) {
            if(! preg_match('/[a-zA-Z\d ]+$/', $text)){
                if($text !== '' && $text !== null && $text !== "") {
                    return true;
                }
            }
        }
 
        return false;
    }

Referenced by validateForm().

Here is the caller graph for this function:

◆ populateForm()

ilWkhtmlToPdfConfigFormGUI::populateForm	(	$form,
		$config
	)

Parameters

ilPropertyFormGUI	$form
ilWkhtmlToPdfConfig	$config

Definition at line 537 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $form->getItemByPostVar('path')->setValue($config->getWKHTMLToPdfDefaultPath());
        $form->getItemByPostVar('zoom')->setValue($config->getZoom());
        $form->getItemByPostVar('external_links')->setValue(1);
        $form->getItemByPostVar('external_links')->setChecked($config->getExternalLinks());
        $form->getItemByPostVar('enable_forms')->setValue(1);
        $form->getItemByPostVar('enable_forms')->setChecked($config->getEnabledForms());
        $form->getItemByPostVar('low_quality')->setValue(1);
        $form->getItemByPostVar('low_quality')->setChecked($config->getLowQuality());
        $form->getItemByPostVar('greyscale')->setValue(1);
        $form->getItemByPostVar('greyscale')->setChecked($config->getGreyscale());
        $form->getItemByPostVar('orientation')->setValue($config->getOrientation());
        $form->getItemByPostVar('page_size')->setValue($config->getPageSize());
        $form->getItemByPostVar('margin_left')->setValue($config->getMarginLeft());
        $form->getItemByPostVar('margin_right')->setValue($config->getMarginRight());
        $form->getItemByPostVar('margin_top')->setValue($config->getMarginTop());
        $form->getItemByPostVar('margin_bottom')->setValue($config->getMarginBottom());
        $form->getItemByPostVar('print_media_type')->setValue(1);
        $form->getItemByPostVar('print_media_type')->setChecked($config->getPrintMediaType());
        $form->getItemByPostVar('javascript_delay')->setValue($config->getJavascriptDelay());
        $form->getItemByPostVar('checkbox_svg')->setValue($config->getCheckboxSvg());
        $form->getItemByPostVar('checkbox_checked_svg')->setValue($config->getCheckboxCheckedSvg());
        $form->getItemByPostVar('radio_button_svg')->setValue($config->getRadioButtonSvg());
        $form->getItemByPostVar('radio_button_checked_svg')->setValue($config->getRadioButtonCheckedSvg());
        $form->getItemByPostVar('header_select')->setValue($config->getHeaderType());
        $form->getItemByPostVar('head_text_left')->setValue($config->getHeaderTextLeft());
        $form->getItemByPostVar('head_text_center')->setValue($config->getHeaderTextCenter());
        $form->getItemByPostVar('head_text_right')->setValue($config->getHeaderTextRight());
        $form->getItemByPostVar('head_text_spacing')->setValue($config->getHeaderTextSpacing());
        $form->getItemByPostVar('head_text_line')->setValue(1);
        $form->getItemByPostVar('head_text_line')->setChecked($config->isHeaderTextLine());
        $form->getItemByPostVar('head_html_line')->setValue(1);
        $form->getItemByPostVar('head_html_line')->setChecked($config->isHeaderHtmlLine());
        $form->getItemByPostVar('head_html_spacing')->setValue($config->getHeaderHtmlSpacing());
        $form->getItemByPostVar('head_html')->setValue($config->getHeaderHtml());
        $form->getItemByPostVar('footer_select')->setValue($config->getFooterType());
        $form->getItemByPostVar('footer_text_left')->setValue($config->getFooterTextLeft());
        $form->getItemByPostVar('footer_text_center')->setValue($config->getFooterTextCenter());
        $form->getItemByPostVar('footer_text_right')->setValue($config->getFooterTextRight());
        $form->getItemByPostVar('footer_text_spacing')->setValue($config->getFooterTextSpacing());
        $form->getItemByPostVar('footer_text_line')->setValue(1);
        $form->getItemByPostVar('footer_text_line')->setChecked($config->isFooterTextLine());
        $form->getItemByPostVar('footer_html_line')->setValue(1);
        $form->getItemByPostVar('footer_html_line')->setChecked($config->isFooterHtmlLine());
        $form->getItemByPostVar('footer_html')->setValue($config->getFooterHtml());
        $form->getItemByPostVar('footer_html_spacing')->setValue($config->getFooterHtmlSpacing());
        $form->getItemByPostVar('overwrite_font')->setValue($config->getOverwriteDefaultFont(false));
 
        ilPDFGeneratorUtils::setCheckedIfTrue($form);
    }

References $config, and ilPDFGeneratorUtils\setCheckedIfTrue().

Here is the call graph for this function:

◆ saveNewDefaultBinaryPath()

ilWkhtmlToPdfConfigFormGUI::saveNewDefaultBinaryPath ( $path )

protected

Parameters

$path

Definition at line 477 of file class.ilWkhtmlToPdfConfigFormGUI.php.

                                                      {
        $settings = new ilSetting('wkhtmltopdfrenderer');
        $settings->set('path', $path);
    }

Referenced by validateForm().

Here is the caller graph for this function:

◆ setLanguage()

ilWkhtmlToPdfConfigFormGUI::setLanguage ( $lng )

protected

Parameters

$lng

Definition at line 22 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $this->lng = $lng;
    }

References $lng.

Referenced by __construct().

Here is the caller graph for this function:

◆ translate()

ilWkhtmlToPdfConfigFormGUI::translate ( $txt )

protected

Parameters

$txt

Returns: string

Definition at line 43 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        return $this->lng->txt($txt);
    }

References $txt.

Referenced by addConfigForm(), appendOutputOptionsForm(), appendPageSettingsForm(), buildCheckboxSvgForm(), buildCheckedCheckboxSvgForm(), buildCheckedRadiobuttonSvgForm(), buildEnableFormsForm(), buildExternalLinksForm(), buildFooterForm(), buildFooterHtmlForm(), buildFooterTextForm(), buildGreyScaleForm(), buildHeaderForm(), buildHeaderHtmlForm(), buildHeaderTextForm(), buildJavascriptDelayForm(), buildLowQualityForm(), buildMarginBottomForm(), buildMarginLeftForm(), buildMarginRightForm(), buildMarginTopForm(), buildOrientationsForm(), buildOverwriteDefaultFont(), buildPageSizesForm(), buildPrintMediaTypeForm(), buildRadiobuttonSvgForm(), and buildZoomForm().

Here is the caller graph for this function:

◆ validateForm()

ilWkhtmlToPdfConfigFormGUI::validateForm ( )

Returns: bool

Definition at line 368 of file class.ilWkhtmlToPdfConfigFormGUI.php.

    {
        $everything_ok = true;
        $config = new ilWkhtmlToPdfConfig();
        $path = realpath(ilUtil::escapeShellCmd($_POST['path']));
        $config->setPath($path);
        $orientation = ilUtil::stripSlashes($_POST['orientation']);
        $margin_left = ilUtil::stripSlashes($_POST['margin_left']);
        $margin_right = ilUtil::stripSlashes($_POST['margin_right']);
        $margin_top = ilUtil::stripSlashes($_POST['margin_top']);
        $margin_bottom = ilUtil::stripSlashes($_POST['margin_bottom']);
        $footer_text_spacing = (int) $_POST['footer_text_spacing'];
        $footer_html_spacing = (int) $_POST['footer_html_spacing'];
        $head_text_spacing = (int) $_POST['head_text_spacing'];
        $head_html_spacing = (int) $_POST['head_html_spacing'];
        $footer_text_left = ilUtil::stripSlashes($_POST['footer_text_left']);
        $footer_text_center = ilUtil::stripSlashes($_POST['footer_text_center']);
        $footer_text_right = ilUtil::stripSlashes($_POST['footer_text_right']);
        $header_text_left = ilUtil::stripSlashes($_POST['head_text_left']);
        $header_text_center = ilUtil::stripSlashes($_POST['head_text_center']);
        $header_text_right = ilUtil::stripSlashes($_POST['head_text_right']);
        $sizes = [
            $margin_left, $margin_right, $margin_top, $margin_bottom, $footer_text_spacing, $footer_html_spacing, $head_text_spacing, $head_html_spacing
        ];
        $header_footer_texts = [
            $footer_text_left, $footer_text_center, $footer_text_right, $header_text_left, $header_text_center, $header_text_right
        ];
        if (mb_stripos($config->getPath(), 'wkhtmlto') === false) {
            ilUtil::sendFailure($this->lng->txt("file_not_found"), true);
            $everything_ok = false;
        } elseif(!in_array($orientation, ilPDFGenerationConstants::getOrientations()))
        {
            $everything_ok = false;
        } elseif($this->isNotValidSize($sizes))
        {
            $everything_ok = false;
        } elseif($this->isNotValidText($header_footer_texts))
        {
            $everything_ok = false;
        }
        else {
            $config->setZoom((float) $_POST['zoom']);
            $config->setExternalLinks((int) $_POST['external_links']);
            $config->setEnabledForms((int) $_POST['enable_forms']);
            $config->setLowQuality((int) $_POST['low_quality']);
            $config->setGreyscale((int) $_POST['greyscale']);
            $config->setOrientation($orientation);
            $config->setPageSize(ilUtil::stripSlashes($_POST['page_size']));
            $config->setMarginLeft(ilUtil::stripSlashes($_POST['margin_left']));
            $config->setMarginRight(ilUtil::stripSlashes($_POST['margin_right']));
            $config->setMarginTop(ilUtil::stripSlashes($_POST['margin_top']));
            $config->setMarginBottom(ilUtil::stripSlashes($_POST['margin_bottom']));
            $config->setPrintMediaType((int) $_POST['print_media_type']);
            $config->setJavascriptDelay((int) $_POST['javascript_delay']);
            $config->setCheckboxSvg(ilUtil::stripSlashes($_POST['checkbox_svg']));
            $config->setCheckboxCheckedSvg(ilUtil::stripSlashes($_POST['checkbox_checked_svg']));
            $config->setRadioButtonSvg(ilUtil::stripSlashes($_POST['radio_button_svg']));
            $config->setRadioButtonCheckedSvg(ilUtil::stripSlashes($_POST['radio_button_checked_svg']));
            $config->setHeaderType((int) $_POST['header_select']);
            $config->setHeaderTextLeft(ilUtil::stripSlashes($header_text_left));
            $config->setHeaderTextCenter(ilUtil::stripSlashes($header_text_center));
            $config->setHeaderTextRight(ilUtil::stripSlashes($header_text_right));
            $config->setHeaderTextSpacing((int) $head_text_spacing);
            $config->setHeaderTextLine((int) $_POST['head_text_line']);
            $config->setHeaderHtmlLine((int) $_POST['head_html_line']);
            $config->setHeaderHtmlSpacing((int) $head_html_spacing);
            $config->setHeaderHtml(ilUtil::stripSlashes($_POST['head_html']));
            $config->setFooterType((int) $_POST['footer_select']);
            $config->setFooterTextLeft($footer_text_left);
            $config->setFooterTextCenter($footer_text_center);
            $config->setFooterTextRight($footer_text_right);
            $config->setFooterTextSpacing($footer_text_spacing);
            $config->setFooterTextLine((int) $_POST['footer_text_line']);
            $config->setFooterHtmlLine((int) $_POST['footer_html_line']);
            $config->setFooterHtmlSpacing((int) $footer_html_spacing);
            $config->setFooterHtml(ilUtil::stripSlashes($_POST['footer_html']));
            $config->setOverwriteDefaultFont(strtolower(ilUtil::stripSlashes($_POST['overwrite_font'])));
            $this->saveNewDefaultBinaryPath($config->getPath());
        }
 
        return $everything_ok;
    }

References $_POST, $config, ilUtil\escapeShellCmd(), ilPDFGenerationConstants\getOrientations(), isNotValidSize(), isNotValidText(), saveNewDefaultBinaryPath(), ilUtil\sendFailure(), and ilUtil\stripSlashes().

Here is the call graph for this function:

Field Documentation

◆ $lng

ilWkhtmlToPdfConfigFormGUI::$lng

protected

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

Referenced by setLanguage().

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

Services/PDFGeneration/classes/renderer/wkhtmltopdf/class.ilWkhtmlToPdfConfigFormGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addConfigForm()

◆ appendOutputOptionsForm()

◆ appendPageSettingsForm()

◆ buildCheckboxSvgForm()

◆ buildCheckedCheckboxSvgForm()

◆ buildCheckedRadiobuttonSvgForm()

◆ buildEnableFormsForm()

◆ buildExternalLinksForm()

◆ buildFooterForm()

◆ buildFooterHtmlForm()

◆ buildFooterTextForm()

◆ buildGreyScaleForm()

◆ buildHeaderForm()

◆ buildHeaderHtmlForm()

◆ buildHeaderTextForm()

◆ buildJavascriptDelayForm()

◆ buildLowQualityForm()

◆ buildMarginBottomForm()

◆ buildMarginLeftForm()

◆ buildMarginRightForm()

◆ buildMarginTopForm()

◆ buildOrientationsForm()

◆ buildOverwriteDefaultFont()

◆ buildPageSizesForm()

◆ buildPrintMediaTypeForm()

◆ buildRadiobuttonSvgForm()

◆ buildZoomForm()

◆ getConfigFromForm()

◆ isNotValidSize()

◆ isNotValidText()

◆ populateForm()

◆ saveNewDefaultBinaryPath()

◆ setLanguage()

◆ translate()

◆ validateForm()

Field Documentation

◆ $lng