ilObjSurvey Class Reference

Class ilObjSurvey. More...

Inheritance diagram for ilObjSurvey:

Collaboration diagram for ilObjSurvey:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	create ($a_upload=false)
	create survey object More...
	createMetaData ()
	Create meta data entry. More...
	update ($a_upload=false)
	update object data More...
	createReference ()
	read ()
	read object data from db into object public More...
	addQuestion ($question_id)
	Adds a question to the survey (used in importer!) More...
	delete ()
	delete object and all related data More...
	deleteSurveyRecord ()
	Deletes the survey from the database. More...
	deleteAllUserData ($reset_LP=true)
	Deletes all user data of a survey. More...
	removeSelectedSurveyResults ($finished_ids)
	Deletes the user data of a given array of survey participants. More...
&	getSurveyParticipants ($finished_ids=null, $force_non_anonymous=false, $include_invites=false)
	isComplete ()
	Returns 1, if a survey is complete for use. More...
	saveCompletionStatus ()
	Saves the completion status of the survey. More...
	duplicateQuestionForSurvey ($question_id, $a_force=false)
	Takes a question and creates a copy of the question for use in the survey. More...
	insertQuestion ($question_id)
	Inserts a question in the survey and saves the relation to the database. More...
	isQuestionInSurvey ($a_question_fi)
	Check if a question is already in the survey. More...
	insertQuestionblock ($questionblock_id)
	Inserts a questionblock in the survey and saves the relation to the database. More...
	saveUserSettings ($usr_id, $key, $title, $value)
	deleteUserSettings ($id)
	getUserSettings ($usr_id, $key)
	saveToDb ()
	Saves a survey object to a database. More...
	saveQuestionsToDb ()
	Saves the survey questions to the database. More...
	getAnonymousId ($id)
	Checks for an anomyous survey id in the database an returns the id. More...
	getQuestionGUI ($questiontype, $question_id)
	Returns a question gui object to a given questiontype and question id. More...
	getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...
	getSurveyId ()
	Returns the survey database id. More...
	setAnonymize ($a_anonymize)
	set anonymize status More...
	getAnonymize ()
	get anonymize status More...
	isAccessibleWithoutCode ()
	Checks if the survey is accessable without a survey code. More...
	hasAnonymizedResults ()
	Checks if the survey results are to be anonymized. More...
	loadFromDb ()
	Loads a survey object from a database. More...
	loadQuestionsFromDb ()
	Loads the survey questions from the database. More...
	fixSequenceStructure ()
	Remove duplicate sequence entries, see #22018. More...
	setAuthor ($author="")
	Sets the authors name of the ilObjSurvey object. More...
	saveAuthorToMetadata ($a_author="")
	Saves an authors name into the lifecycle metadata if no lifecycle metadata exists This will only be called for conversion of "old" tests where the author hasn't been stored in the lifecycle metadata. More...
	getAuthor ()
	Gets the authors name of the ilObjSurvey object. More...
	getShowQuestionTitles ()
	Gets the status of the display_question_titles attribute. More...
	setShowQuestionTitles ($a_show)
	Sets the status of the display_question_titles attribute. More...
	showQuestionTitles ()
	Sets the question titles visible during the query. More...
	hideQuestionTitles ()
	Sets the question titles hidden during the query. More...
	setIntroduction ($introduction="")
	Sets the introduction text. More...
	setOutro ($outro="")
	Sets the outro text. More...
	getStartDate ()
	Gets the start date of the survey. More...
	canStartSurvey ($anonymous_id=null, $a_no_rbac=false)
	Checks if the survey can be started. More...
	setStartDate ($start_date="")
	Sets the start date of the survey. More...
	setStartDateAndTime ($start_date="", $start_time)
	Sets the start date of the survey. More...
	getEndDate ()
	Gets the end date of the survey. More...
	setEndDate ($end_date="")
	Sets the end date of the survey. More...
	setEndDateAndTime ($end_date="", $end_time)
	Sets the end date of the survey. More...
	getEvaluationAccess ()
	Gets the learners evaluation access. More...
	setEvaluationAccess ($evaluation_access=self::EVALUATION_ACCESS_OFF)
	Sets the learners evaluation access. More...
	setActivationVisibility ($a_value)
	getActivationVisibility ()
	isActivationLimited ()
	setActivationLimited ($a_value)
	getIntroduction ()
	Gets the introduction text. More...
	getOutro ()
	Gets the outro text. More...
&	getExistingQuestions ()
	Gets the question id's of the questions which are already in the survey. More...
&	getQuestionpoolTitles ($could_be_offline=false, $showPath=false)
	Get the titles of all available survey question pools. More...
	moveQuestions ($move_questions, $target_index, $insert_mode)
	Move questions and/or questionblocks to another position. More...
	removeQuestion ($question_id)
	Remove a question from the survey. More...
	removeConstraintsConcerningQuestion ($question_id)
	Remove constraints concerning a question with a given question_id. More...
	removeQuestions ($remove_questions, $remove_questionblocks)
	Remove questions from the survey. More...
	unfoldQuestionblocks ($questionblocks)
	Unfolds question blocks of a question pool. More...
	removeQuestionFromBlock ($question_id, $questionblock_id)
	addQuestionToBlock ($question_id, $questionblock_id)
	isQuestionInAnyBlock ($a_question_fi)
	Is question already in a block? More...
&	getQuestionblockQuestions ($questionblock_id)
	Returns the question titles of all questions of a question block. More...
&	getQuestionblockQuestionIds ($questionblock_id)
	Returns the question id's of all questions of a question block. More...
	createQuestionblock ($title, $show_questiontext, $show_blocktitle, $questions)
	Creates a question block for the survey. More...
	modifyQuestionblock ($questionblock_id, $title, $show_questiontext, $show_blocktitle)
	Modifies a question block. More...
	deleteConstraints ($question_id)
	Deletes the constraints for a question. More...
	deleteConstraint ($constraint_id)
	Deletes a constraint of a question. More...
&	getSurveyQuestions ($with_answers=false)
	Returns the survey questions and questionblocks in an array. More...
	setObligatoryStates ($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 ($active_page_question_id, $direction)
	Returns the next "page" of a running test. More...
&	getAvailableQuestionpools ($use_obj_id=false, $could_be_offline=false, $showPath=false, $permission="read")
	Returns the available question pools for the active user. More...
	getPrecondition ($id)
	Returns a precondition with a given id. More...
	getConstraints ($question_id)
	Returns the constraints to a given question or questionblock. More...
&	getVariables ($question_id)
	Returns all variables of a question. More...
	addConstraint ($if_question_id, $relation, $value, $conjunction)
	Adds a constraint. More...
	addConstraintToQuestion ($to_question_id, $constraint_id)
	Adds a constraint to a question. More...
	updateConstraint ($precondition_id, $if_question_id, $relation, $value, $conjunction)
	Updates a precondition. More...
	updateConjunctionForQuestions ($questions, $conjunction)
	getAllRelations ($short_as_key=false)
	Returns all available relations. More...
	deleteWorkingData ($question_id, $active_id)
	Deletes the working data of a question in the database. More...
	loadWorkingData ($question_id, $active_id)
	Gets the working data of question from the database. More...
	startSurvey ($user_id, $anonymous_id, $appraisee_id)
	Starts the survey creating an entry in the database. More...
	finishSurvey ($finished_id)
	Finishes the survey creating an entry in the database. More...
	setPage ($finished_id, $page_id)
	Sets the number of the active survey page. More...
	sendNotificationMail ($a_user_id, $a_anonymize_id, $a_appr_id)
	isSurveyStarted ($user_id, $anonymize_id, $appr_id=0)
	Checks if a user already started a survey. More...
	getActiveID ($user_id, $anonymize_id, $appr_id)
	Checks if a user already started a survey. More...
	getLastActivePage ($active_id)
	Returns the question id of the last active page a user visited in a survey. More...
	checkConstraint ($constraint_data, $working_data)
	Checks if a constraint is valid. More...
&	getSurveyFinishedIds ()
	Get the finished id's of all survey participants. More...
	getUserSpecificResults ($finished_ids)
	Calculates the evaluation data for the user specific results. More...
	getUserDataFromActiveId ($active_id, $force_non_anonymous=false)
	Returns the user information from an active_id (survey_finished.finished_id) More...
&	getEvaluationByUser ($questions, $active_id)
	Calculates the evaluation data for a given user or anonymous id. More...
	getQuestionsTable ($arrFilter)
	Calculates the data for the output of the question browser. More...
	getQuestionblocksTable ($arrFilter)
	Calculates the data for the output of the questionblock browser. More...
	toXML ()
	Returns a QTI xml representation of the survey. More...
	locateImportFiles ($a_dir)
	Locates the import directory and the xml file in a directory with an unzipped import file. More...
	importObject ($file_info, $svy_qpl_id)
	Imports a survey from XML into the ILIAS database. More...
	getTextblock ($question_id)
	cloneTextblocks ($mapping)
	Clones the textblocks of survey questions. More...
	createExportDirectory ()
	creates data directory for export files (data_dir/svy_data/svy_<id>/export, depending on data directory that is set in ILIAS setup/ini) More...
	getExportDirectory ()
	get export directory of survey More...
	createImportDirectory ()
	creates data directory for import files (data_dir/svy_data/svy_<id>/import, depending on data directory that is set in ILIAS setup/ini) More...
	getImportDirectory ()
	get import directory of survey More...
	saveHeading ($heading="", $insertbefore)
	isAnonymousKey ($key)
	bindSurveyCodeToUser ($user_id, $code)
	isAnonymizedParticipant ($key)
	checkSurveyCode ($code)
	getSurveyCodesForExport (array $a_codes=null, array $a_ids=null)
	Returns a list of survey codes for file export. More...
	getSurveyCodesTableData (array $ids=null, $lang=null)
	Fetches the data for the survey codes table. More...
	isSurveyCodeUsed ($code)
	isSurveyCodeUnique ($code)
	createSurveyCodes ($nrOfCodes)
	importSurveyCode ($a_anonymize_key, $a_created, $a_data)
	createSurveyCodesForExternalData ($data)
	sendCodes ($not_sent, $subject, $message, $lang)
	getExternalCodeRecipients ($a_check_finished=false)
	isSurveyFinishedByCode ($a_code)
	Get if survey is finished for an specific anonymous user code. More...
	deleteSurveyCode ($survey_code)
	Deletes a given survey access code. More...
	getUserAccessCode ($user_id)
	Returns a survey access code that was saved for a registered user. More...
	saveUserAccessCode ($user_id, $access_code)
	Saves a survey access code for a registered user to the database. More...
	createNewAccessCode ()
	Returns a new, unused survey access code. More...
	getLastAccess ($finished_id)
	prepareTextareaOutput ($txt_output)
	Prepares a string for a text area output in surveys. More...
	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...
	addMaterialTag (&$a_xml_writer, $a_material, $close_material_tag=true, $add_mobs=true, $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...
	processPrintoutput2FO ($print_output)
	Convert a print output to XSL-FO. More...
	deliverPDFfromFO ($fo)
	Delivers a PDF file from a XSL-FO string. More...
	isPluginActive ($a_pname)
	Checks whether or not a question plugin with a given name is active. More...
	setSurveyId ($survey_id)
	Sets the survey id. More...
&	getUserData ($ids)
	Returns a data of all users specified by id list. More...
	getMailNotification ()
	setMailNotification ($a_notification)
	getMailAddresses ()
	setMailAddresses ($a_addresses)
	getMailParticipantData ()
	setMailParticipantData ($a_data)
	setStartTime ($finished_id, $first_question)
	setEndTime ($finished_id)
	getWorkingtimeForParticipant ($finished_id)
	setTemplate ($template_id)
	getTemplate ()
	updateOrder (array $a_order)
	getPoolUsage ()
	setPoolUsage ($a_value)
	isPoolActive ()
	Get current pool status. More...
	applySettingsTemplate ($template_id)
	Apply settings template. More...
	updateCode ($a_id, $a_email, $a_last_name, $a_first_name, $a_sent)
	get360Mode ()
	set360SelfEvaluation ($a_value)
	get360SelfEvaluation ()
	set360SelfAppraisee ($a_value)
	get360SelfAppraisee ()
	set360SelfRaters ($a_value)
	get360SelfRaters ()
	set360Results ($a_value)
	get360Results ()
	addAppraisee ($a_user_id)
	sendAppraiseeNotification ($a_user_id)
	Send appraisee notification. More...
	sendAppraiseeCloseNotification ($a_user_id)
	Send appraisee notification. More...
	sendRaterNotification ($a_user_id, $a_appraisee_id)
	Send rater notification. More...
	isAppraisee ($a_user_id)
	isAppraiseeClosed ($a_user_id)
	deleteAppraisee ($a_user_id)
	getAppraiseesData ()
	addRater ($a_appraisee_id, $a_user_id, $a_anonymous_id=0)
	isRater ($a_appraisee_id, $a_user_id, $a_anonymous_id=0)
	deleteRater ($a_appraisee_id, $a_user_id, $a_anonymous_id=0)
	getRatersData ($a_appraisee_id)
	getAppraiseesToRate ($a_user_id, $a_anonymous_id=null)
	getAnonymousIdByCode ($a_code)
	is360SurveyStarted ($appr_id, $user_id, $anonymous_code=null)
	getUserSurveyExecutionStatus ($a_code=null)
	findCodeForUser ($a_user_id)
	isUnusedCode ($a_code, $a_user_id)
	getFinishedIdsForAppraiseeId ($a_appr_id, $a_exclude_appraisee=false)
	getFinishedIdForAppraiseeIdAndRaterId ($a_appr_id, $a_rat_id)
	Get finished id for an appraisee and a rater. More...
	setSkillService ($a_val)
	Set skill service. More...
	getSkillService ()
	Get skill service. More...
	set360RaterSent ($a_appraisee_id, $a_user_id, $a_anonymous_id, $a_tstamp=null)
	closeAppraisee ($a_user_id)
	openAllAppraisees ()
	getReminderStatus ()
	setReminderStatus ($a_value)
	getReminderStart ()
	setReminderStart (ilDate $a_value=null)
	getReminderEnd ()
	setReminderEnd (ilDate $a_value=null)
	getReminderFrequency ()
	setReminderFrequency ($a_value)
	getReminderTarget ()
	setReminderTarget ($a_value)
	getReminderLastSent ()
	setReminderLastSent ($a_value)
	getReminderTemplate ($selectDefault=false)
	setReminderTemplate ($a_value)
	getTutorNotificationStatus ()
	setTutorNotificationStatus ($a_value)
	getTutorNotificationRecipients ()
	setTutorNotificationRecipients (array $a_value)
	getTutorNotificationTarget ()
	setTutorNotificationTarget ($a_value)
	getTutorResultsStatus ()
	setTutorResultsStatus ($a_value)
	getTutorResultsRecipients ()
	setTutorResultsRecipients (array $a_value)
	sent360Reminders ()
	Send 360 reminders. More...
	send360ReminderToUser ($a_user_id, $a_appraisee_ids)
	Send rater notification. More...
	getNotificationTargetUserIds ($a_use_invited)
	checkReminder ()
	setActivationStartDate ($starting_time=null)
	setActivationEndDate ($ending_time=null)
	getActivationStartDate ()
	getActivationEndDate ()
	setViewOwnResults ($a_value)
	hasViewOwnResults ()
	setMailOwnResults ($a_value)
	hasMailOwnResults ()
	setMailConfirmation ($a_value)
	hasMailConfirmation ()
	setAnonymousUserList ($a_value)
	hasAnonymousUserList ()
	setMode ($a_value)
	getMode ()
	setSelfEvaluationResults ($a_value)
	getSelfEvaluationResults ()
	sendTutorResults ()
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ()
	read object data from db into object More...
	getId ()
	get object id public More...
	setId ($a_id)
	set object id public More...
	setRefId ($a_id)
	set reference id public More...
	getRefId ()
	get reference id public More...
	getType ()
	get object type public More...
	setType ($a_type)
	set object type public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title public More...
	getUntranslatedTitle ()
	get untranslated object title public More...
	setTitle ($a_title)
	set object title More...
	getDescription ()
	get object description More...
	setDescription ($a_desc)
	set object description More...
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	get import id More...
	setImportId ($a_import_id)
	set import id More...
	setOfflineStatus ($a_status)
	Set offline status. More...
	getOfflineStatus ()
	Get offline status. More...
	supportsOfflineHandling ()
	Check whether object supports offline handling. More...
	getOwner ()
	get object owner More...
	getOwnerName ()
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date public More...
	getLastUpdateDate ()
	get last update date public More...
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	create ()
	create More...
	update ()
	update object in db More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	updateOwner ()
	update owner of object in db More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...
	cloneMetaData ($target_obj)
	Copy meta data. More...
	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_getQuestionblock ($questionblock_id)
	Returns the database row for a given question block. More...
static	_addQuestionblock ($title="", $owner=0, $show_questiontext=true, $show_blocktitle=false)
	Adds a questionblock to the database. More...
static	_getConstraints ($survey_id)
	Returns the constraints to a given question or questionblock. More...
static	_hasDatasets ($survey_id)
static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...
static	validateExternalRaterCode ($a_ref_id, $a_code)
static	getSurveySkippedValue ()
static	getSurveysWithTutorResults ()
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupImportId ($a_obj_id)
static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
static	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner ($a_id)
	lookup object owner More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id, $a_deleted_by)
static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...
static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...
static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate ($a_id)
	Lookup creation date. More...
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

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
	$survey_id
	$author
	$introduction
	$outro
	$evaluation_access
	$start_date
	$end_date
	$questions
	$anonymize
	$display_question_titles
	$surveyCodeSecurity
	$mailnotification
	$mailaddresses
	$mailparticipantdata
	$template_id
	$pool_usage
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
const	MODE_STANDARD = 0
const	MODE_360 = 1
const	MODE_SELF_EVAL = 2
const	RESULTS_SELF_EVAL_NONE = 0
const	RESULTS_SELF_EVAL_OWN = 1
const	RESULTS_SELF_EVAL_ALL = 2
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...
const	DESC_LENGTH = 128
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots

Protected Member Functions
	getParticipantTextResults ($active_id)
	checkTutorNotification ()
	sendTutorNotification ()
	sentReminderPlaceholders ($a_message, $a_user_id, array $a_context_params)

Protected Attributes
	$user
	$access
	$plugin_admin
	$log
	$activation_visibility
	$activation_starting_time
	$activation_ending_time
	$mode_360_self_eval
	$mode_360_self_appr
	$mode_360_self_rate
	$mode_360_results
	$mode_skill_service
	$reminder_status
	$reminder_start
	$reminder_end
	$reminder_frequency
	$reminder_target
	$reminder_last_sent
	$reminder_tmpl
	$tutor_ntf_status
	$tutor_ntf_recipients
	$tutor_ntf_target
	$tutor_res_status
	$tutor_res_recipients
	$view_own_results
	$mail_own_results
	$mail_confirmation
	$anon_user_list
	$mode
	$mode_self_eval_results
	$invitation_manager
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Detailed Description

Class ilObjSurvey.

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 12 of file class.ilObjSurvey.php.

Constructor & Destructor Documentation

__construct()

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

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

References $DIC, $ilUser, ilObject\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilLoggerFactory\getLogger(), and user().

    {
        global $DIC;

        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->access = $DIC->access();
        $this->log = $DIC["ilLog"];
        $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->template_id = null;
        $this->pool_usage = true;
        $this->log = ilLoggerFactory::getLogger("svy");
        $this->mode = self::MODE_STANDARD;
        $this->mode_self_eval_results = self::RESULTS_SELF_EVAL_OWN;

        $this->invitation_manager = new Participants\InvitationsManager();

        parent::__construct($a_id, $a_call_by_reference);
    }

Here is the call graph for this function:

Member Function Documentation

_addQuestionblock()

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

static

Adds a questionblock to the database.

Parameters

string	$title	The questionblock title
integer	$owner	The database id of the owner

Returns

integer The database id of the newly created questionblock public

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

References $DIC, $ilDB, ilObject\$owner, and ilObject\$title.

    {
        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) " .
            "VALUES (%s, %s, %s, %s, %s, %s)",
            array('integer','text','integer','integer','integer','integer'),
            array($next_id, $title, $show_questiontext, $show_blocktitle, $owner, time())
        );
        return $next_id;
    }

_getConstraints()

static ilObjSurvey::_getConstraints (   $survey_id )

static

Returns the constraints to a given question or questionblock.

public

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

References $DIC, $ilDB, $result, and $survey_id.

    {
        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)) {
            array_push($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 (   $questionblock_id )

static

Returns the database row for a given question block.

Parameters

integer

$questionblock_id

The database id of the question block

Returns

array The database row of the question block public

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

References $DIC, $ilDB, and $result.

Referenced by ilSurveyEvaluationGUI\evaluation(), and ilSurveyEditorGUI\initQuestionblockForm().

    {
        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;
    }

Here is the caller graph for this function:

_hasDatasets()

static ilObjSurvey::_hasDatasets (   $survey_id )

static

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

References $DIC, $ilDB, $result, and $survey_id.

Referenced by ilSurveyConstraintsGUI\constraintsObject(), ilSurveySyncTableGUI\importData(), ilObjSurveyGUI\initPropertiesForm(), ilSurveyEditorGUI\questionsObject(), ilSurveyPageGUI\renderPage(), ilObjSurveyGUI\savePropertiesObject(), and ilSurveyConstraintsGUI\validateConstraintForEdit().

    {
        global $DIC;

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

Here is the caller graph for this function:

_instanciateQuestion()

static ilObjSurvey::_instanciateQuestion (   $question_id )

static

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

Parameters

integer

$question_id

The question id

Returns

object The question instance public

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

References SurveyQuestion\_getQuestionType(), and SurveyQuestion\_includeClass().

Referenced by ilSurveyEditorGUI\copyQuestionsToPoolObject(), ilSurveyEditorGUI\executeCopyQuestionsToPoolObject(), and ilSurveyPageGUI\paste().

    {
        if ($question_id < 1) {
            return false;
        }
        $question_type = SurveyQuestion::_getQuestionType($question_id);
        if (strlen($question_type) == 0) {
            return false;
        }
        SurveyQuestion::_includeClass($question_type);
        $question = new $question_type();
        $question->loadFromDb($question_id);
        return $question;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addAppraisee()

ilObjSurvey::addAppraisee

(

$a_user_id

)

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

References $access, $DIC, $ilDB, getSurveyId(), isAppraisee(), and sendAppraiseeNotification().

    {
        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);
            }
        }
    }

Here is the call graph for this function:

addConstraint()

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

Adds a constraint.

Parameters

integer	$if_question_id	The question id of the question which defines a precondition
integer	$relation	The database id of the relation
mixed	$value	The value compared with the relation public

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

References ilObject\$db, and $ilDB.

    {
        $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	(		$to_question_id,
			$constraint_id
	)

Adds a constraint to a question.

Parameters

integer	$to_question_id	The question id of the question where to add the constraint
integer	$constraint_id	The id of the constraint

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

References ilObject\$db, $ilDB, and getSurveyId().

    {
        $ilDB = $this->db;
        
        $next_id = $ilDB->nextId('svy_qst_constraint');
        $affectedRows = $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)
        );
    }

Here is the call graph for this function:

addMaterialTag()

ilObjSurvey::addMaterialTag	(	&	$a_xml_writer,
			$a_material,
			$close_material_tag = true,
			$add_mobs = true,
			$attribs = null
	)

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

Parameters

object	$a_xml_writer	Reference to the ILIAS XML writer
string	$a_material	plain text or html text containing the material

Returns

string XML material tag public

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

References $mobs, ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), ilObject\getId(), and isHTML().

Referenced by toXML().

    {
        $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");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addQuestion()

ilObjSurvey::addQuestion

(

$question_id

)

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

Parameters

integer

$question_id

The question id of the question public

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

    {
        array_push($this->questions, $question_id);
    }

addQuestionToBlock()

ilObjSurvey::addQuestionToBlock	(		$question_id,
			$questionblock_id
	)

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

References ilObject\$db, $ilDB, deleteConstraints(), getSurveyId(), and isQuestionInAnyBlock().

    {
        $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
        }
    }

Here is the call graph for this function:

addRater()

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

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

References $access, $DIC, $ilDB, getSurveyId(), isAppraisee(), isRater(), and sendRaterNotification().

    {
        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())) {
                $this->sendRaterNotification($a_user_id, $a_appraisee_id);
            }
        }
    }

Here is the call graph for this function:

applySettingsTemplate()

ilObjSurvey::applySettingsTemplate

(

$template_id

)

Apply settings template.

Parameters

int

$template_id

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

References $_POST, $template_id, ANONYMIZE_CODE_ALL, ANONYMIZE_FREEACCESS, ANONYMIZE_OFF, ANONYMIZE_ON, saveToDb(), setAnonymize(), setAnonymousUserList(), setEvaluationAccess(), setPoolUsage(), setShowQuestionTitles(), and setTemplate().

    {
        if (!$template_id) {
            return;
        }
        
        $template = new ilSettingsTemplate($template_id);
        $template_settings = $template->getSettings();
        //ilUtil::dumpVar($template_settings); exit;
        if ($template_settings) {
            if ($template_settings["show_question_titles"] !== null) {
                if ($template_settings["show_question_titles"]["value"]) {
                    $this->setShowQuestionTitles(true);
                } else {
                    $this->setShowQuestionTitles(false);
                }
            }

            if ($template_settings["use_pool"] !== null) {
                if ($template_settings["use_pool"]["value"]) {
                    $this->setPoolUsage(true);
                } else {
                    $this->setPoolUsage(false);
                }
            }


            /* see #0021719
            if($template_settings["anonymization_options"]["value"])
            {
                $anon_map = array('personalized' => self::ANONYMIZE_OFF,
                    'anonymize_with_code' => self::ANONYMIZE_ON,
                    'anonymize_without_code' => self::ANONYMIZE_FREEACCESS);
                $this->setAnonymize($anon_map[$template_settings["anonymization_options"]["value"]]);
            }*/

            // see #0021719 and ilObjectSurveyGUI::savePropertiesObject
            $this->setEvaluationAccess($template_settings["evaluation_access"]["value"]);
            $codes = (bool) $template_settings["acc_codes"]["value"];
            $anon = (bool) $template_settings["anonymization_options"]["value"];
            if (!$anon) {
                if (!$codes) {
                    $this->setAnonymize(ilObjSurvey::ANONYMIZE_OFF);
                } else {
                    $this->setAnonymize(ilObjSurvey::ANONYMIZE_CODE_ALL);
                }
            } else {
                if ($codes) {
                    $this->setAnonymize(ilObjSurvey::ANONYMIZE_ON);
                } else {
                    $this->setAnonymize(ilObjSurvey::ANONYMIZE_FREEACCESS);
                }

                $this->setAnonymousUserList($_POST["anon_list"]);
            }



            /* other settings: not needed here
             * - enabled_end_date
             * - enabled_start_date
             * - rte_switch
             */
        }

        $this->setTemplate($template_id);
        $this->saveToDb();
    }

Here is the call graph for this function:

bindSurveyCodeToUser()

ilObjSurvey::bindSurveyCodeToUser	(		$user_id,
			$code
	)

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

References ilObject\$db, $ilDB, and checkSurveyCode().

    {
        $ilDB = $this->db;
        
        if ($user_id == ANONYMOUS_USER_ID) {
            return;
        }
        
        if ($this->checkSurveyCode($code)) {
            $ilDB->manipulate("UPDATE svy_anonymous" .
                " SET user_key = " . $ilDB->quote(md5($user_id), "text") .
                " WHERE survey_key = " . $ilDB->quote($code, "text"));
        }
    }

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

boolean TRUE if the survey is anonymized and the survey code may be shown in the export file

Author

Helmut Schottmüller

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

References getAnonymize().

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

Here is the call graph for this function:

canStartSurvey()

ilObjSurvey::canStartSurvey	(		$anonymous_id = null,
			$a_no_rbac = false
	)

Checks if the survey can be started.

Returns

array An array containing the following keys: result (boolean) and messages (array) public

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

References $access, $messages, $result, ilDatePresentation\formatDate(), getEndDate(), ilObject\getOfflineStatus(), getStartDate(), and IL_CAL_TIMESTAMP.

    {
        $ilAccess = $this->access;
        
        $result = true;
        $messages = array();
        $edit_settings = false;
        // check start date
        if (preg_match("/(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/", $this->getStartDate(), $matches)) {
            $epoch_time = mktime($matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1]);
            $now = time();
            if ($now < $epoch_time) {
                array_push($messages, $this->lng->txt('start_date_not_reached') . ' (' .
                    ilDatePresentation::formatDate(new ilDateTime($this->getStartDate(), IL_CAL_TIMESTAMP)) . ")");
                $result = false;
                $edit_settings = true;
            }
        }
        // check end date
        if (preg_match("/(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/", $this->getEndDate(), $matches)) {
            $epoch_time = mktime($matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1]);
            $now = time();
            if ($now > $epoch_time) {
                array_push($messages, $this->lng->txt('end_date_reached') . ' (' .
                    ilDatePresentation::formatDate(new ilDateTime($this->getEndDate(), IL_CAL_TIMESTAMP)) . ")");
                $result = false;
                $edit_settings = true;
            }
        }
        
        // check online status
        if ($this->getOfflineStatus()) {
            array_push($messages, $this->lng->txt("survey_is_offline"));
            $result = false;
            $edit_settings = true;
        }
        // check rbac permissions
        if (!$a_no_rbac && !$ilAccess->checkAccess("read", "", $this->ref_id)) {
            array_push($messages, $this->lng->txt("cannot_participate_survey"));
            $result = false;
        }
        /*
        // 2. check previous access
        if (!$result["error"])
        {
        $ilUser = $this->user;
            $survey_started = $this->isSurveyStarted($ilUser->getId(), $anonymous_id);
            if ($survey_started === 1)
            {
                array_push($messages, $this->lng->txt("already_completed_survey"));
                $result = FALSE;
            }
        }
        */
        return array(
            "result" => $result,
            "messages" => $messages,
            "edit_settings" => $edit_settings
        );
    }

Here is the call graph for this function:

checkConstraint()

ilObjSurvey::checkConstraint	(		$constraint_data,
			$working_data
	)

Checks if a constraint is valid.

Parameters

array	$constraint_data	The database row containing the constraint data
array	$working_data	The user input of the related question

Returns

boolean true if the constraint is valid, otherwise false public

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

References $data.

    {
        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 5795 of file class.ilObjSurvey.php.

References $access, ilObject\$db, $DIC, $ilDB, $message, ilLanguageFactory\_getLanguageOfUser(), ilLink\_getStaticLink(), ilObjUser\_lookupFullname(), ilObjUser\_lookupLogin(), get360Mode(), getEndDate(), ilObject\getId(), ilObjectActivation\getItem(), getNotificationTargetUserIds(), ilObject\getOfflineStatus(), ilObject\getRefId(), getReminderEnd(), getReminderFrequency(), getReminderLastSent(), getReminderStart(), getReminderStatus(), getReminderTarget(), getReminderTemplate(), getStartDate(), ilObject\getTitle(), IL_CAL_DATE, IL_CAL_DAY, saveToDb(), sent360Reminders(), sentReminderPlaceholders(), setReminderLastSent(), and ilObjectActivation\TIMINGS_ACTIVATION.

    {
        $ilDB = $this->db;
        $ilAccess = $this->access;
        
        $now = time();
        $now_with_format = date("YmdHis", $now);
        $today = date("Y-m-d");

        $this->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 false;
        }
                        
        // 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 false;
        }

        $this->log->debug("Check access period.");

        // object access period
        $item_data = ilObjectActivation::getItem($this->getRefId());
        if ($item_data["timing_type"] == ilObjectActivation::TIMINGS_ACTIVATION &&
            ($now < $item_data["timing_start"] ||
            $now > $item_data["timing_end"])) {
            return false;
        }

        $this->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->get360Mode()) {
                $this->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->log->debug("Entering 360 mode.");

                $this->sent360Reminders();
            }


            $this->setReminderLastSent($today);
            $this->saveToDb();

            return sizeof($missing_ids);
        }
        
        return false;
    }

Here is the call graph for this function:

checkSurveyCode()

ilObjSurvey::checkSurveyCode

(

$code

)

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

References isAnonymousKey(), and isSurveyStarted().

Referenced by bindSurveyCodeToUser().

    {
        if ($this->isAnonymousKey($code)) {
            if ($this->isSurveyStarted("", $code) == 1) {
                return false;
            } else {
                return true;
            }
        } else {
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkTutorNotification()

ilObjSurvey::checkTutorNotification ( )

protected

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

References ilObject\$db, $ilDB, getNotificationTargetUserIds(), getTutorNotificationStatus(), getTutorNotificationTarget(), and sendTutorNotification().

Referenced by finishSurvey().

    {
        $ilDB = $this->db;
        
        if ($this->getTutorNotificationStatus()) {
            $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);
                if ($row["numall"] == sizeof($user_ids)) {
                    $this->sendTutorNotification();
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneTextblocks()

ilObjSurvey::cloneTextblocks

(

$mapping

)

Clones the textblocks of survey questions.

public

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

References ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), getTextblock(), saveHeading(), and ilUtil\stripSlashes().

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

Here is the call graph for this function:

closeAppraisee()

ilObjSurvey::closeAppraisee

(

$a_user_id

)

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

References $DIC, $ilDB, $user, getSkillService(), getSurveyId(), and sendAppraiseeCloseNotification().

    {
        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);
        }
    }

Here is the call graph for this function:

create()

ilObjSurvey::create

(

$a_upload = false

)

create survey object

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

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

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

Here is the call graph for this function:

createExportDirectory()

ilObjSurvey::createExportDirectory

(

)

creates data directory for export files (data_dir/svy_data/svy_<id>/export, depending on data directory that is set in ILIAS setup/ini)

Exceptions

ilSurveyException

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

References ilUtil\getDataDir(), ilObject\getId(), and ilUtil\makeDir().

    {
        $svy_data_dir = ilUtil::getDataDir() . "/svy_data";
        ilUtil::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();
        ilUtil::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";
        ilUtil::makeDir($export_dir);
        if (!@is_dir($export_dir)) {
            throw new ilSurveyException("Creation of Export Directory failed.");
        }
    }

Here is the call graph for this function:

createImportDirectory()

ilObjSurvey::createImportDirectory

(

)

creates data directory for import files (data_dir/svy_data/svy_<id>/import, depending on data directory that is set in ILIAS setup/ini)

Exceptions

ilSurveyException

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

References ilUtil\getDataDir(), ilObject\getId(), and ilUtil\makeDir().

    {
        $svy_data_dir = ilUtil::getDataDir() . "/svy_data";
        ilUtil::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();
        ilUtil::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";
        ilUtil::makeDir($import_dir);
        if (!@is_dir($import_dir)) {
            throw new ilSurveyException("Creation of Import Directory failed.");
        }
    }

Here is the call graph for this function:

createMetaData()

ilObjSurvey::createMetaData

(

)

Create meta data entry.

public

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

References saveAuthorToMetadata().

Referenced by create().

    {
        parent::createMetaData();
        $this->saveAuthorToMetadata();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createNewAccessCode()

ilObjSurvey::createNewAccessCode

(

)

Returns a new, unused survey access code.

Returns

string A new survey access code

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

References $i, $index, and isSurveyCodeUnique().

Referenced by createSurveyCodes(), createSurveyCodesForExternalData(), and getUserSurveyExecutionStatus().

    {
        // create a 5 character code
        $codestring = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
        mt_srand();
        $code = "";
        for ($i = 1; $i <= 5; $i++) {
            $index = mt_rand(0, strlen($codestring) - 1);
            $code .= substr($codestring, $index, 1);
        }
        // verify it against the database
        while (!$this->isSurveyCodeUnique($code)) {
            $code = $this->createNewAccessCode();
        }
        return $code;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createQuestionblock()

ilObjSurvey::createQuestionblock	(		$title,
			$show_questiontext,
			$show_blocktitle,
			$questions
	)

Creates a question block for the survey.

Parameters

string	$title	The title of the question block
array	$questions	An array with the database id's of the question block questions public

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

References ilObject\$db, $ilDB, $ilUser, $index, $questions, ilObject\$title, $user, deleteConstraints(), getSurveyId(), isQuestionInAnyBlock(), and moveQuestions().

Referenced by insertQuestionblock().

    {
        $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) VALUES (%s, %s, %s, %s, %s, %s)",
            array('integer','text','text','text','integer','integer'),
            array($next_id, $title, $show_questiontext, $show_blocktitle, $ilUser->getId(), time())
        );
        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);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createReference()

ilObjSurvey::createReference

(

)

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

References $result, and saveToDb().

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

Here is the call graph for this function:

createSurveyCodes()

ilObjSurvey::createSurveyCodes

(

$nrOfCodes

)

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

References ilObject\$db, $i, $ilDB, $res, createNewAccessCode(), and getSurveyId().

    {
        $ilDB = $this->db;
        
        $res = array();
        
        for ($i = 0; $i < $nrOfCodes; $i++) {
            $next_id = $ilDB->nextId('svy_anonymous');
            $ilDB->manipulateF(
                "INSERT INTO svy_anonymous (anonymous_id, survey_key, survey_fi, tstamp) " .
                "VALUES (%s, %s, %s, %s)",
                array('integer','text','integer','integer'),
                array($next_id, $this->createNewAccessCode(), $this->getSurveyId(), time())
            );
            $res[] = $next_id;
        }
        
        return $res;
    }

Here is the call graph for this function:

createSurveyCodesForExternalData()

ilObjSurvey::createSurveyCodesForExternalData

(

$data

)

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

References $data, ilObject\$db, $ilDB, createNewAccessCode(), and getSurveyId().

    {
        $ilDB = $this->db;
        
        $ids = array();
        foreach ($data as $dataset) {
            $anonymize_key = $this->createNewAccessCode();
            $next_id = $ilDB->nextId('svy_anonymous');
            $affectedRows = $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, $anonymize_key, $this->getSurveyId(), serialize($dataset), time())
            );
            $ids[] = $next_id;
        }
        return $ids;
    }

Here is the call graph for this function:

delete()

ilObjSurvey::delete

(

)

delete object and all related data

public

Returns

boolean true if all object data were removed; false if only a references were removed

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

References ilObject\countReferences(), ilUtil\delDir(), ilObject\deleteMetaData(), deleteSurveyRecord(), getImportDirectory(), and removeQuestion().

    {
        if ($this->countReferences() == 1) {
            $this->deleteMetaData();

            // Delete all survey questions, constraints and materials
            foreach ($this->questions as $question_id) {
                $this->removeQuestion($question_id);
            }
            $this->deleteSurveyRecord();

            ilUtil::delDir($this->getImportDirectory());
        }

        $remove = parent::delete();

        // always call parent delete function first!!
        if (!$remove) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

deleteAllUserData()

ilObjSurvey::deleteAllUserData

(

$reset_LP = true

)

Deletes all user data of a survey.

public

Parameters

bool

$reset_LP

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

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

References ilObject\$db, $ilDB, $result, ilObject\getId(), ilObjectLP\getInstance(), and getSurveyId().

Referenced by deleteSurveyRecord().

    {
        $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)) {
            array_push($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();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAppraisee()

ilObjSurvey::deleteAppraisee

(

$a_user_id

)

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

References ilObject\$db, $ilDB, deleteRater(), and get360SelfEvaluation().

    {
        $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);
        }
    }

Here is the call graph for this function:

deleteConstraint()

ilObjSurvey::deleteConstraint

(

$constraint_id

)

Deletes a constraint of a question.

Parameters

integer	$constraint_id	The database id of the constraint
integer	$question_id	The database id of the question public

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

References ilObject\$db, and $ilDB.

Referenced by deleteConstraints(), and moveQuestions().

    {
        $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)
        );
    }

Here is the caller graph for this function:

deleteConstraints()

ilObjSurvey::deleteConstraints

(

$question_id

)

Deletes the constraints for a question.

Parameters

integer

$question_id

The database id of the question public

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

References ilObject\$db, $ilDB, $result, deleteConstraint(), and getSurveyId().

Referenced by addQuestionToBlock(), and createQuestionblock().

    {
        $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)) {
            array_push($constraints, $row["constraint_fi"]);
        }
        foreach ($constraints as $constraint_id) {
            $this->deleteConstraint($constraint_id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteRater()

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

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

References ilObject\$db, $ilDB, getFinishedIdForAppraiseeIdAndRaterId(), and removeSelectedSurveyResults().

Referenced by deleteAppraisee().

    {
        $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"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteSurveyCode()

ilObjSurvey::deleteSurveyCode

(

$survey_code

)

Deletes a given survey access code.

Parameters

string

$survey_code

The survey code that should be deleted

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

References ilObject\$db, $ilDB, and getSurveyId().

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

Here is the call graph for this function:

deleteSurveyRecord()

ilObjSurvey::deleteSurveyRecord

(

)

Deletes the survey from the database.

public

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

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

Referenced by delete().

    {
        $ilDB = $this->db;
        
        $affectedRows = $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)) {
            array_push($questionblocks, $row["questionblock_fi"]);
        }
        if (count($questionblocks)) {
            $affectedRows = $ilDB->manipulate("DELETE FROM svy_qblk WHERE " . $ilDB->in('questionblock_id', $questionblocks, false, 'integer'));
        }
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_qblk_qst WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        $this->deleteAllUserData(false);

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_anonymous WHERE survey_fi = %s",
            array('integer'),
            array($this->getSurveyId())
        );
        
        // delete export files
        $svy_data_dir = ilUtil::getDataDir() . "/svy_data";
        $directory = $svy_data_dir . "/svy_" . $this->getId();
        if (is_dir($directory)) {
            ilUtil::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();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteUserSettings()

ilObjSurvey::deleteUserSettings

(

$id

)

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

References ilObject\$db, ilObject\$id, and $ilDB.

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

deleteWorkingData()

ilObjSurvey::deleteWorkingData	(		$question_id,
			$active_id
	)

Deletes the working data of a question in the database.

Parameters

integer	$question_id	The database id of the question
integer	$active_id	The active id of the user who worked through the question public

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

References ilObject\$db, and $ilDB.

    {
        $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)
        );
    }

deliverPDFfromFO()

ilObjSurvey::deliverPDFfromFO

(

$fo

)

Delivers a PDF file from a XSL-FO string.

Parameters

string

$fo

The XSL-FO string public

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

References Vendor\Package\$e, $ilLog, $log, ilUtil\deliverData(), ilRpcClientFactory\factory(), ilUtil\getASCIIFilename(), and ilUtil\ilTempnam().

    {
        $ilLog = $this->log;

        $fo_file = ilUtil::ilTempnam() . ".fo";
        $fp = fopen($fo_file, "w");
        fwrite($fp, $fo);
        fclose($fp);

        try {
            $pdf_base64 = ilRpcClientFactory::factory('RPCTransformationHandler')->ilFO2PDF($fo);
            ilUtil::deliverData($pdf_base64->scalar, ilUtil::getASCIIFilename($this->getTitle()) . ".pdf", "application/pdf");
            return true;
        } catch (Exception $e) {
            $ilLog->write(__METHOD__ . ': ' . $e->getMessage());
            return false;
        }
    }

Here is the call graph for this function:

duplicateQuestionForSurvey()

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

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

Parameters

integer

$question_id

The database id of the question

Returns

integer The database id of the copied question public

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

References $ilUser, $user, ilObject\getId(), getQuestionGUI(), and getQuestionType().

Referenced by insertQuestion(), and insertQuestionblock().

    {
        $ilUser = $this->user;
        
        $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, "", "", "", $this->getId());
        return $duplicate_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findCodeForUser()

ilObjSurvey::findCodeForUser

(

$a_user_id

)

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

References ilObject\$db, and $ilDB.

    {
        $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 $a_code["anonymous_id"];
        }
    }

finishSurvey()

ilObjSurvey::finishSurvey

(

$finished_id

)

Finishes the survey creating an entry in the database.

Parameters

integer

$user_id

The database id of the user who finishes the survey public

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

References ilObject\$db, $ilDB, $user, checkTutorNotification(), getMode(), getSurveyId(), getUserDataFromActiveId(), and MODE_SELF_EVAL.

    {
        $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() == ilObjSurvey::MODE_SELF_EVAL) {
            $user = $this->getUserDataFromActiveId($finished_id);
            $sskill = new ilSurveySkill($this);
            $sskill->writeAndAddSelfEvalSkills($user['usr_id']);
        }

        $this->checkTutorNotification();
    }

Here is the call graph for this function:

fixSequenceStructure()

ilObjSurvey::fixSequenceStructure

(

)

Remove duplicate sequence entries, see #22018.

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

References $data, $DIC, $ilDB, $result, and getSurveyId().

    {
        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->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->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->log->debug("update: " . $q);
        }
    }

Here is the call graph for this function:

get360Mode()

ilObjSurvey::get360Mode

(

)

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

References getMode(), and MODE_360.

Referenced by checkReminder(), getUserDataFromActiveId(), getUserSurveyExecutionStatus(), and importObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

get360Results()

ilObjSurvey::get360Results

(

)

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

References $mode_360_results.

Referenced by importObject(), saveToDb(), and toXML().

    {
        return (int) $this->mode_360_results;
    }

Here is the caller graph for this function:

get360SelfAppraisee()

ilObjSurvey::get360SelfAppraisee

(

)

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

References $mode_360_self_appr.

Referenced by importObject(), saveToDb(), sent360Reminders(), and toXML().

    {
        return (bool) $this->mode_360_self_appr;
    }

Here is the caller graph for this function:

get360SelfEvaluation()

ilObjSurvey::get360SelfEvaluation

(

)

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

References $mode_360_self_eval.

Referenced by deleteAppraisee(), getAppraiseesToRate(), importObject(), isRater(), saveToDb(), sent360Reminders(), and toXML().

    {
        return (bool) $this->mode_360_self_eval;
    }

Here is the caller graph for this function:

get360SelfRaters()

ilObjSurvey::get360SelfRaters

(

)

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

References $mode_360_self_rate.

Referenced by importObject(), saveToDb(), and toXML().

    {
        return (bool) $this->mode_360_self_rate;
    }

Here is the caller graph for this function:

getActivationEndDate()

ilObjSurvey::getActivationEndDate

(

)

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

Referenced by saveToDb().

    {
        return (strlen($this->activation_ending_time)) ? $this->activation_ending_time : null;
    }

Here is the caller graph for this function:

getActivationStartDate()

ilObjSurvey::getActivationStartDate

(

)

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

Referenced by saveToDb().

    {
        return (strlen($this->activation_starting_time)) ? $this->activation_starting_time : null;
    }

Here is the caller graph for this function:

getActivationVisibility()

ilObjSurvey::getActivationVisibility

(

)

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

References $activation_visibility.

Referenced by saveToDb().

    {
        return $this->activation_visibility;
    }

Here is the caller graph for this function:

getActiveID()

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

Checks if a user already started a survey.

Parameters

integer

$user_id

The database id of the user

Returns

mixed false, if the user has not started the survey, 0 if the user has started the survey but not finished it, 1 if the user has finished the survey public

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

Referenced by sendNotificationMail().

    {
        $ilDB = $this->db;

        // see self::isSurveyStarted()
        
        // #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 {
            $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 false;
        } else {
            $row = $ilDB->fetchAssoc($result);
            return $row["finished_id"];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllRelations()

ilObjSurvey::getAllRelations

(

$short_as_key = false

)

Returns all available relations.

public

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

References ilObject\$db, $ilDB, $result, and ilUtil\sortArray().

    {
        $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 = ilUtil::sortArray($result_array, "order", "ASC", true, true);
        foreach ($result_array as $idx => $item) {
            unset($result_array[$idx]["order"]);
        }
        
        return $result_array;
    }

Here is the call graph for this function:

getAnonymize()

ilObjSurvey::getAnonymize

(

)

get anonymize status

Returns

integer status

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

Referenced by canExportSurveyCode(), getUserSurveyExecutionStatus(), hasAnonymizedResults(), importObject(), isAccessibleWithoutCode(), saveToDb(), startSurvey(), and toXML().

    {
        return ($this->anonymize) ? $this->anonymize : 0;
    }

Here is the caller graph for this function:

getAnonymousId()

ilObjSurvey::getAnonymousId

(

$id

)

Checks for an anomyous survey id in the database an returns the id.

Parameters

string

$id

A survey access code

Returns

object Anonymous survey id if found, empty string otherwise public

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

References ilObject\$db, ilObject\$id, $ilDB, and $result.

    {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT anonymous_id FROM svy_finished WHERE anonymous_id = %s",
            array('text'),
            array($id)
        );
        if ($result->numRows()) {
            $row = $ilDB->fetchAssoc($result);
            return $row["anonymous_id"];
        } else {
            return "";
        }
    }

getAnonymousIdByCode()

ilObjSurvey::getAnonymousIdByCode

(

$a_code

)

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

References ilObject\$db, $ilDB, and $res.

    {
        $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"];
    }

getAppraiseesData()

ilObjSurvey::getAppraiseesData

(

)

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

References ilObject\$db, $ilDB, $name, $res, ilObjUser\_lookupEmail(), ilObjUser\_lookupName(), and getRatersData().

Referenced by sent360Reminders().

    {
        $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 . "/" . sizeof($raters);
            $res[$row["user_id"]]["closed"] = $row["has_closed"];
        }
        
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAppraiseesToRate()

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

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

References ilObject\$db, $ilDB, $res, get360SelfEvaluation(), getSurveyId(), and isAppraisee().

    {
        $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[] = $row["appr_id"];
        }
                
        // user may evaluate himself if already appraisee
        if ($this->get360SelfEvaluation() &&
            $this->isAppraisee($a_user_id) &&
            !in_array($a_user_id, $res)) {
            $res[] = $a_user_id;
        }
        
        return $res;
    }

Here is the call graph for this function:

getAuthor()

ilObjSurvey::getAuthor

(

)

Gets the authors name of the ilObjSurvey object.

Returns

string The string containing the name of the test author public

See also

$author

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

References $author, ilObject\$id, ilObject\getId(), and ilObject\getType().

Referenced by importObject(), saveToDb(), and toXML().

    {
        $author = array();
        $md = new ilMD($this->getId(), 0, $this->getType());
        $md_life = &$md->getLifecycle();
        if ($md_life) {
            $ids = &$md_life->getContributeIds();
            foreach ($ids as $id) {
                $md_cont = &$md_life->getContribute($id);
                if (strcmp($md_cont->getRole(), "Author") == 0) {
                    $entids = &$md_cont->getEntityIds();
                    foreach ($entids as $entid) {
                        $md_ent = &$md_cont->getEntity($entid);
                        array_push($author, $md_ent->getEntity());
                    }
                }
            }
        }
        return join(",", $author);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailableQuestionpools()

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

Returns the available question pools for the active user.

Returns

array The available question pools public

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

References ilObjSurveyQuestionPool\_getAvailableQuestionpools().

Referenced by getQuestionsTable().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getConstraints()

ilObjSurvey::getConstraints

(

$question_id

)

Returns the constraints to a given question or questionblock.

public

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

References ilObject\$db, $ilDB, $result, SurveyQuestion\_getQuestionType(), SurveyQuestion\_includeClass(), and getSurveyId().

Referenced by getSurveyPages(), getSurveyQuestions(), SurveyConstraintsTableGUI\initItems(), and moveQuestions().

    {
        $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"]);
            array_push($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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEndDate()

ilObjSurvey::getEndDate

(

)

Gets the end date of the survey.

Returns

string Survey end date (YYYY-MM-DD) public

See also

$end_date

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

Referenced by canStartSurvey(), checkReminder(), importObject(), saveToDb(), and toXML().

    {
        return (strlen($this->end_date)) ? $this->end_date : null;
    }

Here is the caller graph for this function:

getEvaluationAccess()

ilObjSurvey::getEvaluationAccess

(

)

Gets the learners evaluation access.

Returns

integer The evaluation access public

See also

$evaluation_access

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

Referenced by importObject(), saveToDb(), and toXML().

    {
        return ($this->evaluation_access) ? $this->evaluation_access : self::EVALUATION_ACCESS_OFF;
    }

Here is the caller graph for this function:

getEvaluationByUser()

& ilObjSurvey::getEvaluationByUser	(		$questions,
			$active_id
	)

Calculates the evaluation data for a given user or anonymous id.

Parameters

array	$questions	An array containing all relevant information on the survey's questions
integer	$user_id	The database id of the user
string	$anonymous_id	The unique anonymous id for an anonymous survey

Returns

array An array containing the evaluation parameters for the user public

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

References ilObject\$db, $ilDB, $questions, $result, and getUserDataFromActiveId().

    {
        $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();
            }
            array_push($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;
    }

Here is the call graph for this function:

getExistingQuestions()

& ilObjSurvey::getExistingQuestions

(

)

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

Returns

array The questions of the survey public

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

References $data, ilObject\$db, $ilDB, $result, and getSurveyId().

Referenced by getQuestionsTable().

    {
        $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"]) {
                array_push($existing_questions, $data["original_id"]);
            }
        }
        return $existing_questions;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExportDirectory()

ilObjSurvey::getExportDirectory

(

)

get export directory of survey

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

References ilUtil\getDataDir(), and ilObject\getId().

    {
        $export_dir = ilUtil::getDataDir() . "/svy_data" . "/svy_" . $this->getId() . "/export";

        return $export_dir;
    }

Here is the call graph for this function:

getExternalCodeRecipients()

ilObjSurvey::getExternalCodeRecipients

(

$a_check_finished = false

)

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

References ilObject\$db, $ilDB, $res, $result, getSurveyId(), and isSurveyFinishedByCode().

Referenced by sendCodes().

    {
        $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($row['externaldata']);
            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']);
            }
            
            array_push($res, $externaldata);
        }
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFinishedIdForAppraiseeIdAndRaterId()

ilObjSurvey::getFinishedIdForAppraiseeIdAndRaterId	(		$a_appr_id,
			$a_rat_id
	)

Get finished id for an appraisee and a rater.

Parameters

int	$a_appraisee_id	appraisee id
int	$a_rater_id	rater id

Returns

int finished id

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

References ilObject\$db, and $ilDB.

Referenced by deleteRater().

    {
        $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"));
        $row = $ilDB->fetchAssoc($set);
        return $row["finished_id"];
    }

Here is the caller graph for this function:

getFinishedIdsForAppraiseeId()

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

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

References ilObject\$db, $ilDB, and $res.

    {
        $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[] = $row["finished_id"];
        }
        
        return $res;
    }

getImportDirectory()

ilObjSurvey::getImportDirectory

(

)

get import directory of survey

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

References ilUtil\getDataDir(), ilObject\getId(), and ilUtil\makeDirParents().

Referenced by delete(), and importObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getIntroduction()

ilObjSurvey::getIntroduction

(

)

Gets the introduction text.

Returns

string The introduction of the survey object public

See also

$introduction

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

Referenced by importObject(), saveToDb(), and toXML().

    {
        return (strlen($this->introduction)) ? $this->introduction : null;
    }

Here is the caller graph for this function:

getLastAccess()

ilObjSurvey::getLastAccess

(

$finished_id

)

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

References ilObject\$db, $ilDB, and $result.

    {
        $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 $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 $row["tstamp"];
            }
        }
        return "";
    }

getLastActivePage()

ilObjSurvey::getLastActivePage

(

$active_id

)

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

Parameters

integer

$active_id

The active id of the user

Returns

mixed Empty string if the user has not worked through a page, question id of the last page otherwise public

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

References ilObject\$db, $ilDB, and $result.

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

getMailAddresses()

ilObjSurvey::getMailAddresses

(

)

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

References $mailaddresses.

Referenced by importObject(), and saveToDb().

    {
        return $this->mailaddresses;
    }

Here is the caller graph for this function:

getMailNotification()

ilObjSurvey::getMailNotification

(

)

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

References $mailnotification.

Referenced by importObject(), and saveToDb().

    {
        return $this->mailnotification;
    }

Here is the caller graph for this function:

getMailParticipantData()

ilObjSurvey::getMailParticipantData

(

)

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

References $mailparticipantdata.

Referenced by importObject(), and saveToDb().

    {
        return $this->mailparticipantdata;
    }

Here is the caller graph for this function:

getMode()

ilObjSurvey::getMode

(

)

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

References $mode.

Referenced by finishSurvey(), get360Mode(), importObject(), saveToDb(), and toXML().

    {
        return $this->mode;
    }

Here is the caller graph for this function:

getNextPage()

ilObjSurvey::getNextPage	(		$active_page_question_id,
			$direction
	)

Returns the next "page" of a running test.

Parameters

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

Returns

mixed An array containing the question id's of the questions on the next page if there is a next page, 0 if the next page is before the start page, 1 if the next page is after the last page public

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

References getSurveyPages().

    {
        $foundpage = -1;
        $pages = &$this->getSurveyPages();
        if (strcmp($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) {
            // error: page not found
        } else {
            $foundpage += $direction;
            if ($foundpage < 0) {
                return 0;
            }
            if ($foundpage >= count($pages)) {
                return 1;
            }
            return $pages[$foundpage];
        }
    }

Here is the call graph for this function:

getNotificationTargetUserIds()

ilObjSurvey::getNotificationTargetUserIds

(

$a_use_invited

)

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

References ilObject\$tree, ilObject\_lookupObjId(), ilObject\getRefId(), and getSurveyId().

Referenced by checkReminder(), and checkTutorNotification().

    {
        $tree = $this->tree;

        if ((bool) $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOutro()

ilObjSurvey::getOutro

(

)

Gets the outro text.

Returns

string The outro of the survey object public

See also

$outro

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

Referenced by importObject(), saveToDb(), and toXML().

    {
        return (strlen($this->outro)) ? $this->outro : null;
    }

Here is the caller graph for this function:

getParticipantTextResults()

ilObjSurvey::getParticipantTextResults (   $active_id )

protected

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

References $questions, getSurveyQuestions(), and getUserSpecificResults().

Referenced by sendNotificationMail().

    {
        $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 (strlen($text) == 0) {
                $text = self::getSurveySkippedValue();
            }
            $text = str_replace("<br />", "\n", $text);
            $textresult .= $text . "\n\n";
        }
        return $textresult;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPoolUsage()

ilObjSurvey::getPoolUsage

(

)

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

References $pool_usage.

Referenced by importObject(), isPoolActive(), saveToDb(), and toXML().

    {
        return $this->pool_usage;
    }

Here is the caller graph for this function:

getPrecondition()

ilObjSurvey::getPrecondition

(

$id

)

Returns a precondition with a given id.

public

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

References ilObject\$db, ilObject\$id, $ilDB, and $result.

    {
        $ilDB = $this->db;
        
        $result_array = array();
        $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($id)
        );
        $pc = array();
        if ($result->numRows()) {
            $pc = $ilDB->fetchAssoc($result);
        }
        return $pc;
    }

getQuestionblockQuestionIds()

& ilObjSurvey::getQuestionblockQuestionIds

(

$questionblock_id

)

Returns the question id's of all questions of a question block.

Returns

array The id's of the the question block questions public

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

References $data, ilObject\$db, $ilDB, and $result.

    {
        $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
                    array_push($ids, $data['question_fi']);
                }
            }
        }

        return $ids;
    }

getQuestionblockQuestions()

& ilObjSurvey::getQuestionblockQuestions

(

$questionblock_id

)

Returns the question titles of all questions of a question block.

Returns

array The titles of the the question block questions public

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

References ilObject\$db, $ilDB, $result, and $survey_id.

Referenced by getQuestionblocksTable().

    {
        $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;
    }

Here is the caller graph for this function:

getQuestionblocksTable()

ilObjSurvey::getQuestionblocksTable

(

$arrFilter

)

Calculates the data for the output of the questionblock browser.

public

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

References ilObject\$db, $ilDB, $ilUser, $rows, $survey_id, $user, ilUtil\_getObjectsByOperations(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), and getQuestionblockQuestions().

    {
        $ilUser = $this->user;
        $ilDB = $this->db;
        
        $where = "";
        if (is_array($arrFilter)) {
            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" => join(", ", $questions_array),
                        "owner" => $row["owner_fi"]
                    );
                }
            }
        }
        return $rows;
    }

Here is the call graph for this function:

getQuestionGUI()

ilObjSurvey::getQuestionGUI	(		$questiontype,
			$question_id
	)

Returns a question gui object to a given questiontype and question id.

Returns

object Resulting question gui object public

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

References SurveyQuestionGUI\_getQuestionGUI().

Referenced by duplicateQuestionForSurvey().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getQuestionpoolTitles()

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

Get the titles of all available survey question pools.

Returns

array An array of survey question pool titles public

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

References ilObjSurveyQuestionPool\_getAvailableQuestionpools().

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

Here is the call graph for this function:

getQuestionsTable()

ilObjSurvey::getQuestionsTable

(

$arrFilter

)

Calculates the data for the output of the question browser.

public

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

References ilObject\$db, $ilDB, $ilUser, $rows, $user, ilObjSurveyQuestionPool\_getQuestionTypeTranslations(), getAvailableQuestionpools(), getExistingQuestions(), and isPluginActive().

    {
        $ilUser = $this->user;
        $ilDB = $this->db;
        $where = "";
        if (is_array($arrFilter)) {
            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($use_obj_id = true, $could_be_offline = false, $showPath = false);
        $forbidden = "";
        $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 (!stristr($spls[$row["obj_fi"]], $arrFilter['spl_txt'])) {
                        continue;
                    }
                }
                
                $row['ttype'] = $trans[$row['type_tag']];
                if ($row["plugin"]) {
                    if ($this->isPluginActive($row["type_tag"])) {
                        array_push($rows, $row);
                    }
                } else {
                    array_push($rows, $row);
                }
            }
        }
        return $rows;
    }

Here is the call graph for this function:

getQuestionType()

ilObjSurvey::getQuestionType

(

$question_id

)

Returns the question type of a question with a given id.

Parameters

integer

$question_id

The database id of the question

Returns

string The question type string private

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

References $data, ilObject\$db, $ilDB, and $result.

Referenced by duplicateQuestionForSurvey().

    {
        $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 "";
        }
    }

Here is the caller graph for this function:

getRatersData()

ilObjSurvey::getRatersData

(

$a_appraisee_id

)

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

References $data, ilObject\$db, $ilDB, $name, $res, ilObjUser\_lookupEmail(), ilObjUser\_lookupName(), getSurveyCodesTableData(), and is360SurveyStarted().

Referenced by getAppraiseesData(), and sent360Reminders().

    {
        $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, $row["user_id"]);
                $res["u" . $row["user_id"]] = $name;
            }
        }
        
        if (sizeof($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, null, $item["code"])
                    );
                }
            }
        }
        
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getReminderEnd()

ilObjSurvey::getReminderEnd

(

)

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

References $reminder_end.

Referenced by checkReminder(), importObject(), and saveToDb().

    {
        return $this->reminder_end;
    }

Here is the caller graph for this function:

getReminderFrequency()

ilObjSurvey::getReminderFrequency

(

)

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

References $reminder_frequency.

Referenced by checkReminder(), importObject(), and saveToDb().

    {
        return $this->reminder_frequency;
    }

Here is the caller graph for this function:

getReminderLastSent()

ilObjSurvey::getReminderLastSent

(

)

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

References $reminder_last_sent.

Referenced by checkReminder(), and saveToDb().

    {
        return $this->reminder_last_sent;
    }

Here is the caller graph for this function:

getReminderStart()

ilObjSurvey::getReminderStart

(

)

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

References $reminder_start.

Referenced by checkReminder(), importObject(), and saveToDb().

    {
        return $this->reminder_start;
    }

Here is the caller graph for this function:

getReminderStatus()

ilObjSurvey::getReminderStatus

(

)

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

References $reminder_status.

Referenced by checkReminder(), importObject(), and saveToDb().

    {
        return (bool) $this->reminder_status;
    }

Here is the caller graph for this function:

getReminderTarget()

ilObjSurvey::getReminderTarget

(

)

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

References $reminder_target.

Referenced by checkReminder(), importObject(), saveToDb(), and sent360Reminders().

    {
        return $this->reminder_target;
    }

Here is the caller graph for this function:

getReminderTemplate()

ilObjSurvey::getReminderTemplate

(

$selectDefault = false

)

Parameters

bool

$selectDefault

Returns

mixed

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

References $reminder_tmpl.

Referenced by checkReminder(), importObject(), and saveToDb().

    {
        if ($selectDefault) {
            $defaultTemplateId = 0;
            $this->getReminderMailTemplates($defaultTemplateId);

            if ($defaultTemplateId > 0) {
                return $defaultTemplateId;
            }
        }

        return $this->reminder_tmpl;
    }

Here is the caller graph for this function:

getSelfEvaluationResults()

ilObjSurvey::getSelfEvaluationResults

(

)

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

References $mode_self_eval_results.

Referenced by importObject(), saveToDb(), and toXML().

    {
        return $this->mode_self_eval_results;
    }

Here is the caller graph for this function:

getShowQuestionTitles()

ilObjSurvey::getShowQuestionTitles

(

)

Gets the status of the display_question_titles attribute.

Returns

integer The status of the display_question_titles attribute

See also

$display_question_titles

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

Referenced by importObject(), saveToDb(), and toXML().

    {
        return ($this->display_question_titles) ? 1 : 0;
    }

Here is the caller graph for this function:

getSkillService()

ilObjSurvey::getSkillService

(

)

Get skill service.

Returns

bool activate skill service

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

References $mode_skill_service.

Referenced by closeAppraisee(), importObject(), saveToDb(), and toXML().

    {
        return $this->mode_skill_service;
    }

Here is the caller graph for this function:

getStartDate()

ilObjSurvey::getStartDate

(

)

Gets the start date of the survey.

Returns

string Survey start date (YYYY-MM-DD) public

See also

$start_date

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

Referenced by canStartSurvey(), checkReminder(), importObject(), saveToDb(), and toXML().

    {
        return (strlen($this->start_date)) ? $this->start_date : null;
    }

Here is the caller graph for this function:

getSurveyCodesForExport()

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

Returns a list of survey codes for file export.

Parameters

array

$a_array

An array of all survey codes that should be exported

Returns

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

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

References ilObject\$db, $ilDB, $ilUser, ilObject\$lng, $result, $user, ilLink\_getLink(), ilObject\getRefId(), getSurveyId(), IL_CAL_DATETIME, IL_CAL_UNIX, and isSurveyCodeUsed().

    {
        $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($row["externaldata"]);
                $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);
    }

Here is the call graph for this function:

getSurveyCodesTableData()

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

Fetches the data for the survey codes table.

Parameters

string

$lang

Language for the survey code URL

Returns

array The requested data public

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

References ilObject\$db, $ilDB, $lang, $result, ilLink\_getLink(), ilObject\getRefId(), getSurveyId(), and isSurveyCodeUsed().

Referenced by getRatersData().

    {
        $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($row["externaldata"]);
                    $item['email'] = $ext['email'];
                    $item['last_name'] = $ext['lastname'];
                    $item['first_name'] = $ext['firstname'];
                }
                                                
                array_push($codes, $item);
            }
        }
        return $codes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSurveyFinishedIds()

& ilObjSurvey::getSurveyFinishedIds

(

)

Get the finished id's of all survey participants.

Returns

array An array containing finished_id's of all survey participants public

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

References ilObject\$db, $ilDB, $ilLog, $log, $result, and getSurveyId().

    {
        $ilDB = $this->db;
        $ilLog = $this->log;
        
        $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)) {
                array_push($users, $row["finished_id"]);
            }
        }
        return $users;
    }

Here is the call graph for this function:

getSurveyId()

ilObjSurvey::getSurveyId

(

)

Returns the survey database id.

Returns

integer survey database id public

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

References $survey_id.

Referenced by addAppraisee(), addConstraintToQuestion(), addQuestionToBlock(), addRater(), closeAppraisee(), createQuestionblock(), createSurveyCodes(), createSurveyCodesForExternalData(), deleteAllUserData(), deleteConstraints(), deleteSurveyCode(), deleteSurveyRecord(), finishSurvey(), fixSequenceStructure(), getActiveID(), getAppraiseesToRate(), getConstraints(), getExistingQuestions(), getExternalCodeRecipients(), ilSurveyParticipantsTableGUI\getItems(), getNotificationTargetUserIds(), getSurveyCodesForExport(), getSurveyCodesTableData(), getSurveyFinishedIds(), getSurveyPages(), getSurveyParticipants(), getSurveyQuestions(), getUserAccessCode(), getUserSurveyExecutionStatus(), importObject(), importSurveyCode(), insertQuestion(), is360SurveyStarted(), isAnonymizedParticipant(), isAnonymousKey(), isRater(), isSurveyCodeUnique(), isSurveyCodeUsed(), isSurveyFinishedByCode(), isSurveyStarted(), loadQuestionsFromDb(), openAllAppraisees(), removeConstraintsConcerningQuestion(), removeQuestionFromBlock(), removeQuestions(), saveCompletionStatus(), saveHeading(), saveQuestionsToDb(), saveToDb(), saveUserAccessCode(), sendCodes(), sendTutorResults(), set360RaterSent(), setObligatoryStates(), startSurvey(), toXML(), and unfoldQuestionblocks().

    {
        return $this->survey_id;
    }

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)

public

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

References ilObject\$db, $ilDB, $index, $result, getConstraints(), and getSurveyId().

Referenced by getNextPage(), and toXML().

    {
        $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'];
                $currentblock = $questionblocks[$question_id]['questionblock_id'];
                $constraints = $this->getConstraints($question_id);
                $all_questions[$question_id]["constraints"] = $constraints;
            } 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;
                $currentblock = "";
                $constraints = $this->getConstraints($question_id);
                $all_questions[$question_id]["constraints"] = $constraints;
            }
            if (!isset($all_pages[$pageindex])) {
                $all_pages[$pageindex] = array();
            }
            array_push($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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSurveyParticipants()

& ilObjSurvey::getSurveyParticipants	(		$finished_ids = null,
			$force_non_anonymous = false,
			$include_invites = false
	)

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

References ilObject\$db, $ilDB, $name, $result, ilObjUser\_lookupFullname(), ilObjUser\_lookupName(), getSurveyId(), and getUserDataFromActiveId().

Referenced by ilSurveyParticipantsTableGUI\getItems().

    {
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSurveyQuestions()

& ilObjSurvey::getSurveyQuestions

(

$with_answers = false

)

Returns the survey questions and questionblocks in an array.

public

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

References $data, ilObject\$db, $ilDB, $result, getConstraints(), getSurveyId(), and isPluginActive().

Referenced by getParticipantTextResults(), getUserSpecificResults(), SurveyConstraintsTableGUI\initItems(), and removeQuestions().

    {
        $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"]) {
                if (!$this->isPluginActive($row["type_tag"])) {
                    $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'];
                $all_questions[$question_id]["constraints"] = $constraints;
            } 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)) {
                        array_push($answers, $data["title"]);
                    }
                }
                $all_questions[$question_id]["answers"] = $answers;
            }
        }
        return $all_questions;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSurveySkippedValue()

static ilObjSurvey::getSurveySkippedValue ( )

static

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

References $DIC, ilObject\$lng, $res, and ilSurveyMailTemplateReminderContext\ID.

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

    {
        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", "");
        }
    }

Here is the caller graph for this function:

getSurveysWithTutorResults()

static ilObjSurvey::getSurveysWithTutorResults ( )

static

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

References $ilDB, $log, $res, and ilLoggerFactory\getLogger().

Referenced by ilSurveyCronNotification\run().

    {
        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[] = $row["obj_fi"];
        }
        
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplate()

ilObjSurvey::getTemplate

(

)

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

References $template_id.

Referenced by importObject(), isPoolActive(), and saveToDb().

    {
        return $this->template_id;
    }

Here is the caller graph for this function:

getTextblock()

ilObjSurvey::getTextblock

(

$question_id

)

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

References ilObject\$db, $ilDB, and $result.

Referenced by cloneTextblocks().

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

Here is the caller graph for this function:

getTutorNotificationRecipients()

ilObjSurvey::getTutorNotificationRecipients

(

)

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

References $tutor_ntf_recipients.

Referenced by importObject(), saveToDb(), and sendTutorNotification().

    {
        return $this->tutor_ntf_recipients;
    }

Here is the caller graph for this function:

getTutorNotificationStatus()

ilObjSurvey::getTutorNotificationStatus

(

)

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

References $tutor_ntf_status.

Referenced by checkTutorNotification(), importObject(), and saveToDb().

    {
        return (bool) $this->tutor_ntf_status;
    }

Here is the caller graph for this function:

getTutorNotificationTarget()

ilObjSurvey::getTutorNotificationTarget

(

)

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

References $tutor_ntf_target.

Referenced by checkTutorNotification(), importObject(), and saveToDb().

    {
        return $this->tutor_ntf_target;
    }

Here is the caller graph for this function:

getTutorResultsRecipients()

ilObjSurvey::getTutorResultsRecipients

(

)

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

References $tutor_res_recipients.

Referenced by importObject(), saveToDb(), and sendTutorResults().

    {
        return $this->tutor_res_recipients;
    }

Here is the caller graph for this function:

getTutorResultsStatus()

ilObjSurvey::getTutorResultsStatus

(

)

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

References $tutor_res_status.

Referenced by importObject(), and saveToDb().

    {
        return (bool) $this->tutor_res_status;
    }

Here is the caller graph for this function:

getUserAccessCode()

ilObjSurvey::getUserAccessCode

(

$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

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

    {
        $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;
    }

Here is the call graph for this function:

getUserData()

& ilObjSurvey::getUserData

(

$ids

)

Returns a data of all users specified by id list.

Parameters

$ids	array of user id's

Returns

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

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

References ilObject\$db, $ilDB, and $result.

    {
        $ilDB = $this->db;

        if (!is_array($ids) || 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	(		$active_id,
			$force_non_anonymous = false
	)

Returns the user information from an active_id (survey_finished.finished_id)

Parameters

integer

$active_id

The active id of the user

Returns

array An array containing the user data public

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

References ilObject\$db, $ilDB, $name, $result, $user, ilObjUser\_lookupLogin(), get360Mode(), and hasAnonymizedResults().

Referenced by finishSurvey(), getEvaluationByUser(), and getSurveyParticipants().

    {
        $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" => "$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()
                    (bool) $force_non_anonymous)) {
                if (strlen(ilObjUser::_lookupLogin($row["user_fi"])) == 0) {
                    $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();
                }
            }
        }
        return $userdata;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserSettings()

ilObjSurvey::getUserSettings	(		$usr_id,
			$key
	)

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

References ilObject\$db, $ilDB, and $result.

    {
        $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

(

$finished_ids

)

Calculates the evaluation data for the user specific results.

Returns

array An array containing the user specific results public

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

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

Referenced by getParticipantTextResults().

    {
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserSurveyExecutionStatus()

ilObjSurvey::getUserSurveyExecutionStatus

(

$a_code = null

)

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

References ilObject\$db, $ilDB, $ilUser, $res, $user, createNewAccessCode(), get360Mode(), getAnonymize(), getSurveyId(), isAccessibleWithoutCode(), isRater(), and saveUserAccessCode().

    {
        $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->get360Mode() &&
                    $user_id != ANONYMOUS_USER_ID &&
                    $this->isRater(0, $user_id)) {
                    // auto-generate code
                    $a_code = $this->createNewAccessCode();
                    $this->saveUserAccessCode($user_id, $a_code);
                } else {
                    return null;
                }
            }
        } elseif ($user_id == ANONYMOUS_USER_ID ||
            $this->getAnonymize() == self::ANONYMIZE_FREEACCESS) {
            if (!$a_code) {
                // auto-generate code
                $a_code = $this->createNewAccessCode();
                $this->saveUserAccessCode($user_id, $a_code);
            }
        } else {
            $a_code = null;
        }
            
        $res = array();
                                
        $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);
    }

Here is the call graph for this function:

getVariables()

& ilObjSurvey::getVariables

(

$question_id

)

Returns all variables of a question.

public

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

References ilObject\$db, $ilDB, and $result.

    {
        $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

(

$finished_id

)

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

References ilObject\$db, $ilDB, $result, and $total.

    {
        $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

(

)

Checks if the survey results are to be anonymized.

Returns

boolean status

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

References getAnonymize().

Referenced by getUserDataFromActiveId(), and sendNotificationMail().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasAnonymousUserList()

ilObjSurvey::hasAnonymousUserList

(

)

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

References $anon_user_list.

Referenced by importObject(), saveToDb(), and toXML().

    {
        return $this->anon_user_list;
    }

Here is the caller graph for this function:

hasMailConfirmation()

ilObjSurvey::hasMailConfirmation

(

)

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

References $mail_confirmation.

Referenced by importObject(), saveToDb(), and toXML().

    {
        return $this->mail_confirmation;
    }

Here is the caller graph for this function:

hasMailOwnResults()

ilObjSurvey::hasMailOwnResults

(

)

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

References $mail_own_results.

Referenced by importObject(), saveToDb(), and toXML().

    {
        return $this->mail_own_results;
    }

Here is the caller graph for this function:

hasViewOwnResults()

ilObjSurvey::hasViewOwnResults

(

)

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

References $view_own_results.

Referenced by importObject(), saveToDb(), and toXML().

    {
        return $this->view_own_results;
    }

Here is the caller graph for this function:

hideQuestionTitles()

ilObjSurvey::hideQuestionTitles

(

)

Sets the question titles hidden during the query.

public

See also

$display_question_titles

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

    {
        $this->display_question_titles = 0;
    }

importObject()

ilObjSurvey::importObject	(		$file_info,
			$svy_qpl_id
	)

Imports a survey from XML into the ILIAS database.

Parameters

$file_info
$svy_qpl_id

Returns

string

Exceptions

ilFileUtilsException
ilInvalidSurveyImportFileException

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

References $_SESSION, $config, ilObject\$db, ilObject\$error, $ilDB, $ilLog, $log, $result, $source, $xml, ilCopyWizardOptions\_getInstance(), SurveyQuestion\_getOriginalId(), SurveyQuestion\_instanciateQuestion(), ilRTE\_replaceMediaObjectImageSrc(), ilObjMediaObject\_saveTempFileAsMediaObject(), ilObjMediaObject\_saveUsage(), ilObject\cloneMetaData(), ilUtil\delDir(), get360Mode(), get360Results(), get360SelfAppraisee(), get360SelfEvaluation(), get360SelfRaters(), getAnonymize(), getAuthor(), getEndDate(), getEvaluationAccess(), ilObject\getId(), getImportDirectory(), getIntroduction(), getMailAddresses(), getMailNotification(), getMailParticipantData(), getMode(), ilObject\getOfflineStatus(), getOutro(), getPoolUsage(), getReminderEnd(), getReminderFrequency(), getReminderStart(), getReminderStatus(), getReminderTarget(), getReminderTemplate(), getSelfEvaluationResults(), getShowQuestionTitles(), getSkillService(), getStartDate(), getSurveyId(), getTemplate(), getTutorNotificationRecipients(), getTutorNotificationStatus(), getTutorNotificationTarget(), getTutorResultsRecipients(), getTutorResultsStatus(), hasAnonymousUserList(), hasMailConfirmation(), hasMailOwnResults(), hasViewOwnResults(), loadFromDb(), locateImportFiles(), MODE_360, MODE_SELF_EVAL, ilUtil\moveUploadedFile(), saveToDb(), setIntroduction(), setOutro(), and ilUtil\unzip().

    {
        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->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->log->debug("isZip");
            $isZip = true;
        }
        if (!$isXml && !$isZip) {
            $error = $this->lng->txt("import_wrong_file_type");
            $this->log->debug("Survey: Import error. Filetype was \"" . $file_info["type"] . "\"");
        }
        if (strlen($error) == 0) {
            // import file as a survey
            $import_dir = $this->getImportDirectory();
            $import_subdir = "";
            $importfile = "";
            if ($isZip) {
                $importfile = $import_dir . "/" . $file_info["name"];
                ilUtil::moveUploadedFile($source, $file_info["name"], $importfile);
                ilUtil::unzip($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");
                ilUtil::moveUploadedFile($source, $file_info["name"], $importfile);
            }

            $this->log->debug("Import file = $importfile");
            $this->log->debug("Import subdir = $import_subdir");

            $fh = fopen($importfile, "r");
            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;
            }

            unset($_SESSION["import_mob_xhtml"]);
            if (strpos($xml, "questestinterop")) {
                throw new ilInvalidSurveyImportFileException("Unsupported survey version (< 3.8) found.");
            } else {
                $this->log->debug("survey id = " . $this->getId());
                $this->log->debug("question pool id = " . $svy_qpl_id);

                $imp = new ilImport();
                $config = $imp->getConfig("Modules/Survey");
                $config->setQuestionPoolID($svy_qpl_id);
                $imp->getMapping()->addMapping("Modules/Survey", "svy", 0, $this->getId());
                $imp->importFromDirectory($import_subdir, "svy", "Modules/Survey");
                $this->log->debug("config(Modules/survey)->getQuestionPoolId =" . $config->getQuestionPoolID());
                return "";

                //old code
                $import = new SurveyImportParser($svy_qpl_id, "", true);
                $import->setSurveyObject($this);
                $import->setXMLContent($xml);
                $import->startParsing();
            }

            if (is_array($_SESSION["import_mob_xhtml"])) {
                foreach ($_SESSION["import_mob_xhtml"] as $mob) {
                    $importfile = $import_subdir . "/" . $mob["uri"];
                    if (file_exists($importfile)) {
                        if (!$mob["type"]) {
                            $mob["type"] = "svy:html";
                        }
                        
                        $media_object = ilObjMediaObject::_saveTempFileAsMediaObject(basename($importfile), $importfile, false);
                        
                        // survey mob
                        if ($mob["type"] == "svy:html") {
                            ilObjMediaObject::_saveUsage($media_object->getId(), "svy:html", $this->getId());
                            $this->setIntroduction(str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $this->getIntroduction()));
                            $this->setOutro(str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $this->getOutro()));
                        }
                        // question mob
                        elseif ($import->questions[$mob["id"]]) {
                            $new_qid = $import->questions[$mob["id"]];
                            ilObjMediaObject::_saveUsage($media_object->getId(), $mob["type"], $new_qid);
                            $new_question = SurveyQuestion::_instanciateQuestion($new_qid);
                            $qtext = $new_question->getQuestiontext();
                            $qtext = ilRTE::_replaceMediaObjectImageSrc($qtext, 0);
                            $qtext = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $qtext);
                            $qtext = ilRTE::_replaceMediaObjectImageSrc($qtext, 1);
                            $new_question->setQuestiontext($qtext);
                            $new_question->saveToDb();
                            
                            // also fix existing original in pool
                            if ($new_question->getOriginalId()) {
                                $pool_question = SurveyQuestion::_instanciateQuestion($new_question->getOriginalId());
                                $pool_question->setQuestiontext($qtext);
                                $pool_question->saveToDb();
                            }
                        }
                    } else {
                        $ilLog = $this->log;
                        $ilLog->write("Error: Could not open XHTML mob file for test introduction during test import. File $importfile does not exist!");
                    }
                }
                $this->setIntroduction(ilRTE::_replaceMediaObjectImageSrc($this->getIntroduction(), 1));
                $this->setOutro(ilRTE::_replaceMediaObjectImageSrc($this->getOutro(), 1));
                $this->saveToDb();
            }

            // delete import directory
            ilUtil::delDir($this->getImportDirectory());
        }
        return $error;
    }

Here is the call graph for this function:

importSurveyCode()

ilObjSurvey::importSurveyCode	(		$a_anonymize_key,
			$a_created,
			$a_data
	)

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

References ilObject\$db, $ilDB, and getSurveyId().

    {
        $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)
        );
    }

Here is the call graph for this function:

insertQuestion()

ilObjSurvey::insertQuestion

(

$question_id

)

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

public

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

References ilObject\$db, $ilDB, $result, SurveyQuestion\_isComplete(), duplicateQuestionForSurvey(), getSurveyId(), isQuestionInSurvey(), and loadQuestionsFromDb().

    {
        $ilDB = $this->db;

        $this->log->debug("insert question, id:" . $question_id);

        if (!SurveyQuestion::_isComplete($question_id)) {
            $this->log->debug("question is not complete");
            return false;
        } else {
            // get maximum sequence index in test
            // @todo: refactor this
            $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->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->log->debug("added entry to svy_svy_qst, id: " . $next_id . ", question id: " . $duplicate_id . ", sequence: " . $sequence);

            $this->loadQuestionsFromDb();
            return true;
        }
    }

Here is the call graph for this function:

insertQuestionblock()

ilObjSurvey::insertQuestionblock

(

$questionblock_id

)

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

public

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

References ilObject\$db, $ilDB, $questions, $result, ilObject\$title, createQuestionblock(), and duplicateQuestionForSurvey().

    {
        $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 = 0;
        $show_blocktitle = 0;
        while ($row = $ilDB->fetchAssoc($result)) {
            $duplicate_id = $this->duplicateQuestionForSurvey($row["question_fi"]);
            array_push($questions, $duplicate_id);
            $title = $row["title"];
            $show_questiontext = $row["show_questiontext"];
            $show_blocktitle = $row["show_blocktitle"];
        }
        $this->createQuestionblock($title, $show_questiontext, $show_blocktitle, $questions);
    }

Here is the call graph for this function:

is360SurveyStarted()

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

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

Referenced by getRatersData(), and sent360Reminders().

    {
        $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 false;
        } else {
            $row = $ilDB->fetchAssoc($result);
            return (int) $row["state"];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAccessibleWithoutCode()

ilObjSurvey::isAccessibleWithoutCode

(

)

Checks if the survey is accessable without a survey code.

Returns

boolean status

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

References getAnonymize().

Referenced by getUserSurveyExecutionStatus().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isActivationLimited()

ilObjSurvey::isActivationLimited

(

)

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

Referenced by saveToDb().

    {
        return (bool) $this->activation_limited;
    }

Here is the caller graph for this function:

isAnonymizedParticipant()

ilObjSurvey::isAnonymizedParticipant

(

$key

)

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

    {
        $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) ? true : false;
    }

Here is the call graph for this function:

isAnonymousKey()

ilObjSurvey::isAnonymousKey

(

$key

)

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

Referenced by checkSurveyCode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isAppraisee()

ilObjSurvey::isAppraisee

(

$a_user_id

)

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

References ilObject\$db, and $ilDB.

Referenced by addAppraisee(), addRater(), getAppraiseesToRate(), and isRater().

    {
        $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);
    }

Here is the caller graph for this function:

isAppraiseeClosed()

ilObjSurvey::isAppraiseeClosed

(

$a_user_id

)

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

References ilObject\$db, and $ilDB.

Referenced by sent360Reminders().

    {
        $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 $row["has_closed"];
    }

Here is the caller graph for this function:

isComplete()

ilObjSurvey::isComplete

(

)

Returns 1, if a survey is complete for use.

Returns

boolean 1, if the survey is complete for use, otherwise 0 public

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

References ilObject\getTitle().

Referenced by saveCompletionStatus(), and saveToDb().

    {
        if (($this->getTitle()) and (count($this->questions))) {
            return 1;
        } else {
            return 0;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isHTML()

ilObjSurvey::isHTML

(

$a_text

)

Checks if a given string contains HTML or not.

Parameters

string

$a_text

Text which should be checked

Returns

boolean public

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

Referenced by addMaterialTag().

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

Here is the caller graph for this function:

isPluginActive()

ilObjSurvey::isPluginActive

(

$a_pname

)

Checks whether or not a question plugin with a given name is active.

Parameters

string

$a_pname

The plugin name public

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

References $plugin_admin, and IL_COMP_MODULE.

Referenced by getQuestionsTable(), and getSurveyQuestions().

    {
        $ilPluginAdmin = $this->plugin_admin;
        if ($ilPluginAdmin->isActive(IL_COMP_MODULE, "SurveyQuestionPool", "svyq", $a_pname)) {
            return true;
        } else {
            return false;
        }
    }

Here is the caller graph for this function:

isPoolActive()

ilObjSurvey::isPoolActive

(

)

Get current pool status.

Returns

bool

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

References getPoolUsage(), and getTemplate().

    {
        $use_pool = (bool) $this->getPoolUsage();
        $template_settings = $this->getTemplate();
        if ($template_settings) {
            $template_settings = new ilSettingsTemplate($template_settings);
            $template_settings = $template_settings->getSettings();
            $template_settings = $template_settings["use_pool"];
            if ($template_settings && $template_settings["hide"]) {
                $use_pool = (bool) $template_settings["value"];
            }
        }
        return $use_pool;
    }

Here is the call graph for this function:

isQuestionInAnyBlock()

ilObjSurvey::isQuestionInAnyBlock

(

$a_question_fi

)

Is question already in a block?

Parameters

int

$a_question_fi

question id as in svy_question

Returns

bool

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

References $DIC, and $ilDB.

Referenced by addQuestionToBlock(), and createQuestionblock().

    {
        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;
    }

Here is the caller graph for this function:

isQuestionInSurvey()

ilObjSurvey::isQuestionInSurvey

(

$a_question_fi

)

Check if a question is already in the survey.

Parameters

question

id (as primary key from svy_question table)

Returns

bool

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

References $DIC, and $ilDB.

Referenced by insertQuestion(), and saveQuestionsToDb().

    {
        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;
    }

Here is the caller graph for this function:

isRater()

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

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

References ilObject\$db, $ilDB, get360SelfEvaluation(), getSurveyId(), and isAppraisee().

Referenced by addRater(), and getUserSurveyExecutionStatus().

    {
        $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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSurveyCodeUnique()

ilObjSurvey::isSurveyCodeUnique

(

$code

)

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

Referenced by createNewAccessCode().

    {
        $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) ? false : true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSurveyCodeUsed()

ilObjSurvey::isSurveyCodeUsed

(

$code

)

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

Referenced by getSurveyCodesForExport(), and getSurveyCodesTableData().

    {
        $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) ? true : false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSurveyFinishedByCode()

ilObjSurvey::isSurveyFinishedByCode

(

$a_code

)

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

Parameters

$a_code

anonymous user code

Returns

bool

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

References $result, and getSurveyId().

Referenced by getExternalCodeRecipients().

    {
        $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'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSurveyStarted()

ilObjSurvey::isSurveyStarted	(		$user_id,
			$anonymize_id,
			$appr_id = 0
	)

Checks if a user already started a survey.

Parameters

integer

$user_id

The database id of the user

Returns

mixed false, if the user has not started the survey, 0 if the user has started the survey but not finished it, 1 if the user has finished the survey public

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

References $_SESSION, ilObject\$db, $ilDB, $result, ilObject\getId(), and getSurveyId().

Referenced by checkSurveyCode().

    {
        $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 * 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 {
            $result = $ilDB->queryF(
                "SELECT * 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 false;
        } else {
            $row = $ilDB->fetchAssoc($result);
            // yes, we are doing it this way
            $_SESSION["finished_id"][$this->getId()] = $row["finished_id"];
            
            return (int) $row["state"];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isUnusedCode()

ilObjSurvey::isUnusedCode	(		$a_code,
			$a_user_id
	)

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

References ilObject\$db, and $ilDB.

    {
        $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 = $user_id["user_fi"];
        
        if ($user_id && ($user_id != $a_user_id || $user_id == ANONYMOUS_USER_ID)) {
            return false;
        }
        return true;
    }

loadFromDb()

ilObjSurvey::loadFromDb

(

)

Loads a survey object from a database.

public

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

References $data, ilObject\$db, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), ilObject\getId(), ilObjectActivation\getItem(), IL_CAL_DATE, loadQuestionsFromDb(), set360Results(), set360SelfAppraisee(), set360SelfEvaluation(), set360SelfRaters(), setActivationEndDate(), setActivationLimited(), setActivationStartDate(), setActivationVisibility(), setAnonymize(), setAnonymousUserList(), setAuthor(), setEndDate(), setEvaluationAccess(), setIntroduction(), setMailAddresses(), setMailConfirmation(), setMailNotification(), setMailOwnResults(), setMailParticipantData(), setMode(), setOutro(), setPoolUsage(), setReminderEnd(), setReminderFrequency(), setReminderLastSent(), setReminderStart(), setReminderStatus(), setReminderTarget(), setReminderTemplate(), setSelfEvaluationResults(), setShowQuestionTitles(), setSkillService(), setStartDate(), setSurveyId(), setTemplate(), setTutorNotificationRecipients(), setTutorNotificationStatus(), setTutorNotificationTarget(), setTutorResultsRecipients(), setTutorResultsStatus(), setViewOwnResults(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by importObject(), and read().

    {
        $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($data["introduction"], 1));
            if (strcmp($data["outro"], "survey_finished") == 0) {
                $this->setOutro($this->lng->txt("survey_finished"));
            } else {
                $this->setOutro(ilRTE::_replaceMediaObjectImageSrc($data["outro"], 1));
            }
            $this->setShowQuestionTitles($data["show_question_titles"]);
            $this->setStartDate($data["startdate"]);
            $this->setEndDate($data["enddate"]);
            $this->setAnonymize($data["anonymize"]);
            $this->setEvaluationAccess($data["evaluation_access"]);
            $this->loadQuestionsFromDb();
            $this->setMailNotification($data['mailnotification']);
            $this->setMailAddresses($data['mailaddresses']);
            $this->setMailParticipantData($data['mailparticipantdata']);
            $this->setTemplate($data['template_id']);
            $this->setPoolUsage($data['pool_usage']);
            // Mode
            $this->setMode($data['mode']);
            // 360°
            $this->set360SelfEvaluation($data['mode_360_self_eval']);
            $this->set360SelfRaters($data['mode_360_self_rate']);
            $this->set360SelfAppraisee($data['mode_360_self_appr']);
            $this->set360Results($data['mode_360_results']);
            // Mode self evaluated
            $this->setSelfEvaluationResults($data['mode_self_eval_results']);
            // Competences
            $this->setSkillService($data['mode_skill_service']);
            // reminder/notification
            $this->setReminderStatus($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($data["reminder_frequency"]);
            $this->setReminderTarget($data["reminder_target"]);
            $this->setReminderLastSent($data["reminder_last_sent"]);
            $this->setReminderTemplate($data["reminder_tmpl"]);
            $this->setTutorNotificationStatus($data["tutor_ntf_status"]);
            $this->setTutorNotificationRecipients(explode(";", $data["tutor_ntf_reci"]));
            $this->setTutorNotificationTarget($data["tutor_ntf_target"]);
            $this->setTutorResultsStatus($data["tutor_res_status"]);
            $this->setTutorResultsRecipients(explode(";", $data["tutor_res_reci"]));
            
            $this->setViewOwnResults($data["own_results_view"]);
            $this->setMailOwnResults($data["own_results_mail"]);
            $this->setMailConfirmation($data["confirmation_mail"]);
            
            $this->setAnonymousUserList($data["anon_user_list"]);
        }
        
        // moved activation to ilObjectActivation
        if ($this->ref_id) {
            $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;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadQuestionsFromDb()

ilObjSurvey::loadQuestionsFromDb

(

)

Loads the survey questions from the database.

public

See also

$questions

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

References $data, ilObject\$db, $ilDB, $result, and getSurveyId().

Referenced by insertQuestion(), and loadFromDb().

    {
        $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"];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadWorkingData()

ilObjSurvey::loadWorkingData	(		$question_id,
			$active_id
	)

Gets the working data of question from the database.

Parameters

integer	$question_id	The database id of the question
integer	$active_id	The active id of the user who worked through the question

Returns

array The resulting database dataset as an array public

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

References ilObject\$db, $ilDB, and $result.

    {
        $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)) {
                array_push($result_array, $row);
            }
            return $result_array;
        } else {
            return $result_array;
        }
    }

locateImportFiles()

ilObjSurvey::locateImportFiles

(

$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) private

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

Referenced by importObject().

    {
        if (!is_dir($a_dir) || is_int(strpos($a_dir, ".."))) {
            return;
        }
        $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 (strlen($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);
    }

Here is the caller graph for this function:

modifyQuestionblock()

ilObjSurvey::modifyQuestionblock	(		$questionblock_id,
			$title,
			$show_questiontext,
			$show_blocktitle
	)

Modifies a question block.

Parameters

integer	$questionblock_id	The database id of the question block
string	$title	The title of the question block public

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

References ilObject\$db, $ilDB, and ilObject\$title.

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

moveQuestions()

ilObjSurvey::moveQuestions	(		$move_questions,
			$target_index,
			$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
integer	$target_index	The question id of the target position
integer	$insert_mode	0, if insert before the target position, 1 if insert after the target position public

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

References deleteConstraint(), getConstraints(), and saveQuestionsToDb().

Referenced by createQuestionblock().

    {
        $array_pos = array_search($target_index, $this->questions);
        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 (!(array_search($question_id, $part1) === false)) {
                unset($part1[array_search($question_id, $part1)]);
                $found++;
            }
            if (!(array_search($question_id, $part2) === false)) {
                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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

openAllAppraisees()

ilObjSurvey::openAllAppraisees

(

)

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

References ilObject\$db, $ilDB, and getSurveyId().

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

Here is the call graph for this function:

prepareTextareaOutput()

ilObjSurvey::prepareTextareaOutput

(

$txt_output

)

Prepares a string for a text area output in surveys.

Parameters

string

$txt_output

String which should be prepared for output public

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

References ilUtil\prepareTextareaOutput().

    {
        return ilUtil::prepareTextareaOutput($txt_output, $prepare_for_latex_output);
    }

Here is the call graph for this function:

processPrintoutput2FO()

ilObjSurvey::processPrintoutput2FO

(

$print_output

)

Convert a print output to XSL-FO.

Parameters

string

$print_output

The print output

Returns

string XSL-FO code public

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

References $config, Vendor\Package\$e, $GLOBALS, xslt_create(), xslt_error(), and xslt_free().

    {
        if (extension_loaded("tidy")) {
            $config = array(
                "indent" => false,
                "output-xml" => true,
                "numeric-entities" => true
            );
            $tidy = new tidy();
            $tidy->parseString($print_output, $config, 'utf8');
            $tidy->cleanRepair();
            $print_output = tidy_get_output($tidy);
            $print_output = preg_replace("/^.*?(<html)/", "\\1", $print_output);
        } else {
            $print_output = str_replace("&nbsp;", "&#160;", $print_output);
            $print_output = str_replace("&otimes;", "X", $print_output);
            
            // #17680 - metric questions use &#160; in print view
            $print_output = str_replace("&gt;", "~|gt|~", $print_output);               // see #21550
            $print_output = str_replace("&lt;", "~|lt|~", $print_output);
            $print_output = str_replace("&#160;", "~|nbsp|~", $print_output);
            $print_output = preg_replace('/&(?!amp)/', '&amp;', $print_output);
            $print_output = str_replace("~|nbsp|~", "&#160;", $print_output);
            $print_output = str_replace("~|gt|~", "&gt;", $print_output);
            $print_output = str_replace("~|lt|~", "&lt;", $print_output);
        }
        $xsl = file_get_contents("./Modules/Survey/xml/question2fo.xsl");

        // additional font support
        $xsl = str_replace(
            'font-family="Helvetica, unifont"',
            'font-family="' . $GLOBALS['ilSetting']->get('rpc_pdf_font', 'Helvetica, unifont') . '"',
            $xsl
        );
        $args = array( '/_xml' => $print_output, '/_xsl' => $xsl );
        $xh = xslt_create();
        $params = array();
        try {
            $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, $params);
        } catch (Exception $e) {
            $this->log->error("Print XSLT failed:");
            $this->log->error("Content: " . $print_output);
            $this->log->error("Xsl: " . $xsl);
            throw ($e);
        }
        xslt_error($xh);
        xslt_free($xh);

        return $output;
    }

Here is the call graph for this function:

read()

ilObjSurvey::read

(

)

read object data from db into object public

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

References loadFromDb().

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

Here is the call graph for this function:

removeConstraintsConcerningQuestion()

ilObjSurvey::removeConstraintsConcerningQuestion

(

$question_id

)

Remove constraints concerning a question with a given question_id.

Parameters

integer

$question_id

The database id of the question public

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

Referenced by removeQuestion().

    {
        $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)) {
                array_push($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)
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeQuestion()

ilObjSurvey::removeQuestion

(

$question_id

)

Remove a question from the survey.

Parameters

integer

$question_id

The database id of the question public

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

References removeConstraintsConcerningQuestion().

Referenced by delete(), and removeQuestions().

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

Here is the call graph for this function:

Here is the caller graph for this function:

removeQuestionFromBlock()

ilObjSurvey::removeQuestionFromBlock	(		$question_id,
			$questionblock_id
	)

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

References ilObject\$db, $ilDB, and getSurveyId().

    {
        $ilDB = $this->db;
        
        $affectedRows = $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)
        );
    }

Here is the call graph for this function:

removeQuestions()

ilObjSurvey::removeQuestions	(		$remove_questions,
			$remove_questionblocks
	)

Remove questions from the survey.

Parameters

array	$remove_questions	An array with the question id's of the questions to remove
array	$remove_questionblocks	An array with the questionblock id's of the questions blocks to remove public

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

References $data, ilObject\$db, $ilDB, $size, getSurveyId(), getSurveyQuestions(), removeQuestion(), and saveQuestionsToDb().

    {
        $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"]]++;
            }
        }
        
        // 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();
    }

Here is the call graph for this function:

removeSelectedSurveyResults()

ilObjSurvey::removeSelectedSurveyResults

(

$finished_ids

)

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

public

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

References ilObject\$db, $ilDB, $result, ilObject\getId(), and ilObjectLP\getInstance().

Referenced by deleteRater().

    {
        $ilDB = $this->db;
        
        $user_ids[] = array();
        
        foreach ($finished_ids as $finished_id) {
            $result = $ilDB->queryF(
                "SELECT finished_id FROM svy_finished WHERE finished_id = %s",
                array('integer'),
                array($finished_id)
            );
            $row = $ilDB->fetchAssoc($result);
            
            if ($row["user_fi"]) {
                $user_ids[] = $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 (sizeof($user_ids)) {
            $lp_obj = ilObjectLP::getInstance($this->getId());
            $lp_obj->resetLPDataForUserIds($user_ids);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAuthorToMetadata()

ilObjSurvey::saveAuthorToMetadata

(

$a_author = ""

)

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

Parameters

string

$a_author

A string containing the name of the test author private

See also

$author

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

References $ilUser, $user, ilObject\getId(), and ilObject\getType().

Referenced by createMetaData().

    {
        $md = new ilMD($this->getId(), 0, $this->getType());
        $md_life = &$md->getLifecycle();
        if (!$md_life) {
            if (strlen($a_author) == 0) {
                $ilUser = $this->user;
                $a_author = $ilUser->getFullname();
            }
            
            $md_life = &$md->addLifecycle();
            $md_life->save();
            $con = &$md_life->addContribute();
            $con->setRole("Author");
            $con->save();
            $ent = &$con->addEntity();
            $ent->setEntity($a_author);
            $ent->save();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveCompletionStatus()

ilObjSurvey::saveCompletionStatus

(

)

Saves the completion status of the survey.

public

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

References ilObject\$db, $ilDB, getSurveyId(), and isComplete().

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

Here is the call graph for this function:

saveHeading()

ilObjSurvey::saveHeading	(		$heading = "",
			$insertbefore
	)

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

References ilObject\$db, $ilDB, and getSurveyId().

Referenced by cloneTextblocks().

    {
        $ilDB = $this->db;
        if ($heading) {
            $affectedRows = $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 {
            $affectedRows = $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)
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveQuestionsToDb()

ilObjSurvey::saveQuestionsToDb

(

)

Saves the survey questions to the database.

public

See also

$questions

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

References ilObject\$db, $ilDB, $result, getSurveyId(), and isQuestionInSurvey().

Referenced by moveQuestions(), removeQuestions(), and saveToDb().

    {
        $ilDB = $this->db;

        $this->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 (sizeof($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->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->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->log->debug("update svy_svy_qst, id:" . $update[$fi] . ", fi: " . $fi . ", seq:" . $seq);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveToDb()

ilObjSurvey::saveToDb

(

)

Saves a survey object to a database.

public

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

References ilObject\$db, $ilDB, ilRTE\_replaceMediaObjectImageSrc(), get360Results(), get360SelfAppraisee(), get360SelfEvaluation(), get360SelfRaters(), getActivationEndDate(), getActivationStartDate(), getActivationVisibility(), getAnonymize(), getAuthor(), getEndDate(), getEvaluationAccess(), ilObject\getId(), getIntroduction(), ilObjectActivation\getItem(), getMailAddresses(), getMailNotification(), getMailParticipantData(), getMode(), getOutro(), getPoolUsage(), getReminderEnd(), getReminderFrequency(), getReminderLastSent(), getReminderStart(), getReminderStatus(), getReminderTarget(), getReminderTemplate(), getSelfEvaluationResults(), getShowQuestionTitles(), getSkillService(), getStartDate(), getSurveyId(), getTemplate(), getTutorNotificationRecipients(), getTutorNotificationStatus(), getTutorNotificationTarget(), getTutorResultsRecipients(), getTutorResultsStatus(), hasAnonymousUserList(), hasMailConfirmation(), hasMailOwnResults(), hasViewOwnResults(), IL_CAL_DATE, isActivationLimited(), isComplete(), RESULTS_SELF_EVAL_OWN, saveQuestionsToDb(), setSurveyId(), ilObjectActivation\setTimingType(), ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

Referenced by applySettingsTemplate(), checkReminder(), createReference(), and importObject().

    {
        $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', strlen($this->getMailAddresses()) ? $this->getMailAddresses() : null),
                "mailparticipantdata" => array('text', strlen($this->getMailParticipantData()) ? $this->getMailParticipantData() : null),
                "tstamp" => array("integer", time()),
                "template_id" => array("integer", $this->getTemplate()),
                "pool_usage" => array("integer", $this->getPoolUsage()),
                // 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", ilObjSurvey::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", (int) $this->getReminderFrequency()),
                "reminder_target" => array("integer", (int) $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(";", (array) $this->getTutorNotificationRecipients())),
                "tutor_ntf_target" => array("integer", (int) $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(";", (array) $this->getTutorResultsRecipients())),
                "confirmation_mail" => array("integer", $this->hasMailConfirmation()),
                "anon_user_list" => array("integer", $this->hasAnonymousUserList())
            ));
            $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', strlen($this->getMailAddresses()) ? $this->getMailAddresses() : null),
                "mailparticipantdata" => array('text', strlen($this->getMailParticipantData()) ? $this->getMailParticipantData() : null),
                "tstamp" => array("integer", time()),
                "template_id" => array("integer", $this->getTemplate()),
                "pool_usage" => array("integer", $this->getPoolUsage()),
                //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(";", (array) $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(";", (array) $this->getTutorResultsRecipients())),
                "confirmation_mail" => array("integer", $this->hasMailConfirmation()),
                "anon_user_list" => array("integer", $this->hasAnonymousUserList())
            ), 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveUserAccessCode()

ilObjSurvey::saveUserAccessCode	(		$user_id,
			$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

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

References ilObject\$db, $ilDB, and getSurveyId().

Referenced by getUserSurveyExecutionStatus().

    {
        $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())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveUserSettings()

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

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

References ilObject\$db, $ilDB, and ilObject\$title.

    {
        $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	(		$a_user_id,
			$a_appraisee_ids
	)

Send rater notification.

Parameters

int

$a_user_id

user id

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

References ilObject\$lng, ilObjUser\_lookupLogin(), ilUserUtil\getNamePresentation(), ilObject\getRefId(), and ilObject\getTitle().

Referenced by sent360Reminders().

    {
        $this->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_360_rater_reminder_mail");
        $subject = str_replace("%1", $this->getTitle(), $lng->txt("svy_user_added_360_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),
            null,
            null,
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendAppraiseeCloseNotification()

ilObjSurvey::sendAppraiseeCloseNotification

(

$a_user_id

)

Send appraisee notification.

Parameters

int

$a_user_id

user id

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

References ilObject\$lng, ilObjUser\_lookupLogin(), ilObject\getRefId(), and ilObject\getTitle().

Referenced by closeAppraisee().

    {
        $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_360_appraisee_close_mail");
        $subject = str_replace("%1", $this->getTitle(), $lng->txt("svy_user_added_360_appraisee"));

        // #10044
        $mail = new ilMail(ANONYMOUS_USER_ID);
        $mail->enqueue(
            ilObjUser::_lookupLogin($a_user_id),
            null,
            null,
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendAppraiseeNotification()

ilObjSurvey::sendAppraiseeNotification

(

$a_user_id

)

Send appraisee notification.

Parameters

int

$a_user_id

user id

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

References ilObject\$lng, ilObjUser\_lookupLogin(), ilObject\getRefId(), and ilObject\getTitle().

Referenced by addAppraisee().

    {
        $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_360_appraisee_mail");
        $subject = str_replace("%1", $this->getTitle(), $lng->txt("svy_user_added_360_appraisee"));

        // #10044
        $mail = new ilMail(ANONYMOUS_USER_ID);
        $mail->enqueue(
            ilObjUser::_lookupLogin($a_user_id),
            null,
            null,
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendCodes()

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

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

References $data, ilObject\$db, $DIC, $ilDB, $lang, $message, $url, ilLink\_getLink(), getExternalCodeRecipients(), ilObject\getRefId(), and getSurveyId().

    {
        global $DIC;
        /*
         * 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 ((int) $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())
        );
    }

Here is the call graph for this function:

sendNotificationMail()

ilObjSurvey::sendNotificationMail	(		$a_user_id,
			$a_anonymize_id,
			$a_appr_id
	)

Parameters

$a_user_id	user who did the survey
$a_anonymize_id
$a_appr_id

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

References $data, ilObject\$lng, $mailparticipantdata, ilObjUser\_getUserData(), getActiveID(), ilUserUtil\getNamePresentation(), getParticipantTextResults(), ilObject\getRefId(), ilObjUser\getUserIdsByEmail(), and hasAnonymizedResults().

    {
        // #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 = preg_split('/,/', $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;
            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);
            $ntf->addAdditionalInfo(
                'results',
                $this->getParticipantTextResults($active_id),
                true
            );
                                    
            $ntf->setGotoLangId('survey_notification_tutor_link');
            $ntf->setReasonLangId('survey_notification_finished_reason');

            if (is_numeric($recipient)) {
                $lng = $ntf->getUserLanguage($recipient);
                $ntf->sendMail(array($recipient), null, null);
            } else {
                $recipient = trim($recipient);
                $user_ids = ilObjUser::getUserIdsByEmail($recipient);
                if (empty($user_ids)) {
                    $ntf->sendMail(array($recipient), null, null);
                } else {
                    foreach ($user_ids as $user_id) {
                        $lng = $ntf->getUserLanguage($user_id);
                        $ntf->sendMail(array($user_id), null, null);
                    }
                }
            }
        }
    }

Here is the call graph for this function:

sendRaterNotification()

ilObjSurvey::sendRaterNotification	(		$a_user_id,
			$a_appraisee_id
	)

Send rater notification.

Parameters

int

$a_user_id

user id

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

References ilObject\$lng, ilObjUser\_lookupLogin(), ilUserUtil\getNamePresentation(), ilObject\getRefId(), and ilObject\getTitle().

Referenced by addRater().

    {
        $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_360_rater_mail");
        $subject = str_replace("%1", $this->getTitle(), $lng->txt("svy_user_added_360_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),
            null,
            null,
            $subject,
            $ntf->composeAndGetMessage($a_user_id, null, "read", true),
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendTutorNotification()

ilObjSurvey::sendTutorNotification ( )

protected

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

References $message, ilLanguageFactory\_getLanguageOfUser(), ilLink\_getStaticLink(), ilObjUser\_lookupFullname(), ilObjUser\_lookupLogin(), ilObject\getRefId(), ilObject\getTitle(), and getTutorNotificationRecipients().

Referenced by checkTutorNotification().

    {
        $link = ilLink::_getStaticLink($this->getRefId(), "svy");
            
        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()
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendTutorResults()

ilObjSurvey::sendTutorResults

(

)

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

References $_GET, $ilCtrl, $ilDB, $log, $message, ilLanguageFactory\_getLanguageOfUser(), ilLink\_getStaticLink(), ilObjUser\_lookupFullname(), ilObjUser\_lookupLogin(), ilLoggerFactory\getLogger(), ilObject\getRefId(), getSurveyId(), ilObject\getTitle(), getTutorResultsRecipients(), ILIAS_HTTP_PATH, and ilHtmlToPdfTransformerFactory\PDF_OUTPUT_FILE.

    {
        global $ilCtrl, $ilDB;

        $log = ilLoggerFactory::getLogger("svy");
        
        include_once "./Services/Mail/classes/class.ilMail.php";
        include_once "./Services/User/classes/class.ilObjUser.php";
        include_once "./Services/Language/classes/class.ilLanguageFactory.php";
        include_once "./Services/User/classes/class.ilUserUtil.php";
        
        include_once "./Services/Link/classes/class.ilLink.php";
        $link = ilLink::_getStaticLink($this->getRefId(), "svy");
        
        // somehow needed in cron-calls
        //$ilCtrl->setTargetScript("ilias.php");
        //$ilCtrl->initBaseClass("ilobjsurveygui");
        
        // yeah, I know...
        $old_ref_id = $_GET["ref_id"];
        $old_base_class = $_GET["baseClass"];
        $_GET["ref_id"] = $this->getRefId();
        $ilCtrl->setTargetScript("ilias.php");
        $_GET["baseClass"] = "ilObjSurveyGUI";

        $ilCtrl->setParameterByClass("ilSurveyEvaluationGUI", "ref_id", $this->getRefId());

        try {
            $gui = new ilSurveyEvaluationGUI($this);
            $html = $gui->evaluation(1, true, true);
        } catch (Exception $exception) {
            $_GET["ref_id"] = $old_ref_id;
            $_GET["baseClass"] = $old_base_class;
            throw $exception;
        }
        $_GET["ref_id"] = $old_ref_id;
        $_GET["baseClass"] = $old_base_class;

        $html = preg_replace("/\?dummy\=[0-9]+/", "", $html);
        $html = preg_replace("/\?vers\=[0-9A-Za-z\-]+/", "", $html);
        $html = str_replace('.css$Id$', ".css", $html);
        $html = preg_replace("/src=\"\\.\\//ims", "src=\"" . ILIAS_HTTP_PATH . "/", $html);
        $html = preg_replace("/href=\"\\.\\//ims", "href=\"" . ILIAS_HTTP_PATH . "/", $html);

        $log->debug("--pdf start, ref id " . $this->getRefId());
        $log->debug("html length: " . strlen($html));
        $log->debug("html (first 1000 chars): " . substr($html, 0, 1000));
        //echo $html; exit;
        $pdf_factory = new ilHtmlToPdfTransformerFactory();
        $pdf = $pdf_factory->deliverPDFFromHTMLString($html, "survey.pdf", ilHtmlToPdfTransformerFactory::PDF_OUTPUT_FILE, "Survey", "Results");
        $log->debug("--pdf end");

        /*
        $log->debug("calling phantom for ref_id: " . $this->getRefId());

        $pdf = $gui->callPdfGeneration($url, "pdf", true, true);

        $log->debug("phantom called : " . $pdf);*/
        
        if (!$pdf ||
            !file_exists($pdf)) {
            return false;
        }
        
        // prepare mail attachment
        require_once 'Services/Mail/classes/class.ilFileDataMail.php';
        $att = "survey_" . $this->getRefId() . ".pdf";
        $mail_data = new ilFileDataMail(ANONYMOUS_USER_ID);
        $mail_data->copyAttachmentFile($pdf, $att);
            
        foreach ($this->getTutorResultsRecipients() as $user_id) {
            // use language of recipient to compose message
            $ulng = ilLanguageFactory::_getLanguageOfUser($user_id);
            $ulng->loadLanguageModule('survey');

            $subject = sprintf($ulng->txt('survey_results_tutor_subject'), $this->getTitle());
            $message = sprintf($ulng->txt('survey_notification_tutor_salutation'), ilObjUser::_lookupFullname($user_id)) . "\n\n";

            $message .= $ulng->txt('survey_results_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);
            $log->debug("send mail to user id: " . $user_id . ",login: " . ilObjUser::_lookupLogin($user_id));
            $mail_obj->enqueue(
                ilObjUser::_lookupLogin($user_id),
                "",
                "",
                $subject,
                $message,
                array($att)
            );
        }
        
        $ilDB->manipulate("UPDATE svy_svy" .
            " SET tutor_res_cron = " . $ilDB->quote(1, "integer") .
            " WHERE survey_id = " . $ilDB->quote($this->getSurveyId(), "integer"));

        return true;
    }

Here is the call graph for this function:

sent360Reminders()

ilObjSurvey::sent360Reminders

(

)

Send 360 reminders.

Parameters

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

References $access, $app, $DIC, ilObject\$id, get360SelfAppraisee(), get360SelfEvaluation(), getAppraiseesData(), getRatersData(), getReminderTarget(), is360SurveyStarted(), isAppraiseeClosed(), NOTIFICATION_APPRAISEES, NOTIFICATION_APPRAISEES_AND_RATERS, NOTIFICATION_RATERS, and send360ReminderToUser().

Referenced by checkReminder().

    {
        global $DIC;

        $access = $DIC->access();

        // collect all open ratings
        $rater_ids = array();
        foreach ($this->getAppraiseesData() as $app) {
            $this->log->debug("Handle appraisee " . $app['user_id']);

            if (!$this->isAppraiseeClosed($app['user_id'])) {
                $this->log->debug("Check self evaluation, self: " . $this->get360SelfAppraisee() . ", target: " . $this->getReminderTarget());

                // self evaluation?
                if ($this->get360SelfEvaluation() &&
                    in_array($this->getReminderTarget(), array(ilObjSurvey::NOTIFICATION_APPRAISEES, ilObjSurvey::NOTIFICATION_APPRAISEES_AND_RATERS))) {
                    $this->log->debug("...1");
                    // did user already finished self evaluation?
                    if (!$this->is360SurveyStarted($app['user_id'], $app['user_id'])) {
                        $this->log->debug("...2");
                        if (!is_array($rater_ids[$app['user_id']])) {
                            $rater_ids[$app['user_id']] = array();
                        }
                        if (!in_array($app["user_id"], $rater_ids[$app['user_id']])) {
                            $rater_ids[$app['user_id']][] = $app["user_id"];
                        }
                    }
                }

                $this->log->debug("Check raters.");

                // should raters be notified?
                if (in_array($this->getReminderTarget(), array(ilObjSurvey::NOTIFICATION_RATERS, ilObjSurvey::NOTIFICATION_APPRAISEES_AND_RATERS))) {
                    foreach ($this->getRatersData($app['user_id']) as $rater) {
                        // is rater not anonymous and did not rate yet?
                        if (!$rater["anonymous_id"] && !$rater["finished"]) {
                            if (!is_array($rater_ids[$rater["user_id"]])) {
                                $rater_ids[$rater["user_id"]] = array();
                            }
                            if (!in_array($app["user_id"], $rater_ids[$rater["user_id"]])) {
                                $rater_ids[$rater["user_id"]][] = $app["user_id"];
                            }
                        }
                    }
                }
            }
        }

        $this->log->debug("Found raters:" . count($rater_ids));

        foreach ($rater_ids as $id => $app) {
            if ($access->checkAccessOfUser($id, "read", "", $this->getRefId())) {
                $this->send360ReminderToUser($id, $app);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sentReminderPlaceholders()

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

protected

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

References $context, Vendor\Package\$e, $user, ilLoggerFactory\getLogger(), ilMailTemplateContextService\getTemplateContextById(), and ilSurveyMailTemplateReminderContext\ID.

Referenced by checkReminder().

    {
        // see ilMail::replacePlaceholders()
        try {
            $context = \ilMailTemplateContextService::getTemplateContextById(ilSurveyMailTemplateReminderContext::ID);

            $user = new \ilObjUser($a_user_id);

            $processor = new \ilMailTemplatePlaceholderResolver($context, $a_message);
            $a_message = $processor->resolve($user, $a_context_params);
        } catch (\Exception $e) {
            ilLoggerFactory::getLogger('mail')->error(__METHOD__ . ' has been called with invalid context.');
        }

        return $a_message;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

set360RaterSent()

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

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

References ilObject\$db, $ilDB, and getSurveyId().

    {
        $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"));
    }

Here is the call graph for this function:

set360Results()

ilObjSurvey::set360Results

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->mode_360_results = (int) $a_value;
    }

Here is the caller graph for this function:

set360SelfAppraisee()

ilObjSurvey::set360SelfAppraisee

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->mode_360_self_appr = (bool) $a_value;
    }

Here is the caller graph for this function:

set360SelfEvaluation()

ilObjSurvey::set360SelfEvaluation

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->mode_360_self_eval = (bool) $a_value;
    }

Here is the caller graph for this function:

set360SelfRaters()

ilObjSurvey::set360SelfRaters

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->mode_360_self_rate = (bool) $a_value;
    }

Here is the caller graph for this function:

setActivationEndDate()

ilObjSurvey::setActivationEndDate

(

$ending_time = null

)

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

Referenced by loadFromDb().

    {
        $this->activation_ending_time = $ending_time;
    }

Here is the caller graph for this function:

setActivationLimited()

ilObjSurvey::setActivationLimited

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->activation_limited = (bool) $a_value;
    }

Here is the caller graph for this function:

setActivationStartDate()

ilObjSurvey::setActivationStartDate

(

$starting_time = null

)

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

Referenced by loadFromDb().

    {
        $this->activation_starting_time = $starting_time;
    }

Here is the caller graph for this function:

setActivationVisibility()

ilObjSurvey::setActivationVisibility

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->activation_visibility = (bool) $a_value;
    }

Here is the caller graph for this function:

setAnonymize()

ilObjSurvey::setAnonymize

(

$a_anonymize

)

set anonymize status

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

Referenced by applySettingsTemplate(), and loadFromDb().

    {
        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;
        }
    }

Here is the caller graph for this function:

setAnonymousUserList()

ilObjSurvey::setAnonymousUserList

(

$a_value

)

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

Referenced by applySettingsTemplate(), and loadFromDb().

    {
        $this->anon_user_list = (bool) $a_value;
    }

Here is the caller graph for this function:

setAuthor()

ilObjSurvey::setAuthor

(

$author = ""

)

Sets the authors name of the ilObjSurvey object.

Parameters

string

$author

A string containing the name of the test author public

See also

$author

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

References $author.

Referenced by loadFromDb().

    {
        $this->author = $author;
    }

Here is the caller graph for this function:

setEndDate()

ilObjSurvey::setEndDate

(

$end_date = ""

)

Sets the end date of the survey.

Parameters

string

$end_date

Survey end date (YYYYMMDDHHMMSS) public

See also

$end_date

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

References $end_date.

Referenced by loadFromDb().

    {
        $this->end_date = $end_date;
    }

Here is the caller graph for this function:

setEndDateAndTime()

ilObjSurvey::setEndDateAndTime	(		$end_date = "",
			$end_time
	)

Sets the end date of the survey.

Parameters

string	$end_date	Survey end date (YYYY-MM-DD)
string	$end_time	Survey end time (HH:MM:SS) public

See also

$start_date

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

References $d, $end_date, and $i.

    {
        $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);
    }

setEndTime()

ilObjSurvey::setEndTime

(

$finished_id

)

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

References $_SESSION, ilObject\$db, and $ilDB.

    {
        $ilDB = $this->db;
        $time = time();
        $affectedRows = $ilDB->manipulateF(
            "UPDATE svy_times SET left_page = %s WHERE finished_fi = %s AND entered_page = %s",
            array('integer', 'integer', 'integer'),
            array($time, $finished_id, $_SESSION['svy_entered_page'])
        );
        unset($_SESSION['svy_entered_page']);
    }

setEvaluationAccess()

ilObjSurvey::setEvaluationAccess

(

$evaluation_access = self::EVALUATION_ACCESS_OFF

)

Sets the learners evaluation access.

Parameters

integer

$evaluation_access

The evaluation access public

See also

$evaluation_access

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

References $evaluation_access.

Referenced by applySettingsTemplate(), and loadFromDb().

    {
        $this->evaluation_access = ($evaluation_access) ? $evaluation_access : self::EVALUATION_ACCESS_OFF;
    }

Here is the caller graph for this function:

setIntroduction()

ilObjSurvey::setIntroduction

(

$introduction = ""

)

Sets the introduction text.

Parameters

string

$introduction

A string containing the introduction

See also

$introduction

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

References $introduction.

Referenced by importObject(), and loadFromDb().

    {
        $this->introduction = $introduction;
    }

Here is the caller graph for this function:

setMailAddresses()

ilObjSurvey::setMailAddresses

(

$a_addresses

)

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

Referenced by loadFromDb().

    {
        $this->mailaddresses = $a_addresses;
    }

Here is the caller graph for this function:

setMailConfirmation()

ilObjSurvey::setMailConfirmation

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->mail_confirmation = (bool) $a_value;
    }

Here is the caller graph for this function:

setMailNotification()

ilObjSurvey::setMailNotification

(

$a_notification

)

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

Referenced by loadFromDb().

    {
        $this->mailnotification = ($a_notification) ? true : false;
    }

Here is the caller graph for this function:

setMailOwnResults()

ilObjSurvey::setMailOwnResults

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->mail_own_results = (bool) $a_value;
    }

Here is the caller graph for this function:

setMailParticipantData()

ilObjSurvey::setMailParticipantData

(

$a_data

)

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

Referenced by loadFromDb().

    {
        $this->mailparticipantdata = $a_data;
    }

Here is the caller graph for this function:

setMode()

ilObjSurvey::setMode

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->mode = $a_value;
    }

Here is the caller graph for this function:

setObligatoryStates()

ilObjSurvey::setObligatoryStates

(

$obligatory_questions

)

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

Parameters

array

$obligatory_questions

The questions which should be set obligatory from the questions form, the remaining questions should be setted not obligatory public

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

References ilObject\$db, $ilDB, $result, and getSurveyId().

    {
        $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"));
        }
    }

Here is the call graph for this function:

setOutro()

ilObjSurvey::setOutro

(

$outro = ""

)

Sets the outro text.

Parameters

string

$outro

A string containing the outro

See also

$outro

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

References $outro.

Referenced by importObject(), and loadFromDb().

    {
        $this->outro = $outro;
    }

Here is the caller graph for this function:

setPage()

ilObjSurvey::setPage	(		$finished_id,
			$page_id
	)

Sets the number of the active survey page.

Parameters

integer	$finished_id	The database id of the active user
integer	$page_id	The index of the page public

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

References ilObject\$db, and $ilDB.

    {
        $ilDB = $this->db;

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

setPoolUsage()

ilObjSurvey::setPoolUsage

(

$a_value

)

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

Referenced by applySettingsTemplate(), and loadFromDb().

    {
        $this->pool_usage = (bool) $a_value;
    }

Here is the caller graph for this function:

setReminderEnd()

ilObjSurvey::setReminderEnd

(

ilDate

$a_value = null

)

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

Referenced by loadFromDb().

    {
        $this->reminder_end = $a_value;
    }

Here is the caller graph for this function:

setReminderFrequency()

ilObjSurvey::setReminderFrequency

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->reminder_frequency = (int) $a_value;
    }

Here is the caller graph for this function:

setReminderLastSent()

ilObjSurvey::setReminderLastSent

(

$a_value

)

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

Referenced by checkReminder(), and loadFromDb().

    {
        $this->reminder_last_sent = $a_value;
    }

Here is the caller graph for this function:

setReminderStart()

ilObjSurvey::setReminderStart

(

ilDate

$a_value = null

)

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

Referenced by loadFromDb().

    {
        $this->reminder_start = $a_value;
    }

Here is the caller graph for this function:

setReminderStatus()

ilObjSurvey::setReminderStatus

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->reminder_status = (bool) $a_value;
    }

Here is the caller graph for this function:

setReminderTarget()

ilObjSurvey::setReminderTarget

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->reminder_target = (int) $a_value;
    }

Here is the caller graph for this function:

setReminderTemplate()

ilObjSurvey::setReminderTemplate

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->reminder_tmpl = $a_value;
    }

Here is the caller graph for this function:

setSelfEvaluationResults()

ilObjSurvey::setSelfEvaluationResults

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->mode_self_eval_results = $a_value;
    }

Here is the caller graph for this function:

setShowQuestionTitles()

ilObjSurvey::setShowQuestionTitles

(

$a_show

)

Sets the status of the display_question_titles attribute.

Parameters

integer

$a_show

The status of the display_question_titles attribute

See also

$display_question_titles

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

Referenced by applySettingsTemplate(), and loadFromDb().

    {
        $this->display_question_titles = ($a_show) ? 1 : 0;
    }

Here is the caller graph for this function:

setSkillService()

ilObjSurvey::setSkillService

(

$a_val

)

Set skill service.

Parameters

bool

$a_val

activate skill service

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

Referenced by loadFromDb().

    {
        $this->mode_skill_service = $a_val;
    }

Here is the caller graph for this function:

setStartDate()

ilObjSurvey::setStartDate

(

$start_date = ""

)

Sets the start date of the survey.

Parameters

string

$start_data

Survey start date (YYYYMMDDHHMMSS) public

See also

$start_date

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

References $start_date.

Referenced by loadFromDb().

    {
        $this->start_date = $start_date;
    }

Here is the caller graph for this function:

setStartDateAndTime()

ilObjSurvey::setStartDateAndTime	(		$start_date = "",
			$start_time
	)

Sets the start date of the survey.

Parameters

string	$start_date	Survey start date (YYYY-MM-DD)
string	$start_time	Survey start time (HH:MM:SS) public

See also

$start_date

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

References $d, $i, and $start_date.

    {
        $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);
    }

setStartTime()

ilObjSurvey::setStartTime	(		$finished_id,
			$first_question
	)

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

References $_SESSION, ilObject\$db, ilObject\$id, and $ilDB.

    {
        $ilDB = $this->db;
        $time = time();
        //primary for table svy_times
        $id = $ilDB->nextId('svy_times');
        $_SESSION['svy_entered_page'] = $time;
        $affectedRows = $ilDB->manipulateF(
            "INSERT INTO svy_times (id, finished_fi, entered_page, left_page, first_question) VALUES (%s, %s, %s, %s,%s)",
            array('integer','integer', 'integer', 'integer', 'integer'),
            array($id, $finished_id, $time, null, $first_question)
        );
    }

setSurveyId()

ilObjSurvey::setSurveyId

(

$survey_id

)

Sets the survey id.

Parameters

integer

$survey_id

The survey id

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

References $survey_id.

Referenced by loadFromDb(), and saveToDb().

    {
        $this->survey_id = $survey_id;
    }

Here is the caller graph for this function:

setTemplate()

ilObjSurvey::setTemplate

(

$template_id

)

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

References $template_id.

Referenced by applySettingsTemplate(), and loadFromDb().

    {
        $this->template_id = (int) $template_id;
    }

Here is the caller graph for this function:

setTutorNotificationRecipients()

ilObjSurvey::setTutorNotificationRecipients

(

array

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->tutor_ntf_recipients = $a_value;
    }

Here is the caller graph for this function:

setTutorNotificationStatus()

ilObjSurvey::setTutorNotificationStatus

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->tutor_ntf_status = (bool) $a_value;
    }

Here is the caller graph for this function:

setTutorNotificationTarget()

ilObjSurvey::setTutorNotificationTarget

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->tutor_ntf_target = (int) $a_value;
    }

Here is the caller graph for this function:

setTutorResultsRecipients()

ilObjSurvey::setTutorResultsRecipients

(

array

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->tutor_res_recipients = $a_value;
    }

Here is the caller graph for this function:

setTutorResultsStatus()

ilObjSurvey::setTutorResultsStatus

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->tutor_res_status = (bool) $a_value;
    }

Here is the caller graph for this function:

setViewOwnResults()

ilObjSurvey::setViewOwnResults

(

$a_value

)

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

Referenced by loadFromDb().

    {
        $this->view_own_results = (bool) $a_value;
    }

Here is the caller graph for this function:

showQuestionTitles()

ilObjSurvey::showQuestionTitles

(

)

Sets the question titles visible during the query.

public

See also

$display_question_titles

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

    {
        $this->display_question_titles = 1;
    }

startSurvey()

ilObjSurvey::startSurvey	(		$user_id,
			$anonymous_id,
			$appraisee_id
	)

Starts the survey creating an entry in the database.

Parameters

integer

$user_id

The database id of the user who starts the survey public

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

References ilObject\$db, $ilDB, getAnonymize(), and getSurveyId().

    {
        $ilDB = $this->db;
        
        if ($this->getAnonymize() && (strlen($anonymous_id) == 0)) {
            return;
        }

        if (strcmp($user_id, "") == 0) {
            if ($user_id == ANONYMOUS_USER_ID) {
                $user_id = 0;
            }
        }
        $next_id = $ilDB->nextId('svy_finished');
        $affectedRows = $ilDB->manipulateF(
            "INSERT INTO svy_finished (finished_id, survey_fi, user_fi, anonymous_id, state, tstamp, appr_id) " .
            "VALUES (%s, %s, %s, %s, %s, %s, %s)",
            array('integer','integer','integer','text','text','integer','integer'),
            array($next_id, $this->getSurveyId(), $user_id, $anonymous_id, 0, time(), $appraisee_id)
        );
        return $next_id;
    }

Here is the call graph for this function:

toXML()

ilObjSurvey::toXML

(

)

Returns a QTI xml representation of the survey.

Returns

string The QTI xml representation of the survey public

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

References $xml, addMaterialTag(), get360Results(), get360SelfAppraisee(), get360SelfEvaluation(), get360SelfRaters(), getAnonymize(), getAuthor(), ilObject\getDescription(), getEndDate(), getEvaluationAccess(), ilObject\getId(), getIntroduction(), getMode(), ilObject\getOfflineStatus(), getOutro(), getPoolUsage(), getSelfEvaluationResults(), getShowQuestionTitles(), getSkillService(), getStartDate(), getSurveyId(), getSurveyPages(), ilObject\getTitle(), ilObject\getType(), hasAnonymousUserList(), hasMailConfirmation(), hasMailOwnResults(), hasViewOwnResults(), and ilXmlWriter\xmlHeader().

    {
        $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" => "http://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], $matches[6]));
        }
        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], $matches[6]));
        }
        $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["pool_usage"] = (int) $this->getPoolUsage();
        
        $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"] = (int) $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"] = (int) $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->xmlStartTag("metadatafield");
        $a_xml_writer->xmlElement("fieldlabel", null, "SCORM");
        $md = new ilMD($this->getId(), 0, $this->getType());
        $writer = new ilXmlWriter();
        $md->toXml($writer);
        $metadata = $writer->xmlDumpMem();
        $a_xml_writer->xmlElement("fieldentry", null, $metadata);
        $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"]);
                $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;
    }

Here is the call graph for this function:

unfoldQuestionblocks()

ilObjSurvey::unfoldQuestionblocks

(

$questionblocks

)

Unfolds question blocks of a question pool.

Parameters

array

$questionblocks

An array of question block id's public

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

References ilObject\$db, $ilDB, $index, and getSurveyId().

    {
        $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())
            );
        }
    }

Here is the call graph for this function:

update()

ilObjSurvey::update

(

$a_upload = false

)

update object data

public

Returns

boolean

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

References ilObject\updateMetaData().

    {
        if (!$a_upload) {
            $this->updateMetaData();
        }

        if (!parent::update()) {
            return false;
        }

        // put here object specific stuff
        
        return true;
    }

Here is the call graph for this function:

updateCode()

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

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

References $data, ilObject\$db, $ilDB, and ilUtil\is_email().

    {
        $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;
    }

Here is the call graph for this function:

updateConjunctionForQuestions()

ilObjSurvey::updateConjunctionForQuestions	(		$questions,
			$conjunction
	)

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

References ilObject\$db, $ilDB, and $questions.

    {
        $ilDB = $this->db;
        foreach ($questions as $question_id) {
            $affectedRows = $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)
            );
        }
    }

updateConstraint()

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

Updates a precondition.

Parameters

integer	$precondition_id	The id of the original precondition
integer	$to_question_id	The question id of the question where to add the constraint
integer	$if_question_id	The question id of the question which defines a precondition
integer	$relation	The database id of the relation
mixed	$value	The value compared with the relation public

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

References ilObject\$db, and $ilDB.

    {
        $ilDB = $this->db;
        $affectedRows = $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 4707 of file class.ilObjSurvey.php.

    {
        if (sizeof($this->questions) == sizeof($a_order)) {
            $this->questions = array_flip($a_order);
            $this->saveQuestionsToDB();
        }
    }

validateExternalRaterCode()

static ilObjSurvey::validateExternalRaterCode (   $a_ref_id,   $a_code  )

static

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

References $_SESSION.

Referenced by ilSurveyExecutionGUI\__construct(), ilObjSurveyAccess\_checkGoto(), and ilObjSurveyGUI\executeCommand().

    {
        if (!isset($_SESSION["360_extrtr"][$a_ref_id])) {
            $svy = new self($a_ref_id);
            $svy->loadFromDB();
            
            if ($svy->canStartSurvey(null, true) &&
                $svy->get360Mode() &&
                $svy->isAnonymousKey($a_code)) {
                $anonymous_id = $svy->getAnonymousIdByCode($a_code);
                if ($anonymous_id) {
                    if (sizeof($svy->getAppraiseesToRate(null, $anonymous_id))) {
                        $_SESSION["360_extrtr"][$a_ref_id] = true;
                        return true;
                    }
                }
            }

            $_SESSION["360_extrtr"][$a_ref_id] = false;
            return false;
        }
        
        return $_SESSION["360_extrtr"][$a_ref_id];
    }

Here is the caller graph for this function:

Field Documentation

$access

ilObjSurvey::$access

protected

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

Referenced by addAppraisee(), addRater(), canStartSurvey(), checkReminder(), and sent360Reminders().

$activation_ending_time

ilObjSurvey::$activation_ending_time

protected

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

$activation_starting_time

ilObjSurvey::$activation_starting_time

protected

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

$activation_visibility

ilObjSurvey::$activation_visibility

protected

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

Referenced by getActivationVisibility().

$anon_user_list

ilObjSurvey::$anon_user_list

protected

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

Referenced by hasAnonymousUserList().

$anonymize

ilObjSurvey::$anonymize

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

$author

ilObjSurvey::$author

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

Referenced by getAuthor(), and setAuthor().

$display_question_titles

ilObjSurvey::$display_question_titles

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

$end_date

ilObjSurvey::$end_date

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

Referenced by setEndDate(), and setEndDateAndTime().

$evaluation_access

ilObjSurvey::$evaluation_access

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

Referenced by setEvaluationAccess().

$introduction

ilObjSurvey::$introduction

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

Referenced by setIntroduction().

$invitation_manager

ilObjSurvey::$invitation_manager

protected

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

$log

ilObjSurvey::$log

protected

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

Referenced by deliverPDFfromFO(), getSurveyFinishedIds(), getSurveysWithTutorResults(), importObject(), and sendTutorResults().

$mail_confirmation

ilObjSurvey::$mail_confirmation

protected

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

Referenced by hasMailConfirmation().

$mail_own_results

ilObjSurvey::$mail_own_results

protected

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

Referenced by hasMailOwnResults().

$mailaddresses

ilObjSurvey::$mailaddresses

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

Referenced by getMailAddresses().

$mailnotification

ilObjSurvey::$mailnotification

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

Referenced by getMailNotification().

$mailparticipantdata

ilObjSurvey::$mailparticipantdata

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

Referenced by getMailParticipantData(), and sendNotificationMail().

$mode

ilObjSurvey::$mode

protected

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

Referenced by getMode().

$mode_360_results

ilObjSurvey::$mode_360_results

protected

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

Referenced by get360Results().

$mode_360_self_appr

ilObjSurvey::$mode_360_self_appr

protected

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

Referenced by get360SelfAppraisee().

$mode_360_self_eval

ilObjSurvey::$mode_360_self_eval

protected

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

Referenced by get360SelfEvaluation().

$mode_360_self_rate

ilObjSurvey::$mode_360_self_rate

protected

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

Referenced by get360SelfRaters().

$mode_self_eval_results

ilObjSurvey::$mode_self_eval_results

protected

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

Referenced by getSelfEvaluationResults().

$mode_skill_service

ilObjSurvey::$mode_skill_service

protected

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

Referenced by getSkillService().

$outro

ilObjSurvey::$outro

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

Referenced by setOutro().

$plugin_admin

ilObjSurvey::$plugin_admin

protected

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

Referenced by isPluginActive().

$pool_usage

ilObjSurvey::$pool_usage

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

Referenced by getPoolUsage().

$questions

ilObjSurvey::$questions

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

Referenced by createQuestionblock(), getEvaluationByUser(), getParticipantTextResults(), insertQuestionblock(), and updateConjunctionForQuestions().

$reminder_end

ilObjSurvey::$reminder_end

protected

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

Referenced by getReminderEnd().

$reminder_frequency

ilObjSurvey::$reminder_frequency

protected

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

Referenced by getReminderFrequency().

$reminder_last_sent

ilObjSurvey::$reminder_last_sent

protected

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

Referenced by getReminderLastSent().

$reminder_start

ilObjSurvey::$reminder_start

protected

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

Referenced by getReminderStart().

$reminder_status

ilObjSurvey::$reminder_status

protected

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

Referenced by getReminderStatus().

$reminder_target

ilObjSurvey::$reminder_target

protected

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

Referenced by getReminderTarget().

$reminder_tmpl

ilObjSurvey::$reminder_tmpl

protected

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

Referenced by getReminderTemplate().

$start_date

ilObjSurvey::$start_date

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

Referenced by setStartDate(), and setStartDateAndTime().

$survey_id

ilObjSurvey::$survey_id

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

Referenced by _getConstraints(), _hasDatasets(), getQuestionblockQuestions(), getQuestionblocksTable(), getSurveyId(), and setSurveyId().

$surveyCodeSecurity

ilObjSurvey::$surveyCodeSecurity

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

$template_id

ilObjSurvey::$template_id

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

Referenced by applySettingsTemplate(), getTemplate(), and setTemplate().

$tutor_ntf_recipients

ilObjSurvey::$tutor_ntf_recipients

protected

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

Referenced by getTutorNotificationRecipients().

$tutor_ntf_status

ilObjSurvey::$tutor_ntf_status

protected

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

Referenced by getTutorNotificationStatus().

$tutor_ntf_target

ilObjSurvey::$tutor_ntf_target

protected

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

Referenced by getTutorNotificationTarget().

$tutor_res_recipients

ilObjSurvey::$tutor_res_recipients

protected

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

Referenced by getTutorResultsRecipients().

$tutor_res_status

ilObjSurvey::$tutor_res_status

protected

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

Referenced by getTutorResultsStatus().

$user

ilObjSurvey::$user

protected

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

Referenced by closeAppraisee(), createQuestionblock(), duplicateQuestionForSurvey(), finishSurvey(), getQuestionblocksTable(), getQuestionsTable(), getSurveyCodesForExport(), getUserDataFromActiveId(), getUserSurveyExecutionStatus(), saveAuthorToMetadata(), and sentReminderPlaceholders().

$view_own_results

ilObjSurvey::$view_own_results

protected

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

Referenced by hasViewOwnResults().

ANONYMIZE_CODE_ALL

const ilObjSurvey::ANONYMIZE_CODE_ALL = 3

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

Referenced by ilObjSurveyGUI\afterSave(), applySettingsTemplate(), and ilObjSurveyGUI\savePropertiesObject().

ANONYMIZE_FREEACCESS

const ilObjSurvey::ANONYMIZE_FREEACCESS = 2

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

Referenced by applySettingsTemplate(), and ilObjSurveyGUI\savePropertiesObject().

ANONYMIZE_OFF

const ilObjSurvey::ANONYMIZE_OFF = 0

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

Referenced by applySettingsTemplate(), and ilObjSurveyGUI\savePropertiesObject().

ANONYMIZE_ON

const ilObjSurvey::ANONYMIZE_ON = 1

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

Referenced by applySettingsTemplate(), and ilObjSurveyGUI\savePropertiesObject().

EVALUATION_ACCESS_ALL

const ilObjSurvey::EVALUATION_ACCESS_ALL = 1

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

Referenced by ilSurveyEvaluationGUI\evaluation(), ilObjSurveyAdministrationGUI\getSettingsTemplateConfig(), and ilObjSurveyGUI\initPropertiesForm().

EVALUATION_ACCESS_OFF

const ilObjSurvey::EVALUATION_ACCESS_OFF = 0

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

Referenced by ilSurveyEvaluationGUI\evaluation(), ilObjSurveyAdministrationGUI\getSettingsTemplateConfig(), and ilObjSurveyGUI\initPropertiesForm().

EVALUATION_ACCESS_PARTICIPANTS

const ilObjSurvey::EVALUATION_ACCESS_PARTICIPANTS = 2

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

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

MODE_360

const ilObjSurvey::MODE_360 = 1

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

Referenced by ilObjSurveyAccess\_hasEvaluationAccess(), ilObjSurveyAccess\_lookup360Mode(), ilSurveyEvaluationGUI\addApprSelectionToToolbar(), ilObjSurveyGUI\afterSave(), get360Mode(), ilObjSurveyListGUI\getProperties(), ilObjSurveyGUI\getTabs(), importObject(), ilObjSurveyGUI\initPropertiesForm(), ilObjSurveyGUI\savePropertiesObject(), and ilSurveySkill\writeAndAddSelfEvalSkills().

MODE_SELF_EVAL

const ilObjSurvey::MODE_SELF_EVAL = 2

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

Referenced by ilSurveyEvaluationGUI\__construct(), ilObjSurveyAccess\_hasEvaluationAccess(), ilSurveyEvaluationGUI\addApprSelectionToToolbar(), ilObjSurveyGUI\afterSave(), ilSurveyExecutionGUI\checkAuth(), ilSurveyEvaluationGUI\competenceEval(), ilSurveyEvaluationGUI\evaluationuser(), ilObjSurveyGUI\executeCommand(), finishSurvey(), ilObjSurveyListGUI\getProperties(), ilObjSurveyGUI\getTabs(), importObject(), ilObjSurveyGUI\initPropertiesForm(), ilSurveyParticipantsGUI\maintenanceObject(), ilObjSurveyGUI\savePropertiesObject(), and ilSurveySkill\writeAndAddSelfEvalSkills().

MODE_STANDARD

const ilObjSurvey::MODE_STANDARD = 0

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

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

NOTIFICATION_APPRAISEES

const ilObjSurvey::NOTIFICATION_APPRAISEES = 3

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

Referenced by ilObjSurveyGUI\initPropertiesForm(), ilObjSurveyGUI\savePropertiesObject(), and sent360Reminders().

NOTIFICATION_APPRAISEES_AND_RATERS

const ilObjSurvey::NOTIFICATION_APPRAISEES_AND_RATERS = 5

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

Referenced by ilObjSurveyGUI\initPropertiesForm(), ilObjSurveyGUI\savePropertiesObject(), and sent360Reminders().

NOTIFICATION_INVITED_USERS

const ilObjSurvey::NOTIFICATION_INVITED_USERS = 2

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

Referenced by ilObjSurveyGUI\initPropertiesForm().

NOTIFICATION_PARENT_COURSE

const ilObjSurvey::NOTIFICATION_PARENT_COURSE = 1

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

Referenced by ilObjSurveyGUI\initPropertiesForm().

NOTIFICATION_RATERS

const ilObjSurvey::NOTIFICATION_RATERS = 4

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

Referenced by ilObjSurveyGUI\initPropertiesForm(), ilObjSurveyGUI\savePropertiesObject(), and sent360Reminders().

PRINT_HIDE_LABELS

const ilObjSurvey::PRINT_HIDE_LABELS = 1

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

Referenced by ilSurveyEditorGUI\__construct(), and SurveyQuestionGUI\getPrintViewQuestionTitle().

PRINT_SHOW_LABELS

const ilObjSurvey::PRINT_SHOW_LABELS = 3

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

Referenced by ilSurveyEditorGUI\__construct(), and SurveyQuestionGUI\getPrintViewQuestionTitle().

QUESTIONTITLES_HIDDEN

const ilObjSurvey::QUESTIONTITLES_HIDDEN = 0

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

QUESTIONTITLES_VISIBLE

const ilObjSurvey::QUESTIONTITLES_VISIBLE = 1

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

RESULTS_360_ALL

const ilObjSurvey::RESULTS_360_ALL = 2

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

Referenced by ilObjSurveyAccess\_hasEvaluationAccess(), ilSurveyEvaluationGUI\addApprSelectionToToolbar(), ilSurveyEvaluationGUI\determineAppraiseeId(), and ilObjSurveyGUI\initPropertiesForm().

RESULTS_360_NONE

const ilObjSurvey::RESULTS_360_NONE = 0

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

Referenced by ilObjSurveyAccess\_hasEvaluationAccess(), and ilObjSurveyGUI\initPropertiesForm().

RESULTS_360_OWN

const ilObjSurvey::RESULTS_360_OWN = 1

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

Referenced by ilObjSurveyAccess\_hasEvaluationAccess(), and ilObjSurveyGUI\initPropertiesForm().

RESULTS_SELF_EVAL_ALL

const ilObjSurvey::RESULTS_SELF_EVAL_ALL = 2

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

Referenced by ilSurveyEvaluationGUI\addApprSelectionToToolbar(), and ilObjSurveyGUI\initPropertiesForm().

RESULTS_SELF_EVAL_NONE

const ilObjSurvey::RESULTS_SELF_EVAL_NONE = 0

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

Referenced by ilObjSurveyAccess\_hasEvaluationAccess(), and ilObjSurveyGUI\initPropertiesForm().

RESULTS_SELF_EVAL_OWN

const ilObjSurvey::RESULTS_SELF_EVAL_OWN = 1

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

Referenced by ilObjSurveyGUI\initPropertiesForm(), and saveToDb().

---

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

• Modules/Survey/classes/class.ilObjSurvey.php