Collaboration diagram for ilPDFGenerationJob:

Public Member Functions
	setAutoPageBreak ($auto_page_break)

	getAutoPageBreak ()

	setAuthor ($author)

	getAuthor ()

	setCreator ($creator)

	getCreator ()

	setFilename ($filename)

	getFilename ()

	setFont ($font)

	getFont ()

	setFooter ($footer)

	getFooter ()

	setFooterFont ($footer_font)

	getFooterFont ()

	setHeader ($header)

	getHeader ()

	setHeaderFont ($header_font)

	getHeaderFont ()

	setImageScale ($image_scale)

	getImageScale ()

	setKeywords ($keywords)

	getKeywords ()

	setMarginBottom ($margin_bottom)

	getMarginBottom ()

	setMarginLeft ($margin_left)

	getMarginLeft ()

	setMarginRight ($margin_right)

	getMarginRight ()

	setMarginTop ($margin_top)

	getMarginTop ()

	setPages ($pages)

	getPages ()

	addPage ($page)

	flushPages ()

	setSubject ($subject)

	getSubject ()

	setTitle ($title)

	getTitle ()

	setOutputMode ($output_mode)

	getOutputMode ()

Private Attributes
	$font

	$author

	$creator

	$footer

	$footer_font

	$header

	$header_font

	$title

	$subject

	$keywords

	$margin_left

	$margin_right

	$margin_top

	$margin_bottom

	$auto_page_break

	$image_scale = 1

	$pages

	$filename

	$output_mode

Detailed Description

Class ilPDFGenerationJob.

Data-object blueprint that holds all PDF-generation related settings. If you add to the methods, see to it that they follow the fluent interface, meaning that all setters return $this for developer convenience.

Author: Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

Definition at line 15 of file class.ilPDFGenerationJob.php.

Member Function Documentation

◆ addPage()

ilPDFGenerationJob::addPage ( $page )

Parameters

$page

Returns: $this

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

         {
                 $this->pages[] = $page;
                 return $this;
         }

◆ flushPages()

ilPDFGenerationJob::flushPages ( )

Returns: $this

Definition at line 341 of file class.ilPDFGenerationJob.php.

         {
                 $this->pages = array();
                 return $this;
         }

◆ getAuthor()

ilPDFGenerationJob::getAuthor ( )

Returns: string

Definition at line 70 of file class.ilPDFGenerationJob.php.

References $author.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->author;
         }

Here is the caller graph for this function:

◆ getAutoPageBreak()

ilPDFGenerationJob::getAutoPageBreak ( )

Returns: boolean

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

References $auto_page_break.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->auto_page_break;
         }

Here is the caller graph for this function:

◆ getCreator()

ilPDFGenerationJob::getCreator ( )

Returns: string

Definition at line 88 of file class.ilPDFGenerationJob.php.

References $creator.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->creator;
         }

Here is the caller graph for this function:

◆ getFilename()

ilPDFGenerationJob::getFilename ( )

Returns: string

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

References $filename.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->filename;
         }

Here is the caller graph for this function:

◆ getFont()

ilPDFGenerationJob::getFont ( )

Returns: array

Definition at line 124 of file class.ilPDFGenerationJob.php.

References $font.

         {
                 return $this->font;
         }

◆ getFooter()

ilPDFGenerationJob::getFooter ( )

Returns: string

Definition at line 142 of file class.ilPDFGenerationJob.php.

References $footer.

         {
                 return $this->footer;
         }

◆ getFooterFont()

ilPDFGenerationJob::getFooterFont ( )

Returns: array

Definition at line 160 of file class.ilPDFGenerationJob.php.

References $footer_font.

         {
                 return $this->footer_font;
         }

◆ getHeader()

ilPDFGenerationJob::getHeader ( )

Returns: string

Definition at line 178 of file class.ilPDFGenerationJob.php.

References $header.

         {
                 return $this->header;
         }

◆ getHeaderFont()

ilPDFGenerationJob::getHeaderFont ( )

Returns: array

Definition at line 196 of file class.ilPDFGenerationJob.php.

References $header_font.

         {
                 return $this->header_font;
         }

◆ getImageScale()

ilPDFGenerationJob::getImageScale ( )

Returns: float

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

References $image_scale.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->image_scale;
         }

Here is the caller graph for this function:

◆ getKeywords()

ilPDFGenerationJob::getKeywords ( )

Returns: string

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

References $keywords.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->keywords;
         }

Here is the caller graph for this function:

◆ getMarginBottom()

ilPDFGenerationJob::getMarginBottom ( )

Returns: string

Definition at line 250 of file class.ilPDFGenerationJob.php.

References $margin_bottom.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->margin_bottom;
         }

Here is the caller graph for this function:

◆ getMarginLeft()

ilPDFGenerationJob::getMarginLeft ( )

Returns: string

Definition at line 268 of file class.ilPDFGenerationJob.php.

References $margin_left.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->margin_left;
         }

Here is the caller graph for this function:

◆ getMarginRight()

ilPDFGenerationJob::getMarginRight ( )

Returns: string

Definition at line 286 of file class.ilPDFGenerationJob.php.

References $margin_right.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->margin_right;
         }

Here is the caller graph for this function:

◆ getMarginTop()

ilPDFGenerationJob::getMarginTop ( )

Returns: string

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

References $margin_top.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->margin_top;
         }

Here is the caller graph for this function:

◆ getOutputMode()

ilPDFGenerationJob::getOutputMode ( )

Returns: string

Definition at line 396 of file class.ilPDFGenerationJob.php.

References $output_mode.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->output_mode;
         }

Here is the caller graph for this function:

◆ getPages()

ilPDFGenerationJob::getPages ( )

Returns: string[] Array of html-strings.

Definition at line 323 of file class.ilPDFGenerationJob.php.

References $pages.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->pages;
         }

Here is the caller graph for this function:

◆ getSubject()

ilPDFGenerationJob::getSubject ( )

Returns: string

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

References $subject.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->subject;
         }

Here is the caller graph for this function:

◆ getTitle()

ilPDFGenerationJob::getTitle ( )

Returns: string

Definition at line 378 of file class.ilPDFGenerationJob.php.

References $title.

Referenced by ilTCPDFGenerator\generatePDF().

         {
                 return $this->title;
         }

Here is the caller graph for this function:

◆ setAuthor()

ilPDFGenerationJob::setAuthor ( $author )

Parameters

string $author

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

References $author.

         {
                 $this->author = $author;
         }

◆ setAutoPageBreak()

ilPDFGenerationJob::setAutoPageBreak ( $auto_page_break )

Parameters

boolean $auto_page_break

Returns: $this

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

References $auto_page_break.

         {
                 $this->auto_page_break = $auto_page_break;
                 return $this;
         }

◆ setCreator()

ilPDFGenerationJob::setCreator ( $creator )

Parameters

string $creator

Returns: $this

Definition at line 79 of file class.ilPDFGenerationJob.php.

References $creator.

         {
                 $this->creator = $creator;
                 return $this;
         }

◆ setFilename()

ilPDFGenerationJob::setFilename ( $filename )

Parameters

string $filename

Returns: $this

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

References $filename.

         {
                 $this->filename = $filename;
                 return $this;
         }

◆ setFont()

ilPDFGenerationJob::setFont ( $font )

Parameters

array $font

Returns: $this

Definition at line 115 of file class.ilPDFGenerationJob.php.

References $font.

         {
                 $this->font = $font;
                 return $this;
         }

◆ setFooter()

ilPDFGenerationJob::setFooter ( $footer )

Parameters

string $footer

Returns: $this

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

References $footer.

         {
                 $this->footer = $footer;
                 return $this;
         }

◆ setFooterFont()

ilPDFGenerationJob::setFooterFont ( $footer_font )

Parameters

array $footer_font

Returns: $this

Definition at line 151 of file class.ilPDFGenerationJob.php.

References $footer_font.

         {
                 $this->footer_font = $footer_font;
                 return $this;
         }

◆ setHeader()

ilPDFGenerationJob::setHeader ( $header )

Parameters

string $header

Returns: $this

Definition at line 169 of file class.ilPDFGenerationJob.php.

References $header.

         {
                 $this->header = $header;
                 return $this;
         }

◆ setHeaderFont()

ilPDFGenerationJob::setHeaderFont ( $header_font )

Parameters

array $header_font

Returns: $this

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

References $header_font.

         {
                 $this->header_font = $header_font;
                 return $this;
         }

◆ setImageScale()

ilPDFGenerationJob::setImageScale ( $image_scale )

Parameters

float $image_scale Image scale factor

Returns: $this

Definition at line 205 of file class.ilPDFGenerationJob.php.

References $image_scale.

         {
                 $this->image_scale = $image_scale;
                 return $this;
         }

◆ setKeywords()

ilPDFGenerationJob::setKeywords ( $keywords )

Parameters

string $keywords

Returns: $this

Definition at line 223 of file class.ilPDFGenerationJob.php.

References $keywords.

         {
                 $this->keywords = $keywords;
                 return $this;
         }

◆ setMarginBottom()

ilPDFGenerationJob::setMarginBottom ( $margin_bottom )

Parameters

string $margin_bottom

Returns: $this

Definition at line 241 of file class.ilPDFGenerationJob.php.

References $margin_bottom.

         {
                 $this->margin_bottom = $margin_bottom;
                 return $this;
         }

◆ setMarginLeft()

ilPDFGenerationJob::setMarginLeft ( $margin_left )

Parameters

string $margin_left

Returns: $this

Definition at line 259 of file class.ilPDFGenerationJob.php.

References $margin_left.

         {
                 $this->margin_left = $margin_left;
                 return $this;
         }

◆ setMarginRight()

ilPDFGenerationJob::setMarginRight ( $margin_right )

Parameters

string $margin_right

Returns: $this

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

References $margin_right.

         {
                 $this->margin_right = $margin_right;
                 return $this;
         }

◆ setMarginTop()

ilPDFGenerationJob::setMarginTop ( $margin_top )

Parameters

string $margin_top

Returns: $this

Definition at line 295 of file class.ilPDFGenerationJob.php.

References $margin_top.

         {
                 $this->margin_top = $margin_top;
                 return $this;
         }

◆ setOutputMode()

ilPDFGenerationJob::setOutputMode ( $output_mode )

Parameters

string $output_mode

Returns: $this

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

References $output_mode.

         {
                 $this->output_mode = $output_mode;
                 return $this;
         }

◆ setPages()

ilPDFGenerationJob::setPages ( $pages )

Parameters

$pages string[] Array of html-strings.

Returns: $this

Definition at line 314 of file class.ilPDFGenerationJob.php.

References $pages.

         {
                 $this->pages = $pages;
                 return $this;
         }

◆ setSubject()

ilPDFGenerationJob::setSubject ( $subject )

Parameters

string $subject

Returns: $this

Definition at line 351 of file class.ilPDFGenerationJob.php.

References $subject.

         {
                 $this->subject = $subject;
                 return $this;
         }

◆ setTitle()

ilPDFGenerationJob::setTitle ( $title )

Parameters

string $title

Returns: $this

Definition at line 369 of file class.ilPDFGenerationJob.php.

References $title.

         {
                 $this->title = $title;
                 return $this;
         }

Field Documentation

◆ $author

ilPDFGenerationJob::$author

private

Definition at line 19 of file class.ilPDFGenerationJob.php.

Referenced by getAuthor(), and setAuthor().

◆ $auto_page_break

ilPDFGenerationJob::$auto_page_break

private

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

Referenced by getAutoPageBreak(), and setAutoPageBreak().

◆ $creator

ilPDFGenerationJob::$creator

private

Definition at line 20 of file class.ilPDFGenerationJob.php.

Referenced by getCreator(), and setCreator().

◆ $filename

ilPDFGenerationJob::$filename

private

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

Referenced by getFilename(), and setFilename().

◆ $font

ilPDFGenerationJob::$font

private

Definition at line 18 of file class.ilPDFGenerationJob.php.

Referenced by getFont(), and setFont().

◆ $footer

ilPDFGenerationJob::$footer

private

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

Referenced by getFooter(), and setFooter().

◆ $footer_font

ilPDFGenerationJob::$footer_font

private

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

Referenced by getFooterFont(), and setFooterFont().

◆ $header

ilPDFGenerationJob::$header

private

Definition at line 23 of file class.ilPDFGenerationJob.php.

Referenced by getHeader(), and setHeader().

◆ $header_font

ilPDFGenerationJob::$header_font

private

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

Referenced by getHeaderFont(), and setHeaderFont().

◆ $image_scale

ilPDFGenerationJob::$image_scale = 1

private

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

Referenced by getImageScale(), and setImageScale().

◆ $keywords

ilPDFGenerationJob::$keywords

private

Definition at line 27 of file class.ilPDFGenerationJob.php.

Referenced by getKeywords(), and setKeywords().

◆ $margin_bottom

ilPDFGenerationJob::$margin_bottom

private

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

Referenced by getMarginBottom(), and setMarginBottom().

◆ $margin_left

ilPDFGenerationJob::$margin_left

private

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

Referenced by getMarginLeft(), and setMarginLeft().

◆ $margin_right

ilPDFGenerationJob::$margin_right

private

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

Referenced by getMarginRight(), and setMarginRight().

◆ $margin_top

ilPDFGenerationJob::$margin_top

private

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

Referenced by getMarginTop(), and setMarginTop().

◆ $output_mode

ilPDFGenerationJob::$output_mode

private

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

Referenced by getOutputMode(), and setOutputMode().

◆ $pages

ilPDFGenerationJob::$pages

private

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

Referenced by getPages(), and setPages().

◆ $subject

ilPDFGenerationJob::$subject

private

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

Referenced by getSubject(), and setSubject().

◆ $title

ilPDFGenerationJob::$title

private

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

Referenced by getTitle(), and setTitle().

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

Services/PDFGeneration/classes/class.ilPDFGenerationJob.php

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addPage()

◆ flushPages()

◆ getAuthor()

◆ getAutoPageBreak()

◆ getCreator()

◆ getFilename()

◆ getFont()

◆ getFooter()

◆ getFooterFont()

◆ getHeader()

◆ getHeaderFont()

◆ getImageScale()

◆ getKeywords()

◆ getMarginBottom()

◆ getMarginLeft()

◆ getMarginRight()

◆ getMarginTop()

◆ getOutputMode()

◆ getPages()

◆ getSubject()

◆ getTitle()

◆ setAuthor()

◆ setAutoPageBreak()

◆ setCreator()

◆ setFilename()

◆ setFont()

◆ setFooter()

◆ setFooterFont()

◆ setHeader()

◆ setHeaderFont()

◆ setImageScale()

◆ setKeywords()

◆ setMarginBottom()

◆ setMarginLeft()

◆ setMarginRight()

◆ setMarginTop()

◆ setOutputMode()

◆ setPages()

◆ setSubject()

◆ setTitle()

Field Documentation

◆ $author

◆ $auto_page_break

◆ $creator

◆ $filename

◆ $font

◆ $footer

◆ $footer_font

◆ $header

◆ $header_font

◆ $image_scale

◆ $keywords

◆ $margin_bottom

◆ $margin_left

◆ $margin_right

◆ $margin_top

◆ $output_mode

◆ $pages

◆ $subject

◆ $title