WebEnq4 PHP Documentation
Back to top  

Abstract downloader class

This class contains the common parts for all downloader classes. The inherited class is responsible for creating the right document type and preparing/sending the response 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()

Parameters

$value

string

$type

string

Returns

string

Class constructor

__construct(\Webenq_Model_Questionnaire $questionnaire) 

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

Parameters

$questionnaire

\Webenq_Model_Questionnaire

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

factory(string $format, \Webenq_Model_Questionnaire $questionnaire) 
Static

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

Parameters

$value

string

Returns

string

getCollectionPresentationTypes() 

getCollectionPresentationTypes() 
InheritedStatic
inherited_from \Webenq::getCollectionPresentationTypes()

Returns the name of the file for download

getDownloadFilename() 

getFilterInstance() 

getFilterInstance($name) 
InheritedStatic
inherited_from \Webenq::getFilterInstance()

Parameters

$name

getFilters() 

getFilters() 
InheritedStatic
inherited_from \Webenq::getFilters()

Returns the MIME type of the file for download

getMimeType() 

getReportPresentationTypes() 

getReportPresentationTypes() 
InheritedStatic
inherited_from \Webenq::getReportPresentationTypes()

getValidatorInstance() 

getValidatorInstance($name) 
InheritedStatic
inherited_from \Webenq::getValidatorInstance()

Parameters

$name

getValidators() 

getValidators() 
InheritedStatic
inherited_from \Webenq::getValidators()

Prepares the document

init() 

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.

Sends the document

send(\Zend_Controller_Response_Http $response) 

This method must be implemented by all downloader classes and should send the document to the client, using the provided response object.

Parameters

$response

\Zend_Controller_Response_Http

Manually sets the data

setData(array $data) : \Webenq_Download

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

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

setMaxExecutionTime() 

setMaxExecutionTime($value) 
InheritedStatic
inherited_from \Webenq::setMaxExecutionTime()

Parameters

$value

setMemoryLimit() 

setMemoryLimit($value) 
InheritedStatic
inherited_from \Webenq::setMemoryLimit()

Parameters

$value

 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
 

$_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
 

$_data : array
 

$_questionnaire : \Webenq_Model_Questionnaire

 Constants

 

COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES

COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES
 

COLLECTION_PRESENTATION_MULTIPLESELECT_LIST

COLLECTION_PRESENTATION_MULTIPLESELECT_LIST 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_MULTIPLESELECT_LIST
 

COLLECTION_PRESENTATION_OPEN_CURRENTDATE

COLLECTION_PRESENTATION_OPEN_CURRENTDATE 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_OPEN_CURRENTDATE
 

COLLECTION_PRESENTATION_OPEN_DATE

COLLECTION_PRESENTATION_OPEN_DATE 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_OPEN_DATE
 

COLLECTION_PRESENTATION_OPEN_TEXT

COLLECTION_PRESENTATION_OPEN_TEXT 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_OPEN_TEXT
 

COLLECTION_PRESENTATION_OPEN_TEXTAREA

COLLECTION_PRESENTATION_OPEN_TEXTAREA 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_OPEN_TEXTAREA
 

COLLECTION_PRESENTATION_RANGESELECT_SLIDER

COLLECTION_PRESENTATION_RANGESELECT_SLIDER 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_RANGESELECT_SLIDER
 

COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST

COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST
 

COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS

COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS
 

COLLECTION_PRESENTATION_SINGLESELECT_SLIDER

COLLECTION_PRESENTATION_SINGLESELECT_SLIDER 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_SINGLESELECT_SLIDER
 

COLLECTION_PRESENTATION_TEXT

COLLECTION_PRESENTATION_TEXT 
Inherited
inherited_from \Webenq::COLLECTION_PRESENTATION_TEXT