Collaboration diagram for ilWkhtmlToPdfConfig:

Public Member Functions
	__construct ($config=null)
	ilWkhtmlToPdfConfig constructor. More...

	getZoom ()

	setZoom ($zoom)

	getEnabledForms ()

	setEnabledForms ($enabled_forms)

	getExternalLinks ()

	setExternalLinks ($external_links)

	getUserStylesheet ()

	setUserStylesheet ($user_stylesheet)

	getLowQuality ()

	setLowQuality ($low_quality)

	getGreyscale ()

	setGreyscale ($greyscale)

	getOrientation ()

	setOrientation ($orientation)

	getPageSize ()

	setPageSize ($page_size)

	getMarginLeft ()

	setMarginLeft ($margin_left)

	getMarginRight ()

	setMarginRight ($margin_right)

	getFooterHtmlSpacing ()

	setFooterHtmlSpacing ($footer_html_spacing)

	getFooterHtml ()

	setFooterHtml ($footer_html)

	isFooterTextLine ()

	setFooterTextLine ($footer_text_line)

	getFooterTextCenter ()

	setFooterTextCenter ($footer_text_center)

	getFooterTextSpacing ()

	setFooterTextSpacing ($footer_text_spacing)

	getFooterTextRight ()

	setFooterTextRight ($footer_text_right)

	getFooterTextLeft ()

	setFooterTextLeft ($footer_text_left)

	getFooterType ()

	setFooterType ($footer_type)

	isFooterHtmlLine ()

	setFooterHtmlLine ($footer_html_line)

	isHeaderTextLine ()

	setHeaderTextLine ($header_text_line)

	getHeaderTextSpacing ()

	setHeaderTextSpacing ($header_text_spacing)

	getHeaderTextRight ()

	setHeaderTextRight ($header_text_right)

	getHeaderTextCenter ()

	setHeaderTextCenter ($header_text_center)

	getHeaderTextLeft ()

	setHeaderTextLeft ($header_text_left)

	getHeaderType ()

	setHeaderType ($header_type)

	getRadioButtonCheckedSvg ()

	setRadioButtonCheckedSvg ($radio_button_checked_svg)

	getRadioButtonSvg ()

	setRadioButtonSvg ($radio_button_svg)

	getCheckboxCheckedSvg ()

	setCheckboxCheckedSvg ($checkbox_checked_svg)

	getCheckboxSvg ()

	setCheckboxSvg ($checkbox_svg)

	getJavascriptDelay ()

	setJavascriptDelay ($javascript_delay)

	getPrintMediaType ()

	setPrintMediaType ($print_media_type)

	getMarginTop ()

	setMarginTop ($margin_top)

	getMarginBottom ()

	setMarginBottom ($margin_bottom)

	getOverwriteDefaultFont ($renderStyle=false)

	setOverwriteDefaultFont ($overwrite_default_font)

	getPath ()

	setPath ($path)

	getWKHTMLToPdfDefaultPath ()

	getConfig ()

	getCommandLineConfig ()

	getHeaderHtml ()

	setHeaderHtml ($header_html)

	getHeaderHtmlSpacing ()

	setHeaderHtmlSpacing ($header_html_spacing)

	isHeaderHtmlLine ()

	setHeaderHtmlLine ($header_html_line)

Static Public Member Functions
static	supportMultiSourcesFiles ()

Data Fields
const	ENABLE_QUIET = true

Protected Member Functions
	readConfigFromArray ($config)

	setKeyIfExists ($function, $key, $config)

	readConfigFromObject ($config)

	useDefaultConfig ()

	generateCommandLineConfig ()

	getZoomArgument ()

	getExternalLinksArgument ()

	getEnabledFormsArgument ()

	getUserStylesheetArgument ()

	getGreyscaleArgument ()

	getLowQualityArgument ()

	getOrientationArgument ()

	getPrintMediaTypeArgument ()

	getPageSizeArgument ()

	getJavascriptDelayArgument ()

	getCheckboxSvgArgument ()

	getCheckboxCheckedSvgArgument ()

	getRadioButtonSvgArgument ()

	getRadioButtonCheckedSvgArgument ()

	getMarginArgument ()

	getHeaderArgument ()

	getFooterArgument ()

	getDebugArgument ()

	getSessionObject ()

	getSavedDefaultBinaryPath ()

Protected Attributes
	$phpunit = false

	$config = array()

	$zoom

	$external_links

	$enabled_forms

	$user_stylesheet

	$greyscale

	$low_quality

	$orientation

	$print_media_type

	$page_size

	$javascript_delay

	$margin_left

	$margin_right

	$margin_top

	$margin_bottom

	$header_type

	$header_text_left

	$header_text_center

	$header_text_right

	$header_text_spacing

	$header_text_line

	$header_html

	$header_html_spacing

	$header_html_line

	$footer_type

	$footer_text_left

	$footer_text_center

	$footer_text_right

	$footer_text_spacing

	$footer_text_line

	$footer_html

	$footer_html_spacing

	$footer_html_line

	$checkbox_svg

	$checkbox_checked_svg

	$radio_button_svg

	$radio_button_checked_svg

	$path

	$overwrite_default_font = ''

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilWkhtmlToPdfConfig::__construct ( $config = null )

ilWkhtmlToPdfConfig constructor.

Parameters

null $config

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

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

     {
         if ($config != null && !$config instanceof ilWkhtmlToPdfConfig) {
             $this->readConfigFromArray($config);
         } else {
             if ($config instanceof ilWkhtmlToPdfConfig) {
                 $this->readConfigFromObject($config);
             } else {
                 $this->useDefaultConfig();
             }
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ generateCommandLineConfig()

ilWkhtmlToPdfConfig::generateCommandLineConfig ( )

protected

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

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

Referenced by getCommandLineConfig().

     {
         $this->getZoomArgument();
         $this->getExternalLinksArgument();
         $this->getEnabledFormsArgument();
         $this->getUserStylesheetArgument();
         $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 ( )

Returns: string

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

References $checkbox_checked_svg.

Referenced by getCheckboxCheckedSvgArgument().

     {
         return $this->checkbox_checked_svg;
     }

Here is the caller graph for this function:

◆ getCheckboxCheckedSvgArgument()

ilWkhtmlToPdfConfig::getCheckboxCheckedSvgArgument ( )

protected

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

References $checkbox_svg, and getCheckboxCheckedSvg().

Referenced by generateCommandLineConfig().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCheckboxSvg()

ilWkhtmlToPdfConfig::getCheckboxSvg ( )

Returns: string

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

References $checkbox_svg.

Referenced by getCheckboxSvgArgument().

     {
         return $this->checkbox_svg;
     }

Here is the caller graph for this function:

◆ getCheckboxSvgArgument()

ilWkhtmlToPdfConfig::getCheckboxSvgArgument ( )

protected

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

References $checkbox_svg, and getCheckboxSvg().

Referenced by generateCommandLineConfig().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommandLineConfig()

ilWkhtmlToPdfConfig::getCommandLineConfig ( )

Returns: string

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

References generateCommandLineConfig().

     {
         $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 888 of file class.ilWkhtmlToPdfConfig.php.

References $config.

     {
         return $this->config;
     }

◆ getDebugArgument()

ilWkhtmlToPdfConfig::getDebugArgument ( )

protected

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

Referenced by generateCommandLineConfig().

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

Here is the caller graph for this function:

◆ getEnabledForms()

ilWkhtmlToPdfConfig::getEnabledForms ( )

Returns: bool

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

References $enabled_forms.

Referenced by getEnabledFormsArgument().

     {
         return $this->enabled_forms;
     }

Here is the caller graph for this function:

◆ getEnabledFormsArgument()

ilWkhtmlToPdfConfig::getEnabledFormsArgument ( )

protected

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

References getEnabledForms().

Referenced by generateCommandLineConfig().

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

Returns: bool

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

References $external_links.

Referenced by getExternalLinksArgument().

     {
         return $this->external_links;
     }

Here is the caller graph for this function:

◆ getExternalLinksArgument()

ilWkhtmlToPdfConfig::getExternalLinksArgument ( )

protected

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

References getExternalLinks().

Referenced by generateCommandLineConfig().

     {
         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 1131 of file class.ilWkhtmlToPdfConfig.php.

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

Referenced by generateCommandLineConfig().

     {
         $footer_value = $this->getFooterType();
         if ($footer_value == ilPDFGenerationConstants::FOOTER_TEXT) {
             $this->config[] = 'footer-left "' . $this->getFooterTextLeft() . '"';
             $this->config[] = 'footer-center "' . $this->getFooterTextCenter() . '"';
             $this->config[] = 'footer-right "' . $this->getFooterTextRight() . '"';
             if ($this->getFooterTextSpacing() != '') {
                 $this->config[] = 'footer-spacing ' . $this->getFooterTextSpacing();
             }
 
             if ($this->isFooterTextLine()) {
                 $this->config[] = 'footer-line';
             }
         } else {
             if ($footer_value == ilPDFGenerationConstants::FOOTER_HTML) {
                 $this->config[] = 'footer-html "' . $this->getFooterHtml() . '"';
 
                 if ($this->getFooterHtmlSpacing() != '') {
                     $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 ( )

Returns: string

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

References $footer_html.

Referenced by getFooterArgument().

     {
         return $this->footer_html;
     }

Here is the caller graph for this function:

◆ getFooterHtmlSpacing()

ilWkhtmlToPdfConfig::getFooterHtmlSpacing ( )

Returns: int

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

References $footer_html_spacing.

Referenced by getFooterArgument().

     {
         return $this->footer_html_spacing;
     }

Here is the caller graph for this function:

◆ getFooterTextCenter()

ilWkhtmlToPdfConfig::getFooterTextCenter ( )

Returns: string

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

References $footer_text_center.

Referenced by getFooterArgument().

     {
         return $this->footer_text_center;
     }

Here is the caller graph for this function:

◆ getFooterTextLeft()

ilWkhtmlToPdfConfig::getFooterTextLeft ( )

Returns: string

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

References $footer_text_left.

Referenced by getFooterArgument().

     {
         return $this->footer_text_left;
     }

Here is the caller graph for this function:

◆ getFooterTextRight()

ilWkhtmlToPdfConfig::getFooterTextRight ( )

Returns: string

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

References $footer_text_right.

Referenced by getFooterArgument().

     {
         return $this->footer_text_right;
     }

Here is the caller graph for this function:

◆ getFooterTextSpacing()

ilWkhtmlToPdfConfig::getFooterTextSpacing ( )

Returns: int

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

References $footer_text_spacing.

Referenced by getFooterArgument().

     {
         return $this->footer_text_spacing;
     }

Here is the caller graph for this function:

◆ getFooterType()

ilWkhtmlToPdfConfig::getFooterType ( )

Returns: int

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

References $footer_type.

Referenced by getFooterArgument().

     {
         return $this->footer_type;
     }

Here is the caller graph for this function:

◆ getGreyscale()

ilWkhtmlToPdfConfig::getGreyscale ( )

Returns: bool

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

References $greyscale.

Referenced by getGreyscaleArgument().

     {
         return $this->greyscale;
     }

Here is the caller graph for this function:

◆ getGreyscaleArgument()

ilWkhtmlToPdfConfig::getGreyscaleArgument ( )

protected

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

References getGreyscale().

Referenced by generateCommandLineConfig().

     {
         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 1055 of file class.ilWkhtmlToPdfConfig.php.

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

Referenced by generateCommandLineConfig().

     {
         $header_value = $this->getHeaderType();
         if ($header_value == ilPDFGenerationConstants::HEADER_TEXT) {
             $this->config[] = 'header-left "' . $this->getHeaderTextLeft() . '"';
             $this->config[] = 'header-center "' . $this->getHeaderTextCenter() . '"';
             $this->config[] = 'header-right "' . $this->getHeaderTextRight() . '"';
             if ($this->getHeaderTextSpacing() != '') {
                 $this->config[] = 'header-spacing ' . $this->getHeaderTextSpacing();
             }
 
             if ($this->isHeaderTextLine()) {
                 $this->config[] = 'header-line';
             }
         } else {
             if ($header_value == ilPDFGenerationConstants::HEADER_HTML) {
                 $this->config[] = 'header-html "' . $this->getHeaderHtml() . '"';
 
                 if ($this->getHeaderHtmlSpacing() != '') {
                     $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 ( )

Returns: string

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

References $header_html.

Referenced by getHeaderArgument().

     {
         return $this->header_html;
     }

Here is the caller graph for this function:

◆ getHeaderHtmlSpacing()

ilWkhtmlToPdfConfig::getHeaderHtmlSpacing ( )

Returns: int

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

References $header_html_spacing.

Referenced by getHeaderArgument().

     {
         return $this->header_html_spacing;
     }

Here is the caller graph for this function:

◆ getHeaderTextCenter()

ilWkhtmlToPdfConfig::getHeaderTextCenter ( )

Returns: string

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

References $header_text_center.

Referenced by getHeaderArgument().

     {
         return $this->header_text_center;
     }

Here is the caller graph for this function:

◆ getHeaderTextLeft()

ilWkhtmlToPdfConfig::getHeaderTextLeft ( )

Returns: string

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

References $header_text_left.

Referenced by getHeaderArgument().

     {
         return $this->header_text_left;
     }

Here is the caller graph for this function:

◆ getHeaderTextRight()

ilWkhtmlToPdfConfig::getHeaderTextRight ( )

Returns: string

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

References $header_text_right.

Referenced by getHeaderArgument().

     {
         return $this->header_text_right;
     }

Here is the caller graph for this function:

◆ getHeaderTextSpacing()

ilWkhtmlToPdfConfig::getHeaderTextSpacing ( )

Returns: int

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

References $header_text_spacing.

Referenced by getHeaderArgument().

     {
         return $this->header_text_spacing;
     }

Here is the caller graph for this function:

◆ getHeaderType()

ilWkhtmlToPdfConfig::getHeaderType ( )

Returns: int

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

References $header_type.

Referenced by getHeaderArgument().

     {
         return $this->header_type;
     }

Here is the caller graph for this function:

◆ getJavascriptDelay()

ilWkhtmlToPdfConfig::getJavascriptDelay ( )

Returns: string

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

References $javascript_delay.

Referenced by getJavascriptDelayArgument().

     {
         return $this->javascript_delay;
     }

Here is the caller graph for this function:

◆ getJavascriptDelayArgument()

ilWkhtmlToPdfConfig::getJavascriptDelayArgument ( )

protected

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

References getJavascriptDelay().

Referenced by generateCommandLineConfig().

     {
         if ($this->getJavascriptDelay() != '') {
             $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 ( )

Returns: bool

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

References $low_quality.

Referenced by getLowQualityArgument().

     {
         return $this->low_quality;
     }

Here is the caller graph for this function:

◆ getLowQualityArgument()

ilWkhtmlToPdfConfig::getLowQualityArgument ( )

protected

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

References getLowQuality().

Referenced by generateCommandLineConfig().

     {
         if ($this->getLowQuality() == 1 || $this->getLowQuality() == true) {
             $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 1039 of file class.ilWkhtmlToPdfConfig.php.

References getMarginBottom(), getMarginLeft(), getMarginRight(), and getMarginTop().

Referenced by generateCommandLineConfig().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMarginBottom()

ilWkhtmlToPdfConfig::getMarginBottom ( )

Returns: string

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

References $margin_bottom.

Referenced by getMarginArgument().

     {
         return $this->margin_bottom;
     }

Here is the caller graph for this function:

◆ getMarginLeft()

ilWkhtmlToPdfConfig::getMarginLeft ( )

Returns: string

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

References $margin_left.

Referenced by getMarginArgument().

     {
         return $this->margin_left;
     }

Here is the caller graph for this function:

◆ getMarginRight()

ilWkhtmlToPdfConfig::getMarginRight ( )

Returns: string

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

References $margin_right.

Referenced by getMarginArgument().

     {
         return $this->margin_right;
     }

Here is the caller graph for this function:

◆ getMarginTop()

ilWkhtmlToPdfConfig::getMarginTop ( )

Returns: string

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

References $margin_top.

Referenced by getMarginArgument().

     {
         return $this->margin_top;
     }

Here is the caller graph for this function:

◆ getOrientation()

ilWkhtmlToPdfConfig::getOrientation ( )

Returns: string

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

References $orientation.

Referenced by getOrientationArgument().

     {
         return $this->orientation;
     }

Here is the caller graph for this function:

◆ getOrientationArgument()

ilWkhtmlToPdfConfig::getOrientationArgument ( )

protected

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

References $orientation, and getOrientation().

Referenced by generateCommandLineConfig().

     {
         $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 ( $renderStyle = false )

Parameters

bool $renderStyle

Returns: string

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

References $overwrite_default_font.

     {
         if ($renderStyle) {
             if (strlen($this->overwrite_default_font) > 0) {
                 return '<style>body{font-family: ' . $this->overwrite_default_font . ';}</style>';
             }
         } else {
             return $this->overwrite_default_font;
         }
 
         return '';
     }

◆ getPageSize()

ilWkhtmlToPdfConfig::getPageSize ( )

Returns: string

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

References $page_size.

Referenced by getPageSizeArgument().

     {
         return $this->page_size;
     }

Here is the caller graph for this function:

◆ getPageSizeArgument()

ilWkhtmlToPdfConfig::getPageSizeArgument ( )

protected

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

References getPageSize().

Referenced by generateCommandLineConfig().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPath()

ilWkhtmlToPdfConfig::getPath ( )

Returns: string

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

References $path.

     {
         return $this->path;
     }

◆ getPrintMediaType()

ilWkhtmlToPdfConfig::getPrintMediaType ( )

Returns: bool

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

References $print_media_type.

Referenced by getPrintMediaTypeArgument().

     {
         return $this->print_media_type;
     }

Here is the caller graph for this function:

◆ getPrintMediaTypeArgument()

ilWkhtmlToPdfConfig::getPrintMediaTypeArgument ( )

protected

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

References getPrintMediaType().

Referenced by generateCommandLineConfig().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRadioButtonCheckedSvg()

ilWkhtmlToPdfConfig::getRadioButtonCheckedSvg ( )

Returns: string

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

References $radio_button_checked_svg.

Referenced by getRadioButtonCheckedSvgArgument().

     {
         return $this->radio_button_checked_svg;
     }

Here is the caller graph for this function:

◆ getRadioButtonCheckedSvgArgument()

ilWkhtmlToPdfConfig::getRadioButtonCheckedSvgArgument ( )

protected

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

References $radio_button_svg, and getRadioButtonCheckedSvg().

Referenced by generateCommandLineConfig().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRadioButtonSvg()

ilWkhtmlToPdfConfig::getRadioButtonSvg ( )

Returns: string

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

References $radio_button_svg.

Referenced by getRadioButtonSvgArgument().

     {
         return $this->radio_button_svg;
     }

Here is the caller graph for this function:

◆ getRadioButtonSvgArgument()

ilWkhtmlToPdfConfig::getRadioButtonSvgArgument ( )

protected

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

References $radio_button_svg, and getRadioButtonSvg().

Referenced by generateCommandLineConfig().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSavedDefaultBinaryPath()

ilWkhtmlToPdfConfig::getSavedDefaultBinaryPath ( )

protected

Returns: string

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

References $path.

Referenced by getWKHTMLToPdfDefaultPath().

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

Here is the caller graph for this function:

◆ getSessionObject()

ilWkhtmlToPdfConfig::getSessionObject ( )

protected

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

References CLIENT_ID.

Referenced by generateCommandLineConfig().

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

Here is the caller graph for this function:

◆ getUserStylesheet()

ilWkhtmlToPdfConfig::getUserStylesheet ( )

Returns: string

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

References $user_stylesheet.

Referenced by getUserStylesheetArgument().

     {
         return $this->user_stylesheet;
     }

Here is the caller graph for this function:

◆ getUserStylesheetArgument()

ilWkhtmlToPdfConfig::getUserStylesheetArgument ( )

protected

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

References getUserStylesheet().

Referenced by generateCommandLineConfig().

     {
         $stylesheet = $this->getUserStylesheet();
         if ($stylesheet != '') {
             $this->config[] = 'user-style-sheet "' . $stylesheet . '"';
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWKHTMLToPdfDefaultPath()

ilWkhtmlToPdfConfig::getWKHTMLToPdfDefaultPath ( )

Returns: string

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

References $path, and getSavedDefaultBinaryPath().

     {
         $path = $this->getSavedDefaultBinaryPath();
         if($path !== ''){
             return $path;
         }
         return '/usr/local/bin/wkhtmltopdf';
     }

Here is the call graph for this function:

◆ getZoom()

ilWkhtmlToPdfConfig::getZoom ( )

Returns: float

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

References $zoom.

Referenced by getZoomArgument().

     {
         return $this->zoom;
     }

Here is the caller graph for this function:

◆ getZoomArgument()

ilWkhtmlToPdfConfig::getZoomArgument ( )

protected

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

References getZoom().

Referenced by generateCommandLineConfig().

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

Returns: boolean

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

References $footer_html_line.

Referenced by getFooterArgument().

     {
         return $this->footer_html_line;
     }

Here is the caller graph for this function:

◆ isFooterTextLine()

ilWkhtmlToPdfConfig::isFooterTextLine ( )

Returns: boolean

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

References $footer_text_line.

Referenced by getFooterArgument().

     {
         return $this->footer_text_line;
     }

Here is the caller graph for this function:

◆ isHeaderHtmlLine()

ilWkhtmlToPdfConfig::isHeaderHtmlLine ( )

Returns: boolean

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

References $header_html_line.

Referenced by getHeaderArgument().

     {
         return $this->header_html_line;
     }

Here is the caller graph for this function:

◆ isHeaderTextLine()

ilWkhtmlToPdfConfig::isHeaderTextLine ( )

Returns: boolean

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

References $header_text_line.

Referenced by getHeaderArgument().

     {
         return $this->header_text_line;
     }

Here is the caller graph for this function:

◆ readConfigFromArray()

ilWkhtmlToPdfConfig::readConfigFromArray ( $config )

protected

Parameters

$config

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

References $config, and setKeyIfExists().

Referenced by __construct().

     {
         $this->setKeyIfExists('setZoom', 'zoom', $config);
         $this->setKeyIfExists('setEnabledForms', 'enable_forms', $config);
         $this->setKeyIfExists('setExternalLinks', 'external_links', $config);
         $this->setKeyIfExists('setUserStylesheet', 'user_stylesheet', $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 ( $config )

protected

Parameters

ilWkhtmlToPdfConfig $config

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

References $config, 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(), setUserStylesheet(), and setZoom().

Referenced by __construct().

     {
         $this->setZoom($config->getZoom());
         $this->setEnabledForms($config->getEnabledForms());
         $this->setExternalLinks($config->getExternalLinks());
         $this->setUserStylesheet($config->getUserStylesheet());
         $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 ( $checkbox_checked_svg )

Parameters

string $checkbox_checked_svg

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

References $checkbox_checked_svg.

Referenced by readConfigFromObject().

     {
         $this->checkbox_checked_svg = $checkbox_checked_svg;
     }

Here is the caller graph for this function:

◆ setCheckboxSvg()

ilWkhtmlToPdfConfig::setCheckboxSvg ( $checkbox_svg )

Parameters

string $checkbox_svg

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

References $checkbox_svg.

Referenced by readConfigFromObject().

     {
         $this->checkbox_svg = $checkbox_svg;
     }

Here is the caller graph for this function:

◆ setEnabledForms()

ilWkhtmlToPdfConfig::setEnabledForms ( $enabled_forms )

Parameters

boolean $enabled_forms

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

References $enabled_forms.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->enabled_forms = $enabled_forms;
     }

Here is the caller graph for this function:

◆ setExternalLinks()

ilWkhtmlToPdfConfig::setExternalLinks ( $external_links )

Parameters

boolean $external_links

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

References $external_links.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->external_links = $external_links;
     }

Here is the caller graph for this function:

◆ setFooterHtml()

ilWkhtmlToPdfConfig::setFooterHtml ( $footer_html )

Parameters

string $footer_html

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

References $footer_html.

Referenced by readConfigFromObject().

     {
         $this->footer_html = $footer_html;
     }

Here is the caller graph for this function:

◆ setFooterHtmlLine()

ilWkhtmlToPdfConfig::setFooterHtmlLine ( $footer_html_line )

Parameters

boolean $footer_html_line

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

References $footer_html_line.

Referenced by readConfigFromObject().

     {
         $this->footer_html_line = $footer_html_line;
     }

Here is the caller graph for this function:

◆ setFooterHtmlSpacing()

ilWkhtmlToPdfConfig::setFooterHtmlSpacing ( $footer_html_spacing )

Parameters

int $footer_html_spacing

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

References $footer_html_spacing.

Referenced by readConfigFromObject().

     {
         $this->footer_html_spacing = $footer_html_spacing;
     }

Here is the caller graph for this function:

◆ setFooterTextCenter()

ilWkhtmlToPdfConfig::setFooterTextCenter ( $footer_text_center )

Parameters

string $footer_text_center

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

References $footer_text_center.

Referenced by readConfigFromObject().

     {
         $this->footer_text_center = $footer_text_center;
     }

Here is the caller graph for this function:

◆ setFooterTextLeft()

ilWkhtmlToPdfConfig::setFooterTextLeft ( $footer_text_left )

Parameters

string $footer_text_left

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

References $footer_text_left.

Referenced by readConfigFromObject().

     {
         $this->footer_text_left = $footer_text_left;
     }

Here is the caller graph for this function:

◆ setFooterTextLine()

ilWkhtmlToPdfConfig::setFooterTextLine ( $footer_text_line )

Parameters

boolean $footer_text_line

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

References $footer_text_line.

Referenced by readConfigFromObject().

     {
         $this->footer_text_line = $footer_text_line;
     }

Here is the caller graph for this function:

◆ setFooterTextRight()

ilWkhtmlToPdfConfig::setFooterTextRight ( $footer_text_right )

Parameters

string $footer_text_right

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

References $footer_text_right.

Referenced by readConfigFromObject().

     {
         $this->footer_text_right = $footer_text_right;
     }

Here is the caller graph for this function:

◆ setFooterTextSpacing()

ilWkhtmlToPdfConfig::setFooterTextSpacing ( $footer_text_spacing )

Parameters

int $footer_text_spacing

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

References $footer_text_spacing.

Referenced by readConfigFromObject().

     {
         $this->footer_text_spacing = $footer_text_spacing;
     }

Here is the caller graph for this function:

◆ setFooterType()

ilWkhtmlToPdfConfig::setFooterType ( $footer_type )

Parameters

int $footer_type

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

References $footer_type.

Referenced by readConfigFromObject().

     {
         $this->footer_type = $footer_type;
     }

Here is the caller graph for this function:

◆ setGreyscale()

ilWkhtmlToPdfConfig::setGreyscale ( $greyscale )

Parameters

boolean $greyscale

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

References $greyscale.

Referenced by readConfigFromObject().

     {
         $this->greyscale = $greyscale;
     }

Here is the caller graph for this function:

◆ setHeaderHtml()

ilWkhtmlToPdfConfig::setHeaderHtml ( $header_html )

Parameters

string $header_html

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

References $header_html.

Referenced by readConfigFromObject().

     {
         $this->header_html = $header_html;
     }

Here is the caller graph for this function:

◆ setHeaderHtmlLine()

ilWkhtmlToPdfConfig::setHeaderHtmlLine ( $header_html_line )

Parameters

boolean $header_html_line

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

References $header_html_line.

Referenced by readConfigFromObject().

     {
         $this->header_html_line = $header_html_line;
     }

Here is the caller graph for this function:

◆ setHeaderHtmlSpacing()

ilWkhtmlToPdfConfig::setHeaderHtmlSpacing ( $header_html_spacing )

Parameters

int $header_html_spacing

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

References $header_html_spacing.

Referenced by readConfigFromObject().

     {
         $this->header_html_spacing = $header_html_spacing;
     }

Here is the caller graph for this function:

◆ setHeaderTextCenter()

ilWkhtmlToPdfConfig::setHeaderTextCenter ( $header_text_center )

Parameters

string $header_text_center

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

References $header_text_center.

Referenced by readConfigFromObject().

     {
         $this->header_text_center = $header_text_center;
     }

Here is the caller graph for this function:

◆ setHeaderTextLeft()

ilWkhtmlToPdfConfig::setHeaderTextLeft ( $header_text_left )

Parameters

string $header_text_left

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

References $header_text_left.

Referenced by readConfigFromObject().

     {
         $this->header_text_left = $header_text_left;
     }

Here is the caller graph for this function:

◆ setHeaderTextLine()

ilWkhtmlToPdfConfig::setHeaderTextLine ( $header_text_line )

Parameters

boolean $header_text_line

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

References $header_text_line.

Referenced by readConfigFromObject().

     {
         $this->header_text_line = $header_text_line;
     }

Here is the caller graph for this function:

◆ setHeaderTextRight()

ilWkhtmlToPdfConfig::setHeaderTextRight ( $header_text_right )

Parameters

string $header_text_right

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

References $header_text_right.

Referenced by readConfigFromObject().

     {
         $this->header_text_right = $header_text_right;
     }

Here is the caller graph for this function:

◆ setHeaderTextSpacing()

ilWkhtmlToPdfConfig::setHeaderTextSpacing ( $header_text_spacing )

Parameters

int $header_text_spacing

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

References $header_text_spacing.

Referenced by readConfigFromObject().

     {
         $this->header_text_spacing = $header_text_spacing;
     }

Here is the caller graph for this function:

◆ setHeaderType()

ilWkhtmlToPdfConfig::setHeaderType ( $header_type )

Parameters

int $header_type

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

References $header_type.

Referenced by readConfigFromObject().

     {
         $this->header_type = $header_type;
     }

Here is the caller graph for this function:

◆ setJavascriptDelay()

ilWkhtmlToPdfConfig::setJavascriptDelay ( $javascript_delay )

Parameters

int $javascript_delay

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

References $javascript_delay.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->javascript_delay = $javascript_delay;
     }

Here is the caller graph for this function:

◆ setKeyIfExists()

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

protected

Parameters

$function
$key
$config

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

References $config.

Referenced by readConfigFromArray().

     {
         if (array_key_exists($key, $config)) {
             $this->{$function}($config[$key]);
         }
     }

Here is the caller graph for this function:

◆ setLowQuality()

ilWkhtmlToPdfConfig::setLowQuality ( $low_quality )

Parameters

boolean $low_quality

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

References $low_quality.

Referenced by readConfigFromObject().

     {
         $this->low_quality = $low_quality;
     }

Here is the caller graph for this function:

◆ setMarginBottom()

ilWkhtmlToPdfConfig::setMarginBottom ( $margin_bottom )

Parameters

string $margin_bottom

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

References $margin_bottom.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->margin_bottom = $margin_bottom;
     }

Here is the caller graph for this function:

◆ setMarginLeft()

ilWkhtmlToPdfConfig::setMarginLeft ( $margin_left )

Parameters

string $margin_left

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

References $margin_left.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->margin_left = $margin_left;
     }

Here is the caller graph for this function:

◆ setMarginRight()

ilWkhtmlToPdfConfig::setMarginRight ( $margin_right )

Parameters

string $margin_right

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

References $margin_right.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->margin_right = $margin_right;
     }

Here is the caller graph for this function:

◆ setMarginTop()

ilWkhtmlToPdfConfig::setMarginTop ( $margin_top )

Parameters

string $margin_top

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

References $margin_top.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->margin_top = $margin_top;
     }

Here is the caller graph for this function:

◆ setOrientation()

ilWkhtmlToPdfConfig::setOrientation ( $orientation )

Parameters

string $orientation

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

References $orientation.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->orientation = $orientation;
     }

Here is the caller graph for this function:

◆ setOverwriteDefaultFont()

ilWkhtmlToPdfConfig::setOverwriteDefaultFont ( $overwrite_default_font )

Parameters

string $overwrite_default_font

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

References $overwrite_default_font.

Referenced by readConfigFromObject().

     {
         $this->overwrite_default_font = $overwrite_default_font;
     }

Here is the caller graph for this function:

◆ setPageSize()

ilWkhtmlToPdfConfig::setPageSize ( $page_size )

Parameters

string $page_size

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

References $page_size.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->page_size = $page_size;
     }

Here is the caller graph for this function:

◆ setPath()

ilWkhtmlToPdfConfig::setPath ( $path )

Parameters

string $path

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

References $path.

     {
         $this->path = $path;
     }

◆ setPrintMediaType()

ilWkhtmlToPdfConfig::setPrintMediaType ( $print_media_type )

Parameters

boolean $print_media_type

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

References $print_media_type.

Referenced by readConfigFromObject().

     {
         $this->print_media_type = $print_media_type;
     }

Here is the caller graph for this function:

◆ setRadioButtonCheckedSvg()

ilWkhtmlToPdfConfig::setRadioButtonCheckedSvg ( $radio_button_checked_svg )

Parameters

string $radio_button_checked_svg

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

References $radio_button_checked_svg.

Referenced by readConfigFromObject().

     {
         $this->radio_button_checked_svg = $radio_button_checked_svg;
     }

Here is the caller graph for this function:

◆ setRadioButtonSvg()

ilWkhtmlToPdfConfig::setRadioButtonSvg ( $radio_button_svg )

Parameters

string $radio_button_svg

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

References $radio_button_svg.

Referenced by readConfigFromObject().

     {
         $this->radio_button_svg = $radio_button_svg;
     }

Here is the caller graph for this function:

◆ setUserStylesheet()

ilWkhtmlToPdfConfig::setUserStylesheet ( $user_stylesheet )

Parameters

string $user_stylesheet

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

References $user_stylesheet.

Referenced by readConfigFromObject().

     {
         $this->user_stylesheet = $user_stylesheet;
     }

Here is the caller graph for this function:

◆ setZoom()

ilWkhtmlToPdfConfig::setZoom ( $zoom )

Parameters

float $zoom

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

References $zoom.

Referenced by readConfigFromObject(), and useDefaultConfig().

     {
         $this->zoom = $zoom;
     }

Here is the caller graph for this function:

◆ supportMultiSourcesFiles()

static ilWkhtmlToPdfConfig::supportMultiSourcesFiles ( )

static

Returns: bool

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

     {
         return true;
     }

◆ useDefaultConfig()

ilWkhtmlToPdfConfig::useDefaultConfig ( )

protected

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

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

Referenced by __construct().

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

ilWkhtmlToPdfConfig::$checkbox_checked_svg

protected

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

Referenced by getCheckboxCheckedSvg(), and setCheckboxCheckedSvg().

◆ $checkbox_svg

ilWkhtmlToPdfConfig::$checkbox_svg

protected

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

Referenced by getCheckboxCheckedSvgArgument(), getCheckboxSvg(), getCheckboxSvgArgument(), and setCheckboxSvg().

◆ $config

ilWkhtmlToPdfConfig::$config = array()

protected

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

Referenced by __construct(), getConfig(), readConfigFromArray(), readConfigFromObject(), and setKeyIfExists().

◆ $enabled_forms

ilWkhtmlToPdfConfig::$enabled_forms

protected

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

Referenced by getEnabledForms(), and setEnabledForms().

◆ $external_links

ilWkhtmlToPdfConfig::$external_links

protected

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

Referenced by getExternalLinks(), and setExternalLinks().

◆ $footer_html

ilWkhtmlToPdfConfig::$footer_html

protected

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

Referenced by getFooterHtml(), and setFooterHtml().

◆ $footer_html_line

ilWkhtmlToPdfConfig::$footer_html_line

protected

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

Referenced by isFooterHtmlLine(), and setFooterHtmlLine().

◆ $footer_html_spacing

ilWkhtmlToPdfConfig::$footer_html_spacing

protected

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

Referenced by getFooterHtmlSpacing(), and setFooterHtmlSpacing().

◆ $footer_text_center

ilWkhtmlToPdfConfig::$footer_text_center

protected

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

Referenced by getFooterTextCenter(), and setFooterTextCenter().

◆ $footer_text_left

ilWkhtmlToPdfConfig::$footer_text_left

protected

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

Referenced by getFooterTextLeft(), and setFooterTextLeft().

◆ $footer_text_line

ilWkhtmlToPdfConfig::$footer_text_line

protected

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

Referenced by isFooterTextLine(), and setFooterTextLine().

◆ $footer_text_right

ilWkhtmlToPdfConfig::$footer_text_right

protected

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

Referenced by getFooterTextRight(), and setFooterTextRight().

◆ $footer_text_spacing

ilWkhtmlToPdfConfig::$footer_text_spacing

protected

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

Referenced by getFooterTextSpacing(), and setFooterTextSpacing().

◆ $footer_type

ilWkhtmlToPdfConfig::$footer_type

protected

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

Referenced by getFooterType(), and setFooterType().

◆ $greyscale

ilWkhtmlToPdfConfig::$greyscale

protected

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

Referenced by getGreyscale(), and setGreyscale().

◆ $header_html

ilWkhtmlToPdfConfig::$header_html

protected

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

Referenced by getHeaderHtml(), and setHeaderHtml().

◆ $header_html_line

ilWkhtmlToPdfConfig::$header_html_line

protected

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

Referenced by isHeaderHtmlLine(), and setHeaderHtmlLine().

◆ $header_html_spacing

ilWkhtmlToPdfConfig::$header_html_spacing

protected

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

Referenced by getHeaderHtmlSpacing(), and setHeaderHtmlSpacing().

◆ $header_text_center

ilWkhtmlToPdfConfig::$header_text_center

protected

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

Referenced by getHeaderTextCenter(), and setHeaderTextCenter().

◆ $header_text_left

ilWkhtmlToPdfConfig::$header_text_left

protected

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

Referenced by getHeaderTextLeft(), and setHeaderTextLeft().

◆ $header_text_line

ilWkhtmlToPdfConfig::$header_text_line

protected

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

Referenced by isHeaderTextLine(), and setHeaderTextLine().

◆ $header_text_right

ilWkhtmlToPdfConfig::$header_text_right

protected

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

Referenced by getHeaderTextRight(), and setHeaderTextRight().

◆ $header_text_spacing

ilWkhtmlToPdfConfig::$header_text_spacing

protected

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

Referenced by getHeaderTextSpacing(), and setHeaderTextSpacing().

◆ $header_type

ilWkhtmlToPdfConfig::$header_type

protected

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

Referenced by getHeaderType(), and setHeaderType().

◆ $javascript_delay

ilWkhtmlToPdfConfig::$javascript_delay

protected

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

Referenced by getJavascriptDelay(), and setJavascriptDelay().

◆ $low_quality

ilWkhtmlToPdfConfig::$low_quality

protected

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

Referenced by getLowQuality(), and setLowQuality().

◆ $margin_bottom

ilWkhtmlToPdfConfig::$margin_bottom

protected

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

Referenced by getMarginBottom(), and setMarginBottom().

◆ $margin_left

ilWkhtmlToPdfConfig::$margin_left

protected

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

Referenced by getMarginLeft(), and setMarginLeft().

◆ $margin_right

ilWkhtmlToPdfConfig::$margin_right

protected

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

Referenced by getMarginRight(), and setMarginRight().

◆ $margin_top

ilWkhtmlToPdfConfig::$margin_top

protected

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

Referenced by getMarginTop(), and setMarginTop().

◆ $orientation

ilWkhtmlToPdfConfig::$orientation

protected

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

Referenced by getOrientation(), getOrientationArgument(), and setOrientation().

◆ $overwrite_default_font

ilWkhtmlToPdfConfig::$overwrite_default_font = ''

protected

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

Referenced by getOverwriteDefaultFont(), and setOverwriteDefaultFont().

◆ $page_size

ilWkhtmlToPdfConfig::$page_size

protected

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

Referenced by getPageSize(), and setPageSize().

◆ $path

ilWkhtmlToPdfConfig::$path

protected

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

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

◆ $phpunit

ilWkhtmlToPdfConfig::$phpunit = false

protected

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

◆ $print_media_type

ilWkhtmlToPdfConfig::$print_media_type

protected

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

Referenced by getPrintMediaType(), and setPrintMediaType().

◆ $radio_button_checked_svg

ilWkhtmlToPdfConfig::$radio_button_checked_svg

protected

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

Referenced by getRadioButtonCheckedSvg(), and setRadioButtonCheckedSvg().

◆ $radio_button_svg

ilWkhtmlToPdfConfig::$radio_button_svg

protected

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

Referenced by getRadioButtonCheckedSvgArgument(), getRadioButtonSvg(), getRadioButtonSvgArgument(), and setRadioButtonSvg().

◆ $user_stylesheet

ilWkhtmlToPdfConfig::$user_stylesheet

protected

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

Referenced by getUserStylesheet(), and setUserStylesheet().

◆ $zoom

ilWkhtmlToPdfConfig::$zoom

protected

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

Referenced by getZoom(), and setZoom().

◆ ENABLE_QUIET

const ilWkhtmlToPdfConfig::ENABLE_QUIET = true

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

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ generateCommandLineConfig()

◆ getCheckboxCheckedSvg()

◆ getCheckboxCheckedSvgArgument()

◆ getCheckboxSvg()

◆ getCheckboxSvgArgument()

◆ getCommandLineConfig()

◆ getConfig()

◆ getDebugArgument()

◆ getEnabledForms()

◆ getEnabledFormsArgument()

◆ getExternalLinks()

◆ getExternalLinksArgument()

◆ getFooterArgument()

◆ getFooterHtml()

◆ getFooterHtmlSpacing()

◆ getFooterTextCenter()

◆ getFooterTextLeft()

◆ getFooterTextRight()

◆ getFooterTextSpacing()

◆ getFooterType()

◆ getGreyscale()

◆ getGreyscaleArgument()

◆ getHeaderArgument()

◆ getHeaderHtml()

◆ getHeaderHtmlSpacing()

◆ getHeaderTextCenter()

◆ getHeaderTextLeft()

◆ getHeaderTextRight()

◆ getHeaderTextSpacing()

◆ getHeaderType()

◆ getJavascriptDelay()

◆ getJavascriptDelayArgument()

◆ getLowQuality()

◆ getLowQualityArgument()

◆ getMarginArgument()

◆ getMarginBottom()

◆ getMarginLeft()

◆ getMarginRight()

◆ getMarginTop()

◆ getOrientation()

◆ getOrientationArgument()

◆ getOverwriteDefaultFont()

◆ getPageSize()

◆ getPageSizeArgument()

◆ getPath()

◆ getPrintMediaType()

◆ getPrintMediaTypeArgument()

◆ getRadioButtonCheckedSvg()

◆ getRadioButtonCheckedSvgArgument()

◆ getRadioButtonSvg()

◆ getRadioButtonSvgArgument()

◆ getSavedDefaultBinaryPath()

◆ getSessionObject()

◆ getUserStylesheet()

◆ getUserStylesheetArgument()

◆ getWKHTMLToPdfDefaultPath()

◆ getZoom()

◆ getZoomArgument()

◆ isFooterHtmlLine()

◆ isFooterTextLine()

◆ isHeaderHtmlLine()

◆ isHeaderTextLine()

◆ readConfigFromArray()

◆ readConfigFromObject()

◆ setCheckboxCheckedSvg()

◆ setCheckboxSvg()

◆ setEnabledForms()

◆ setExternalLinks()

◆ setFooterHtml()

◆ setFooterHtmlLine()

◆ setFooterHtmlSpacing()