ilObjSurvey Class Reference

Inheritance diagram for ilObjSurvey:

Collaboration diagram for ilObjSurvey:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	create ($a_upload=false)
	update ($a_upload=false)
	createReference ()
	creates reference for object More...
	read ()
	addQuestion (int $question_id)
	Adds a question to the survey (used in importer!) More...
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	deleteSurveyRecord ()
	Deletes the survey from the database. More...
	deleteAllUserData (bool $reset_LP=true)
	Deletes all user data of a survey. More...
	removeSelectedSurveyResults (array $finished_ids)
	Deletes the user data of a given array of survey participants. More...
	getSurveyParticipants (?array $finished_ids=null, bool $force_non_anonymous=false, bool $include_invites=false)
	isComplete ()
	Check if survey is complete for use. More...
	hasQuestions ()
	saveCompletionStatus ()
	Saves the completion status of the survey. More...
	duplicateQuestionForSurvey (int $question_id, bool $a_force=false)
	Takes a question and creates a copy of the question for use in the survey. More...
	insertQuestion (int $question_id)
	Inserts a question in the survey and saves the relation to the database. More...
	isQuestionInSurvey (int $a_question_fi)
	insertQuestionblock (int $questionblock_id)
	saveUserSettings (int $usr_id, string $key, string $title, string $value)
	deleteUserSettings (int $id)
	getUserSettings (int $usr_id, string $key)
	saveToDb ()
	saveQuestionsToDb ()
	getQuestionGUI (string $questiontype, int $question_id)
	getQuestionType (int $question_id)
	getSurveyId ()
	setAnonymize (int $a_anonymize)
	set anonymize status More...
	getAnonymize ()
	setCalculateSumScore (bool $a_val)
	getCalculateSumScore ()
	isAccessibleWithoutCode ()
	hasAnonymizedResults ()
	loadFromDb ()
	loadQuestionsFromDb ()
	fixSequenceStructure ()
	setAuthor (string $author="")
	saveAuthorToMetadata (string $a_author="")
	Saves an authors name into the lifecycle metadata if no lifecycle metadata exists This will only be called for conversion of "old" surveys where the author hasn't been stored in the lifecycle metadata. More...
	getAuthor ()
	getShowQuestionTitles ()
	setShowQuestionTitles (bool $a_show)
	setIntroduction (string $introduction="")
	setOutro (string $outro="")
	getStartDate ()
	setStartDate (string $start_date="")
	setStartDateAndTime (string $start_date, string $start_time)
	getEndDate ()
	setEndDate (string $end_date="")
	hasStarted ()
	hasEnded ()
	setEndDateAndTime (string $end_date, string $end_time)
	getEvaluationAccess ()
	setEvaluationAccess (string $evaluation_access=self::EVALUATION_ACCESS_OFF)
	setActivationVisibility (bool $a_value)
	getActivationVisibility ()
	isActivationLimited ()
	setActivationLimited (bool $a_value)
	getIntroduction ()
	getOutro ()
	getExistingQuestions ()
	Gets the question id's of the questions which are already in the survey. More...
	getQuestionpoolTitles (bool $could_be_offline=false, bool $showPath=false)
	Returns the available question pools for the active user. More...
	moveQuestions (array $move_questions, int $target_index, int $insert_mode)
	Move questions and/or questionblocks to another position. More...
	removeQuestion (int $question_id)
	removeConstraintsConcerningQuestion (int $question_id)
	Remove constraints concerning a question with a given question_id. More...
	removeQuestions (array $remove_questions, array $remove_questionblocks)
	unfoldQuestionblocks (array $questionblocks)
	removeQuestionFromBlock (int $question_id, int $questionblock_id)
	addQuestionToBlock (int $question_id, int $questionblock_id)
	isQuestionInAnyBlock (int $a_question_fi)
	getQuestionblockQuestions (int $questionblock_id)
	getQuestionblockQuestionIds (int $questionblock_id)
	createQuestionblock (string $title, bool $show_questiontext, bool $show_blocktitle, array $questions, bool $compress_view=false)
	modifyQuestionblock (int $questionblock_id, string $title, bool $show_questiontext, bool $show_blocktitle, bool $compress_view=false)
	deleteConstraints (int $question_id)
	Deletes the constraints for a question. More...
	deleteConstraint (int $constraint_id)
	Deletes a single constraint. More...
	getSurveyQuestions (bool $with_answers=false)
	Returns the survey questions and questionblocks in an array. More...
	setObligatoryStates (array $obligatory_questions)
	Sets the obligatory states for questions in a survey from the questions form. More...
	getSurveyPages ()
	Returns the survey pages in an array (a page contains one or more questions) More...
	getNextPage (int $active_page_question_id, int $direction)
	Get current, previous or next page. More...
	getAvailableQuestionpools (bool $use_obj_id=false, bool $could_be_offline=false, bool $showPath=false, string $permission="read")
	Returns the available question pools for the active user. More...
	getPrecondition (int $constraint_id)
	Returns a precondition with a given id. More...
	getConstraints (int $question_id)
	Returns the constraints to a given question or questionblock. More...
	getVariables (int $question_id)
	Returns all variables (answer options/scale values) of a question. More...
	addConstraint (int $if_question_id, int $relation, float $value, int $conjunction)
	Adds a constraint. More...
	addConstraintToQuestion (int $to_question_id, int $constraint_id)
	updateConstraint (int $precondition_id, int $if_question_id, int $relation, float $value, int $conjunction)
	updateConjunctionForQuestions (array $questions, int $conjunction)
	getAllRelations (bool $short_as_key=false)
	deleteWorkingData (int $question_id, int $active_id)
	Deletes the working data of a question in the database. More...
	loadWorkingData (int $question_id, int $active_id)
	Gets the given answer data of a question in a run. More...
	finishSurvey (int $finished_id, int $appr_id=0)
	Finishes the survey creating an entry in the database. More...
	setPage (int $finished_id, int $page_id)
	Sets the number of the active survey page. More...
	sendNotificationMail (int $a_user_id, string $a_anonymize_id, int $a_appr_id=0)
	These mails are sent to tutors for each single participant that finishes a survey. More...
	getActiveID (int $user_id, string $anonymize_id, int $appr_id)
	Get run id. More...
	getLastActivePage (int $active_id)
	Returns the question id of the last active page a user visited in a survey. More...
	checkConstraint (array $constraint_data, ?array $working_data)
	Checks if a constraint is valid. More...
	getSurveyFinishedIds ()
	Get run ids. More...
	getUserSpecificResults (array $finished_ids)
	Calculates the evaluation data for the user specific results. More...
	getUserDataFromActiveId (int $active_id, bool $force_non_anonymous=false)
	Returns run information. More...
	getEvaluationByUser (array $questions, int $active_id)
	Calculates the evaluation data for a given run. More...
	getQuestionsTable (array $arrFilter)
	Retrieve data for question browser. More...
	getQuestionblocksTable (array $arrFilter)
	Retrieve data for question block browser. More...
	toXML ()
	Returns a QTI xml representation of the survey. More...
	locateImportFiles (string $a_dir)
	Locates the import directory and the xml file in a directory with an unzipped import file. More...
	importObject (array $file_info, int $svy_qpl_id)
	getTextblock (int $question_id)
	cloneTextblocks (array $mapping)
	Clones the text blocks of survey questions. More...
	createExportDirectory ()
	creates data directory for export files (data_dir/svy_data/svy_<id>/export) More...
	getExportDirectory ()
	createImportDirectory ()
	creates data directory for import files (data_dir/svy_data/svy_<id>/import) More...
	getImportDirectory ()
	get import directory of survey More...
	saveHeading (string $heading, int $insertbefore)
	isAnonymizedParticipant (string $key)
	getSurveyCodesForExport (?array $a_codes=null, ?array $a_ids=null)
	Return a list of survey codes for file export, note: user_key needs to be null to export a record. More...
	getSurveyCodesTableData (?array $ids=null, ?string $lang=null)
	Fetches the data for the survey codes table. More...
	isSurveyCodeUsed (string $code)
	isSurveyCodeUnique (string $code)
	importSurveyCode (string $a_anonymize_key, int $a_created, array $a_data)
	sendCodes (int $not_sent, string $subject, string $message, string $lang)
	getExternalCodeRecipients (bool $a_check_finished=false)
	isSurveyFinishedByCode (string $a_code)
	Get if survey is finished for a specific anonymous user code. More...
	deleteSurveyCode (string $survey_code)
	getUserAccessCode (int $user_id)
	Returns a survey access code that was saved for a registered user. More...
	saveUserAccessCode (int $user_id, string $access_code)
	Saves a survey access code for a registered user to the database. More...
	getLastAccess (int $finished_id)
	prepareTextareaOutput (string $txt_output)
	Prepares a string for a text area output in surveys. More...
	isHTML (string $a_text)
	Checks if a given string contains HTML or not. More...
	addMaterialTag (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true, ?array $attribs=null)
	Creates an XML material tag from a plain text or xhtml text. More...
	canExportSurveyCode ()
	Checks if the survey code can be exported with the survey evaluation. More...
	setSurveyId (int $survey_id)
	getUserData (array $ids)
	Returns a data of all users specified by id list. More...
	getMailNotification ()
	Send mail to tutors each time a participant finishes the survey? More...
	setMailNotification (bool $a_notification)
	Activate mail to tutors each time a participant finishes the survey. More...
	getMailAddresses ()
	(Tutor) Recipients of "single participant has finished" mails More...
	setMailAddresses (string $a_addresses)
	Set (Tutor) Recipients of "single participant has finished" mails. More...
	getMailParticipantData ()
	Preceding text (incl. More...
	setMailParticipantData (string $a_data)
	Set preceding text (incl. More...
	getWorkingtimeForParticipant (int $finished_id)
	updateOrder (array $a_order)
	getPoolUsage ()
	setPoolUsage (bool $a_value)
	updateCode (int $a_id, string $a_email, string $a_last_name, string $a_first_name, int $a_sent)
	get360Mode ()
	set360SelfEvaluation (bool $a_value)
	get360SelfEvaluation ()
	set360SelfAppraisee (bool $a_value)
	get360SelfAppraisee ()
	set360SelfRaters (bool $a_value)
	get360SelfRaters ()
	set360Results (int $a_value)
	get360Results ()
	addAppraisee (int $a_user_id)
	sendAppraiseeNotification (int $a_user_id)
	sendAppraiseeCloseNotification (int $a_user_id)
	sendRaterNotification (int $a_user_id, int $a_appraisee_id)
	isAppraisee (int $a_user_id)
	isAppraiseeClosed (int $a_user_id)
	deleteAppraisee (int $a_user_id)
	getAppraiseesData ()
	addRater (int $a_appraisee_id, int $a_user_id, int $a_anonymous_id=0)
	isRater (int $a_appraisee_id, int $a_user_id, int $a_anonymous_id=0)
	deleteRater (int $a_appraisee_id, int $a_user_id, int $a_anonymous_id=0)
	getRatersData (int $a_appraisee_id)
	getAppraiseesToRate (?int $a_user_id, ?int $a_anonymous_id=null)
	getAnonymousIdByCode (string $a_code)
	is360SurveyStarted (int $appr_id, int $user_id, ?string $anonymous_code=null)
	getUserSurveyExecutionStatus (?string $a_code=null)
	Get current user execution status. More...
	findCodeForUser (int $a_user_id)
	isUnusedCode (string $a_code, int $a_user_id)
	getFinishedIdsForAppraiseeId (int $a_appr_id, bool $a_exclude_appraisee=false)
	getFinishedIdForAppraiseeIdAndRaterId (int $a_appr_id, int $a_rat_id)
	Get finished id for an appraisee and a rater. More...
	setSkillService (bool $a_val)
	getSkillService ()
	set360RaterSent (int $a_appraisee_id, int $a_user_id, int $a_anonymous_id, ?int $a_tstamp=null)
	closeAppraisee (int $a_user_id)
	openAllAppraisees ()
	getReminderStatus ()
	setReminderStatus (bool $a_value)
	getReminderStart ()
	setReminderStart (?ilDate $a_value=null)
	getReminderEnd ()
	setReminderEnd (?ilDate $a_value=null)
	getReminderFrequency ()
	setReminderFrequency (int $a_value)
	getReminderTarget ()
	setReminderTarget (int $a_value)
	getReminderLastSent ()
	setReminderLastSent (?string $a_value)
	getReminderTemplate (bool $selectDefault=false)
	setReminderTemplate (?int $a_value)
	getTutorNotificationStatus ()
	setTutorNotificationStatus (bool $a_value)
	Activates mail being sent to tutors after all participants have finished the survey. More...
	getTutorNotificationRecipients ()
	Mail being sent to tutors after all participants have finished the survey? More...
	setTutorNotificationRecipients (array $a_value)
	Set tutor recipients for "all participants have finished" mail. More...
	getTutorNotificationTarget ()
	Group that is checked for the "all participants have finished" mail Either a) all members of a parent group/course or b) all users which have been invited (svy_invitation) (= task on dashboard) More...
	setTutorNotificationTarget (int $a_value)
	getTutorResultsStatus ()
	setTutorResultsStatus (bool $a_value)
	getTutorResultsRecipients ()
	setTutorResultsRecipients (array $a_value)
	sent360Reminders ()
	Send 360 reminders. More...
	send360ReminderToUser (int $a_user_id, array $a_appraisee_ids)
	getNotificationTargetUserIds (bool $a_use_invited)
	These users must finish the survey to trigger the tutor notification "all users finished the survey" a) members of a parent group/course or b) all members that have been invited (svy_invitation) invitations are presented as tasks on the dashboard. More...
	checkReminder ()
	setActivationStartDate (?int $starting_time=null)
	setActivationEndDate (?int $ending_time=null)
	getActivationStartDate ()
	getActivationEndDate ()
	setViewOwnResults (bool $a_value)
	hasViewOwnResults ()
	setMailOwnResults (bool $a_value)
	hasMailOwnResults ()
	setMailConfirmation (bool $a_value)
	hasMailConfirmation ()
	setAnonymousUserList (bool $a_value)
	hasAnonymousUserList ()
	getReminderMailTemplates (?int &$defaultTemplateId=null)
	setMode (int $a_value)
	getMode ()
	setSelfEvaluationResults (int $a_value)
	getSelfEvaluationResults ()
	getMaxSumScore ()
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_getQuestionblock (int $questionblock_id)
	get question block properties More...
static	_addQuestionblock (string $title="", int $owner=0, bool $show_questiontext=true, bool $show_blocktitle=false, bool $compress_view=false)
static	_getConstraints (int $survey_id)
static	_hasDatasets (int $survey_id)
static	_instanciateQuestion (int $question_id)
	Creates an instance of a question with a given question id. More...
static	getSurveySkippedValue ()
static	getSurveysWithTutorResults ()
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Data Fields
const	EVALUATION_ACCESS_OFF = "0"
const	EVALUATION_ACCESS_ALL = "1"
const	EVALUATION_ACCESS_PARTICIPANTS = "2"
const	ANONYMIZE_OFF = 0
const	ANONYMIZE_ON = 1
const	ANONYMIZE_FREEACCESS = 2
const	ANONYMIZE_CODE_ALL = 3
const	QUESTIONTITLES_HIDDEN = 0
const	QUESTIONTITLES_VISIBLE = 1
const	PRINT_HIDE_LABELS = 1
const	PRINT_SHOW_LABELS = 3
const	MODE_STANDARD = 0
const	MODE_360 = 1
const	MODE_SELF_EVAL = 2
const	MODE_IND_FEEDB = 3
const	RESULTS_SELF_EVAL_NONE = 0
const	RESULTS_SELF_EVAL_OWN = 1
const	RESULTS_SELF_EVAL_ALL = 2
const	RESULTS_360_NONE = 0
const	RESULTS_360_OWN = 1
const	RESULTS_360_ALL = 2
const	NOTIFICATION_PARENT_COURSE = 1
const	NOTIFICATION_INVITED_USERS = 2
const	NOTIFICATION_APPRAISEES = 3
const	NOTIFICATION_RATERS = 4
const	NOTIFICATION_APPRAISEES_AND_RATERS = 5
int	$survey_id = 0
	A unique positive numerical ID which identifies the survey. More...
string	$author = ""
	A text representation of the authors name. More...
string	$introduction = ""
string	$outro = ""
string	$evaluation_access = self::EVALUATION_ACCESS_OFF
string	$start_date = ""
string	$end_date = ""
array	$questions = []
int	$anonymize = 0
int	$display_question_titles = 0
bool	$surveyCodeSecurity = false
bool	$mailnotification = false
string	$mailaddresses = ""
string	$mailparticipantdata = ""
bool	$pool_usage = false
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Protected Member Functions
	initServices ()
	doCreateMetaData ()
	getParticipantTextResults (int $active_id)
	checkTutorNotification ()
	Check, if mail to tutors after all participants have finished the survey should be sent. More...
	sendTutorNotification ()
	Send mail to tutors after all participants have finished the survey. More...
	sentReminderPlaceholders (string $a_message, int $a_user_id, array $a_context_params)
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
InternalDomainService	$domain
ilLogger	$svy_log
bool	$activation_limited = false
ilObjUser	$user
ilAccessHandler	$access
ilPluginAdmin	$plugin_admin
bool	$calculate_sum_score = false
bool	$activation_visibility = false
int	$activation_starting_time = null
int	$activation_ending_time = null
bool	$mode_360_self_eval = false
bool	$mode_360_self_appr = false
bool	$mode_360_self_rate = false
int	$mode_360_results = 0
bool	$mode_skill_service = false
bool	$reminder_status = false
ilDate	$reminder_start = null
ilDate	$reminder_end = null
int	$reminder_frequency = 0
int	$reminder_target = 0
string	$reminder_last_sent = null
int	$reminder_tmpl = null
bool	$tutor_ntf_status = false
array	$tutor_ntf_recipients = []
int	$tutor_ntf_target = 0
bool	$tutor_res_status = false
array	$tutor_res_recipients = []
bool	$view_own_results = false
bool	$mail_own_results = false
bool	$mail_confirmation = false
bool	$anon_user_list = false
int	$mode = 0
int	$mode_self_eval_results = 0
Participants InvitationsManager	$invitation_manager
ILIAS Survey InternalService	$survey_service
ILIAS Survey Code CodeManager	$code_manager
ILIAS Survey InternalDataService	$data_manager
Mode FeatureConfig	$feature_config
ILIAS SurveyQuestionPool Export ImportManager	$import_manager
ilMailTemplatePlaceholderResolver	$placeholder_resolver
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Detailed Description

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Definition at line 26 of file class.ilObjSurvey.php.

Constructor & Destructor Documentation

__construct()

ilObjSurvey::__construct	(	int	$a_id = 0,
		bool	$a_call_by_reference = true
	)

Definition at line 145 of file class.ilObjSurvey.php.

      {
        global $DIC;
 
        $this->survey_service = $DIC->survey()->internal();
 
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->access = $DIC->access();
        $this->plugin_admin = $DIC["ilPluginAdmin"];
        $this->tree = $DIC->repositoryTree();
        $ilUser = $DIC->user();
        $lng = $DIC->language();
 
        $this->type = "svy";
        $this->survey_id = -1;
        $this->introduction = "";
        $this->outro = $lng->txt("survey_finished");
        $this->author = $ilUser->getFullname();
        $this->evaluation_access = self::EVALUATION_ACCESS_OFF;
        $this->questions = array();
        $this->anonymize = self::ANONYMIZE_OFF;
        $this->display_question_titles = self::QUESTIONTITLES_VISIBLE;
        $this->surveyCodeSecurity = true;
        $this->pool_usage = true;
        $this->mode = self::MODE_STANDARD;
        $this->mode_self_eval_results = self::RESULTS_SELF_EVAL_OWN;
 
        $this->invitation_manager = $this
            ->survey_service
            ->domain()
            ->participants()
            ->invitations();
 
        $this->import_manager = $DIC->surveyQuestionPool()
            ->internal()
            ->domain()
            ->import();
        $this->placeholder_resolver = $DIC->mail()->placeholderResolver();
 
        parent::__construct($a_id, $a_call_by_reference);
        $this->svy_log = ilLoggerFactory::getLogger("svy");
        $this->initServices();
        $this->domain = $DIC->survey()->internal()->domain();
    }

References $DIC, ilObject\$lng, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ANONYMIZE_OFF, EVALUATION_ACCESS_OFF, ilLoggerFactory\getLogger(), initServices(), ILIAS\Repository\lng(), MODE_STANDARD, QUESTIONTITLES_VISIBLE, RESULTS_SELF_EVAL_OWN, ilLanguage\txt(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

_addQuestionblock()

static ilObjSurvey::_addQuestionblock ( string  $title = "", int  $owner = 0, bool  $show_questiontext = true, bool  $show_blocktitle = false, bool  $compress_view = false  )

static

Todo:

move to survey question manager/repo

Definition at line 1674 of file class.ilObjSurvey.php.

     : int {
        global $DIC;
 
        $ilDB = $DIC->database();
        $next_id = $ilDB->nextId('svy_qblk');
        $ilDB->manipulateF(
            "INSERT INTO svy_qblk (questionblock_id, title, show_questiontext," .
            " show_blocktitle, owner_fi, tstamp, compress_view) " .
            "VALUES (%s, %s, %s, %s, %s, %s, %s)",
            array('integer','text','integer','integer','integer','integer','integer'),
            array($next_id, $title, $show_questiontext, $show_blocktitle, $owner, time(),$compress_view)
        );
        return $next_id;
    }

_getConstraints()

static ilObjSurvey::_getConstraints ( int  $survey_id )

static

Todo:

move to constraint manager/repo, use dto

Definition at line 2100 of file class.ilObjSurvey.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
        $result_array = array();
        $result = $ilDB->queryF(
            "SELECT svy_qst_constraint.question_fi as for_question, svy_constraint.*, svy_relation.* " .
            "FROM svy_qst_constraint, svy_constraint, svy_relation WHERE svy_constraint.relation_fi = svy_relation.relation_id " .
            "AND svy_qst_constraint.constraint_fi = svy_constraint.constraint_id AND svy_qst_constraint.survey_fi = %s",
            array('integer'),
            array($survey_id)
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            $result_array[] = array("id" => $row["constraint_id"],
                                    "for_question" => $row["for_question"],
                                    "question" => $row["question_fi"],
                                    "short" => $row["shortname"],
                                    "long" => $row["longname"],
                                    "relation_id" => $row["relation_id"],
                                    "value" => $row["value"],
                                    'conjunction' => $row['conjunction']
            );
        }
        return $result_array;
    }

_getQuestionblock()

static ilObjSurvey::_getQuestionblock ( int  $questionblock_id )

static

get question block properties

Todo:

move to survey question manager/repo

Definition at line 1656 of file class.ilObjSurvey.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
        $result = $ilDB->queryF(
            "SELECT * FROM svy_qblk WHERE questionblock_id = %s",
            array('integer'),
            array($questionblock_id)
        );
        $row = $ilDB->fetchAssoc($result);
        return $row;
    }

_hasDatasets()

static ilObjSurvey::_hasDatasets ( int  $survey_id )

static

Todo:

move to run manager

Definition at line 2636 of file class.ilObjSurvey.php.

     : bool {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $result = $ilDB->queryF(
            "SELECT finished_id FROM svy_finished WHERE survey_fi = %s",
            array('integer'),
            array($survey_id)
        );
        return (bool) $result->numRows();
    }

Referenced by ilSurveyConstraintsGUI\constraintsObject(), ilSurveySyncTableGUI\importData(), and ilSurveyEditorGUI\questionsObject().

Here is the caller graph for this function:

_instanciateQuestion()

static ilObjSurvey::_instanciateQuestion ( int  $question_id )

static

Creates an instance of a question with a given question id.

Todo:

move to factory in pool module

Definition at line 3094 of file class.ilObjSurvey.php.

     : ?SurveyQuestion {
        if ($question_id < 1) {
            return null;
        }
        $question_type = SurveyQuestion::_getQuestionType($question_id);
        if ($question_type === '') {
            return null;
        }
        SurveyQuestion::_includeClass($question_type);
        $question = new $question_type();
        $question->loadFromDb($question_id);
        return $question;
    }

Referenced by ilSurveyEditorGUI\copyPasteObject(), ilSurveyEditorGUI\copyQuestionsToPoolObject(), and ilSurveyEditorGUI\executeCopyQuestionsToPoolObject().

Here is the caller graph for this function:

addAppraisee()

ilObjSurvey::addAppraisee

(

int

$a_user_id

)

Todo:

move to appraisal manager

Definition at line 4277 of file class.ilObjSurvey.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
        $access = $DIC->access();
 
        if (!$this->isAppraisee($a_user_id) &&
            $a_user_id !== ANONYMOUS_USER_ID) {
            $fields = array(
                "obj_id" => array("integer", $this->getSurveyId()),
                "user_id" => array("integer", $a_user_id)
            );
            $ilDB->insert("svy_360_appr", $fields);
 
            // send notification and add to desktop
            if ($access->checkAccessOfUser($a_user_id, "read", "", $this->getRefId())) {
                $this->sendAppraiseeNotification($a_user_id);
            }
        }
    }

References $ilDB, and ilRBACAccessHandler\checkAccessOfUser().

Here is the call graph for this function:

addConstraint()

ilObjSurvey::addConstraint	(	int	$if_question_id,
		int	$relation,
		float	$value,
		int	$conjunction
	)

Adds a constraint.

Parameters

int	$if_question_id	question id of the question which defines a precondition
int	$relation	relation id
float	$value	value compared with the relation
int	$conjunction

Returns

?int

Todo:

move to constraint manager/repo

Definition at line 2161 of file class.ilObjSurvey.php.

     : ?int {
        $ilDB = $this->db;
 
        $next_id = $ilDB->nextId('svy_constraint');
        $affectedRows = $ilDB->manipulateF(
            "INSERT INTO svy_constraint (constraint_id, question_fi, relation_fi, value, conjunction) VALUES " .
            "(%s, %s, %s, %s, %s)",
            array('integer','integer','integer','float', 'integer'),
            array($next_id, $if_question_id, $relation, $value, $conjunction)
        );
        if ($affectedRows) {
            return $next_id;
        } else {
            return null;
        }
    }

addConstraintToQuestion()

ilObjSurvey::addConstraintToQuestion	(	int	$to_question_id,
		int	$constraint_id
	)

Todo:

move to constraint manager/repo

Definition at line 2187 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $next_id = $ilDB->nextId('svy_qst_constraint');
        $ilDB->manipulateF(
            "INSERT INTO svy_qst_constraint (question_constraint_id, survey_fi, question_fi, " .
            "constraint_fi) VALUES (%s, %s, %s, %s)",
            array('integer','integer','integer','integer'),
            array($next_id, $this->getSurveyId(), $to_question_id, $constraint_id)
        );
    }

addMaterialTag()

ilObjSurvey::addMaterialTag	(	ilXmlWriter	$a_xml_writer,
		string	$a_material,
		bool	$close_material_tag = true,
		bool	$add_mobs = true,
		?array	$attribs = null
	)

Creates an XML material tag from a plain text or xhtml text.

Todo:

move to export sub-service

Definition at line 4011 of file class.ilObjSurvey.php.

     : void {
        $a_xml_writer->xmlStartTag("material", $attribs);
        $attrs = array(
            "type" => "text/plain"
        );
        if ($this->isHTML($a_material)) {
            $attrs["type"] = "text/xhtml";
        }
        $mattext = ilRTE::_replaceMediaObjectImageSrc($a_material, 0);
        $a_xml_writer->xmlElement("mattext", $attrs, $mattext);
 
        if ($add_mobs) {
            $mobs = ilObjMediaObject::_getMobsOfObject("svy:html", $this->getId());
            foreach ($mobs as $mob) {
                $mob_id = "il_" . IL_INST_ID . "_mob_" . $mob;
                if (strpos($mattext, $mob_id) !== false) {
                    $mob_obj = new ilObjMediaObject($mob);
                    $imgattrs = array(
                        "label" => $mob_id,
                        "uri" => "objects/" . "il_" . IL_INST_ID . "_mob_" . $mob . "/" . $mob_obj->getTitle(),
                        "type" => "svy:html",
                        "id" => $this->getId()
                    );
                    $a_xml_writer->xmlElement("matimage", $imgattrs, null);
                }
            }
        }
        if ($close_material_tag) {
            $a_xml_writer->xmlEndTag("material");
        }
    }

addQuestion()

ilObjSurvey::addQuestion

(

int

$question_id

)

Adds a question to the survey (used in importer!)

Definition at line 260 of file class.ilObjSurvey.php.

                                                 : void
    {
        $this->questions[] = $question_id;
    }

addQuestionToBlock()

ilObjSurvey::addQuestionToBlock	(	int	$question_id,
		int	$questionblock_id
	)

Todo:

move to survey question manager/repo

Definition at line 1547 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        // see #22018
        if (!$this->isQuestionInAnyBlock($question_id)) {
            $next_id = $ilDB->nextId('svy_qblk_qst');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_qblk_qst (qblk_qst_id, survey_fi, questionblock_fi, " .
                "question_fi) VALUES (%s, %s, %s, %s)",
                array('integer', 'integer', 'integer', 'integer'),
                array($next_id, $this->getSurveyId(), $questionblock_id, $question_id)
            );
 
            $this->deleteConstraints($question_id); // #13713
        }
    }

References $ilDB.

addRater()

ilObjSurvey::addRater	(	int	$a_appraisee_id,
		int	$a_user_id,
		int	$a_anonymous_id = 0
	)

Todo:

move to appraisal manager

Definition at line 4478 of file class.ilObjSurvey.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
        $access = $DIC->access();
 
        if ($this->isAppraisee($a_appraisee_id) &&
            !$this->isRater($a_appraisee_id, $a_user_id, $a_anonymous_id)) {
            $fields = array(
                "obj_id" => array("integer", $this->getSurveyId()),
                "appr_id" => array("integer", $a_appraisee_id),
                "user_id" => array("integer", $a_user_id),
                "anonymous_id" => array("integer", $a_anonymous_id)
            );
            $ilDB->insert("svy_360_rater", $fields);
 
            // send notification and add to desktop
            if ($access->checkAccessOfUser($a_user_id, "read", "", $this->getRefId())) {
                // out-commented, since adding raters will end in a mail
                // form to send the mail "manually"
                // otherwise two mails would be sent (tested in individual feedback)
                //$this->sendRaterNotification($a_user_id, $a_appraisee_id);
            }
        }
    }

References $ilDB, and ilRBACAccessHandler\checkAccessOfUser().

Here is the call graph for this function:

canExportSurveyCode()

ilObjSurvey::canExportSurveyCode

(

)

Checks if the survey code can be exported with the survey evaluation.

In some cases this may be necessary but usually you should prevent it because people who sent the survey codes could connect real people with the survey code in the evaluation and undermine the anonymity

Returns

bool true if the survey is anonymized and the survey code may be shown in the export file

Todo:

move to code manager

Definition at line 4056 of file class.ilObjSurvey.php.

                                         : bool
    {
        if ($this->getAnonymize() !== self::ANONYMIZE_OFF) {
            if ($this->surveyCodeSecurity === false) {
                return true;
            }
        }
        return false;
    }

checkConstraint()

ilObjSurvey::checkConstraint	(	array	$constraint_data,
		?array	$working_data
	)

Checks if a constraint is valid.

Parameters

array	$constraint_data	constraint data
	?array	$working_data user input of the related question

Returns

bool true if the constraint is valid, otherwise false

Todo:

move to run/constraint manager

Definition at line 2574 of file class.ilObjSurvey.php.

     : bool {
        if (!is_array($working_data) || count($working_data) === 0) {
            return 0;
        }
 
        if ((count($working_data) === 1) and (strcmp($working_data[0]["value"], "") === 0)) {
            return 0;
        }
 
        $found = false;
        foreach ($working_data as $data) {
            switch ($constraint_data["short"]) {
                case "<":
                    if ($data["value"] < $constraint_data["value"]) {
                        $found = true;
                    }
                    break;
 
                case "<=":
                    if ($data["value"] <= $constraint_data["value"]) {
                        $found = true;
                    }
                    break;
 
                case "=":
                    if ($data["value"] == $constraint_data["value"]) {
                        $found = true;
                    }
                    break;
 
                case "<>":
                    if ($data["value"] <> $constraint_data["value"]) {
                        $found = true;
                    }
                    break;
 
                case ">=":
                    if ($data["value"] >= $constraint_data["value"]) {
                        $found = true;
                    }
                    break;
 
                case ">":
                    if ($data["value"] > $constraint_data["value"]) {
                        $found = true;
                    }
                    break;
            }
            if ($found) {
                break;
            }
        }
 
        return (int) $found;
    }

checkReminder()

ilObjSurvey::checkReminder

(

)

Definition at line 5316 of file class.ilObjSurvey.php.

                                   : ?int
    {
        $ilDB = $this->db;
        $ilAccess = $this->access;
 
        $now = time();
        $now_with_format = date("YmdHis", $now);
        $today = date("Y-m-d");
 
        $this->svy_log->debug("Check status and dates.");
 
        // object settings / participation period
        if (
            $this->getOfflineStatus() ||
            !$this->getReminderStatus() ||
            ($this->getStartDate() && $now_with_format < $this->getStartDate()) ||
            ($this->getEndDate() && $now_with_format > $this->getEndDate())) {
            return null;
        }
 
        // reminder period
        $start = $this->getReminderStart();
        if ($start) {
            $start = $start->get(IL_CAL_DATE);
        }
        $end = $this->getReminderEnd();
        if ($end) {
            $end = $end->get(IL_CAL_DATE);
        }
        if ($today < $start ||
            ($end && $today > $end)) {
            return null;
        }
 
        $this->svy_log->debug("Check access period.");
 
        // object access period
        $item_data = ilObjectActivation::getItem($this->getRefId());
        if ((int) $item_data["timing_type"] === ilObjectActivation::TIMINGS_ACTIVATION &&
            ($now < $item_data["timing_start"] ||
            $now > $item_data["timing_end"])) {
            return null;
        }
 
        $this->svy_log->debug("Check frequency.");
 
        // check frequency
        $cut = new ilDate($today, IL_CAL_DATE);
        $cut->increment(IL_CAL_DAY, $this->getReminderFrequency() * -1);
        if (!$this->getReminderLastSent() ||
            $cut->get(IL_CAL_DATE) >= substr($this->getReminderLastSent(), 0, 10)) {
            $missing_ids = array();
            if (!$this->feature_config->usesAppraisees()) {
                $this->svy_log->debug("Entering survey mode.");
 
                // #16871
                $user_ids = $this->getNotificationTargetUserIds(($this->getReminderTarget() === self::NOTIFICATION_INVITED_USERS));
                if ($user_ids) {
                    // gather participants who already finished
                    $finished_ids = array();
                    $set = $ilDB->query("SELECT user_fi FROM svy_finished" .
                        " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
                        " AND state = " . $ilDB->quote(1, "text") .
                        " AND " . $ilDB->in("user_fi", $user_ids, "", "integer"));
                    while ($row = $ilDB->fetchAssoc($set)) {
                        $finished_ids[] = $row["user_fi"];
                    }
 
                    // some users missing out?
                    $missing_ids = array_diff($user_ids, $finished_ids);
                    if ($missing_ids) {
                        foreach ($missing_ids as $idx => $user_id) {
                            // should be able to participate
                            if (!$ilAccess->checkAccessOfUser($user_id, "read", "", $this->getRefId(), "svy", $this->getId())) {
                                unset($missing_ids[$idx]);
                            }
                        }
                    }
                    if ($missing_ids) {
                        $this->sentReminder($missing_ids);
                    }
                }
            } else {
                $this->svy_log->debug("Entering 360 mode.");
 
                $this->sent360Reminders();
            }
 
 
            $this->setReminderLastSent($today);
            $this->saveToDb();
 
            return count($missing_ids);
        }
 
        return null;
    }

References $ilDB, $user_id, ilObjectActivation\getItem(), IL_CAL_DATE, IL_CAL_DAY, and ilObjectActivation\TIMINGS_ACTIVATION.

Here is the call graph for this function:

checkTutorNotification()

ilObjSurvey::checkTutorNotification ( )

protected

Check, if mail to tutors after all participants have finished the survey should be sent.

Definition at line 5124 of file class.ilObjSurvey.php.

                                               : void
    {
        $ilDB = $this->db;
 
        if ($this->getTutorNotificationStatus()) {
            // get target users, either parent course/group members or
            // user with the survey on the dashboard
            $user_ids = $this->getNotificationTargetUserIds(($this->getTutorNotificationTarget() === self::NOTIFICATION_INVITED_USERS));
            if ($user_ids) {
                $set = $ilDB->query("SELECT COUNT(*) numall FROM svy_finished" .
                    " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
                    " AND state = " . $ilDB->quote(1, "integer") .
                    " AND " . $ilDB->in("user_fi", $user_ids, "", "integer"));
                $row = $ilDB->fetchAssoc($set);
 
                // all users finished the survey -> send notifications
                if ((int) $row["numall"] === count($user_ids)) {
                    $this->sendTutorNotification();
                }
            }
        }
    }

References $ilDB.

cloneTextblocks()

ilObjSurvey::cloneTextblocks

(

array

$mapping

)

Clones the text blocks of survey questions.

Todo:

move to survey question manager

Parameters

array<int,int>

$mapping (key is original, value is new id)

Definition at line 3430 of file class.ilObjSurvey.php.

     : void {
        foreach ($mapping as $original_id => $new_id) {
            $textblock = $this->getTextblock($original_id);
            $this->saveHeading(ilUtil::stripSlashes($textblock, true, ilRTESettings::_getUsedHTMLTagsAsString("survey")), $new_id);
        }
    }

References ilRTESettings\_getUsedHTMLTagsAsString(), and ilUtil\stripSlashes().

Here is the call graph for this function:

closeAppraisee()

ilObjSurvey::closeAppraisee

(

int

$a_user_id

)

Todo:

move to appraisal/run manager/mode

Definition at line 4885 of file class.ilObjSurvey.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
        $user = $DIC->user();
 
        // close the appraisee
        $ilDB->manipulate("UPDATE svy_360_appr" .
            " SET has_closed = " . $ilDB->quote(time(), "integer") .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer"));
 
        // write competences
        $skmg_set = new ilSkillManagementSettings();
        if ($this->getSkillService() && $skmg_set->isActivated()) {
            $sskill = new ilSurveySkill($this);
            $sskill->writeAndAddAppraiseeSkills($a_user_id);
        }
 
        // send notification
        if ($user->getId() !== $a_user_id) {
            $this->sendAppraiseeCloseNotification($a_user_id);
        }
    }

create()

ilObjSurvey::create

(

$a_upload = false

)

Definition at line 212 of file class.ilObjSurvey.php.

                                             : int
    {
        $id = parent::create();
        if (!$a_upload) {
            $this->createMetaData();
        }
        $this->setOfflineStatus(true);
        $this->update($a_upload);
        return $id;
    }

References $id, ilObject\createMetaData(), ilObject\setOfflineStatus(), and ilObject\update().

Here is the call graph for this function:

createExportDirectory()

ilObjSurvey::createExportDirectory

(

)

creates data directory for export files (data_dir/svy_data/svy_<id>/export)

Todo:

move to export sub-service

Exceptions

ilSurveyException

Definition at line 3445 of file class.ilObjSurvey.php.

                                           : void
    {
        $svy_data_dir = ilFileUtils::getDataDir() . "/svy_data";
        ilFileUtils::makeDir($svy_data_dir);
        if (!is_writable($svy_data_dir)) {
            throw new ilSurveyException("Survey Data Directory (" . $svy_data_dir . ") not writeable.");
        }
 
        // create learning module directory (data_dir/lm_data/lm_<id>)
        $svy_dir = $svy_data_dir . "/svy_" . $this->getId();
        ilFileUtils::makeDir($svy_dir);
        if (!is_dir($svy_dir)) {
            throw new ilSurveyException("Creation of Survey Directory failed.");
        }
        // create Export subdirectory (data_dir/lm_data/lm_<id>/Export)
        $export_dir = $svy_dir . "/export";
        ilFileUtils::makeDir($export_dir);
        if (!is_dir($export_dir)) {
            throw new ilSurveyException("Creation of Export Directory failed.");
        }
    }

References ilFileUtils\getDataDir(), ILIAS\Survey\Mode\getId(), and ilFileUtils\makeDir().

Here is the call graph for this function:

createImportDirectory()

ilObjSurvey::createImportDirectory

(

)

creates data directory for import files (data_dir/svy_data/svy_<id>/import)

Todo:

move to export sub-service

Exceptions

ilSurveyException

Definition at line 3483 of file class.ilObjSurvey.php.

                                           : void
    {
        $svy_data_dir = ilFileUtils::getDataDir() . "/svy_data";
        ilFileUtils::makeDir($svy_data_dir);
 
        if (!is_writable($svy_data_dir)) {
            throw new ilSurveyException("Survey Data Directory (" . $svy_data_dir . ") not writeable.");
        }
 
        // create test directory (data_dir/svy_data/svy_<id>)
        $svy_dir = $svy_data_dir . "/svy_" . $this->getId();
        ilFileUtils::makeDir($svy_dir);
        if (!is_dir($svy_dir)) {
            throw new ilSurveyException("Creation of Survey Directory failed.");
        }
 
        // create import subdirectory (data_dir/svy_data/svy_<id>/import)
        $import_dir = $svy_dir . "/import";
        ilFileUtils::makeDir($import_dir);
        if (!is_dir($import_dir)) {
            throw new ilSurveyException("Creation of Import Directory failed.");
        }
    }

References ilFileUtils\getDataDir(), ILIAS\Survey\Mode\getId(), and ilFileUtils\makeDir().

Here is the call graph for this function:

createQuestionblock()

ilObjSurvey::createQuestionblock	(	string	$title,
		bool	$show_questiontext,
		bool	$show_blocktitle,
		array	$questions,
		bool	$compress_view = false
	)

Parameters

int[]

$questions

array with question ids

Definition at line 1698 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        // if the selected questions are not in a continous selection, move all questions of the
        // questionblock at the position of the first selected question
        $this->moveQuestions($questions, $questions[0], 0);
 
        // now save the question block
        $ilUser = $this->user;
        $next_id = $ilDB->nextId('svy_qblk');
        $affectedRows = $ilDB->manipulateF(
            "INSERT INTO svy_qblk (questionblock_id, title, show_questiontext," .
            " show_blocktitle, owner_fi, tstamp, compress_view) VALUES (%s, %s, %s, %s, %s, %s, %s)",
            array('integer','text','text','text','integer','integer','integer'),
            array($next_id, $title, $show_questiontext, $show_blocktitle, $ilUser->getId(), time(), $compress_view)
        );
        if ($affectedRows) {
            $questionblock_id = $next_id;
            foreach ($questions as $index) {
                if (!$this->isQuestionInAnyBlock($index)) {
                    $next_id = $ilDB->nextId('svy_qblk_qst');   // #22018
                    $affectedRows = $ilDB->manipulateF(
                        "INSERT INTO svy_qblk_qst (qblk_qst_id, survey_fi, questionblock_fi, " .
                        "question_fi) VALUES (%s, %s, %s, %s)",
                        array('integer', 'integer', 'integer', 'integer'),
                        array($next_id, $this->getSurveyId(), $questionblock_id, $index)
                    );
                    $this->deleteConstraints($index);
                }
            }
        }
    }

createReference()

ilObjSurvey::createReference

(

)

creates reference for object

Reimplemented from ilObject.

Definition at line 243 of file class.ilObjSurvey.php.

                                     : int
    {
        $result = parent::createReference();
        $this->saveToDb();
        return $result;
    }

References saveToDb().

Here is the call graph for this function:

delete()

ilObjSurvey::delete

(

)

delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!!

Returns

bool true if object was removed completely; false if only a references was removed

Reimplemented from ilObject.

Definition at line 265 of file class.ilObjSurvey.php.

                            : bool
    {
        $this->svy_log->debug("Deleting Survey, ref id: " . $this->getRefId() . ", obj id: " .
            $this->getId() . ", title: " . $this->getTitle());
        $this->svy_log->debug("References: " . $this->countReferences());
        if ($this->countReferences() === 1) {
            $this->deleteMetaData();
 
            // Delete all survey questions, constraints and materials
            foreach ($this->questions as $question_id) {
                $this->svy_log->debug("Remove question " . $question_id);
                $this->removeQuestion($question_id);
            }
            $this->deleteSurveyRecord();
 
            ilFileUtils::delDir($this->getImportDirectory());
        }
 
        $this->svy_log->debug("Call parent delete.");
        $remove = parent::delete();
 
        // always call parent delete function first!!
        if (!$remove) {
            return false;
        }
        return true;
    }

References ilObject\countReferences(), ilFileUtils\delDir(), ilObject\deleteMetaData(), deleteSurveyRecord(), ilObject\getId(), getImportDirectory(), ilObject\getRefId(), ilObject\getTitle(), and removeQuestion().

Here is the call graph for this function:

deleteAllUserData()

ilObjSurvey::deleteAllUserData

(

bool

$reset_LP = true

)

Deletes all user data of a survey.

Parameters

bool

$reset_LP

notice that the LP can only be reset it the determining components still exist

Todo:

move to run manager/repo

Definition at line 354 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $result = $ilDB->queryF(
            "SELECT finished_id FROM svy_finished WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        $active_array = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            $active_array[] = $row["finished_id"];
        }
 
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_finished WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
 
        foreach ($active_array as $active_fi) {
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_answer WHERE active_fi = %s",
                array('integer'),
                array($active_fi)
            );
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_times WHERE finished_fi = %s",
                array('integer'),
                array($active_fi)
            );
        }
 
        if ($reset_LP) {
            $lp_obj = ilObjectLP::getInstance($this->getId());
            $lp_obj->resetLPDataForCompleteObject();
        }
 
        $this->invitation_manager->removeAll($this->getSurveyId());
    }

Referenced by deleteSurveyRecord().

Here is the caller graph for this function:

deleteAppraisee()

ilObjSurvey::deleteAppraisee

(

int

$a_user_id

)

Todo:

move to appraisal manager

Definition at line 4422 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $ilDB->manipulate("DELETE FROM svy_360_appr" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer"));
 
        $set = $ilDB->query("SELECT user_id" .
            " FROM svy_360_rater" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND appr_id = " . $ilDB->quote($a_user_id, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $this->deleteRater($a_user_id, $row["user_id"]);
        }
        // appraisee will not be part of raters table
        if ($this->get360SelfEvaluation()) {
            $this->deleteRater($a_user_id, $a_user_id);
        }
    }

deleteConstraint()

ilObjSurvey::deleteConstraint

(

int

$constraint_id

)

Deletes a single constraint.

Todo:

move to constraint manager/repo

Definition at line 1782 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_constraint WHERE constraint_id = %s",
            array('integer'),
            array($constraint_id)
        );
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_qst_constraint WHERE constraint_fi = %s",
            array('integer'),
            array($constraint_id)
        );
    }

deleteConstraints()

ilObjSurvey::deleteConstraints

(

int

$question_id

)

Deletes the constraints for a question.

Todo:

move to constraint manager/repo

Definition at line 1760 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT constraint_fi FROM svy_qst_constraint WHERE question_fi = %s AND survey_fi = %s",
            array('integer','integer'),
            array($question_id, $this->getSurveyId())
        );
        $constraints = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            $constraints[] = $row["constraint_fi"];
        }
        foreach ($constraints as $constraint_id) {
            $this->deleteConstraint($constraint_id);
        }
    }

deleteRater()

ilObjSurvey::deleteRater	(	int	$a_appraisee_id,
		int	$a_user_id,
		int	$a_anonymous_id = 0
	)

Todo:

move to appraisal manager

Definition at line 4542 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $finished_id = $this->getFinishedIdForAppraiseeIdAndRaterId($a_appraisee_id, $a_user_id);
        if ($finished_id) {
            $this->removeSelectedSurveyResults(array($finished_id));
        }
 
        $ilDB->manipulate("DELETE FROM svy_360_rater" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND appr_id = " . $ilDB->quote($a_appraisee_id, "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND anonymous_id = " . $ilDB->quote($a_anonymous_id, "integer"));
    }

deleteSurveyCode()

ilObjSurvey::deleteSurveyCode

(

string

$survey_code

)

Todo:

move to code manager

Definition at line 3894 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        if ($survey_code !== '') {
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_anonymous WHERE survey_fi = %s AND survey_key = %s",
                array('integer', 'text'),
                array($this->getSurveyId(), $survey_code)
            );
        }
    }

References $ilDB.

deleteSurveyRecord()

ilObjSurvey::deleteSurveyRecord

(

)

Deletes the survey from the database.

Todo:

move to survey manager/repo

Definition at line 297 of file class.ilObjSurvey.php.

                                        : void
    {
        $ilDB = $this->db;
 
        $ilDB->manipulateF(
            "DELETE FROM svy_svy WHERE survey_id = %s",
            array('integer'),
            array($this->getSurveyId())
        );
 
        $result = $ilDB->queryF(
            "SELECT questionblock_fi FROM svy_qblk_qst WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        $questionblocks = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            $questionblocks[] = $row["questionblock_fi"];
        }
        if (count($questionblocks)) {
            $affectedRows = $ilDB->manipulate("DELETE FROM svy_qblk WHERE " . $ilDB->in('questionblock_id', $questionblocks, false, 'integer'));
        }
        $ilDB->manipulateF(
            "DELETE FROM svy_qblk_qst WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        $this->deleteAllUserData(false);
 
        if (isset($this->code_manager)) {
            $this->code_manager->deleteAll(true);
        }
 
        // delete export files
        $svy_data_dir = ilFileUtils::getDataDir() . "/svy_data";
        $directory = $svy_data_dir . "/svy_" . $this->getId();
        if (is_dir($directory)) {
            ilFileUtils::delDir($directory);
        }
 
        $mobs = ilObjMediaObject::_getMobsOfObject("svy:html", $this->getId());
        // remaining usages are not in text anymore -> delete them
        // and media objects (note: delete method of ilObjMediaObject
        // checks whether object is used in another context; if yes,
        // the object is not deleted!)
        foreach ($mobs as $mob) {
            ilObjMediaObject::_removeUsage($mob, "svy:html", $this->getId());
            $mob_obj = new ilObjMediaObject($mob);
            $mob_obj->delete();
        }
    }

References ilObject\$db, $ilDB, ilObjMediaObject\_getMobsOfObject(), ilObjMediaObject\_removeUsage(), ilFileUtils\delDir(), deleteAllUserData(), ilFileUtils\getDataDir(), ilObject\getId(), and getSurveyId().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteUserSettings()

ilObjSurvey::deleteUserSettings

(

int

$id

)

Definition at line 663 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $ilDB->manipulateF(
            "DELETE FROM svy_settings WHERE settings_id = %s",
            array('integer'),
            array($id)
        );
    }

deleteWorkingData()

ilObjSurvey::deleteWorkingData	(	int	$question_id,
		int	$active_id
	)

Deletes the working data of a question in the database.

Todo:

move to run(?) manager/repo

Definition at line 2276 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_answer WHERE question_fi = %s AND active_fi = %s",
            array('integer','integer'),
            array($question_id, $active_id)
        );
    }

doCreateMetaData()

ilObjSurvey::doCreateMetaData ( )

protected

Reimplemented from ilObject.

Definition at line 223 of file class.ilObjSurvey.php.

                                         : void
    {
        $this->saveAuthorToMetadata();
    }

References saveAuthorToMetadata().

Here is the call graph for this function:

duplicateQuestionForSurvey()

ilObjSurvey::duplicateQuestionForSurvey	(	int	$question_id,
		bool	$a_force = false
	)

Takes a question and creates a copy of the question for use in the survey.

Todo:

move to survey question manager/repo

Definition at line 530 of file class.ilObjSurvey.php.

     : int {
        $questiontype = $this->getQuestionType($question_id);
        $question_gui = $this->getQuestionGUI($questiontype, $question_id);
 
        // check if question is a pool question at all, if not do nothing
        if ($this->getId() === $question_gui->object->getObjId() && !$a_force) {
            return $question_id;
        }
 
        $duplicate_id = $question_gui->object->duplicate(true, "", "", 0, $this->getId());
        return $duplicate_id;
    }

findCodeForUser()

ilObjSurvey::findCodeForUser

(

int

$a_user_id

)

Todo:

move to code manager

Definition at line 4765 of file class.ilObjSurvey.php.

     : string {
        $ilDB = $this->db;
 
        if ($a_user_id !== ANONYMOUS_USER_ID) {
            $set = $ilDB->query("SELECT sf.anonymous_id FROM svy_finished sf" .
                " WHERE sf.survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
                " AND sf.user_fi = " . $ilDB->quote($a_user_id, "integer"));
            $a_code = $ilDB->fetchAssoc($set);
            return (string) ($a_code["anonymous_id"] ?? "");
        }
        return "";
    }

References $ilDB.

finishSurvey()

ilObjSurvey::finishSurvey	(	int	$finished_id,
		int	$appr_id = 0
	)

Finishes the survey creating an entry in the database.

Todo:

move to run manager

Definition at line 2316 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $ilDB->manipulateF(
            "UPDATE svy_finished SET state = %s, tstamp = %s" .
            " WHERE survey_fi = %s AND finished_id = %s",
            array('text','integer','integer','integer'),
            array(1, time(), $this->getSurveyId(), $finished_id)
        );
 
        // self eval writes skills on finishing
        if ($this->getMode() === self::MODE_SELF_EVAL) {
            $user = $this->getUserDataFromActiveId($finished_id);
            $sskill = new ilSurveySkill($this);
            $sskill->writeAndAddSelfEvalSkills($user['usr_id']);
        }
 
        // self eval writes skills on finishing
        if ($this->getMode() === self::MODE_IND_FEEDB) {
            // we use a rater id like "a27" for anonymous or
            // "123" for non anonymous user
            // @todo: move this e.g. to participant manager
            $raters = $this->getRatersData($appr_id);
            $run_manager = $this->survey_service
                ->domain()
                ->execution()
                ->run($this, $this->user->getId(), $appr_id);
            $run = $run_manager->getById($finished_id);
            $rater_id = "";
            if ($run->getUserId() !== 0 && $run->getUserId() !== ANONYMOUS_USER_ID) {
                $rater_id = $run->getUserId();
            } else {
                foreach ($raters as $id => $rater) {
                    if (($rater["code"] ?? "") === $run->getCode()) {
                        $rater_id = $id;
                    }
                }
            }
            $sskill = new ilSurveySkill($this);
            //$sskill->writeAndAddSelfEvalSkills($user['usr_id']);
            $sskill->writeAndAddIndFeedbackSkills($finished_id, $appr_id, $rater_id);
        }
 
        $this->checkTutorNotification();
    }

fixSequenceStructure()

ilObjSurvey::fixSequenceStructure

(

)

Definition at line 1074 of file class.ilObjSurvey.php.

                                          : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        //return;
        // we keep all survey question ids with their lowest sequence
        $result = $ilDB->queryF(
            "SELECT * FROM svy_svy_qst WHERE survey_fi = %s ORDER BY sequence",
            array('integer'),
            array($this->getSurveyId())
        );
 
        // step 1: find duplicates -> $to_delete_ids
        $fis = array();
        $to_delete_ids = array();
        while ($data = $ilDB->fetchAssoc($result)) {
            if (in_array($data["question_fi"], $fis)) {         // found a duplicate
                $to_delete_ids[] = $data["survey_question_id"];
            } else {
                $fis[] = $data["question_fi"];
            }
        }
 
        // step 2: we delete the duplicates
        if (count($to_delete_ids) > 0) {
            $ilDB->manipulate($q = "DELETE FROM svy_svy_qst" .
                " WHERE " . $ilDB->in("survey_question_id", $to_delete_ids, false, "integer") .
                " AND survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer"));
            $this->svy_log->debug("delete: " . $q);
 
            $ilDB->manipulate($q = "DELETE FROM svy_qblk_qst " .
                " WHERE " . $ilDB->in("question_fi", $fis, true, "integer") .
                " AND survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer"));
            $this->svy_log->debug("delete: " . $q);
        }
 
        // step 3: we fix the sequence
        $set = $ilDB->query("SELECT * FROM svy_svy_qst " .
            " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") . " ORDER BY sequence");
        $seq = 0;
        while ($rec = $ilDB->fetchAssoc($set)) {
            $ilDB->manipulate(
                $q = "UPDATE svy_svy_qst SET " .
                " sequence = " . $ilDB->quote($seq++, "integer") .
                " WHERE survey_question_id = " . $ilDB->quote($rec["survey_question_id"], "integer")
            );
            $this->svy_log->debug("update: " . $q);
        }
    }

References $data, $DIC, $ilDB, and $q.

get360Mode()

ilObjSurvey::get360Mode

(

)

Definition at line 4226 of file class.ilObjSurvey.php.

                                : bool
    {
        if ($this->getMode() === self::MODE_360) {
            return true;
        }
        return false;
    }

Referenced by ILIAS\Survey\Evaluation\EvaluationManager\getSelectableAppraisees().

Here is the caller graph for this function:

get360Results()

ilObjSurvey::get360Results

(

)

Definition at line 4269 of file class.ilObjSurvey.php.

                                   : int
    {
        return $this->mode_360_results;
    }

Referenced by ILIAS\Survey\Evaluation\EvaluationManager\isMultiParticipantsView().

Here is the caller graph for this function:

get360SelfAppraisee()

ilObjSurvey::get360SelfAppraisee

(

)

Definition at line 4249 of file class.ilObjSurvey.php.

                                         : bool
    {
        return $this->mode_360_self_appr;
    }

Referenced by ILIAS\Survey\Participants\StatusManager\canAddItselfAsAppraisee().

Here is the caller graph for this function:

get360SelfEvaluation()

ilObjSurvey::get360SelfEvaluation

(

)

Definition at line 4239 of file class.ilObjSurvey.php.

                                          : bool
    {
        return $this->mode_360_self_eval;
    }

get360SelfRaters()

ilObjSurvey::get360SelfRaters

(

)

Definition at line 4259 of file class.ilObjSurvey.php.

                                      : bool
    {
        return $this->mode_360_self_rate;
    }

getActivationEndDate()

ilObjSurvey::getActivationEndDate

(

)

Definition at line 5487 of file class.ilObjSurvey.php.

                                          : ?int
    {
        return $this->activation_ending_time;
    }

getActivationStartDate()

ilObjSurvey::getActivationStartDate

(

)

Definition at line 5482 of file class.ilObjSurvey.php.

                                            : ?int
    {
        return $this->activation_starting_time;
    }

getActivationVisibility()

ilObjSurvey::getActivationVisibility

(

)

Definition at line 1303 of file class.ilObjSurvey.php.

                                             : bool
    {
        return $this->activation_visibility;
    }

getActiveID()

ilObjSurvey::getActiveID	(	int	$user_id,
		string	$anonymize_id,
		int	$appr_id
	)

Get run id.

Todo:

move to run manager/repo

Definition at line 2514 of file class.ilObjSurvey.php.

     : ?int {
        $ilDB = $this->db;
        // #15031 - should not matter if code was used by registered or anonymous (each code must be unique)
        if ($anonymize_id) {
            $result = $ilDB->queryF(
                "SELECT finished_id FROM svy_finished" .
                " WHERE survey_fi = %s AND anonymous_id = %s AND appr_id = %s",
                array('integer','text','integer'),
                array($this->getSurveyId(), $anonymize_id, $appr_id)
            );
        } else {
            if ($user_id == ANONYMOUS_USER_ID) {
                return null;
            }
            $result = $ilDB->queryF(
                "SELECT finished_id FROM svy_finished" .
                " WHERE survey_fi = %s AND user_fi = %s AND appr_id = %s",
                array('integer','integer','integer'),
                array($this->getSurveyId(), $user_id, $appr_id)
            );
        }
        if ($result->numRows() === 0) {
            return null;
        } else {
            $row = $ilDB->fetchAssoc($result);
            return (int) $row["finished_id"];
        }
    }

References $ilDB.

getAllRelations()

ilObjSurvey::getAllRelations

(

bool

$short_as_key = false

)

Todo:

move to constraint manager/repo

Definition at line 2242 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        // #7987
        $custom_order = array("equal", "not_equal", "less", "less_or_equal", "more", "more_or_equal");
        $custom_order = array_flip($custom_order);
 
        $result_array = array();
        $result = $ilDB->query("SELECT * FROM svy_relation");
        while ($row = $ilDB->fetchAssoc($result)) {
            if ($short_as_key) {
                $result_array[$row["shortname"]] = array("short" => $row["shortname"], "long" => $row["longname"], "id" => $row["relation_id"], "order" => $custom_order[$row["longname"]]);
            } else {
                $result_array[$row["relation_id"]] = array("short" => $row["shortname"], "long" => $row["longname"], "order" => $custom_order[$row["longname"]]);
            }
        }
 
        $result_array = ilArrayUtil::sortArray($result_array, "order", "ASC", true, true);
        foreach ($result_array as $idx => $item) {
            unset($result_array[$idx]["order"]);
        }
 
        return $result_array;
    }

getAnonymize()

ilObjSurvey::getAnonymize

(

)

Definition at line 951 of file class.ilObjSurvey.php.

                                  : int
    {
        return $this->anonymize;
    }

getAnonymousIdByCode()

ilObjSurvey::getAnonymousIdByCode

(

string

$a_code

)

Todo:

move to code manager

Definition at line 4655 of file class.ilObjSurvey.php.

     : ?int {
        $ilDB = $this->db;
        $set = $ilDB->query("SELECT anonymous_id FROM svy_anonymous" .
                " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
                " AND survey_key = " . $ilDB->quote($a_code, "text"));
        $res = $ilDB->fetchAssoc($set);
        return $res["anonymous_id"] ?? null;
    }

Referenced by ILIAS\Survey\Participants\StatusManager\isExternalRater().

Here is the caller graph for this function:

getAppraiseesData()

ilObjSurvey::getAppraiseesData

(

)

Todo:

move to appraisal manager, use dto

Definition at line 4447 of file class.ilObjSurvey.php.

                                       : array
    {
        $ilDB = $this->db;
 
        $res = array();
 
        $set = $ilDB->query("SELECT * FROM svy_360_appr" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $name = ilObjUser::_lookupName($row["user_id"]);
            $name["email"] = ilObjUser::_lookupEmail($row["user_id"]);
            $name["name"] = $name["lastname"] . ", " . $name["firstname"];
            $res[$row["user_id"]] = $name;
 
            $finished = 0;
            $raters = $this->getRatersData($row["user_id"]);
            foreach ($raters as $rater) {
                if ($rater["finished"]) {
                    $finished++;
                }
            }
            $res[$row["user_id"]]["finished"] = $finished . "/" . count($raters);
            $res[$row["user_id"]]["closed"] = $row["has_closed"];
        }
 
        return $res;
    }

References $ilDB, $res, ilObjUser\_lookupEmail(), and ilObjUser\_lookupName().

Referenced by ILIAS\Survey\Evaluation\EvaluationManager\getSelectableAppraisees().

Here is the call graph for this function:

Here is the caller graph for this function:

getAppraiseesToRate()

ilObjSurvey::getAppraiseesToRate	(	?int	$a_user_id,
		?int	$a_anonymous_id = null
	)

Todo:

move to appraisal manager

Returns

int[]

Definition at line 4620 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $res = array();
 
        $sql = "SELECT appr_id FROM svy_360_rater" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer");
 
        if ($a_user_id) {
            $sql .= " AND user_id = " . $ilDB->quote($a_user_id, "integer");
        } else {
            $sql .= " AND anonymous_id = " . $ilDB->quote($a_anonymous_id, "integer");
        }
 
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = (int) $row["appr_id"];
        }
 
        // user may evaluate himself if already appraisee
        if ($this->get360SelfEvaluation() &&
            $this->isAppraisee((int) $a_user_id) &&
            !in_array($a_user_id, $res)) {
            $res[] = $a_user_id;
        }
 
        return $res;
    }

Referenced by ILIAS\Survey\Participants\StatusManager\isExternalRater().

Here is the caller graph for this function:

getAuthor()

ilObjSurvey::getAuthor

(

)

Definition at line 1152 of file class.ilObjSurvey.php.

                               : string
    {
        return $this->domain->metadata()->getAuthorsFromLOM(
            $this->getId(),
            0,
            $this->getType()
        );
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getAvailableQuestionpools()

ilObjSurvey::getAvailableQuestionpools	(	bool	$use_obj_id = false,
		bool	$could_be_offline = false,
		bool	$showPath = false,
		string	$permission = "read"
	)

Returns the available question pools for the active user.

Definition at line 2029 of file class.ilObjSurvey.php.

     : array {
        return ilObjSurveyQuestionPool::_getAvailableQuestionpools($use_obj_id, $could_be_offline, $showPath, $permission);
    }

getCalculateSumScore()

ilObjSurvey::getCalculateSumScore

(

)

Definition at line 962 of file class.ilObjSurvey.php.

                                          : bool
    {
        return $this->calculate_sum_score;
    }

getConstraints()

ilObjSurvey::getConstraints

(

int

$question_id

)

Returns the constraints to a given question or questionblock.

Todo:

move to constraint manager, introduce dto

Definition at line 2065 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $result_array = array();
        $result = $ilDB->queryF(
            "SELECT svy_constraint.*, svy_relation.* FROM svy_qst_constraint, svy_constraint, svy_relation " .
            "WHERE svy_constraint.relation_fi = svy_relation.relation_id AND " .
            "svy_qst_constraint.constraint_fi = svy_constraint.constraint_id AND svy_qst_constraint.question_fi = %s " .
            "AND svy_qst_constraint.survey_fi = %s",
            array('integer','integer'),
            array($question_id, $this->getSurveyId())
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            $question_type = SurveyQuestion::_getQuestionType($row["question_fi"]);
            SurveyQuestion::_includeClass($question_type);
            $question = new $question_type();
            $question->loadFromDb($row["question_fi"]);
            $valueoutput = $question->getPreconditionValueOutput($row["value"]);
            $result_array[] = array("id" => $row["constraint_id"],
                                    "question" => $row["question_fi"],
                                    "short" => $row["shortname"],
                                    "long" => $row["longname"],
                                    "value" => $row["value"],
                                    "conjunction" => $row["conjunction"],
                                    "valueoutput" => $valueoutput
            );
        }
        return $result_array;
    }

Referenced by SurveyConstraintsTableGUI\initItems().

Here is the caller graph for this function:

getEndDate()

ilObjSurvey::getEndDate

(

)

Definition at line 1224 of file class.ilObjSurvey.php.

                                : string
    {
        return $this->end_date;
    }

getEvaluationAccess()

ilObjSurvey::getEvaluationAccess

(

)

Definition at line 1286 of file class.ilObjSurvey.php.

                                         : string
    {
        return $this->evaluation_access;
    }

getEvaluationByUser()

ilObjSurvey::getEvaluationByUser	(	array	$questions,
		int	$active_id
	)

Calculates the evaluation data for a given run.

Todo:

move to evaluation manager

Definition at line 2776 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        // collect all answers
        $answers = array();
        $result = $ilDB->queryF(
            "SELECT * FROM svy_answer WHERE active_fi = %s",
            array('integer'),
            array($active_id)
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            if (!is_array($answers[$row["question_fi"]])) {
                $answers[$row["question_fi"]] = array();
            }
            $answers[$row["question_fi"]][] = $row;
        }
        $userdata = $this->getUserDataFromActiveId($active_id);
        $resultset = array(
            "name" => $userdata["fullname"],
            "firstname" => $userdata["firstname"],
            "lastname" => $userdata["lastname"],
            "login" => $userdata["login"],
            "gender" => $userdata["gender"],
            "answers" => array()
        );
        foreach ($questions as $key => $question) {
            if (array_key_exists($key, $answers)) {
                $resultset["answers"][$key] = $answers[$key];
            } else {
                $resultset["answers"][$key] = array();
            }
            sort($resultset["answers"][$key]);
        }
        return $resultset;
    }

getExistingQuestions()

ilObjSurvey::getExistingQuestions

(

)

Gets the question id's of the questions which are already in the survey.

Returns

int[]

Definition at line 1332 of file class.ilObjSurvey.php.

                                          : array
    {
        $ilDB = $this->db;
        $existing_questions = array();
        $result = $ilDB->queryF(
            "SELECT svy_question.original_id FROM svy_question, svy_svy_qst WHERE " .
            "svy_svy_qst.survey_fi = %s AND svy_svy_qst.question_fi = svy_question.question_id",
            array('integer'),
            array($this->getSurveyId())
        );
        while ($data = $ilDB->fetchAssoc($result)) {
            if ($data["original_id"]) {
                $existing_questions[] = (int) $data["original_id"];
            }
        }
        return $existing_questions;
    }

References $data, $ilDB, and ILIAS\Repository\int().

Here is the call graph for this function:

getExportDirectory()

ilObjSurvey::getExportDirectory

(

)

Todo:

move to export sub-service

Definition at line 3470 of file class.ilObjSurvey.php.

                                        : string
    {
        $export_dir = ilFileUtils::getDataDir() . "/svy_data" . "/svy_" . $this->getId() . "/export";
 
        return $export_dir;
    }

References ilFileUtils\getDataDir(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

getExternalCodeRecipients()

ilObjSurvey::getExternalCodeRecipients

(

bool

$a_check_finished = false

)

Todo:

move to code manager

Definition at line 3838 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT survey_key code, externaldata, sent FROM svy_anonymous WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        $res = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            if (!$row['externaldata']) {
                continue;
            }
 
            $externaldata = unserialize((string) $row['externaldata'], ['allowed_classes' => false]);
            if (!$externaldata['email']) {
                continue;
            }
 
            $externaldata['code'] = $row['code'];
            $externaldata['sent'] = $row['sent'];
 
            if ($a_check_finished) {
                #23294
                //$externaldata['finished'] =  $this->isSurveyCodeUsed($row['code']);
                $externaldata['finished'] = $this->isSurveyFinishedByCode($row['code']);
            }
 
            $res[] = $externaldata;
        }
        return $res;
    }

getFinishedIdForAppraiseeIdAndRaterId()

ilObjSurvey::getFinishedIdForAppraiseeIdAndRaterId	(	int	$a_appr_id,
		int	$a_rat_id
	)

Get finished id for an appraisee and a rater.

Todo:

move to run manager

Definition at line 4830 of file class.ilObjSurvey.php.

     : ?int {
        $ilDB = $this->db;
 
        $set = $ilDB->query("SELECT finished_id, user_fi FROM svy_finished" .
            " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND appr_id = " . $ilDB->quote($a_appr_id, "integer") .
            " AND user_fi = " . $ilDB->quote($a_rat_id, "integer"));
        if ($row = $ilDB->fetchAssoc($set)) {
            return (int) $row["finished_id"];
        }
        return  null;
    }

getFinishedIdsForAppraiseeId()

ilObjSurvey::getFinishedIdsForAppraiseeId	(	int	$a_appr_id,
		bool	$a_exclude_appraisee = false
	)

Returns

int[]

Todo:

move to run manager

Definition at line 4805 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $res = array();
 
        $set = $ilDB->query("SELECT finished_id, user_fi FROM svy_finished" .
            " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND appr_id = " . $ilDB->quote($a_appr_id, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            if ($a_exclude_appraisee && $row["user_fi"] == $a_appr_id) {
                continue;
            }
            $res[] = (int) $row["finished_id"];
        }
 
        return $res;
    }

getImportDirectory()

ilObjSurvey::getImportDirectory

(

)

get import directory of survey

Todo:

move to export sub-service

Definition at line 3511 of file class.ilObjSurvey.php.

                                        : string
    {
        $import_dir = ilFileUtils::getDataDir() . "/svy_data" .
            "/svy_" . $this->getId() . "/import";
        if (!is_dir($import_dir)) {
            ilFileUtils::makeDirParents($import_dir);
        }
        if (is_dir($import_dir)) {
            return $import_dir;
        } else {
            return "";
        }
    }

References ilFileUtils\getDataDir(), ILIAS\Survey\Mode\getId(), and ilFileUtils\makeDirParents().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

getIntroduction()

ilObjSurvey::getIntroduction

(

)

Definition at line 1318 of file class.ilObjSurvey.php.

                                     : string
    {
        return $this->introduction;
    }

getLastAccess()

ilObjSurvey::getLastAccess

(

int

$finished_id

)

Todo:

move to run manager

Definition at line 3957 of file class.ilObjSurvey.php.

     : ?int {
        $ilDB = $this->db;
 
        $result = $ilDB->queryF(
            "SELECT tstamp FROM svy_answer WHERE active_fi = %s ORDER BY tstamp DESC",
            array('integer'),
            array($finished_id)
        );
        if ($result->numRows()) {
            $row = $ilDB->fetchAssoc($result);
            return (int) $row["tstamp"];
        } else {
            $result = $ilDB->queryF(
                "SELECT tstamp FROM svy_finished WHERE finished_id = %s",
                array('integer'),
                array($finished_id)
            );
            if ($result->numRows()) {
                $row = $ilDB->fetchAssoc($result);
                return (int) $row["tstamp"];
            }
        }
        return null;
    }

References $ilDB.

getLastActivePage()

ilObjSurvey::getLastActivePage

(

int

$active_id

)

Returns the question id of the last active page a user visited in a survey.

Todo:

move to run manager/repo

Definition at line 2551 of file class.ilObjSurvey.php.

     : ?int {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT lastpage FROM svy_finished WHERE finished_id = %s",
            array('integer'),
            array($active_id)
        );
        if ($row = $ilDB->fetchAssoc($result)) {
            return (int) $row["lastpage"];
        }
        return null;
    }

getMailAddresses()

ilObjSurvey::getMailAddresses

(

)

(Tutor) Recipients of "single participant has finished" mails

Definition at line 4114 of file class.ilObjSurvey.php.

                                      : string
    {
        return $this->mailaddresses;
    }

getMailNotification()

ilObjSurvey::getMailNotification

(

)

Send mail to tutors each time a participant finishes the survey?

Definition at line 4098 of file class.ilObjSurvey.php.

                                         : bool
    {
        return $this->mailnotification;
    }

getMailParticipantData()

ilObjSurvey::getMailParticipantData

(

)

Preceding text (incl.

placeholders) for "single participant has finished" mails

Definition at line 4130 of file class.ilObjSurvey.php.

                                            : string
    {
        return $this->mailparticipantdata;
    }

getMaxSumScore()

ilObjSurvey::getMaxSumScore

(

)

Definition at line 5639 of file class.ilObjSurvey.php.

                                    : int
    {
        $sum_score = 0;
        foreach (ilObjSurveyQuestionPool::_getQuestionClasses() as $c) {
            $sum_score += call_user_func([$c, "getMaxSumScore"], $this->getSurveyId());
        }
        return $sum_score;
    }

References $c, and ilObjSurveyQuestionPool\_getQuestionClasses().

Here is the call graph for this function:

getMode()

ilObjSurvey::getMode

(

)

Definition at line 5590 of file class.ilObjSurvey.php.

                             : int
    {
        return $this->mode;
    }

Referenced by ilSurveyExecutionGUI\__construct(), ILIAS\Survey\Participants\StatusManager\__construct(), ILIAS\Survey\Evaluation\EvaluationManager\__construct(), ILIAS\Survey\Settings\UIFactory\__construct(), ILIAS\Survey\Settings\SettingsFormGUI\__construct(), ILIAS\Survey\Execution\RunManager\__construct(), ILIAS\Survey\Evaluation\EvaluationManager\getSelectableAppraisees(), initServices(), ILIAS\Survey\Participants\StatusManager\isExternalRater(), and ILIAS\Survey\Evaluation\EvaluationManager\isMultiParticipantsView().

Here is the caller graph for this function:

getNextPage()

ilObjSurvey::getNextPage	(	int	$active_page_question_id,
		int	$direction
	)

Get current, previous or next page.

Parameters

int	$active_page_question_id	The database id of one of the questions on that page
int	$direction	The direction of the next page (-1 = previous page, 1 = next page)

Returns

?array question data or null, if there is no previous/next page

Exceptions

ilSurveyException

Todo:

move to execution manager

Definition at line 1996 of file class.ilObjSurvey.php.

     : ?array {
        $foundpage = -1;
        $pages = $this->getSurveyPages();
        if ($active_page_question_id === 0) {
            return $pages[0];
        }
        foreach ($pages as $key => $question_array) {
            foreach ($question_array as $question) {
                if ($active_page_question_id == $question["question_id"]) {
                    $foundpage = $key;
                }
            }
        }
        if ($foundpage === -1) {
            throw new ilSurveyException("nextPage: Current page not found.");
        } else {
            $foundpage += $direction;
            if ($foundpage < 0) {
                return null;
            }
            if ($foundpage >= count($pages)) {
                return null;
            }
            return $pages[$foundpage];
        }
    }

getNotificationTargetUserIds()

ilObjSurvey::getNotificationTargetUserIds

(

bool

$a_use_invited

)

These users must finish the survey to trigger the tutor notification "all users finished the survey" a) members of a parent group/course or b) all members that have been invited (svy_invitation) invitations are presented as tasks on the dashboard.

Definition at line 5259 of file class.ilObjSurvey.php.

     : array {
        $tree = $this->tree;
 
        $user_ids = [];
        if ($a_use_invited) {
            $user_ids = $this->invitation_manager->getAllForSurvey($this->getSurveyId());
        } else {
            $parent_grp_ref_id = $tree->checkForParentType($this->getRefId(), "grp");
            if ($parent_grp_ref_id) {
                $part = new ilGroupParticipants(ilObject::_lookupObjId($parent_grp_ref_id));
                $user_ids = $part->getMembers();
            } else {
                $parent_crs_ref_id = $tree->checkForParentType($this->getRefId(), "crs");
                if ($parent_crs_ref_id) {
                    $part = new ilCourseParticipants(ilObject::_lookupObjId($parent_crs_ref_id));
                    $user_ids = $part->getMembers();
                }
            }
        }
        return $user_ids;
    }

getOutro()

ilObjSurvey::getOutro

(

)

Definition at line 1323 of file class.ilObjSurvey.php.

                              : string
    {
        return $this->outro;
    }

getParticipantTextResults()

ilObjSurvey::getParticipantTextResults ( int  $active_id )

protected

Definition at line 2485 of file class.ilObjSurvey.php.

     : string {
        $textresult = "";
        $userResults = $this->getUserSpecificResults(array($active_id));
        $questions = $this->getSurveyQuestions(true);
        $questioncounter = 1;
        foreach ($questions as $question_id => $question_data) {
            $textresult .= $questioncounter++ . ". " . $question_data["title"] . "\n";
            $found = $userResults[$question_id][$active_id];
            $text = "";
            if (is_array($found)) {
                $text = implode("\n", $found);
            } else {
                $text = $found;
            }
            if ($text === '') {
                $text = self::getSurveySkippedValue();
            }
            $text = str_replace("<br />", "\n", $text);
            $textresult .= $text . "\n\n";
        }
        return $textresult;
    }

getPoolUsage()

ilObjSurvey::getPoolUsage

(

)

Definition at line 4174 of file class.ilObjSurvey.php.

                                  : bool
    {
        return $this->pool_usage;
    }

getPrecondition()

ilObjSurvey::getPrecondition

(

int

$constraint_id

)

Returns a precondition with a given id.

Todo:

move to constraint manager, introduce dto

Definition at line 2042 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $result = $ilDB->queryF(
            "SELECT svy_constraint.*, svy_relation.*, svy_qst_constraint.question_fi ref_question_fi FROM svy_qst_constraint, svy_constraint, " .
            "svy_relation WHERE svy_constraint.relation_fi = svy_relation.relation_id AND " .
            "svy_qst_constraint.constraint_fi = svy_constraint.constraint_id AND svy_constraint.constraint_id = %s",
            array('integer'),
            array($constraint_id)
        );
        $pc = array();
        if ($result->numRows()) {
            $pc = $ilDB->fetchAssoc($result);
        }
        return $pc;
    }

getQuestionblockQuestionIds()

ilObjSurvey::getQuestionblockQuestionIds

(

int

$questionblock_id

)

Parameters

int

$questionblock_id

Returns

int[]

Todo:

move to survey question manager/repo

Definition at line 1629 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        // we need a correct order here, see #22011
        $result = $ilDB->queryF(
            "SELECT a.question_fi FROM svy_qblk_qst a JOIN svy_svy_qst b ON (a.question_fi = b.question_fi) " .
            " WHERE a.questionblock_fi = %s ORDER BY b.sequence",
            array("integer"),
            array($questionblock_id)
        );
        $ids = array();
        if ($result->numRows()) {
            while ($data = $ilDB->fetchAssoc($result)) {
                if (!in_array($data['question_fi'], $ids)) {            // no duplicates, see #22018
                    $ids[] = (int) $data['question_fi'];
                }
            }
        }
        return $ids;
    }

getQuestionblockQuestions()

ilObjSurvey::getQuestionblockQuestions

(

int

$questionblock_id

)

Parameters

int

$questionblock_id

Returns

string[] question titles

Todo:

move to survey question manager/repo

Definition at line 1592 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
        $titles = array();
        $result = $ilDB->queryF(
            "SELECT svy_question.title, svy_qblk_qst.question_fi, svy_qblk_qst.survey_fi FROM " .
            "svy_qblk, svy_qblk_qst, svy_question WHERE svy_qblk.questionblock_id = svy_qblk_qst.questionblock_fi AND " .
            "svy_question.question_id = svy_qblk_qst.question_fi AND svy_qblk.questionblock_id = %s",
            array('integer'),
            array($questionblock_id)
        );
        $survey_id = "";
        while ($row = $ilDB->fetchAssoc($result)) {
            $titles[$row["question_fi"]] = $row["title"];
            $survey_id = $row["survey_fi"];
        }
        $result = $ilDB->queryF(
            "SELECT question_fi, sequence FROM svy_svy_qst WHERE survey_fi = %s ORDER BY sequence",
            array('integer'),
            array($survey_id)
        );
        $resultarray = array();
        $counter = 1;
        while ($row = $ilDB->fetchAssoc($result)) {
            if (array_key_exists($row["question_fi"], $titles)) {
                $resultarray[$counter++] = $titles[$row["question_fi"]];
            }
        }
        return $resultarray;
    }

getQuestionblocksTable()

ilObjSurvey::getQuestionblocksTable

(

array

$arrFilter

)

Retrieve data for question block browser.

Todo:

move to survey question manager, use dto

Definition at line 2881 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $where = "";
        if (array_key_exists('title', $arrFilter) && strlen($arrFilter['title'])) {
            $where .= " AND " . $ilDB->like('svy_qblk.title', 'text', "%%" . $arrFilter['title'] . "%%");
        }
 
        $query_result = $ilDB->query("SELECT svy_qblk.*, svy_svy.obj_fi FROM svy_qblk , svy_qblk_qst, svy_svy WHERE " .
            "svy_qblk.questionblock_id = svy_qblk_qst.questionblock_fi AND svy_svy.survey_id = svy_qblk_qst.survey_fi " .
            "$where GROUP BY svy_qblk.questionblock_id, svy_qblk.title, svy_qblk.show_questiontext,  svy_qblk.show_blocktitle, " .
            "svy_qblk.owner_fi, svy_qblk.tstamp, svy_svy.obj_fi");
        $rows = array();
        if ($query_result->numRows()) {
            $survey_ref_ids = ilUtil::_getObjectsByOperations("svy", "write");
            $surveytitles = array();
            foreach ($survey_ref_ids as $survey_ref_id) {
                $survey_id = ilObject::_lookupObjId($survey_ref_id);
                $surveytitles[$survey_id] = ilObject::_lookupTitle($survey_id);
            }
            while ($row = $ilDB->fetchAssoc($query_result)) {
                $questions_array = $this->getQuestionblockQuestions($row["questionblock_id"]);
                $counter = 1;
                foreach ($questions_array as $key => $value) {
                    $questions_array[$key] = "$counter. $value";
                    $counter++;
                }
                if (strlen($surveytitles[$row["obj_fi"]] ?? "")) { // only questionpools which are not in trash
                    $rows[$row["questionblock_id"]] = array(
                        "questionblock_id" => $row["questionblock_id"],
                        "title" => $row["title"],
                        "svy" => $surveytitles[$row["obj_fi"]],
                        "contains" => implode(", ", $questions_array),
                        "owner" => $row["owner_fi"]
                    );
                }
            }
        }
        return $rows;
    }

References $ilDB.

Referenced by ilSurveyQuestionblockbrowserTableGUI\initData().

Here is the caller graph for this function:

getQuestionGUI()

ilObjSurvey::getQuestionGUI	(	string	$questiontype,
		int	$question_id
	)

Definition at line 899 of file class.ilObjSurvey.php.

     : SurveyQuestionGUI {
        return SurveyQuestionGUI::_getQuestionGUI($questiontype, $question_id);
    }

getQuestionpoolTitles()

ilObjSurvey::getQuestionpoolTitles	(	bool	$could_be_offline = false,
		bool	$showPath = false
	)

Returns the available question pools for the active user.

Returns

array<int, string> keys are obj IDs, values are titles

Definition at line 1354 of file class.ilObjSurvey.php.

     : array {
        return ilObjSurveyQuestionPool::_getAvailableQuestionpools(true, $could_be_offline, $showPath);
    }

getQuestionsTable()

ilObjSurvey::getQuestionsTable

(

array

$arrFilter

)

Retrieve data for question browser.

Todo:

move to survey question manager, use dto

Definition at line 2819 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
        $where = "";
        if (array_key_exists('title', $arrFilter) && strlen($arrFilter['title'])) {
            $where .= " AND " . $ilDB->like('svy_question.title', 'text', "%%" . $arrFilter['title'] . "%%");
        }
        if (array_key_exists('description', $arrFilter) && strlen($arrFilter['description'])) {
            $where .= " AND " . $ilDB->like('svy_question.description', 'text', "%%" . $arrFilter['description'] . "%%");
        }
        if (array_key_exists('author', $arrFilter) && strlen($arrFilter['author'])) {
            $where .= " AND " . $ilDB->like('svy_question.author', 'text', "%%" . $arrFilter['author'] . "%%");
        }
        if (array_key_exists('type', $arrFilter) && strlen($arrFilter['type'])) {
            $where .= " AND svy_qtype.type_tag = " . $ilDB->quote($arrFilter['type'], 'text');
        }
        if (array_key_exists('spl', $arrFilter) && strlen($arrFilter['spl'])) {
            $where .= " AND svy_question.obj_fi = " . $ilDB->quote($arrFilter['spl'], 'integer');
        }
 
        $spls = $this->getAvailableQuestionpools(true, false, false);
        $forbidden = " AND " . $ilDB->in('svy_question.obj_fi', array_keys($spls), false, 'integer');
        $forbidden .= " AND svy_question.complete = " . $ilDB->quote("1", 'text');
        $existing = "";
        $existing_questions = $this->getExistingQuestions();
        if (count($existing_questions)) {
            $existing = " AND " . $ilDB->in('svy_question.question_id', $existing_questions, true, 'integer');
        }
 
        $trans = ilObjSurveyQuestionPool::_getQuestionTypeTranslations();
 
        $query_result = $ilDB->query("SELECT svy_question.*, svy_qtype.type_tag, svy_qtype.plugin, object_reference.ref_id" .
            " FROM svy_question, svy_qtype, object_reference" .
            " WHERE svy_question.original_id IS NULL" . $forbidden . $existing .
            " AND svy_question.obj_fi = object_reference.obj_id AND svy_question.tstamp > 0" .
            " AND svy_question.questiontype_fi = svy_qtype.questiontype_id " . $where);
 
        $rows = array();
        if ($query_result->numRows()) {
            while ($row = $ilDB->fetchAssoc($query_result)) {
                if (array_key_exists('spl_txt', $arrFilter) && strlen($arrFilter['spl_txt'])) {
                    if (stripos($spls[$row["obj_fi"]], $arrFilter['spl_txt']) === false) {
                        continue;
                    }
                }
 
                $row['ttype'] = $trans[$row['type_tag']];
                if ($row["plugin"]) {
                    continue;
                } else {
                    $rows[] = $row;
                }
            }
        }
        return $rows;
    }

References $ilDB.

Referenced by ilSurveyQuestionbrowserTableGUI\initData().

Here is the caller graph for this function:

getQuestionType()

ilObjSurvey::getQuestionType

(

int

$question_id

)

Definition at line 907 of file class.ilObjSurvey.php.

     : string {
        $ilDB = $this->db;
        if ($question_id < 1) {
            return -1;
        }
        $result = $ilDB->queryF(
            "SELECT type_tag FROM svy_question, svy_qtype WHERE svy_question.question_id = %s AND " .
            "svy_question.questiontype_fi = svy_qtype.questiontype_id",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() === 1) {
            $data = $ilDB->fetchAssoc($result);
            return $data["type_tag"];
        } else {
            return "";
        }
    }

getRatersData()

ilObjSurvey::getRatersData

(

int

$a_appraisee_id

)

Todo:

move to appraisal manager

Definition at line 4564 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $res = $anonymous_ids = array();
 
        $set = $ilDB->query("SELECT * FROM svy_360_rater" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND appr_id = " . $ilDB->quote($a_appraisee_id, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            if ($row["anonymous_id"]) {
                $res["a" . $row["anonymous_id"]] = array(
                    "lastname" => "unknown code " . $row["anonymous_id"],
                    "sent" => $row["mail_sent"],
                    "finished" => null
                );
                $anonymous_ids[] = $row["anonymous_id"];
            } else {
                $name = ilObjUser::_lookupName($row["user_id"]);
                $name["name"] = $name["lastname"] . ", " . $name["firstname"];
                $name["user_id"] = "u" . $name["user_id"];
                $name["email"] = ilObjUser::_lookupEmail($row["user_id"]);
                $name["sent"] = $row["mail_sent"];
                $name["finished"] = (bool) $this->is360SurveyStarted($a_appraisee_id, (int) $row["user_id"]);
                $res["u" . $row["user_id"]] = $name;
            }
        }
 
        if (count($anonymous_ids)) {
            $data = $this->getSurveyCodesTableData($anonymous_ids);
            foreach ($data as $item) {
                if (isset($res["a" . $item["id"]])) {
                    $res["a" . $item["id"]] = array(
                        "user_id" => "a" . $item["id"],
                        "lastname" => $item["last_name"],
                        "firstname" => $item["first_name"],
                        "name" => $item["last_name"] . ", " . $item["first_name"],
                        "login" => "",
                        "email" => $item["email"],
                        "code" => $item["code"],
                        "href" => $item["href"],
                        "sent" => $res["a" . $item["id"]]["sent"],
                        "finished" => (bool) $this->is360SurveyStarted($a_appraisee_id, 0, $item["code"])
                    );
                }
            }
        }
 
        return $res;
    }

Referenced by ILIAS\Survey\Evaluation\EvaluationManager\getSelectableRaters().

Here is the caller graph for this function:

getReminderEnd()

ilObjSurvey::getReminderEnd

(

)

Definition at line 4992 of file class.ilObjSurvey.php.

                                    : ?ilDate
    {
        return $this->reminder_end;
    }

getReminderFrequency()

ilObjSurvey::getReminderFrequency

(

)

Definition at line 5002 of file class.ilObjSurvey.php.

                                          : int
    {
        return $this->reminder_frequency;
    }

getReminderLastSent()

ilObjSurvey::getReminderLastSent

(

)

Definition at line 5022 of file class.ilObjSurvey.php.

                                         : ?string
    {
        return $this->reminder_last_sent;
    }

getReminderMailTemplates()

ilObjSurvey::getReminderMailTemplates

(

?int &

$defaultTemplateId = null

)

Definition at line 5548 of file class.ilObjSurvey.php.

     : array {
        global $DIC;
 
        $res = array();
 
        $templateService = $DIC->mail()->textTemplates();
        foreach ($templateService->loadTemplatesForContextId(ilSurveyMailTemplateReminderContext::ID) as $tmpl) {
            $res[$tmpl->getTplId()] = $tmpl->getTitle();
            if (null !== $defaultTemplateId && $tmpl->isDefault()) {
                $defaultTemplateId = $tmpl->getTplId();
            }
        }
 
        return $res;
    }

getReminderStart()

ilObjSurvey::getReminderStart

(

)

Definition at line 4982 of file class.ilObjSurvey.php.

                                      : ?ilDate
    {
        return $this->reminder_start;
    }

getReminderStatus()

ilObjSurvey::getReminderStatus

(

)

Definition at line 4972 of file class.ilObjSurvey.php.

                                       : bool
    {
        return $this->reminder_status;
    }

getReminderTarget()

ilObjSurvey::getReminderTarget

(

)

Definition at line 5012 of file class.ilObjSurvey.php.

                                       : int
    {
        return $this->reminder_target;
    }

getReminderTemplate()

ilObjSurvey::getReminderTemplate

(

bool

$selectDefault = false

)

Definition at line 5035 of file class.ilObjSurvey.php.

     : ?int {
        if ($selectDefault) {
            $defaultTemplateId = 0;
            $this->getReminderMailTemplates($defaultTemplateId);
 
            if ($defaultTemplateId > 0) {
                return $defaultTemplateId;
            }
        }
 
        return $this->reminder_tmpl;
    }

getSelfEvaluationResults()

ilObjSurvey::getSelfEvaluationResults

(

)

Definition at line 5600 of file class.ilObjSurvey.php.

                                              : int
    {
        return $this->mode_self_eval_results;
    }

Referenced by ILIAS\Survey\Evaluation\EvaluationManager\isMultiParticipantsView().

Here is the caller graph for this function:

getShowQuestionTitles()

ilObjSurvey::getShowQuestionTitles

(

)

Definition at line 1161 of file class.ilObjSurvey.php.

                                           : bool
    {
        return (bool) $this->display_question_titles;
    }

getSkillService()

ilObjSurvey::getSkillService

(

)

Definition at line 4854 of file class.ilObjSurvey.php.

                                     : bool
    {
        return $this->mode_skill_service;
    }

getStartDate()

ilObjSurvey::getStartDate

(

)

Definition at line 1183 of file class.ilObjSurvey.php.

                                  : string
    {
        return $this->start_date;
    }

getSurveyCodesForExport()

ilObjSurvey::getSurveyCodesForExport	(	?array	$a_codes = null,
		?array	$a_ids = null
	)

Return a list of survey codes for file export, note: user_key needs to be null to export a record.

Parameters

?string[]	$a_codes array of all survey codes that should be exported, if null...
?int[]	$a_ids array of anonymous ids that should be exported

Returns

string comma separated list of survey codes an URLs for file export

Todo:

move to code manager

Exceptions

ilDateTimeException

Definition at line 3575 of file class.ilObjSurvey.php.

     : string {
        $ilDB = $this->db;
        $ilUser = $this->user;
        $lng = $this->lng;
 
        $sql = "SELECT svy_anonymous.*, svy_finished.state" .
            " FROM svy_anonymous" .
            " LEFT JOIN svy_finished ON (svy_anonymous.survey_key = svy_finished.anonymous_id)" .
            " WHERE svy_anonymous.survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND svy_anonymous.user_key IS NULL";
 
        if ($a_codes) {
            $sql .= " AND " . $ilDB->in("svy_anonymous.survey_key", $a_codes, "", "text");
        } elseif ($a_ids) {
            $sql .= " AND " . $ilDB->in("svy_anonymous.anonymous_id", $a_ids, "", "text");
        }
 
        $export = array();
 
        // #14905
        $titles = array();
        $titles[] = '"' . $lng->txt("survey_code") . '"';
        $titles[] = '"' . $lng->txt("email") . '"';
        $titles[] = '"' . $lng->txt("lastname") . '"';
        $titles[] = '"' . $lng->txt("firstname") . '"';
        $titles[] = '"' . $lng->txt("create_date") . '"';
        $titles[] = '"' . $lng->txt("used") . '"';
        $titles[] = '"' . $lng->txt("mail_sent_short") . '"';
        $titles[] = '"' . $lng->txt("survey_code_url") . '"';
        $export[] = implode(";", $titles);
 
        $result = $ilDB->query($sql);
        $default_lang = $ilUser->getPref("survey_code_language");
        while ($row = $ilDB->fetchAssoc($result)) {
            $item = array();
            $item[] = $row["survey_key"];
 
            if ($row["externaldata"]) {
                $ext = unserialize((string) $row["externaldata"], ['allowed_classes' => false]);
                $item[] = $ext["email"];
                $item[] = $ext["lastname"];
                $item[] = $ext["firstname"];
            } else {
                $item[] = "";
                $item[] = "";
                $item[] = "";
            }
 
            // No relative (today, tomorrow...) dates in export.
            $date = new ilDateTime($row['tstamp'], IL_CAL_UNIX);
            $item[] = $date->get(IL_CAL_DATETIME);
 
            $item[] = ($this->isSurveyCodeUsed($row["survey_key"])) ? 1 : 0;
            $item[] = ($row["sent"]) ? 1 : 0;
 
            $params = array("accesscode" => $row["survey_key"]);
            if ($default_lang) {
                $params["lang"] = $default_lang;
            }
            $item[] = ilLink::_getLink($this->getRefId(), "svy", $params);
 
            $export[] = '"' . implode('";"', $item) . '"';
        }
        return implode("\n", $export);
    }

References $ilDB.

getSurveyCodesTableData()

ilObjSurvey::getSurveyCodesTableData	(	?array	$ids = null,
		?string	$lang = null
	)

Fetches the data for the survey codes table.

Parameters

?string

$lang Language for the survey code URL

Todo:

move to code manager

Definition at line 3649 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $codes = array();
 
        $sql = "SELECT svy_anonymous.*, svy_finished.state" .
            " FROM svy_anonymous" .
            " LEFT JOIN svy_finished ON (svy_anonymous.survey_key = svy_finished.anonymous_id)" .
            " WHERE svy_anonymous.survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") /*.
            " AND svy_anonymous.user_key IS NULL" */; // #15860
 
        if ($ids) {
            $sql .= " AND " . $ilDB->in("svy_anonymous.anonymous_id", $ids, "", "integer");
        }
 
        $sql .= " ORDER BY tstamp, survey_key ASC";
        $result = $ilDB->query($sql);
        if ($result->numRows() > 0) {
            while ($row = $ilDB->fetchAssoc($result)) {
                $href = "";
                $used = false;
                if ($this->isSurveyCodeUsed($row["survey_key"])) {
                    $used = true;
                } else {
                    $params = array("accesscode" => $row["survey_key"]);
                    if ($lang) {
                        $params["lang"] = $lang;
                    }
                    $href = ilLink::_getLink($this->getRefId(), "svy", $params);
                }
 
 
                $item = array(
                    'id' => $row["anonymous_id"],
                    'code' => $row["survey_key"],
                    'date' => $row["tstamp"],
                    'used' => $used,
                    'sent' => $row['sent'],
                    'href' => $href,
                    'email' => '',
                    'last_name' => '',
                    'first_name' => ''
                );
 
                if ($row["externaldata"]) {
                    $ext = unserialize((string) $row["externaldata"], ['allowed_classes' => false]);
                    $item['email'] = $ext['email'] ?? "";
                    $item['last_name'] = $ext['lastname'] ?? "";
                    $item['first_name'] = $ext['firstname'] ?? "";
                }
 
                $codes[] = $item;
            }
        }
        return $codes;
    }

getSurveyFinishedIds()

ilObjSurvey::getSurveyFinishedIds

(

)

Get run ids.

Todo:

move to run manager

Returns

int[]

Definition at line 2656 of file class.ilObjSurvey.php.

                                          : array
    {
        $ilDB = $this->db;
 
        $users = array();
        $result = $ilDB->queryF(
            "SELECT * FROM svy_finished WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        if ($result->numRows()) {
            while ($row = $ilDB->fetchAssoc($result)) {
                $users[] = (int) $row["finished_id"];
            }
        }
        return $users;
    }

References $ilDB, and ILIAS\Repository\int().

Here is the call graph for this function:

getSurveyId()

ilObjSurvey::getSurveyId

(

)

Definition at line 928 of file class.ilObjSurvey.php.

                                 : int
    {
        return $this->survey_id;
    }

Referenced by ILIAS\Survey\Code\CodeManager\__construct(), ILIAS\Survey\Execution\RunManager\__construct(), deleteSurveyRecord(), and ilSurveyParticipantsTableGUI\getItems().

Here is the caller graph for this function:

getSurveyPages()

ilObjSurvey::getSurveyPages

(

)

Returns the survey pages in an array (a page contains one or more questions)

Todo:

move to survey question manager/repo, use dto

Definition at line 1911 of file class.ilObjSurvey.php.

                                    : array
    {
        $ilDB = $this->db;
        // get questionblocks
        $all_questions = array();
        $result = $ilDB->queryF(
            "SELECT svy_question.*, svy_qtype.type_tag, svy_svy_qst.heading FROM " .
            "svy_question, svy_qtype, svy_svy_qst WHERE svy_svy_qst.survey_fi = %s AND " .
            "svy_svy_qst.question_fi = svy_question.question_id AND svy_question.questiontype_fi = svy_qtype.questiontype_id " .
            "ORDER BY svy_svy_qst.sequence",
            array('integer'),
            array($this->getSurveyId())
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            $all_questions[$row["question_id"]] = $row;
        }
        // get all questionblocks
        $questionblocks = array();
        if (count($all_questions)) {
            $result = $ilDB->queryF(
                "SELECT svy_qblk.*, svy_qblk_qst.question_fi FROM svy_qblk, svy_qblk_qst " .
                "WHERE svy_qblk.questionblock_id = svy_qblk_qst.questionblock_fi AND svy_qblk_qst.survey_fi = %s " .
                "AND " . $ilDB->in('svy_qblk_qst.question_fi', array_keys($all_questions), false, 'integer'),
                array('integer'),
                array($this->getSurveyId())
            );
            while ($row = $ilDB->fetchAssoc($result)) {
                $questionblocks[$row['question_fi']] = $row;
            }
        }
 
        $all_pages = array();
        $pageindex = -1;
        $currentblock = "";
        foreach ($all_questions as $question_id => $row) {
            $constraints = array();
            if (isset($questionblocks[$question_id])) {
                if (!$currentblock or ($currentblock != $questionblocks[$question_id]['questionblock_id'])) {
                    $pageindex++;
                }
                $all_questions[$question_id]['page'] = $pageindex;
                $all_questions[$question_id]["questionblock_title"] = $questionblocks[$question_id]['title'];
                $all_questions[$question_id]["questionblock_id"] = $questionblocks[$question_id]['questionblock_id'];
                $all_questions[$question_id]["questionblock_show_questiontext"] = $questionblocks[$question_id]['show_questiontext'];
                $all_questions[$question_id]["questionblock_show_blocktitle"] = $questionblocks[$question_id]['show_blocktitle'];
                $all_questions[$question_id]["questionblock_compress_view"] = $questionblocks[$question_id]['compress_view'];
                $currentblock = $questionblocks[$question_id]['questionblock_id'];
            } else {
                $pageindex++;
                $all_questions[$question_id]['page'] = $pageindex;
                $all_questions[$question_id]["questionblock_title"] = "";
                $all_questions[$question_id]["questionblock_id"] = "";
                $all_questions[$question_id]["questionblock_show_questiontext"] = 1;
                $all_questions[$question_id]["questionblock_show_blocktitle"] = 1;
                $all_questions[$question_id]["questionblock_compress_view"] = false;
                $currentblock = "";
            }
            $constraints = $this->getConstraints($question_id);
            $all_questions[$question_id]["constraints"] = $constraints;
            if (!isset($all_pages[$pageindex])) {
                $all_pages[$pageindex] = array();
            }
            $all_pages[$pageindex][] = $all_questions[$question_id];
        }
        // calculate position percentage for every page
        $max = count($all_pages);
        $counter = 1;
        foreach ($all_pages as $index => $block) {
            foreach ($block as $blockindex => $question) {
                $all_pages[$index][$blockindex]["position"] = $counter / $max;
            }
            $counter++;
        }
 
        return $all_pages;
    }

References $counter, and $ilDB.

getSurveyParticipants()

ilObjSurvey::getSurveyParticipants	(	?array	$finished_ids = null,
		bool	$force_non_anonymous = false,
		bool	$include_invites = false
	)

Todo:

move to run/participant manager/repo

Definition at line 451 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
        $sql = "SELECT * FROM svy_finished" .
            " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer");
        if ($finished_ids) {
            $sql .= " AND " . $ilDB->in("finished_id", $finished_ids, "", "integer");
        }
 
        $result = $ilDB->query($sql);
        $participants = array();
        if ($result->numRows() > 0) {
            while ($row = $ilDB->fetchAssoc($result)) {
                $userdata = $this->getUserDataFromActiveId($row["finished_id"], $force_non_anonymous);
                $userdata["finished"] = (bool) $row["state"];
                $userdata["finished_tstamp"] = $row["tstamp"];
                $participants[$userdata["sortname"] . $userdata["active_id"]] = $userdata;
            }
        }
        $participant_ids = array_column($participants, "usr_id");
        if ($include_invites) {
            foreach ($this->invitation_manager->getAllForSurvey($this->getSurveyId()) as $usr_id) {
                if (!in_array($usr_id, $participant_ids)) {
                    $name = ilObjUser::_lookupName($usr_id);
                    $participants[$name["lastname"] . "," . $name["firstname"] . $usr_id] = [
                        "fullname" => ilObjUser::_lookupFullname($usr_id),
                        "sortname" => $name["lastname"] . "," . $name["firstname"],
                        "fistname" => $name["firstname"],
                        "lastname" => $name["lastname"],
                        "login" => $name["login"],
                        "gender" => "",
                        "usr_id" => $usr_id,
                        "finished" => false,
                        "finished_tstamp" => 0,
                        "invited" => true
                    ];
                }
            }
        }
        return $participants;
    }

References $ilDB.

Referenced by ilSurveyParticipantsTableGUI\getItems(), and ILIAS\Survey\Evaluation\EvaluationManager\getSelectableAppraisees().

Here is the caller graph for this function:

getSurveyQuestions()

ilObjSurvey::getSurveyQuestions

(

bool

$with_answers = false

)

Returns the survey questions and questionblocks in an array.

Todo:

move to survey question manager/repo, use dto

Definition at line 1802 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
        // get questionblocks
        $all_questions = array();
        $result = $ilDB->queryF(
            "SELECT svy_qtype.type_tag, svy_qtype.plugin, svy_question.question_id, " .
            "svy_svy_qst.heading FROM svy_qtype, svy_question, svy_svy_qst WHERE svy_svy_qst.survey_fi = %s AND " .
            "svy_svy_qst.question_fi = svy_question.question_id AND svy_question.questiontype_fi = svy_qtype.questiontype_id " .
            "ORDER BY svy_svy_qst.sequence",
            array('integer'),
            array($this->getSurveyId())
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            $add = true;
            if ($row["plugin"]) {
                $add = false;
            }
            if ($add) {
                $question = self::_instanciateQuestion($row["question_id"]);
                $questionrow = $question->getQuestionDataArray($row["question_id"]);
                foreach ($row as $key => $value) {
                    $questionrow[$key] = $value;
                }
                $all_questions[$row["question_id"]] = $questionrow;
                $all_questions[$row["question_id"]]["usableForPrecondition"] = $question->usableForPrecondition();
                $all_questions[$row["question_id"]]["availableRelations"] = $question->getAvailableRelations();
            }
        }
        // get all questionblocks
        $questionblocks = array();
        if (count($all_questions)) {
            $result = $ilDB->queryF(
                "SELECT svy_qblk.*, svy_qblk_qst.question_fi FROM svy_qblk, svy_qblk_qst WHERE " .
                "svy_qblk.questionblock_id = svy_qblk_qst.questionblock_fi AND svy_qblk_qst.survey_fi = %s " .
                "AND " . $ilDB->in('svy_qblk_qst.question_fi', array_keys($all_questions), false, 'integer'),
                array('integer'),
                array($this->getSurveyId())
            );
            while ($row = $ilDB->fetchAssoc($result)) {
                $questionblocks[$row['question_fi']] = $row;
            }
        }
 
        foreach ($all_questions as $question_id => $row) {
            $constraints = $this->getConstraints($question_id);
            if (isset($questionblocks[$question_id])) {
                $all_questions[$question_id]["questionblock_title"] = $questionblocks[$question_id]['title'];
                $all_questions[$question_id]["questionblock_id"] = $questionblocks[$question_id]['questionblock_id'];
            } else {
                $all_questions[$question_id]["questionblock_title"] = "";
                $all_questions[$question_id]["questionblock_id"] = "";
            }
            $all_questions[$question_id]["constraints"] = $constraints;
            if ($with_answers) {
                $answers = array();
                $result = $ilDB->queryF(
                    "SELECT svy_variable.*, svy_category.title FROM svy_variable, svy_category " .
                    "WHERE svy_variable.question_fi = %s AND svy_variable.category_fi = svy_category.category_id " .
                    "ORDER BY sequence ASC",
                    array('integer'),
                    array($question_id)
                );
                if ($result->numRows() > 0) {
                    while ($data = $ilDB->fetchAssoc($result)) {
                        $answers[] = $data["title"];
                    }
                }
                $all_questions[$question_id]["answers"] = $answers;
            }
        }
        return $all_questions;
    }

Referenced by SurveyConstraintsTableGUI\initItems().

Here is the caller graph for this function:

getSurveySkippedValue()

static ilObjSurvey::getSurveySkippedValue ( )

static

Definition at line 5532 of file class.ilObjSurvey.php.

                                                  : string
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        // #13541
 
        $surveySetting = new ilSetting("survey");
        if (!$surveySetting->get("skipped_is_custom", false)) {
            return $lng->txt("skipped");
        } else {
            return $surveySetting->get("skipped_custom_value", "");
        }
    }

References $DIC, and $lng.

Referenced by ilSurveyResultsUserTableGUI\fillRow(), and SurveyQuestionEvaluation\getSkippedValue().

Here is the caller graph for this function:

getSurveysWithTutorResults()

static ilObjSurvey::getSurveysWithTutorResults ( )

static

Returns

int[]

Definition at line 5608 of file class.ilObjSurvey.php.

                                                       : array
    {
        global $ilDB;
 
        $res = array();
 
        $log = ilLoggerFactory::getLogger("svy");
 
 
        $q = "SELECT obj_fi FROM svy_svy" .
            " WHERE tutor_res_cron IS NULL" .
            " AND tutor_res_status = " . $ilDB->quote(1, "integer") .
            " AND enddate < " . $ilDB->quote(date("Ymd000000"), "text");
 
        if (DEVMODE) {
            $q = "SELECT obj_fi FROM svy_svy" .
                " WHERE tutor_res_status = " . $ilDB->quote(1, "integer") .
                " AND enddate < " . $ilDB->quote(date("Ymd000000"), "text");
        }
 
        $set = $ilDB->query($q);
 
        $log->debug($q);
 
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = (int) $row["obj_fi"];
        }
 
        return $res;
    }

References $ilDB, $log, $q, $res, ilLoggerFactory\getLogger(), and ILIAS\Repository\int().

Here is the call graph for this function:

getTextblock()

ilObjSurvey::getTextblock

(

int

$question_id

)

Todo:

move to survey question manager

Definition at line 3409 of file class.ilObjSurvey.php.

     : string {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT * FROM svy_svy_qst WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
        if ($row = $ilDB->fetchAssoc($result)) {
            return $row["heading"] ?? "";
        } else {
            return "";
        }
    }

getTutorNotificationRecipients()

ilObjSurvey::getTutorNotificationRecipients

(

)

Mail being sent to tutors after all participants have finished the survey?

Definition at line 5071 of file class.ilObjSurvey.php.

                                                    : array
    {
        return $this->tutor_ntf_recipients;
    }

getTutorNotificationStatus()

ilObjSurvey::getTutorNotificationStatus

(

)

Definition at line 5055 of file class.ilObjSurvey.php.

                                                : bool
    {
        return $this->tutor_ntf_status;
    }

getTutorNotificationTarget()

ilObjSurvey::getTutorNotificationTarget

(

)

Group that is checked for the "all participants have finished" mail Either a) all members of a parent group/course or b) all users which have been invited (svy_invitation) (= task on dashboard)

Definition at line 5090 of file class.ilObjSurvey.php.

                                                : int
    {
        return $this->tutor_ntf_target;
    }

getTutorResultsRecipients()

ilObjSurvey::getTutorResultsRecipients

(

)

Definition at line 5110 of file class.ilObjSurvey.php.

                                               : array
    {
        return $this->tutor_res_recipients;
    }

getTutorResultsStatus()

ilObjSurvey::getTutorResultsStatus

(

)

Definition at line 5100 of file class.ilObjSurvey.php.

                                           : bool
    {
        return $this->tutor_res_status;
    }

getUserAccessCode()

ilObjSurvey::getUserAccessCode

(

int

$user_id

)

Returns a survey access code that was saved for a registered user.

Parameters

int

$user_id

The database id of the user

Returns

string The survey access code of the user

Todo:

move to code manager

Definition at line 3914 of file class.ilObjSurvey.php.

                                                   : string
    {
        $ilDB = $this->db;
        $access_code = "";
        $result = $ilDB->queryF(
            "SELECT survey_key FROM svy_anonymous WHERE survey_fi = %s AND user_key = %s",
            array('integer','text'),
            array($this->getSurveyId(), md5($user_id))
        );
        if ($result->numRows()) {
            $row = $ilDB->fetchAssoc($result);
            $access_code = $row["survey_key"];
        }
        return $access_code;
    }

References $ilDB, and $user_id.

getUserData()

ilObjSurvey::getUserData

(

array

$ids

)

Returns a data of all users specified by id list.

Parameters

int[]

$ids

array of user id's

Returns

array The user data "usr_id, login, lastname, firstname, clientip" of the users with id as key

Todo:

use user service, remove direct access to usr_data table

Definition at line 4078 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        if (count($ids) === 0) {
            return array();
        }
 
        $result = $ilDB->query("SELECT usr_id, login, lastname, firstname FROM usr_data WHERE " . $ilDB->in('usr_id', $ids, false, 'integer') . " ORDER BY login");
        $result_array = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            $result_array[$row["usr_id"]] = $row;
        }
        return $result_array;
    }

getUserDataFromActiveId()

ilObjSurvey::getUserDataFromActiveId	(	int	$active_id,
		bool	$force_non_anonymous = false
	)

Returns run information.

Todo:

move to run manager/repo

Definition at line 2709 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $surveySetting = new ilSetting("survey");
        $use_anonymous_id = $surveySetting->get("use_anonymous_id");
        $result = $ilDB->queryF(
            "SELECT * FROM svy_finished WHERE finished_id = %s",
            array('integer'),
            array($active_id)
        );
        $row = array();
        $foundrows = $result->numRows();
        if ($foundrows) {
            $row = $ilDB->fetchAssoc($result);
        }
        $name = ($use_anonymous_id) ? $row["anonymous_id"] : $this->lng->txt("anonymous");
        $userdata = array(
            "fullname" => $name,
            "sortname" => $name,
            "firstname" => "",
            "lastname" => "",
            "login" => "",
            "gender" => "",
            "active_id" => (string) $active_id
        );
        if ($foundrows) {
            if (($row["user_fi"] > 0) &&
                    (($row["user_fi"] != ANONYMOUS_USER_ID &&
                        !$this->hasAnonymizedResults() &&
                        !$this->get360Mode()) ||  // 360° uses ANONYMIZE_CODE_ALL which is wrong - see ilObjSurveyGUI::afterSave()
                        $force_non_anonymous)) {
                if (ilObjUser::_lookupLogin($row["user_fi"]) === '') {
                    $userdata["fullname"] = $userdata["sortname"] = $this->lng->txt("deleted_user");
                } else {
                    $user = new ilObjUser($row["user_fi"]);
                    $userdata['usr_id'] = $row['user_fi'];
                    $userdata["fullname"] = $user->getFullname();
                    $gender = $user->getGender();
                    if (strlen($gender) === 1) {
                        $gender = $this->lng->txt("gender_$gender");
                    }
                    $userdata["gender"] = $gender;
                    $userdata["firstname"] = $user->getFirstname();
                    $userdata["lastname"] = $user->getLastname();
                    $userdata["sortname"] = $user->getLastname() . ", " . $user->getFirstname();
                    $userdata["login"] = $user->getLogin();
                }
            }
            if ($row["user_fi"] == 0 || $row["user_fi"] == ANONYMOUS_USER_ID) {
                $code = $this->code_manager->getByUserKey((string) $row["anonymous_id"]);
                if (!is_null($code) && $this->feature_config->usesAppraisees()) {
                    $userdata["firstname"] = $code->getFirstName();
                    $userdata["lastname"] = $code->getLastName();
                    $userdata["sortname"] = $code->getLastName() . ", " . $code->getFirstName();
                }
            }
        }
        return $userdata;
    }

getUserSettings()

ilObjSurvey::getUserSettings	(	int	$usr_id,
		string	$key
	)

Definition at line 675 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $result = $ilDB->queryF(
            "SELECT * FROM svy_settings WHERE usr_id = %s AND keyword = %s",
            array('integer', 'text'),
            array($usr_id, $key)
        );
        $found = array();
        if ($result->numRows()) {
            while ($row = $ilDB->fetchAssoc($result)) {
                $found[$row['settings_id']] = $row;
            }
        }
        return $found;
    }

getUserSpecificResults()

ilObjSurvey::getUserSpecificResults

(

array

$finished_ids

)

Calculates the evaluation data for the user specific results.

Parameters

int[]

$finished_ids

Todo:

move to evaluation manager

Definition at line 2679 of file class.ilObjSurvey.php.

     : array {
        $evaluation = array();
 
        foreach (array_keys($this->getSurveyQuestions()) as $question_id) {
            // get question instance
            $question_type = SurveyQuestion::_getQuestionType($question_id);
            SurveyQuestion::_includeClass($question_type);
            $question = new $question_type();
            $question->loadFromDb($question_id);
 
            $q_eval = SurveyQuestion::_instanciateQuestionEvaluation($question_id, $finished_ids);
            $q_res = $q_eval->getResults();
 
            $data = array();
            foreach ($finished_ids as $user_id) {
                $data[$user_id] = $q_eval->parseUserSpecificResults($q_res, $user_id);
            }
 
            $evaluation[$question_id] = $data;
        }
 
        return $evaluation;
    }

References $data, $user_id, SurveyQuestion\_getQuestionType(), SurveyQuestion\_includeClass(), and SurveyQuestion\_instanciateQuestionEvaluation().

Here is the call graph for this function:

getUserSurveyExecutionStatus()

ilObjSurvey::getUserSurveyExecutionStatus

(

?string

$a_code = null

)

Get current user execution status.

Generates a code in svy_anonymous for logged in raters, if codes are used Generates a code for the anonymous user, if the survey is set to anonymous and no codes are used

Parameters

?string

$a_code

Returns

array|null

Todo:

move to run manager

Definition at line 4701 of file class.ilObjSurvey.php.

     : ?array {
        $ilUser = $this->user;
        $ilDB = $this->db;
        $user_id = $ilUser->getId();
        // code is obligatory?
        if (!$this->isAccessibleWithoutCode()) {
            if (!$a_code) {
                // registered raters do not need code
                if ($this->feature_config->usesAppraisees() &&
                    $user_id !== ANONYMOUS_USER_ID &&
                    $this->isRater(0, $user_id)) {
                    // auto-generate code
                    $code = $this->data_manager->code("")
                        ->withUserId($user_id);
                    $this->code_manager->add($code);
                    $a_code = $this->code_manager->getByUserId($user_id);
                } else {
                    return null;
                }
            }
        } elseif ($user_id === ANONYMOUS_USER_ID ||
            $this->getAnonymize() === self::ANONYMIZE_FREEACCESS) {
            // self::ANONYMIZE_FREEACCESS: anonymized, no codes
            // or anonymous user when no codes are used
            if (!$a_code) {
                // auto-generate code
                $code = $this->data_manager->code("")
                    ->withUserId($user_id);
                $code_id = $this->code_manager->add($code);
                $a_code = $this->code_manager->getByCodeId($code_id);
            }
        } else {
            $a_code = null;
        }
 
        $res = array();
 
        // get runs for user id / code
        $sql = "SELECT * FROM svy_finished" .
            " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer");
        // if proper user id is given, use it or current code
        if ($user_id !== ANONYMOUS_USER_ID) {
            $sql .= " AND (user_fi = " . $ilDB->quote($user_id, "integer") .
                " OR anonymous_id = " . $ilDB->quote($a_code, "text") . ")";
        }
        // use anonymous code to find finished id(s)
        else {
            $sql .= " AND anonymous_id = " . $ilDB->quote($a_code, "text");
        }
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[$row["finished_id"]] = array("appr_id" => $row["appr_id"],
                "user_id" => $row["user_fi"],
                "code" => $row["anonymous_id"],
                "finished" => (bool) $row["state"]);
        }
        return array("code" => $a_code, "runs" => $res);
    }

References $user_id, and ANONYMOUS_USER_ID.

getVariables()

ilObjSurvey::getVariables

(

int

$question_id

)

Returns all variables (answer options/scale values) of a question.

Todo:

move to (pool?) question manager/repo

Definition at line 2133 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
 
        $result_array = array();
        $result = $ilDB->queryF(
            "SELECT svy_variable.*, svy_category.title FROM svy_variable LEFT JOIN " .
            "svy_category ON svy_variable.category_fi = svy_category.category_id WHERE svy_variable.question_fi = %s " .
            "ORDER BY svy_variable.sequence",
            array('integer'),
            array($question_id)
        );
        while ($row = $ilDB->fetchObject($result)) {
            $result_array[$row->sequence] = $row;
        }
        return $result_array;
    }

getWorkingtimeForParticipant()

ilObjSurvey::getWorkingtimeForParticipant

(

int

$finished_id

)

Todo:

move to run manager?

Definition at line 4146 of file class.ilObjSurvey.php.

     : int {
        $ilDB = $this->db;
 
        $result = $ilDB->queryF(
            "SELECT * FROM svy_times WHERE finished_fi = %s",
            array('integer'),
            array($finished_id)
        );
        $total = 0;
        while ($row = $ilDB->fetchAssoc($result)) {
            if ($row['left_page'] > 0 && $row['entered_page'] > 0) {
                $total += $row['left_page'] - $row['entered_page'];
            }
        }
        return $total;
    }

hasAnonymizedResults()

ilObjSurvey::hasAnonymizedResults

(

)

Definition at line 975 of file class.ilObjSurvey.php.

                                          : bool
    {
        return ($this->getAnonymize() === self::ANONYMIZE_ON ||
            $this->getAnonymize() === self::ANONYMIZE_FREEACCESS);
    }

hasAnonymousUserList()

ilObjSurvey::hasAnonymousUserList

(

)

Definition at line 5527 of file class.ilObjSurvey.php.

                                          : bool
    {
        return $this->anon_user_list;
    }

hasEnded()

ilObjSurvey::hasEnded

(

)

Definition at line 1248 of file class.ilObjSurvey.php.

                              : bool
    {
        $end = $this->getEndDate();
        if ($end) {
            $end_date = new ilDateTime($end, IL_CAL_TIMESTAMP);
            return ($end_date->get(IL_CAL_UNIX) < time());
        }
        return false;
    }

References IL_CAL_TIMESTAMP, and IL_CAL_UNIX.

hasMailConfirmation()

ilObjSurvey::hasMailConfirmation

(

)

Definition at line 5517 of file class.ilObjSurvey.php.

                                         : bool
    {
        return $this->mail_confirmation;
    }

hasMailOwnResults()

ilObjSurvey::hasMailOwnResults

(

)

Definition at line 5507 of file class.ilObjSurvey.php.

                                       : bool
    {
        return $this->mail_own_results;
    }

hasQuestions()

ilObjSurvey::hasQuestions

(

)

Definition at line 505 of file class.ilObjSurvey.php.

                                  : bool
    {
        return count($this->questions);
    }

hasStarted()

ilObjSurvey::hasStarted

(

)

Definition at line 1238 of file class.ilObjSurvey.php.

                                : bool
    {
        $start = $this->getStartDate();
        if ($start) {
            $start_date = new ilDateTime($start, IL_CAL_TIMESTAMP);
            return ($start_date->get(IL_CAL_UNIX) < time());
        }
        return true;
    }

References IL_CAL_TIMESTAMP, and IL_CAL_UNIX.

hasViewOwnResults()

ilObjSurvey::hasViewOwnResults

(

)

Definition at line 5497 of file class.ilObjSurvey.php.

                                       : bool
    {
        return $this->view_own_results;
    }

importObject()

ilObjSurvey::importObject	(	array	$file_info,
		int	$svy_qpl_id
	)

Exceptions

ilException
ilImportException
ilInvalidSurveyImportFileException

Returns

string error

Todo:

move to export sub-service

Definition at line 3164 of file class.ilObjSurvey.php.

     : string {
        if ($svy_qpl_id < 1) {
            $svy_qpl_id = -1;
        }
        // check if file was uploaded
        $source = $file_info["tmp_name"];
        $error = "";
        if (($source === 'none') || (!$source) || $file_info["error"] > UPLOAD_ERR_OK) {
            $error = $this->lng->txt("import_no_file_selected");
        }
        // check correct file type
        $isXml = false;
        $isZip = false;
        if ((strcmp($file_info["type"], "text/xml") === 0) || (strcmp($file_info["type"], "application/xml") === 0)) {
            $this->svy_log->debug("isXML");
            $isXml = true;
        }
        // too many different mime-types, so we use the suffix
        $suffix = pathinfo($file_info["name"]);
        if (strcmp(strtolower($suffix["extension"]), "zip") === 0) {
            $this->svy_log->debug("isZip");
            $isZip = true;
        }
        if (!$isXml && !$isZip) {
            $error = $this->lng->txt("import_wrong_file_type");
            $this->svy_log->debug("Survey: Import error. Filetype was \"" . $file_info["type"] . "\"");
        }
        if ($error === '') {
            // import file as a survey
            $import_dir = $this->getImportDirectory();
            $import_subdir = "";
            $importfile = "";
            if ($isZip) {
                $importfile = $import_dir . "/" . $file_info["name"];
                ilFileUtils::moveUploadedFile($source, $file_info["name"], $importfile);
                $this->domain->resources()->zip()->unzipFile($importfile);
                $found = $this->locateImportFiles($import_dir);
                if (!((strlen($found["dir"]) > 0) && (strlen($found["xml"]) > 0))) {
                    $error = $this->lng->txt("wrong_import_file_structure");
                    return $error;
                }
                $importfile = $found["xml"];
                $import_subdir = $found["dir"];
            } else {
                $importfile = tempnam($import_dir, "survey_import");
                ilFileUtils::moveUploadedFile($source, $file_info["name"], $importfile);
            }
 
            $this->svy_log->debug("Import file = $importfile");
            $this->svy_log->debug("Import subdir = $import_subdir");
 
            $fh = fopen($importfile, 'rb');
            if (!$fh) {
                $error = $this->lng->txt("import_error_opening_file");
                return $error;
            }
            $xml = fread($fh, filesize($importfile));
            $result = fclose($fh);
            if (!$result) {
                $error = $this->lng->txt("import_error_closing_file");
                return $error;
            }
 
            $this->import_manager->clearMobs();
            if (strpos($xml, "questestinterop")) {
                throw new ilInvalidSurveyImportFileException("Unsupported survey version (< 3.8) found.");
            } else {
                $this->svy_log->debug("survey id = " . $this->getId());
                $this->svy_log->debug("question pool id = " . $svy_qpl_id);
 
                $imp = new ilImport();
                $config = $imp->getConfig("components/ILIAS/Survey");
                $config->setQuestionPoolID($svy_qpl_id);
                $imp->getMapping()->addMapping("components/ILIAS/Survey", "svy", 0, $this->getId());
                $imp->importFromDirectory($import_subdir, "svy", "components/ILIAS/Survey");
                $this->svy_log->debug("config(Modules/survey)->getQuestionPoolId =" . $config->getQuestionPoolID());
            }
        }
        return $error;
    }

importSurveyCode()

ilObjSurvey::importSurveyCode	(	string	$a_anonymize_key,
		int	$a_created,
		array	$a_data
	)

Todo:

move to code manager

Definition at line 3742 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $next_id = $ilDB->nextId('svy_anonymous');
        $ilDB->manipulateF(
            "INSERT INTO svy_anonymous (anonymous_id, survey_key, survey_fi, externaldata, tstamp) " .
            "VALUES (%s, %s, %s, %s, %s)",
            array('integer','text','integer','text','integer'),
            array($next_id, $a_anonymize_key, $this->getSurveyId(), serialize($a_data), $a_created)
        );
    }

initServices()

ilObjSurvey::initServices ( )

protected

Definition at line 194 of file class.ilObjSurvey.php.

                                     : void
    {
        if ($this->getRefId() > 0) {
            $this->code_manager = $this
                ->survey_service
                ->domain()
                ->code($this, $this->user->getId());
        }
        $this->feature_config = $this
            ->survey_service
            ->domain()
            ->modeFeatureConfig($this->getMode());
 
        $this->data_manager = $this
            ->survey_service
            ->data();
    }

References getMode(), ilObject\getRefId(), and ILIAS\Repository\user().

Referenced by __construct(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

insertQuestion()

ilObjSurvey::insertQuestion

(

int

$question_id

)

Inserts a question in the survey and saves the relation to the database.

Todo:

move to survey question manager/repo

Definition at line 550 of file class.ilObjSurvey.php.

     : bool {
        $ilDB = $this->db;
 
        $this->svy_log->debug("insert question, id:" . $question_id);
 
        if (!SurveyQuestion::_isComplete($question_id)) {
            $this->svy_log->debug("question is not complete");
            return false;
        } else {
            // get maximum sequence index in test
            $result = $ilDB->queryF(
                "SELECT survey_question_id FROM svy_svy_qst WHERE survey_fi = %s",
                array('integer'),
                array($this->getSurveyId())
            );
            $sequence = $result->numRows();
            $duplicate_id = $this->duplicateQuestionForSurvey($question_id);
            $this->svy_log->debug("duplicate, id: " . $question_id . ", duplicate id: " . $duplicate_id);
 
            // check if question is not already in the survey, see #22018
            if ($this->isQuestionInSurvey($duplicate_id)) {
                return false;
            }
 
            $next_id = $ilDB->nextId('svy_svy_qst');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_svy_qst (survey_question_id, survey_fi, question_fi, sequence, tstamp) VALUES (%s, %s, %s, %s, %s)",
                array('integer', 'integer', 'integer', 'integer', 'integer'),
                array($next_id, $this->getSurveyId(), $duplicate_id, $sequence, time())
            );
 
            $this->svy_log->debug("added entry to svy_svy_qst, id: " . $next_id . ", question id: " . $duplicate_id . ", sequence: " . $sequence);
 
            $this->loadQuestionsFromDb();
            $this->saveCompletionStatus();
            return true;
        }
    }

insertQuestionblock()

ilObjSurvey::insertQuestionblock

(

int

$questionblock_id

)

Definition at line 609 of file class.ilObjSurvey.php.

     : void {
 
        $sequence_manager = $this->survey_service->domain()->sequence(
            $this->getSurveyId(),
            $this
        );
 
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT svy_qblk.title, svy_qblk.show_questiontext, svy_qblk.show_blocktitle," .
            " svy_qblk_qst.question_fi FROM svy_qblk, svy_qblk_qst, svy_svy_qst" .
            " WHERE svy_qblk.questionblock_id = svy_qblk_qst.questionblock_fi" .
            " AND svy_svy_qst.question_fi = svy_qblk_qst.question_fi" .
            " AND svy_qblk.questionblock_id = %s" .
            " ORDER BY svy_svy_qst.sequence",
            array('integer'),
            array($questionblock_id)
        );
        $questions = array();
        $show_questiontext = false;
        $show_blocktitle = false;
        $title = "";
        while ($row = $ilDB->fetchAssoc($result)) {
            //$duplicate_id = $this->duplicateQuestionForSurvey($row["question_fi"]);
            $duplicate_id = $sequence_manager->appendQuestion($row["question_fi"], true);
            $questions[] = $duplicate_id;
            $title = (string) $row["title"];
            $show_questiontext = (bool) $row["show_questiontext"];
            $show_blocktitle = (bool) $row["show_blocktitle"];
        }
        $this->createQuestionblock($title, $show_questiontext, $show_blocktitle, $questions);
    }

is360SurveyStarted()

ilObjSurvey::is360SurveyStarted	(	int	$appr_id,
		int	$user_id,
		?string	$anonymous_code = null
	)

Todo:

move to appraisal manager

Definition at line 4669 of file class.ilObjSurvey.php.

     : ?int {
        $ilDB = $this->db;
 
        $sql = "SELECT * FROM svy_finished" .
            " WHERE survey_fi =" . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND appr_id = " . $ilDB->quote($appr_id, "integer");
        if ($user_id) {
            $sql .= " AND user_fi = " . $ilDB->quote($user_id, "integer");
        } else {
            $sql .= " AND anonymous_id = " . $ilDB->quote($anonymous_code, "text");
        }
        $result = $ilDB->query($sql);
        if ($result->numRows() === 0) {
            return null;
        } else {
            $row = $ilDB->fetchAssoc($result);
            return (int) $row["state"];
        }
    }

References $ilDB, and $user_id.

isAccessibleWithoutCode()

ilObjSurvey::isAccessibleWithoutCode

(

)

Definition at line 968 of file class.ilObjSurvey.php.

                                             : bool
    {
        return ($this->getAnonymize() === self::ANONYMIZE_OFF ||
            $this->getAnonymize() === self::ANONYMIZE_FREEACCESS);
    }

isActivationLimited()

ilObjSurvey::isActivationLimited

(

)

Definition at line 1308 of file class.ilObjSurvey.php.

                                         : bool
    {
        return $this->activation_limited;
    }

isAnonymizedParticipant()

ilObjSurvey::isAnonymizedParticipant

(

string

$key

)

Parameters

string

$key

(access code)

Todo:

move to participant manager

Definition at line 3554 of file class.ilObjSurvey.php.

                                                        : bool
    {
        $ilDB = $this->db;
 
        $result = $ilDB->queryF(
            "SELECT finished_id FROM svy_finished WHERE anonymous_id = %s AND survey_fi = %s",
            array('text','integer'),
            array($key, $this->getSurveyId())
        );
        return $result->numRows() === 1;
    }

References $ilDB.

isAppraisee()

ilObjSurvey::isAppraisee

(

int

$a_user_id

)

Todo:

move to appraisal manager

Definition at line 4392 of file class.ilObjSurvey.php.

     : bool {
        $ilDB = $this->db;
        $set = $ilDB->query("SELECT user_id" .
            " FROM svy_360_appr" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer"));
        return (bool) $ilDB->numRows($set);
    }

Referenced by ILIAS\Survey\Participants\StatusManager\canAddItselfAsAppraisee(), and ILIAS\Survey\Participants\StatusManager\isAppraisee().

Here is the caller graph for this function:

isAppraiseeClosed()

ilObjSurvey::isAppraiseeClosed

(

int

$a_user_id

)

Todo:

move to appraisal manager

Definition at line 4406 of file class.ilObjSurvey.php.

     : bool {
        $ilDB = $this->db;
 
        $set = $ilDB->query("SELECT has_closed" .
            " FROM svy_360_appr" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer"));
        $row = $ilDB->fetchAssoc($set);
        return (bool) ($row["has_closed"] ?? false);
    }

isComplete()

ilObjSurvey::isComplete

(

)

Check if survey is complete for use.

Todo:

move to survey manager

Definition at line 500 of file class.ilObjSurvey.php.

                                : bool
    {
        return ($this->getTitle() && count($this->questions));
    }

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

isHTML()

ilObjSurvey::isHTML

(

string

$a_text

)

Checks if a given string contains HTML or not.

Todo:

move to export sub-service

Definition at line 3997 of file class.ilObjSurvey.php.

     : bool {
        if (preg_match("/<[^>]*?>/", $a_text)) {
            return true;
        } else {
            return false;
        }
    }

isQuestionInAnyBlock()

ilObjSurvey::isQuestionInAnyBlock

(

int

$a_question_fi

)

Todo:

move to survey question manager/repo

Definition at line 1570 of file class.ilObjSurvey.php.

     : bool {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT * FROM svy_qblk_qst " .
            " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND question_fi = " . $ilDB->quote($a_question_fi, "integer"));
        if ($rec = $ilDB->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

isQuestionInSurvey()

ilObjSurvey::isQuestionInSurvey

(

int

$a_question_fi

)

Definition at line 592 of file class.ilObjSurvey.php.

     : bool {
        global $DIC;
        //return false;
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT * FROM svy_svy_qst " .
            " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND question_fi = " . $ilDB->quote($a_question_fi, "integer"));
        if ($rec = $ilDB->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

isRater()

ilObjSurvey::isRater	(	int	$a_appraisee_id,
		int	$a_user_id,
		int	$a_anonymous_id = 0
	)

Todo:

move to appraisal manager

Definition at line 4511 of file class.ilObjSurvey.php.

     : bool {
        $ilDB = $this->db;
 
        // user is rater if already appraisee and active self-evaluation
        if ($this->isAppraisee($a_user_id) &&
            $this->get360SelfEvaluation() &&
            (!$a_appraisee_id || $a_appraisee_id === $a_user_id)) {
            return true;
        }
 
        // :TODO: should we get rid of code as well?
 
        $sql = "SELECT user_id" .
            " FROM svy_360_rater" .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND anonymous_id = " . $ilDB->quote($a_anonymous_id, "integer");
        if ($a_appraisee_id) {
            $sql .= " AND appr_id = " . $ilDB->quote($a_appraisee_id, "integer");
        }
        $set = $ilDB->query($sql);
        return (bool) $ilDB->numRows($set);
    }

isSurveyCodeUnique()

ilObjSurvey::isSurveyCodeUnique

(

string

$code

)

Todo:

move to code manager

Definition at line 3727 of file class.ilObjSurvey.php.

     : bool {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT anonymous_id FROM svy_anonymous WHERE survey_fi = %s AND survey_key = %s",
            array('integer','text'),
            array($this->getSurveyId(), $code)
        );
        return !(($result->numRows() > 0));
    }

isSurveyCodeUsed()

ilObjSurvey::isSurveyCodeUsed

(

string

$code

)

Todo:

move to code manager

Definition at line 3712 of file class.ilObjSurvey.php.

     : bool {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT finished_id FROM svy_finished WHERE survey_fi = %s AND anonymous_id = %s",
            array('integer','text'),
            array($this->getSurveyId(), $code)
        );
        return $result->numRows() > 0;
    }

isSurveyFinishedByCode()

ilObjSurvey::isSurveyFinishedByCode

(

string

$a_code

)

Get if survey is finished for a specific anonymous user code.

Parameters

string

$a_code

anonymous user code

Returns

bool

Todo:

move to run manager

Definition at line 3878 of file class.ilObjSurvey.php.

                                                          : bool
    {
        $result = $this->db->queryF(
            "SELECT state FROM svy_finished WHERE survey_fi = %s AND anonymous_id = %s",
            array('integer','text'),
            array($this->getSurveyId(), $a_code)
        );
 
        $row = $this->db->fetchAssoc($result);
 
        return $row['state'] ?? false;
    }

isUnusedCode()

ilObjSurvey::isUnusedCode	(	string	$a_code,
		int	$a_user_id
	)

Todo:

move to code manager

Definition at line 4783 of file class.ilObjSurvey.php.

     : bool {
        $ilDB = $this->db;
 
        $set = $ilDB->query("SELECT user_fi FROM svy_finished" .
            " WHERE survey_fi = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND anonymous_id = " . $ilDB->quote($a_code, "text"));
        $user_id = $ilDB->fetchAssoc($set);
        $user_id = (int) $user_id["user_fi"];
 
        if ($user_id && ($user_id !== $a_user_id || $user_id === ANONYMOUS_USER_ID)) {
            return false;
        }
        return true;
    }

loadFromDb()

ilObjSurvey::loadFromDb

(

)

Definition at line 981 of file class.ilObjSurvey.php.

                                : void
    {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT * FROM svy_svy WHERE obj_fi = %s",
            array('integer'),
            array($this->getId())
        );
        if ($result->numRows() === 1) {
            $data = $ilDB->fetchAssoc($result);
            $this->setSurveyId($data["survey_id"]);
            $this->setAuthor($data["author"] ?? "");
            $this->setIntroduction(ilRTE::_replaceMediaObjectImageSrc((string) $data["introduction"], 1));
            if ($data["outro"] === "survey_finished") {
                $this->setOutro($this->lng->txt("survey_finished"));
            } else {
                $this->setOutro(ilRTE::_replaceMediaObjectImageSrc((string) $data["outro"], 1));
            }
            $this->setShowQuestionTitles((bool) $data["show_question_titles"]);
            $this->setStartDate((string) ($data["startdate"] ?? ""));
            $this->setEndDate((string) ($data["enddate"] ?? ""));
            $this->setAnonymize((int) $data["anonymize"]);
            $this->setEvaluationAccess($data["evaluation_access"] ?? "");
            $this->loadQuestionsFromDb();
            $this->setMailNotification((bool) $data['mailnotification']);
            $this->setMailAddresses((string) $data['mailaddresses']);
            $this->setMailParticipantData((string) $data['mailparticipantdata']);
            $this->setPoolUsage((bool) $data['pool_usage']);
            // Mode
            $this->setMode($data['mode']);
            // 360°
            $this->set360SelfEvaluation((bool) $data['mode_360_self_eval']);
            $this->set360SelfRaters((bool) $data['mode_360_self_rate']);
            $this->set360SelfAppraisee((bool) $data['mode_360_self_appr']);
            $this->set360Results((int) $data['mode_360_results']);
            // Mode self evaluated
            $this->setSelfEvaluationResults((int) $data['mode_self_eval_results']);
            // Competences
            $this->setSkillService((bool) $data['mode_skill_service']);
            // reminder/notification
            $this->setReminderStatus((bool) $data["reminder_status"]);
            $this->setReminderStart($data["reminder_start"] ? new ilDate($data["reminder_start"], IL_CAL_DATE) : null);
            $this->setReminderEnd($data["reminder_end"] ? new ilDate($data["reminder_end"], IL_CAL_DATE) : null);
            $this->setReminderFrequency((int) $data["reminder_frequency"]);
            $this->setReminderTarget((int) $data["reminder_target"]);
            $this->setReminderLastSent((string) $data["reminder_last_sent"]);
            $this->setReminderTemplate((int) $data["reminder_tmpl"]);
            $this->setTutorNotificationStatus($data["tutor_ntf_status"]);
            $this->setTutorNotificationRecipients(explode(";", $data["tutor_ntf_reci"] ?? ""));
            $this->setTutorNotificationTarget($data["tutor_ntf_target"]);
            $this->setTutorResultsStatus((bool) $data["tutor_res_status"]);
            $this->setTutorResultsRecipients(explode(";", $data["tutor_res_reci"] ?? ""));
 
            $this->setMailOwnResults((bool) $data["own_results_mail"]);
            $this->setMailConfirmation((bool) $data["confirmation_mail"]);
            $this->setCalculateSumScore((bool) $data["calculate_sum_score"]);
 
            $this->setAnonymousUserList((bool) $data["anon_user_list"]);
        }
 
        // moved activation to ilObjectActivation
        if (isset($this->ref_id) && $this->ref_id !== 0) {
            $activation = ilObjectActivation::getItem($this->ref_id);
            switch ($activation["timing_type"]) {
                case ilObjectActivation::TIMINGS_ACTIVATION:
                    $this->setActivationLimited(true);
                    $this->setActivationStartDate($activation["timing_start"]);
                    $this->setActivationEndDate($activation["timing_end"]);
                    $this->setActivationVisibility($activation["visible"]);
                    break;
 
                default:
                    $this->setActivationLimited(false);
                    break;
            }
        }
    }

References $data, $ilDB, ilRTE\_replaceMediaObjectImageSrc(), ILIAS\Survey\Mode\getId(), ilObjectActivation\getItem(), IL_CAL_DATE, ILIAS\Repository\lng(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

loadQuestionsFromDb()

ilObjSurvey::loadQuestionsFromDb

(

)

Definition at line 1059 of file class.ilObjSurvey.php.

                                         : void
    {
        $ilDB = $this->db;
        $this->questions = array();
        $result = $ilDB->queryF(
            "SELECT * FROM svy_svy_qst WHERE survey_fi = %s ORDER BY sequence",
            array('integer'),
            array($this->getSurveyId())
        );
        while ($data = $ilDB->fetchAssoc($result)) {
            $this->questions[$data["sequence"]] = $data["question_fi"];
        }
    }

References $data, and $ilDB.

loadWorkingData()

ilObjSurvey::loadWorkingData	(	int	$question_id,
		int	$active_id
	)

Gets the given answer data of a question in a run.

Todo:

move to run(?) manager/repo

Definition at line 2293 of file class.ilObjSurvey.php.

     : array {
        $ilDB = $this->db;
        $result_array = array();
        $result = $ilDB->queryF(
            "SELECT * FROM svy_answer WHERE question_fi = %s AND active_fi = %s",
            array('integer','integer'),
            array($question_id, $active_id)
        );
        if ($result->numRows() >= 1) {
            while ($row = $ilDB->fetchAssoc($result)) {
                $result_array[] = $row;
            }
        }
        return $result_array;
    }

locateImportFiles()

ilObjSurvey::locateImportFiles

(

string

$a_dir

)

Locates the import directory and the xml file in a directory with an unzipped import file.

Returns

array An associative array containing "dir" (import directory) and "xml" (xml file)

Todo:

move to export sub-service

Definition at line 3115 of file class.ilObjSurvey.php.

     : ?array {
        if (!is_dir($a_dir) || is_int(strpos($a_dir, ".."))) {
            return null;
        }
        $importDirectory = "";
        $xmlFile = "";
 
        $current_dir = opendir($a_dir);
        $files = array();
        while ($entryname = readdir($current_dir)) {
            $files[] = $entryname;
        }
 
        foreach ($files as $file) {
            if (is_dir($a_dir . "/" . $file) and ($file !== "." and $file !== "..")) {
                // found directory created by zip
                $importDirectory = $a_dir . "/" . $file;
            }
        }
        closedir($current_dir);
        if ($importDirectory !== '') {
            // find the xml file
            $current_dir = opendir($importDirectory);
            $files = array();
            while ($entryname = readdir($current_dir)) {
                $files[] = $entryname;
            }
            foreach ($files as $file) {
                if (is_file($importDirectory . "/" . $file) &&
                    ($file !== "." && $file !== "..") &&
                    (preg_match("/^[0-9]{10}__[0-9]+__(svy_)*[0-9]+\.[A-Za-z]{1,3}$/", $file) ||
                        preg_match("/^[0-9]{10}__[0-9]+__(survey__)*[0-9]+\.[A-Za-z]{1,3}$/", $file))) {
                    // found xml file
                    $xmlFile = $importDirectory . "/" . $file;
                }
            }
        }
        return array("dir" => $importDirectory, "xml" => $xmlFile);
    }

modifyQuestionblock()

ilObjSurvey::modifyQuestionblock	(	int	$questionblock_id,
		string	$title,
		bool	$show_questiontext,
		bool	$show_blocktitle,
		bool	$compress_view = false
	)

Todo:

move to survey question manager/repo

Definition at line 1740 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        $ilDB->manipulateF(
            "UPDATE svy_qblk SET title = %s, show_questiontext = %s," .
            " show_blocktitle = %s, compress_view = %s WHERE questionblock_id = %s",
            array('text','text','text','integer', 'integer'),
            array($title, $show_questiontext, $show_blocktitle, $compress_view, $questionblock_id)
        );
    }

moveQuestions()

ilObjSurvey::moveQuestions	(	array	$move_questions,
		int	$target_index,
		int	$insert_mode
	)

Move questions and/or questionblocks to another position.

Parameters

array	$move_questions	An array with the question id's of the questions to move
int	$target_index	The question id of the target position
int	$insert_mode	0, if insert before the target position, 1 if insert after the target position

Todo:

move to survey question manager/repo

Definition at line 1368 of file class.ilObjSurvey.php.

     : void {
        $array_pos = array_search($target_index, $this->questions);
        $part1 = $part2 = [];
        if ($insert_mode === 0) {
            $part1 = array_slice($this->questions, 0, $array_pos);
            $part2 = array_slice($this->questions, $array_pos);
        } elseif ($insert_mode === 1) {
            $part1 = array_slice($this->questions, 0, $array_pos + 1);
            $part2 = array_slice($this->questions, $array_pos + 1);
        }
        $found = 0;
        foreach ($move_questions as $question_id) {
            if (!(!in_array($question_id, $part1))) {
                unset($part1[array_search($question_id, $part1)]);
                $found++;
            }
            if (!(!in_array($question_id, $part2))) {
                unset($part2[array_search($question_id, $part2)]);
                $found++;
            }
        }
        // sanity check: do not move questions if they have not be found in the array
        if ($found !== count($move_questions)) {
            return;
        }
        $part1 = array_values($part1);
        $part2 = array_values($part2);
        $this->questions = array_values(array_merge($part1, $move_questions, $part2));
        foreach ($move_questions as $question_id) {
            $constraints = $this->getConstraints($question_id);
            foreach ($constraints as $idx => $constraint) {
                foreach ($part2 as $next_question_id) {
                    if ($constraint["question"] == $next_question_id) {
                        // constraint concerning a question that follows -> delete constraint
                        $this->deleteConstraint($constraint["id"]);
                    }
                }
            }
        }
        $this->saveQuestionsToDb();
    }

openAllAppraisees()

ilObjSurvey::openAllAppraisees

(

)

Todo:

move to appraisal manager

Definition at line 4915 of file class.ilObjSurvey.php.

                                       : void
    {
        $ilDB = $this->db;
 
        $ilDB->manipulate("UPDATE svy_360_appr" .
            " SET has_closed = " . $ilDB->quote(null, "integer") .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer"));
    }

References $ilDB.

prepareTextareaOutput()

ilObjSurvey::prepareTextareaOutput

(

string

$txt_output

)

Prepares a string for a text area output in surveys.

Definition at line 3987 of file class.ilObjSurvey.php.

     : string {
        return ilLegacyFormElementsUtil::prepareTextareaOutput($txt_output);
    }

read()

ilObjSurvey::read

(

)

Reimplemented from ilObject.

Definition at line 250 of file class.ilObjSurvey.php.

                          : void
    {
        parent::read();
        $this->loadFromDb();
        $this->initServices();
    }

References initServices(), and loadFromDb().

Here is the call graph for this function:

removeConstraintsConcerningQuestion()

ilObjSurvey::removeConstraintsConcerningQuestion

(

int

$question_id

)

Remove constraints concerning a question with a given question_id.

Todo:

move to constraint manager/repo

Definition at line 1432 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT constraint_fi FROM svy_qst_constraint WHERE question_fi = %s AND survey_fi = %s",
            array('integer','integer'),
            array($question_id, $this->getSurveyId())
        );
        if ($result->numRows() > 0) {
            $remove_constraints = array();
            while ($row = $ilDB->fetchAssoc($result)) {
                $remove_constraints[] = $row["constraint_fi"];
            }
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_qst_constraint WHERE question_fi = %s AND survey_fi = %s",
                array('integer','integer'),
                array($question_id, $this->getSurveyId())
            );
            foreach ($remove_constraints as $key => $constraint_id) {
                $affectedRows = $ilDB->manipulateF(
                    "DELETE FROM svy_constraint WHERE constraint_id = %s",
                    array('integer'),
                    array($constraint_id)
                );
            }
        }
    }

References $ilDB.

removeQuestion()

ilObjSurvey::removeQuestion

(

int

$question_id

)

Todo:

move to survey question manager/repo

Definition at line 1417 of file class.ilObjSurvey.php.

     : void {
        $question = self::_instanciateQuestion($question_id);
        #20610 if no question found, do nothing.
        if ($question) {
            $question->delete($question_id);
            $this->removeConstraintsConcerningQuestion($question_id);
        }
    }

Referenced by delete().

Here is the caller graph for this function:

removeQuestionFromBlock()

ilObjSurvey::removeQuestionFromBlock	(	int	$question_id,
		int	$questionblock_id
	)

Todo:

move to survey question manager/repo

Definition at line 1531 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $ilDB->manipulateF(
            "DELETE FROM svy_qblk_qst WHERE questionblock_fi = %s AND survey_fi = %s AND question_fi = %s",
            array('integer','integer','integer'),
            array($questionblock_id, $this->getSurveyId(), $question_id)
        );
    }

removeQuestions()

ilObjSurvey::removeQuestions	(	array	$remove_questions,
		array	$remove_questionblocks
	)

Parameters

int[]	$remove_questions	question ids of the questions to remove
int[]	$remove_questionblocks	questionblock ids of the questions blocks to remove

Todo:

move to survey question manager/repo

Definition at line 1466 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $block_sizes = array();
        foreach ($this->getSurveyQuestions() as $question_id => $data) {
            if (in_array($question_id, $remove_questions) or in_array($data["questionblock_id"], $remove_questionblocks)) {
                unset($this->questions[array_search($question_id, $this->questions)]);
                $this->removeQuestion($question_id);
            } elseif ($data["questionblock_id"]) {
                $block_sizes[$data["questionblock_id"]] = ($block_sizes[$data["questionblock_id"]] ?? 0) + 1;
            }
        }
 
        // blocks with just 1 question need to be deleted
        foreach ($block_sizes as $block_id => $size) {
            if ($size < 2) {
                $remove_questionblocks[] = $block_id;
            }
        }
 
        foreach (array_unique($remove_questionblocks) as $questionblock_id) {
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_qblk WHERE questionblock_id = %s",
                array('integer'),
                array($questionblock_id)
            );
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_qblk_qst WHERE questionblock_fi = %s AND survey_fi = %s",
                array('integer','integer'),
                array($questionblock_id, $this->getSurveyId())
            );
        }
 
        $this->questions = array_values($this->questions);
        $this->saveQuestionsToDb();
    }

removeSelectedSurveyResults()

ilObjSurvey::removeSelectedSurveyResults

(

array

$finished_ids

)

Deletes the user data of a given array of survey participants.

Todo:

move to run manager/repo

Definition at line 400 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $user_ids = [];
 
        foreach ($finished_ids as $finished_id) {
            $result = $ilDB->queryF(
                "SELECT finished_id, user_fi FROM svy_finished WHERE finished_id = %s",
                array('integer'),
                array($finished_id)
            );
            $row = $ilDB->fetchAssoc($result);
            if ($row["user_fi"]) {
                $user_ids[] = (int) $row["user_fi"];
            }
 
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_answer WHERE active_fi = %s",
                array('integer'),
                array($row["finished_id"])
            );
 
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_finished WHERE finished_id = %s",
                array('integer'),
                array($finished_id)
            );
 
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_times WHERE finished_fi = %s",
                array('integer'),
                array($row["finished_id"])
            );
        }
 
        if (count($user_ids)) {
            $lp_obj = ilObjectLP::getInstance($this->getId());
            $lp_obj->resetLPDataForUserIds($user_ids);
 
            // remove invitations, if exist
            foreach ($user_ids as $user_id) {
                $this->invitation_manager->remove($this->getSurveyId(), $user_id);
            }
        }
    }

References $ilDB, and ILIAS\Repository\int().

Here is the call graph for this function:

saveAuthorToMetadata()

ilObjSurvey::saveAuthorToMetadata

(

string

$a_author = ""

)

Saves an authors name into the lifecycle metadata if no lifecycle metadata exists This will only be called for conversion of "old" surveys where the author hasn't been stored in the lifecycle metadata.

Definition at line 1136 of file class.ilObjSurvey.php.

     : void {
        if ($a_author === '') {
            $ilUser = $this->user;
            $a_author = $ilUser->getFullname();
        }
        $this->domain->metadata()->saveAuthorsInLOMIfNoLifecycleSet(
            $this->getId(),
            0,
            $this->getType(),
            $a_author,
        );
    }

Referenced by doCreateMetaData().

Here is the caller graph for this function:

saveCompletionStatus()

ilObjSurvey::saveCompletionStatus

(

)

Saves the completion status of the survey.

Todo:

move to survey manager/repo

Definition at line 514 of file class.ilObjSurvey.php.

                                          : void
    {
        $db = $this->db;
        if ($this->getSurveyId() > 0) {
            $db->manipulateF(
                "UPDATE svy_svy SET complete = %s, tstamp = %s WHERE survey_id = %s",
                array('text','integer','integer'),
                array($this->isComplete(), time(), $this->getSurveyId())
            );
        }
    }

saveHeading()

ilObjSurvey::saveHeading	(	string	$heading,
		int	$insertbefore
	)

Todo:

move to survey question manager

Parameters

string	$heading
int	$insertbefore	question id which gets the heading (before)

Definition at line 3530 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        if ($heading) {
            $ilDB->manipulateF(
                "UPDATE svy_svy_qst SET heading=%s WHERE survey_fi=%s AND question_fi=%s",
                array('text','integer','integer'),
                array($heading, $this->getSurveyId(), $insertbefore)
            );
        } else {
            $ilDB->manipulateF(
                "UPDATE svy_svy_qst SET heading=%s WHERE survey_fi=%s AND question_fi=%s",
                array('text','integer','integer'),
                array(null, $this->getSurveyId(), $insertbefore)
            );
        }
    }

References $ilDB.

saveQuestionsToDb()

ilObjSurvey::saveQuestionsToDb

(

)

Definition at line 831 of file class.ilObjSurvey.php.

                                       : void
    {
        $ilDB = $this->db;
 
        $this->svy_log->debug("save questions");
 
        // gather old questions state
        $old_questions = array();
        $result = $ilDB->queryF(
            "SELECT survey_question_id,question_fi,sequence" .
            " FROM svy_svy_qst WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            $old_questions[$row["question_fi"]] = $row;         // problem, as soon as duplicates exist, they will be hidden here
        }
 
        // #15231 - diff with current questions state
        $insert = $update = $delete = array();
        foreach ($this->questions as $seq => $fi) {
            if (!array_key_exists($fi, $old_questions)) {               // really new fi IDs
                $insert[] = $fi;                                                        // this should be ok, should not create duplicates here
            } elseif ($old_questions[$fi]["sequence"] != $seq) {                                // we are updating one of the duplicates (if any)
                $update[$fi] = $old_questions[$fi]["survey_question_id"];
            }
            // keep track of still relevant questions
            unset($old_questions[$fi]);                                         // deleting old question, if they are not in current array
        }
 
        // delete obsolete question relations
        if (count($old_questions)) {
            $del_ids = array();
            foreach ($old_questions as $fi => $old) {
                $del_ids[] = $old["survey_question_id"];
            }
            $ilDB->manipulate($q = "DELETE FROM svy_svy_qst" .
                " WHERE " . $ilDB->in("survey_question_id", $del_ids, "", "integer"));
            $this->svy_log->debug("delete: " . $q);
        }
        unset($old_questions);
 
        // create/update question relations
        foreach ($this->questions as $seq => $fi) {
            if (in_array($fi, $insert)) {
                // check if question is not already in the survey, see #22018
                if (!$this->isQuestionInSurvey($fi)) {
                    $next_id = $ilDB->nextId('svy_svy_qst');
                    $ilDB->manipulateF(
                        "INSERT INTO svy_svy_qst" .
                        " (survey_question_id, survey_fi, question_fi, heading, sequence, tstamp)" .
                        " VALUES (%s, %s, %s, %s, %s, %s)",
                        array('integer', 'integer', 'integer', 'text', 'integer', 'integer'),
                        array($next_id, $this->getSurveyId(), $fi, null, $seq, time())
                    );
                    $this->svy_log->debug("insert svy_svy_qst, id:" . $next_id . ", fi: " . $fi . ", seq:" . $seq);
                }
            } elseif (array_key_exists($fi, $update)) {
                $ilDB->manipulate("UPDATE svy_svy_qst" .
                    " SET sequence = " . $ilDB->quote($seq, "integer") .
                    ", tstamp = " . $ilDB->quote(time(), "integer") .
                    " WHERE survey_question_id = " . $ilDB->quote($update[$fi], "integer"));
                $this->svy_log->debug("update svy_svy_qst, id:" . $update[$fi] . ", fi: " . $fi . ", seq:" . $seq);
            }
        }
    }

References $ilDB, and $q.

saveToDb()

ilObjSurvey::saveToDb

(

)

Definition at line 696 of file class.ilObjSurvey.php.

                              : void
    {
        $ilDB = $this->db;
 
        // date handling
        $rmd_start = $this->getReminderStart();
        if (is_object($rmd_start)) {
            $rmd_start = $rmd_start->get(IL_CAL_DATE);
        }
        $rmd_end = $this->getReminderEnd();
        if (is_object($rmd_end)) {
            $rmd_end = $rmd_end->get(IL_CAL_DATE);
        }
        if ($this->getSurveyId() < 1) {
            $next_id = $ilDB->nextId('svy_svy');
            $affectedRows = $ilDB->insert("svy_svy", array(
                "survey_id" => array("integer", $next_id),
                "obj_fi" => array("integer", $this->getId()),
                "author" => array("text", $this->getAuthor()),
                "introduction" => array("clob", ilRTE::_replaceMediaObjectImageSrc($this->getIntroduction(), 0)),
                "outro" => array("clob", ilRTE::_replaceMediaObjectImageSrc($this->getOutro(), 0)),
                "startdate" => array("text", $this->getStartDate()),
                "enddate" => array("text", $this->getEndDate()),
                "evaluation_access" => array("text", $this->getEvaluationAccess()),
                "complete" => array("text", $this->isComplete()),
                "created" => array("integer", time()),
                "anonymize" => array("text", $this->getAnonymize()),
                "show_question_titles" => array("text", $this->getShowQuestionTitles()),
                "mailnotification" => array('integer', ($this->getMailNotification()) ? 1 : 0),
                "mailaddresses" => array('text', $this->getMailAddresses()),
                "mailparticipantdata" => array('text', $this->getMailParticipantData()),
                "tstamp" => array("integer", time()),
                // Mode type
                "mode" => array("integer", $this->getMode()),
                // 360°
                "mode_360_self_eval" => array("integer", $this->get360SelfEvaluation()),
                "mode_360_self_rate" => array("integer", $this->get360SelfRaters()),
                "mode_360_self_appr" => array("integer", $this->get360SelfAppraisee()),
                "mode_360_results" => array("integer", $this->get360Results()),
                // competences
                "mode_skill_service" => array("integer", (int) $this->getSkillService()),
                // Self Evaluation Only
                "mode_self_eval_results" => array("integer", self::RESULTS_SELF_EVAL_OWN),
                // reminder/notification
                "reminder_status" => array("integer", (int) $this->getReminderStatus()),
                "reminder_start" => array("datetime", $rmd_start),
                "reminder_end" => array("datetime", $rmd_end),
                "reminder_frequency" => array("integer", $this->getReminderFrequency()),
                "reminder_target" => array("integer", $this->getReminderTarget()),
                "reminder_last_sent" => array("datetime", $this->getReminderLastSent()),
                "reminder_tmpl" => array("text", $this->getReminderTemplate(true)),
                "tutor_ntf_status" => array("integer", (int) $this->getTutorNotificationStatus()),
                "tutor_ntf_reci" => array("text", implode(";", $this->getTutorNotificationRecipients())),
                "tutor_ntf_target" => array("integer", $this->getTutorNotificationTarget()),
                "own_results_view" => array("integer", $this->hasViewOwnResults()),
                "own_results_mail" => array("integer", $this->hasMailOwnResults()),
                "tutor_res_status" => array("integer", (int) $this->getTutorResultsStatus()),
                "tutor_res_reci" => array("text", implode(";", $this->getTutorResultsRecipients())),
                "confirmation_mail" => array("integer", $this->hasMailConfirmation()),
                "anon_user_list" => array("integer", $this->hasAnonymousUserList()),
                "calculate_sum_score" => array("integer", $this->getCalculateSumScore())
            ));
            $this->setSurveyId($next_id);
        } else {
            $affectedRows = $ilDB->update("svy_svy", array(
                "author" => array("text", $this->getAuthor()),
                "introduction" => array("clob", ilRTE::_replaceMediaObjectImageSrc($this->getIntroduction(), 0)),
                "outro" => array("clob", ilRTE::_replaceMediaObjectImageSrc($this->getOutro(), 0)),
                "startdate" => array("text", $this->getStartDate()),
                "enddate" => array("text", $this->getEndDate()),
                "evaluation_access" => array("text", $this->getEvaluationAccess()),
                "complete" => array("text", $this->isComplete()),
                "anonymize" => array("text", $this->getAnonymize()),
                "show_question_titles" => array("text", $this->getShowQuestionTitles()),
                "mailnotification" => array('integer', ($this->getMailNotification()) ? 1 : 0),
                "mailaddresses" => array('text', $this->getMailAddresses()),
                "mailparticipantdata" => array('text', $this->getMailParticipantData()),
                "tstamp" => array("integer", time()),
                //MODE TYPE
                "mode" => array("integer", $this->getMode()),
                // 360°
                "mode_360_self_eval" => array("integer", $this->get360SelfEvaluation()),
                "mode_360_self_rate" => array("integer", $this->get360SelfRaters()),
                "mode_360_self_appr" => array("integer", $this->get360SelfAppraisee()),
                "mode_360_results" => array("integer", $this->get360Results()),
                // Competences
                "mode_skill_service" => array("integer", (int) $this->getSkillService()),
                // Self Evaluation Only
                "mode_self_eval_results" => array("integer", $this->getSelfEvaluationResults()),
                // reminder/notification
                "reminder_status" => array("integer", $this->getReminderStatus()),
                "reminder_start" => array("datetime", $rmd_start),
                "reminder_end" => array("datetime", $rmd_end),
                "reminder_frequency" => array("integer", $this->getReminderFrequency()),
                "reminder_target" => array("integer", $this->getReminderTarget()),
                "reminder_last_sent" => array("datetime", $this->getReminderLastSent()),
                "reminder_tmpl" => array("text", $this->getReminderTemplate()),
                "tutor_ntf_status" => array("integer", $this->getTutorNotificationStatus()),
                "tutor_ntf_reci" => array("text", implode(";", $this->getTutorNotificationRecipients())),
                "tutor_ntf_target" => array("integer", $this->getTutorNotificationTarget()),
                "own_results_view" => array("integer", $this->hasViewOwnResults()),
                "own_results_mail" => array("integer", $this->hasMailOwnResults()),
                "tutor_res_status" => array("integer", (int) $this->getTutorResultsStatus()),
                "tutor_res_reci" => array("text", implode(";", $this->getTutorResultsRecipients())),
                "confirmation_mail" => array("integer", $this->hasMailConfirmation()),
                "anon_user_list" => array("integer", $this->hasAnonymousUserList()),
                "calculate_sum_score" => array("integer", $this->getCalculateSumScore())
            ), array(
            "survey_id" => array("integer", $this->getSurveyId())
            ));
        }
        if ($affectedRows) {
            // save questions to db
            $this->saveQuestionsToDb();
        }
 
        // moved activation to ilObjectActivation
        if ($this->ref_id) {
            ilObjectActivation::getItem($this->ref_id);
 
            $item = new ilObjectActivation();
            if (!$this->isActivationLimited()) {
                $item->setTimingType(ilObjectActivation::TIMINGS_DEACTIVATED);
            } else {
                $item->setTimingType(ilObjectActivation::TIMINGS_ACTIVATION);
                $item->setTimingStart($this->getActivationStartDate());
                $item->setTimingEnd($this->getActivationEndDate());
                $item->toggleVisible($this->getActivationVisibility());
            }
 
            $item->update($this->ref_id);
        }
    }

References $ilDB, ilRTE\_replaceMediaObjectImageSrc(), ILIAS\Survey\Mode\getId(), ilObjectActivation\getItem(), IL_CAL_DATE, ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

Referenced by createReference().

Here is the call graph for this function:

Here is the caller graph for this function:

saveUserAccessCode()

ilObjSurvey::saveUserAccessCode	(	int	$user_id,
		string	$access_code
	)

Saves a survey access code for a registered user to the database.

Parameters

int	$user_id	The database id of the user
string	$access_code	The survey access code

Todo:

move to code manager

Definition at line 3936 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        // not really sure what to do about ANONYMOUS_USER_ID
 
        $next_id = $ilDB->nextId('svy_anonymous');
        $affectedRows = $ilDB->manipulateF(
            "INSERT INTO svy_anonymous (anonymous_id, survey_key, survey_fi, user_key, tstamp) " .
            "VALUES (%s, %s, %s, %s, %s)",
            array('integer','text', 'integer', 'text', 'integer'),
            array($next_id, $access_code, $this->getSurveyId(), md5($user_id), time())
        );
    }

saveUserSettings()

ilObjSurvey::saveUserSettings	(	int	$usr_id,
		string	$key,
		string	$title,
		string	$value
	)

Definition at line 645 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $next_id = $ilDB->nextId('svy_settings');
        $affectedRows = $ilDB->insert("svy_settings", array(
            "settings_id" => array("integer", $next_id),
            "usr_id" => array("integer", $usr_id),
            "keyword" => array("text", $key),
            "title" => array("text", $title),
            "value" => array("clob", $value)
        ));
    }

send360ReminderToUser()

ilObjSurvey::send360ReminderToUser	(	int	$a_user_id,
		array	$a_appraisee_ids
	)

Definition at line 5219 of file class.ilObjSurvey.php.

     : void {
        $this->svy_log->debug("Send mail to:" . $a_user_id);
 
        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("svy", "survey"));
        $ntf->setRefId($this->getRefId());
        $ntf->setGotoLangId('url');
 
        // user specific language
        $lng = $ntf->getUserLanguage($a_user_id);
 
        $ntf->setIntroductionLangId("svy_user_added_rater_reminder_mail");
        $subject = str_replace("%1", $this->getTitle(), $lng->txt("svy_user_added_rater"));
 
        foreach ($a_appraisee_ids as $appraisee_id) {
            $ntf->addAdditionalInfo("survey_360_appraisee", ilUserUtil::getNamePresentation($appraisee_id, false, false, "", true));
        }
 
        // #10044
        $mail = new ilMail(ANONYMOUS_USER_ID);
        $mail->enqueue(
            ilObjUser::_lookupLogin($a_user_id),
            "",
            "",
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

sendAppraiseeCloseNotification()

ilObjSurvey::sendAppraiseeCloseNotification

(

int

$a_user_id

)

Todo:

move to appraisal manager

Definition at line 4332 of file class.ilObjSurvey.php.

     : void {
        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("svy", "survey"));
        $ntf->setRefId($this->getRefId());
        $ntf->setGotoLangId('url');
 
        // user specific language
        $lng = $ntf->getUserLanguage($a_user_id);
 
        $ntf->setIntroductionLangId("svy_user_added_appraisee_close_mail");
        $subject = str_replace("%1", $this->getTitle(), $lng->txt("svy_user_added_appraisee"));
 
        // #10044
        $mail = new ilMail(ANONYMOUS_USER_ID);
        $mail->enqueue(
            ilObjUser::_lookupLogin($a_user_id),
            "",
            "",
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

sendAppraiseeNotification()

ilObjSurvey::sendAppraiseeNotification

(

int

$a_user_id

)

Todo:

move to appraisal manager

Definition at line 4303 of file class.ilObjSurvey.php.

     : void {
        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("svy", "survey"));
        $ntf->setRefId($this->getRefId());
        $ntf->setGotoLangId('url');
 
        // user specific language
        $lng = $ntf->getUserLanguage($a_user_id);
 
        $ntf->setIntroductionLangId("svy_user_added_appraisee_mail");
        $subject = str_replace("%1", $this->getTitle(), $lng->txt("svy_user_added_appraisee"));
 
        // #10044
        $mail = new ilMail(ANONYMOUS_USER_ID);
        $mail->enqueue(
            ilObjUser::_lookupLogin($a_user_id),
            "",
            "",
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

sendCodes()

ilObjSurvey::sendCodes	(	int	$not_sent,
		string	$subject,
		string	$message,
		string	$lang
	)

Todo:

move to code manager

Definition at line 3761 of file class.ilObjSurvey.php.

     : void {
        /*
         * 0 = all
         * 1 = not sent
         * 2 = finished
         * 3 = not finished
         */
        $check_finished = ($not_sent > 1);
 
 
        $mail = new ilMail(ANONYMOUS_USER_ID);
        $recipients = $this->getExternalCodeRecipients($check_finished);
        foreach ($recipients as $data) {
            if ($data['email'] && $data['code']) {
                $do_send = false;
                switch ($not_sent) {
                    case 1:
                        $do_send = !(bool) $data['sent'];
                        break;
 
                    case 2:
                        $do_send = $data['finished'];
                        break;
 
                    case 3:
                        $do_send = !$data['finished'];
                        break;
 
                    default:
                        $do_send = true;
                        break;
                }
                if ($do_send) {
                    // build text
                    $messagetext = $message;
                    $url = ilLink::_getLink(
                        $this->getRefId(),
                        "svy",
                        array(
                            "accesscode" => $data["code"],
                            "lang" => $lang
                        )
                    );
                    $messagetext = str_replace('[url]', $url, $messagetext);
                    foreach ($data as $key => $value) {
                        $messagetext = str_replace('[' . $key . ']', $value, $messagetext);
                    }
 
                    // send mail
                    $mail->enqueue(
                        $data['email'], // to
                        "", // cc
                        "", // bcc
                        $subject, // subject
                        $messagetext, // message
                        array() // attachments
                    );
                }
            }
        }
 
        $ilDB = $this->db;
        $ilDB->manipulateF(
            "UPDATE svy_anonymous SET sent = %s WHERE survey_fi = %s AND externaldata IS NOT NULL",
            array('integer','integer'),
            array(1, $this->getSurveyId())
        );
    }

sendNotificationMail()

ilObjSurvey::sendNotificationMail	(	int	$a_user_id,
		string	$a_anonymize_id,
		int	$a_appr_id = 0
	)

These mails are sent to tutors for each single participant that finishes a survey.

It includes the "additional participant data" text that can be set in the settings screen.

Exceptions

ilWACException

Definition at line 2390 of file class.ilObjSurvey.php.

     : void {
        // #12755
        $placeholders = array(
            "FIRST_NAME" => "firstname",
            "LAST_NAME" => "lastname",
            "LOGIN" => "login",
            // old style
            "firstname" => "firstname"
        );
 
        //mailaddresses is just text split by commas.
        //sendMail can send emails if it gets an user id or an email as first parameter.
        $recipients = explode(",", $this->mailaddresses ?? "");
        foreach ($recipients as $recipient) {
            // #11298
            $ntf = new ilSystemNotification();
            $ntf->setLangModules(array("survey"));
            $ntf->setRefId($this->getRefId());
            $ntf->setSubjectLangId('finished_mail_subject');
 
            $messagetext = $this->mailparticipantdata;
            $data = [];
            if (trim($messagetext ?? "")) {
                if (!$this->hasAnonymizedResults()) {
                    $data = ilObjUser::_getUserData(array($a_user_id));
                    $data = $data[0];
                }
                foreach ($placeholders as $key => $mapping) {
                    if ($this->hasAnonymizedResults()) { // #16480
                        $messagetext = str_replace('[' . $key . ']', '', $messagetext);
                    } else {
                        $messagetext = str_replace('[' . $key . ']', trim($data[$mapping] ?? ""), $messagetext);
                    }
                }
                $ntf->setIntroductionDirect($messagetext);
            } else {
                $ntf->setIntroductionLangId('survey_notification_finished_introduction');
            }
 
            // 360°? add appraisee data
            if ($a_appr_id) {
                $ntf->addAdditionalInfo(
                    'survey_360_appraisee',
                    ilUserUtil::getNamePresentation($a_appr_id)
                );
            }
 
            $active_id = $this->getActiveID($a_user_id, $a_anonymize_id, $a_appr_id);
            if ($active_id) {   // 43908
                $ntf->addAdditionalInfo(
                    'results',
                    $this->getParticipantTextResults($active_id),
                    true
                );
            }
 
            $ntf->setGotoLangId('survey_notification_tutor_link');
            $ntf->setReasonLangId('survey_notification_finished_reason');
 
            $recipient = trim($recipient ?? "");
            $user_id = (int) ilObjUser::_lookupId($recipient);
            if ($user_id > 0) {
                $ntf->sendMailAndReturnRecipients([$user_id]);
            } else {
                $user_ids = ilObjUser::getUserIdsByEmail($recipient);
                if (count($user_ids) > 0) {
                    $ntf->sendMailAndReturnRecipients([current($user_ids)]);
                }
            }
            /*  note: this block is replace by the single line above
                since the UI asks for account names and the "e-mail" fallback leads
                to strange issues like multiple mails. Also the test case has been
                adopted, see https://mantis.ilias.de/view.php?id=36327
            if (is_numeric($recipient)) {
                $lng = $ntf->getUserLanguage((int) $recipient);
                $ntf->sendMailAndReturnRecipients([(int) $recipient]);
            } else {
                $recipient = trim($recipient);
                $user_ids = ilObjUser::getUserIdsByEmail($recipient);
                if (empty($user_ids)) {
                    $ntf->sendMailAndReturnRecipients([ilObjUser::_lookupId($recipient)]);
                } else {
                    foreach ($user_ids as $user_id) {
                        $lng = $ntf->getUserLanguage($user_id);
                        $ntf->sendMailAndReturnRecipients(array($user_id));
                    }
                }
            }*/
        }
    }

sendRaterNotification()

ilObjSurvey::sendRaterNotification	(	int	$a_user_id,
		int	$a_appraisee_id
	)

Todo:

move to appraisal manager

Definition at line 4361 of file class.ilObjSurvey.php.

     : void {
        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("svy", "survey"));
        $ntf->setRefId($this->getRefId());
        $ntf->setGotoLangId('url');
 
        // user specific language
        $lng = $ntf->getUserLanguage($a_user_id);
 
        $ntf->setIntroductionLangId("svy_user_added_rater_mail");
        $subject = str_replace("%1", $this->getTitle(), $lng->txt("svy_user_added_rater"));
        $ntf->addAdditionalInfo("survey_360_appraisee", ilUserUtil::getNamePresentation($a_appraisee_id, false, false, "", true));
 
        // #10044
        $mail = new ilMail(ANONYMOUS_USER_ID);
        $mail->enqueue(
            ilObjUser::_lookupLogin($a_user_id),
            "",
            "",
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

sendTutorNotification()

ilObjSurvey::sendTutorNotification ( )

protected

Send mail to tutors after all participants have finished the survey.

Definition at line 5286 of file class.ilObjSurvey.php.

                                              : void
    {
        $link = ilLink::_getStaticLink($this->getRefId(), "svy");
 
        // get tutors being set in the setting
        foreach ($this->getTutorNotificationRecipients() as $user_id) {
            // use language of recipient to compose message
            $ulng = ilLanguageFactory::_getLanguageOfUser($user_id);
            $ulng->loadLanguageModule('survey');
 
            $subject = sprintf($ulng->txt('survey_notification_tutor_subject'), $this->getTitle());
            $message = sprintf($ulng->txt('survey_notification_tutor_salutation'), ilObjUser::_lookupFullname($user_id)) . "\n\n";
 
            $message .= $ulng->txt('survey_notification_tutor_body') . ":\n\n";
            $message .= $ulng->txt('obj_svy') . ": " . $this->getTitle() . "\n";
            $message .= "\n" . $ulng->txt('survey_notification_tutor_link') . ": " . $link;
 
            $mail_obj = new ilMail(ANONYMOUS_USER_ID);
            $mail_obj->appendInstallationSignature(true);
            $mail_obj->enqueue(
                ilObjUser::_lookupLogin($user_id),
                "",
                "",
                $subject,
                $message,
                array()
            );
        }
    }

References $message, $user_id, ilLanguageFactory\_getLanguageOfUser(), ilLink\_getStaticLink(), ilObjUser\_lookupFullname(), ilObjUser\_lookupLogin(), ANONYMOUS_USER_ID, and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

sent360Reminders()

ilObjSurvey::sent360Reminders

(

)

Send 360 reminders.

Definition at line 5150 of file class.ilObjSurvey.php.

                                      : void
    {
        global $DIC;
 
        $access = $DIC->access();
        // collect all open ratings
        $rater_ids = array();
        foreach ($this->getAppraiseesData() as $app) {
            $this->svy_log->debug("Handle appraisee " . $app['user_id']);
 
            if (!$this->isAppraiseeClosed($app['user_id'])) {
                $this->svy_log->debug("Check self evaluation, self: " . $this->get360SelfAppraisee() . ", target: " . $this->getReminderTarget());
 
                // self evaluation?
                if ($this->get360SelfEvaluation() &&
                    in_array($this->getReminderTarget(), array(self::NOTIFICATION_APPRAISEES, self::NOTIFICATION_APPRAISEES_AND_RATERS))) {
                    $this->svy_log->debug("...1");
                    // did user already finished self evaluation?
                    if (!$this->is360SurveyStarted((int) $app['user_id'], (int) $app['user_id'])) {
                        $this->svy_log->debug("...2");
                        if (!isset($rater_ids[$app['user_id']])) {
                            $rater_ids[$app['user_id']] = array();
                        }
                        if (!isset($app["user_id"], $rater_ids[$app['user_id']])) {
                            $rater_ids[$app['user_id']][] = $app["user_id"];
                        }
                    }
                }
 
                $this->svy_log->debug("Check raters.");
 
                // should raters be notified?
                if (
                    in_array(
                        $this->getReminderTarget(),
                        array(self::NOTIFICATION_RATERS, self::NOTIFICATION_APPRAISEES_AND_RATERS),
                        true
                    )
                ) {
                    foreach ($this->getRatersData($app['user_id']) as $rater) {
                        $rater_id = 0;
                        if ($rater["login"] !== "") {
                            $rater_id = ilObjUser::_lookupId($rater["login"]);
                        }
                        if ($rater_id > 0) {
                            // is rater not anonymous and did not rate yet?
                            if (!($rater["anonymous_id"] ?? false) && !($rater["finished"] ?? false)) {
                                if (!isset($rater_ids[$rater_id])) {
                                    $rater_ids[$rater_id] = array();
                                }
                                if (!in_array($app["user_id"], $rater_ids[$rater_id])) {
                                    $rater_ids[$rater_id][] = $app["user_id"];
                                }
                            }
                        }
                    }
                }
            }
        }
 
        $this->svy_log->debug("Found raters:" . count($rater_ids));
 
        foreach ($rater_ids as $id => $app) {
            if ($access->checkAccessOfUser((int) $id, "read", "", $this->getRefId())) {
                $this->send360ReminderToUser((int) $id, $app);
            }
        }
    }

References $DIC, $id, ilObjUser\_lookupId(), and ilRBACAccessHandler\checkAccessOfUser().

Here is the call graph for this function:

sentReminderPlaceholders()

ilObjSurvey::sentReminderPlaceholders ( string  $a_message, int  $a_user_id, array  $a_context_params  )

protected

Definition at line 5566 of file class.ilObjSurvey.php.

     : string {
        // see ilMail::replacePlaceholders()
        try {
            $context = \ilMailTemplateContextService::getTemplateContextById(ilSurveyMailTemplateReminderContext::ID);
 
            $user = new \ilObjUser($a_user_id);
 
            $a_message = $this->placeholder_resolver->resolve($context, $a_message, $user, $a_context_params);
        } catch (\Exception $e) {
            ilLoggerFactory::getLogger('mail')->error(__METHOD__ . ' has been called with invalid context.');
        }
 
        return $a_message;
    }

set360RaterSent()

ilObjSurvey::set360RaterSent	(	int	$a_appraisee_id,
		int	$a_user_id,
		int	$a_anonymous_id,
		?int	$a_tstamp = null
	)

Todo:

move to appraisal manager

Definition at line 4862 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        if (!$a_tstamp) {
            $a_tstamp = time();
        }
 
        $ilDB->manipulate("UPDATE svy_360_rater" .
            " SET mail_sent = " . $ilDB->quote($a_tstamp, "integer") .
            " WHERE obj_id = " . $ilDB->quote($this->getSurveyId(), "integer") .
            " AND appr_id = " . $ilDB->quote($a_appraisee_id, "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND anonymous_id = " . $ilDB->quote($a_anonymous_id, "integer"));
    }

set360Results()

ilObjSurvey::set360Results

(

int

$a_value

)

Definition at line 4264 of file class.ilObjSurvey.php.

                                               : void
    {
        $this->mode_360_results = $a_value;
    }

set360SelfAppraisee()

ilObjSurvey::set360SelfAppraisee

(

bool

$a_value

)

Definition at line 4244 of file class.ilObjSurvey.php.

                                                      : void
    {
        $this->mode_360_self_appr = $a_value;
    }

set360SelfEvaluation()

ilObjSurvey::set360SelfEvaluation

(

bool

$a_value

)

Definition at line 4234 of file class.ilObjSurvey.php.

                                                       : void
    {
        $this->mode_360_self_eval = $a_value;
    }

set360SelfRaters()

ilObjSurvey::set360SelfRaters

(

bool

$a_value

)

Definition at line 4254 of file class.ilObjSurvey.php.

                                                   : void
    {
        $this->mode_360_self_rate = $a_value;
    }

setActivationEndDate()

ilObjSurvey::setActivationEndDate

(

?int

$ending_time = null

)

Definition at line 5476 of file class.ilObjSurvey.php.

     : void {
        $this->activation_ending_time = $ending_time;
    }

setActivationLimited()

ilObjSurvey::setActivationLimited

(

bool

$a_value

)

Definition at line 1313 of file class.ilObjSurvey.php.

                                                       : void
    {
        $this->activation_limited = $a_value;
    }

setActivationStartDate()

ilObjSurvey::setActivationStartDate

(

?int

$starting_time = null

)

Definition at line 5470 of file class.ilObjSurvey.php.

     : void {
        $this->activation_starting_time = $starting_time;
    }

setActivationVisibility()

ilObjSurvey::setActivationVisibility

(

bool

$a_value

)

Definition at line 1297 of file class.ilObjSurvey.php.

     : void {
        $this->activation_visibility = $a_value;
    }

setAnonymize()

ilObjSurvey::setAnonymize

(

int

$a_anonymize

)

set anonymize status

Definition at line 936 of file class.ilObjSurvey.php.

                                                  : void
    {
        switch ($a_anonymize) {
            case self::ANONYMIZE_OFF:
            case self::ANONYMIZE_ON:
            case self::ANONYMIZE_FREEACCESS:
            case self::ANONYMIZE_CODE_ALL:
                $this->anonymize = $a_anonymize;
                break;
            default:
                $this->anonymize = self::ANONYMIZE_OFF;
                break;
        }
    }

setAnonymousUserList()

ilObjSurvey::setAnonymousUserList

(

bool

$a_value

)

Definition at line 5522 of file class.ilObjSurvey.php.

                                                       : void
    {
        $this->anon_user_list = $a_value;
    }

setAuthor()

ilObjSurvey::setAuthor

(

string

$author = ""

)

Definition at line 1125 of file class.ilObjSurvey.php.

     : void {
        $this->author = $author;
    }

setCalculateSumScore()

ilObjSurvey::setCalculateSumScore

(

bool

$a_val

)

Definition at line 956 of file class.ilObjSurvey.php.

     : void {
        $this->calculate_sum_score = $a_val;
    }

setEndDate()

ilObjSurvey::setEndDate

(

string

$end_date = ""

)

Parameters

string

$end_date

(YYYYMMDDHHMMSS)

Definition at line 1232 of file class.ilObjSurvey.php.

     : void {
        $this->end_date = $end_date;
    }

setEndDateAndTime()

ilObjSurvey::setEndDateAndTime	(	string	$end_date,
		string	$end_time
	)

Parameters

string	$end_date	(YYYY-MM-DD)
string	$end_time	(HH:MM:SS)

Definition at line 1262 of file class.ilObjSurvey.php.

     : void {
        $y = '';
        $m = '';
        $d = '';
        $h = '';
        $i = '';
        $s = '';
        if (preg_match("/(\d{4})-(\d{2})-(\d{2})/", $end_date, $matches)) {
            $y = $matches[1];
            $m = $matches[2];
            $d = $matches[3];
        }
        if (preg_match("/(\d{2}):(\d{2}):(\d{2})/", $end_time, $matches)) {
            $h = $matches[1];
            $i = $matches[2];
            $s = $matches[3];
        }
        $this->end_date = sprintf('%04d%02d%02d%02d%02d%02d', $y, $m, $d, $h, $i, $s);
    }

References Vendor\Package\$d.

setEvaluationAccess()

ilObjSurvey::setEvaluationAccess

(

string

$evaluation_access = self::EVALUATION_ACCESS_OFF

)

Definition at line 1291 of file class.ilObjSurvey.php.

     : void {
        $this->evaluation_access = $evaluation_access;
    }

setIntroduction()

ilObjSurvey::setIntroduction

(

string

$introduction = ""

)

Definition at line 1171 of file class.ilObjSurvey.php.

     : void {
        $this->introduction = $introduction;
    }

setMailAddresses()

ilObjSurvey::setMailAddresses

(

string

$a_addresses

)

Set (Tutor) Recipients of "single participant has finished" mails.

Definition at line 4122 of file class.ilObjSurvey.php.

                                                         : void
    {
        $this->mailaddresses = $a_addresses;
    }

setMailConfirmation()

ilObjSurvey::setMailConfirmation

(

bool

$a_value

)

Definition at line 5512 of file class.ilObjSurvey.php.

                                                      : void
    {
        $this->mail_confirmation = $a_value;
    }

setMailNotification()

ilObjSurvey::setMailNotification

(

bool

$a_notification

)

Activate mail to tutors each time a participant finishes the survey.

Definition at line 4106 of file class.ilObjSurvey.php.

                                                             : void
    {
        $this->mailnotification = $a_notification;
    }

setMailOwnResults()

ilObjSurvey::setMailOwnResults

(

bool

$a_value

)

Definition at line 5502 of file class.ilObjSurvey.php.

                                                    : void
    {
        $this->mail_own_results = $a_value;
    }

setMailParticipantData()

ilObjSurvey::setMailParticipantData

(

string

$a_data

)

Set preceding text (incl.

placeholders) for "single participant has finished" mails

Definition at line 4138 of file class.ilObjSurvey.php.

                                                          : void
    {
        $this->mailparticipantdata = $a_data;
    }

setMode()

ilObjSurvey::setMode

(

int

$a_value

)

Definition at line 5585 of file class.ilObjSurvey.php.

                                         : void
    {
        $this->mode = $a_value;
    }

setObligatoryStates()

ilObjSurvey::setObligatoryStates

(

array

$obligatory_questions

)

Sets the obligatory states for questions in a survey from the questions form.

Parameters

array

$obligatory_questions

key is question id, value should be bool value

Todo:

move to survey question manager/repo

Definition at line 1882 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT * FROM svy_svy_qst WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        if ($result->numRows()) {
            while ($row = $ilDB->fetchAssoc($result)) {
                if (!array_key_exists($row["question_fi"], $obligatory_questions)) {
                    $obligatory_questions[$row["question_fi"]] = 0;
                }
            }
        }
        // set the obligatory states in the database
        foreach ($obligatory_questions as $question_fi => $obligatory) {
            // #12420
            $ilDB->manipulate("UPDATE svy_question" .
                " SET obligatory = " . $ilDB->quote($obligatory, "integer") .
                " WHERE question_id = " . $ilDB->quote($question_fi, "integer"));
        }
    }

References $ilDB.

setOutro()

ilObjSurvey::setOutro

(

string

$outro = ""

)

Definition at line 1177 of file class.ilObjSurvey.php.

     : void {
        $this->outro = $outro;
    }

setPage()

ilObjSurvey::setPage	(	int	$finished_id,
		int	$page_id
	)

Sets the number of the active survey page.

Parameters

int	$finished_id	id of the active user
int	$page_id	index of the page

Todo:

move to run manager/repo

Definition at line 2371 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
 
        $ilDB->manipulateF(
            "UPDATE svy_finished SET lastpage = %s WHERE finished_id = %s",
            array('integer','integer'),
            array(($page_id) ?: 0, $finished_id)
        );
    }

setPoolUsage()

ilObjSurvey::setPoolUsage

(

bool

$a_value

)

Definition at line 4179 of file class.ilObjSurvey.php.

                                               : void
    {
        $this->pool_usage = $a_value;
    }

setReminderEnd()

ilObjSurvey::setReminderEnd

(

?ilDate

$a_value = null

)

Definition at line 4997 of file class.ilObjSurvey.php.

                                                           : void
    {
        $this->reminder_end = $a_value;
    }

setReminderFrequency()

ilObjSurvey::setReminderFrequency

(

int

$a_value

)

Definition at line 5007 of file class.ilObjSurvey.php.

                                                      : void
    {
        $this->reminder_frequency = $a_value;
    }

setReminderLastSent()

ilObjSurvey::setReminderLastSent

(

?string

$a_value

)

Definition at line 5027 of file class.ilObjSurvey.php.

                                                         : void
    {
        if ($a_value == "") {
            $a_value = null;
        }
        $this->reminder_last_sent = $a_value;
    }

setReminderStart()

ilObjSurvey::setReminderStart

(

?ilDate

$a_value = null

)

Definition at line 4987 of file class.ilObjSurvey.php.

                                                             : void
    {
        $this->reminder_start = $a_value;
    }

setReminderStatus()

ilObjSurvey::setReminderStatus

(

bool

$a_value

)

Definition at line 4977 of file class.ilObjSurvey.php.

                                                    : void
    {
        $this->reminder_status = $a_value;
    }

setReminderTarget()

ilObjSurvey::setReminderTarget

(

int

$a_value

)

Definition at line 5017 of file class.ilObjSurvey.php.

                                                   : void
    {
        $this->reminder_target = $a_value;
    }

Referenced by ILIAS\Survey\Mode\Feedback360\UIModifier\setValuesFromForm(), and ILIAS\Survey\Mode\IndividualFeedback\UIModifier\setValuesFromForm().

Here is the caller graph for this function:

setReminderTemplate()

ilObjSurvey::setReminderTemplate

(

?int

$a_value

)

Definition at line 5050 of file class.ilObjSurvey.php.

                                                      : void
    {
        $this->reminder_tmpl = $a_value;
    }

setSelfEvaluationResults()

ilObjSurvey::setSelfEvaluationResults

(

int

$a_value

)

Definition at line 5595 of file class.ilObjSurvey.php.

                                                          : void
    {
        $this->mode_self_eval_results = $a_value;
    }

setShowQuestionTitles()

ilObjSurvey::setShowQuestionTitles

(

bool

$a_show

)

Definition at line 1166 of file class.ilObjSurvey.php.

                                                       : void
    {
        $this->display_question_titles = $a_show;
    }

setSkillService()

ilObjSurvey::setSkillService

(

bool

$a_val

)

Definition at line 4849 of file class.ilObjSurvey.php.

                                                : void
    {
        $this->mode_skill_service = $a_val;
    }

setStartDate()

ilObjSurvey::setStartDate

(

string

$start_date = ""

)

Parameters

string

$start_date

(YYYYMMDDHHMMSS)

Definition at line 1191 of file class.ilObjSurvey.php.

     : void {
        $this->start_date = $start_date;
    }

setStartDateAndTime()

ilObjSurvey::setStartDateAndTime	(	string	$start_date,
		string	$start_time
	)

Parameters

string	$start_date	(YYYY-MM-DD)
string	$start_time	(HH:MM:SS)

Definition at line 1201 of file class.ilObjSurvey.php.

     : void {
        $y = '';
        $m = '';
        $d = '';
        $h = '';
        $i = '';
        $s = '';
        if (preg_match("/(\d{4})-(\d{2})-(\d{2})/", $start_date, $matches)) {
            $y = $matches[1];
            $m = $matches[2];
            $d = $matches[3];
        }
        if (preg_match("/(\d{2}):(\d{2}):(\d{2})/", $start_time, $matches)) {
            $h = $matches[1];
            $i = $matches[2];
            $s = $matches[3];
        }
        $this->start_date = sprintf('%04d%02d%02d%02d%02d%02d', $y, $m, $d, $h, $i, $s);
    }

References Vendor\Package\$d.

setSurveyId()

ilObjSurvey::setSurveyId

(

int

$survey_id

)

Definition at line 4066 of file class.ilObjSurvey.php.

                                               : void
    {
        $this->survey_id = $survey_id;
    }

setTutorNotificationRecipients()

ilObjSurvey::setTutorNotificationRecipients

(

array

$a_value

)

Set tutor recipients for "all participants have finished" mail.

Definition at line 5079 of file class.ilObjSurvey.php.

                                                                  : void
    {
        $this->tutor_ntf_recipients = $a_value;
    }

setTutorNotificationStatus()

ilObjSurvey::setTutorNotificationStatus

(

bool

$a_value

)

Activates mail being sent to tutors after all participants have finished the survey.

Definition at line 5063 of file class.ilObjSurvey.php.

                                                             : void
    {
        $this->tutor_ntf_status = $a_value;
    }

setTutorNotificationTarget()

ilObjSurvey::setTutorNotificationTarget

(

int

$a_value

)

Definition at line 5095 of file class.ilObjSurvey.php.

                                                            : void
    {
        $this->tutor_ntf_target = $a_value;
    }

setTutorResultsRecipients()

ilObjSurvey::setTutorResultsRecipients

(

array

$a_value

)

Definition at line 5115 of file class.ilObjSurvey.php.

                                                             : void
    {
        $this->tutor_res_recipients = $a_value;
    }

setTutorResultsStatus()

ilObjSurvey::setTutorResultsStatus

(

bool

$a_value

)

Definition at line 5105 of file class.ilObjSurvey.php.

                                                        : void
    {
        $this->tutor_res_status = $a_value;
    }

setViewOwnResults()

ilObjSurvey::setViewOwnResults

(

bool

$a_value

)

Definition at line 5492 of file class.ilObjSurvey.php.

                                                    : void
    {
        $this->view_own_results = $a_value;
    }

toXML()

ilObjSurvey::toXML

(

)

Returns a QTI xml representation of the survey.

Todo:

move to export sub-service

Definition at line 2928 of file class.ilObjSurvey.php.

                           : string
    {
        $a_xml_writer = new ilXmlWriter();
        // set xml header
        $a_xml_writer->xmlHeader();
        $attrs = array(
            "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
            "xsi:noNamespaceSchemaLocation" => "https://www.ilias.de/download/xsd/ilias_survey_4_2.xsd"
        );
        $a_xml_writer->xmlStartTag("surveyobject", $attrs);
        $attrs = array(
            "id" => $this->getSurveyId(),
            "title" => $this->getTitle()
        );
        $a_xml_writer->xmlStartTag("survey", $attrs);
 
        $a_xml_writer->xmlElement("description", null, $this->getDescription());
        $a_xml_writer->xmlElement("author", null, $this->getAuthor());
        $a_xml_writer->xmlStartTag("objectives");
        $attrs = array(
            "label" => "introduction"
        );
        $this->addMaterialTag($a_xml_writer, $this->getIntroduction(), true, true, $attrs);
        $attrs = array(
            "label" => "outro"
        );
        $this->addMaterialTag($a_xml_writer, $this->getOutro(), true, true, $attrs);
        $a_xml_writer->xmlEndTag("objectives");
 
        if ($this->getAnonymize()) {
            $attribs = array("enabled" => "1");
        } else {
            $attribs = array("enabled" => "0");
        }
        $a_xml_writer->xmlElement("anonymisation", $attribs);
        $a_xml_writer->xmlStartTag("restrictions");
        if ($this->getAnonymize() === 2) {
            $attribs = array("type" => "free");
        } else {
            $attribs = array("type" => "restricted");
        }
        $a_xml_writer->xmlElement("access", $attribs);
        if ($this->getStartDate()) {
            $attrs = array("type" => "date");
            preg_match("/(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/", $this->getStartDate(), $matches);
            $a_xml_writer->xmlElement("startingtime", $attrs, sprintf("%04d-%02d-%02dT%02d:%02d:00", $matches[1], $matches[2], $matches[3], $matches[4], $matches[5]));
        }
        if ($this->getEndDate()) {
            $attrs = array("type" => "date");
            preg_match("/(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/", $this->getEndDate(), $matches);
            $a_xml_writer->xmlElement("endingtime", $attrs, sprintf("%04d-%02d-%02dT%02d:%02d:00", $matches[1], $matches[2], $matches[3], $matches[4], $matches[5]));
        }
        $a_xml_writer->xmlEndTag("restrictions");
 
        // constraints
        $pages = $this->getSurveyPages();
        $hasconstraints = false;
        foreach ($pages as $question_array) {
            foreach ($question_array as $question) {
                if (count($question["constraints"])) {
                    $hasconstraints = true;
                }
            }
        }
 
        if ($hasconstraints) {
            $a_xml_writer->xmlStartTag("constraints");
            foreach ($pages as $question_array) {
                foreach ($question_array as $question) {
                    if (count($question["constraints"])) {
                        // found constraints
                        foreach ($question["constraints"] as $constraint) {
                            $attribs = array(
                                "sourceref" => $question["question_id"],
                                "destref" => $constraint["question"],
                                "relation" => $constraint["short"],
                                "value" => $constraint["value"],
                                "conjunction" => $constraint["conjunction"]
                            );
                            $a_xml_writer->xmlElement("constraint", $attribs);
                        }
                    }
                }
            }
            $a_xml_writer->xmlEndTag("constraints");
        }
 
        // add the rest of the preferences in qtimetadata tags, because there is no correspondent definition in QTI
        $a_xml_writer->xmlStartTag("metadata");
 
        $custom_properties = array();
        $custom_properties["evaluation_access"] = $this->getEvaluationAccess();
        $custom_properties["status"] = !$this->getOfflineStatus();
        $custom_properties["display_question_titles"] = $this->getShowQuestionTitles();
 
        $custom_properties["own_results_view"] = (int) $this->hasViewOwnResults();
        $custom_properties["own_results_mail"] = (int) $this->hasMailOwnResults();
        $custom_properties["confirmation_mail"] = (int) $this->hasMailConfirmation();
 
        $custom_properties["anon_user_list"] = (int) $this->hasAnonymousUserList();
        $custom_properties["mode"] = $this->getMode();
        $custom_properties["mode_360_self_eval"] = (int) $this->get360SelfEvaluation();
        $custom_properties["mode_360_self_rate"] = (int) $this->get360SelfRaters();
        $custom_properties["mode_360_self_appr"] = (int) $this->get360SelfAppraisee();
        $custom_properties["mode_360_results"] = $this->get360Results();
        $custom_properties["mode_skill_service"] = (int) $this->getSkillService();
        $custom_properties["mode_self_eval_results"] = $this->getSelfEvaluationResults();
 
 
        // :TODO: skills?
 
        // reminder/tutor notification are (currently?) not exportable
 
        foreach ($custom_properties as $label => $value) {
            $a_xml_writer->xmlStartTag("metadatafield");
            $a_xml_writer->xmlElement("fieldlabel", null, $label);
            $a_xml_writer->xmlElement("fieldentry", null, $value);
            $a_xml_writer->xmlEndTag("metadatafield");
        }
 
        $a_xml_writer->xmlEndTag("metadata");
        $a_xml_writer->xmlEndTag("survey");
 
        $attribs = array("id" => $this->getId());
        $a_xml_writer->xmlStartTag("surveyquestions", $attribs);
        // add questionblock descriptions
        foreach ($pages as $question_array) {
            if (count($question_array) > 1) {
                $attribs = array("id" => $question_array[0]["question_id"]);
                $attribs = array(
                    "showQuestiontext" => $question_array[0]["questionblock_show_questiontext"],
                    "showBlocktitle" => $question_array[0]["questionblock_show_blocktitle"],
                    "compressView" => $question_array[0]["questionblock_compress_view"]
                );
                $a_xml_writer->xmlStartTag("questionblock", $attribs);
                if (strlen($question_array[0]["questionblock_title"])) {
                    $a_xml_writer->xmlElement("questionblocktitle", null, $question_array[0]["questionblock_title"]);
                }
            }
            foreach ($question_array as $question) {
                if (strlen($question["heading"] ?? "")) {
                    $a_xml_writer->xmlElement("textblock", null, $question["heading"]);
                }
                $questionObject = self::_instanciateQuestion($question["question_id"]);
                //questionObject contains all the fields from the database. (loadFromDb)
                //we don't need the value from svy_qst_oblig table, we already have the values from svy_question table.
                //if ($questionObject !== FALSE) $questionObject->insertXML($a_xml_writer, FALSE, $obligatory_states[$question["question_id"]]);
                if ($questionObject !== false) {
                    $questionObject->insertXML($a_xml_writer, false);
                }
            }
            if (count($question_array) > 1) {
                $a_xml_writer->xmlEndTag("questionblock");
            }
        }
 
        $a_xml_writer->xmlEndTag("surveyquestions");
        $a_xml_writer->xmlEndTag("surveyobject");
        $xml = $a_xml_writer->xmlDumpMem(false);
        return $xml;
    }

References ILIAS\Survey\Mode\getId(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ILIAS\Repository\int().

Here is the call graph for this function:

unfoldQuestionblocks()

ilObjSurvey::unfoldQuestionblocks

(

array

$questionblocks

)

Parameters

int[]

$questionblocks

question block ids

Todo:

move to survey question manager/repo

Definition at line 1510 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        foreach ($questionblocks as $index) {
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_qblk WHERE questionblock_id = %s",
                array('integer'),
                array($index)
            );
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_qblk_qst WHERE questionblock_fi = %s AND survey_fi = %s",
                array('integer','integer'),
                array($index, $this->getSurveyId())
            );
        }
    }

References $ilDB.

update()

ilObjSurvey::update

(

$a_upload = false

)

Definition at line 228 of file class.ilObjSurvey.php.

                                             : bool
    {
        if (!$a_upload) {
            $this->updateMetaData();
        }
 
        if (!parent::update()) {
            return false;
        }
 
        // put here object specific stuff
 
        return true;
    }

References ilObject\updateMetaData().

Here is the call graph for this function:

updateCode()

ilObjSurvey::updateCode	(	int	$a_id,
		string	$a_email,
		string	$a_last_name,
		string	$a_first_name,
		int	$a_sent
	)

Todo:

move to code manager

Definition at line 4187 of file class.ilObjSurvey.php.

     : bool {
        $ilDB = $this->db;
 
        $a_email = trim($a_email);
 
        // :TODO:
        if (($a_email && !ilUtil::is_email($a_email)) || $a_email === "") {
            return false;
        }
 
        $data = array("email" => $a_email,
            "lastname" => trim($a_last_name),
            "firstname" => trim($a_first_name));
 
        $fields = array(
            "externaldata" => array("text", serialize($data)),
            "sent" => array("integer", $a_sent)
        );
 
        $ilDB->update(
            "svy_anonymous",
            $fields,
            array("anonymous_id" => array("integer", $a_id))
        );
 
        return true;
    }

updateConjunctionForQuestions()

ilObjSurvey::updateConjunctionForQuestions	(	array	$questions,
		int	$conjunction
	)

Todo:

move to constraint manager/repo

Definition at line 2224 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        foreach ($questions as $question_id) {
            $ilDB->manipulateF(
                "UPDATE svy_constraint SET conjunction = %s " .
                "WHERE constraint_id IN (SELECT constraint_fi FROM svy_qst_constraint WHERE svy_qst_constraint.question_fi = %s)",
                array('integer','integer'),
                array($conjunction, $question_id)
            );
        }
    }

References $ilDB.

updateConstraint()

ilObjSurvey::updateConstraint	(	int	$precondition_id,
		int	$if_question_id,
		int	$relation,
		float	$value,
		int	$conjunction
	)

Todo:

move to constraint manager/repo

Definition at line 2205 of file class.ilObjSurvey.php.

     : void {
        $ilDB = $this->db;
        $ilDB->manipulateF(
            "UPDATE svy_constraint SET question_fi = %s, relation_fi = %s, value = %s, conjunction = %s " .
            "WHERE constraint_id = %s",
            array('integer','integer','float','integer','integer'),
            array($if_question_id, $relation, $value, $conjunction, $precondition_id)
        );
    }

updateOrder()

ilObjSurvey::updateOrder

(

array

$a_order

)

Definition at line 4165 of file class.ilObjSurvey.php.

     : void {
        if (count($this->questions) === count($a_order)) {
            $this->questions = array_flip($a_order);
            $this->saveQuestionsToDb();
        }
    }

Field Documentation

$access

ilAccessHandler ilObjSurvey::$access

protected

Definition at line 69 of file class.ilObjSurvey.php.

$activation_ending_time

int ilObjSurvey::$activation_ending_time = null

protected

Definition at line 106 of file class.ilObjSurvey.php.

$activation_limited

bool ilObjSurvey::$activation_limited = false

protected

Definition at line 67 of file class.ilObjSurvey.php.

$activation_starting_time

int ilObjSurvey::$activation_starting_time = null

protected

Definition at line 105 of file class.ilObjSurvey.php.

$activation_visibility

bool ilObjSurvey::$activation_visibility = false

protected

Definition at line 104 of file class.ilObjSurvey.php.

$anon_user_list

bool ilObjSurvey::$anon_user_list = false

protected

Definition at line 133 of file class.ilObjSurvey.php.

$anonymize

int ilObjSurvey::$anonymize = 0

Definition at line 93 of file class.ilObjSurvey.php.

$author

string ilObjSurvey::$author = ""

A text representation of the authors name.

The name of the author must not necessary be the name of the owner.

Definition at line 81 of file class.ilObjSurvey.php.

$calculate_sum_score

bool ilObjSurvey::$calculate_sum_score = false

protected

Definition at line 71 of file class.ilObjSurvey.php.

$code_manager

ILIAS Survey Code CodeManager ilObjSurvey::$code_manager

protected

Definition at line 139 of file class.ilObjSurvey.php.

$data_manager

ILIAS Survey InternalDataService ilObjSurvey::$data_manager

protected

Definition at line 140 of file class.ilObjSurvey.php.

$display_question_titles

int ilObjSurvey::$display_question_titles = 0

Definition at line 95 of file class.ilObjSurvey.php.

$domain

InternalDomainService ilObjSurvey::$domain

protected

Definition at line 64 of file class.ilObjSurvey.php.

$end_date

string ilObjSurvey::$end_date = ""

Definition at line 89 of file class.ilObjSurvey.php.

$evaluation_access

string ilObjSurvey::$evaluation_access = self::EVALUATION_ACCESS_OFF

Definition at line 85 of file class.ilObjSurvey.php.

$feature_config

Mode FeatureConfig ilObjSurvey::$feature_config

protected

Definition at line 141 of file class.ilObjSurvey.php.

$import_manager

ILIAS SurveyQuestionPool Export ImportManager ilObjSurvey::$import_manager

protected

Definition at line 142 of file class.ilObjSurvey.php.

$introduction

string ilObjSurvey::$introduction = ""

Definition at line 82 of file class.ilObjSurvey.php.

$invitation_manager

Participants InvitationsManager ilObjSurvey::$invitation_manager

protected

Definition at line 137 of file class.ilObjSurvey.php.

$mail_confirmation

bool ilObjSurvey::$mail_confirmation = false

protected

Definition at line 131 of file class.ilObjSurvey.php.

$mail_own_results

bool ilObjSurvey::$mail_own_results = false

protected

Definition at line 130 of file class.ilObjSurvey.php.

$mailaddresses

string ilObjSurvey::$mailaddresses = ""

Definition at line 100 of file class.ilObjSurvey.php.

$mailnotification

bool ilObjSurvey::$mailnotification = false

Definition at line 99 of file class.ilObjSurvey.php.

$mailparticipantdata

string ilObjSurvey::$mailparticipantdata = ""

Definition at line 101 of file class.ilObjSurvey.php.

$mode

int ilObjSurvey::$mode = 0

protected

Definition at line 134 of file class.ilObjSurvey.php.

$mode_360_results

int ilObjSurvey::$mode_360_results = 0

protected

Definition at line 112 of file class.ilObjSurvey.php.

$mode_360_self_appr

bool ilObjSurvey::$mode_360_self_appr = false

protected

Definition at line 110 of file class.ilObjSurvey.php.

$mode_360_self_eval

bool ilObjSurvey::$mode_360_self_eval = false

protected

Definition at line 109 of file class.ilObjSurvey.php.

$mode_360_self_rate

bool ilObjSurvey::$mode_360_self_rate = false

protected

Definition at line 111 of file class.ilObjSurvey.php.

$mode_self_eval_results

int ilObjSurvey::$mode_self_eval_results = 0

protected

Definition at line 135 of file class.ilObjSurvey.php.

$mode_skill_service

bool ilObjSurvey::$mode_skill_service = false

protected

Definition at line 113 of file class.ilObjSurvey.php.

$outro

string ilObjSurvey::$outro = ""

Definition at line 83 of file class.ilObjSurvey.php.

$placeholder_resolver

ilMailTemplatePlaceholderResolver ilObjSurvey::$placeholder_resolver

protected

Definition at line 143 of file class.ilObjSurvey.php.

$plugin_admin

ilPluginAdmin ilObjSurvey::$plugin_admin

protected

Definition at line 70 of file class.ilObjSurvey.php.

$pool_usage

bool ilObjSurvey::$pool_usage = false

Definition at line 102 of file class.ilObjSurvey.php.

$questions

array ilObjSurvey::$questions = []

Definition at line 91 of file class.ilObjSurvey.php.

$reminder_end

ilDate ilObjSurvey::$reminder_end = null

protected

Definition at line 118 of file class.ilObjSurvey.php.

$reminder_frequency

int ilObjSurvey::$reminder_frequency = 0

protected

Definition at line 119 of file class.ilObjSurvey.php.

$reminder_last_sent

string ilObjSurvey::$reminder_last_sent = null

protected

Definition at line 121 of file class.ilObjSurvey.php.

$reminder_start

ilDate ilObjSurvey::$reminder_start = null

protected

Definition at line 117 of file class.ilObjSurvey.php.

$reminder_status

bool ilObjSurvey::$reminder_status = false

protected

Definition at line 116 of file class.ilObjSurvey.php.

$reminder_target

int ilObjSurvey::$reminder_target = 0

protected

Definition at line 120 of file class.ilObjSurvey.php.

$reminder_tmpl

int ilObjSurvey::$reminder_tmpl = null

protected

Definition at line 122 of file class.ilObjSurvey.php.

$start_date

string ilObjSurvey::$start_date = ""

Definition at line 87 of file class.ilObjSurvey.php.

$survey_id

int ilObjSurvey::$survey_id = 0

A unique positive numerical ID which identifies the survey.

This is the primary key from a database table.

Definition at line 76 of file class.ilObjSurvey.php.

$survey_service

ILIAS Survey InternalService ilObjSurvey::$survey_service

protected

Definition at line 138 of file class.ilObjSurvey.php.

$surveyCodeSecurity

bool ilObjSurvey::$surveyCodeSecurity = false

Definition at line 97 of file class.ilObjSurvey.php.

$svy_log

ilLogger ilObjSurvey::$svy_log

protected

Definition at line 66 of file class.ilObjSurvey.php.

$tutor_ntf_recipients

array ilObjSurvey::$tutor_ntf_recipients = []

protected

Definition at line 124 of file class.ilObjSurvey.php.

$tutor_ntf_status

bool ilObjSurvey::$tutor_ntf_status = false

protected

Definition at line 123 of file class.ilObjSurvey.php.

$tutor_ntf_target

int ilObjSurvey::$tutor_ntf_target = 0

protected

Definition at line 125 of file class.ilObjSurvey.php.

$tutor_res_recipients

array ilObjSurvey::$tutor_res_recipients = []

protected

Definition at line 127 of file class.ilObjSurvey.php.

$tutor_res_status

bool ilObjSurvey::$tutor_res_status = false

protected

Definition at line 126 of file class.ilObjSurvey.php.

$user

ilObjUser ilObjSurvey::$user

protected

Definition at line 68 of file class.ilObjSurvey.php.

$view_own_results

bool ilObjSurvey::$view_own_results = false

protected

Definition at line 129 of file class.ilObjSurvey.php.

ANONYMIZE_CODE_ALL

const ilObjSurvey::ANONYMIZE_CODE_ALL = 3

Definition at line 35 of file class.ilObjSurvey.php.

Referenced by ilObjSurveyGUI\afterSave().

ANONYMIZE_FREEACCESS

const ilObjSurvey::ANONYMIZE_FREEACCESS = 2

Definition at line 34 of file class.ilObjSurvey.php.

ANONYMIZE_OFF

const ilObjSurvey::ANONYMIZE_OFF = 0

Definition at line 32 of file class.ilObjSurvey.php.

Referenced by __construct().

ANONYMIZE_ON

const ilObjSurvey::ANONYMIZE_ON = 1

Definition at line 33 of file class.ilObjSurvey.php.

EVALUATION_ACCESS_ALL

const ilObjSurvey::EVALUATION_ACCESS_ALL = "1"

Definition at line 29 of file class.ilObjSurvey.php.

Referenced by ilSurveyEvaluationGUI\evaluation().

EVALUATION_ACCESS_OFF

const ilObjSurvey::EVALUATION_ACCESS_OFF = "0"

Definition at line 28 of file class.ilObjSurvey.php.

Referenced by __construct(), and ilSurveyEvaluationGUI\evaluation().

EVALUATION_ACCESS_PARTICIPANTS

const ilObjSurvey::EVALUATION_ACCESS_PARTICIPANTS = "2"

Definition at line 30 of file class.ilObjSurvey.php.

Referenced by ilObjSurveyGUI\afterSave(), and ilSurveyEvaluationGUI\evaluation().

MODE_360

const ilObjSurvey::MODE_360 = 1

Definition at line 46 of file class.ilObjSurvey.php.

Referenced by ilObjSurveyGUI\afterSave(), ilSurveyExecutionGUI\backToRepository(), ilObjSurveyListGUI\getProperties(), and ilSurveyExecutionGUI\runShowFinishedPage().

MODE_IND_FEEDB

const ilObjSurvey::MODE_IND_FEEDB = 3

Definition at line 48 of file class.ilObjSurvey.php.

Referenced by ilObjSurveyGUI\afterSave(), ilSurveyEvaluationGUI\competenceEval(), ilSurveyEvaluationGUI\evaluation(), ILIAS\Survey\Evaluation\EvaluationManager\getFilteredFinishedIds(), ILIAS\Survey\Evaluation\EvaluationManager\getSelectableRaters(), ilSurveyEvaluationGUI\openEvaluation(), and ilSurveyEvaluationGUI\setEvalSubtabs().

MODE_SELF_EVAL

const ilObjSurvey::MODE_SELF_EVAL = 2

Definition at line 47 of file class.ilObjSurvey.php.

Referenced by ilSurveyExecutionGUI\__construct(), ilObjSurveyGUI\afterSave(), ilSurveyEvaluationGUI\evaluationuser(), ILIAS\Survey\Evaluation\EvaluationManager\getFilteredFinishedIds(), ilObjSurveyListGUI\getProperties(), ILIAS\Survey\Evaluation\EvaluationManager\getSelectableAppraisees(), ilSurveyParticipantsGUI\maintenanceObject(), and ilSurveyEvaluationGUI\sumscore().

MODE_STANDARD

const ilObjSurvey::MODE_STANDARD = 0

Definition at line 45 of file class.ilObjSurvey.php.

Referenced by __construct(), and ilObjSurveyGUI\getTabs().

NOTIFICATION_APPRAISEES

const ilObjSurvey::NOTIFICATION_APPRAISEES = 3

Definition at line 61 of file class.ilObjSurvey.php.

NOTIFICATION_APPRAISEES_AND_RATERS

const ilObjSurvey::NOTIFICATION_APPRAISEES_AND_RATERS = 5

Definition at line 63 of file class.ilObjSurvey.php.

Referenced by ILIAS\Survey\Mode\Feedback360\UIModifier\setValuesFromForm(), and ILIAS\Survey\Mode\IndividualFeedback\UIModifier\setValuesFromForm().

NOTIFICATION_INVITED_USERS

const ilObjSurvey::NOTIFICATION_INVITED_USERS = 2

Definition at line 60 of file class.ilObjSurvey.php.

NOTIFICATION_PARENT_COURSE

const ilObjSurvey::NOTIFICATION_PARENT_COURSE = 1

Definition at line 59 of file class.ilObjSurvey.php.

NOTIFICATION_RATERS

const ilObjSurvey::NOTIFICATION_RATERS = 4

Definition at line 62 of file class.ilObjSurvey.php.

PRINT_HIDE_LABELS

const ilObjSurvey::PRINT_HIDE_LABELS = 1

Definition at line 41 of file class.ilObjSurvey.php.

Referenced by SurveyQuestionGUI\getPrintViewQuestionTitle(), and SurveyQuestionGUI\getQuestionTitle().

PRINT_SHOW_LABELS

const ilObjSurvey::PRINT_SHOW_LABELS = 3

Definition at line 42 of file class.ilObjSurvey.php.

Referenced by SurveyQuestionGUI\getPrintViewQuestionTitle(), and SurveyQuestionGUI\getQuestionTitle().

QUESTIONTITLES_HIDDEN

const ilObjSurvey::QUESTIONTITLES_HIDDEN = 0

Definition at line 37 of file class.ilObjSurvey.php.

QUESTIONTITLES_VISIBLE

const ilObjSurvey::QUESTIONTITLES_VISIBLE = 1

Definition at line 38 of file class.ilObjSurvey.php.

Referenced by __construct().

RESULTS_360_ALL

const ilObjSurvey::RESULTS_360_ALL = 2

Definition at line 57 of file class.ilObjSurvey.php.

Referenced by ILIAS\Survey\Evaluation\EvaluationManager\isMultiParticipantsView().

RESULTS_360_NONE

const ilObjSurvey::RESULTS_360_NONE = 0

Definition at line 55 of file class.ilObjSurvey.php.

RESULTS_360_OWN

const ilObjSurvey::RESULTS_360_OWN = 1

Definition at line 56 of file class.ilObjSurvey.php.

RESULTS_SELF_EVAL_ALL

const ilObjSurvey::RESULTS_SELF_EVAL_ALL = 2

Definition at line 53 of file class.ilObjSurvey.php.

Referenced by ILIAS\Survey\Evaluation\EvaluationManager\getFilteredFinishedIds(), and ILIAS\Survey\Evaluation\EvaluationManager\isMultiParticipantsView().

RESULTS_SELF_EVAL_NONE

const ilObjSurvey::RESULTS_SELF_EVAL_NONE = 0

Definition at line 51 of file class.ilObjSurvey.php.

RESULTS_SELF_EVAL_OWN

const ilObjSurvey::RESULTS_SELF_EVAL_OWN = 1

Definition at line 52 of file class.ilObjSurvey.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Survey/classes/class.ilObjSurvey.php