WebEnq4 PHP Documentation » \Webenq_Download

Constants

Downloader class for PDF format

This class generates a PDF download and sends it to the client.

package	Webenq_Data_Export
author	Bart Huttinga

Methods

Return the given value converted for use with XML.

Xmlify(string $value, string $type) : string

InheritedStatic

The second parameter indicates the type of xml entity. Valid values are: tag, attribute, value.

inherited_from	\Webenq::Xmlify()
inherited_from	\Webenq_Download::Xmlify()
inherited_from	\Webenq_Download_Xls::Xmlify()

Parameters

$value

string

$type

string

Returns

string

Class constructor

__construct(\Webenq_Model_Questionnaire $questionnaire)

Inherited

Sets the questionnaire property and calls the init() method that must be implemented by all downloader classes.

inherited_from	\Webenq_Download::__construct()
inherited_from	\Webenq_Download_Xls::__construct()

Parameters

$questionnaire

\Webenq_Model_Questionnaire

addWorkingSheet()

addWorkingSheet(array $data)

Inherited

inherited_from	\Webenq_Download_Xls::addWorkingSheet()

Parameters

$data

Factory method for easily getting an instance of the right downloader class.

factory(string $format, \Webenq_Model_Questionnaire $questionnaire)

InheritedStatic

inherited_from	\Webenq_Download::factory()
inherited_from	\Webenq_Download_Xls::factory()

Parameters

$format

string

$questionnaire

\Webenq_Model_Questionnaire

Return the given value converted for use as filename.

filename(string $value) : string

InheritedStatic

inherited_from	\Webenq::filename()
inherited_from	\Webenq_Download::filename()
inherited_from	\Webenq_Download_Xls::filename()

Parameters

$value

string

Returns

string

getCollectionPresentationTypes()

getCollectionPresentationTypes()

InheritedStatic

inherited_from	\Webenq::getCollectionPresentationTypes()
inherited_from	\Webenq_Download::getCollectionPresentationTypes()
inherited_from	\Webenq_Download_Xls::getCollectionPresentationTypes()

Returns the name of the file for download

getDownloadFilename()

Inherited

inherited_from	\Webenq_Download::getDownloadFilename()
inherited_from	\Webenq_Download_Xls::getDownloadFilename()

getFilterInstance()

getFilterInstance($name)

InheritedStatic

inherited_from	\Webenq::getFilterInstance()
inherited_from	\Webenq_Download::getFilterInstance()
inherited_from	\Webenq_Download_Xls::getFilterInstance()

Parameters

$name

getFilters()

getFilters()

InheritedStatic

inherited_from	\Webenq::getFilters()
inherited_from	\Webenq_Download::getFilters()
inherited_from	\Webenq_Download_Xls::getFilters()

Returns the MIME type of the file for download

getMimeType()

Inherited

inherited_from	\Webenq_Download::getMimeType()
inherited_from	\Webenq_Download_Xls::getMimeType()

getReportPresentationTypes()

getReportPresentationTypes()

InheritedStatic

inherited_from	\Webenq::getReportPresentationTypes()
inherited_from	\Webenq_Download::getReportPresentationTypes()
inherited_from	\Webenq_Download_Xls::getReportPresentationTypes()

getValidatorInstance()

getValidatorInstance($name)

InheritedStatic

inherited_from	\Webenq::getValidatorInstance()
inherited_from	\Webenq_Download::getValidatorInstance()
inherited_from	\Webenq_Download_Xls::getValidatorInstance()

Parameters

$name

getValidators()

getValidators()

InheritedStatic

inherited_from	\Webenq::getValidators()
inherited_from	\Webenq_Download::getValidators()
inherited_from	\Webenq_Download_Xls::getValidators()

Prepares the document so that it can be send to the client.

init() : \Webenq_Download_Pdf

Inherited

This method must be implemented by all downloader classes and should prepare the document, so that it is ready to be send to the client.

inherited_from	\Webenq_Download_Xls::init()
fluent	This method is part of a fluent interface and will return the same instance

Returns

\Webenq_Download_Pdf

save()

save($fileNameBase)

Inherited

inherited_from	\Webenq_Download_Xls::save()

Parameters

$fileNameBase

Sends the document

send(\Zend_Controller_Response_Http $response)

Inherited

Sets and sends the headers using the provided response object. And then writes the document to the standard output.

inherited_from	\Webenq_Download_Xls::send()

Parameters

$response

\Zend_Controller_Response_Http

Manually sets the data

setData(array $data) : \Webenq_Download_Pdf

Inherited

This method can be used when a questionnaire has not been provided to the constructor, or when the provided questionnaire was empty

inherited_from	\Webenq_Download::setData()
inherited_from	\Webenq_Download_Xls::setData()
fluent	This method is part of a fluent interface and will return the same instance

Parameters

$data

array

Multidimensional array with questionnaire data (only the first sheet)

Returns

\Webenq_Download_Pdf

setMaxExecutionTime()

setMaxExecutionTime($value)

InheritedStatic

inherited_from	\Webenq::setMaxExecutionTime()
inherited_from	\Webenq_Download::setMaxExecutionTime()
inherited_from	\Webenq_Download_Xls::setMaxExecutionTime()

Parameters

$value

setMemoryLimit()

setMemoryLimit($value)

InheritedStatic

inherited_from	\Webenq::setMemoryLimit()
inherited_from	\Webenq_Download::setMemoryLimit()
inherited_from	\Webenq_Download_Xls::setMemoryLimit()

Parameters

$value

Returns a writer instance for the given document type.

_getWriter() : \PHPExcel_Writer_IWriter

Returns

\PHPExcel_Writer_IWriter

Properties

$_filters : array

Inherited

The key is the system name used for identifying the filters. The value of each entry is an array holding the keys 'name' (human readable name), 'class' (the class to use) and (optionally) 'options' (an array that holds the parameters to pass to the class' constructor).

inherited_from	\Webenq::$$_filters
inherited_from	\Webenq_Download::$$_filters
inherited_from	\Webenq_Download_Xls::$$_filters

$_validators : array

Inherited

The key is the system name used for identifying the validators. The value of each entry is an array holding the keys 'name' (human readable name), 'class' (the class to use) and (optionally) 'options' (an array that holds the parameters to pass to the class' constructor).

inherited_from	\Webenq::$$_validators
inherited_from	\Webenq_Download::$$_validators
inherited_from	\Webenq_Download_Xls::$$_validators

$_data : array

Inherited

inherited_from	\Webenq_Download::$$_data
inherited_from	\Webenq_Download_Xls::$$_data

$_document : \PHPExcel

Inherited

inherited_from	\Webenq_Download_Xls::$$_document

$_extension : string

$_mimeType : string

$_questionnaire : \Webenq_Model_Questionnaire

Inherited

inherited_from	\Webenq_Download::$$_questionnaire
inherited_from	\Webenq_Download_Xls::$$_questionnaire

Constants

COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES

COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES

COLLECTION_PRESENTATION_MULTIPLESELECT_LIST

COLLECTION_PRESENTATION_MULTIPLESELECT_LIST

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_MULTIPLESELECT_LIST
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_MULTIPLESELECT_LIST
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_MULTIPLESELECT_LIST

COLLECTION_PRESENTATION_OPEN_CURRENTDATE

COLLECTION_PRESENTATION_OPEN_CURRENTDATE

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_OPEN_CURRENTDATE
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_OPEN_CURRENTDATE
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_OPEN_CURRENTDATE

COLLECTION_PRESENTATION_OPEN_DATE

COLLECTION_PRESENTATION_OPEN_DATE

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_OPEN_DATE
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_OPEN_DATE
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_OPEN_DATE

COLLECTION_PRESENTATION_OPEN_TEXT

COLLECTION_PRESENTATION_OPEN_TEXT

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_OPEN_TEXT
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_OPEN_TEXT
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_OPEN_TEXT

COLLECTION_PRESENTATION_OPEN_TEXTAREA

COLLECTION_PRESENTATION_OPEN_TEXTAREA

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_OPEN_TEXTAREA
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_OPEN_TEXTAREA
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_OPEN_TEXTAREA

COLLECTION_PRESENTATION_RANGESELECT_SLIDER

COLLECTION_PRESENTATION_RANGESELECT_SLIDER

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_RANGESELECT_SLIDER
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_RANGESELECT_SLIDER
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_RANGESELECT_SLIDER

COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST

COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST

COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS

COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS

COLLECTION_PRESENTATION_SINGLESELECT_SLIDER

COLLECTION_PRESENTATION_SINGLESELECT_SLIDER

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_SINGLESELECT_SLIDER
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_SINGLESELECT_SLIDER
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_SINGLESELECT_SLIDER

COLLECTION_PRESENTATION_TEXT

COLLECTION_PRESENTATION_TEXT

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_TEXT
inherited_from	\Webenq_Download::COLLECTION_PRESENTATION_TEXT
inherited_from	\Webenq_Download_Xls::COLLECTION_PRESENTATION_TEXT