ILIAS  release_7 Revision v7.30-3-g800a261c036
ilWkhtmlToPdfConfig Class Reference
+ 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.

172 {
173 if ($config != null && !$config instanceof ilWkhtmlToPdfConfig) {
175 } else {
176 if ($config instanceof ilWkhtmlToPdfConfig) {
178 } else {
179 $this->useDefaultConfig();
180 }
181 }
182 }

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

907 {
908 $this->getZoomArgument();
912 $this->getGreyscaleArgument();
913 $this->getLowQualityArgument();
914 $this->getOrientationArgument();
916 $this->getPageSizeArgument();
918 $this->getCheckboxSvgArgument();
922 $this->getMarginArgument();
923 $this->getHeaderArgument();
924 $this->getFooterArgument();
925 $this->getDebugArgument();
926 $this->getSessionObject();
927 }

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

Referenced by getCommandLineConfig().

+ 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().

+ Here is the caller graph for this function:

◆ getCheckboxCheckedSvgArgument()

ilWkhtmlToPdfConfig::getCheckboxCheckedSvgArgument ( )
protected

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

1016 {
1018 if ($checkbox_svg != '') {
1019 $this->config[] = 'checkbox-checked-svg "' . $checkbox_svg . '"';
1020 }
1021 }

References $checkbox_svg, and getCheckboxCheckedSvg().

Referenced by generateCommandLineConfig().

+ 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.

737 {
738 return $this->checkbox_svg;
739 }

References $checkbox_svg.

Referenced by getCheckboxSvgArgument().

+ Here is the caller graph for this function:

◆ getCheckboxSvgArgument()

ilWkhtmlToPdfConfig::getCheckboxSvgArgument ( )
protected

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

1008 {
1009 $checkbox_svg = $this->getCheckboxSvg();
1010 if ($checkbox_svg != '') {
1011 $this->config[] = 'checkbox-svg "' . $checkbox_svg . '"';
1012 }
1013 }

References $checkbox_svg, and getCheckboxSvg().

Referenced by generateCommandLineConfig().

+ 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.

897 {
899 $settings = ' ';
900 foreach ($this->config as $value) {
901 $settings .= '--' . $value . ' ';
902 }
903 return $settings;
904 }

References generateCommandLineConfig().

+ Here is the call graph for this function:

◆ getConfig()

ilWkhtmlToPdfConfig::getConfig ( )

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

889 {
890 return $this->config;
891 }

References $config.

◆ getDebugArgument()

ilWkhtmlToPdfConfig::getDebugArgument ( )
protected

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

1160 {
1161 if (self::ENABLE_QUIET) {
1162 $this->config[] = 'quiet';
1163 }
1164 }

Referenced by generateCommandLineConfig().

+ 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().

+ Here is the caller graph for this function:

◆ getEnabledFormsArgument()

ilWkhtmlToPdfConfig::getEnabledFormsArgument ( )
protected

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

946 {
947 if ($this->getEnabledForms()) {
948 $this->config[] = 'enable-forms';
949 } else {
950 $this->config[] = 'disable-forms';
951 }
952 }

References getEnabledForms().

Referenced by generateCommandLineConfig().

+ 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().

+ Here is the caller graph for this function:

◆ getExternalLinksArgument()

ilWkhtmlToPdfConfig::getExternalLinksArgument ( )
protected

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

937 {
938 if ($this->getExternalLinks()) {
939 $this->config[] = 'enable-external-links';
940 } else {
941 $this->config[] = 'disable-external-links';
942 }
943 }

References getExternalLinks().

Referenced by generateCommandLineConfig().

+ 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.

1132 {
1133 $footer_value = $this->getFooterType();
1134 if ($footer_value == ilPDFGenerationConstants::FOOTER_TEXT) {
1135 $this->config[] = 'footer-left "' . $this->getFooterTextLeft() . '"';
1136 $this->config[] = 'footer-center "' . $this->getFooterTextCenter() . '"';
1137 $this->config[] = 'footer-right "' . $this->getFooterTextRight() . '"';
1138 if ($this->getFooterTextSpacing() != '') {
1139 $this->config[] = 'footer-spacing ' . $this->getFooterTextSpacing();
1140 }
1141
1142 if ($this->isFooterTextLine()) {
1143 $this->config[] = 'footer-line';
1144 }
1145 } else {
1146 if ($footer_value == ilPDFGenerationConstants::FOOTER_HTML) {
1147 $this->config[] = 'footer-html "' . $this->getFooterHtml() . '"';
1148
1149 if ($this->getFooterHtmlSpacing() != '') {
1150 $this->config[] = 'footer-spacing ' . $this->getFooterHtmlSpacing();
1151 }
1152 if ($this->isFooterHtmlLine()) {
1153 $this->config[] = 'footer-line';
1154 }
1155 }
1156 }
1157 }

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

Referenced by generateCommandLineConfig().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ Here is the caller graph for this function:

◆ getGreyscaleArgument()

ilWkhtmlToPdfConfig::getGreyscaleArgument ( )
protected

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

963 {
964 if ($this->getGreyscale()) {
965 $this->config[] = 'grayscale';
966 }
967 }

References getGreyscale().

Referenced by generateCommandLineConfig().

+ 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.

1056 {
1057 $header_value = $this->getHeaderType();
1058 if ($header_value == ilPDFGenerationConstants::HEADER_TEXT) {
1059 $this->config[] = 'header-left "' . $this->getHeaderTextLeft() . '"';
1060 $this->config[] = 'header-center "' . $this->getHeaderTextCenter() . '"';
1061 $this->config[] = 'header-right "' . $this->getHeaderTextRight() . '"';
1062 if ($this->getHeaderTextSpacing() != '') {
1063 $this->config[] = 'header-spacing ' . $this->getHeaderTextSpacing();
1064 }
1065
1066 if ($this->isHeaderTextLine()) {
1067 $this->config[] = 'header-line';
1068 }
1069 } else {
1070 if ($header_value == ilPDFGenerationConstants::HEADER_HTML) {
1071 $this->config[] = 'header-html "' . $this->getHeaderHtml() . '"';
1072
1073 if ($this->getHeaderHtmlSpacing() != '') {
1074 $this->config[] = 'header-spacing ' . $this->getHeaderHtmlSpacing();
1075 }
1076 if ($this->isHeaderHtmlLine()) {
1077 $this->config[] = 'header-line';
1078 }
1079 }
1080 }
1081 }

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

Referenced by generateCommandLineConfig().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ Here is the caller graph for this function:

◆ getJavascriptDelayArgument()

ilWkhtmlToPdfConfig::getJavascriptDelayArgument ( )
protected

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

1001 {
1002 if ($this->getJavascriptDelay() != '') {
1003 $this->config[] = 'javascript-delay ' . $this->getJavascriptDelay();
1004 }
1005 }

References getJavascriptDelay().

Referenced by generateCommandLineConfig().

+ 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().

+ Here is the caller graph for this function:

◆ getLowQualityArgument()

ilWkhtmlToPdfConfig::getLowQualityArgument ( )
protected

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

970 {
971 if ($this->getLowQuality() == 1 || $this->getLowQuality() == true) {
972 $this->config[] = 'lowquality';
973 }
974 }

References getLowQuality().

Referenced by generateCommandLineConfig().

+ 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.

1040 {
1041 if ($this->getMarginBottom() != '') {
1042 $this->config[] = 'margin-bottom ' . $this->getMarginBottom();
1043 }
1044 if ($this->getMarginLeft() != '') {
1045 $this->config[] = 'margin-left ' . $this->getMarginLeft();
1046 }
1047 if ($this->getMarginRight() != '') {
1048 $this->config[] = 'margin-right ' . $this->getMarginRight();
1049 }
1050 if ($this->getMarginTop() != '') {
1051 $this->config[] = 'margin-top ' . $this->getMarginTop();
1052 }
1053 }

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

Referenced by generateCommandLineConfig().

+ 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().

+ 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().

+ 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().

+ 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().

+ 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().

+ Here is the caller graph for this function:

◆ getOrientationArgument()

ilWkhtmlToPdfConfig::getOrientationArgument ( )
protected

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

977 {
978 $orientation = $this->getOrientation();
979 if ($orientation == '' || $orientation == 'Portrait') {
980 $this->config[] = 'orientation Portrait';
981 } else {
982 $this->config[] = 'orientation Landscape';
983 }
984 }

References $orientation, and getOrientation().

Referenced by generateCommandLineConfig().

+ 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.

818 {
819 if ($renderStyle) {
820 if (strlen($this->overwrite_default_font) > 0) {
821 return '<style>body{font-family: ' . $this->overwrite_default_font . ';}</style>';
822 }
823 } else {
825 }
826
827 return '';
828 }

References $overwrite_default_font.

◆ getPageSize()

ilWkhtmlToPdfConfig::getPageSize ( )
Returns
string

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

References $page_size.

Referenced by getPageSizeArgument().

+ Here is the caller graph for this function:

◆ getPageSizeArgument()

ilWkhtmlToPdfConfig::getPageSizeArgument ( )
protected

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

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

References getPageSize().

Referenced by generateCommandLineConfig().

+ 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.

◆ getPrintMediaType()

ilWkhtmlToPdfConfig::getPrintMediaType ( )
Returns
bool

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

References $print_media_type.

Referenced by getPrintMediaTypeArgument().

+ Here is the caller graph for this function:

◆ getPrintMediaTypeArgument()

ilWkhtmlToPdfConfig::getPrintMediaTypeArgument ( )
protected

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

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

References getPrintMediaType().

Referenced by generateCommandLineConfig().

+ 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().

+ Here is the caller graph for this function:

◆ getRadioButtonCheckedSvgArgument()

ilWkhtmlToPdfConfig::getRadioButtonCheckedSvgArgument ( )
protected

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

1032 {
1034 if ($radio_button_svg != '') {
1035 $this->config[] = 'radiobutton-checked-svg "' . $radio_button_svg . '"';
1036 }
1037 }

References $radio_button_svg, and getRadioButtonCheckedSvg().

Referenced by generateCommandLineConfig().

+ 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.

705 {
707 }

References $radio_button_svg.

Referenced by getRadioButtonSvgArgument().

+ Here is the caller graph for this function:

◆ getRadioButtonSvgArgument()

ilWkhtmlToPdfConfig::getRadioButtonSvgArgument ( )
protected

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

1024 {
1026 if ($radio_button_svg != '') {
1027 $this->config[] = 'radiobutton-svg "' . $radio_button_svg . '"';
1028 }
1029 }

References $radio_button_svg, and getRadioButtonSvg().

Referenced by generateCommandLineConfig().

+ 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.

1175 {
1176 $settings = new ilSetting('wkhtmltopdfrenderer');
1177 $path = $settings->get('path');
1178 if( ! is_bool($path) && $path != null && $path != ''){
1179 return $path;
1180 }
1181 return '';
1182 }
ILIAS Setting Class.

References $path.

Referenced by getWKHTMLToPdfDefaultPath().

+ Here is the caller graph for this function:

◆ getSessionObject()

ilWkhtmlToPdfConfig::getSessionObject ( )
protected

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

1167 {
1168 $this->config[] = 'cookie "PHPSESSID" "' . session_id() . '"';
1169 $this->config[] = 'cookie "ilClientId" "' . CLIENT_ID . '"';
1170 }
const CLIENT_ID
Definition: constants.php:39

References CLIENT_ID.

Referenced by generateCommandLineConfig().

+ 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().

+ Here is the caller graph for this function:

◆ getUserStylesheetArgument()

ilWkhtmlToPdfConfig::getUserStylesheetArgument ( )
protected

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

955 {
956 $stylesheet = $this->getUserStylesheet();
957 if ($stylesheet != '') {
958 $this->config[] = 'user-style-sheet "' . $stylesheet . '"';
959 }
960 }

References getUserStylesheet().

Referenced by generateCommandLineConfig().

+ 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.

880 {
882 if($path !== ''){
883 return $path;
884 }
885 return '/usr/local/bin/wkhtmltopdf';
886 }

References $path, and getSavedDefaultBinaryPath().

+ 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().

+ Here is the caller graph for this function:

◆ getZoomArgument()

ilWkhtmlToPdfConfig::getZoomArgument ( )
protected

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

930 {
931 if ($this->getZoom() != '') {
932 $this->config[] = 'zoom ' . $this->getZoom();
933 }
934 }

References getZoom().

Referenced by generateCommandLineConfig().

+ 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().

+ 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().

+ 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().

+ 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().

+ Here is the caller graph for this function:

◆ readConfigFromArray()

ilWkhtmlToPdfConfig::readConfigFromArray (   $config)
protected
Parameters
$config

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

188 {
189 $this->setKeyIfExists('setZoom', 'zoom', $config);
190 $this->setKeyIfExists('setEnabledForms', 'enable_forms', $config);
191 $this->setKeyIfExists('setExternalLinks', 'external_links', $config);
192 $this->setKeyIfExists('setUserStylesheet', 'user_stylesheet', $config);
193 $this->setKeyIfExists('setLowQuality', 'low_quality', $config);
194 $this->setKeyIfExists('setGreyscale', 'greyscale', $config);
195 $this->setKeyIfExists('setOrientation', 'orientation', $config);
196 $this->setKeyIfExists('setPageSize', 'page_size', $config);
197 $this->setKeyIfExists('setMarginLeft', 'margin_left', $config);
198 $this->setKeyIfExists('setMarginRight', 'margin_right', $config);
199 $this->setKeyIfExists('setFooterHtmlSpacing', 'footer_html_spacing', $config);
200 $this->setKeyIfExists('setFooterHtml', 'footer_html', $config);
201 $this->setKeyIfExists('setFooterTextLine', 'footer_text_line', $config);
202 $this->setKeyIfExists('setFooterTextCenter', 'footer_text_center', $config);
203 $this->setKeyIfExists('setFooterTextCenter', 'footer_text_center', $config);
204 $this->setKeyIfExists('setFooterTextSpacing', 'footer_text_spacing', $config);
205 $this->setKeyIfExists('setFooterTextRight', 'footer_text_right', $config);
206 $this->setKeyIfExists('setFooterTextLeft', 'footer_text_left', $config);
207 $this->setKeyIfExists('setFooterType', 'footer_select', $config);
208 $this->setKeyIfExists('setHeaderHtmlSpacing', 'head_html_spacing', $config);
209 $this->setKeyIfExists('setHeaderHtmlLine', 'head_html_line', $config);
210 $this->setKeyIfExists('setHeaderHtml', 'head_html', $config);
211 $this->setKeyIfExists('setHeaderTextLine', 'head_text_line', $config);
212 $this->setKeyIfExists('setHeaderTextSpacing', 'head_text_spacing', $config);
213 $this->setKeyIfExists('setHeaderTextRight', 'head_text_right', $config);
214 $this->setKeyIfExists('setHeaderTextCenter', 'head_text_center', $config);
215 $this->setKeyIfExists('setHeaderTextLeft', 'head_text_left', $config);
216 $this->setKeyIfExists('setHeaderType', 'header_select', $config);
217 $this->setKeyIfExists('setRadioButtonCheckedSvg', 'radio_button_checked_svg', $config);
218 $this->setKeyIfExists('setRadioButtonSvg', 'radio_button_svg', $config);
219 $this->setKeyIfExists('setCheckboxCheckedSvg', 'checkbox_checked_svg', $config);
220 $this->setKeyIfExists('setCheckboxSvg', 'checkbox_svg', $config);
221 $this->setKeyIfExists('setJavascriptDelay', 'javascript_delay', $config);
222 $this->setKeyIfExists('setPrintMediaType', 'print_media_type', $config);
223 $this->setKeyIfExists('setMarginTop', 'margin_top', $config);
224 $this->setKeyIfExists('setMarginBottom', 'margin_bottom', $config);
225 $this->setKeyIfExists('setOverwriteDefaultFont', 'overwrite_font', $config);
226 }
setKeyIfExists($function, $key, $config)

References $config, and setKeyIfExists().

Referenced by __construct().

+ 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.

244 {
245 $this->setZoom($config->getZoom());
246 $this->setEnabledForms($config->getEnabledForms());
247 $this->setExternalLinks($config->getExternalLinks());
248 $this->setUserStylesheet($config->getUserStylesheet());
249 $this->setLowQuality($config->getLowQuality());
250 $this->setGreyscale($config->getGreyscale());
251 $this->setOrientation($config->getOrientation());
252 $this->setPageSize($config->getPageSize());
253 $this->setMarginLeft($config->getMarginLeft());
254 $this->setMarginRight($config->getMarginRight());
255 $this->setFooterTextLine($config->isFooterTextLine());
256 $this->setFooterTextCenter($config->getFooterTextCenter());
257 $this->setFooterTextSpacing($config->getFooterTextSpacing());
258 $this->setFooterTextRight($config->getFooterTextRight());
259 $this->setFooterTextLeft($config->getFooterTextLeft());
260 $this->setFooterType($config->getFooterType());
261
262 $this->setFooterHtmlSpacing($config->getFooterHtmlSpacing());
263 $this->setFooterHtml($config->getFooterHtml());
264 $this->setFooterHtmlLine($config->isFooterHtmlLine());
265 $this->setHeaderHtmlSpacing($config->getHeaderHtmlSpacing());
266 $this->setHeaderHtml($config->getHeaderHtml());
267 $this->setHeaderHtmlLine($config->isHeaderHtmlLine());
268 $this->setHeaderTextLine($config->isHeaderTextLine());
269 $this->setHeaderTextSpacing($config->getHeaderTextSpacing());
270 $this->setHeaderTextRight($config->getHeaderTextRight());
271 $this->setHeaderTextCenter($config->getHeaderTextCenter());
272 $this->setHeaderTextLeft($config->getHeaderTextLeft());
273 $this->setHeaderType($config->getHeaderType());
274 $this->setRadioButtonCheckedSvg($config->getRadioButtonCheckedSvg());
275 $this->setRadioButtonSvg($config->getRadioButtonSvg());
276 $this->setCheckboxCheckedSvg($config->getCheckboxCheckedSvg());
277 $this->setCheckboxSvg($config->getCheckboxSvg());
278 $this->setJavascriptDelay($config->getJavascriptDelay());
279 $this->setPrintMediaType($config->getPrintMediaType());
280 $this->setMarginTop($config->getMarginTop());
281 $this->setMarginBottom($config->getMarginBottom());
282 $this->setOverwriteDefaultFont($config->getOverwriteDefaultFont());
283 }
setJavascriptDelay($javascript_delay)
setHeaderTextCenter($header_text_center)
setFooterTextLine($footer_text_line)
setFooterHtmlSpacing($footer_html_spacing)
setFooterTextRight($footer_text_right)
setFooterTextLeft($footer_text_left)
setHeaderHtmlLine($header_html_line)
setHeaderTextLine($header_text_line)
setHeaderTextRight($header_text_right)
setRadioButtonCheckedSvg($radio_button_checked_svg)
setRadioButtonSvg($radio_button_svg)
setHeaderHtmlSpacing($header_html_spacing)
setFooterTextCenter($footer_text_center)
setUserStylesheet($user_stylesheet)
setFooterTextSpacing($footer_text_spacing)
setOverwriteDefaultFont($overwrite_default_font)
setFooterHtmlLine($footer_html_line)
setHeaderTextSpacing($header_text_spacing)
setCheckboxCheckedSvg($checkbox_checked_svg)
setPrintMediaType($print_media_type)
setHeaderTextLeft($header_text_left)

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

+ 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.

729 {
730 $this->checkbox_checked_svg = $checkbox_checked_svg;
731 }

References $checkbox_checked_svg.

Referenced by readConfigFromObject().

+ 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.

745 {
746 $this->checkbox_svg = $checkbox_svg;
747 }

References $checkbox_svg.

Referenced by readConfigFromObject().

+ 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.

313 {
314 $this->enabled_forms = $enabled_forms;
315 }

References $enabled_forms.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ 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.

329 {
330 $this->external_links = $external_links;
331 }

References $external_links.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ 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.

473 {
474 $this->footer_html = $footer_html;
475 }

References $footer_html.

Referenced by readConfigFromObject().

+ 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.

585 {
586 $this->footer_html_line = $footer_html_line;
587 }

References $footer_html_line.

Referenced by readConfigFromObject().

+ 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.

457 {
458 $this->footer_html_spacing = $footer_html_spacing;
459 }

References $footer_html_spacing.

Referenced by readConfigFromObject().

+ 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.

505 {
506 $this->footer_text_center = $footer_text_center;
507 }

References $footer_text_center.

Referenced by readConfigFromObject().

+ 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.

553 {
554 $this->footer_text_left = $footer_text_left;
555 }

References $footer_text_left.

Referenced by readConfigFromObject().

+ 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.

489 {
490 $this->footer_text_line = $footer_text_line;
491 }

References $footer_text_line.

Referenced by readConfigFromObject().

+ 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.

537 {
538 $this->footer_text_right = $footer_text_right;
539 }

References $footer_text_right.

Referenced by readConfigFromObject().

+ 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.

521 {
522 $this->footer_text_spacing = $footer_text_spacing;
523 }

References $footer_text_spacing.

Referenced by readConfigFromObject().

+ 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.

569 {
570 $this->footer_type = $footer_type;
571 }

References $footer_type.

Referenced by readConfigFromObject().

+ Here is the caller graph for this function:

◆ setGreyscale()

ilWkhtmlToPdfConfig::setGreyscale (   $greyscale)
Parameters
boolean$greyscale

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

377 {
378 $this->greyscale = $greyscale;
379 }

References $greyscale.

Referenced by readConfigFromObject().

+ 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.

1095 {
1096 $this->header_html = $header_html;
1097 }

References $header_html.

Referenced by readConfigFromObject().

+ 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.

1127 {
1128 $this->header_html_line = $header_html_line;
1129 }

References $header_html_line.

Referenced by readConfigFromObject().

+ 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.

1111 {
1112 $this->header_html_spacing = $header_html_spacing;
1113 }

References $header_html_spacing.

Referenced by readConfigFromObject().

+ 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.

649 {
650 $this->header_text_center = $header_text_center;
651 }

References $header_text_center.

Referenced by readConfigFromObject().

+ 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.

665 {
666 $this->header_text_left = $header_text_left;
667 }

References $header_text_left.

Referenced by readConfigFromObject().

+ 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.

601 {
602 $this->header_text_line = $header_text_line;
603 }

References $header_text_line.

Referenced by readConfigFromObject().

+ 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.

633 {
634 $this->header_text_right = $header_text_right;
635 }

References $header_text_right.

Referenced by readConfigFromObject().

+ 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.

617 {
618 $this->header_text_spacing = $header_text_spacing;
619 }

References $header_text_spacing.

Referenced by readConfigFromObject().

+ 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.

681 {
682 $this->header_type = $header_type;
683 }

References $header_type.

Referenced by readConfigFromObject().

+ 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.

761 {
762 $this->javascript_delay = $javascript_delay;
763 }

References $javascript_delay.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ 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.

234 {
235 if (array_key_exists($key, $config)) {
236 $this->{$function}($config[$key]);
237 }
238 }

References $config.

Referenced by readConfigFromArray().

+ 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.

361 {
362 $this->low_quality = $low_quality;
363 }

References $low_quality.

Referenced by readConfigFromObject().

+ 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.

809 {
810 $this->margin_bottom = $margin_bottom;
811 }

References $margin_bottom.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ 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.

425 {
426 $this->margin_left = $margin_left;
427 }

References $margin_left.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ 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.

441 {
442 $this->margin_right = $margin_right;
443 }

References $margin_right.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ 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.

793 {
794 $this->margin_top = $margin_top;
795 }

References $margin_top.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ Here is the caller graph for this function:

◆ setOrientation()

ilWkhtmlToPdfConfig::setOrientation (   $orientation)
Parameters
string$orientation

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

393 {
394 $this->orientation = $orientation;
395 }

References $orientation.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ 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.

834 {
835 $this->overwrite_default_font = $overwrite_default_font;
836 }

References $overwrite_default_font.

Referenced by readConfigFromObject().

+ 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.

409 {
410 $this->page_size = $page_size;
411 }

References $page_size.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ Here is the caller graph for this function:

◆ setPath()

ilWkhtmlToPdfConfig::setPath (   $path)
Parameters
string$path

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

872 {
873 $this->path = $path;
874 }

References $path.

◆ setPrintMediaType()

ilWkhtmlToPdfConfig::setPrintMediaType (   $print_media_type)
Parameters
boolean$print_media_type

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

777 {
778 $this->print_media_type = $print_media_type;
779 }

References $print_media_type.

Referenced by readConfigFromObject().

+ 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.

697 {
698 $this->radio_button_checked_svg = $radio_button_checked_svg;
699 }

References $radio_button_checked_svg.

Referenced by readConfigFromObject().

+ 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.

713 {
714 $this->radio_button_svg = $radio_button_svg;
715 }

References $radio_button_svg.

Referenced by readConfigFromObject().

+ 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.

345 {
346 $this->user_stylesheet = $user_stylesheet;
347 }

References $user_stylesheet.

Referenced by readConfigFromObject().

+ Here is the caller graph for this function:

◆ setZoom()

ilWkhtmlToPdfConfig::setZoom (   $zoom)
Parameters
float$zoom

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

297 {
298 $this->zoom = $zoom;
299 }

References $zoom.

Referenced by readConfigFromObject(), and useDefaultConfig().

+ Here is the caller graph for this function:

◆ supportMultiSourcesFiles()

static ilWkhtmlToPdfConfig::supportMultiSourcesFiles ( )
static
Returns
bool

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

856 {
857 return true;
858 }

◆ useDefaultConfig()

ilWkhtmlToPdfConfig::useDefaultConfig ( )
protected

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

839 {
840 $this->setExternalLinks(true);
841 $this->setEnabledForms(false);
842 $this->setJavascriptDelay(500);
843 $this->setZoom(1);
844 $this->setOrientation('Portrait');
845 $this->setPageSize('A4');
846 $this->setMarginLeft('0.5cm');
847 $this->setMarginRight('2cm');
848 $this->setMarginBottom('0.5cm');
849 $this->setMarginTop('2cm');
850 }

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

Referenced by __construct().

+ 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

◆ $config

ilWkhtmlToPdfConfig::$config = array()
protected

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

◆ $overwrite_default_font

ilWkhtmlToPdfConfig::$overwrite_default_font = ''
protected

◆ $page_size

ilWkhtmlToPdfConfig::$page_size
protected

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

Referenced by getPageSize(), and setPageSize().

◆ $path

ilWkhtmlToPdfConfig::$path
protected

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

◆ $radio_button_svg

ilWkhtmlToPdfConfig::$radio_button_svg
protected

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