GemsTracker library API » \Gems_Tracker_Source

Constants

A fieldmap object adds LS source code knowledge and interpretation to the database data about a survey. This enables the code to work with the survey object.

package	Gems
subpackage	Tracker
copyright	Copyright (c) 2011 Erasmus MC
license	New BSD License
since	Class available since version 1.4
inherited_from	\Gems_Tracker_Source_LimeSurvey1m9FieldMap

Methods

Construct a fieldmap object to add LS source code knowledge and interpretation to the database data about a survey.

__construct(integer $sourceSurveyId, string $language, \Zend_Db_Adapter_Abstract $lsDb, \Zend_Translate $translate, \type $tablePrefix)

Inherited

Parameters

$sourceSurveyId

integer

Survey ID

$language

string

(ISO) Language

$lsDb

\Zend_Db_Adapter_Abstract

The Lime Survey database connection

$translate

\Zend_Translate

A translate object

$tablePrefix

\type

The prefix to use for all LS tables (in this installation)

Applies the fieldmap data to the model

applyToModel(\MUtil_Model_ModelAbstract $model)

inherited_from	\Gems_Tracker_Source_LimeSurvey1m9FieldMap::applyToModel()

Parameters

$model

\MUtil_Model_ModelAbstract

Applies the fieldmap data to the model

applyToModel(\MUtil_Model_ModelAbstract $model)

Inherited

Parameters

$model

\MUtil_Model_ModelAbstract

Returns an array containing fieldname => label for dropdown list etc.

getFullQuestionList(string $forType = false) : array

Inherited

Parameters

$forType

string

Optional type filter

Returns

arrayfieldname => label

Returns an array of array with the structure: question => string, class => question|question_sub group => is for grouping type => (optional) source specific type answers => string for single types, array for selection of, nothing for no answer

getQuestionInformation() : array

Inherited

Returns

arrayNested array

Returns an array containing fieldname => label for dropdown list etc.

getQuestionList(string $forType = false) : array

Inherited

Parameters

$forType

string

Optional type filter

Returns

arrayfieldname => label

Function to cast numbers as float, but leave null intact

handleFloat(\The $value) : float

Parameters

$value

\The

number to cast to float

Returns

float

Changes the keys of the values array to the more readable titles also available in LimeSurvey

mapKeysToTitles(array $values)

Inherited

Parameters

$values

array

Changes the keys of the values array to the more readable titles also available in LimeSurvey

mapTitlesToKeys(array $values)

Inherited

Parameters

$values

array

Removes all markup from input

removeMarkup(string $text) : string

Inherited

Parameters

$text

string

Input possibly containing html

Returns

string

The answers table contains code => answer sets per question/language/scale_id

_getAnswersTableName() : string

Inherited

Returns

stringname of the answers table

The groups table contains group texts per group id / language

_getGroupsTableName() : string

Inherited

Returns

stringname of the groups table

_getMap()

_getMap()

Inherited

Return an array with all possible answers for a given sid/field combination

_getMultiOptions($field)

Inherited

Parameters

$field

Field from getFieldMap function

Return a certain question attribute or the default value if it does not exist.

_getQuestionAttribute(string $qid, string $subId, \mxied $default = null) : mixed

Inherited

Parameters

$qid

string

$subId

string

$default

\mxied

Returns

mixed

The question attributes table contains all non-translateable settings for a question, e.g. 'page_break'

_getQuestionAttributesTableName() : string

Inherited

Returns

stringname of the question attributes table

The question table contains one row per language per question per survey in LS.

_getQuestionsTableName() : string

Inherited

All non-text data is replicated over all the question/language rows.

Returns

stringname of the questions table

There exists a survey table for each active survey. The table contains the answers to the survey

_getSurveyTableName() : string

Inherited

Returns

stringName of survey table for this survey

The survey table contains one row per each survey in LS

_getSurveysTableName() : string

Inherited

Returns

stringname of the surveys table

Returns

_getType($field) : integer

Inherited

Parameters

$field

Field from _getMap function

Returns

integer\MUtil_Model::TYPE_ constant

getDateFormats()

getDateFormats($fieldname, $type)

Inherited

Parameters

$fieldname

$type

getFieldTableDataType()

getFieldTableDataType($fieldname)

Inherited

Parameters

$fieldname

loadTableMetaData()

loadTableMetaData()

Inherited

_getFixedAnswers()

_getFixedAnswers($type)

Inherited

Parameters

$type

Returns the answers for a matrix or list type question from the answers table

_getHardAnswers(integer $qid, integer $scale_id)

Inherited

Uses 1 query to retrieve all answers and serves them as needed

Parameters

$qid

integer

Question ID

$scale_id

integer

Scale ID

Return an array with all possible answers for a given sid/field combination

_getPossibleAnswers($field)

Inherited

Parameters

$field

Field from getFieldMap function

Returns a map of databasecode => questioncode

_getTitlesMap() : array

Inherited

Returns

array

Properties

$_answers

$_answers

Default

$_attributes

$_attributes

Default

$_fieldMap

$_fieldMap

Default

$_hardAnswers

$_hardAnswers

Default

$_titlesMap

$_titlesMap

Default

$cache

$cache : \Zend_Cache_Core

Default

The language of this fieldmap

$language : string

Default

Limesurvey database adapter

$ldDb : \Zend_Db_Adapter_Abstract

Default

The Lime Survey survey Id

$sourceSurveyId : integer

Default

$tableMetaData

$tableMetaData

Default

Prefix to add to standard table name

$tablePrefix : string

Default

$translate

$translate : \Zend_Translate

Default

Constants

ANSWERS_TABLE

ANSWERS_TABLE = 'answers'

ATTRIBUTES_TABLE

ATTRIBUTES_TABLE = 'question_attributes'

GROUPS_TABLE

GROUPS_TABLE = 'groups'

Internal type, used for startdate, submitdate, datestamp fields

INTERNAL = 'stamp'

QUESTIONS_TABLE

QUESTIONS_TABLE = 'questions'