Contains functions and properties that are common to all writers.
All extending classes must implement the internalWrite(...) method and have access to functionality as described below:
TODO Write more docs here
package | Default |
---|
__construct()
close()
getAbbreviatedHeading(\SurveyObj $oSurvey,\FormattingOptions $oOptions,string $fieldName): string
getFullFieldSubHeading(\SurveyObj $oSurvey,\FormattingOptions $oOptions,string $fieldName): string
getFullHeading(\SurveyObj $oSurvey,\FormattingOptions $oOptions,string $fieldName): string
Force headingTextLength to null (old behaviour)
deprecated |
---|
\SurveyObj
\FormattingOptions
string
string
getFullQuestionHeading(\SurveyObj $oSurvey,\FormattingOptions $oOptions,string $fieldName): string
getHeadingCode(\SurveyObj $oSurvey,\FormattingOptions $oOptions,string $fieldName): string
getHeadingText(\SurveyObj $oSurvey,\FormattingOptions $oOptions,string $fieldName): string
getLongAnswer(\SurveyObj $oSurvey,\FormattingOptions $oOptions,string $fieldName,string $sValue): string
\SurveyObj
\FormattingOptions
string
string
string
getShortAnswer(\SurveyObj $oSurvey,\FormattingOptions $oOptions,string $fieldName,string $sValue): string
\SurveyObj
\FormattingOptions
string
string
string
init(\SurveyObj $oSurvey,mixed $sLanguageCode,\FormattingOptions $oOptions)
out( $content)
outputRecord(array $headers,array $values,\FormattingOptions $oOptions)
Implementations must use the data from these method calls to construct proper output for their output type and the given FormattingOptions.
array
array
\FormattingOptions
setGroupMap(\SurveyObj $survey,\FormattingOptions $oOptions): array
stripTagsFull( $string)
transformResponseValue(string $value,string $fieldType,\FormattingOptions $oOptions,string $column = null): string
All transforms should be processed during the execution of this function!
The final step in the transform is to apply a stripTagsFull on the $value. This occurs for ALL values whether or not any other transform is applied.
string
string
\FormattingOptions
string
The name of the column
string
translate( $key, $sLanguageCode)
write(\SurveyObj $oSurvey,string $sLanguageCode,\FormattingOptions $oOptions,boolean $bOutputHeaders = true)
The inialization process is dependent upon the survey being passed into the write function and so must be performed when the method is called and not prior to (such as in a constructor).
All extending classes must implement the internalWrite function which is the code that is called after all initialization is completed.
\SurveyObj
string
\FormattingOptions
boolean
Set if header should be given back
output :
separator :
hasOutputHeader :
maxLength :
handle :
customFieldmap :
headers :
sLanguageCode :
filename :
webfilename :