Inheritance diagram for ilObjSurveyQuestionPool:

Collaboration diagram for ilObjSurveyQuestionPool:

Public Member Functions
	__construct ($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 ()
	read object data from db into object public More...

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	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 ()

	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 ()

	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
	__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	_setOnline ($a_obj_id, $a_online_status)

static	_lookupOnline ($a_obj_id)

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

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

static	_getQuestionTypeTranslations ()

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

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)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	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
	$online

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 Attributes
	$user

	$plugin_admin

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

References $DIC, and user().

     {
         global $DIC;
 
         $this->log = $DIC["ilLog"];
         $this->db = $DIC->database();
         $this->user = $DIC->user();
         $this->plugin_admin = $DIC["ilPluginAdmin"];
         $this->type = "spl";
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getAvailableQuestionpools()

static ilObjSurveyQuestionPool::_getAvailableQuestionpools	(	$use_object_id = `false`,
		$could_be_offline = `false`,
		$showPath = `false`,
		$permission = `"read"`
	)

static

Returns the available question pools for the active user.

Returns: array The available question pools public

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

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

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

     {
         global $DIC;
 
         $ilUser = $DIC->user();
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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()

static ilObjSurveyQuestionPool::_getQuestiontypes ( )

static

Creates a list of all available question types.

Returns: array An array containing the available questiontypes public

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

References $DIC, $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 $DIC;
 
         $ilDB = $DIC->database();
         global $DIC;
 
         $lng = $DIC->language();
         
         $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 $DIC;
 
                 $ilPluginAdmin = $DIC["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 880 of file class.ilObjSurveyQuestionPool.php.

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

Referenced by ilObjSurvey\getQuestionsTable().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         global $DIC;
 
         $lng = $DIC->language();
         global $DIC;
 
         $ilLog = $DIC["ilLog"];
         global $DIC;
 
         $ilPluginAdmin = $DIC["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()

static ilObjSurveyQuestionPool::_isWriteable	(	$object_id,
		$user_id
	)

static

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

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

Referenced by SurveyQuestion\_isWriteable().

     {
         global $DIC;
 
         $rbacsystem = $DIC->rbac()->system();
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $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()

static ilObjSurveyQuestionPool::_lookupOnline ( $a_obj_id )

static

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

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

Referenced by ilObjSurveyQuestionPoolListGUI\getProperties().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $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 713 of file class.ilObjSurveyQuestionPool.php.

References $DIC, and $ilDB.

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $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`,
		$a_omit_tree = `false`
	)

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

public

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

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

     {
         $ilLog = $this->log;
         $newObj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
 
         //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 170 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 1018 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 76 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)

Exceptions

ilSurveyException

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

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

     {
         $spl_data_dir = ilUtil::getDataDir() . "/spl_data";
         ilUtil::makeDir($spl_data_dir);
         if (!is_writable($spl_data_dir)) {
             include_once "Modules/Survey/exceptions/class.ilSurveyException.php";
             throw new ilSurveyException("Survey Questionpool Data Directory (" . $spl_data_dir . ") not writeable.");
         }
         
         // 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)) {
             include_once "Modules/Survey/exceptions/class.ilSurveyException.php";
             throw new ilSurveyException("Creation of Survey Questionpool Directory failed.");
         }
         // create Export subdirectory (data_dir/lm_data/lm_<id>/Export)
         $export_dir = $spl_dir . "/export";
         ilUtil::makeDir($export_dir);
         if (!@is_dir($export_dir)) {
             include_once "Modules/Survey/exceptions/class.ilSurveyException.php";
             throw new ilSurveyException("Creation of Survey Questionpool Export Directory failed.");
         }
     }

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)

Exceptions

ilSurveyException

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

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

     {
         $spl_data_dir = ilUtil::getDataDir() . "/spl_data";
         ilUtil::makeDir($spl_data_dir);
         
         if (!is_writable($spl_data_dir)) {
             include_once "Modules/Survey/exceptions/class.ilSurveyException.php";
             throw new ilSurveyException("Survey Questionpool Data Directory (" . $spl_data_dir . ") not writeable.");
         }
 
         // 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)) {
             include_once "Modules/Survey/exceptions/class.ilSurveyException.php";
             throw new ilSurveyException("Creation of Survey Questionpool Directory failed.");
         }
 
         // create import subdirectory (data_dir/spl_data/spl_<id>/import)
         $import_dir = $spl_dir . "/import";
         ilUtil::makeDir($import_dir);
         if (!@is_dir($import_dir)) {
             include_once "Modules/Survey/exceptions/class.ilSurveyException.php";
             throw new ilSurveyException("Creation of Survey Questionpool Import Directory failed.");
         }
     }

Here is the call graph for this function:

◆ createQuestion()

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

Definition at line 146 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 248 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 265 of file class.ilObjSurveyQuestionPool.php.

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

Referenced by delete().

     {
         $ilDB = $this->db;
         $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
         $spl_data_dir = ilUtil::getDataDir() . "/spl_data";
         $directory = $spl_data_dir . "/spl_" . $this->getId();
         if (is_dir($directory)) {
             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 404 of file class.ilObjSurveyQuestionPool.php.

References $ilUser, $user, and SurveyQuestion\_instanciateQuestion().

Referenced by copyQuestion(), and paste().

     {
         $ilUser = $this->user;
         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 505 of file class.ilObjSurveyQuestionPool.php.

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

     {
         $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 514 of file class.ilObjSurveyQuestionPool.php.

     {
         // 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 != ".." &&
                 preg_match("/^[0-9]{10}__[0-9]+__(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 583 of file class.ilObjSurveyQuestionPool.php.

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

     {
         $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 753 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 973 of file class.ilObjSurveyQuestionPool.php.

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

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

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

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

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

References ilObject\$db, $ilDB, $ilUser, $key, $row, $rows, $user, ilObject\getId(), and isPluginActive().

     {
         $ilUser = $this->user;
         $ilDB = $this->db;
         $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)) {
                 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 381 of file class.ilObjSurveyQuestionPool.php.

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

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

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

Referenced by createQuestion(), and toXML().

     {
         $ilDB = $this->db;
         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:

◆ 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 678 of file class.ilObjSurveyQuestionPool.php.

References $source, $xml, 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.");
             } 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 335 of file class.ilObjSurveyQuestionPool.php.

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

     {
         $ilDB = $this->db;
         // 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 957 of file class.ilObjSurveyQuestionPool.php.

References $plugin_admin, and IL_COMP_MODULE.

Referenced by getQuestionsData(), and getQuestionsInfo().

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

◆ loadFromDb()

ilObjSurveyQuestionPool::loadFromDb ( )

Loads a ilObjQuestionpool object from a database.

public

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

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

Referenced by read().

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

◆ 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 369 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 1042 of file class.ilObjSurveyQuestionPool.php.

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

     {
         $ilDB = $this->db;
 
         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)) {
                                     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 998 of file class.ilObjSurveyQuestionPool.php.

References $data, ilObject\$db, $ilDB, $ilUser, $result, $user, and removeQuestion().

     {
         $ilDB = $this->db;
         $ilUser = $this->user;
         
         $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 ( )

read object data from db into object public

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

References loadFromDb().

     {
         parent::read();
         $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 292 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 215 of file class.ilObjSurveyQuestionPool.php.

References ilObject\$db, $ilDB, $query, $result, ilObject\getId(), getOnline(), and League\Flysystem\Adapter\Polyfill\update().

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

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

     {
         $ilDB = $this->db;
         
         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 740 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 597 of file class.ilObjSurveyQuestionPool.php.

References $key, $metadata, $xml, 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 90 of file class.ilObjSurveyQuestionPool.php.

References League\Flysystem\Adapter\Polyfill\update(), and 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 53 of file class.ilObjSurveyQuestionPool.php.

Referenced by getOnline().

◆ $plugin_admin

ilObjSurveyQuestionPool::$plugin_admin

protected

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

Referenced by isPluginActive().

◆ $user

ilObjSurveyQuestionPool::$user

protected

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

Referenced by duplicateQuestion(), getQuestionsData(), and purgeQuestions().

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

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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()

◆ importObject()

◆ isInUse()

◆ isPluginActive()

◆ loadFromDb()

◆ moveToClipboard()

◆ paste()

◆ pasteFromClipboard()

◆ purgeQuestions()

◆ read()

◆ removeQuestion()

◆ saveToDb()

◆ setObligatoryStates()

◆ setOnline()

◆ toXML()

◆ update()

Field Documentation

◆ $online

◆ $plugin_admin

◆ $user