ilWkhtmlToPdfConfig Class Reference

Collaboration diagram for ilWkhtmlToPdfConfig:

Public Member Functions
	__construct ($config=null)
	getZoom ()
	setZoom (float $zoom)
	getEnabledForms ()
	setEnabledForms (?bool $enabled_forms)
	getExternalLinks ()
	setExternalLinks (bool $external_links)
	getLowQuality ()
	setLowQuality (bool $low_quality)
	getGreyscale ()
	setGreyscale (bool $greyscale)
	getOrientation ()
	setOrientation (string $orientation)
	getPageSize ()
	setPageSize (string $page_size)
	getMarginLeft ()
	setMarginLeft (string $margin_left)
	getMarginRight ()
	setMarginRight (string $margin_right)
	getFooterHtmlSpacing ()
	setFooterHtmlSpacing (int $footer_html_spacing)
	getFooterHtml ()
	setFooterHtml (string $footer_html)
	isFooterTextLine ()
	setFooterTextLine (bool $footer_text_line)
	getFooterTextCenter ()
	setFooterTextCenter (string $footer_text_center)
	getFooterTextSpacing ()
	setFooterTextSpacing (int $footer_text_spacing)
	getFooterTextRight ()
	setFooterTextRight (string $footer_text_right)
	getFooterTextLeft ()
	setFooterTextLeft (string $footer_text_left)
	getFooterType ()
	setFooterType (int $footer_type)
	isFooterHtmlLine ()
	setFooterHtmlLine (bool $footer_html_line)
	isHeaderTextLine ()
	setHeaderTextLine (bool $header_text_line)
	getHeaderTextSpacing ()
	setHeaderTextSpacing (int $header_text_spacing)
	getHeaderTextRight ()
	setHeaderTextRight (string $header_text_right)
	getHeaderTextCenter ()
	setHeaderTextCenter (string $header_text_center)
	getHeaderTextLeft ()
	setHeaderTextLeft (string $header_text_left)
	getHeaderType ()
	setHeaderType (int $header_type)
	getRadioButtonCheckedSvg ()
	setRadioButtonCheckedSvg (string $radio_button_checked_svg)
	getRadioButtonSvg ()
	setRadioButtonSvg (string $radio_button_svg)
	getCheckboxCheckedSvg ()
	setCheckboxCheckedSvg (string $checkbox_checked_svg)
	getCheckboxSvg ()
	setCheckboxSvg (string $checkbox_svg)
	getJavascriptDelay ()
	setJavascriptDelay (int $javascript_delay)
	getPrintMediaType ()
	setPrintMediaType (bool $print_media_type)
	getMarginTop ()
	setMarginTop (string $margin_top)
	getMarginBottom ()
	setMarginBottom (string $margin_bottom)
	getOverwriteDefaultFont (bool $renderStyle=false)
	setOverwriteDefaultFont (string $overwrite_default_font)
	getPath ()
	setPath (string $path)
	getWKHTMLToPdfDefaultPath ()
	getConfig ()
	getCommandLineConfig ()
	getHeaderHtml ()
	setHeaderHtml (string $header_html)
	getHeaderHtmlSpacing ()
	setHeaderHtmlSpacing (int $header_html_spacing)
	isHeaderHtmlLine ()
	setHeaderHtmlLine (bool $header_html_line)

Static Public Member Functions
static	supportMultiSourcesFiles ()

Protected Member Functions
	readConfigFromArray (array $config)
	setKeyIfExists (string $function, string $key, array $config)
	readConfigFromObject (ilWkhtmlToPdfConfig $config)
	useDefaultConfig ()
	generateCommandLineConfig ()
	getZoomArgument ()
	getExternalLinksArgument ()
	getEnabledFormsArgument ()
	getGreyscaleArgument ()
	getLowQualityArgument ()
	getOrientationArgument ()
	getPrintMediaTypeArgument ()
	getPageSizeArgument ()
	getJavascriptDelayArgument ()
	getCheckboxSvgArgument ()
	getCheckboxCheckedSvgArgument ()
	getRadioButtonSvgArgument ()
	getRadioButtonCheckedSvgArgument ()
	getMarginArgument ()
	getHeaderArgument ()
	getFooterArgument ()
	getDebugArgument ()
	getSessionObject ()
	getSavedDefaultBinaryPath ()

Protected Attributes
bool	$phpunit = false
array	$config = []
float	$zoom = 1.0
bool	$external_links = false
bool	$enabled_forms = false
bool	$greyscale = false
bool	$low_quality = false
string	$orientation = 'Portrait'
bool	$print_media_type = false
string	$page_size = 'A4'
int	$javascript_delay = 100
string	$margin_left = ''
string	$margin_right = ''
string	$margin_top = ''
string	$margin_bottom = ''
int	$header_type = 0
string	$header_text_left = ''
string	$header_text_center = ''
string	$header_text_right = ''
int	$header_text_spacing = 0
bool	$header_text_line = false
string	$header_html = ''
int	$header_html_spacing = 0
bool	$header_html_line = false
int	$footer_type = 0
string	$footer_text_left = ''
string	$footer_text_center = ''
string	$footer_text_right = ''
int	$footer_text_spacing = 0
bool	$footer_text_line = false
string	$footer_html = ''
int	$footer_html_spacing = 0
bool	$footer_html_line = false
string	$checkbox_svg = ''
string	$checkbox_checked_svg = ''
string	$radio_button_svg = ''
string	$radio_button_checked_svg = ''
string	$path = ''
string	$overwrite_default_font = 'arial'

Private Attributes
const	ENABLE_QUIET = true

Detailed Description

Deprecated:

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

Constructor & Destructor Documentation

__construct()

ilWkhtmlToPdfConfig::__construct

(

$config = null

)

Parameters

array | null | self

$config

Definition at line 71 of file class.ilWkhtmlToPdfConfig.php.

References readConfigFromArray(), readConfigFromObject(), and useDefaultConfig().

    {
        if (is_array($config)) {
            $this->readConfigFromArray($config);
        } elseif ($config instanceof self) {
            $this->readConfigFromObject($config);
        } else {
            $this->useDefaultConfig();
        }
    }

Here is the call graph for this function:

Member Function Documentation

generateCommandLineConfig()

ilWkhtmlToPdfConfig::generateCommandLineConfig ( )

protected

Definition at line 584 of file class.ilWkhtmlToPdfConfig.php.

References getCheckboxCheckedSvgArgument(), getCheckboxSvgArgument(), getDebugArgument(), getEnabledFormsArgument(), getExternalLinksArgument(), getFooterArgument(), getGreyscaleArgument(), getHeaderArgument(), getJavascriptDelayArgument(), getLowQualityArgument(), getMarginArgument(), getOrientationArgument(), getPageSizeArgument(), getPrintMediaTypeArgument(), getRadioButtonCheckedSvgArgument(), getRadioButtonSvgArgument(), getSessionObject(), and getZoomArgument().

Referenced by getCommandLineConfig().

                                                  : void
    {
        $this->getZoomArgument();
        $this->getExternalLinksArgument();
        $this->getEnabledFormsArgument();
        $this->getGreyscaleArgument();
        $this->getLowQualityArgument();
        $this->getOrientationArgument();
        $this->getPrintMediaTypeArgument();
        $this->getPageSizeArgument();
        $this->getJavascriptDelayArgument();
        $this->getCheckboxSvgArgument();
        $this->getCheckboxCheckedSvgArgument();
        $this->getRadioButtonSvgArgument();
        $this->getRadioButtonCheckedSvgArgument();
        $this->getMarginArgument();
        $this->getHeaderArgument();
        $this->getFooterArgument();
        $this->getDebugArgument();
        $this->getSessionObject();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCheckboxCheckedSvg()

ilWkhtmlToPdfConfig::getCheckboxCheckedSvg

(

)

Definition at line 447 of file class.ilWkhtmlToPdfConfig.php.

References $checkbox_checked_svg.

Referenced by getCheckboxCheckedSvgArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                           : string
    {
        return $this->checkbox_checked_svg;
    }

Here is the caller graph for this function:

getCheckboxCheckedSvgArgument()

ilWkhtmlToPdfConfig::getCheckboxCheckedSvgArgument ( )

protected

Definition at line 684 of file class.ilWkhtmlToPdfConfig.php.

References ilShellUtil\escapeShellArg(), and getCheckboxCheckedSvg().

Referenced by generateCommandLineConfig().

                                                      : void
    {
        $checkbox_svg = $this->getCheckboxCheckedSvg();
        if ($checkbox_svg !== '') {
            $this->config[] = 'checkbox-checked-svg ' . ilShellUtil::escapeShellArg($checkbox_svg);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCheckboxSvg()

ilWkhtmlToPdfConfig::getCheckboxSvg

(

)

Definition at line 457 of file class.ilWkhtmlToPdfConfig.php.

References $checkbox_svg.

Referenced by getCheckboxSvgArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                    : string
    {
        return $this->checkbox_svg;
    }

Here is the caller graph for this function:

getCheckboxSvgArgument()

ilWkhtmlToPdfConfig::getCheckboxSvgArgument ( )

protected

Definition at line 676 of file class.ilWkhtmlToPdfConfig.php.

References ilShellUtil\escapeShellArg(), and getCheckboxSvg().

Referenced by generateCommandLineConfig().

                                               : void
    {
        $checkbox_svg = $this->getCheckboxSvg();
        if ($checkbox_svg !== '') {
            $this->config[] = 'checkbox-svg ' . ilShellUtil::escapeShellArg($checkbox_svg);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCommandLineConfig()

ilWkhtmlToPdfConfig::getCommandLineConfig

(

)

Definition at line 572 of file class.ilWkhtmlToPdfConfig.php.

References ILIAS\LTI\ToolProvider\$settings, and generateCommandLineConfig().

                                          : string
    {
        $this->generateCommandLineConfig();

        $settings = ' ';
        foreach ($this->config as $value) {
            $settings .= '--' . $value . ' ';
        }

        return $settings;
    }

Here is the call graph for this function:

getConfig()

ilWkhtmlToPdfConfig::getConfig

(

)

Definition at line 567 of file class.ilWkhtmlToPdfConfig.php.

References $config.

                               : array
    {
        return $this->config;
    }

getDebugArgument()

ilWkhtmlToPdfConfig::getDebugArgument ( )

protected

Definition at line 806 of file class.ilWkhtmlToPdfConfig.php.

Referenced by generateCommandLineConfig().

                                         : void
    {
        if (self::ENABLE_QUIET) {
            $this->config[] = 'quiet';
        }
    }

Here is the caller graph for this function:

getEnabledForms()

ilWkhtmlToPdfConfig::getEnabledForms

(

)

Definition at line 197 of file class.ilWkhtmlToPdfConfig.php.

References $enabled_forms.

Referenced by getEnabledFormsArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                     : bool
    {
        return $this->enabled_forms;
    }

Here is the caller graph for this function:

getEnabledFormsArgument()

ilWkhtmlToPdfConfig::getEnabledFormsArgument ( )

protected

Definition at line 622 of file class.ilWkhtmlToPdfConfig.php.

References getEnabledForms().

Referenced by generateCommandLineConfig().

                                                : void
    {
        if ($this->getEnabledForms()) {
            $this->config[] = 'enable-forms';
        } else {
            $this->config[] = 'disable-forms';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExternalLinks()

ilWkhtmlToPdfConfig::getExternalLinks

(

)

Definition at line 207 of file class.ilWkhtmlToPdfConfig.php.

References $external_links.

Referenced by getExternalLinksArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                      : bool
    {
        return $this->external_links;
    }

Here is the caller graph for this function:

getExternalLinksArgument()

ilWkhtmlToPdfConfig::getExternalLinksArgument ( )

protected

Definition at line 613 of file class.ilWkhtmlToPdfConfig.php.

References getExternalLinks().

Referenced by generateCommandLineConfig().

                                                 : void
    {
        if ($this->getExternalLinks()) {
            $this->config[] = 'enable-external-links';
        } else {
            $this->config[] = 'disable-external-links';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFooterArgument()

ilWkhtmlToPdfConfig::getFooterArgument ( )

protected

Definition at line 780 of file class.ilWkhtmlToPdfConfig.php.

References ilShellUtil\escapeShellArg(), ilPDFGenerationConstants\FOOTER_HTML, ilPDFGenerationConstants\FOOTER_TEXT, getFooterHtml(), getFooterHtmlSpacing(), getFooterTextCenter(), getFooterTextLeft(), getFooterTextRight(), getFooterTextSpacing(), getFooterType(), isFooterHtmlLine(), and isFooterTextLine().

Referenced by generateCommandLineConfig().

                                          : void
    {
        $footer_value = $this->getFooterType();
        if ($footer_value === ilPDFGenerationConstants::FOOTER_TEXT) {
            $this->config[] = 'footer-left ' . ilShellUtil::escapeShellArg($this->getFooterTextLeft());
            $this->config[] = 'footer-center ' . ilShellUtil::escapeShellArg($this->getFooterTextCenter());
            $this->config[] = 'footer-right ' . ilShellUtil::escapeShellArg($this->getFooterTextRight());
            if ($this->getFooterTextSpacing() > 0) {
                $this->config[] = 'footer-spacing ' . $this->getFooterTextSpacing();
            }

            if ($this->isFooterTextLine()) {
                $this->config[] = 'footer-line';
            }
        } elseif ($footer_value === ilPDFGenerationConstants::FOOTER_HTML) {
            $this->config[] = 'footer-html ' . ilShellUtil::escapeShellArg($this->getFooterHtml());

            if ($this->getFooterHtmlSpacing() > 0) {
                $this->config[] = 'footer-spacing ' . $this->getFooterHtmlSpacing();
            }
            if ($this->isFooterHtmlLine()) {
                $this->config[] = 'footer-line';
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFooterHtml()

ilWkhtmlToPdfConfig::getFooterHtml

(

)

Definition at line 287 of file class.ilWkhtmlToPdfConfig.php.

References $footer_html.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                   : string
    {
        return $this->footer_html;
    }

Here is the caller graph for this function:

getFooterHtmlSpacing()

ilWkhtmlToPdfConfig::getFooterHtmlSpacing

(

)

Definition at line 277 of file class.ilWkhtmlToPdfConfig.php.

References $footer_html_spacing.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                          : int
    {
        return $this->footer_html_spacing;
    }

Here is the caller graph for this function:

getFooterTextCenter()

ilWkhtmlToPdfConfig::getFooterTextCenter

(

)

Definition at line 307 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_center.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                         : string
    {
        return $this->footer_text_center;
    }

Here is the caller graph for this function:

getFooterTextLeft()

ilWkhtmlToPdfConfig::getFooterTextLeft

(

)

Definition at line 337 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_left.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                       : string
    {
        return $this->footer_text_left;
    }

Here is the caller graph for this function:

getFooterTextRight()

ilWkhtmlToPdfConfig::getFooterTextRight

(

)

Definition at line 327 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_right.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                        : string
    {
        return $this->footer_text_right;
    }

Here is the caller graph for this function:

getFooterTextSpacing()

ilWkhtmlToPdfConfig::getFooterTextSpacing

(

)

Definition at line 317 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_spacing.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                          : int
    {
        return $this->footer_text_spacing;
    }

Here is the caller graph for this function:

getFooterType()

ilWkhtmlToPdfConfig::getFooterType

(

)

Definition at line 347 of file class.ilWkhtmlToPdfConfig.php.

References $footer_type.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                   : int
    {
        return $this->footer_type;
    }

Here is the caller graph for this function:

getGreyscale()

ilWkhtmlToPdfConfig::getGreyscale

(

)

Definition at line 227 of file class.ilWkhtmlToPdfConfig.php.

References $greyscale.

Referenced by getGreyscaleArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                  : bool
    {
        return $this->greyscale;
    }

Here is the caller graph for this function:

getGreyscaleArgument()

ilWkhtmlToPdfConfig::getGreyscaleArgument ( )

protected

Definition at line 631 of file class.ilWkhtmlToPdfConfig.php.

References getGreyscale().

Referenced by generateCommandLineConfig().

                                             : void
    {
        if ($this->getGreyscale()) {
            $this->config[] = 'grayscale';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHeaderArgument()

ilWkhtmlToPdfConfig::getHeaderArgument ( )

protected

Definition at line 724 of file class.ilWkhtmlToPdfConfig.php.

References ilShellUtil\escapeShellArg(), getHeaderHtml(), getHeaderHtmlSpacing(), getHeaderTextCenter(), getHeaderTextLeft(), getHeaderTextRight(), getHeaderTextSpacing(), getHeaderType(), ilPDFGenerationConstants\HEADER_HTML, ilPDFGenerationConstants\HEADER_TEXT, isHeaderHtmlLine(), and isHeaderTextLine().

Referenced by generateCommandLineConfig().

                                          : void
    {
        $header_value = $this->getHeaderType();
        if ($header_value === ilPDFGenerationConstants::HEADER_TEXT) {
            $this->config[] = 'header-left ' . ilShellUtil::escapeShellArg($this->getHeaderTextLeft());
            $this->config[] = 'header-center ' . ilShellUtil::escapeShellArg($this->getHeaderTextCenter());
            $this->config[] = 'header-right ' . ilShellUtil::escapeShellArg($this->getHeaderTextRight());
            if ($this->getHeaderTextSpacing() > 0) {
                $this->config[] = 'header-spacing ' . $this->getHeaderTextSpacing();
            }

            if ($this->isHeaderTextLine()) {
                $this->config[] = 'header-line';
            }
        } elseif ($header_value === ilPDFGenerationConstants::HEADER_HTML) {
            $this->config[] = 'header-html ' . ilShellUtil::escapeShellArg($this->getHeaderHtml());

            if ($this->getHeaderHtmlSpacing() > 0) {
                $this->config[] = 'header-spacing ' . $this->getHeaderHtmlSpacing();
            }
            if ($this->isHeaderHtmlLine()) {
                $this->config[] = 'header-line';
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHeaderHtml()

ilWkhtmlToPdfConfig::getHeaderHtml

(

)

Definition at line 750 of file class.ilWkhtmlToPdfConfig.php.

References $header_html.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                   : string
    {
        return $this->header_html;
    }

Here is the caller graph for this function:

getHeaderHtmlSpacing()

ilWkhtmlToPdfConfig::getHeaderHtmlSpacing

(

)

Definition at line 760 of file class.ilWkhtmlToPdfConfig.php.

References $header_html_spacing.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                          : int
    {
        return $this->header_html_spacing;
    }

Here is the caller graph for this function:

getHeaderTextCenter()

ilWkhtmlToPdfConfig::getHeaderTextCenter

(

)

Definition at line 397 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_center.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                         : string
    {
        return $this->header_text_center;
    }

Here is the caller graph for this function:

getHeaderTextLeft()

ilWkhtmlToPdfConfig::getHeaderTextLeft

(

)

Definition at line 407 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_left.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                       : string
    {
        return $this->header_text_left;
    }

Here is the caller graph for this function:

getHeaderTextRight()

ilWkhtmlToPdfConfig::getHeaderTextRight

(

)

Definition at line 387 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_right.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                        : string
    {
        return $this->header_text_right;
    }

Here is the caller graph for this function:

getHeaderTextSpacing()

ilWkhtmlToPdfConfig::getHeaderTextSpacing

(

)

Definition at line 377 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_spacing.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                          : int
    {
        return $this->header_text_spacing;
    }

Here is the caller graph for this function:

getHeaderType()

ilWkhtmlToPdfConfig::getHeaderType

(

)

Definition at line 417 of file class.ilWkhtmlToPdfConfig.php.

References $header_type.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                   : int
    {
        return $this->header_type;
    }

Here is the caller graph for this function:

getJavascriptDelay()

ilWkhtmlToPdfConfig::getJavascriptDelay

(

)

Definition at line 467 of file class.ilWkhtmlToPdfConfig.php.

References $javascript_delay.

Referenced by getJavascriptDelayArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                        : int
    {
        return $this->javascript_delay;
    }

Here is the caller graph for this function:

getJavascriptDelayArgument()

ilWkhtmlToPdfConfig::getJavascriptDelayArgument ( )

protected

Definition at line 669 of file class.ilWkhtmlToPdfConfig.php.

References getJavascriptDelay().

Referenced by generateCommandLineConfig().

                                                   : void
    {
        if ($this->getJavascriptDelay() > 0) {
            $this->config[] = 'javascript-delay ' . $this->getJavascriptDelay();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLowQuality()

ilWkhtmlToPdfConfig::getLowQuality

(

)

Definition at line 217 of file class.ilWkhtmlToPdfConfig.php.

References $low_quality.

Referenced by getLowQualityArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                   : bool
    {
        return $this->low_quality;
    }

Here is the caller graph for this function:

getLowQualityArgument()

ilWkhtmlToPdfConfig::getLowQualityArgument ( )

protected

Definition at line 638 of file class.ilWkhtmlToPdfConfig.php.

References getLowQuality().

Referenced by generateCommandLineConfig().

                                              : void
    {
        if ($this->getLowQuality()) {
            $this->config[] = 'lowquality';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMarginArgument()

ilWkhtmlToPdfConfig::getMarginArgument ( )

protected

Definition at line 708 of file class.ilWkhtmlToPdfConfig.php.

References ilShellUtil\escapeShellArg(), getMarginBottom(), getMarginLeft(), getMarginRight(), and getMarginTop().

Referenced by generateCommandLineConfig().

                                          : void
    {
        if ($this->getMarginBottom() !== '') {
            $this->config[] = 'margin-bottom ' . ilShellUtil::escapeShellArg($this->getMarginBottom());
        }
        if ($this->getMarginLeft() !== '') {
            $this->config[] = 'margin-left ' . ilShellUtil::escapeShellArg($this->getMarginLeft());
        }
        if ($this->getMarginRight() !== '') {
            $this->config[] = 'margin-right ' . ilShellUtil::escapeShellArg($this->getMarginRight());
        }
        if ($this->getMarginTop() !== '') {
            $this->config[] = 'margin-top ' . ilShellUtil::escapeShellArg($this->getMarginTop());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMarginBottom()

ilWkhtmlToPdfConfig::getMarginBottom

(

)

Definition at line 497 of file class.ilWkhtmlToPdfConfig.php.

References $margin_bottom.

Referenced by getMarginArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                     : string
    {
        return $this->margin_bottom;
    }

Here is the caller graph for this function:

getMarginLeft()

ilWkhtmlToPdfConfig::getMarginLeft

(

)

Definition at line 257 of file class.ilWkhtmlToPdfConfig.php.

References $margin_left.

Referenced by getMarginArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                   : string
    {
        return $this->margin_left;
    }

Here is the caller graph for this function:

getMarginRight()

ilWkhtmlToPdfConfig::getMarginRight

(

)

Definition at line 267 of file class.ilWkhtmlToPdfConfig.php.

References $margin_right.

Referenced by getMarginArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                    : string
    {
        return $this->margin_right;
    }

Here is the caller graph for this function:

getMarginTop()

ilWkhtmlToPdfConfig::getMarginTop

(

)

Definition at line 487 of file class.ilWkhtmlToPdfConfig.php.

References $margin_top.

Referenced by getMarginArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                  : string
    {
        return $this->margin_top;
    }

Here is the caller graph for this function:

getOrientation()

ilWkhtmlToPdfConfig::getOrientation

(

)

Definition at line 237 of file class.ilWkhtmlToPdfConfig.php.

References $orientation.

Referenced by getOrientationArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                    : string
    {
        return $this->orientation;
    }

Here is the caller graph for this function:

getOrientationArgument()

ilWkhtmlToPdfConfig::getOrientationArgument ( )

protected

Definition at line 645 of file class.ilWkhtmlToPdfConfig.php.

References getOrientation().

Referenced by generateCommandLineConfig().

                                               : void
    {
        $orientation = $this->getOrientation();
        if ($orientation === '' || $orientation === 'Portrait') {
            $this->config[] = 'orientation Portrait';
        } else {
            $this->config[] = 'orientation Landscape';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOverwriteDefaultFont()

ilWkhtmlToPdfConfig::getOverwriteDefaultFont

(

bool

$renderStyle = false

)

Definition at line 507 of file class.ilWkhtmlToPdfConfig.php.

References $overwrite_default_font.

Referenced by ilWkhtmlToPdfRenderer\appendDefaultFontStyle(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                                                      : string
    {
        if ($renderStyle) {
            if ($this->overwrite_default_font !== '') {
                return '<style>body{font-family: ' . $this->overwrite_default_font . ';}</style>';
            }

            return '';
        }
        if ($this->overwrite_default_font === '') {
            return 'arial';
        }

        return $this->overwrite_default_font;
    }

Here is the caller graph for this function:

getPageSize()

ilWkhtmlToPdfConfig::getPageSize

(

)

Definition at line 247 of file class.ilWkhtmlToPdfConfig.php.

References $page_size.

Referenced by getPageSizeArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                 : string
    {
        return $this->page_size;
    }

Here is the caller graph for this function:

getPageSizeArgument()

ilWkhtmlToPdfConfig::getPageSizeArgument ( )

protected

Definition at line 662 of file class.ilWkhtmlToPdfConfig.php.

References ilShellUtil\escapeShellArg(), and getPageSize().

Referenced by generateCommandLineConfig().

                                            : void
    {
        if ($this->getPageSize() !== '') {
            $this->config[] = 'page-size ' . ilShellUtil::escapeShellArg($this->getPageSize());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPath()

ilWkhtmlToPdfConfig::getPath

(

)

Definition at line 547 of file class.ilWkhtmlToPdfConfig.php.

References $path.

                             : string
    {
        return $this->path;
    }

getPrintMediaType()

ilWkhtmlToPdfConfig::getPrintMediaType

(

)

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

References $print_media_type.

Referenced by getPrintMediaTypeArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                       : bool
    {
        return $this->print_media_type;
    }

Here is the caller graph for this function:

getPrintMediaTypeArgument()

ilWkhtmlToPdfConfig::getPrintMediaTypeArgument ( )

protected

Definition at line 655 of file class.ilWkhtmlToPdfConfig.php.

References getPrintMediaType().

Referenced by generateCommandLineConfig().

                                                  : void
    {
        if ($this->getPrintMediaType()) {
            $this->config[] = 'print-media-type';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRadioButtonCheckedSvg()

ilWkhtmlToPdfConfig::getRadioButtonCheckedSvg

(

)

Definition at line 427 of file class.ilWkhtmlToPdfConfig.php.

References $radio_button_checked_svg.

Referenced by getRadioButtonCheckedSvgArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                              : string
    {
        return $this->radio_button_checked_svg;
    }

Here is the caller graph for this function:

getRadioButtonCheckedSvgArgument()

ilWkhtmlToPdfConfig::getRadioButtonCheckedSvgArgument ( )

protected

Definition at line 700 of file class.ilWkhtmlToPdfConfig.php.

References ilShellUtil\escapeShellArg(), and getRadioButtonCheckedSvg().

Referenced by generateCommandLineConfig().

                                                         : void
    {
        $radio_button_svg = $this->getRadioButtonCheckedSvg();
        if ($radio_button_svg !== '') {
            $this->config[] = 'radiobutton-checked-svg ' . ilShellUtil::escapeShellArg($radio_button_svg);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRadioButtonSvg()

ilWkhtmlToPdfConfig::getRadioButtonSvg

(

)

Definition at line 437 of file class.ilWkhtmlToPdfConfig.php.

References $radio_button_svg.

Referenced by getRadioButtonSvgArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                       : string
    {
        return $this->radio_button_svg;
    }

Here is the caller graph for this function:

getRadioButtonSvgArgument()

ilWkhtmlToPdfConfig::getRadioButtonSvgArgument ( )

protected

Definition at line 692 of file class.ilWkhtmlToPdfConfig.php.

References ilShellUtil\escapeShellArg(), and getRadioButtonSvg().

Referenced by generateCommandLineConfig().

                                                  : void
    {
        $radio_button_svg = $this->getRadioButtonSvg();
        if ($radio_button_svg !== '') {
            $this->config[] = 'radiobutton-svg ' . ilShellUtil::escapeShellArg($radio_button_svg);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSavedDefaultBinaryPath()

ilWkhtmlToPdfConfig::getSavedDefaultBinaryPath ( )

protected

Definition at line 821 of file class.ilWkhtmlToPdfConfig.php.

References $path, and ILIAS\LTI\ToolProvider\$settings.

Referenced by getWKHTMLToPdfDefaultPath().

                                                  : string
    {
        $settings = new ilSetting('wkhtmltopdfrenderer');
        $path = $settings->get('path');
        if ($path !== null && $path !== '') {
            return $path;
        }

        return '';
    }

Here is the caller graph for this function:

getSessionObject()

ilWkhtmlToPdfConfig::getSessionObject ( )

protected

Definition at line 813 of file class.ilWkhtmlToPdfConfig.php.

References CLIENT_ID.

Referenced by generateCommandLineConfig().

                                         : void
    {
        $this->config[] = 'cookie "PHPSESSID" "' . session_id() . '"';
        if (defined('CLIENT_ID')) {
            $this->config[] = 'cookie "ilClientId" "' . CLIENT_ID . '"';
        }
    }

Here is the caller graph for this function:

getWKHTMLToPdfDefaultPath()

ilWkhtmlToPdfConfig::getWKHTMLToPdfDefaultPath

(

)

Definition at line 557 of file class.ilWkhtmlToPdfConfig.php.

References $path, and getSavedDefaultBinaryPath().

Referenced by ilWkhtmlToPdfConfigFormGUI\populateForm().

                                               : string
    {
        $path = $this->getSavedDefaultBinaryPath();
        if ($path !== '') {
            return $path;
        }

        return '/usr/local/bin/wkhtmltopdf';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getZoom()

ilWkhtmlToPdfConfig::getZoom

(

)

Definition at line 187 of file class.ilWkhtmlToPdfConfig.php.

References $zoom.

Referenced by getZoomArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                             : float
    {
        return $this->zoom;
    }

Here is the caller graph for this function:

getZoomArgument()

ilWkhtmlToPdfConfig::getZoomArgument ( )

protected

Definition at line 606 of file class.ilWkhtmlToPdfConfig.php.

References getZoom().

Referenced by generateCommandLineConfig().

                                        : void
    {
        if ($this->getZoom()) {
            $this->config[] = 'zoom ' . $this->getZoom();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFooterHtmlLine()

ilWkhtmlToPdfConfig::isFooterHtmlLine

(

)

Definition at line 357 of file class.ilWkhtmlToPdfConfig.php.

References $footer_html_line.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                      : bool
    {
        return $this->footer_html_line;
    }

Here is the caller graph for this function:

isFooterTextLine()

ilWkhtmlToPdfConfig::isFooterTextLine

(

)

Definition at line 297 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_line.

Referenced by getFooterArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                      : bool
    {
        return $this->footer_text_line;
    }

Here is the caller graph for this function:

isHeaderHtmlLine()

ilWkhtmlToPdfConfig::isHeaderHtmlLine

(

)

Definition at line 770 of file class.ilWkhtmlToPdfConfig.php.

References $header_html_line.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                      : bool
    {
        return $this->header_html_line;
    }

Here is the caller graph for this function:

isHeaderTextLine()

ilWkhtmlToPdfConfig::isHeaderTextLine

(

)

Definition at line 367 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_line.

Referenced by getHeaderArgument(), ilWkhtmlToPdfConfigFormGUI\populateForm(), and readConfigFromObject().

                                      : bool
    {
        return $this->header_text_line;
    }

Here is the caller graph for this function:

readConfigFromArray()

ilWkhtmlToPdfConfig::readConfigFromArray ( array  $config )

protected

Definition at line 82 of file class.ilWkhtmlToPdfConfig.php.

References setKeyIfExists().

Referenced by __construct().

                                                         : void
    {
        $this->setKeyIfExists('setZoom', 'zoom', $config);
        $this->setKeyIfExists('setEnabledForms', 'enable_forms', $config);
        $this->setKeyIfExists('setExternalLinks', 'external_links', $config);
        $this->setKeyIfExists('setLowQuality', 'low_quality', $config);
        $this->setKeyIfExists('setGreyscale', 'greyscale', $config);
        $this->setKeyIfExists('setOrientation', 'orientation', $config);
        $this->setKeyIfExists('setPageSize', 'page_size', $config);
        $this->setKeyIfExists('setMarginLeft', 'margin_left', $config);
        $this->setKeyIfExists('setMarginRight', 'margin_right', $config);
        $this->setKeyIfExists('setFooterHtmlSpacing', 'footer_html_spacing', $config);
        $this->setKeyIfExists('setFooterHtml', 'footer_html', $config);
        $this->setKeyIfExists('setFooterTextLine', 'footer_text_line', $config);
        $this->setKeyIfExists('setFooterTextCenter', 'footer_text_center', $config);
        $this->setKeyIfExists('setFooterTextCenter', 'footer_text_center', $config);
        $this->setKeyIfExists('setFooterTextSpacing', 'footer_text_spacing', $config);
        $this->setKeyIfExists('setFooterTextRight', 'footer_text_right', $config);
        $this->setKeyIfExists('setFooterTextLeft', 'footer_text_left', $config);
        $this->setKeyIfExists('setFooterType', 'footer_select', $config);
        $this->setKeyIfExists('setHeaderHtmlSpacing', 'head_html_spacing', $config);
        $this->setKeyIfExists('setHeaderHtmlLine', 'head_html_line', $config);
        $this->setKeyIfExists('setHeaderHtml', 'head_html', $config);
        $this->setKeyIfExists('setHeaderTextLine', 'head_text_line', $config);
        $this->setKeyIfExists('setHeaderTextSpacing', 'head_text_spacing', $config);
        $this->setKeyIfExists('setHeaderTextRight', 'head_text_right', $config);
        $this->setKeyIfExists('setHeaderTextCenter', 'head_text_center', $config);
        $this->setKeyIfExists('setHeaderTextLeft', 'head_text_left', $config);
        $this->setKeyIfExists('setHeaderType', 'header_select', $config);
        $this->setKeyIfExists('setRadioButtonCheckedSvg', 'radio_button_checked_svg', $config);
        $this->setKeyIfExists('setRadioButtonSvg', 'radio_button_svg', $config);
        $this->setKeyIfExists('setCheckboxCheckedSvg', 'checkbox_checked_svg', $config);
        $this->setKeyIfExists('setCheckboxSvg', 'checkbox_svg', $config);
        $this->setKeyIfExists('setJavascriptDelay', 'javascript_delay', $config);
        $this->setKeyIfExists('setPrintMediaType', 'print_media_type', $config);
        $this->setKeyIfExists('setMarginTop', 'margin_top', $config);
        $this->setKeyIfExists('setMarginBottom', 'margin_bottom', $config);
        $this->setKeyIfExists('setOverwriteDefaultFont', 'overwrite_font', $config);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readConfigFromObject()

ilWkhtmlToPdfConfig::readConfigFromObject ( ilWkhtmlToPdfConfig  $config )

protected

Definition at line 146 of file class.ilWkhtmlToPdfConfig.php.

References getCheckboxCheckedSvg(), getCheckboxSvg(), getEnabledForms(), getExternalLinks(), getFooterHtml(), getFooterHtmlSpacing(), getFooterTextCenter(), getFooterTextLeft(), getFooterTextRight(), getFooterTextSpacing(), getFooterType(), getGreyscale(), getHeaderHtml(), getHeaderHtmlSpacing(), getHeaderTextCenter(), getHeaderTextLeft(), getHeaderTextRight(), getHeaderTextSpacing(), getHeaderType(), getJavascriptDelay(), getLowQuality(), getMarginBottom(), getMarginLeft(), getMarginRight(), getMarginTop(), getOrientation(), getOverwriteDefaultFont(), getPageSize(), getPrintMediaType(), getRadioButtonCheckedSvg(), getRadioButtonSvg(), getZoom(), isFooterHtmlLine(), isFooterTextLine(), isHeaderHtmlLine(), isHeaderTextLine(), setCheckboxCheckedSvg(), setCheckboxSvg(), setEnabledForms(), setExternalLinks(), setFooterHtml(), setFooterHtmlLine(), setFooterHtmlSpacing(), setFooterTextCenter(), setFooterTextLeft(), setFooterTextLine(), setFooterTextRight(), setFooterTextSpacing(), setFooterType(), setGreyscale(), setHeaderHtml(), setHeaderHtmlLine(), setHeaderHtmlSpacing(), setHeaderTextCenter(), setHeaderTextLeft(), setHeaderTextLine(), setHeaderTextRight(), setHeaderTextSpacing(), setHeaderType(), setJavascriptDelay(), setLowQuality(), setMarginBottom(), setMarginLeft(), setMarginRight(), setMarginTop(), setOrientation(), setOverwriteDefaultFont(), setPageSize(), setPrintMediaType(), setRadioButtonCheckedSvg(), setRadioButtonSvg(), and setZoom().

Referenced by __construct().

                                                                        : void
    {
        $this->setZoom($config->getZoom());
        $this->setEnabledForms($config->getEnabledForms());
        $this->setExternalLinks($config->getExternalLinks());
        $this->setLowQuality($config->getLowQuality());
        $this->setGreyscale($config->getGreyscale());
        $this->setOrientation($config->getOrientation());
        $this->setPageSize($config->getPageSize());
        $this->setMarginLeft($config->getMarginLeft());
        $this->setMarginRight($config->getMarginRight());
        $this->setFooterTextLine($config->isFooterTextLine());
        $this->setFooterTextCenter($config->getFooterTextCenter());
        $this->setFooterTextSpacing($config->getFooterTextSpacing());
        $this->setFooterTextRight($config->getFooterTextRight());
        $this->setFooterTextLeft($config->getFooterTextLeft());
        $this->setFooterType($config->getFooterType());

        $this->setFooterHtmlSpacing($config->getFooterHtmlSpacing());
        $this->setFooterHtml($config->getFooterHtml());
        $this->setFooterHtmlLine($config->isFooterHtmlLine());
        $this->setHeaderHtmlSpacing($config->getHeaderHtmlSpacing());
        $this->setHeaderHtml($config->getHeaderHtml());
        $this->setHeaderHtmlLine($config->isHeaderHtmlLine());
        $this->setHeaderTextLine($config->isHeaderTextLine());
        $this->setHeaderTextSpacing($config->getHeaderTextSpacing());
        $this->setHeaderTextRight($config->getHeaderTextRight());
        $this->setHeaderTextCenter($config->getHeaderTextCenter());
        $this->setHeaderTextLeft($config->getHeaderTextLeft());
        $this->setHeaderType($config->getHeaderType());
        $this->setRadioButtonCheckedSvg($config->getRadioButtonCheckedSvg());
        $this->setRadioButtonSvg($config->getRadioButtonSvg());
        $this->setCheckboxCheckedSvg($config->getCheckboxCheckedSvg());
        $this->setCheckboxSvg($config->getCheckboxSvg());
        $this->setJavascriptDelay($config->getJavascriptDelay());
        $this->setPrintMediaType($config->getPrintMediaType());
        $this->setMarginTop($config->getMarginTop());
        $this->setMarginBottom($config->getMarginBottom());
        $this->setOverwriteDefaultFont($config->getOverwriteDefaultFont());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCheckboxCheckedSvg()

ilWkhtmlToPdfConfig::setCheckboxCheckedSvg

(

string

$checkbox_checked_svg

)

Definition at line 452 of file class.ilWkhtmlToPdfConfig.php.

References $checkbox_checked_svg.

Referenced by readConfigFromObject().

                                                                       : void
    {
        $this->checkbox_checked_svg = $checkbox_checked_svg;
    }

Here is the caller graph for this function:

setCheckboxSvg()

ilWkhtmlToPdfConfig::setCheckboxSvg

(

string

$checkbox_svg

)

Definition at line 462 of file class.ilWkhtmlToPdfConfig.php.

References $checkbox_svg.

Referenced by readConfigFromObject().

                                                        : void
    {
        $this->checkbox_svg = $checkbox_svg;
    }

Here is the caller graph for this function:

setEnabledForms()

ilWkhtmlToPdfConfig::setEnabledForms

(

?bool

$enabled_forms

)

Definition at line 202 of file class.ilWkhtmlToPdfConfig.php.

References $enabled_forms.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                         : void
    {
        $this->enabled_forms = $enabled_forms;
    }

Here is the caller graph for this function:

setExternalLinks()

ilWkhtmlToPdfConfig::setExternalLinks

(

bool

$external_links

)

Definition at line 212 of file class.ilWkhtmlToPdfConfig.php.

References $external_links.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                          : void
    {
        $this->external_links = $external_links;
    }

Here is the caller graph for this function:

setFooterHtml()

ilWkhtmlToPdfConfig::setFooterHtml

(

string

$footer_html

)

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

References $footer_html.

Referenced by readConfigFromObject().

                                                      : void
    {
        $this->footer_html = $footer_html;
    }

Here is the caller graph for this function:

setFooterHtmlLine()

ilWkhtmlToPdfConfig::setFooterHtmlLine

(

bool

$footer_html_line

)

Definition at line 362 of file class.ilWkhtmlToPdfConfig.php.

References $footer_html_line.

Referenced by readConfigFromObject().

                                                             : void
    {
        $this->footer_html_line = $footer_html_line;
    }

Here is the caller graph for this function:

setFooterHtmlSpacing()

ilWkhtmlToPdfConfig::setFooterHtmlSpacing

(

int

$footer_html_spacing

)

Definition at line 282 of file class.ilWkhtmlToPdfConfig.php.

References $footer_html_spacing.

Referenced by readConfigFromObject().

                                                                  : void
    {
        $this->footer_html_spacing = $footer_html_spacing;
    }

Here is the caller graph for this function:

setFooterTextCenter()

ilWkhtmlToPdfConfig::setFooterTextCenter

(

string

$footer_text_center

)

Definition at line 312 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_center.

Referenced by readConfigFromObject().

                                                                   : void
    {
        $this->footer_text_center = $footer_text_center;
    }

Here is the caller graph for this function:

setFooterTextLeft()

ilWkhtmlToPdfConfig::setFooterTextLeft

(

string

$footer_text_left

)

Definition at line 342 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_left.

Referenced by readConfigFromObject().

                                                               : void
    {
        $this->footer_text_left = $footer_text_left;
    }

Here is the caller graph for this function:

setFooterTextLine()

ilWkhtmlToPdfConfig::setFooterTextLine

(

bool

$footer_text_line

)

Definition at line 302 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_line.

Referenced by readConfigFromObject().

                                                             : void
    {
        $this->footer_text_line = $footer_text_line;
    }

Here is the caller graph for this function:

setFooterTextRight()

ilWkhtmlToPdfConfig::setFooterTextRight

(

string

$footer_text_right

)

Definition at line 332 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_right.

Referenced by readConfigFromObject().

                                                                 : void
    {
        $this->footer_text_right = $footer_text_right;
    }

Here is the caller graph for this function:

setFooterTextSpacing()

ilWkhtmlToPdfConfig::setFooterTextSpacing

(

int

$footer_text_spacing

)

Definition at line 322 of file class.ilWkhtmlToPdfConfig.php.

References $footer_text_spacing.

Referenced by readConfigFromObject().

                                                                  : void
    {
        $this->footer_text_spacing = $footer_text_spacing;
    }

Here is the caller graph for this function:

setFooterType()

ilWkhtmlToPdfConfig::setFooterType

(

int

$footer_type

)

Definition at line 352 of file class.ilWkhtmlToPdfConfig.php.

References $footer_type.

Referenced by readConfigFromObject().

                                                   : void
    {
        $this->footer_type = $footer_type;
    }

Here is the caller graph for this function:

setGreyscale()

ilWkhtmlToPdfConfig::setGreyscale

(

bool

$greyscale

)

Definition at line 232 of file class.ilWkhtmlToPdfConfig.php.

References $greyscale.

Referenced by readConfigFromObject().

                                                 : void
    {
        $this->greyscale = $greyscale;
    }

Here is the caller graph for this function:

setHeaderHtml()

ilWkhtmlToPdfConfig::setHeaderHtml

(

string

$header_html

)

Definition at line 755 of file class.ilWkhtmlToPdfConfig.php.

References $header_html.

Referenced by readConfigFromObject().

                                                      : void
    {
        $this->header_html = $header_html;
    }

Here is the caller graph for this function:

setHeaderHtmlLine()

ilWkhtmlToPdfConfig::setHeaderHtmlLine

(

bool

$header_html_line

)

Definition at line 775 of file class.ilWkhtmlToPdfConfig.php.

References $header_html_line.

Referenced by readConfigFromObject().

                                                             : void
    {
        $this->header_html_line = $header_html_line;
    }

Here is the caller graph for this function:

setHeaderHtmlSpacing()

ilWkhtmlToPdfConfig::setHeaderHtmlSpacing

(

int

$header_html_spacing

)

Definition at line 765 of file class.ilWkhtmlToPdfConfig.php.

References $header_html_spacing.

Referenced by readConfigFromObject().

                                                                  : void
    {
        $this->header_html_spacing = $header_html_spacing;
    }

Here is the caller graph for this function:

setHeaderTextCenter()

ilWkhtmlToPdfConfig::setHeaderTextCenter

(

string

$header_text_center

)

Definition at line 402 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_center.

Referenced by readConfigFromObject().

                                                                   : void
    {
        $this->header_text_center = $header_text_center;
    }

Here is the caller graph for this function:

setHeaderTextLeft()

ilWkhtmlToPdfConfig::setHeaderTextLeft

(

string

$header_text_left

)

Definition at line 412 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_left.

Referenced by readConfigFromObject().

                                                               : void
    {
        $this->header_text_left = $header_text_left;
    }

Here is the caller graph for this function:

setHeaderTextLine()

ilWkhtmlToPdfConfig::setHeaderTextLine

(

bool

$header_text_line

)

Definition at line 372 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_line.

Referenced by readConfigFromObject().

                                                             : void
    {
        $this->header_text_line = $header_text_line;
    }

Here is the caller graph for this function:

setHeaderTextRight()

ilWkhtmlToPdfConfig::setHeaderTextRight

(

string

$header_text_right

)

Definition at line 392 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_right.

Referenced by readConfigFromObject().

                                                                 : void
    {
        $this->header_text_right = $header_text_right;
    }

Here is the caller graph for this function:

setHeaderTextSpacing()

ilWkhtmlToPdfConfig::setHeaderTextSpacing

(

int

$header_text_spacing

)

Definition at line 382 of file class.ilWkhtmlToPdfConfig.php.

References $header_text_spacing.

Referenced by readConfigFromObject().

                                                                  : void
    {
        $this->header_text_spacing = $header_text_spacing;
    }

Here is the caller graph for this function:

setHeaderType()

ilWkhtmlToPdfConfig::setHeaderType

(

int

$header_type

)

Definition at line 422 of file class.ilWkhtmlToPdfConfig.php.

References $header_type.

Referenced by readConfigFromObject().

                                                   : void
    {
        $this->header_type = $header_type;
    }

Here is the caller graph for this function:

setJavascriptDelay()

ilWkhtmlToPdfConfig::setJavascriptDelay

(

int

$javascript_delay

)

Definition at line 472 of file class.ilWkhtmlToPdfConfig.php.

References $javascript_delay.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                             : void
    {
        $this->javascript_delay = $javascript_delay;
    }

Here is the caller graph for this function:

setKeyIfExists()

ilWkhtmlToPdfConfig::setKeyIfExists ( string  $function, string  $key, array  $config  )

protected

Parameters

string	$function
string	$key
	array<string,mixed>	$config

Returns

void

Definition at line 128 of file class.ilWkhtmlToPdfConfig.php.

References ILIAS\LTI\ToolProvider\$key, and $type.

Referenced by readConfigFromArray().

                                                                                   : void
    {
        if (array_key_exists($key, $config)) {
            $value = $config[$key];

            if (is_scalar($value)) {
                $reflMethod = new ReflectionMethod($this, $function);
                $type = $reflMethod->getParameters()[0]->getType();
                if ($type instanceof ReflectionNamedType && $type->isBuiltin()) {
                    settype($value, $type->getName());
                }
            }
            if ($value != null) {
                $this->{$function}($value);
            }
        }
    }

Here is the caller graph for this function:

setLowQuality()

ilWkhtmlToPdfConfig::setLowQuality

(

bool

$low_quality

)

Definition at line 222 of file class.ilWkhtmlToPdfConfig.php.

References $low_quality.

Referenced by readConfigFromObject().

                                                    : void
    {
        $this->low_quality = $low_quality;
    }

Here is the caller graph for this function:

setMarginBottom()

ilWkhtmlToPdfConfig::setMarginBottom

(

string

$margin_bottom

)

Definition at line 502 of file class.ilWkhtmlToPdfConfig.php.

References $margin_bottom.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                          : void
    {
        $this->margin_bottom = $margin_bottom;
    }

Here is the caller graph for this function:

setMarginLeft()

ilWkhtmlToPdfConfig::setMarginLeft

(

string

$margin_left

)

Definition at line 262 of file class.ilWkhtmlToPdfConfig.php.

References $margin_left.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                      : void
    {
        $this->margin_left = $margin_left;
    }

Here is the caller graph for this function:

setMarginRight()

ilWkhtmlToPdfConfig::setMarginRight

(

string

$margin_right

)

Definition at line 272 of file class.ilWkhtmlToPdfConfig.php.

References $margin_right.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                        : void
    {
        $this->margin_right = $margin_right;
    }

Here is the caller graph for this function:

setMarginTop()

ilWkhtmlToPdfConfig::setMarginTop

(

string

$margin_top

)

Definition at line 492 of file class.ilWkhtmlToPdfConfig.php.

References $margin_top.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                    : void
    {
        $this->margin_top = $margin_top;
    }

Here is the caller graph for this function:

setOrientation()

ilWkhtmlToPdfConfig::setOrientation

(

string

$orientation

)

Definition at line 242 of file class.ilWkhtmlToPdfConfig.php.

References $orientation.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                       : void
    {
        $this->orientation = $orientation;
    }

Here is the caller graph for this function:

setOverwriteDefaultFont()

ilWkhtmlToPdfConfig::setOverwriteDefaultFont

(

string

$overwrite_default_font

)

Definition at line 523 of file class.ilWkhtmlToPdfConfig.php.

References $overwrite_default_font.

Referenced by readConfigFromObject().

                                                                           : void
    {
        $this->overwrite_default_font = $overwrite_default_font;
    }

Here is the caller graph for this function:

setPageSize()

ilWkhtmlToPdfConfig::setPageSize

(

string

$page_size

)

Definition at line 252 of file class.ilWkhtmlToPdfConfig.php.

References $page_size.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                                  : void
    {
        $this->page_size = $page_size;
    }

Here is the caller graph for this function:

setPath()

ilWkhtmlToPdfConfig::setPath

(

string

$path

)

Definition at line 552 of file class.ilWkhtmlToPdfConfig.php.

References $path.

                                         : void
    {
        $this->path = $path;
    }

setPrintMediaType()

ilWkhtmlToPdfConfig::setPrintMediaType

(

bool

$print_media_type

)

Definition at line 482 of file class.ilWkhtmlToPdfConfig.php.

References $print_media_type.

Referenced by readConfigFromObject().

                                                             : void
    {
        $this->print_media_type = $print_media_type;
    }

Here is the caller graph for this function:

setRadioButtonCheckedSvg()

ilWkhtmlToPdfConfig::setRadioButtonCheckedSvg

(

string

$radio_button_checked_svg

)

Definition at line 432 of file class.ilWkhtmlToPdfConfig.php.

References $radio_button_checked_svg.

Referenced by readConfigFromObject().

                                                                              : void
    {
        $this->radio_button_checked_svg = $radio_button_checked_svg;
    }

Here is the caller graph for this function:

setRadioButtonSvg()

ilWkhtmlToPdfConfig::setRadioButtonSvg

(

string

$radio_button_svg

)

Definition at line 442 of file class.ilWkhtmlToPdfConfig.php.

References $radio_button_svg.

Referenced by readConfigFromObject().

                                                               : void
    {
        $this->radio_button_svg = $radio_button_svg;
    }

Here is the caller graph for this function:

setZoom()

ilWkhtmlToPdfConfig::setZoom

(

float

$zoom

)

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

References $zoom.

Referenced by readConfigFromObject(), and useDefaultConfig().

                                        : void
    {
        $this->zoom = $zoom;
    }

Here is the caller graph for this function:

supportMultiSourcesFiles()

static ilWkhtmlToPdfConfig::supportMultiSourcesFiles ( )

static

Definition at line 542 of file class.ilWkhtmlToPdfConfig.php.

                                                     : bool
    {
        return true;
    }

useDefaultConfig()

ilWkhtmlToPdfConfig::useDefaultConfig ( )

protected

Definition at line 528 of file class.ilWkhtmlToPdfConfig.php.

References setEnabledForms(), setExternalLinks(), setJavascriptDelay(), setMarginBottom(), setMarginLeft(), setMarginRight(), setMarginTop(), setOrientation(), setPageSize(), and setZoom().

Referenced by __construct().

                                         : void
    {
        $this->setExternalLinks(true);
        $this->setEnabledForms(false);
        $this->setJavascriptDelay(500);
        $this->setZoom(1);
        $this->setOrientation('Portrait');
        $this->setPageSize('A4');
        $this->setMarginLeft('0.5cm');
        $this->setMarginRight('2cm');
        $this->setMarginBottom('0.5cm');
        $this->setMarginTop('2cm');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$checkbox_checked_svg

string ilWkhtmlToPdfConfig::$checkbox_checked_svg = ''

protected

Definition at line 62 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getCheckboxCheckedSvg(), and setCheckboxCheckedSvg().

$checkbox_svg

string ilWkhtmlToPdfConfig::$checkbox_svg = ''

protected

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

Referenced by getCheckboxSvg(), and setCheckboxSvg().

$config

array ilWkhtmlToPdfConfig::$config = []

protected

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

Referenced by getConfig().

$enabled_forms

bool ilWkhtmlToPdfConfig::$enabled_forms = false

protected

Definition at line 32 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getEnabledForms(), and setEnabledForms().

$external_links

bool ilWkhtmlToPdfConfig::$external_links = false

protected

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

Referenced by getExternalLinks(), and setExternalLinks().

$footer_html

string ilWkhtmlToPdfConfig::$footer_html = ''

protected

Definition at line 58 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getFooterHtml(), and setFooterHtml().

$footer_html_line

bool ilWkhtmlToPdfConfig::$footer_html_line = false

protected

Definition at line 60 of file class.ilWkhtmlToPdfConfig.php.

Referenced by isFooterHtmlLine(), and setFooterHtmlLine().

$footer_html_spacing

int ilWkhtmlToPdfConfig::$footer_html_spacing = 0

protected

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

Referenced by getFooterHtmlSpacing(), and setFooterHtmlSpacing().

$footer_text_center

string ilWkhtmlToPdfConfig::$footer_text_center = ''

protected

Definition at line 54 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getFooterTextCenter(), and setFooterTextCenter().

$footer_text_left

string ilWkhtmlToPdfConfig::$footer_text_left = ''

protected

Definition at line 53 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getFooterTextLeft(), and setFooterTextLeft().

$footer_text_line

bool ilWkhtmlToPdfConfig::$footer_text_line = false

protected

Definition at line 57 of file class.ilWkhtmlToPdfConfig.php.

Referenced by isFooterTextLine(), and setFooterTextLine().

$footer_text_right

string ilWkhtmlToPdfConfig::$footer_text_right = ''

protected

Definition at line 55 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getFooterTextRight(), and setFooterTextRight().

$footer_text_spacing

int ilWkhtmlToPdfConfig::$footer_text_spacing = 0

protected

Definition at line 56 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getFooterTextSpacing(), and setFooterTextSpacing().

$footer_type

int ilWkhtmlToPdfConfig::$footer_type = 0

protected

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

Referenced by getFooterType(), and setFooterType().

$greyscale

bool ilWkhtmlToPdfConfig::$greyscale = false

protected

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

Referenced by getGreyscale(), and setGreyscale().

$header_html

string ilWkhtmlToPdfConfig::$header_html = ''

protected

Definition at line 49 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getHeaderHtml(), and setHeaderHtml().

$header_html_line

bool ilWkhtmlToPdfConfig::$header_html_line = false

protected

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

Referenced by isHeaderHtmlLine(), and setHeaderHtmlLine().

$header_html_spacing

int ilWkhtmlToPdfConfig::$header_html_spacing = 0

protected

Definition at line 50 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getHeaderHtmlSpacing(), and setHeaderHtmlSpacing().

$header_text_center

string ilWkhtmlToPdfConfig::$header_text_center = ''

protected

Definition at line 45 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getHeaderTextCenter(), and setHeaderTextCenter().

$header_text_left

string ilWkhtmlToPdfConfig::$header_text_left = ''

protected

Definition at line 44 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getHeaderTextLeft(), and setHeaderTextLeft().

$header_text_line

bool ilWkhtmlToPdfConfig::$header_text_line = false

protected

Definition at line 48 of file class.ilWkhtmlToPdfConfig.php.

Referenced by isHeaderTextLine(), and setHeaderTextLine().

$header_text_right

string ilWkhtmlToPdfConfig::$header_text_right = ''

protected

Definition at line 46 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getHeaderTextRight(), and setHeaderTextRight().

$header_text_spacing

int ilWkhtmlToPdfConfig::$header_text_spacing = 0

protected

Definition at line 47 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getHeaderTextSpacing(), and setHeaderTextSpacing().

$header_type

int ilWkhtmlToPdfConfig::$header_type = 0

protected

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

Referenced by getHeaderType(), and setHeaderType().

$javascript_delay

int ilWkhtmlToPdfConfig::$javascript_delay = 100

protected

Definition at line 38 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getJavascriptDelay(), and setJavascriptDelay().

$low_quality

bool ilWkhtmlToPdfConfig::$low_quality = false

protected

Definition at line 34 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getLowQuality(), and setLowQuality().

$margin_bottom

string ilWkhtmlToPdfConfig::$margin_bottom = ''

protected

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

Referenced by getMarginBottom(), and setMarginBottom().

$margin_left

string ilWkhtmlToPdfConfig::$margin_left = ''

protected

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

Referenced by getMarginLeft(), and setMarginLeft().

$margin_right

string ilWkhtmlToPdfConfig::$margin_right = ''

protected

Definition at line 40 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getMarginRight(), and setMarginRight().

$margin_top

string ilWkhtmlToPdfConfig::$margin_top = ''

protected

Definition at line 41 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getMarginTop(), and setMarginTop().

$orientation

string ilWkhtmlToPdfConfig::$orientation = 'Portrait'

protected

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

Referenced by getOrientation(), and setOrientation().

$overwrite_default_font

string ilWkhtmlToPdfConfig::$overwrite_default_font = 'arial'

protected

Definition at line 66 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getOverwriteDefaultFont(), and setOverwriteDefaultFont().

$page_size

string ilWkhtmlToPdfConfig::$page_size = 'A4'

protected

Definition at line 37 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getPageSize(), and setPageSize().

$path

string ilWkhtmlToPdfConfig::$path = ''

protected

Definition at line 65 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getPath(), getSavedDefaultBinaryPath(), getWKHTMLToPdfDefaultPath(), and setPath().

$phpunit

bool ilWkhtmlToPdfConfig::$phpunit = false

protected

Definition at line 28 of file class.ilWkhtmlToPdfConfig.php.

$print_media_type

bool ilWkhtmlToPdfConfig::$print_media_type = false

protected

Definition at line 36 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getPrintMediaType(), and setPrintMediaType().

$radio_button_checked_svg

string ilWkhtmlToPdfConfig::$radio_button_checked_svg = ''

protected

Definition at line 64 of file class.ilWkhtmlToPdfConfig.php.

Referenced by getRadioButtonCheckedSvg(), and setRadioButtonCheckedSvg().

$radio_button_svg

string ilWkhtmlToPdfConfig::$radio_button_svg = ''

protected

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

Referenced by getRadioButtonSvg(), and setRadioButtonSvg().

$zoom

float ilWkhtmlToPdfConfig::$zoom = 1.0

protected

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

Referenced by getZoom(), and setZoom().

ENABLE_QUIET

const ilWkhtmlToPdfConfig::ENABLE_QUIET = true

private

Definition at line 26 of file class.ilWkhtmlToPdfConfig.php.

---

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

• Services/PDFGeneration/classes/renderer/wkhtmltopdf/class.ilWkhtmlToPdfConfig.php