Class description of LimeSurvey1m91Database
Difference with 1.9 version:
| package | Gems |
|---|---|
| subpackage | Tracker |
| copyright | Copyright (c) 2011 Erasmus MC |
| license | New BSD License |
| since | Class available since version 1.4.1 |
| inherited_from | \Gems_Tracker_Source_LimeSurvey1m9Database |
__construct(array $sourceData, \Zend_Db_Adapter_Abstract $gemsDb)
| inherited_from | \Gems_Tracker_Source_SourceInterface::__construct() |
|---|
arrayThe information from gems__sources for this source.
\Zend_Db_Adapter_AbstractDo not want to copy db using registry because that is public and this should be private
checkSourceActive(integer $userId) : boolean
integerId of the user who takes the action (for logging)
booleanTrue if the source is activecheckSurvey(string $sourceSurveyId, integer $surveyId, integer $userId) : mixed
string
integer
integer
mixedmessage string or array of messagescopyTokenToSource(\Gems_Tracker_Token $token, string $language, integer $surveyId, string $sourceSurveyId = null) : integer
\Gems_Tracker_Token
string
integerGems Survey Id
stringOptional Survey Id used by source
\Gems_Tracker_Source_SurveyNotFoundException |
|---|
integer1 of the token was inserted or changed, 0 otherwisegetAnswerDateTime(string $fieldName, \Gems_Tracker_Token $token, integer $surveyId, string $sourceSurveyId = null) : \MUtil_Date
A seperate function as only the source knows what format the date/time value has.
stringName of answer field
\Gems_Tracker_TokenGems token object
integerGems Survey Id
stringOptional Survey Id used by source
\MUtil_Datedate time or nullgetAttributes()
getCompletedTokens(array $tokenIds, integer $sourceSurveyId) : array
Returns all tokens from the input array that are completed, by doing this in bulk we saved overhead and only do a deep check on the completed tokens.
array
integer
arraygetCompletionTime(\Gems_Tracker_Token $token, integer $surveyId, string $sourceSurveyId = null) : \MUtil_Date
A source always return null when it does not know this time (or does not know it well enough). In the case \Gems_Tracker_Token will do it's best to keep track by itself.
\Gems_Tracker_TokenGems token object
integerGems Survey Id
stringOptional Survey Id used by source
\MUtil_Datedate time or nullgetDatesList(string $language, integer $surveyId, string $sourceSurveyId = null) : array
Used in dropdown list etc..
string(ISO) language string
integerGems Survey Id
stringOptional Survey Id used by source
arrayfieldname => labelgetFullQuestionList(string $language, integer $surveyId, string $sourceSurveyId = null) : array
string(ISO) language string
integerGems Survey Id
stringOptional Survey Id used by source
arrayNested arraygetId() : integer
| inherited_from | \Gems_Tracker_Source_SourceInterface::getId() |
|---|
integerThe source Id of this sourcegetQuestionInformation(string $language, integer $surveyId, string $sourceSurveyId = null) : array
string(ISO) language string
integerGems Survey Id
stringOptional Survey Id used by source
arrayNested arraygetQuestionList(string $language, integer $surveyId, string $sourceSurveyId = null) : array
Used in dropdown list etc..
string(ISO) language string
integerGems Survey Id
stringOptional Survey Id used by source
arrayfieldname => labelgetRawTokenAnswerRow(string $tokenId, integer $surveyId, string $sourceSurveyId = null) : array
Function may return more fields than just the answers.
stringGems Token Id
integerGems Survey Id
stringOptional Survey Id used by source
arrayField => Value arraygetRawTokenAnswerRows(array $filter, integer $surveyId, string $sourceSurveyId = null) : array
Function may return more fields than just the answers.
arrayXXXXX
integerGems Survey Id
stringOptional Survey Id used by source
arrayOf nested Field => Value arrays indexed by tokenIdgetRawTokenAnswerRowsCount(array $filter, integer $surveyId, string $sourceSurveyId = null) : integer
Abstract implementation is not efficient, sources should handle this as efficient as possible.
| inherited_from | \Gems_Tracker_Source_SourceInterface::getRawTokenAnswerRowsCount() |
|---|
arrayfilter array
integerGems Survey Id
stringOptional Survey Id used by source
integergetRawTokenAnswerRowsSelect(array $filter, \type $surveyId, \type $sourceSurveyId = null) : \Zend_Db_Select
array
\type
\type
\Zend_Db_SelectgetSourceDatabase() : \Zend_Db_Adapter_Abstract
| inherited_from | \Gems_Tracker_Source_SourceInterface::getSourceDatabase() |
|---|
\Zend_Db_Adapter_AbstractgetStartTime(\Gems_Tracker_Token $token, integer $surveyId, string $sourceSurveyId = null) : \MUtil_Date
A source always return null when it does not know this time (or does not know it well enough). In the case \Gems_Tracker_Token will do it's best to keep track by itself.
\Gems_Tracker_TokenGems token object
integerGems Survey Id
stringOptional Survey Id used by source
\MUtil_Datedate time or nullgetSurveyAnswerModel(\Gems_Tracker_Survey $survey, string $language= null, string $sourceSurveyId= null) : \MUtil_Model_ModelAbstract
\Gems_Tracker_Survey
stringOptional (ISO) language string
stringOptional Survey Id used by source
\MUtil_Model_ModelAbstractgetTokenInfo(\Gems_Tracker_Token $token, \type $surveyId, \type $sourceSurveyId, array $fields = null) : \type
\Gems_Tracker_Token
\type
\type
array
\typegetTokenUrl(\Gems_Tracker_Token $token, string $language, integer $surveyId, string $sourceSurveyId) : string
\Gems_Tracker_TokenGems token object
string
integerGems Survey Id
stringOptional Survey Id used by source
stringThe url to start the surveyinSource(\Gems_Tracker_Token $token, integer $surveyId, string $sourceSurveyId = null) : boolean
\Gems_Tracker_TokenGems token object
integerGems Survey Id
stringOptional Survey Id used by source
booleanisCompleted(\Gems_Tracker_Token $token, integer $surveyId, string $sourceSurveyId = null) : boolean
\Gems_Tracker_TokenGems token object
integerGems Survey Id
stringOptional Survey Id used by source
booleanTrue if the token has completedsetRawTokenAnswers(\Gems_Tracker_Token $token, array $answers, integer $surveyId, string $sourceSurveyId = null) : true
\Gems_Tracker_TokenGems token object
arrayField => Value array
integerGems Survey Id
stringOptional Survey Id used by source
trueWhen answers changedsetTokenCompletionTime(\Gems_Tracker_Token $token, \Zend_Date|null $completionTime, integer $surveyId, string $sourceSurveyId = null)
\Gems_Tracker_TokenGems token object
\Zend_Datenull\Zend_Date or null
integerGems Survey Id (actually required)
stringOptional Survey Id used by source
synchronizeSurveyBatch(\Gems_Task_TaskRunnerBatch $batch, integer $userId) : array
| inherited_from | \Gems_Tracker_Source_SourceInterface::synchronizeSurveyBatch() |
|---|
\Gems_Task_TaskRunnerBatch
integerId of the user who takes the action (for logging)
arrayReturns an array of messagesupdateConsent(\Gems_Tracker_Token $token, integer $surveyId, string $sourceSurveyId= null, string $consentCode= null) : integer
\Gems_Tracker_Token
integerGems Survey Id
stringOptional Survey Id used by source
stringOptional consent code, otherwise code from token is used.
integer1 of the token was inserted or changed, 0 otherwise_checkReturnURI(string $sourceSurveyId, \Gems_Tracker_Survey $survey, array $messages)
_checkTokenTable(array $tokenTable) : array
| inherited_from | \Gems_Tracker_Source_LimeSurvey1m9Database::_checkTokenTable() |
|---|
array
arrayFieldname => change field commands_checkTokenTable(array $tokenTable) : array
array
arrayFieldname => change field commands_fillAttributeMap(\Gems_Tracker_Token $token) : array
Added the usesleft value.
| inherited_from | \Gems_Tracker_Source_LimeSurvey1m9Database::_fillAttributeMap() |
|---|
\Gems_Tracker_Token
arrayOf fieldname => value type_fillAttributeMap(\Gems_Tracker_Token $token) : array
\Gems_Tracker_Token
arrayOf fieldname => value type_filterAnswersOnly(integer $sourceSurveyId, array $answers) : array
integerSurvey ID
array
array_getFieldMap(integer $sourceSurveyId, string $language = null) : \Gems_Tracker_Source_LimeSurvey1m9FieldMap
integerSurvey ID
stringOptional (ISO) Language, uses default language for survey when null
\Gems_Tracker_Source_LimeSurvey1m9FieldMap_getGemsSurveysForSynchronisation() : array
arrayPairs gemsId => sourceId_getLanguage(integer $sourceSurveyId, string $language) : string
Uses the requested language if it exists for the survey, the default language for the survey otherwise
integerSurvey ID
string(ISO) Language
string(ISO) Language_getReturnURI() : string
string_getReturnURIDescription(string $language) : string
string
string_getSid(integer $surveyId) : integer
integer
integer_getSourceSurveysForSynchronisation() : array
arrayof sourceId values or false_getSurveyLanguagesTableName() : string
stringName of survey languages table_getSurveyTableName(integer $sourceSurveyId) : string
integerSurvey ID
stringName of survey table for this survey_getSurveysTableName() : string
stringName of survey table_getToken($tokenId, boolean $reverse = false) : string
booleanReverse the action to go from limesurvey to GemsTracker token (default is false)
string_getTokenFromSqlWhere(string $from, string $fieldName) : string
stringThe tokens that should not occur
stringName of database field to use
string_getTokenFromToSql(string $from, string $to, string $fieldName) : string
stringThe tokens that should not occur
stringThe tokens that replace them
stringName of database field to use
string_getTokenTableName(integer $sourceSurveyId) : string
integerSurvey ID
stringName of token table for this survey_isLanguage(integer $sourceSurveyId, string $language) : boolean
integerSurvey ID
string(ISO) Language
booleanTrue when the language is an existing language_updateGemsSurveyExists(array $surveyorSids, integer $userId) : array
arrayThe gsu_surveyor_id's that ARE in the source
integerId of the user who takes the action (for logging)
arrayThe names of the surveys that no longer exist_updateSource(array $values, integer $userId) : integer
arrayThe values that this source should be set to
integerThe current user
integer1 if data changed, 0 otherwiseaddDatabasePrefix(\return $tableName, boolean $addDatabaseName = true) : string
\return
booleanOptional, when true (= default) and there is a database name then it is prepended to the name.
stringfilterLimitOffset(array $filter, \Zend_Db_Select $select)
array
\Zend_Db_Select
getBaseUrl() : string
stringBase url for sourcegetSurveyData(integer $surveyId, string $field = null) : array
Uses internal caching to prevent multiple db lookups during a program run (so no caching beyond page generation time)
integer
stringOptional field to retrieve data for
arrayupdateTokens(integer $userId, $updateTokens = true) : integer
integerId of the user who takes the action (for logging)
integerThe number of tokens changed_extractFieldLength(string $typeDescr) : integer
stringE.g. int(11) or varchar(36)
integerIn case 11 or 36$_anonymizedField : string
'anonymized'| inherited_from | \Gems_Tracker_Source_LimeSurvey1m9Database::_anonymizedField |
|---|
$_anonymizedField : string
'private'$_attributeMap : array
array('respondentid' => 'attribute_1', 'organizationid' => 'attribute_2', 'consentcode' => 'attribute_3', 'resptrackid' => 'attribute_4')Should contain maps for respondentid, organizationid and consentcode.
$attributeSize : integer
255$locale : \Zend_Locale
$logger : \Gems_Log
$project : \Gems_Project_ProjectSettings
$request : \Zend_Controller_Request_Abstract
$tracker : \Gems_Tracker
$translate : \Zend_Translate
$util : \Gems_Util
$_fieldMaps : array
$_gemsDb : \Gems_Task_TaskRunnerBatch: \Zend_Db_Adapter_Abstract
$_languageMap : array
$_sourceData : array
$_sourceDb : \Zend_Db_Adapter_Abstract
CACHE_TOKEN_INFO = 'tokenInfo'
LS_DB_COMPLETION_FORMAT = 'yyyy-MM-dd HH:mm'
LS_DB_DATETIME_FORMAT = 'yyyy-MM-dd HH:mm:ss'
LS_DB_DATE_FORMAT = 'yyyy-MM-dd'
QUESTIONS_TABLE = 'questions'
SURVEYS_LANG_TABLE = 'surveys_languagesettings'
SURVEYS_TABLE = 'surveys'
SURVEY_TABLE = 'survey_'
TOKEN_TABLE = 'tokens_'