ilIndividualAssessmentDataSet Class Reference

Individual Assessment dataset class. More...

Inheritance diagram for ilIndividualAssessmentDataSet:

Collaboration diagram for ilIndividualAssessmentDataSet:

Public Member Functions
	getSupportedVersions ()
	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from Cache for a given entity and ID(s) More...
	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Import record. More...
Public Member Functions inherited from ilDataSet
	__construct ()
	init (string $a_entity, string $a_schema_version)
	Init. More...
	getSupportedVersions ()
	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...
	setExportDirectories (string $a_relative, string $a_absolute)
	setImportDirectory (string $a_val)
	getImportDirectory ()
	setDSPrefix (string $a_val)
	getDSPrefix ()
	getDSPrefixString ()
	getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...
	convertToLeadingUpper (string $a_str)
	Make xyz_abc a XyzAbc string. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ... More...
	addRecordsXml (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")
	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)
	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)
	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...
	getXmlTypes (string $a_entity, string $a_version)
	Get xml types. More...
	getXMLEntityName (string $a_entity, string $a_version)
	Get entity name for xml (may be overwritten) More...
	getXMLEntityTag (string $a_entity, string $a_schema_version)
	Get entity tag. More...
	setImport (ilSurveyImporter $a_val)
	getImport ()
	setCurrentInstallationId (string $a_val)
	getCurrentInstallationId ()
	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)
	getTypes (string $a_entity, string $a_version)
	Map XML attributes of entities to data types (text, integer...) More...
	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	Return dependencies form entities to other entities (in our case these are all the DB relations) More...
	_readData (string $entity, array $ids)
	Build data array, data is read from cache except iass object itself. More...
Protected Member Functions inherited from ilDataSet
	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...
	getXmlNamespace (string $a_entity, string $a_schema_version)
	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	createObjectExportId (string $a_type, string $a_id)
	Build ilias export id. More...
	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...
	stripTags (array $rec, array $omit_keys=[])

Additional Inherited Members
Data Fields inherited from ilDataSet
const	EXPORT_NO_INST_ID = 1
const	EXPORT_ID_ILIAS_LOCAL = 2
const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3
const	EXPORT_ID_ILIAS_REMOTE = 4
const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5
const	EXPORT_ID = 6
const	EXPORT_ID_INVALID = 7
int	$dircnt = 0
Protected Attributes inherited from ilDataSet
string	$current_installation_id = ""
array	$data = []
ilDBInterface	$db
ilLogger	$ds_log
string	$import_directory = ""
string	$entity = ""
string	$schema_version = ""
string	$relative_export_dir = ""
string	$absolute_export_dir = ""
string	$ds_prefix = "ds"
string	$version = ""
ilSurveyImporter	$import

Detailed Description

Individual Assessment dataset class.

Definition at line 24 of file class.ilIndividualAssessmentDataSet.php.

Member Function Documentation

_readData()

ilIndividualAssessmentDataSet::_readData ( string  $entity, array  $ids  )

protected

Build data array, data is read from cache except iass object itself.

Definition at line 86 of file class.ilIndividualAssessmentDataSet.php.

References ilDataSet\$data, ILIAS\LTI\ToolProvider\$settings, ilObject\_lookupType(), and ILIAS\Repository\int().

Referenced by readData().

                                                            : void
    {
        switch ($entity) {
            case 'iass':
                foreach ($ids as $iass_id) {
                    $iass_id = (int) $iass_id;
                    if (ilObject::_lookupType($iass_id) == 'iass') {
                        $obj = new ilObjIndividualAssessment($iass_id, false);
                        $settings = $obj->getSettings();
                        $info = $obj->getInfoSettings();
                        $data = array(
                            'id' => $iass_id,
                            'title' => $obj->getTitle(),
                            'description' => $obj->getDescription(),
                            'content' => $settings->getContent(),
                            'recordTemplate' => $settings->getRecordTemplate(),
                            'eventTimePlaceRequired' => (int) $settings->isEventTimePlaceRequired(),
                            'file_required' => (int) $settings->isFileRequired(),
                            "contact" => $info->getContact(),
                            "responsibility" => $info->getResponsibility(),
                            "phone" => $info->getPhone(),
                            "mails" => $info->getMails(),
                            "consultation_hours" => $info->getConsultationHours()
                        );
                        $this->data[] = $data;
                    }
                }
                break;
            default:
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDependencies()

ilIndividualAssessmentDataSet::getDependencies ( string  $a_entity, string  $a_version, ?array  $a_rec = null, ?array  $a_ids = null  )

protected

Return dependencies form entities to other entities (in our case these are all the DB relations)

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

     : array {
        return [];
    }

getSupportedVersions()

ilIndividualAssessmentDataSet::getSupportedVersions

(

)

Definition at line 26 of file class.ilIndividualAssessmentDataSet.php.

                                          : array
    {
        return ['5.2.0', '5.3.0'];
    }

getTypes()

ilIndividualAssessmentDataSet::getTypes ( string  $a_entity, string  $a_version  )

protected

Map XML attributes of entities to data types (text, integer...)

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

Referenced by ilIndividualAssessmentDataSetWrapper\getTypesWrapper().

                                                                    : array
    {
        switch ($a_entity) {
            case 'iass':
                return array(
                    "id" => "integer",
                    "title" => "text",
                    "description" => "text",
                    "content" => "text",
                    "recordTemplate" => "text",
                    "eventTimePlaceRequired" => "integer",
                    "file_required" => "integer",
                    "contact" => "text",
                    "responsibility" => "text",
                    "phone" => "text",
                    "mails" => "text",
                    "consultation_hours" => "text"
                );
            default:
                return array();
        }
    }

Here is the caller graph for this function:

getXmlNamespace()

ilIndividualAssessmentDataSet::getXmlNamespace ( string  $a_entity, string  $a_schema_version  )

protected

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

Referenced by ilIndividualAssessmentDataSetWrapper\getXmlNamespaceWrapper().

                                                                                  : string
    {
        return 'http://www.ilias.de/xml/Modules/IndividualAssessment/' . $a_entity;
    }

Here is the caller graph for this function:

importRecord()

ilIndividualAssessmentDataSet::importRecord	(	string	$a_entity,
		array	$a_types,
		array	$a_rec,
		ilImportMapping	$a_mapping,
		string	$a_schema_version
	)

Import record.

Definition at line 121 of file class.ilIndividualAssessmentDataSet.php.

References ILIAS\LTI\ToolProvider\$settings, ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), and ilImportMapping\getMapping().

     : void {
        if ($a_entity == "iass") {
            if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['id'])) {
                $newObj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
            } else {
                $newObj = new ilObjIndividualAssessment();
                $newObj->create();
            }

            $newObj->setTitle($a_rec["title"]);
            $newObj->setDescription($a_rec["description"]);

            $settings = new ilIndividualAssessmentSettings(
                $newObj->getId(),
                $newObj->getTitle(),
                $newObj->getDescription(),
                $a_rec["content"],
                $a_rec["recordTemplate"],
                $a_rec['eventTimePlaceRequired'] == 1,
                $a_rec['file_required'] == 1
            );

            $info = new ilIndividualAssessmentInfoSettings(
                $newObj->getId(),
                $a_rec['contact'],
                $a_rec['responsibility'],
                $a_rec['phone'],
                $a_rec['mails'],
                $a_rec['consultation_hours']
            );

            $newObj->setSettings($settings);
            $newObj->setInfoSettings($info);
            $newObj->update();
            $newObj->updateInfo();
            $a_mapping->addMapping("Modules/IndividualAssessment", "iass", $a_rec["id"], (string) $newObj->getId());
        }
    }

Here is the call graph for this function:

readData()

ilIndividualAssessmentDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

Read data from Cache for a given entity and ID(s)

Definition at line 77 of file class.ilIndividualAssessmentDataSet.php.

References _readData().

                                                                               : void
    {
        $this->data = array();
        $this->_readData($a_entity, $a_ids);
    }

Here is the call graph for this function:

---

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

• Modules/IndividualAssessment/classes/class.ilIndividualAssessmentDataSet.php