class ilCourseObjectiveMaterials More...

Collaboration diagram for ilCourseObjectiveMaterials:

Public Member Functions
	__construct (int $a_objective_id=0)

	cloneDependencies (int $a_new_objective, int $a_copy_id)

	getMaterials ()

	getChapters ()

	getLM (int $lm_id)

	getObjectiveId ()

	setLMRefId (int $a_ref_id)

	getLMRefId ()

	setLMObjId (int $a_obj_id)

	getLMObjId ()

	setType (string $a_type)

	getType ()

	isAssigned (int $a_ref_id, bool $a_get_id=false)

	isChapterAssigned (int $a_ref_id, int $a_obj_id)

	checkExists ()

	add ()

	deleteMaterial (int $ref_id, int $obj_id)

	isMaterialAssigned (int $ref_id, int $obj_id)

	delete (int $lm_id)

	deleteAll ()

	writePosition (int $a_ass_id, int $a_position)

	__read ()

	toXml (ilXmlWriter $writer)

Static Public Member Functions
static	_getAssignedMaterials (int $a_objective_id)

static	_getAssignableMaterials (int $a_container_id)
	Get an array of course material ids that can be assigned to learning objectives No tst, fold and grp. More...

static	_getAllAssignedMaterials (int $a_container_id)

Protected Attributes
ilLogger	$logger

ilDBInterface	$db

ilObjectDataCache	$objectDataCache

ilTree	$tree

Private Attributes
int	$objective_id = 0

array	$lms = []

int	$lm_ref_id = 0

int	$lm_obj_id = 0

string	$type = ''

Detailed Description

class ilCourseObjectiveMaterials

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 25 of file class.ilCourseObjectiveMaterials.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseObjectiveMaterials::__construct ( int $a_objective_id = 0 )

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

References $DIC, __read(), ILIAS\Repository\logger(), and ILIAS\Repository\objectDataCache().

     {
         global $DIC;
 
         $this->objectDataCache = $DIC['ilObjDataCache'];
         $this->tree = $DIC->repositoryTree();
         $this->db = $DIC->database();
         $this->objective_id = $a_objective_id;
         $this->logger = $DIC->logger()->crs();
         $this->__read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __read()

ilCourseObjectiveMaterials::__read ( )

Definition at line 346 of file class.ilCourseObjectiveMaterials.php.

References $res, ilLMObject\_exists(), ilObject\_getAllReferences(), ilCourseObjective\_lookupContainerIdByObjectiveId(), ilDBConstants\FETCHMODE_OBJECT, getObjectiveId(), and ILIAS\Repository\int().

Referenced by __construct().

                             : bool
     {
         $container_ref_ids = ilObject::_getAllReferences(ilCourseObjective::_lookupContainerIdByObjectiveId($this->objective_id));
         $container_ref_id = current($container_ref_ids);
 
         $this->lms = array();
         $query = "SELECT position,lm_ass_id,lm.ref_id,lm.obj_id,lm.type FROM crs_objective_lm lm " .
             "JOIN object_reference obr ON lm.ref_id = obr.ref_id " .
             "JOIN object_data obd ON obr.obj_id = obd.obj_id " .
             "LEFT JOIN lm_data lmd ON lmd.obj_id = lm.obj_id " .
             "WHERE objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " " .
             "ORDER BY position,obd.title,lmd.title";
 
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if (
                 !$this->tree->isInTree((int) $row->ref_id) ||
                 !$this->tree->isGrandChild($container_ref_id, (int) $row->ref_id)
             ) {
                 $this->delete((int) $row->lm_ass_id);
                 continue;
             }
             if (
                 $row->obj_id > 0 &&
                 ($row->type == 'pg' || $row->type == 'st') &&
                 !ilLMObject::_exists((int) $row->obj_id)
             ) {
                 continue;
             }
             $lm['ref_id'] = (int) $row->ref_id;
             $lm['obj_id'] = (int) $row->obj_id;
             $lm['type'] = (string) $row->type;
             $lm['lm_ass_id'] = (int) $row->lm_ass_id;
             $lm['position'] = (int) $row->position;
             $this->lms[(int) $row->lm_ass_id] = $lm;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAllAssignedMaterials()

static ilCourseObjectiveMaterials::_getAllAssignedMaterials ( int $a_container_id )

static

Returns: int[]

Definition at line 151 of file class.ilCourseObjectiveMaterials.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

                                                                         : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = "SELECT DISTINCT(com.ref_id) ref_id FROM crs_objectives co " .
             "JOIN crs_objective_lm com ON co.objective_id = com.objective_id " .
             "JOIN object_reference obr ON com.ref_id = obr.ref_id " .
             "JOIN object_data obd ON obr.obj_id = obd.obj_id " .
             "WHERE co.crs_id = " . $ilDB->quote($a_container_id, 'integer') . " " .
             "ORDER BY obd.title ";
 
         $res = $ilDB->query($query);
         $ref_ids = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $ref_ids[] = (int) $row->ref_id;
         }
         return $ref_ids;
     }

Here is the call graph for this function:

◆ _getAssignableMaterials()

static ilCourseObjectiveMaterials::_getAssignableMaterials ( int $a_container_id )

static

Get an array of course material ids that can be assigned to learning objectives No tst, fold and grp.

Definition at line 112 of file class.ilCourseObjectiveMaterials.php.

References $DIC, ilObject\_lookupObjId(), ilLOTestAssignments\getInstance(), ilTree\getNodeData(), ilTree\getSubTree(), ilArrayUtil\sortArray(), and ilLOSettings\TYPE_TEST_UNDEFINED.

Referenced by ilCourseObjectivesGUI\materialAssignment().

                                                                        : array
     {
         global $DIC;
 
         $tree = $DIC->repositoryTree();
         $container_obj_id = ilObject::_lookupObjId($a_container_id);
 
         $all_materials = $tree->getSubTree($tree->getNodeData($a_container_id), true);
         $all_materials = ilArrayUtil::sortArray($all_materials, 'title', 'asc');
 
         // Filter
         $assignable = [];
         foreach ($all_materials as $material) {
             switch ($material['type']) {
                 case 'tst':
                     $type = ilLOTestAssignments::getInstance($container_obj_id)->getTypeByTest($material['child']);
                     if ($type != ilLOSettings::TYPE_TEST_UNDEFINED) {
                         break;
                     }
 
                     $assignable[] = $material;
                     break;
 
                 case 'crs':
                 case 'rolf':
                 case 'itgr':
                     break;
 
                 default:
                     $assignable[] = $material;
                     break;
             }
         }
         return $assignable;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAssignedMaterials()

static ilCourseObjectiveMaterials::_getAssignedMaterials ( int $a_objective_id )

static

Returns: int[]

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

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilObjectActivation\getItemsByObjective().

                                                                      : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = "SELECT DISTINCT(ref_id) ref_id FROM crs_objective_lm " .
             "WHERE objective_id = " . $ilDB->quote($a_objective_id, 'integer');
         $res = $ilDB->query($query);
         $ref_ids = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $ref_ids[] = (int) $row->ref_id;
         }
         return $ref_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add()

ilCourseObjectiveMaterials::add ( )

Definition at line 282 of file class.ilCourseObjectiveMaterials.php.

References $res, getLMObjId(), getLMRefId(), getObjectiveId(), and getType().

                          : int
     {
         $next_id = $this->db->nextId('crs_objective_lm');
         $query = "INSERT INTO crs_objective_lm (lm_ass_id,objective_id,ref_id,obj_id,type) " .
             "VALUES( " .
             $this->db->quote($next_id, 'integer') . ", " .
             $this->db->quote($this->getObjectiveId(), 'integer') . ", " .
             $this->db->quote($this->getLMRefId(), 'integer') . ", " .
             $this->db->quote($this->getLMObjId(), 'integer') . ", " .
             $this->db->quote($this->getType(), 'text') .
             ")";
         $res = $this->db->manipulate($query);
         return $next_id;
     }

Here is the call graph for this function:

◆ checkExists()

ilCourseObjectiveMaterials::checkExists ( )

Definition at line 265 of file class.ilCourseObjectiveMaterials.php.

References $res, getLMObjId(), getLMRefId(), and getObjectiveId().

                                  : bool
     {
         if ($this->getLMObjId()) {
             $query = "SELECT * FROM crs_objective_lm " .
                 "WHERE objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " " .
                 "AND ref_id = " . $this->db->quote($this->getLMRefId(), 'integer') . " " .
                 "AND obj_id = " . $this->db->quote($this->getLMObjId(), 'integer') . " ";
         } else {
             $query = "SELECT * FROM crs_objective_lm " .
                 "WHERE objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " " .
                 "AND ref_id = " . $this->db->quote($this->getLMRefId(), 'integer') . " ";
         }
 
         $res = $this->db->query($query);
         return (bool) $res->numRows();
     }

Here is the call graph for this function:

◆ cloneDependencies()

ilCourseObjectiveMaterials::cloneDependencies	(	int	$a_new_objective,
		int	$a_copy_id
	)

Definition at line 50 of file class.ilCourseObjectiveMaterials.php.

References ilCopyWizardOptions\_getInstance(), getMaterials(), ILIAS\Repository\int(), ILIAS\Repository\logger(), and ILIAS\Repository\objectDataCache().

                                                                            : void
     {
         $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
         $mappings = $cwo->getMappings();
         foreach ($this->getMaterials() as $material) {
             // Copy action omit ?
             if (!isset($mappings[$material['ref_id']]) || !$mappings[$material['ref_id']]) {
                 continue;
             }
             $material_ref_id = (int) $material['ref_id'];
             $material_rbac_obj_id = $this->objectDataCache->lookupObjId($material_ref_id);
             $material_obj_id = $material['obj_id'];
             $new_ref_id = (int) $mappings[$material_ref_id];
             $new_rbac_obj_id = $this->objectDataCache->lookupObjId($new_ref_id);
 
             if ($new_rbac_obj_id === $material_rbac_obj_id) {
                 $this->logger->debug('Material has been linked. Keeping object id.');
                 $new_obj_id = $material_obj_id;
             } elseif ($material['type'] == 'st' || $material['type'] == 'pg') {
                 // Chapter assignment
                 $new_material_info = $mappings[$material_ref_id . '_' . $material_obj_id] ?? '';
                 $new_material_arr = explode('_', $new_material_info);
                 if (!isset($new_material_arr[1]) || !$new_material_arr[1]) {
                     $this->logger->debug(': No mapping found for chapter: ' . $material_obj_id);
                     continue;
                 }
                 $new_obj_id = $new_material_arr[1];
                 $this->logger->debug('New material id is: ' . $new_obj_id);
             } else {
                 $new_obj_id = $this->objectDataCache->lookupObjId((int) $mappings[$material_ref_id]);
             }
 
             $new_material = new ilCourseObjectiveMaterials($a_new_objective);
             $new_material->setLMRefId($new_ref_id);
             $new_material->setLMObjId($new_obj_id);
             $new_material->setType($material['type']);
             $new_material->add();
         }
     }

Here is the call graph for this function:

◆ delete()

ilCourseObjectiveMaterials::delete ( int $lm_id )

Definition at line 317 of file class.ilCourseObjectiveMaterials.php.

References $res.

                                       : bool
     {
         if (!$lm_id) {
             return false;
         }
 
         $query = "DELETE FROM crs_objective_lm " .
             "WHERE lm_ass_id = " . $this->db->quote($lm_id, 'integer') . " ";
         $res = $this->db->manipulate($query);
         return true;
     }

◆ deleteAll()

ilCourseObjectiveMaterials::deleteAll ( )

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

References $res, and getObjectiveId().

                                : bool
     {
         $query = "DELETE FROM crs_objective_lm " .
             "WHERE objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " ";
         $res = $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

◆ deleteMaterial()

ilCourseObjectiveMaterials::deleteMaterial	(	int	$ref_id,
		int	$obj_id
	)

Definition at line 297 of file class.ilCourseObjectiveMaterials.php.

References getObjectiveId().

                                                             : bool
     {
         $query = "DELETE FROM crs_objective_lm " .
             "WHERE objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " " .
             "AND ref_id = " . $this->db->quote($ref_id, 'integer') . " " .
             "AND obj_id = " . $this->db->quote($obj_id, 'integer');
         $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

◆ getChapters()

ilCourseObjectiveMaterials::getChapters ( )

Definition at line 176 of file class.ilCourseObjectiveMaterials.php.

                                  : array
     {
         $chapters = [];
         foreach ($this->lms as $lm_data) {
             if ($lm_data['type'] == 'st') {
                 $chapters[] = $lm_data;
             }
             if ($lm_data['type'] == 'pg') {
                 $chapters[] = $lm_data;
             }
         }
         return $chapters;
     }

◆ getLM()

ilCourseObjectiveMaterials::getLM ( int $lm_id )

Definition at line 190 of file class.ilCourseObjectiveMaterials.php.

                                      : array
     {
         if ($this->lms[$lm_id]) {
             return $this->lms[$lm_id];
         } else {
             return [];
         }
     }

◆ getLMObjId()

ilCourseObjectiveMaterials::getLMObjId ( )

Definition at line 219 of file class.ilCourseObjectiveMaterials.php.

References $lm_obj_id.

Referenced by add(), and checkExists().

                                 : int
     {
         return $this->lm_obj_id;
     }

Here is the caller graph for this function:

◆ getLMRefId()

ilCourseObjectiveMaterials::getLMRefId ( )

Definition at line 209 of file class.ilCourseObjectiveMaterials.php.

References $lm_ref_id.

Referenced by add(), and checkExists().

                                 : int
     {
         return $this->lm_ref_id;
     }

Here is the caller graph for this function:

◆ getMaterials()

ilCourseObjectiveMaterials::getMaterials ( )

Definition at line 171 of file class.ilCourseObjectiveMaterials.php.

References $lms.

Referenced by cloneDependencies(), and toXml().

                                   : array
     {
         return $this->lms;
     }

Here is the caller graph for this function:

◆ getObjectiveId()

ilCourseObjectiveMaterials::getObjectiveId ( )

Definition at line 199 of file class.ilCourseObjectiveMaterials.php.

References $objective_id.

Referenced by __read(), add(), checkExists(), deleteAll(), deleteMaterial(), isAssigned(), isChapterAssigned(), isMaterialAssigned(), and writePosition().

                                     : int
     {
         return $this->objective_id;
     }

Here is the caller graph for this function:

◆ getType()

ilCourseObjectiveMaterials::getType ( )

Definition at line 229 of file class.ilCourseObjectiveMaterials.php.

References $type.

Referenced by add().

                              : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ isAssigned()

ilCourseObjectiveMaterials::isAssigned	(	int	$a_ref_id,
		bool	$a_get_id = `false`
	)

Returns: bool|int

Definition at line 237 of file class.ilCourseObjectiveMaterials.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, and getObjectiveId().

     {
         $query = "SELECT * FROM crs_objective_lm " .
             "WHERE ref_id = " . $this->db->quote($a_ref_id, 'integer') . " " .
             "AND objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " " .
             "AND type != 'st' AND type != 'pg' ";
         $res = $this->db->query($query);
         if (!$a_get_id) {
             return (bool) $res->numRows();
         } else {
             while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                 return (int) $row->lm_ass_id;
             }
             return 0;
         }
     }

Here is the call graph for this function:

◆ isChapterAssigned()

ilCourseObjectiveMaterials::isChapterAssigned	(	int	$a_ref_id,
		int	$a_obj_id
	)

Definition at line 254 of file class.ilCourseObjectiveMaterials.php.

References $res, and getObjectiveId().

                                                                    : bool
     {
         $query = "SELECT * FROM crs_objective_lm " .
             "WHERE ref_id = " . $this->db->quote($a_ref_id, 'integer') . " " .
             "AND obj_id = " . $this->db->quote($a_obj_id, 'integer') . " " .
             "AND objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " " .
             "AND (type = 'st' OR type = 'pg')";
         $res = $this->db->query($query);
         return (bool) $res->numRows();
     }

Here is the call graph for this function:

◆ isMaterialAssigned()

ilCourseObjectiveMaterials::isMaterialAssigned	(	int	$ref_id,
		int	$obj_id
	)

Definition at line 307 of file class.ilCourseObjectiveMaterials.php.

References $res, and getObjectiveId().

                                                                 : bool
     {
         $query = "SELECT * FROM crs_objective_lm " .
             "WHERE ref_id = " . $this->db->quote($ref_id, 'integer') . " " .
             "AND obj_id = " . $this->db->quote($obj_id, 'integer') . " " .
             "AND objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " ";
         $res = $this->db->query($query);
         return (bool) $res->numRows();
     }

Here is the call graph for this function:

◆ setLMObjId()

ilCourseObjectiveMaterials::setLMObjId ( int $a_obj_id )

Definition at line 214 of file class.ilCourseObjectiveMaterials.php.

                                              : void
     {
         $this->lm_obj_id = $a_obj_id;
     }

◆ setLMRefId()

ilCourseObjectiveMaterials::setLMRefId ( int $a_ref_id )

Definition at line 204 of file class.ilCourseObjectiveMaterials.php.

                                              : void
     {
         $this->lm_ref_id = $a_ref_id;
     }

◆ setType()

ilCourseObjectiveMaterials::setType ( string $a_type )

Definition at line 224 of file class.ilCourseObjectiveMaterials.php.

                                            : void
     {
         $this->type = $a_type;
     }

◆ toXml()

ilCourseObjectiveMaterials::toXml ( ilXmlWriter $writer )

Definition at line 385 of file class.ilCourseObjectiveMaterials.php.

References getMaterials(), and ilXmlWriter\xmlElement().

                                               : bool
     {
         foreach ($this->getMaterials() as $material) {
             $writer->xmlElement(
                 'Material',
                 array(
                     'refId' => $material['ref_id'],
                     'objId' => $material['obj_id'],
                     'type' => $material['type'],
                     'position' => $material['position']
                 )
             );
         }
         return true;
     }

Here is the call graph for this function:

◆ writePosition()

ilCourseObjectiveMaterials::writePosition	(	int	$a_ass_id,
		int	$a_position
	)

Definition at line 337 of file class.ilCourseObjectiveMaterials.php.

References getObjectiveId().

                                                                  : void
     {
         $query = "UPDATE crs_objective_lm " .
             "SET position = " . $this->db->quote((string) $a_position, 'integer') . " " .
             "WHERE objective_id = " . $this->db->quote($this->getObjectiveId(), 'integer') . " " .
             "AND lm_ass_id = " . $this->db->quote($a_ass_id, "integer");
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilCourseObjectiveMaterials::$db

protected

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

◆ $lm_obj_id

int ilCourseObjectiveMaterials::$lm_obj_id = 0

private

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

Referenced by getLMObjId().

◆ $lm_ref_id

int ilCourseObjectiveMaterials::$lm_ref_id = 0

private

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

Referenced by getLMRefId().

◆ $lms

array ilCourseObjectiveMaterials::$lms = []

private

Definition at line 28 of file class.ilCourseObjectiveMaterials.php.

Referenced by getMaterials().

◆ $logger

ilLogger ilCourseObjectiveMaterials::$logger

protected

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

◆ $objectDataCache

ilObjectDataCache ilCourseObjectiveMaterials::$objectDataCache

protected

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

◆ $objective_id

int ilCourseObjectiveMaterials::$objective_id = 0

private

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

Referenced by getObjectiveId().

◆ $tree

ilTree ilCourseObjectiveMaterials::$tree

protected

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

◆ $type

string ilCourseObjectiveMaterials::$type = ''

private

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

Referenced by getType().

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

components/ILIAS/Course/classes/Objectives/class.ilCourseObjectiveMaterials.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __read()

◆ _getAllAssignedMaterials()

◆ _getAssignableMaterials()

◆ _getAssignedMaterials()

◆ add()

◆ checkExists()

◆ cloneDependencies()

◆ delete()

◆ deleteAll()

◆ deleteMaterial()

◆ getChapters()

◆ getLM()

◆ getLMObjId()

◆ getLMRefId()

◆ getMaterials()

◆ getObjectiveId()

◆ getType()

◆ isAssigned()

◆ isChapterAssigned()

◆ isMaterialAssigned()

◆ setLMObjId()

◆ setLMRefId()

◆ setType()

◆ toXml()

◆ writePosition()

Field Documentation

◆ $db

◆ $lm_obj_id

◆ $lm_ref_id

◆ $lms

◆ $logger

◆ $objectDataCache

◆ $objective_id

◆ $tree

◆ $type