Screenshot Class Reference

Public Member Functions
	__construct ($uri, $ssl=false, $useToken=true, $output=null, $landscape=false)
	Creates a new PDF object configured to generate a PDF from the supplied URI on the local web application. More...
	coverPage ($url)
	Provides a separate URL to use as the cover page of the PDF. More...
	footer ($text, $position="center", $size=11)
	generate ()

Public Attributes
	$uri
	$ssl
	$output
	$footer
	$landscape = false

Detailed Description

Definition at line 413 of file pdf.inc.

Constructor & Destructor Documentation

__construct()

Screenshot::__construct	(		$uri,
			$ssl = false,
			$useToken = true,
			$output = null,
			$landscape = false
	)

Creates a new PDF object configured to generate a PDF from the supplied URI on the local web application.

Parameters

string	$uri	the URI that will generate the content for the PDF
boolean	$ssl	whether to use SSL to access the URI
boolean	$useToken	set to true to use an AutoLogin token to use the credentials of the currently logged in user to generate the PDF content
string	$output	(optional) a local output file path if the PDF output is to be saved to disk (for caching, or as an intermeediate step)
boolean	$landscape	true for landscape orientated output, false for portrait oriented output (the default)

Definition at line 430 of file pdf.inc.

     {
          $this->uri = $uri;
          $this->ssl = $ssl;
          $this->useToken = $useToken;
          $this->output = $output;
          $this->landscape = $landscape;
          $this->convertor = PdfManager::createConvertor($this);
     }

Member Function Documentation

coverPage()

Screenshot::coverPage

(

$url

)

Provides a separate URL to use as the cover page of the PDF.

Parameters

string

$url

the URL used to generate the cover page

Returns

PDF

Definition at line 446 of file pdf.inc.

     {
          $this->convertor->coverPage($url);
     }

footer()

Screenshot::footer	(		$text,
			$position = "center",
			$size = 11
	)

Parameters

$text	- text of the footer
$position	- valid positions are left, right, and center
$size	- font size for the footer ?? doesn't work

Definition at line 457 of file pdf.inc.

     {
          $this->convertor->footer($text, $position, $size);
     }

generate()

Screenshot::generate

(

)

Definition at line 462 of file pdf.inc.

     {
          return $this->convertor->screenshot();
     }

Member Data Documentation

$footer

Screenshot::$footer

Definition at line 418 of file pdf.inc.

$landscape

Screenshot::$landscape = false

Definition at line 419 of file pdf.inc.

$output

Screenshot::$output

Definition at line 417 of file pdf.inc.

$ssl

Screenshot::$ssl

Definition at line 416 of file pdf.inc.

$uri

Screenshot::$uri

Definition at line 415 of file pdf.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/pdf/pdf.inc