ilPDFGenerationJob Class Reference

Class ilPDFGenerationJob. More...

Collaboration diagram for ilPDFGenerationJob:

Public Member Functions
	setFilename ($filename)
	getFilename ()
	setPages ($pages)
	getPages ()
	addPage ($page)
	flushPages ()
	setOutputMode ($output_mode)
	getOutputMode ()

Private Attributes
	$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 62 of file class.ilPDFGenerationJob.php.

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

flushPages()

ilPDFGenerationJob::flushPages

(

)

Returns

$this

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

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

getFilename()

ilPDFGenerationJob::getFilename

(

)

Returns

string

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

    {
        return $this->filename;
    }

References $filename.

Referenced by ilTCPDFGenerator\generatePDF().

Here is the caller graph for this function:

getOutputMode()

ilPDFGenerationJob::getOutputMode

(

)

Returns

string

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

    {
        return $this->output_mode;
    }

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 53 of file class.ilPDFGenerationJob.php.

    {
        return $this->pages;
    }

References $pages.

Referenced by ilTCPDFGenerator\generatePDF().

Here is the caller graph for this function:

setFilename()

ilPDFGenerationJob::setFilename

(

$filename

)

Parameters

string

$filename

Returns

$this

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

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

References $filename.

setOutputMode()

ilPDFGenerationJob::setOutputMode

(

$output_mode

)

Parameters

string

$output_mode

Returns

$this

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

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

References $output_mode.

setPages()

ilPDFGenerationJob::setPages

(

$pages

)

Parameters

$pages

string[] Array of html-strings.

Returns

$this

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

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

References $pages.

Field Documentation

$filename

ilPDFGenerationJob::$filename

private

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

Referenced by getFilename(), and setFilename().

$output_mode

ilPDFGenerationJob::$output_mode

private

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

Referenced by getOutputMode(), and setOutputMode().

$pages

ilPDFGenerationJob::$pages

private

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

Referenced by getPages(), and setPages().

---

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

• Services/PDFGeneration/classes/class.ilPDFGenerationJob.php