Inheritance diagram for ilObjQuestionPool:

Collaboration diagram for ilObjQuestionPool:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)

	create ($a_upload=false)
	create questionpool object More...

	createReference ()
	Creates a database reference id for the object (saves the object to the database and creates a reference id in the database) More...

	update ()
	update object data More...

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

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

	deleteQuestionpool ()

	deleteQuestion (int $question_id)

	loadFromDb ()

	saveToDb ()

	getQuestiontype ($question_id)

	isInUse (int $question_id)

	createQuestion (string $question_type, int $question_id=-1)

	duplicateQuestion (int $question_id)

	copyQuestion (int $question_id, int $questionpool_to)

	appendCounterToQuestionTitleIfNecessary (string $title)

	getPrintviewQuestions ()

	objectToXmlWriter (ilXmlWriter &$a_xml_writer, $a_inst, $a_target_dir, &$expLog, $questions)
	export pages of test to xml (see ilias_co.dtd) More...

	exportTitleAndDescription (ilXmlWriter &$a_xml_writer)

	modifyExportIdentifier ($a_tag, $a_param, $a_value)

	exportXMLPageObjects (&$a_xml_writer, $a_inst, &$expLog, $questions)
	export page objects to xml (see ilias_co.dtd) More...

	exportXMLMediaObjects (&$a_xml_writer, $a_inst, $a_target_dir, &$expLog)

	exportFileItems ($target_dir, &$expLog)
	export files of file itmes More...

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

	getExportDirectory ($type='')
	get export directory of questionpool More...

&	getAllQuestions ()
	Retrieve an array containing all question ids of the questionpool. More...

&	getAllQuestionIds ()

	checkQuestionParent (int $question_id)

	getImportMapping ()
	get array of (two) new created questions for import id More...

	questionsToXML ($questions)
	Returns a QTI xml representation of a list of questions. More...

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

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

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

	cleanupClipboard (int $deleted_question_id)

	getQuestionDetails ($question_ids)
	Returns an array containing the qpl_question and qpl_qst_type fields for an array of question ids. More...

	getDeleteableQuestionDetails ($question_ids)
	Returns an array containing the qpl_question and qpl_qst_type fields of deleteable questions for an array of question ids. More...

	getQplQuestions ()

	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
	Creates a 1:1 copy of the object and places the copy in a given repository. More...

	getQuestionTypes ($all_tags=false, $fixOrder=false, $withDeprecatedTypes=true)

	getQuestionList ()

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

	purgeQuestions ()

	getTaxonomyIds ()
	get ids of all taxonomies corresponding to current pool More...

	isSkillServiceEnabled ()

	setSkillServiceEnabled (bool $skill_service_enabled)

	fromXML (?string $xml_file)

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

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

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_hasEqualPoints ($a_obj_id, $is_reference=false)
	Checks a question pool for questions with the same maximum points. More...

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

static	_getAvailableQuestionpools (bool $use_object_id=false, bool $equal_points=false, bool $could_be_offline=false, bool $showPath=false, bool $with_questioncount=false, string $permission='read', int $usr_id=0)
	Returns the available question pools for the active user. More...

static	_getQuestionTypes ($all_tags=false, $fixOrder=false, $withDeprecatedTypes=true)

static	getQuestionTypeByTypeId ($type_id)

static	getQuestionTypeTranslations ()

static &	_getSelfAssessmentQuestionTypes ($all_tags=false)

static	_updateQuestionCount (int $object_id)

static	isSkillManagementGloballyActivated ()

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Protected Member Functions
	populateQuestionSkillAssignmentsXml (ilXmlWriter &$a_xml_writer, $questions)

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Static Protected Member Functions
static	_getQuestionCount (int $pool_id)

Private Member Functions
	exportXMLSettings ($xmlWriter)

Private Attributes
ilComponentRepository	$component_repository

ilBenchmark	$benchmark

array	$mob_ids

array	$file_ids

bool	$skill_service_enabled

GeneralQuestionPropertiesRepository	$questionrepository

Static Private Attributes
static	$isSkillManagementGloballyActivated = null

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

     {
         global $DIC;
         $this->component_repository = $DIC['component.repository'];
         $this->benchmark = $DIC['ilBench'];
 
         $local_dic = QuestionPoolDIC::dic();
         $this->questionrepository = $local_dic['question.general_properties.repository'];
 
         $this->type = 'qpl';
 
         parent::__construct((int) $a_id, $a_call_by_reference);
 
         $this->skill_service_enabled = false;
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getAvailableQuestionpools()

static ilObjQuestionPool::_getAvailableQuestionpools	(	bool	$use_object_id = `false`,
		bool	$equal_points = `false`,
		bool	$could_be_offline = `false`,
		bool	$showPath = `false`,
		bool	$with_questioncount = `false`,
		string	$permission = `'read'`,
		int	$usr_id = `0`
	)

static

Returns the available question pools for the active user.

Returns: array The available question pools public

Definition at line 924 of file class.ilObjQuestionPool.php.

References $DIC, $ilDB, ilObject\$lng, ilObject\$ref_id, ilObject\$title, ilUtil\_getObjectsByOperations(), _hasEqualPoints(), ilObject\_lookupObjId(), ilObject\_prepareCloneSelection(), and ilLanguage\txt().

Referenced by ilObjTestGUI\buildInputPoolSelection(), ilObjTest\getAvailableQuestionpools(), ilObjTest\getAvailableQuestions(), and ilTestQuestionBrowserTableGUI\getQuestionParentObjIds().

      : array {
         global $DIC;
         $ilUser = $DIC['ilUser'];
         $ilDB = $DIC['ilDB'];
         $lng = $DIC['lng'];
 
         $result_array = [];
         $qpls = ilUtil::_getObjectsByOperations('qpl', $permission, $usr_id > 0 ? $usr_id : $ilUser->getId(), -1);
         $obj_ids = [];
         foreach ($qpls as $ref_id) {
             $obj_id = ilObject::_lookupObjId($ref_id);
             $obj_ids[$ref_id] = $obj_id;
         }
         $titles = ilObject::_prepareCloneSelection($qpls, 'qpl');
         if (count($obj_ids)) {
             $in = $ilDB->in('object_data.obj_id', $obj_ids, false, 'integer');
             if ($could_be_offline) {
                 $result = $ilDB->query(
                     'SELECT qpl_questionpool.*, object_data.title FROM qpl_questionpool, object_data WHERE ' .
                     'qpl_questionpool.obj_fi = object_data.obj_id AND ' . $in . ' ORDER BY object_data.title'
                 );
             } else {
                 $result = $ilDB->queryF(
                     'SELECT qpl_questionpool.*, object_data.title FROM qpl_questionpool, object_data WHERE ' .
                     'qpl_questionpool.obj_fi = object_data.obj_id AND ' . $in . ' AND object_data.offline = %s ' .
                     'ORDER BY object_data.title',
                     ['text'],
                     [0]
                 );
             }
             while ($row = $ilDB->fetchAssoc($result)) {
                 $add = true;
                 if ($equal_points !== false) {
                     if (!ilObjQuestionPool::_hasEqualPoints($row['obj_fi'])) {
                         $add = false;
                     }
                 }
                 if ($add) {
                     $ref_id = array_search($row['obj_fi'], $obj_ids);
                     $title = (($showPath) ? $titles[$ref_id] : $row['title']);
                     if ($with_questioncount) {
                         $title .= ' [' . $row['questioncount'] . ' ' . ($row['questioncount'] == 1 ? $lng->txt(
                             'ass_question'
                         ) : $lng->txt('assQuestions')) . ']';
                     }
 
                     if ($use_object_id) {
                         $result_array[$row['obj_fi']] = [
                             'qpl_id' => $row['obj_fi'],
                             'qpl_title' => $row['title'],
                             'title' => $title,
                             'count' => $row['questioncount']
                         ];
                     } else {
                         $result_array[$ref_id] = [
                             'qpl_id' => $row['obj_fi'],
                             'qpl_title' => $row['title'],
                             'title' => $title,
                             'count' => $row['questioncount']
                         ];
                     }
                 }
             }
         }
         return $result_array;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getQuestionCount()

static ilObjQuestionPool::_getQuestionCount ( int $pool_id )

staticprotected

Definition at line 644 of file class.ilObjQuestionPool.php.

References $DIC, and $ilDB.

Referenced by _updateQuestionCount().

                                                              : int
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $result = $ilDB->queryF(
             'SELECT COUNT(question_id) question_count FROM qpl_questions WHERE obj_fi = %s AND qpl_questions.tstamp > 0 AND original_id IS NULL AND complete = %s',
             ['integer', 'text'],
             [$pool_id, 1]
         );
         $row = $ilDB->fetchAssoc($result);
         return $row['question_count'];
     }

Here is the caller graph for this function:

◆ _getQuestionTypes()

static ilObjQuestionPool::_getQuestionTypes	(	$all_tags = `false`,
		$fixOrder = `false`,
		$withDeprecatedTypes = `true`
	)

static

Definition at line 1056 of file class.ilObjQuestionPool.php.

References $DIC, $ilDB, ilObject\$lng, ilLanguage\loadLanguageModule(), ilAssQuestionTypeOrderer\ORDER_MODE_ALPHA, ilAssQuestionTypeOrderer\ORDER_MODE_FIX, and ilLanguage\txt().

Referenced by _getSelfAssessmentQuestionTypes(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getFilter(), ilTestRandomQuestionSetSourcePoolDefinition\getTypeFilterAsTypeTags(), ilQuestionBrowserTableGUI\initFilter(), ilTestQuestionFilterLabelTranslator\loadTypeLabels(), ILIAS\Test\Questions\Presentation\QuestionsBrowserFilter\resolveQuestionTypeFilterOptions(), ilTestRandomQuestionSetSourcePoolDefinition\setTypeFilterFromTypeTags(), and ILIAS\Test\Settings\GlobalSettings\GlobalTestSettings\toForm().

                                                                                                                : array
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $lng = $DIC['lng'];
         $component_factory = $DIC['component.factory'];
         $disabled_question_types = QuestionPoolDIC::dic()['global_test_settings']->getDisabledQuestionTypes();
 
         $lng->loadLanguageModule('assessment');
         $result = $ilDB->query('SELECT * FROM qpl_qst_type');
         $types = [];
         while ($row = $ilDB->fetchAssoc($result)) {
             if ($all_tags || (!in_array($row['question_type_id'], $disabled_question_types))) {
                 if ($row['plugin'] == 0) {
                     $types[$lng->txt($row['type_tag'])] = $row;
                 } else {
                     foreach ($component_factory->getActivePluginsInSlot('qst') as $pl) {
                         if (strcmp($pl->getQuestionType(), $row['type_tag']) == 0) {
                             $types[$pl->getQuestionTypeTranslation()] = $row;
                         }
                     }
                 }
             }
         }
 
         $orderMode = ($fixOrder ? ilAssQuestionTypeOrderer::ORDER_MODE_FIX : ilAssQuestionTypeOrderer::ORDER_MODE_ALPHA);
         $orderer = new ilAssQuestionTypeOrderer($types, $orderMode);
         $types = $orderer->getOrderedTypes($withDeprecatedTypes);
 
         return $types;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getSelfAssessmentQuestionTypes()

static& ilObjQuestionPool::_getSelfAssessmentQuestionTypes ( $all_tags = false )

static

Todo:: Make it more flexible

Definition at line 1132 of file class.ilObjQuestionPool.php.

References _getQuestionTypes().

Referenced by ilCopySelfAssQuestionTableGUI\getQuestions(), and ilPCQuestionGUI\insert().

                                                                               : array
     {
         $allowed_types = [
             'assSingleChoice' => 1,
             'assMultipleChoice' => 2,
             'assKprimChoice' => 3,
             'assClozeTest' => 4,
             'assMatchingQuestion' => 5,
             'assOrderingQuestion' => 6,
             'assOrderingHorizontal' => 7,
             'assImagemapQuestion' => 8,
             'assTextSubset' => 9,
             'assErrorText' => 10,
             'assLongMenu' => 11
         ];
         $satypes = [];
         $qtypes = ilObjQuestionPool::_getQuestionTypes($all_tags);
         foreach ($qtypes as $k => $t) {
             if (isset($allowed_types[$t['type_tag']])) {
                 $t['order'] = $allowed_types[$t['type_tag']];
                 $satypes[$k] = $t;
             }
         }
         return $satypes;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _hasEqualPoints()

static ilObjQuestionPool::_hasEqualPoints	(	$a_obj_id,
		$is_reference = `false`
	)

static

Checks a question pool for questions with the same maximum points.

Parameters

integer $a_obj_id Object id of the question pool private

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

References $DIC, and $ilDB.

Referenced by _getAvailableQuestionpools().

                                                                             : int
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         if ($is_reference) {
             $result = $ilDB->queryF(
                 'SELECT count(DISTINCT qpl_questions.points) equal_points FROM qpl_questions, object_reference WHERE object_reference.ref_id = %s AND qpl_questions.tstamp > 0 AND object_reference.obj_id = qpl_questions.obj_fi AND qpl_questions.original_id IS NULL',
                 ['integer'],
                 [$a_obj_id]
             );
         } else {
             $result = $ilDB->queryF(
                 'SELECT count(DISTINCT points) equal_points FROM qpl_questions WHERE obj_fi = %s AND qpl_questions.tstamp > 0 AND qpl_questions.original_id IS NULL',
                 ['integer'],
                 [$a_obj_id]
             );
         }
         if ($result->numRows() == 1) {
             $row = $ilDB->fetchAssoc($result);
             if ($row['equal_points'] == 1) {
                 return 1;
             } else {
                 return 0;
             }
         }
         return 0;
     }

Here is the caller graph for this function:

◆ _isWriteable()

static ilObjQuestionPool::_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 object
integer	$user_id	The database id of the user public

Definition at line 806 of file class.ilObjQuestionPool.php.

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

Referenced by assQuestion\isWriteable().

                                                              : bool
     {
         global $DIC;
         $rbacsystem = $DIC['rbacsystem'];
 
         $refs = ilObject::_getAllReferences($object_id);
         if (count($refs)) {
             foreach ($refs as $ref_id) {
                 if ($rbacsystem->checkAccess('write', $ref_id) && (ilObject::_hasUntrashedReference($object_id))) {
                     return true;
                 }
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _updateQuestionCount()

static ilObjQuestionPool::_updateQuestionCount ( int $object_id )

static

Definition at line 1172 of file class.ilObjQuestionPool.php.

References $DIC, $ilDB, and _getQuestionCount().

Referenced by assQuestion\delete(), duplicateQuestion(), pasteFromClipboard(), and assQuestion\saveToDb().

                                                                : void
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $ilDB->manipulateF(
             'UPDATE qpl_questionpool SET questioncount = %s, tstamp = %s WHERE obj_fi = %s',
             ['integer', 'integer', 'integer'],
             [ilObjQuestionPool::_getQuestionCount($object_id), time(), $object_id]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendCounterToQuestionTitleIfNecessary()

ilObjQuestionPool::appendCounterToQuestionTitleIfNecessary ( string $title )

Definition at line 275 of file class.ilObjQuestionPool.php.

References ilObject\$title, and ilObject\getId().

Referenced by copyQuestion(), ilObjTestGUI\copyQuestionToPool(), and duplicateQuestion().

                                                                           : string
     {
         $result = $this->db->queryF(
             "SELECT COUNT(question_id) AS cnt FROM qpl_questions WHERE obj_fi = %s AND title like %s",
             ['integer','text'],
             [$this->getId(), "{$title}%"]
         );
         $counter_object = $this->db->fetchObject($result);
         if ($counter_object->cnt === 0) {
             return $title;
         }
         return "{$title} ({$counter_object->cnt})";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkQuestionParent()

ilObjQuestionPool::checkQuestionParent ( int $question_id )

Definition at line 594 of file class.ilObjQuestionPool.php.

                                                          : bool
     {
         $row = $this->db->fetchAssoc(
             $this->db->queryF(
                 'SELECT COUNT(question_id) cnt FROM qpl_questions WHERE question_id = %s AND obj_fi = %s',
                 ['integer', 'integer'],
                 [$question_id, $this->getId()]
             )
         );
 
         return (bool) $row['cnt'];
     }

◆ cleanupClipboard()

ilObjQuestionPool::cleanupClipboard ( int $deleted_question_id )

Definition at line 779 of file class.ilObjQuestionPool.php.

References ilSession\clear(), ilSession\get(), null, and ilSession\set().

                                                               : void
     {
         if (ilSession::get('qpl_clipboard') == null) {
             return;
         }
 
         $clip = ilSession::get('qpl_clipboard');
         if (!isset($clip[$deleted_question_id])) {
             return;
         }
 
         unset($clip[$deleted_question_id]);
 
         if (!count($clip)) {
             ilSession::clear('qpl_clipboard');
         } else {
             ilSession::set('qpl_clipboard', $clip);
         }
     }

Here is the call graph for this function:

◆ cloneObject()

ilObjQuestionPool::cloneObject	(	int	$target_id,
		int	$copy_id = `0`,
		bool	$omit_tree = `false`
	)

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

public

Definition at line 1018 of file class.ilObjQuestionPool.php.

References ilObject\cloneMetaData(), ilObject\getId(), getQplQuestions(), ilObject\getType(), and isSkillServiceEnabled().

                                                                                           : ?ilObject
     {
         $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);
 
         $new_obj->update();
 
         $new_obj->setSkillServiceEnabled($this->isSkillServiceEnabled());
         $new_obj->saveToDb();
 
         // clone the questions in the question pool
         $questions = $this->getQplQuestions();
         $questionIdsMap = [];
         foreach ($questions as $question_id) {
             $newQuestionId = $new_obj->copyQuestion($question_id, $new_obj->getId());
             $questionIdsMap[$question_id] = $newQuestionId;
         }
 
         $this->cloneMetaData($new_obj);
         $new_obj->updateMetaData();
 
         $duplicator = new ilQuestionPoolTaxonomiesDuplicator();
         $duplicator->setSourceObjId($this->getId());
         $duplicator->setSourceObjType($this->getType());
         $duplicator->setTargetObjId($new_obj->getId());
         $duplicator->setTargetObjType($new_obj->getType());
         $duplicator->setQuestionIdMapping($questionIdsMap);
         $duplicator->duplicate($duplicator->getAllTaxonomiesForSourceObject());
 
         $new_obj->saveToDb();
 
         return $new_obj;
     }

Here is the call graph for this function:

◆ copyQuestion()

ilObjQuestionPool::copyQuestion	(	int	$question_id,
		int	$questionpool_to
	)

Definition at line 259 of file class.ilObjQuestionPool.php.

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

Referenced by pasteFromClipboard().

                                                                         : int
     {
         $question_gui = $this->createQuestion('', $question_id);
         if ($question_gui->getObject()->getObjId() == $questionpool_to) {
             // the question is copied into the same question pool
             return $this->duplicateQuestion($question_id);
         } else {
             // the question is copied into another question pool
             $newtitle = $this->appendCounterToQuestionTitleIfNecessary(
                 $question_gui->getObject()->getTitle()
             );
 
             return $question_gui->getObject()->copyObject($this->getId(), $newtitle);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyToClipboard()

ilObjQuestionPool::copyToClipboard ( $question_id )

Copies a question to the clipboard.

Parameters

integer $question_id Object id of the question private

Definition at line 753 of file class.ilObjQuestionPool.php.

References ilSession\get(), null, and ilSession\set().

                                                  : void
     {
         if (ilSession::get('qpl_clipboard') == null) {
             ilSession::set('qpl_clipboard', []);
         }
         $clip = ilSession::get('qpl_clipboard');
         $clip[$question_id] = ['question_id' => $question_id, 'action' => 'copy'];
         ilSession::set('qpl_clipboard', $clip);
     }

Here is the call graph for this function:

◆ create()

ilObjQuestionPool::create ( $a_upload = false )

create questionpool object

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

References $id, and ilObject\createMetaData().

                                              : int
     {
         $id = parent::create();
 
         // meta data will be created by
         // import parser
         if (!$a_upload) {
             $this->createMetaData();
         }
         return $id;
     }

Here is the call graph for this function:

◆ createExportDirectory()

ilObjQuestionPool::createExportDirectory ( )

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

Definition at line 504 of file class.ilObjQuestionPool.php.

References ilFileUtils\getDataDir(), getExportDirectory(), ilObject\getId(), and ilFileUtils\makeDir().

                                            : void
     {
         $qpl_data_dir = ilFileUtils::getDataDir() . '/qpl_data';
         ilFileUtils::makeDir($qpl_data_dir);
         if (!is_writable($qpl_data_dir)) {
             $this->error->raiseError(
                 'Questionpool Data Directory (' . $qpl_data_dir
                 . ') not writeable.',
                 $this->error->FATAL
             );
         }
 
         // create learning module directory (data_dir/lm_data/lm_<id>)
         $qpl_dir = $qpl_data_dir . '/qpl_' . $this->getId();
         ilFileUtils::makeDir($qpl_dir);
         if (!@is_dir($qpl_dir)) {
             $this->error->raiseError('Creation of Questionpool Directory failed.', $this->error->FATAL);
         }
         // create Export subdirectory (data_dir/lm_data/lm_<id>/Export)
         ilFileUtils::makeDir($this->getExportDirectory('xlsx'));
         if (!@is_dir($this->getExportDirectory('xlsx'))) {
             $this->error->raiseError('Creation of Export Directory failed.', $this->error->FATAL);
         }
         ilFileUtils::makeDir($this->getExportDirectory('zip'));
         if (!@is_dir($this->getExportDirectory('zip'))) {
             $this->error->raiseError('Creation of Export Directory failed.', $this->error->FATAL);
         }
     }

Here is the call graph for this function:

◆ createQuestion()

ilObjQuestionPool::createQuestion	(	string	$question_type,
		int	$question_id = `-1`
	)

Definition at line 238 of file class.ilObjQuestionPool.php.

Referenced by copyQuestion(), duplicateQuestion(), getDeleteableQuestionDetails(), and questionsToXML().

     {
         if ($question_id > 0) {
             return assQuestion::instantiateQuestionGUI($question_id);
         }
         $question_type_gui = $question_type . 'GUI';
         $question_gui = new $question_type_gui();
         return $question_gui;
     }

Here is the caller graph for this function:

◆ createReference()

ilObjQuestionPool::createReference ( )

Creates a database reference id for the object (saves the object to the database and creates a reference id in the database)

public

Definition at line 80 of file class.ilObjQuestionPool.php.

References saveToDb().

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

Here is the call graph for this function:

◆ delete()

ilObjQuestionPool::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 122 of file class.ilObjQuestionPool.php.

References ilObject\deleteMetaData(), deleteQuestionpool(), and ilObject\getId().

                             : bool
     {
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         // delete meta data
         $this->deleteMetaData();
 
         //put here your module specific stuff
         $this->deleteQuestionpool();
 
         $qsaImportFails = new ilAssQuestionSkillAssignmentImportFails($this->getId());
         $qsaImportFails->deleteRegisteredImportFails();
 
         return true;
     }

Here is the call graph for this function:

◆ deleteQuestion()

ilObjQuestionPool::deleteQuestion ( int $question_id )

Definition at line 158 of file class.ilObjQuestionPool.php.

References assQuestion\instantiateQuestion().

Referenced by deleteQuestionpool().

                                                     : void
     {
         $question = assQuestion::instantiateQuestion($question_id);
         $question->delete($question_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteQuestionpool()

ilObjQuestionPool::deleteQuestionpool ( )

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

References ilFileUtils\delDir(), deleteQuestion(), getAllQuestions(), ilFileUtils\getDataDir(), and ilObject\getId().

Referenced by delete().

                                         : void
     {
         $questions = &$this->getAllQuestions();
 
         if (count($questions)) {
             foreach ($questions as $question_id) {
                 $this->deleteQuestion($question_id);
             }
         }
 
         $qpl_data_dir = ilFileUtils::getDataDir() . '/qpl_data';
         $directory = $qpl_data_dir . '/qpl_' . $this->getId();
         if (is_dir($directory)) {
             ilFileUtils::delDir($directory);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duplicateQuestion()

ilObjQuestionPool::duplicateQuestion ( int $question_id )

Definition at line 248 of file class.ilObjQuestionPool.php.

References _updateQuestionCount(), appendCounterToQuestionTitleIfNecessary(), and createQuestion().

Referenced by copyQuestion().

                                                        : int
     {
         $question = $this->createQuestion('', $question_id);
         $newtitle = $this->appendCounterToQuestionTitleIfNecessary(
             $question->getObject()->getTitle()
         );
         $new_id = $question->getObject()->duplicate(false, $newtitle);
         ilObjQuestionPool::_updateQuestionCount($new_id);
         return $new_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportFileItems()

ilObjQuestionPool::exportFileItems	(		$target_dir,
		&	$expLog
	)

export files of file itmes

Definition at line 481 of file class.ilObjQuestionPool.php.

References IL_INST_ID, and ilFileUtils\makeDir().

Referenced by objectToXmlWriter().

                                                           : void
     {
         foreach ($this->file_ids as $file_id) {
             $expLog->write(date("[y-m-d H:i:s] ") . "File Item " . $file_id);
             $file_dir = $target_dir . '/objects/il_' . IL_INST_ID . '_file_' . $file_id;
             ilFileUtils::makeDir($file_dir);
             $file_obj = new ilObjFile($file_id, false);
             $source_file = $file_obj->getFile($file_obj->getVersion());
             if (!is_file($source_file)) {
                 $source_file = $file_obj->getFile();
             }
             if (is_file($source_file)) {
                 copy($source_file, $file_dir . '/' . $file_obj->getFileName());
             }
             unset($file_obj);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTitleAndDescription()

ilObjQuestionPool::exportTitleAndDescription ( ilXmlWriter & $a_xml_writer )

Definition at line 391 of file class.ilObjQuestionPool.php.

References ilObject\getDescription(), ilObject\getTitle(), null, and ilXmlWriter\xmlElement().

Referenced by objectToXmlWriter().

                                                                          : void
     {
         $a_xml_writer->xmlElement('Title', null, $this->getTitle());
         $a_xml_writer->xmlElement('Description', null, $this->getDescription());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportXMLMediaObjects()

ilObjQuestionPool::exportXMLMediaObjects	(	&	$a_xml_writer,
			$a_inst,
			$a_target_dir,
		&	$expLog
	)

Definition at line 457 of file class.ilObjQuestionPool.php.

References ilObjMediaObject\_exists(), ilFileUtils\createDirectory(), and IL_INST_ID.

Referenced by objectToXmlWriter().

                                                                                            : void
     {
         foreach ($this->mob_ids as $mob_id) {
             $expLog->write(date('[y-m-d H:i:s] ') . 'Media Object ' . $mob_id);
             if (ilObjMediaObject::_exists($mob_id)) {
                 $target_dir = $a_target_dir . DIRECTORY_SEPARATOR . 'objects'
                     . DIRECTORY_SEPARATOR . 'il_' . IL_INST_ID . '_mob_' . $mob_id;
                 ilFileUtils::createDirectory($target_dir);
                 $media_obj = new ilObjMediaObject($mob_id);
                 $media_obj->exportXML($a_xml_writer, $a_inst);
                 foreach ($media_obj->getMediaItems() as $item) {
                     $stream = $item->getLocationStream();
                     file_put_contents($target_dir . DIRECTORY_SEPARATOR . $item->getLocation(), $stream);
                     $stream->close();
                 }
                 unset($media_obj);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportXMLPageObjects()

ilObjQuestionPool::exportXMLPageObjects	(	&	$a_xml_writer,
			$a_inst,
		&	$expLog,
			$questions
	)

export page objects to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

Definition at line 412 of file class.ilObjQuestionPool.php.

References $benchmark, ilPCFileList\collectFileItems(), and ilBenchmark\start().

Referenced by objectToXmlWriter().

                                                                                        : void
     {
         $ilBench = $this->benchmark;
 
         foreach ($questions as $question_id) {
             $ilBench->start('ContentObjectExport', 'exportPageObject');
             $expLog->write(date('[y-m-d H:i:s] ') . 'Page Object ' . $question_id);
 
             $attrs = [];
             $a_xml_writer->xmlStartTag('PageObject', $attrs);
 
             // export xml to writer object
             $ilBench->start('ContentObjectExport', 'exportPageObject_XML');
             $page_object = new ilAssQuestionPage($question_id);
             $page_object->buildDom();
             $page_object->insertInstIntoIDs($a_inst);
             $mob_ids = $page_object->collectMediaObjects(false);
             $file_ids = ilPCFileList::collectFileItems($page_object, $page_object->getDomDoc());
             $xml = $page_object->getXMLFromDom(false, false, false, '', true);
             $xml = str_replace('&', '&amp;', $xml);
             $a_xml_writer->appendXML($xml);
             $page_object->freeDom();
             unset($page_object);
             $ilBench->stop('ContentObjectExport', 'exportPageObject_XML');
 
             $ilBench->start("ContentObjectExport", "exportPageObject_CollectMedia");
             foreach ($mob_ids as $mob_id) {
                 $this->mob_ids[$mob_id] = $mob_id;
             }
             $ilBench->stop('ContentObjectExport', 'exportPageObject_CollectMedia');
 
             // collect all file items
             $ilBench->start('ContentObjectExport', 'exportPageObject_CollectFileItems');
             //$file_ids = $page_obj->getFileItemIds();
             foreach ($file_ids as $file_id) {
                 $this->file_ids[$file_id] = $file_id;
             }
             $ilBench->stop('ContentObjectExport', 'exportPageObject_CollectFileItems');
 
             $a_xml_writer->xmlEndTag("PageObject");
 
             $ilBench->stop('ContentObjectExport', 'exportPageObject');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportXMLSettings()

ilObjQuestionPool::exportXMLSettings ( $xmlWriter )

private

Parameters

ilXmlWriter $xmlWriter

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

References isSkillServiceEnabled(), and null.

Referenced by objectToXmlWriter().

                                                   : void
     {
         $xmlWriter->xmlStartTag('Settings');
         $xmlWriter->xmlElement('SkillService', null, (int) $this->isSkillServiceEnabled());
         $xmlWriter->xmlEndTag('Settings');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromXML()

ilObjQuestionPool::fromXML ( ?string $xml_file )

Definition at line 1251 of file class.ilObjQuestionPool.php.

                                               : void
     {
         $parser = new ilObjQuestionPoolXMLParser($this, $xml_file);
         $parser->startParsing();
     }

◆ getAllQuestionIds()

& ilObjQuestionPool::getAllQuestionIds ( )

Definition at line 572 of file class.ilObjQuestionPool.php.

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

                                         : array
     {
         $query_result = $this->db->queryF(
             'SELECT question_id, qpl_qst_type.type_tag, qpl_qst_type.plugin FROM qpl_questions, qpl_qst_type WHERE original_id IS NULL AND qpl_questions.tstamp > 0 AND obj_fi = %s AND complete = %s AND qpl_questions.question_type_fi = qpl_qst_type.question_type_id',
             ['integer', 'text'],
             [$this->getId(), 1]
         );
         $questions = [];
         if ($query_result->numRows()) {
             while ($row = $this->db->fetchAssoc($query_result)) {
                 if ($row['plugin']) {
                     if ($this->isPluginActive($row['type_tag'])) {
                         array_push($questions, $row['question_id']);
                     }
                 } else {
                     array_push($questions, $row['question_id']);
                 }
             }
         }
         return $questions;
     }

Here is the call graph for this function:

◆ getAllQuestions()

& ilObjQuestionPool::getAllQuestions ( )

Retrieve an array containing all question ids of the questionpool.

Returns: array An array containing all question ids of the questionpool

Definition at line 558 of file class.ilObjQuestionPool.php.

References ilObject\getId().

Referenced by deleteQuestionpool().

                                       : array
     {
         $result = $this->db->queryF(
             'SELECT question_id FROM qpl_questions WHERE obj_fi = %s AND qpl_questions.tstamp > 0 AND original_id IS NULL',
             ['integer'],
             [$this->getId()]
         );
         $questions = [];
         while ($row = $this->db->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:

◆ getDeleteableQuestionDetails()

ilObjQuestionPool::getDeleteableQuestionDetails ( $question_ids )

Returns an array containing the qpl_question and qpl_qst_type fields of deleteable questions for an array of question ids.

Parameters

array $question_ids An array containing the question ids

Returns: array An array containing the details of the requested questions public

Definition at line 859 of file class.ilObjQuestionPool.php.

References createQuestion().

                                                                : array
     {
         $result = [];
         $query_result = $this->db->query(
             'SELECT qpl_questions.*, qpl_qst_type.type_tag FROM qpl_questions, qpl_qst_type WHERE qpl_questions.question_type_fi = qpl_qst_type.question_type_id AND '
             . $this->db->in('qpl_questions.question_id', $question_ids, false, 'integer')
             . ' ORDER BY qpl_questions.title'
         );
         if ($query_result->numRows()) {
             while ($row = $this->db->fetchAssoc($query_result)) {
                 if (!$this->questionrepository->isUsedInRandomTest($row['question_id'])) {
                     array_push($result, $row);
                 } else {
                     // the question was used in a random test prior to ILIAS 3.7 so it was inserted
                     // as a reference to the original question pool object and not as a copy. To allow
                     // the deletion of the question pool object, a copy must be created and all database references
                     // of the original question must changed with the reference of the copy
 
                     // 1. Create a copy of the original question
                     $question = $this->createQuestion('', $row['question_id']);
                     $duplicate_id = $question->getObject()->duplicate(true);
                     if ($duplicate_id > 0) {
                         // 2. replace the question id in the solutions
                         $affectedRows = $this->db->manipulateF(
                             'UPDATE tst_solutions SET question_fi = %s WHERE question_fi = %s',
                             ['integer', 'integer'],
                             [$duplicate_id, $row['question_id']]
                         );
 
                         // 3. replace the question id in the question list of random tests
                         $affectedRows = $this->db->manipulateF(
                             'UPDATE tst_test_rnd_qst SET question_fi = %s WHERE question_fi = %s',
                             ['integer', 'integer'],
                             [$duplicate_id, $row['question_id']]
                         );
 
                         // 4. replace the question id in the test results
                         $affectedRows = $this->db->manipulateF(
                             'UPDATE tst_test_result SET question_fi = %s WHERE question_fi = %s',
                             ['integer', 'integer'],
                             [$duplicate_id, $row['question_id']]
                         );
 
                         // 5. replace the question id in the test&assessment log
                         $affectedRows = $this->db->manipulateF(
                             'UPDATE ass_log SET question_fi = %s WHERE question_fi = %s',
                             ['integer', 'integer'],
                             [$duplicate_id, $row['question_id']]
                         );
 
                         // 6. The original question can be deleted, so add it to the list of questions
                         array_push($result, $row);
                     }
                 }
             }
         }
         return $result;
     }

Here is the call graph for this function:

◆ getExportDirectory()

ilObjQuestionPool::getExportDirectory ( $type = '' )

get export directory of questionpool

Definition at line 536 of file class.ilObjQuestionPool.php.

References ilObject\$type, ilExport\_getExportDirectory(), ilFileUtils\getDataDir(), ilObject\getId(), and ilObject\getType().

Referenced by createExportDirectory().

                                                   : string
     {
         switch ($type) {
             case 'xml':
                 $export_dir = ilExport::_getExportDirectory($this->getId(), $type, $this->getType());
                 break;
             case 'xlsx':
             case 'zip':
                 $export_dir = ilFileUtils::getDataDir() . "/qpl_data/qpl_{$this->getId()}/export_{$type}";
                 break;
             default:
                 $export_dir = ilFileUtils::getDataDir() . '/qpl_data' . '/qpl_' . $this->getId() . '/export';
                 break;
         }
         return $export_dir;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImportMapping()

ilObjQuestionPool::getImportMapping ( )

get array of (two) new created questions for import id

Definition at line 611 of file class.ilObjQuestionPool.php.

                                       : array
     {
         return [];
     }

◆ getPrintviewQuestions()

ilObjQuestionPool::getPrintviewQuestions ( )

Definition at line 289 of file class.ilObjQuestionPool.php.

References ilObject\getId(), getQuestionTypeTranslations(), and isPluginActive().

                                            : array
     {
         $query_result = $this->db->queryF(
             'SELECT qpl_questions.*, qpl_qst_type.type_tag, qpl_qst_type.plugin, qpl_questions.tstamp updated FROM qpl_questions, qpl_qst_type WHERE qpl_questions.original_id IS NULL AND qpl_questions.tstamp > 0 AND qpl_questions.question_type_fi = qpl_qst_type.question_type_id AND qpl_questions.obj_fi = %s',
             ['integer'],
             [$this->getId()]
         );
         $rows = [];
         $types = $this->getQuestionTypeTranslations();
         if ($query_result->numRows()) {
             while ($row = $this->db->fetchAssoc($query_result)) {
                 $row['ttype'] = $types[$row['type_tag']];
                 if ($row['plugin']) {
                     if ($this->isPluginActive($row['type_tag'])) {
                         array_push($rows, $row);
                     }
                 } else {
                     array_push($rows, $row);
                 }
             }
         }
         return $rows;
     }

Here is the call graph for this function:

◆ getQplQuestions()

ilObjQuestionPool::getQplQuestions ( )

Definition at line 999 of file class.ilObjQuestionPool.php.

References ilObject\getId().

Referenced by cloneObject().

                                      : array
     {
         $questions = [];
         $result = $this->db->queryF(
             'SELECT qpl_questions.question_id FROM qpl_questions WHERE qpl_questions.original_id IS NULL AND qpl_questions.tstamp > 0 AND qpl_questions.obj_fi = %s',
             ['integer'],
             [$this->getId()]
         );
         while ($row = $this->db->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:

◆ getQuestionDetails()

ilObjQuestionPool::getQuestionDetails ( $question_ids )

Returns an array containing the qpl_question and qpl_qst_type fields for an array of question ids.

Parameters

array $question_ids An array containing the question ids

Returns: array An array containing the details of the requested questions public

Definition at line 829 of file class.ilObjQuestionPool.php.

                                                      : array
     {
         $result = [];
         $query_result = $this->db->query(
             'SELECT qpl_questions.*, qpl_qst_type.type_tag '
             . 'FROM qpl_questions, qpl_qst_type '
             . 'WHERE qpl_questions.question_type_fi = qpl_qst_type.question_type_id '
             . 'AND ' . $this->db->in(
                 'qpl_questions.question_id',
                 $question_ids,
                 false,
                 'integer'
             ) . ' ORDER BY qpl_questions.title'
         );
         if ($query_result->numRows()) {
             while ($row = $this->db->fetchAssoc($query_result)) {
                 array_push($result, $row);
             }
         }
         return $result;
     }

◆ getQuestionList()

ilObjQuestionPool::getQuestionList ( )

Definition at line 1158 of file class.ilObjQuestionPool.php.

References ilObject\getId().

                                      : array
     {
         $questions = [];
         $result = $this->db->queryF(
             'SELECT qpl_questions.*, qpl_qst_type.* FROM qpl_questions, qpl_qst_type WHERE qpl_questions.original_id IS NULL AND qpl_questions.obj_fi = %s AND qpl_questions.tstamp > 0 AND qpl_questions.question_type_fi = qpl_qst_type.question_type_id',
             ['integer'],
             [$this->getId()]
         );
         while ($row = $this->db->fetchAssoc($result)) {
             array_push($questions, $row);
         }
         return $questions;
     }

Here is the call graph for this function:

◆ getQuestiontype()

ilObjQuestionPool::getQuestiontype ( $question_id )

Definition at line 208 of file class.ilObjQuestionPool.php.

References $data, and null.

     {
         if ($question_id < 1) {
             return null;
         }
 
         $result = $this->db->queryF(
             'SELECT qpl_qst_type.type_tag FROM qpl_questions, qpl_qst_type WHERE qpl_questions.question_type_fi = qpl_qst_type.question_type_id AND qpl_questions.question_id = %s',
             ['integer'],
             [$question_id]
         );
 
         if ($result->numRows() == 1) {
             $data = $this->db->fetchAssoc($result);
             return $data['type_tag'];
         }
         return null;
     }

◆ getQuestionTypeByTypeId()

static ilObjQuestionPool::getQuestionTypeByTypeId ( $type_id )

static

Definition at line 1088 of file class.ilObjQuestionPool.php.

References $DIC, $ilDB, and null.

Referenced by ilObjQuestionPoolGUI\cleanupAfterImport(), and ilObjTestGUI\createQuestionPool().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $query = 'SELECT type_tag FROM qpl_qst_type WHERE question_type_id = %s';
         $types = ['integer'];
         $values = [$type_id];
         $result = $ilDB->queryF($query, $types, $values);
 
         if ($row = $ilDB->fetchAssoc($result)) {
             return $row['type_tag'];
         }
         return null;
     }

Here is the caller graph for this function:

◆ getQuestionTypes()

ilObjQuestionPool::getQuestionTypes	(	$all_tags = `false`,
		$fixOrder = `false`,
		$withDeprecatedTypes = `true`
	)

Definition at line 1051 of file class.ilObjQuestionPool.php.

                                                                                                        : array
     {
         return self::_getQuestionTypes($all_tags, $fixOrder, $withDeprecatedTypes);
     }

◆ getQuestionTypeTranslations()

static ilObjQuestionPool::getQuestionTypeTranslations ( )

static

Definition at line 1104 of file class.ilObjQuestionPool.php.

References $DIC, $ilDB, ilObject\$lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Referenced by getPrintviewQuestions().

                                                         : array
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $lng = $DIC['lng'];
         $component_factory = $DIC['component.factory'];
 
         $lng->loadLanguageModule('assessment');
         $result = $ilDB->query('SELECT * FROM qpl_qst_type');
         $types = [];
         while ($row = $ilDB->fetchAssoc($result)) {
             if ($row['plugin'] == 0) {
                 $types[$row['type_tag']] = $lng->txt($row['type_tag']);
             } else {
                 foreach ($component_factory->getActivePluginsInSlot('qst') as $pl) {
                     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:

◆ getTaxonomyIds()

ilObjQuestionPool::getTaxonomyIds ( )

get ids of all taxonomies corresponding to current pool

Returns: array

Definition at line 1223 of file class.ilObjQuestionPool.php.

References ilObject\getId(), and ilObjTaxonomy\getUsageOfObject().

                                     : array
     {
         return ilObjTaxonomy::getUsageOfObject($this->getId());
     }

Here is the call graph for this function:

◆ isInUse()

ilObjQuestionPool::isInUse ( int $question_id )

Definition at line 227 of file class.ilObjQuestionPool.php.

                                              : bool
     {
         $result = $this->db->queryF(
             'SELECT COUNT(solution_id) solution_count FROM tst_solutions WHERE question_fi = %s',
             ['integer'],
             [$question_id]
         );
         $row = $this->db->fetchAssoc($result);
         return $row['solution_count'];
     }

◆ isPluginActive()

ilObjQuestionPool::isPluginActive ( $questionType )

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

Parameters

string $a_pname The plugin name public

Definition at line 1189 of file class.ilObjQuestionPool.php.

References ilComponentInfo\TYPE_MODULES.

Referenced by getAllQuestionIds(), and getPrintviewQuestions().

                                                  : bool
     {
         if (!$this->component_repository->getComponentByTypeAndName(
             ilComponentInfo::TYPE_MODULES,
             'TestQuestionPool'
         )->getPluginSlotById('qst')->hasPluginName($questionType)) {
             return false;
         }
 
         return $this->component_repository
             ->getComponentByTypeAndName(
                 ilComponentInfo::TYPE_MODULES,
                 'TestQuestionPool'
             )
             ->getPluginSlotById(
                 'qst'
             )
             ->getPluginByName(
                 $questionType
             )->isActive();
     }

Here is the caller graph for this function:

◆ isSkillManagementGloballyActivated()

static ilObjQuestionPool::isSkillManagementGloballyActivated ( )

static

Definition at line 1240 of file class.ilObjQuestionPool.php.

References null.

Referenced by ilObjQuestionPoolSettingsGeneralGUI\buildForm(), ilQuestionPoolSkillAdministrationGUI\isAccessDenied(), and ilObjQuestionPoolGUI\isSkillsTabRequired().

                                                                : ?bool
     {
         if (self::$isSkillManagementGloballyActivated === null) {
             $skmgSet = new ilSkillManagementSettings();
 
             self::$isSkillManagementGloballyActivated = $skmgSet->isActivated();
         }
 
         return self::$isSkillManagementGloballyActivated;
     }

Here is the caller graph for this function:

◆ isSkillServiceEnabled()

ilObjQuestionPool::isSkillServiceEnabled ( )

Definition at line 1228 of file class.ilObjQuestionPool.php.

References $skill_service_enabled.

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

                                            : bool
     {
         return $this->skill_service_enabled;
     }

Here is the caller graph for this function:

◆ loadFromDb()

ilObjQuestionPool::loadFromDb ( )

Definition at line 164 of file class.ilObjQuestionPool.php.

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

Referenced by read().

                                 : void
     {
         $result = $this->db->queryF(
             'SELECT * FROM qpl_questionpool WHERE obj_fi = %s',
             ['integer'],
             [$this->getId()]
         );
         if ($result->numRows() == 1) {
             $row = $this->db->fetchAssoc($result);
             $this->setSkillServiceEnabled((bool) $row['skill_service']);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyExportIdentifier()

ilObjQuestionPool::modifyExportIdentifier	(	$a_tag,
		$a_param,
		$a_value
	)

Definition at line 397 of file class.ilObjQuestionPool.php.

References ilUtil\insertInstIntoID().

     {
         if ($a_tag == 'Identifier' && $a_param == 'Entry') {
             $a_value = ilUtil::insertInstIntoID($a_value);
         }
 
         return $a_value;
     }

Here is the call graph for this function:

◆ moveToClipboard()

ilObjQuestionPool::moveToClipboard ( int $question_id )

Moves a question to the clipboard.

Parameters

integer $question_id Object id of the question private

Definition at line 769 of file class.ilObjQuestionPool.php.

References ilSession\get(), null, and ilSession\set().

                                                      : void
     {
         if (ilSession::get('qpl_clipboard') == null) {
             ilSession::set('qpl_clipboard', []);
         }
         $clip = ilSession::get('qpl_clipboard');
         $clip[$question_id] = ['question_id' => $question_id, 'action' => 'move'];
         ilSession::set('qpl_clipboard', $clip);
     }

Here is the call graph for this function:

◆ objectToXmlWriter()

ilObjQuestionPool::objectToXmlWriter	(	ilXmlWriter &	$a_xml_writer,
			$a_inst,
			$a_target_dir,
		&	$expLog,
			$questions
	)

export pages of test to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

Definition at line 329 of file class.ilObjQuestionPool.php.

References $benchmark, exportFileItems(), exportTitleAndDescription(), exportXMLMediaObjects(), exportXMLPageObjects(), exportXMLSettings(), populateQuestionSkillAssignmentsXml(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                                                                                                : void
     {
         $ilBench = $this->benchmark;
 
         $this->mob_ids = [];
         $this->file_ids = [];
 
         $attrs = [];
         $attrs['Type'] = 'Questionpool_Test';
         $a_xml_writer->xmlStartTag('ContentObject', $attrs);
 
         // MetaData
         $this->exportTitleAndDescription($a_xml_writer);
 
         // Settings
         $this->exportXMLSettings($a_xml_writer);
 
         // PageObjects
         $expLog->write(date('[y-m-d H:i:s] ') . 'Start Export Page Objects');
         $ilBench->start('ContentObjectExport', 'exportPageObjects');
         $this->exportXMLPageObjects($a_xml_writer, $a_inst, $expLog, $questions);
         $ilBench->stop('ContentObjectExport', 'exportPageObjects');
         $expLog->write(date('[y-m-d H:i:s] ') . 'Finished Export Page Objects');
 
         // MediaObjects
         $expLog->write(date('[y-m-d H:i:s] ') . 'Start Export Media Objects');
         $ilBench->start('ContentObjectExport', 'exportMediaObjects');
         $this->exportXMLMediaObjects($a_xml_writer, $a_inst, $a_target_dir, $expLog);
         $ilBench->stop('ContentObjectExport', 'exportMediaObjects');
         $expLog->write(date('[y-m-d H:i:s] ') . 'Finished Export Media Objects');
 
         // FileItems
         $expLog->write(date('[y-m-d H:i:s] ') . 'Start Export File Items');
         $ilBench->start('ContentObjectExport', 'exportFileItems');
         $this->exportFileItems($a_target_dir, $expLog);
         $ilBench->stop('ContentObjectExport', 'exportFileItems');
         $expLog->write(date('[y-m-d H:i:s] ') . 'Finished Export File Items');
 
         // skill assignments
         $this->populateQuestionSkillAssignmentsXml($a_xml_writer, $questions);
 
         $a_xml_writer->xmlEndTag('ContentObject');
     }

Here is the call graph for this function:

◆ pasteFromClipboard()

ilObjQuestionPool::pasteFromClipboard ( )

Copies/Moves a question from the clipboard.

private

Definition at line 697 of file class.ilObjQuestionPool.php.

References _updateQuestionCount(), ilSession\clear(), CLIENT_WEB_DIR, copyQuestion(), ilSession\get(), ilObject\getId(), ilFileUtils\makeDirParents(), and null.

                                         : bool
     {
         $success = false;
         if (ilSession::get('qpl_clipboard') != null) {
             $success = true;
             foreach (ilSession::get('qpl_clipboard') as $question_object) {
                 if (strcmp($question_object['action'], 'move') == 0) {
                     $result = $this->db->queryF(
                         'SELECT obj_fi FROM qpl_questions WHERE question_id = %s',
                         ['integer'],
                         [$question_object['question_id']]
                     );
                     if ($result->numRows() == 1) {
                         $row = $this->db->fetchAssoc($result);
                         $source_questionpool = $row['obj_fi'];
                         $affectedRows = $this->db->manipulateF(
                             'UPDATE qpl_questions SET obj_fi = %s WHERE question_id = %s',
                             ['integer', 'integer'],
                             [$this->getId(), $question_object['question_id']]
                         );
                         if (!$affectedRows) {
                             $success = false;
                         }
 
                         $source_path = CLIENT_WEB_DIR . '/assessment/' . $source_questionpool . '/' . $question_object['question_id'] . '/';
                         if (@is_dir($source_path)) {
                             $target_path = CLIENT_WEB_DIR . '/assessment/' . $this->getId() . '/';
                             if (!@is_dir($target_path)) {
                                 ilFileUtils::makeDirParents($target_path);
                             }
                             rename($source_path, $target_path . $question_object['question_id']);
                         }
 
                         ilObjQuestionPool::_updateQuestionCount($source_questionpool);
                     }
                 } else {
                     $new_question_id = $this->copyQuestion($question_object['question_id'], $this->getId());
                     if (!$new_question_id) {
                         $success = false;
                     }
                 }
             }
         }
         // update question count of question pool
         ilObjQuestionPool::_updateQuestionCount($this->getId());
         ilSession::clear('qpl_clipboard');
 
         return $success;
     }

Here is the call graph for this function:

◆ populateQuestionSkillAssignmentsXml()

ilObjQuestionPool::populateQuestionSkillAssignmentsXml	(	ilXmlWriter &	$a_xml_writer,
			$questions
	)

protected

Parameters

ilXmlWriter	$a_xml_writer
	$questions

Definition at line 377 of file class.ilObjQuestionPool.php.

References ilObject\getId().

Referenced by objectToXmlWriter().

                                                                                                   : void
     {
         $assignmentList = new ilAssQuestionSkillAssignmentList($this->db);
         $assignmentList->setParentObjId($this->getId());
         $assignmentList->loadFromDb();
         $assignmentList->loadAdditionalSkillData();
 
         $skillQuestionAssignmentExporter = new ilAssQuestionSkillAssignmentExporter();
         $skillQuestionAssignmentExporter->setXmlWriter($a_xml_writer);
         $skillQuestionAssignmentExporter->setQuestionIds($questions);
         $skillQuestionAssignmentExporter->setAssignmentList($assignmentList);
         $skillQuestionAssignmentExporter->export();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ purgeQuestions()

ilObjQuestionPool::purgeQuestions ( )

Definition at line 1211 of file class.ilObjQuestionPool.php.

References ILIAS\Repository\user().

                                     : void
     {
         $incompleteQuestionPurger = new ilAssIncompleteQuestionPurger($this->db);
         $incompleteQuestionPurger->setOwnerId($this->user->getId());
         $incompleteQuestionPurger->purge();
     }

Here is the call graph for this function:

◆ questionsToXML()

ilObjQuestionPool::questionsToXML ( $questions )

Returns a QTI xml representation of a list of questions.

Parameters

array $questions An array containing the question ids of the questions

Returns: string The QTI xml representation of the questions public

Definition at line 623 of file class.ilObjQuestionPool.php.

References createQuestion().

                                               : string
     {
         $xml = '';
         // export button was pressed
         if (count($questions) > 0) {
             foreach ($questions as $key => $value) {
                 $question = $this->createQuestion('', $value);
                 $xml .= $question->getObject()->toXML();
             }
             if (count($questions) > 1) {
                 $xml = preg_replace('/<\/questestinterop>\s*<.xml.*?>\s*<questestinterop>/', '', $xml);
             }
         }
         $xml = preg_replace(
             '/(<\?xml[^>]*?>)/',
             '\\1' . '<!DOCTYPE questestinterop SYSTEM "ims_qtiasiv1p2p1.dtd">',
             $xml
         );
         return $xml;
     }

Here is the call graph for this function:

◆ read()

ilObjQuestionPool::read ( $a_force_db = false )

read object data from db into object

Parameters

boolean public

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

References loadFromDb().

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

Here is the call graph for this function:

◆ saveToDb()

ilObjQuestionPool::saveToDb ( )

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

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

Referenced by createReference().

                               : void
     {
         $result = $this->db->queryF(
             'SELECT id_questionpool FROM qpl_questionpool WHERE obj_fi = %s',
             ['integer'],
             [$this->getId()]
         );
 
         if ($result->numRows() == 1) {
             $result = $this->db->update(
                 'qpl_questionpool',
                 [
                     'skill_service' => ['integer', (int) $this->isSkillServiceEnabled()],
                     'tstamp' => ['integer', time()]
                 ],
                 [
                     'obj_fi' => ['integer', $this->getId()]
                 ]
             );
         } else {
             $next_id = $this->db->nextId('qpl_questionpool');
 
             $result = $this->db->insert('qpl_questionpool', [
                 'id_questionpool' => ['integer', $next_id],
                 'skill_service' => ['integer', (int) $this->isSkillServiceEnabled()],
                 'tstamp' => ['integer', time()],
                 'obj_fi' => ['integer', $this->getId()]
             ]);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSkillServiceEnabled()

ilObjQuestionPool::setSkillServiceEnabled ( bool $skill_service_enabled )

Definition at line 1233 of file class.ilObjQuestionPool.php.

References $skill_service_enabled.

Referenced by loadFromDb().

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

Here is the caller graph for this function:

◆ update()

ilObjQuestionPool::update ( )

update object data

public

Returns: boolean

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

References ilObject\updateMetaData().

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

Here is the call graph for this function:

Field Documentation

◆ $benchmark

ilBenchmark ilObjQuestionPool::$benchmark

private

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

Referenced by exportXMLPageObjects(), and objectToXmlWriter().

◆ $component_repository

ilComponentRepository ilObjQuestionPool::$component_repository

private

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

◆ $file_ids

array ilObjQuestionPool::$file_ids

private

Definition at line 39 of file class.ilObjQuestionPool.php.

◆ $isSkillManagementGloballyActivated

ilObjQuestionPool::$isSkillManagementGloballyActivated = null

staticprivate

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

◆ $mob_ids

array ilObjQuestionPool::$mob_ids

private

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

◆ $questionrepository

GeneralQuestionPropertiesRepository ilObjQuestionPool::$questionrepository

private

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

◆ $skill_service_enabled

bool ilObjQuestionPool::$skill_service_enabled

private

Definition at line 40 of file class.ilObjQuestionPool.php.

Referenced by isSkillServiceEnabled(), and setSkillServiceEnabled().

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

components/ILIAS/TestQuestionPool/classes/class.ilObjQuestionPool.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getAvailableQuestionpools()

◆ _getQuestionCount()

◆ _getQuestionTypes()

◆ _getSelfAssessmentQuestionTypes()

◆ _hasEqualPoints()

◆ _isWriteable()

◆ _updateQuestionCount()

◆ appendCounterToQuestionTitleIfNecessary()

◆ checkQuestionParent()

◆ cleanupClipboard()

◆ cloneObject()

◆ copyQuestion()

◆ copyToClipboard()

◆ create()

◆ createExportDirectory()

◆ createQuestion()

◆ createReference()

◆ delete()

◆ deleteQuestion()

◆ deleteQuestionpool()

◆ duplicateQuestion()

◆ exportFileItems()

◆ exportTitleAndDescription()

◆ exportXMLMediaObjects()

◆ exportXMLPageObjects()

◆ exportXMLSettings()

◆ fromXML()

◆ getAllQuestionIds()

◆ getAllQuestions()

◆ getDeleteableQuestionDetails()

◆ getExportDirectory()

◆ getImportMapping()

◆ getPrintviewQuestions()

◆ getQplQuestions()

◆ getQuestionDetails()

◆ getQuestionList()

◆ getQuestiontype()

◆ getQuestionTypeByTypeId()

◆ getQuestionTypes()

◆ getQuestionTypeTranslations()

◆ getTaxonomyIds()

◆ isInUse()

◆ isPluginActive()

◆ isSkillManagementGloballyActivated()

◆ isSkillServiceEnabled()

◆ loadFromDb()

◆ modifyExportIdentifier()

◆ moveToClipboard()

◆ objectToXmlWriter()

◆ pasteFromClipboard()

◆ populateQuestionSkillAssignmentsXml()

◆ purgeQuestions()

◆ questionsToXML()

◆ read()

◆ saveToDb()

◆ setSkillServiceEnabled()

◆ update()

Field Documentation

◆ $benchmark

◆ $component_repository

◆ $file_ids

◆ $isSkillManagementGloballyActivated

◆ $mob_ids

◆ $questionrepository

◆ $skill_service_enabled