Inheritance diagram for ilObjSurveyQuestionPool:

Collaboration diagram for ilObjSurveyQuestionPool:

Public Member Functions
	ilObjSurveyQuestionPool ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...

	create ($a_upload=false)
	create question pool object More...

	update ()
	update object data More...

	read ($a_force_db=false)
	read object data from db into object More...

	cloneObject ($a_target_id, $a_copy_id=0)
	Creates a 1:1 copy of the object and places the copy in a given repository. More...

&	createQuestion ($question_type, $question_id=-1)

	copyQuestion ($question_id, $questionpool_to)
	Copies a question into another question pool. More...

	loadFromDb ()
	Loads a ilObjQuestionpool object from a database. More...

	saveToDb ()
	Saves a ilObjSurveyQuestionPool object to a database. More...

	delete ()
	delete object and all related data More...

	deleteAllData ()

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event happend, each object may decide how it reacts. More...

	removeQuestion ($question_id)
	Removes a question from the question pool. More...

	getQuestiontype ($question_id)
	Returns the question type of a question with a given id. More...

	isInUse ($question_id)
	Checks if a question is in use by a survey. More...

	paste ($question_id)
	Pastes a question in the question pool. More...

&	getQuestionsInfo ($question_array)
	Retrieves the datase entries for questions from a given array. More...

	duplicateQuestion ($question_id, $obj_id="")
	Duplicates a question for a questionpool. More...

	getQuestionsData ($arrFilter)
	Calculates the data for the output of the questionpool. More...

	createExportDirectory ()
	creates data directory for export files (data_dir/spl_data/spl_<id>/export, depending on data directory that is set in ILIAS setup/ini) More...

	getExportDirectory ()
	get export directory of survey More...

	getExportFiles ($dir)
	get export files More...

	createImportDirectory ()
	creates data directory for import files (data_dir/spl_data/spl_<id>/import, depending on data directory that is set in ILIAS setup/ini) More...

	getImportDirectory ()
	get import directory of survey More...

	toXML ($questions)
	export questions to xml More...

&	getQuestions ()

	importObject ($source, $spl_exists=FALSE)
	Imports survey questions into ILIAS. More...

	setOnline ($a_online_status)
	Sets the questionpool online status. More...

	getOnline ()

	_lookupOnline ($a_obj_id)

	_isWriteable ($object_id, $user_id)
	Returns true, if the question pool is writeable by a given user. More...

&	_getQuestiontypes ()
	Creates a list of all available question types. More...

	_getAvailableQuestionpools ($use_object_id=FALSE, $could_be_offline=FALSE, $showPath=FALSE, $permission="read")
	Returns the available question pools for the active user. More...

	isPluginActive ($a_pname)
	Checks whether or not a question plugin with a given name is active. More...

	getQuestionInfos ($question_ids)
	Returns title, description and type for an array of question id's. More...

	purgeQuestions ()

	copyToClipboard ($question_id)
	Copies a question to the clipboard. More...

	moveToClipboard ($question_id)
	Moves a question to the clipboard. More...

	pasteFromClipboard ()
	Copies/Moves a question from the clipboard. More...

	setObligatoryStates ($obligatory_questions)
	Sets the obligatory states for questions in a survey from the questions form. More...

Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ($a_force_db=false)
	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...

	getOwner ()
	get object owner More...

	getOwnerName ()

	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

	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...

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...

	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

	_lookupOwner ($a_id)
	lookup object owner More...

	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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...

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

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type 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...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

	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...

	_lookupCreationDate ($a_id)
	Lookup creation date. 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	_setOnline ($a_obj_id, $a_online_status)

static &	_getQuestionTypeTranslations ()

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupObjId ($a_id)

static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_lookupObjectId ($a_ref_id)
	lookup object id 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	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. 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	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
	$online

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$ilias

	$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

	$obj_data_record
	object_data record More...

Detailed Description

Definition at line 36 of file class.ilObjSurveyQuestionPool.php.

Member Function Documentation

◆ _getAvailableQuestionpools()

ilObjSurveyQuestionPool::_getAvailableQuestionpools	(	$use_object_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 1030 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $ilUser, ilObject\$ref_id, $result, $row, ilUtil\_getObjectsByOperations(), ilObject\_lookupObjectId(), and ilObject\_prepareCloneSelection().

Referenced by ilSurveyQuestionbrowserTableGUI\__construct(), ilObjSurvey\getAvailableQuestionpools(), and ilObjSurvey\getQuestionpoolTitles().

         {
                 global $ilUser;
                 global $ilDB;
 
                 $result_array = array();
                 $qpls = ilUtil::_getObjectsByOperations("spl", $permission, $ilUser->getId(), -1);
                 $titles = ilObject::_prepareCloneSelection($qpls, "spl", $showPath);
                 $allqpls = array();
                 $result = $ilDB->query("SELECT obj_fi, isonline FROM svy_qpl");         
                 while ($row = $ilDB->fetchAssoc($result))
                 {
                         $allqpls[$row['obj_fi']] = $row['isonline'];
                 }
                 foreach ($qpls as $ref_id)
                 {
                         $obj_id = ilObject::_lookupObjectId($ref_id);
                         if ($could_be_offline || $allqpls[$obj_id] == 1)
                         {
                                 if ($use_object_id)
                                 {
                                         $result_array[$obj_id] = $titles[$ref_id];
                                 }
                                 else
                                 {
                                         $result_array[$ref_id] = $titles[$ref_id];
                                 }
                         }
                 }
                 return $result_array;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getQuestiontypes()

& ilObjSurveyQuestionPool::_getQuestiontypes ( )

Creates a list of all available question types.

Returns: array An array containing the available questiontypes public

Definition at line 918 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, ilObject\$lng, $row, ilObject\$type, ilPlugin\getPluginObject(), and IL_COMP_MODULE.

Referenced by ilSurveyPageGUI\addQuestion(), ilSurveyPageGUI\addQuestionToolbarForm(), ilSurveyPageGUI\getPageNodes(), ilSurveyQuestionTableGUI\importData(), and ilSurveyEditorGUI\questionsObject().

         {
                 global $ilDB;
                 global $lng;
                 
                 $lng->loadLanguageModule("survey");
                 $types = array();
                 $query_result = $ilDB->query("SELECT * FROM svy_qtype ORDER BY type_tag");
                 while ($row = $ilDB->fetchAssoc($query_result))
                 {
                         //array_push($questiontypes, $row["type_tag"]);
                         if ($row["plugin"] == 0)
                         {
                                 $types[$lng->txt($row["type_tag"])] = $row;
                         }
                         else
                         {
                                 global $ilPluginAdmin;
                                 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_MODULE, "SurveyQuestionPool", "svyq");
                                 foreach ($pl_names as $pl_name)
                                 {                                       
                                         $pl = ilPlugin::getPluginObject(IL_COMP_MODULE, "SurveyQuestionPool", "svyq", $pl_name);
                                         if (strcmp($pl->getQuestionType(), $row["type_tag"]) == 0)
                                         {
                                                 $types[$pl->getQuestionTypeTranslation()] = $row;
                                         }
                                 }
                         }
                 }
                 ksort($types);
                 
                 
                 // #14263 - default sorting             
                 
                 $default_sorting = array_flip(array(
                         "SurveySingleChoiceQuestion", 
                         "SurveyMultipleChoiceQuestion", 
                         "SurveyMatrixQuestion", 
                         "SurveyMetricQuestion",
                         "SurveyTextQuestion"
                 ));
    
                 $sorted = array();
                 $idx = sizeof($default_sorting);
                 foreach($types as $caption => $item)
                 {
                         $type = $item["type_tag"];
                         $item["caption"] = $caption;
                         
                         // default
                         if(array_key_exists($type, $default_sorting))
                         {                               
                                 $sorted[$default_sorting[$type]] = $item;
                         }
                         // plugin (append alphabetically sorted)
                         else
                         {
                                 $sorted[$idx] = $item;
                                 $idx++;
                         }
                 }
                 ksort($sorted);
                 
                 // redo captions as index
                 $types = array();
                 foreach($sorted as $item)
                 {
                         $types[$item["caption"]] = $item;
                 }
                 
                 return $types;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getQuestionTypeTranslations()

static& ilObjSurveyQuestionPool::_getQuestionTypeTranslations ( )

static

Definition at line 991 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $ilLog, ilObject\$lng, $result, $row, ilPlugin\getPluginObject(), and IL_COMP_MODULE.

Referenced by ilObjSurvey\getQuestionsTable().

         {
                 global $ilDB;
                 global $lng;
                 global $ilLog;
                 global $ilPluginAdmin;
                 
                 $lng->loadLanguageModule("survey");
                 $result = $ilDB->query("SELECT * FROM svy_qtype");
                 $types = array();
                 while ($row = $ilDB->fetchAssoc($result))
                 {
                         if ($row["plugin"] == 0)
                         {
                                 $types[$row['type_tag']] = $lng->txt($row["type_tag"]);
                         }
                         else
                         {
                                 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_MODULE, "SurveyQuestionPool", "svyq");
                                 foreach ($pl_names as $pl_name)
                                 {
                                         $pl = ilPlugin::getPluginObject(IL_COMP_MODULE, "SurveyQuestionPool", "svyq", $pl_name);
                                         if (strcmp($pl->getQuestionType(), $row["type_tag"]) == 0)
                                         {
                                                 $types[$row['type_tag']] = $pl->getQuestionTypeTranslation();
                                         }
                                 }
                         }
                 }
                 ksort($types);
                 return $types;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isWriteable()

ilObjSurveyQuestionPool::_isWriteable	(	$object_id,
		$user_id
	)

Returns true, if the question pool is writeable by a given user.

Parameters

integer	$object_id	The object id of the question pool
integer	$user_id	The database id of the user public

Definition at line 895 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $result, ilObject\_getAllReferences(), and ilObject\_hasUntrashedReference().

Referenced by SurveyQuestion\_isWriteable().

         {
                 global $rbacsystem;
                 global $ilDB;
                 
                 $refs = ilObject::_getAllReferences($object_id);
                 $result = false;
                 foreach ($refs as $ref)
                 {
                         if ($rbacsystem->checkAccess("write", $ref) && (ilObject::_hasUntrashedReference($object_id)))
                         {
                                 $result = true;
                         }
                 }
                 return $result;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupOnline()

ilObjSurveyQuestionPool::_lookupOnline ( $a_obj_id )

Definition at line 872 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $result, and $row.

Referenced by ilObjSurveyQuestionPoolListGUI\getProperties().

         {
                 global $ilDB;
                 
                 $result = $ilDB->queryF("SELECT isonline FROM svy_qpl WHERE obj_fi = %s",
                         array('integer'),
                         array($a_obj_id)
                 );
                 if ($result->numRows() == 1)
                 {
                         $row = $ilDB->fetchAssoc($result);
                         return $row["isonline"];
                 }
                 return 0;
         }

Here is the caller graph for this function:

◆ _setOnline()

static ilObjSurveyQuestionPool::_setOnline	(	$a_obj_id,
		$a_online_status
	)

static

Definition at line 827 of file class.ilObjSurveyQuestionPool.php.

References $ilDB.

         {
                 global $ilDB;
                 
                 $status = "0";
                 switch ($a_online_status)
                 {
                         case 0:
                         case 1:
                                 $status = "$a_online_status";
                                 break;
                 }
                 $affectedRows = $ilDB->manipulateF("UPDATE svy_qpl SET isonline = %s  WHERE obj_fi = %s",
                         array('text','integer'),
                         array($status, $a_obj_id)
                 );
         }

◆ cloneObject()

ilObjSurveyQuestionPool::cloneObject	(	$a_target_id,
		$a_copy_id = `0`
	)

Creates a 1:1 copy of the object and places the copy in a given repository.

public

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

References $ilLog, ilCopyWizardOptions\_getInstance(), ilObject\getId(), getOnline(), getQuestions(), and ilObject\getType().

                 {
                         global $ilLog;
                         $newObj = parent::cloneObject($a_target_id,$a_copy_id);
 
                         //copy online status if object is not the root copy object
                         $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
 
                         if(!$cp_options->isRootNode($this->getRefId()))
                         {
                                 $newObj->setOnline($this->getOnline());
                         }
 
                         $newObj->saveToDb();
                         // clone the questions in the question pool
                         $questions =& $this->getQuestions();
                         foreach ($questions as $question_id)
                         {
                                 $newObj->copyQuestion($question_id, $newObj->getId());
                         }
 
                         // clone meta data
                         include_once "./Services/MetaData/classes/class.ilMD.php";
                         $md = new ilMD($this->getId(),0,$this->getType());
                         $new_md =& $md->cloneMD($newObj->getId(),0,$newObj->getType());
 
                         // update the metadata with the new title of the question pool
                         $newObj->updateMetaData();
                         return $newObj;
                 }

Here is the call graph for this function:

◆ copyQuestion()

ilObjSurveyQuestionPool::copyQuestion	(	$question_id,
		$questionpool_to
	)

Copies a question into another question pool.

Parameters

integer	$question_id	Database id of the question
integer	$questionpool_to	Database id of the target questionpool public

Definition at line 161 of file class.ilObjSurveyQuestionPool.php.

References createQuestion(), duplicateQuestion(), and ilObject\getId().

Referenced by pasteFromClipboard().

                 {
                         $question_gui =& $this->createQuestion("", $question_id);
                         if ($question_gui->object->getObjId() == $questionpool_to)
                         {
                                 // the question is copied into the same question pool
                                 $this->duplicateQuestion($question_id);
                         }
                         else
                         {
                                 // the question is copied into another question pool
                                 $newtitle = $question_gui->object->getTitle(); 
                                 if ($question_gui->object->questionTitleExists($question_gui->object->getTitle(), $questionpool_to))
                                 {
                                         $counter = 2;
                                         while ($question_gui->object->questionTitleExists($question_gui->object->getTitle() . " ($counter)", $questionpool_to))
                                         {
                                                 $counter++;
                                         }
                                         $newtitle = $question_gui->object->getTitle() . " ($counter)";
                                 }
                                 $question_gui->object->copyObject($this->getId(), $newtitle);
                         }
                 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyToClipboard()

ilObjSurveyQuestionPool::copyToClipboard ( $question_id )

Copies a question to the clipboard.

Parameters

integer $question_id Object id of the question

Definition at line 1134 of file class.ilObjSurveyQuestionPool.php.

References $_SESSION.

         {
                 if (!array_key_exists("spl_clipboard", $_SESSION))
                 {
                         $_SESSION["spl_clipboard"] = array();
                 }
                 $_SESSION["spl_clipboard"][$question_id] = array("question_id" => $question_id, "action" => "copy");
         }

◆ create()

ilObjSurveyQuestionPool::create ( $a_upload = false )

create question pool object

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

References ilObject\createMetaData().

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

Here is the call graph for this function:

◆ createExportDirectory()

ilObjSurveyQuestionPool::createExportDirectory ( )

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

Definition at line 563 of file class.ilObjSurveyQuestionPool.php.

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

         {
                 include_once "./Services/Utilities/classes/class.ilUtil.php";
                 $spl_data_dir = ilUtil::getDataDir()."/spl_data";
                 ilUtil::makeDir($spl_data_dir);
                 if(!is_writable($spl_data_dir))
                 {
                         $this->ilias->raiseError("Survey Questionpool Data Directory (".$spl_data_dir
                                 .") not writeable.",$this->ilias->error_obj->FATAL);
                 }
                 
                 // create learning module directory (data_dir/lm_data/lm_<id>)
                 $spl_dir = $spl_data_dir."/spl_".$this->getId();
                 ilUtil::makeDir($spl_dir);
                 if(!@is_dir($spl_dir))
                 {
                         $this->ilias->raiseError("Creation of Survey Questionpool Directory failed.",$this->ilias->error_obj->FATAL);
                 }
                 // create Export subdirectory (data_dir/lm_data/lm_<id>/Export)
                 $export_dir = $spl_dir."/export";
                 ilUtil::makeDir($export_dir);
                 if(!@is_dir($export_dir))
                 {
                         $this->ilias->raiseError("Creation of Export Directory failed.",$this->ilias->error_obj->FATAL);
                 }
         }

Here is the call graph for this function:

◆ createImportDirectory()

ilObjSurveyQuestionPool::createImportDirectory ( )

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

Definition at line 643 of file class.ilObjSurveyQuestionPool.php.

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

         {
                 include_once "./Services/Utilities/classes/class.ilUtil.php";
                 $spl_data_dir = ilUtil::getDataDir()."/spl_data";
                 ilUtil::makeDir($spl_data_dir);
                 
                 if(!is_writable($spl_data_dir))
                 {
                         $this->ilias->raiseError("Survey Questionpool Data Directory (".$spl_data_dir
                                 .") not writeable.",$this->ilias->error_obj->FATAL);
                 }
 
                 // create test directory (data_dir/spl_data/spl_<id>)
                 $spl_dir = $spl_data_dir."/spl_".$this->getId();
                 ilUtil::makeDir($spl_dir);
                 if(!@is_dir($spl_dir))
                 {
                         $this->ilias->raiseError("Creation of Survey Questionpool Directory failed.",$this->ilias->error_obj->FATAL);
                 }
 
                 // create import subdirectory (data_dir/spl_data/spl_<id>/import)
                 $import_dir = $spl_dir."/import";
                 ilUtil::makeDir($import_dir);
                 if(!@is_dir($import_dir))
                 {
                         $this->ilias->raiseError("Creation of Import Directory failed.",$this->ilias->error_obj->FATAL);
                 }
         }

Here is the call graph for this function:

◆ createQuestion()

& ilObjSurveyQuestionPool::createQuestion	(	$question_type,
		$question_id = `-1`
	)

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

References getQuestiontype().

Referenced by copyQuestion().

                 {
                         if ((!$question_type) and ($question_id > 0))
                         {
                                 $question_type = $this->getQuestiontype($question_id);
                         }
 
                         include_once "./Modules/SurveyQuestionPool/classes/class.".$question_type."GUI.php";
                         $question_type_gui = $question_type . "GUI";
                         $question =& new $question_type_gui();
 
                         if ($question_id > 0)
                         {
                                 $question->object->loadFromDb($question_id);
                         }
 
                         return $question;
                 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilObjSurveyQuestionPool::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 244 of file class.ilObjSurveyQuestionPool.php.

References deleteAllData(), and ilObject\deleteMetaData().

         {
                 $remove = parent::delete();
                 // always call parent delete function first!!
                 if (!$remove)
                 {
                         return false;
                 }
 
                 // delete all related questions
                 $this->deleteAllData();
 
                 // delete meta data
                 $this->deleteMetaData();
                 
                 return true;
         }

Here is the call graph for this function:

◆ deleteAllData()

ilObjSurveyQuestionPool::deleteAllData ( )

Definition at line 262 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $result, $row, ilUtil\delDir(), ilUtil\getDataDir(), ilObject\getId(), and removeQuestion().

Referenced by delete().

         {
                 global $ilDB;
                 $result = $ilDB->queryF("SELECT question_id FROM svy_question WHERE obj_fi = %s AND original_id IS NULL",
                         array('integer'),
                         array($this->getId())
                 );
                 $found_questions = array();
                 while ($row = $ilDB->fetchAssoc($result))
                 {
                         $this->removeQuestion($row["question_id"]);
                 }
 
                 // delete export files
                 include_once "./Services/Utilities/classes/class.ilUtil.php";
                 $spl_data_dir = ilUtil::getDataDir()."/spl_data";
                 $directory = $spl_data_dir."/spl_".$this->getId();
                 if (is_dir($directory))
                 {
                         include_once "./Services/Utilities/classes/class.ilUtil.php";
                         ilUtil::delDir($directory);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duplicateQuestion()

ilObjSurveyQuestionPool::duplicateQuestion	(	$question_id,
		$obj_id = `""`
	)

Duplicates a question for a questionpool.

Parameters

integer $question_id The database id of the question public

Definition at line 473 of file class.ilObjSurveyQuestionPool.php.

References $ilUser, and SurveyQuestion\_instanciateQuestion().

Referenced by copyQuestion(), and paste().

         {
                 global $ilUser;
                 include_once "./Modules/SurveyQuestionPool/classes/class.SurveyQuestion.php";
                 $question = SurveyQuestion::_instanciateQuestion($question_id);
                 $suffix = "";
                 $counter = 1;
                 while ($question->questionTitleExists($question->getTitle().$suffix, $obj_id)) 
                 {
                         $counter++;
                         if ($counter > 1) $suffix = " ($counter)";
                 }
                 if ($obj_id)
                 {
                         $question->setObjId($obj_id);
                 }
                 $question->duplicate(false, $question->getTitle() . $suffix, $ilUser->fullname, $ilUser->id);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportDirectory()

ilObjSurveyQuestionPool::getExportDirectory ( )

get export directory of survey

Definition at line 593 of file class.ilObjSurveyQuestionPool.php.

References ilUtil\getDataDir().

         {
                 include_once "./Services/Utilities/classes/class.ilUtil.php";
                 $export_dir = ilUtil::getDataDir()."/spl_data"."/spl_".$this->getId()."/export";
                 return $export_dir;
         }

Here is the call graph for this function:

◆ getExportFiles()

ilObjSurveyQuestionPool::getExportFiles ( $dir )

get export files

Definition at line 603 of file class.ilObjSurveyQuestionPool.php.

References $file.

         {
                 // quit if import dir not available
                 if (!@is_dir($dir) or
                         !is_writeable($dir))
                 {
                         return array();
                 }
 
                         // open directory
                 $dir = dir($dir);
 
                 // initialize array
                 $file = array();
 
                 // get files and save the in the array
                 while ($entry = $dir->read())
                 {
                         if ($entry != "." &&
                                 $entry != ".." &&
                                 ereg("^[0-9]{10}_{2}[0-9]+_{2}(spl_)*[0-9]+\.[A-Za-z]{3}\$", $entry))
                         {
                                 $file[] = $entry;
                         }
                 }
 
                 // close import directory
                 $dir->close();
                 // sort files
                 sort ($file);
                 reset ($file);
 
                 return $file;
         }

◆ getImportDirectory()

ilObjSurveyQuestionPool::getImportDirectory ( )

get import directory of survey

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

References ilUtil\getDataDir().

         {
                 include_once "./Services/Utilities/classes/class.ilUtil.php";
                 $import_dir = ilUtil::getDataDir()."/spl_data".
                         "/spl_".$this->getId()."/import";
                 if(@is_dir($import_dir))
                 {
                         return $import_dir;
                 }
                 else
                 {
                         return false;
                 }
         }

Here is the call graph for this function:

◆ getOnline()

ilObjSurveyQuestionPool::getOnline ( )

Definition at line 866 of file class.ilObjSurveyQuestionPool.php.

References $online.

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

         {
                 if (strcmp($this->online, "") == 0) $this->online = "0";
                 return $this->online;
         }

Here is the caller graph for this function:

◆ getQuestionInfos()

ilObjSurveyQuestionPool::getQuestionInfos ( $question_ids )

Returns title, description and type for an array of question id's.

Parameters

array $question_ids An array of question id's

Returns: array Array of associated arrays with title, description, type_tag

Definition at line 1087 of file class.ilObjSurveyQuestionPool.php.

References $data, and $ilDB.

         {
                 global $ilDB;
                 
                 $found = array();
                 $query_result = $ilDB->query("SELECT svy_question.*, svy_qtype.type_tag FROM svy_question, svy_qtype " .
                         "WHERE svy_question.questiontype_fi = svy_qtype.questiontype_id " .
                         "AND svy_question.tstamp > 0 AND " . $ilDB->in('svy_question.question_id', $question_ids, false, 'integer') . " " .
                         "ORDER BY svy_question.title");
                 if ($query_result->numRows() > 0)
                 {
                         while ($data = $ilDB->fetchAssoc($query_result))
                         {
                                 if (in_array($data["question_id"], $question_ids))
                                 {
                                         array_push($found, array('id' => $data["question_id"], 
                                                 'title' => $data["title"], 
                                                 'description' => $data["description"], 
                                                 'type_tag' => $data["type_tag"]));                              
                                 }
                         }
                 }
                 return $found;
         }

◆ getQuestions()

& ilObjSurveyQuestionPool::getQuestions ( )

Definition at line 754 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $result, $row, and ilObject\getId().

Referenced by cloneObject(), setObligatoryStates(), and toXML().

         {
                 global $ilDB;
                 $questions = array();
                 $result = $ilDB->queryF("SELECT question_id FROM svy_question WHERE obj_fi = %s AND svy_question.tstamp > 0 AND original_id IS NULL",
                         array('integer'),
                         array($this->getId())
                 );
                 if ($result->numRows())
                 {
                         while ($row = $ilDB->fetchAssoc($result))
                         {
                                 array_push($questions, $row["question_id"]);
                         }
                 }
                 return $questions;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionsData()

ilObjSurveyQuestionPool::getQuestionsData ( $arrFilter )

Calculates the data for the output of the questionpool.

public

Definition at line 497 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $ilUser, $row, ilObject\getId(), and isPluginActive().

         {
                 global $ilUser;
                 global $ilDB;
                 $where = "";
                 if (is_array($arrFilter))
                 {
                         foreach ($arrFilter as $key => $value)
                         {
                                 $arrFilter[$key] = str_replace('%', '', $arrFilter[$key]);
                         }
                         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');
                         }
                 }
                 $query_result = $ilDB->queryF("SELECT svy_question.*, svy_qtype.type_tag, svy_qtype.plugin FROM svy_question, svy_qtype WHERE svy_question.original_id IS NULL AND svy_question.tstamp > 0 AND svy_question.questiontype_fi = svy_qtype.questiontype_id AND svy_question.obj_fi = %s" . $where,
                         array('integer'),
                         array($this->getId())
                 );
                 $rows = array();
                 if ($query_result->numRows())
                 {
                         while ($row = $ilDB->fetchAssoc($query_result))
                         {
                                 // first part fix #19469
                                 $set = $ilDB->query("SELECT question_fi FROM svy_svy_qst  ".
                                         " WHERE question_fi = ".$ilDB->quote($row["question_id"], "integer")
                                         );
                                 if ($temp = $ilDB->fetchAssoc($set))
                                 {
                                         continue;
                                 }
                                 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:

◆ getQuestionsInfo()

& ilObjSurveyQuestionPool::getQuestionsInfo ( $question_array )

Retrieves the datase entries for questions from a given array.

Parameters

array $question_array An array containing the id's of the questions

Returns: array An array containing the database rows of the given question id's public

Definition at line 445 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $result, $row, and isPluginActive().

         {
                 global $ilDB;
                 $result_array = array();
                 $result = $ilDB->query("SELECT svy_question.*, svy_qtype.type_tag, svy_qtype.plugin FROM svy_question, svy_qtype WHERE svy_question.questiontype_fi = svy_qtype.questiontype_id AND svy_question.tstamp > 0 AND " . $ilDB->in('svy_question.question_id', $question_array, false, 'integer'));
                 while ($row = $ilDB->fetchAssoc($result))
                 {
                         if ($row["plugin"])
                         {
                                 if ($this->isPluginActive($row["type_tag"]))
                                 {
                                         array_push($result_array, $row);
                                 }
                         }
                         else
                         {
                                 array_push($result_array, $row);
                         }
                 }
                 return $result_array;
         }

Here is the call graph for this function:

◆ getQuestiontype()

ilObjSurveyQuestionPool::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 373 of file class.ilObjSurveyQuestionPool.php.

References $data, $ilDB, and $result.

Referenced by createQuestion(), and toXML().

         {
                 global $ilDB;
                 if ($question_id < 1) return;
                 $result = $ilDB->queryF("SELECT svy_qtype.type_tag FROM svy_question, svy_qtype WHERE svy_question.questiontype_fi = svy_qtype.questiontype_id AND svy_question.question_id = %s",
                         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:

◆ ilObjSurveyQuestionPool()

ilObjSurveyQuestionPool::ilObjSurveyQuestionPool	(	$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 51 of file class.ilObjSurveyQuestionPool.php.

References ilObject\ilObject().

         {
                 $this->type = "spl";
                 $this->ilObject($a_id,$a_call_by_reference);
         }

Here is the call graph for this function:

◆ importObject()

ilObjSurveyQuestionPool::importObject	(	$source,
		$spl_exists = `FALSE`
	)

Imports survey questions into ILIAS.

Parameters

string $source The filename of an XML import file public

Definition at line 778 of file class.ilObjSurveyQuestionPool.php.

References ilUtil\delDir(), ilObject\getId(), and ilUtil\unzip().

         {
                 if (is_file($source))
                 {
                         $isZip = (strcmp(strtolower(substr($source, -3)), 'zip') == 0);
                         if ($isZip)
                         {
                                 // unzip file
                                 ilUtil::unzip($source);
 
                                 // determine filenames of xml files
                                 $subdir = basename($source, ".zip");
                                 $source = dirname($source)."/".$subdir."/".$subdir.".xml";
                         }
 
                         $fh = fopen($source, "r") or die("");
                         $xml = fread($fh, filesize($source));
                         fclose($fh) or die("");
                         if ($isZip)
                         {
                                 $subdir = basename($source, ".zip");
                                 if (@is_dir(dirname($source)."/".$subdir))
                                 {
                                         ilUtil::delDir(dirname($source)."/".$subdir);
                                 }
                         }
                         if (strpos($xml, "questestinterop") > 0)
                         {
                                 include_once("./Modules/Survey/exceptions/class.ilInvalidSurveyImportFileException.php");
                                 throw new ilInvalidSurveyImportFileException("Unsupported survey version (< 3.8) found.");
 
                                 // survey questions for ILIAS < 3.8
                                 /*
                                 include_once "./Services/Survey/classes/class.SurveyImportParserPre38.php";
                                 $import = new SurveyImportParserPre38($this->getId(), "", $spl_exists);
                                 $import->setXMLContent($xml);
                                 $import->startParsing();*/
                         }
                         else
                         {
                                 // survey questions for ILIAS >= 3.8
                                 include_once "./Services/Survey/classes/class.SurveyImportParser.php";
                                 $import = new SurveyImportParser($this->getId(), "", $spl_exists);
                                 $import->setXMLContent($xml);
                                 $import->startParsing();
                         }
                 }
         }

Here is the call graph for this function:

◆ isInUse()

ilObjSurveyQuestionPool::isInUse ( $question_id )

Checks if a question is in use by a survey.

Parameters

integer $question_id The database id of the question

Returns: mixed An array of the surveys which use the question, when the question is in use by at least one survey, otherwise false public

Definition at line 399 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $result, and $row.

         {
                 global $ilDB;
                 // check out the already answered questions
                 $result = $ilDB->queryF("SELECT answer_id FROM svy_answer WHERE question_fi = %s",
                         array('integer'),
                         array($question_id)
                 );
                 $answered = $result->numRows();
                 
                 // check out the questions inserted in surveys
                 $result = $ilDB->queryF("SELECT svy_svy.* FROM svy_svy, svy_svy_qst WHERE svy_svy_qst.survey_fi = svy_svy.survey_id AND svy_svy_qst.question_fi = %s",
                         array('integer'),
                         array($question_id)
                 );
                 $inserted = $result->numRows();
                 if (($inserted + $answered) == 0)
                 {
                         return false;
                 }
                 $result_array = array();
                 while ($row = $ilDB->fetchObject($result))
                 {
                         array_push($result_array, $row);
                 }
                 return $result_array;
         }

◆ isPluginActive()

ilObjSurveyQuestionPool::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 1068 of file class.ilObjSurveyQuestionPool.php.

References IL_COMP_MODULE.

Referenced by getQuestionsData(), and getQuestionsInfo().

         {
                 global $ilPluginAdmin;
                 if ($ilPluginAdmin->isActive(IL_COMP_MODULE, "SurveyQuestionPool", "svyq", $a_pname))
                 {
                         return TRUE;
                 }
                 else
                 {
                         return FALSE;
                 }
         }

Here is the caller graph for this function:

◆ loadFromDb()

ilObjSurveyQuestionPool::loadFromDb ( )

Loads a ilObjQuestionpool object from a database.

public

Definition at line 191 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $result, $row, ilObject\getId(), and setOnline().

Referenced by read().

         {
                 global $ilDB;
                 
                 $result = $ilDB->queryF("SELECT * FROM svy_qpl WHERE obj_fi = %s",
                         array('integer'),
                         array($this->getId())
                 );
                 if ($result->numRows() == 1)
                 {
                         $row = $ilDB->fetchAssoc($result);
                         $this->setOnline($row["isonline"]);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moveToClipboard()

ilObjSurveyQuestionPool::moveToClipboard ( $question_id )

Moves a question to the clipboard.

Parameters

integer $question_id Object id of the question

Definition at line 1148 of file class.ilObjSurveyQuestionPool.php.

References $_SESSION.

         {
                 if (!array_key_exists("spl_clipboard", $_SESSION))
                 {
                         $_SESSION["spl_clipboard"] = array();
                 }
                 $_SESSION["spl_clipboard"][$question_id] = array("question_id" => $question_id, "action" => "move");
         }

◆ notify()

ilObjSurveyQuestionPool::notify	(	$a_event,
		$a_ref_id,
		$a_parent_non_rbac_id,
		$a_node_id,
		$a_params = `0`
	)

notifys an object about an event occured Based on the event happend, each object may decide how it reacts.

If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)

public

Parameters

string	event
integer	reference id of object where the event occured
array	passes optional parameters if required

Returns: boolean

Definition at line 299 of file class.ilObjSurveyQuestionPool.php.

References $_GET, and ilObject\getType().

         {
                 global $tree;
                 
                 switch ($a_event)
                 {
                         case "link":
                                 
                                 //var_dump("<pre>",$a_params,"</pre>");
                                 //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                         
                         case "cut":
                                 
                                 //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                                 
                         case "copy":
                         
                                 //var_dump("<pre>",$a_params,"</pre>");
                                 //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
 
                         case "paste":
                                 
                                 //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                         
                         case "new":
                                 
                                 //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                 }
                 
                 // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
                 if ($a_node_id==$_GET["ref_id"])
                 {       
                         $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                         $parent_type = $parent_obj->getType();
                         if($parent_type == $this->getType())
                         {
                                 $a_node_id = (int) $tree->getParentId($a_node_id);
                         }
                 }
                 
                 parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
         }

Here is the call graph for this function:

◆ paste()

ilObjSurveyQuestionPool::paste ( $question_id )

Pastes a question in the question pool.

Parameters

integer $question_id The database id of the question public

Definition at line 433 of file class.ilObjSurveyQuestionPool.php.

References duplicateQuestion(), and ilObject\getId().

         {
                 $this->duplicateQuestion($question_id, $this->getId());
         }

Here is the call graph for this function:

◆ pasteFromClipboard()

ilObjSurveyQuestionPool::pasteFromClipboard ( )

Copies/Moves a question from the clipboard.

Definition at line 1160 of file class.ilObjSurveyQuestionPool.php.

References $_SESSION, $ilDB, $result, $row, copyQuestion(), ilObject\getId(), ilUtil\makeDirParents(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

         {
                 global $ilDB;
 
                 if (array_key_exists("spl_clipboard", $_SESSION))
                 {
                         foreach ($_SESSION["spl_clipboard"] as $question_object)
                         {
                                 if (strcmp($question_object["action"], "move") == 0)
                                 {
                                         $result = $ilDB->queryF("SELECT obj_fi FROM svy_question WHERE question_id = %s",
                                                 array('integer'),
                                                 array($question_object["question_id"])
                                         );
                                         if ($result->numRows() == 1)
                                         {
                                                 $row = $ilDB->fetchAssoc($result);
                                                 $source_questionpool = $row["obj_fi"];
                                                 if ($this->getId() != $source_questionpool)
                                                 {
                                                         // change the questionpool id in the qpl_questions table
                                                         $affectedRows = $ilDB->manipulateF("UPDATE svy_question SET obj_fi = %s WHERE question_id = %s",
                                                                 array('integer','integer'),
                                                                 array($this->getId(), $question_object["question_id"])
                                                         );
 
                                                         // move question data to the new target directory
                                                         $source_path = CLIENT_WEB_DIR . "/survey/" . $source_questionpool . "/" . $question_object["question_id"] . "/";
                                                         if (@is_dir($source_path))
                                                         {
                                                                 $target_path = CLIENT_WEB_DIR . "/survey/" . $this->getId() . "/";
                                                                 if (!@is_dir($target_path))
                                                                 {
                                                                         include_once "./Services/Utilities/classes/class.ilUtil.php";
                                                                         ilUtil::makeDirParents($target_path);
                                                                 }
                                                                 @rename($source_path, $target_path . $question_object["question_id"]);
                                                         }
                                                 }
                                                 else
                                                 {
                                                         ilUtil::sendFailure($this->lng->txt("spl_move_same_pool"), true);
                                                         return;
                                                 }
                                         }
                                 }
                                 else
                                 {
                                         $this->copyQuestion($question_object["question_id"], $this->getId());
                                 }
                         }
                 }
                 ilUtil::sendSuccess($this->lng->txt("spl_paste_success"), true);
                 unset($_SESSION["spl_clipboard"]);
         }

Here is the call graph for this function:

◆ purgeQuestions()

ilObjSurveyQuestionPool::purgeQuestions ( )

Definition at line 1115 of file class.ilObjSurveyQuestionPool.php.

References $data, $ilDB, $ilUser, $result, and removeQuestion().

         {
                 global $ilDB, $ilUser;
                 
                 $result = $ilDB->queryF("SELECT question_id FROM svy_question WHERE owner_fi = %s AND tstamp = %s", 
                         array("integer", "integer"),
                         array($ilUser->getId(), 0)
                 );
                 while ($data = $ilDB->fetchAssoc($result))
                 {
                         $this->removeQuestion($data["question_id"]);
                 }
         }

Here is the call graph for this function:

◆ read()

ilObjSurveyQuestionPool::read ( $a_force_db = false )

read object data from db into object

Parameters

boolean public

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

References loadFromDb().

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

Here is the call graph for this function:

◆ removeQuestion()

ilObjSurveyQuestionPool::removeQuestion ( $question_id )

Removes a question from the question pool.

Parameters

integer $question_id The database id of the question private

Definition at line 358 of file class.ilObjSurveyQuestionPool.php.

References SurveyQuestion\_instanciateQuestion().

Referenced by deleteAllData(), and purgeQuestions().

         {
                 if ($question_id < 1) return;
                 include_once "./Modules/SurveyQuestionPool/classes/class.SurveyQuestion.php";
                 $question =& SurveyQuestion::_instanciateQuestion($question_id);
                 $question->delete($question_id);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToDb()

ilObjSurveyQuestionPool::saveToDb ( )

Saves a ilObjSurveyQuestionPool object to a database.

public

Definition at line 211 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, $query, $result, ilObject\getId(), and getOnline().

   {
                 global $ilDB;
                 
                 parent::update();
                 
                 $result = $ilDB->queryF("SELECT * FROM svy_qpl WHERE obj_fi = %s",
                         array('integer'),
                         array($this->getId())
                 );
                 if ($result->numRows() == 1)
                 {
                         $affectedRows = $ilDB->manipulateF("UPDATE svy_qpl SET isonline = %s, tstamp = %s WHERE obj_fi = %s",
                                 array('text','integer','integer'),
                                 array($this->getOnline(), time(), $this->getId())
                         );
                 }
                 else
                 {
                         $next_id = $ilDB->nextId('svy_qpl');
                         $query = $ilDB->manipulateF("INSERT INTO svy_qpl (id_questionpool, isonline, obj_fi, tstamp) VALUES (%s, %s, %s, %s)",
                                 array('integer', 'text', 'integer', 'integer'),
                                 array($next_id, $this->getOnline(), $this->getId(), time())
                         );
                 }
         }

Here is the call graph for this function:

◆ setObligatoryStates()

ilObjSurveyQuestionPool::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 1222 of file class.ilObjSurveyQuestionPool.php.

References $ilDB, and getQuestions().

         {                               
                 global $ilDB;
                 
                 foreach($this->getQuestions() as $question_id)
                 {
                         $status = (int)(in_array($question_id, $obligatory_questions));
                         
                         $ilDB->manipulate("UPDATE svy_question".
                                 " SET obligatory = ".$ilDB->quote($status, "integer").
                                 " WHERE question_id = ".$ilDB->quote($question_id, "integer"));                         
                 }               
         }

Here is the call graph for this function:

◆ setOnline()

ilObjSurveyQuestionPool::setOnline ( $a_online_status )

Sets the questionpool online status.

Parameters

integer $a_online_status Online status of the questionpool

See also: online User interface

Definition at line 852 of file class.ilObjSurveyQuestionPool.php.

Referenced by loadFromDb().

         {
                 switch ($a_online_status)
                 {
                         case 0:
                         case 1:
                                 $this->online = $a_online_status;
                                 break;
                         default:
                                 $this->online = 0;
                                 break;
                 }
         }

Here is the caller graph for this function:

◆ toXML()

ilObjSurveyQuestionPool::toXML ( $questions )

export questions to xml

Definition at line 693 of file class.ilObjSurveyQuestionPool.php.

References SurveyQuestion\_includeClass(), ilObject\getId(), getOnline(), getQuestions(), getQuestiontype(), ilObject\getTitle(), ilObject\getType(), and ilXmlWriter\xmlHeader().

         {
                 if (!is_array($questions))
                 {
                         $questions =& $this->getQuestions();
                 }
                 if (count($questions) == 0)
                 {
                         $questions =& $this->getQuestions();
                 }
                 $xml = "";
 
                 include_once("./Services/Xml/classes/class.ilXmlWriter.php");
                 $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" => "qpl_" . $this->getId(),
                         "label" => $this->getTitle(),
                         "online" => $this->getOnline()
                 );
                 $a_xml_writer->xmlStartTag("surveyquestions", $attrs);
                 $a_xml_writer->xmlElement("dummy", NULL, "dummy");
                 // add ILIAS specific metadata
                 $a_xml_writer->xmlStartTag("metadata");
                 $a_xml_writer->xmlStartTag("metadatafield");
                 $a_xml_writer->xmlElement("fieldlabel", NULL, "SCORM");
                 include_once "./Services/MetaData/classes/class.ilMD.php";
                 $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("surveyquestions");
                 $a_xml_writer->xmlEndTag("surveyobject");
 
                 $xml = $a_xml_writer->xmlDumpMem(FALSE);
 
                 $questionxml = "";
                 foreach ($questions as $key => $value)
                 {
                         $questiontype = $this->getQuestiontype($value);
                         include_once "./Modules/SurveyQuestionPool/classes/class.SurveyQuestion.php";
                         SurveyQuestion::_includeClass($questiontype);
                         $question = new $questiontype();
                         $question->loadFromDb($value);
                         $questionxml .= $question->toXML(false);
                 }
                 
                 $xml = str_replace("<dummy>dummy</dummy>", $questionxml, $xml);
                 return $xml;
         }

Here is the call graph for this function:

◆ update()

ilObjSurveyQuestionPool::update ( )

update object data

public

Returns: boolean

Definition at line 75 of file class.ilObjSurveyQuestionPool.php.

References ilObject\updateMetaData().

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

Here is the call graph for this function:

Field Documentation

◆ $online

ilObjSurveyQuestionPool::$online

Definition at line 43 of file class.ilObjSurveyQuestionPool.php.

Referenced by getOnline().

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

Modules/SurveyQuestionPool/classes/class.ilObjSurveyQuestionPool.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ _getAvailableQuestionpools()

◆ _getQuestiontypes()

◆ _getQuestionTypeTranslations()

◆ _isWriteable()

◆ _lookupOnline()

◆ _setOnline()

◆ cloneObject()

◆ copyQuestion()

◆ copyToClipboard()

◆ create()

◆ createExportDirectory()

◆ createImportDirectory()

◆ createQuestion()

◆ delete()

◆ deleteAllData()

◆ duplicateQuestion()

◆ getExportDirectory()

◆ getExportFiles()

◆ getImportDirectory()

◆ getOnline()

◆ getQuestionInfos()

◆ getQuestions()

◆ getQuestionsData()

◆ getQuestionsInfo()

◆ getQuestiontype()

◆ ilObjSurveyQuestionPool()

◆ importObject()

◆ isInUse()

◆ isPluginActive()

◆ loadFromDb()

◆ moveToClipboard()

◆ notify()

◆ paste()

◆ pasteFromClipboard()

◆ purgeQuestions()

◆ read()

◆ removeQuestion()

◆ saveToDb()

◆ setObligatoryStates()

◆ setOnline()

◆ toXML()

◆ update()

Field Documentation

◆ $online