ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilPDFGenerationJob Class Reference

Class ilPDFGenerationJob. More...

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

333 {
334 $this->pages[] = $page;
335 return $this;
336 }

◆ flushPages()

ilPDFGenerationJob::flushPages ( )
Returns
$this

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

342 {
343 $this->pages = array();
344 return $this;
345 }

◆ getAuthor()

ilPDFGenerationJob::getAuthor ( )
Returns
string

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

References $author.

Referenced by ilTCPDFGenerator\generatePDF().

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

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

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

+ Here is the caller graph for this function:

◆ getFont()

ilPDFGenerationJob::getFont ( )
Returns
array

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

125 {
126 return $this->font;
127 }

References $font.

◆ getFooter()

ilPDFGenerationJob::getFooter ( )
Returns
string

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

References $footer.

◆ getFooterFont()

ilPDFGenerationJob::getFooterFont ( )
Returns
array

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

References $footer_font.

◆ getHeader()

ilPDFGenerationJob::getHeader ( )
Returns
string

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

References $header.

◆ getHeaderFont()

ilPDFGenerationJob::getHeaderFont ( )
Returns
array

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

References $header_font.

◆ getImageScale()

ilPDFGenerationJob::getImageScale ( )
Returns
float

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

References $image_scale.

Referenced by ilTCPDFGenerator\generatePDF().

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

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

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

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

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

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

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

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

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

+ Here is the caller graph for this function:

◆ setAuthor()

ilPDFGenerationJob::setAuthor (   $author)
Parameters
string$author

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

63 {
64 $this->author = $author;
65 }

References $author.

◆ setAutoPageBreak()

ilPDFGenerationJob::setAutoPageBreak (   $auto_page_break)
Parameters
boolean$auto_page_break
Returns
$this

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

46 {
47 $this->auto_page_break = $auto_page_break;
48 return $this;
49 }

References $auto_page_break.

◆ setCreator()

ilPDFGenerationJob::setCreator (   $creator)
Parameters
string$creator
Returns
$this

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

80 {
81 $this->creator = $creator;
82 return $this;
83 }

References $creator.

◆ setFilename()

ilPDFGenerationJob::setFilename (   $filename)
Parameters
string$filename
Returns
$this

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

98 {
99 $this->filename = $filename;
100 return $this;
101 }

References $filename.

◆ setFont()

ilPDFGenerationJob::setFont (   $font)
Parameters
array$font
Returns
$this

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

116 {
117 $this->font = $font;
118 return $this;
119 }

References $font.

◆ setFooter()

ilPDFGenerationJob::setFooter (   $footer)
Parameters
string$footer
Returns
$this

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

134 {
135 $this->footer = $footer;
136 return $this;
137 }

References $footer.

◆ setFooterFont()

ilPDFGenerationJob::setFooterFont (   $footer_font)
Parameters
array$footer_font
Returns
$this

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

152 {
153 $this->footer_font = $footer_font;
154 return $this;
155 }

References $footer_font.

◆ setHeader()

ilPDFGenerationJob::setHeader (   $header)
Parameters
string$header
Returns
$this

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

170 {
171 $this->header = $header;
172 return $this;
173 }

References $header.

◆ setHeaderFont()

ilPDFGenerationJob::setHeaderFont (   $header_font)
Parameters
array$header_font
Returns
$this

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

188 {
189 $this->header_font = $header_font;
190 return $this;
191 }

References $header_font.

◆ setImageScale()

ilPDFGenerationJob::setImageScale (   $image_scale)
Parameters
float$image_scaleImage scale factor
Returns
$this

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

206 {
207 $this->image_scale = $image_scale;
208 return $this;
209 }

References $image_scale.

◆ setKeywords()

ilPDFGenerationJob::setKeywords (   $keywords)
Parameters
string$keywords
Returns
$this

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

224 {
225 $this->keywords = $keywords;
226 return $this;
227 }

References $keywords.

◆ setMarginBottom()

ilPDFGenerationJob::setMarginBottom (   $margin_bottom)
Parameters
string$margin_bottom
Returns
$this

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

242 {
243 $this->margin_bottom = $margin_bottom;
244 return $this;
245 }

References $margin_bottom.

◆ setMarginLeft()

ilPDFGenerationJob::setMarginLeft (   $margin_left)
Parameters
string$margin_left
Returns
$this

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

260 {
261 $this->margin_left = $margin_left;
262 return $this;
263 }

References $margin_left.

◆ setMarginRight()

ilPDFGenerationJob::setMarginRight (   $margin_right)
Parameters
string$margin_right
Returns
$this

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

278 {
279 $this->margin_right = $margin_right;
280 return $this;
281 }

References $margin_right.

◆ setMarginTop()

ilPDFGenerationJob::setMarginTop (   $margin_top)
Parameters
string$margin_top
Returns
$this

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

296 {
297 $this->margin_top = $margin_top;
298 return $this;
299 }

References $margin_top.

◆ setOutputMode()

ilPDFGenerationJob::setOutputMode (   $output_mode)
Parameters
string$output_mode
Returns
$this

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

388 {
389 $this->output_mode = $output_mode;
390 return $this;
391 }

References $output_mode.

◆ setPages()

ilPDFGenerationJob::setPages (   $pages)
Parameters
$pagesstring[] Array of html-strings.
Returns
$this

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

315 {
316 $this->pages = $pages;
317 return $this;
318 }

References $pages.

◆ setSubject()

ilPDFGenerationJob::setSubject (   $subject)
Parameters
string$subject
Returns
$this

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

352 {
353 $this->subject = $subject;
354 return $this;
355 }

References $subject.

◆ setTitle()

ilPDFGenerationJob::setTitle (   $title)
Parameters
string$title
Returns
$this

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

370 {
371 $this->title = $title;
372 return $this;
373 }

References $title.

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: