class PdfExportControllerExtension extends Extension (View source)

Properties

protected object $owner

The object this extension is applied to.

from  Extension

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
object
getOwner()

Returns the owner of this extension.

public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

public
HTTPResponse|false
downloadpdf()

Serve the page rendered as PDF.

public
string
getPDFBaseURL()

This will return either pdf_base_url from YML, CWP_SECURE_DOMAIN from _ss_environment, or blank. In that order of importance.

public
string
getPDFProxy($pdfBaseUrl)

Don't use the proxy if the pdf domain is the CWP secure domain or if we aren't on a CWP server

public
HTTPResponse|false
generatePDF()

Render the page as PDF using wkhtmltopdf.

Details

__construct()

No description

static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

object getOwner()

Returns the owner of this extension.

Return Value

object

static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

HTTPResponse|false downloadpdf()

Serve the page rendered as PDF.

Return Value

HTTPResponse|false

string getPDFBaseURL()

This will return either pdf_base_url from YML, CWP_SECURE_DOMAIN from _ss_environment, or blank. In that order of importance.

Return Value

string

string getPDFProxy($pdfBaseUrl)

Don't use the proxy if the pdf domain is the CWP secure domain or if we aren't on a CWP server

Parameters

$pdfBaseUrl

Return Value

string

HTTPResponse|false generatePDF()

Render the page as PDF using wkhtmltopdf.

Return Value

HTTPResponse|false