Interface description of SourceInterface for (external) survey sources.
| package | Gems |
|---|---|
| subpackage | Tracker |
| copyright | Copyright (c) 2011 Erasmus MC |
| license | New BSD License |
| since | Class available since version 1.2 |
__construct(array $sourceData, \Zend_Db_Adapter_Abstract $gemsDb)
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)
booleancheckSurvey(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 nullgetCompletionTime(\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 => labelgetId() : integer
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
.
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. The $filter param is an array of filters to apply to the selection, it has some special formatting rules. The key is the db-field to filter on and the value could be a value or an array of values to filter on.
Special keys that should be mapped to the right field by the source are: respondentid organizationid consentcode token
So a filter of [token]=>[abc-def][def-abc] will return the results for these two tokens while a filter of [organizationid] => 70 will return all results for this organization.
arrayfilter array
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
arrayfilter array
integerGems Survey Id
stringOptional Survey Id used by source
integergetSourceDatabase() : \Zend_Db_Adapter_Abstract
\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_ModelAbstractgetTokenUrl(\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: boolean
\Gems_Tracker_TokenGems token object
integerGems Survey Id
stringOptional Survey Id used by source
boolean/
public function hasBatch();
Checks whether the token is in the 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, $answers, integer $surveyId, string $sourceSurveyId = null) : true
Use $this->hasBatch to check for existence
\Gems_Tracker_TokenGems token object
array Field => 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
\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) : array: integer
\Gems_Tracker_Token
integerGems Survey Id
stringOptional Survey Id used by source
stringOptional consent code, otherwise code from token is used.
arrayReturns an array of messages
/
public function synchronizeSurveys($userId);
Updates the consent code of the the token in the source (if needed)integer1 of the token was inserted or changed, 0 otherwise