Inheritance diagram for ilObjSurveyQuestionPool:

Collaboration diagram for ilObjSurveyQuestionPool:

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

	create ($a_upload=false)

	update ()

	read ()

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

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

	copyQuestion (int $question_id, int $questionpool_to)

	loadFromDb ()

	saveToDb ()

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

	deleteAllData ()

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

	getQuestiontype (int $question_id)

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

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

	getQuestionsInfo (array $question_array)

	duplicateQuestion (int $question_id, int $obj_id=0)
	Duplicates a question for a question pool. More...

	getQuestionsData (array $arrFilter)
	Retrieve the data for the output of the question pool. More...

	createExportDirectory ()
	creates data directory for export files data_dir/spl_data/spl_<id>/export More...

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

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

	createImportDirectory ()
	creates data directory for import files (data_dir/spl_data/spl_<id>/import More...

	getImportDirectory ()

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

	toXmlForExport ()

	getQuestions ()

	importObject (string $source, bool $spl_exists=false)
	Imports survey questions into ILIAS. More...

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

	purgeQuestions ()
	Remove all questions with tstamp = 0. More...

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

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

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

	setObligatoryStates (array $obligatory_questions)

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

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

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

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

	setOwner (int $usr_id)

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

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

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

	update ()

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

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

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

	createReference ()
	creates reference for object More...

	countReferences ()

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

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

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

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

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

	selfOrParentWithRatingEnabled ()

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

Static Public Member Functions
static	_lookupOnline (int $a_obj_id)

static	_isWriteable (int $object_id)
	Returns true, if the question pool is writeable for the current user. More...

static	_getQuestiontypes ()
	Get all available question types. More...

static	_getQuestionClasses ()

static	_getQuestionTypeTranslations ()

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

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

static	_lookupImportId (int $obj_id)

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

static	_getIdForImportId (string $import_id)

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

static	_lookupTitle (int $obj_id)

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

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

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

static	_lookupDescription (int $obj_id)

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

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

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

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

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

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

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

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

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

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

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

static	getIconForType (string $type)

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

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

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

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

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

Data Fields
bool	$online = false

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Attributes
InternalDomainService	$domain

EditManager	$edit_manager

ilObjUser	$user

ilComponentRepository	$component_repository

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

Private Attributes
ilGlobalTemplateInterface	$main_tpl

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

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Detailed Description

Class ilObjSurveyQuestionPool.

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

      {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
 
        $this->log = $DIC["ilLog"];
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->component_repository = $DIC["component.repository"];
        $this->type = "spl";
        parent::__construct($a_id, $a_call_by_reference);
        $this->edit_manager = $DIC->surveyQuestionPool()
            ->internal()
            ->domain()
            ->editing();
        $this->domain = $DIC->surveyQuestionPool()->internal()->domain();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _getAvailableQuestionpools()

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

static

Returns the available question pools for the active user.

Returns: array<int, string> keys are ref or obj IDs, values are titles

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

     : array {
        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 sq.obj_fi, od.offline as offline FROM svy_qpl sq JOIN object_data od ON (sq.obj_fi = od.obj_id) WHERE sq.obj_fi > 0 AND sq.tstamp > 0 AND NOT(od.offline = 1)");
        while ($row = $ilDB->fetchAssoc($result)) {
            $allqpls[$row['obj_fi']] = !($row['offline']);
        }
        foreach ($qpls as $ref_id) {
            $obj_id = ilObject::_lookupObjectId($ref_id);
            if ($could_be_offline || ($allqpls[$obj_id] ?? 0) == 1) {
                if ($use_object_id) {
                    $result_array[$obj_id] = $titles[$ref_id];
                } else {
                    $result_array[(int) $ref_id] = $titles[$ref_id];
                }
            }
        }
        return $result_array;
    }

Referenced by ilSurveyQuestionbrowserTableGUI\__construct().

Here is the caller graph for this function:

◆ _getQuestionClasses()

static ilObjSurveyQuestionPool::_getQuestionClasses ( )

static

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

                                                : array
    {
        $classes = array_map(
            static function (array $c): string {
                return $c["type_tag"];
            },
            self::_getQuestiontypes()
        );
        return $classes;
    }

References $c.

Referenced by ilObjSurvey\getMaxSumScore().

Here is the caller graph for this function:

◆ _getQuestiontypes()

static ilObjSurveyQuestionPool::_getQuestiontypes ( )

static

Get all available question types.

Todo:: move to question manager, use dto

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

                                              : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $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 ((int) $row["plugin"] === 0) {
                $types[$lng->txt($row["type_tag"])] = $row;
            }
        }
        ksort($types);
 
 
        // #14263 - default sorting
 
        $default_sorting = array_flip(array(
            "SurveySingleChoiceQuestion",
            "SurveyMultipleChoiceQuestion",
            "SurveyMatrixQuestion",
            "SurveyMetricQuestion",
            "SurveyTextQuestion"
        ));
 
        $sorted = array();
        $idx = count($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;
    }

References $DIC, $ilDB, and $lng.

Referenced by ilSurveyQuestionTableGUI\importData(), ilSurveyQuestionbrowserTableGUI\initFilter(), ilSurveyQuestionsTableGUI\initFilter(), ilSurveyEditorGUI\questionsObject(), and ilObjSurveyQuestionPoolGUI\questionsObject().

Here is the caller graph for this function:

◆ _getQuestionTypeTranslations()

static ilObjSurveyQuestionPool::_getQuestionTypeTranslations ( )

static

Todo:: move to question manager, use dto

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

                                                         : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $lng = $DIC->language();
 
        $component_factory = $DIC["component.factory"];
 
        $lng->loadLanguageModule("survey");
        $result = $ilDB->query("SELECT * FROM svy_qtype");
        $types = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            if ((int) $row["plugin"] === 0) {
                $types[$row['type_tag']] = $lng->txt($row["type_tag"]);
            }
        }
        ksort($types);
        return $types;
    }

References $DIC, $ilDB, and $lng.

◆ _isWriteable()

static ilObjSurveyQuestionPool::_isWriteable ( int $object_id )

static

Returns true, if the question pool is writeable for the current user.

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

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

◆ _lookupOnline()

static ilObjSurveyQuestionPool::_lookupOnline ( int $a_obj_id )

static

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

                                                       : bool
    {
        return !self::getOfflineStatus($a_obj_id);
    }

Referenced by ILIAS\Container\Content\Filter\FilterManager\legacyOnlineFilter().

Here is the caller graph for this function:

◆ cloneObject()

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

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

                                                                                          : ?ilObject
    {
        $newObj = parent::cloneObject($target_id, $copy_id, $omit_tree);
 
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($copy_id);
 
        $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
        $this->cloneMetaData($newObj);
 
        // update the metadata with the new title of the question pool
        $newObj->updateMetaData();
        return $newObj;
    }

References ilCopyWizardOptions\_getInstance(), ilObject\cloneMetaData(), and getQuestions().

Here is the call graph for this function:

◆ copyQuestion()

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

Parameters

int	$question_id
int	$questionpool_to	question pool id

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

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

◆ copyToClipboard()

ilObjSurveyQuestionPool::copyToClipboard ( int $question_id )

Copies a question to the clipboard.

Parameters

int $question_id Object id of the question

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

     : void {
        $this->edit_manager->addQuestionToClipboard($question_id, "copy");
    }

◆ create()

ilObjSurveyQuestionPool::create ( $a_upload = false )

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

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

References $id, and ilObject\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

Exceptions

ilSurveyException

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

                                           : void
    {
        $spl_data_dir = ilFileUtils::getDataDir() . "/spl_data";
        ilFileUtils::makeDir($spl_data_dir);
        if (!is_writable($spl_data_dir)) {
            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();
        ilFileUtils::makeDir($spl_dir);
        if (!is_dir($spl_dir)) {
            throw new ilSurveyException("Creation of Survey Questionpool Directory failed.");
        }
        // create Export subdirectory (data_dir/lm_data/lm_<id>/Export)
        $export_dir = $spl_dir . "/export";
        ilFileUtils::makeDir($export_dir);
        if (!is_dir($export_dir)) {
            throw new ilSurveyException("Creation of Survey Questionpool Export Directory failed.");
        }
    }

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

Here is the call graph for this function:

◆ createImportDirectory()

ilObjSurveyQuestionPool::createImportDirectory ( )

creates data directory for import files (data_dir/spl_data/spl_<id>/import

Exceptions

ilSurveyException

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

                                           : void
    {
        $spl_data_dir = ilFileUtils::getDataDir() . "/spl_data";
        ilFileUtils::makeDir($spl_data_dir);
 
        if (!is_writable($spl_data_dir)) {
            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();
        ilFileUtils::makeDir($spl_dir);
        if (!is_dir($spl_dir)) {
            throw new ilSurveyException("Creation of Survey Questionpool Directory failed.");
        }
 
        // create import subdirectory (data_dir/spl_data/spl_<id>/import)
        $import_dir = $spl_dir . "/import";
        ilFileUtils::makeDir($import_dir);
        if (!is_dir($import_dir)) {
            throw new ilSurveyException("Creation of Survey Questionpool Import Directory failed.");
        }
    }

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

Here is the call graph for this function:

◆ createQuestion()

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

Todo:: check this method, it does not seem to create anything

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

     : SurveyQuestionGUI {
        if ((!$question_type) and ($question_id > 0)) {
            $question_type = $this->getQuestiontype($question_id);
        }
 
        $question_type_gui = $question_type . "GUI";
        $question = new $question_type_gui();
 
        if ($question_id > 0) {
            $question->object->loadFromDb($question_id);
        }
 
        return $question;
    }

References getQuestiontype().

Here is the call graph for this function:

◆ delete()

ilObjSurveyQuestionPool::delete ( )

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

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

Reimplemented from ilObject.

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

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

◆ deleteAllData()

ilObjSurveyQuestionPool::deleteAllData ( )

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

                                   : void
    {
        $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 = ilFileUtils::getDataDir() . "/spl_data";
        $directory = $spl_data_dir . "/spl_" . $this->getId();
        if (is_dir($directory)) {
            ilFileUtils::delDir($directory);
        }
    }

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

Here is the call graph for this function:

◆ duplicateQuestion()

ilObjSurveyQuestionPool::duplicateQuestion	(	int	$question_id,
		int	$obj_id = `0`
	)

Duplicates a question for a question pool.

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

     : void {
        $ilUser = $this->user;
        $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);
        }
        $max_len = 195;
        if (strlen($question->getTitle() . $suffix) > $max_len) {
            $title = substr($question->getTitle(), 0, $max_len - strlen($suffix)) . $suffix;
        } else {
            $title = $question->getTitle() . $suffix;
        }
        $question->duplicate(false, $title, $ilUser->fullname, $ilUser->id);
    }

◆ getExportDirectory()

ilObjSurveyQuestionPool::getExportDirectory ( )

get export directory of survey

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

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

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

Here is the call graph for this function:

◆ getExportFiles()

ilObjSurveyQuestionPool::getExportFiles ( string $dir )

get export files

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

                                               : array
    {
        // quit if import dir not available
        if (!is_dir($dir) or
            !is_writable($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);
 
        return $file;
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ getImportDirectory()

ilObjSurveyQuestionPool::getImportDirectory ( )

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

                                        : string
    {
        return ilFileUtils::getDataDir() . "/spl_data" .
            "/spl_" . $this->getId() . "/import";
    }

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

Here is the call graph for this function:

◆ getQuestionInfos()

ilObjSurveyQuestionPool::getQuestionInfos ( array $question_ids )

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

Parameters

int[] $question_ids An array of question id's

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

Todo:: move to question manager, use dto

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

                                                         : array
    {
        $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)) {
                    $found[] = array('id' => $data["question_id"],
                                     'title' => $data["title"],
                                     'description' => $data["description"],
                                     'type_tag' => $data["type_tag"]
                    );
                }
            }
        }
        return $found;
    }

References $data, and $ilDB.

◆ getQuestions()

ilObjSurveyQuestionPool::getQuestions ( )

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

                                  : array
    {
        $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)) {
                $questions[] = $row["question_id"];
            }
        }
        return $questions;
    }

References $ilDB, and ILIAS\Survey\Mode\getId().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionsData()

ilObjSurveyQuestionPool::getQuestionsData ( array $arrFilter )

Retrieve the data for the output of the question pool.

Todo:: move to question/pool manager

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

     : array {
        $ilDB = $this->db;
        $where = "";
        if (count($arrFilter) > 0) {
            foreach ($arrFilter as $key => $value) {
                $arrFilter[$key] = str_replace('%', '', $value);
            }
            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"]) {
                    continue;
                } else {
                    $rows[] = $row;
                }
            }
        }
        return $rows;
    }

References $ilDB.

◆ getQuestionsInfo()

ilObjSurveyQuestionPool::getQuestionsInfo ( array $question_array )

Parameters

int[] $question_array question ids

Todo:: move to question manager/repo, use dto

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

     : array {
        $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"]) {
                continue;
            } else {
                $result_array[] = $row;
            }
        }
        return $result_array;
    }

◆ getQuestiontype()

ilObjSurveyQuestionPool::getQuestiontype ( int $question_id )

Returns: string|null question type string

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

     : ?string {
        $ilDB = $this->db;
        if ($question_id < 1) {
            return null;
        }
        $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 null;
        }
    }

Referenced by createQuestion().

Here is the caller graph for this function:

◆ importObject()

ilObjSurveyQuestionPool::importObject	(	string	$source,
		bool	$spl_exists = `false`
	)

Imports survey questions into ILIAS.

Parameters

string $source The filename of an XML import file

Exceptions

ilInvalidSurveyImportFileException

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

     : void {
        if (is_file($source)) {
            $isZip = (strcmp(strtolower(substr($source, -3)), 'zip') === 0);
            if ($isZip) {
                // unzip file
                $this->domain->resources()->zip()->unzipFile($source);
 
                // determine filenames of xml files
                $subdir = basename($source, ".zip");
                $source = dirname($source) . "/" . $subdir . "/" . $subdir . ".xml";
            }
 
            $fh = fopen($source, 'rb') or die("");
            $xml = fread($fh, filesize($source));
            fclose($fh) or die("");
            if ($isZip) {
                $subdir = basename($source, ".zip");
                if (is_dir(dirname($source) . "/" . $subdir)) {
                    ilFileUtils::delDir(dirname($source) . "/" . $subdir);
                }
            }
            if (strpos($xml, "questestinterop") > 0) {
                throw new ilInvalidSurveyImportFileException("Unsupported survey version (< 3.8) found.");
            }
 
            // survey questions for ILIAS >= 3.8
            $import = new SurveyImportParser($this->getId(), "", $spl_exists);
            $import->setXMLContent($xml);
            $import->startParsing();
        }
    }

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

Here is the call graph for this function:

◆ isInUse()

ilObjSurveyQuestionPool::isInUse ( int $question_id )

Checks if a question is in use by a survey.

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

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

                                             : ?array
    {
        $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 null;
        }
        $result_array = array();
        while ($row = $ilDB->fetchObject($result)) {
            $result_array[] = $row;
        }
        return $result_array;
    }

References $ilDB.

◆ loadFromDb()

ilObjSurveyQuestionPool::loadFromDb ( )

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

                                : void
    {
    }

Referenced by read().

Here is the caller graph for this function:

◆ moveToClipboard()

ilObjSurveyQuestionPool::moveToClipboard ( int $question_id )

Moves a question to the clipboard.

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

     : void {
        $this->edit_manager->addQuestionToClipboard($question_id, "move");
    }

◆ paste()

ilObjSurveyQuestionPool::paste ( int $question_id )

Pastes a duplicate of a question in the question pool.

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

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

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ pasteFromClipboard()

ilObjSurveyQuestionPool::pasteFromClipboard ( )

Copies/Moves a question from the clipboard.

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

                                        : void
    {
        $ilDB = $this->db;
 
        $qentries = $this->edit_manager->getQuestionsFromClipboard();
        if (count($qentries) > 0) {
            foreach ($qentries 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)) {
                                    ilFileUtils::makeDirParents($target_path);
                                }
                                ilFileUtils::rename($source_path, $target_path . $question_object["question_id"]);
                            }
                        } else {
                            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt("spl_move_same_pool"), true);
                            return;
                        }
                    }
                } else {
                    $this->copyQuestion($question_object["question_id"], $this->getId());
                }
            }
        }
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("spl_paste_success"), true);
        $this->edit_manager->clearClipboardQuestions();
    }

References $ilDB, CLIENT_WEB_DIR, ILIAS\Survey\Mode\getId(), ILIAS\Repository\lng(), ilFileUtils\makeDirParents(), and ilFileUtils\rename().

Here is the call graph for this function:

◆ purgeQuestions()

ilObjSurveyQuestionPool::purgeQuestions ( )

Remove all questions with tstamp = 0.

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

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

References $data, and $ilDB.

◆ read()

ilObjSurveyQuestionPool::read ( )

Reimplemented from ilObject.

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

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

References loadFromDb().

Here is the call graph for this function:

◆ removeQuestion()

ilObjSurveyQuestionPool::removeQuestion ( int $question_id )

Removes a question from the question pool.

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

                                                    : void
    {
        if ($question_id < 1) {
            return;
        }
        $question = SurveyQuestion::_instanciateQuestion($question_id);
        $question->delete($question_id);
    }

References SurveyQuestion\_instanciateQuestion().

Here is the call graph for this function:

◆ saveToDb()

ilObjSurveyQuestionPool::saveToDb ( )

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

                              : void
    {
        $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) {
            $next_id = $ilDB->nextId('svy_qpl');
            $query = $ilDB->manipulateF(
                "INSERT INTO svy_qpl (id_questionpool, obj_fi, tstamp) VALUES (%s, %s, %s)",
                array('integer', 'integer', 'integer'),
                array($next_id, $this->getId(), time())
            );
        }
    }

References $ilDB, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ setObligatoryStates()

ilObjSurveyQuestionPool::setObligatoryStates ( array $obligatory_questions )

Parameters

int[] $obligatory_questions obligatory question ids

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

     : void {
        $ilDB = $this->db;
        foreach ($this->getQuestions() as $question_id) {
            $status = (int) (isset($obligatory_questions["$question_id"]));
 
            $ilDB->manipulate("UPDATE svy_question" .
                " SET obligatory = " . $ilDB->quote($status, "integer") .
                " WHERE question_id = " . $ilDB->quote($question_id, "integer"));
        }
    }

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

Here is the call graph for this function:

◆ toXML()

ilObjSurveyQuestionPool::toXML ( ?array $questions )

export questions to xml

Todo:: move to export sub-component

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

                                            : string
    {
        if (is_null($questions) || count($questions) === 0) {
            $questions = $this->getQuestions();
        }
        $a_xml_writer = new ilXmlWriter();
        // set xml header
        $a_xml_writer->xmlHeader();
        $attrs = array(
            "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
            "xsi:noNamespaceSchemaLocation" => "https://www.ilias.de/download/xsd/ilias_survey_4_2.xsd"
        );
        $a_xml_writer->xmlStartTag("surveyobject", $attrs);
        $attrs = array(
            "id" => "qpl_" . $this->getId(),
            "label" => $this->getTitle()
        );
        $a_xml_writer->xmlStartTag("surveyquestions", $attrs);
        $a_xml_writer->xmlElement("dummy", null, "dummy");
 
        $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);
            SurveyQuestion::_includeClass($questiontype);
            $question = new $questiontype();
            $question->loadFromDb($value);
            $questionxml .= $question->toXML(false);
        }
 
        $xml = str_replace("<dummy>dummy</dummy>", $questionxml, $xml);
        return $xml;
    }

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

Here is the call graph for this function:

◆ toXmlForExport()

ilObjSurveyQuestionPool::toXmlForExport ( )

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

                                    : string
    {
        $questions = $this->getQuestions();
        $a_xml_writer = new ilXmlWriter();
        $attrs = array(
            "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
            "xsi:noNamespaceSchemaLocation" => "https://www.ilias.de/download/xsd/ilias_survey_4_2.xsd"
        );
        $a_xml_writer->xmlStartTag("surveyobject", $attrs);
        $attrs = array(
            "id" => "qpl_" . $this->getId(),
            "label" => $this->getTitle()
        );
        $a_xml_writer->xmlStartTag("surveyquestions", $attrs);
        $a_xml_writer->xmlElement("dummy", null, "dummy");
        $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);
            SurveyQuestion::_includeClass($questiontype);
            $question = new $questiontype();
            $question->loadFromDb($value);
            $questionxml .= $question->toXML(false);
        }
        $xml = str_replace("<dummy>dummy</dummy>", $questionxml, $xml);
        return $xml;
    }

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

Here is the call graph for this function:

◆ update()

ilObjSurveyQuestionPool::update ( )

Reimplemented from ilObject.

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

                            : bool
    {
        $this->updateMetaData();
        if (!parent::update()) {
            return false;
        }
        return true;
    }

References ilObject\updateMetaData().

Here is the call graph for this function:

Field Documentation

◆ $component_repository

ilComponentRepository ilObjSurveyQuestionPool::$component_repository

protected

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

◆ $domain

InternalDomainService ilObjSurveyQuestionPool::$domain

protected

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

◆ $edit_manager

EditManager ilObjSurveyQuestionPool::$edit_manager

protected

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

◆ $main_tpl

ilGlobalTemplateInterface ilObjSurveyQuestionPool::$main_tpl

private

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

◆ $online

bool ilObjSurveyQuestionPool::$online = false

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

◆ $user

ilObjUser ilObjSurveyQuestionPool::$user

protected

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

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

components/ILIAS/SurveyQuestionPool/classes/class.ilObjSurveyQuestionPool.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getAvailableQuestionpools()

◆ _getQuestionClasses()

◆ _getQuestiontypes()

◆ _getQuestionTypeTranslations()

◆ _isWriteable()

◆ _lookupOnline()

◆ cloneObject()

◆ copyQuestion()

◆ copyToClipboard()

◆ create()

◆ createExportDirectory()

◆ createImportDirectory()

◆ createQuestion()

◆ delete()

◆ deleteAllData()

◆ duplicateQuestion()

◆ getExportDirectory()

◆ getExportFiles()

◆ getImportDirectory()

◆ getQuestionInfos()

◆ getQuestions()

◆ getQuestionsData()

◆ getQuestionsInfo()

◆ getQuestiontype()

◆ importObject()

◆ isInUse()

◆ loadFromDb()

◆ moveToClipboard()

◆ paste()

◆ pasteFromClipboard()

◆ purgeQuestions()

◆ read()

◆ removeQuestion()

◆ saveToDb()

◆ setObligatoryStates()

◆ toXML()

◆ toXmlForExport()

◆ update()

Field Documentation

◆ $component_repository

◆ $domain

◆ $edit_manager

◆ $main_tpl

◆ $online

◆ $user