WebEnq4 PHP Documentation » \Webenq_Tool

Constants

Tool class for converting ClientA data

package	Webenq
author	Bart Huttinga <b.huttinga@nivocer.com>, Jaap-Andre de Hoop <j.dehoop@nivocer.com>

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_Tool::Xmlify()

Parameters

$value

string

$type

string

Returns

string

__construct()

__construct($filename)

Parameters

$filename

countRespondents()

countRespondents()

Return the given value converted for use as filename.

filename(string $value) : string

InheritedStatic

inherited_from	\Webenq::filename()
inherited_from	\Webenq_Tool::filename()

Parameters

$value

string

Returns

string

getAdapter()

getAdapter()

getCollectionPresentationTypes()

getCollectionPresentationTypes()

InheritedStatic

inherited_from	\Webenq::getCollectionPresentationTypes()
inherited_from	\Webenq_Tool::getCollectionPresentationTypes()

getData()

getData()

Returns a downloadable object

getDownload() : \Webenq_Download

Returns

\Webenq_Download

getFilterInstance()

getFilterInstance($name)

InheritedStatic

inherited_from	\Webenq::getFilterInstance()
inherited_from	\Webenq_Tool::getFilterInstance()

Parameters

$name

getFilters()

getFilters()

InheritedStatic

inherited_from	\Webenq::getFilters()
inherited_from	\Webenq_Tool::getFilters()

getNewData()

getNewData()

getReportPresentationTypes()

getReportPresentationTypes()

InheritedStatic

inherited_from	\Webenq::getReportPresentationTypes()
inherited_from	\Webenq_Tool::getReportPresentationTypes()

getValidatorInstance()

getValidatorInstance($name)

InheritedStatic

inherited_from	\Webenq::getValidatorInstance()
inherited_from	\Webenq_Tool::getValidatorInstance()

Parameters

$name

getValidators()

getValidators()

InheritedStatic

inherited_from	\Webenq::getValidators()
inherited_from	\Webenq_Tool::getValidators()

process()

process()

setFirstRespondentId()

setFirstRespondentId($id)

Parameters

$id

setMaxExecutionTime()

setMaxExecutionTime($value)

InheritedStatic

inherited_from	\Webenq::setMaxExecutionTime()
inherited_from	\Webenq_Tool::setMaxExecutionTime()

Parameters

$value

setMemoryLimit()

setMemoryLimit($value)

InheritedStatic

inherited_from	\Webenq::setMemoryLimit()
inherited_from	\Webenq_Tool::setMemoryLimit()

Parameters

$value

Returns the skeleton for the new data

_getModuleDataColumns() : array

Returns

array

Returns the modules found in the data the multiple response column at the beginning of the data are used to determin the modules, they start with '1: '

_getModules() : array

Returns

arrayModules

Returns the new data TODO function is processed twice, is that correct?

_getNewData() : array

Returns

array

Returns the column index that contains the respondents

_getRespondentColumn() : int

Returns

int

Returns the data for the given respondent

_getRespondentRow(string $respondent, array $data) : array

Parameters

$respondent

string

$data

array

Returns

array

Returns the respondents found in the data

_getRespondents() : array

Returns

arrayRespondents

Returns the modules attended by respondents found in the data

_getRespondentsModules() : array

Returns

arrayRespondentsModules

Checks if the given column number is for module answers

_isModuleColumn(int $column, array $moduleDataColumns, array $data) : bool

Parameters

$column

int

$moduleDataColumns

array

$data

array

Returns

bool

Merges the modules if the question texts are the same

_mergeModules(array $data, array $moduleDataColumns) : array

Parameters

$data

array

&$data

$moduleDataColumns

array

&$moduleDataColumns

Returns

array

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_Tool::$$_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_Tool::$$_validators

$_adapter

$_data : array

$_filename

$_firstRespondentId

$_moduleDataColumns : array

$_modules : array

$_newData : array

$_respondentColumn : int

$_respondents : array

$_respondentsModules : array

Constants

COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES

COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_MULTIPLESELECT_CHECKBOXES

COLLECTION_PRESENTATION_MULTIPLESELECT_LIST

COLLECTION_PRESENTATION_MULTIPLESELECT_LIST

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_MULTIPLESELECT_LIST
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_MULTIPLESELECT_LIST

COLLECTION_PRESENTATION_OPEN_CURRENTDATE

COLLECTION_PRESENTATION_OPEN_CURRENTDATE

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_OPEN_CURRENTDATE
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_OPEN_CURRENTDATE

COLLECTION_PRESENTATION_OPEN_DATE

COLLECTION_PRESENTATION_OPEN_DATE

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_OPEN_DATE
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_OPEN_DATE

COLLECTION_PRESENTATION_OPEN_TEXT

COLLECTION_PRESENTATION_OPEN_TEXT

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_OPEN_TEXT
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_OPEN_TEXT

COLLECTION_PRESENTATION_OPEN_TEXTAREA

COLLECTION_PRESENTATION_OPEN_TEXTAREA

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_OPEN_TEXTAREA
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_OPEN_TEXTAREA

COLLECTION_PRESENTATION_RANGESELECT_SLIDER

COLLECTION_PRESENTATION_RANGESELECT_SLIDER

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_RANGESELECT_SLIDER
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_RANGESELECT_SLIDER

COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST

COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_SINGLESELECT_DROPDOWNLIST

COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS

COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_SINGLESELECT_RADIOBUTTONS

COLLECTION_PRESENTATION_SINGLESELECT_SLIDER

COLLECTION_PRESENTATION_SINGLESELECT_SLIDER

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_SINGLESELECT_SLIDER
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_SINGLESELECT_SLIDER

COLLECTION_PRESENTATION_TEXT

COLLECTION_PRESENTATION_TEXT

Inherited

inherited_from	\Webenq::COLLECTION_PRESENTATION_TEXT
inherited_from	\Webenq_Tool::COLLECTION_PRESENTATION_TEXT