LP collection base class. More...

Inheritance diagram for ilLPCollection:

Collaboration diagram for ilLPCollection:

Public Member Functions
	__construct (int $a_obj_id, int $a_mode)

	hasSelectableItems ()

	cloneCollection (int $a_target_id, int $a_copy_id)

	getItems ()

	delete ()

	isAssignedEntry (int $a_item_id)

	deactivateEntries (array $a_item_ids)

	activateEntries (array $a_item_ids)

Static Public Member Functions
static	getInstanceByMode (int $a_obj_id, int $a_mode)

static	getCollectionModes ()

Protected Member Functions
	read (int $a_obj_id)

	validateEntry (int $a_item_id)

	addEntry (int $a_item_id)

	deleteEntry (int $a_item_id)

Protected Attributes
int	$obj_id

int	$mode

array	$items = []

ilDBInterface	$db

ilLogger	$logger

Detailed Description

LP collection base class.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 11 of file class.ilLPCollection.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPCollection::__construct	(	int	$a_obj_id,
		int	$a_mode
	)

Definition at line 20 of file class.ilLPCollection.php.

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

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->logger = $DIC->logger()->trac();
 
         $this->obj_id = $a_obj_id;
         $this->mode = $a_mode;
 
         if ($a_obj_id) {
             $this->read($a_obj_id);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateEntries()

ilLPCollection::activateEntries ( array $a_item_ids )

Parameters

int[] $a_item_ids

Definition at line 194 of file class.ilLPCollection.php.

References addEntry().

                                                       : void
     {
         foreach ($a_item_ids as $item_id) {
             $this->addEntry($item_id);
         }
     }

Here is the call graph for this function:

◆ addEntry()

ilLPCollection::addEntry ( int $a_item_id )

protected

Definition at line 157 of file class.ilLPCollection.php.

References isAssignedEntry().

Referenced by activateEntries().

                                                : bool
     {
         if (!$this->isAssignedEntry($a_item_id)) {
             $query = "INSERT INTO ut_lp_collections" .
                 " (obj_id, lpmode, item_id)" .
                 " VALUES (" . $this->db->quote($this->obj_id, "integer") .
                 ", " . $this->db->quote($this->mode, "integer") .
                 ", " . $this->db->quote($a_item_id, "integer") .
                 ")";
             $this->db->manipulate($query);
             $this->items[] = $a_item_id;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneCollection()

ilLPCollection::cloneCollection	(	int	$a_target_id,
		int	$a_copy_id
	)

Definition at line 87 of file class.ilLPCollection.php.

References $mode, ilCopyWizardOptions\_getInstance(), ilObject\_lookupObjId(), and ILIAS\Repository\logger().

                                                                      : void
     {
         $target_obj_id = ilObject::_lookupObjId($a_target_id);
         $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
         $mappings = $cwo->getMappings();
 
         // #12067
         $new_collection = new static($target_obj_id, $this->mode);
         foreach ($this->items as $item) {
             if (!isset($mappings[$item]) or !$mappings[$item]) {
                 continue;
             }
 
             $new_collection->addEntry($mappings[$item]);
         }
         $this->logger->debug('cloned learning progress collection.');
     }

Here is the call graph for this function:

◆ deactivateEntries()

ilLPCollection::deactivateEntries ( array $a_item_ids )

Parameters

int[] $a_item_ids

Definition at line 184 of file class.ilLPCollection.php.

References deleteEntry().

                                                         : void
     {
         foreach ($a_item_ids as $item_id) {
             $this->deleteEntry($item_id);
         }
     }

Here is the call graph for this function:

◆ delete()

ilLPCollection::delete ( )

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

                             : void
     {
         $query = "DELETE FROM ut_lp_collections" .
             " WHERE obj_id = " . $this->db->quote($this->obj_id, "integer");
         $this->db->manipulate($query);
 
         $query = "DELETE FROM ut_lp_coll_manual" .
             " WHERE obj_id = " . $this->db->quote($this->obj_id, "integer");
         $this->db->manipulate($query);
         // #15462 - reset internal data
         $this->items = array();
     }

◆ deleteEntry()

ilLPCollection::deleteEntry ( int $a_item_id )

protected

Definition at line 172 of file class.ilLPCollection.php.

Referenced by deactivateEntries(), and read().

                                                   : bool
     {
         $query = "DELETE FROM ut_lp_collections" .
             " WHERE obj_id = " . $this->db->quote($this->obj_id, "integer") .
             " AND item_id = " . $this->db->quote($a_item_id, "integer");
         $this->db->manipulate($query);
         return true;
     }

Here is the caller graph for this function:

◆ getCollectionModes()

static ilLPCollection::getCollectionModes ( )

static

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

References ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_MOBS, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPObjSettings\LP_MODE_OBJECTIVES, and ilLPObjSettings\LP_MODE_SCORM.

Referenced by ilLPStatus\checkLPModesForObjects().

                                                : array
     {
         return array(
             ilLPObjSettings::LP_MODE_COLLECTION
             ,
             ilLPObjSettings::LP_MODE_COLLECTION_TLT
             ,
             ilLPObjSettings::LP_MODE_COLLECTION_MANUAL
             ,
             ilLPObjSettings::LP_MODE_SCORM
             ,
             ilLPObjSettings::LP_MODE_OBJECTIVES
             ,
             ilLPObjSettings::LP_MODE_COLLECTION_MOBS
         );
     }

Here is the caller graph for this function:

◆ getInstanceByMode()

static ilLPCollection::getInstanceByMode	(	int	$a_obj_id,
		int	$a_mode
	)

static

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

References $path, ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_MOBS, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPObjSettings\LP_MODE_OBJECTIVES, and ilLPObjSettings\LP_MODE_SCORM.

Referenced by ilLearningSequenceImporter\buildLPSettings(), ilObjectLP\getCollectionInstance(), ilTrackingCollectionTest\testCollectionInstance(), and ilLearningSequenceXMLWriter\writeLPSettings().

      : ?ilLPCollection {
         $path = "Services/Tracking/classes/collection/";
 
         switch ($a_mode) {
             case ilLPObjSettings::LP_MODE_COLLECTION:
             case ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR:
                 return new ilLPCollectionOfRepositoryObjects(
                     $a_obj_id,
                     $a_mode
                 );
 
             case ilLPObjSettings::LP_MODE_OBJECTIVES:
                 return new ilLPCollectionOfObjectives($a_obj_id, $a_mode);
 
             case ilLPObjSettings::LP_MODE_SCORM:
                 return new ilLPCollectionOfSCOs($a_obj_id, $a_mode);
 
             case ilLPObjSettings::LP_MODE_COLLECTION_MANUAL:
             case ilLPObjSettings::LP_MODE_COLLECTION_TLT:
                 return new ilLPCollectionOfLMChapters($a_obj_id, $a_mode);
 
             case ilLPObjSettings::LP_MODE_COLLECTION_MOBS:
                 return new ilLPCollectionOfMediaObjects($a_obj_id, $a_mode);
         }
         return null;
     }

Here is the caller graph for this function:

◆ getItems()

ilLPCollection::getItems ( )

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

References $items.

Referenced by ilLPCollectionOfRepositoryObjects\getGroupedItemsForLPStatus().

                               : array
     {
         return $this->items;
     }

Here is the caller graph for this function:

◆ hasSelectableItems()

ilLPCollection::hasSelectableItems ( )

Definition at line 82 of file class.ilLPCollection.php.

                                         : bool
     {
         return true;
     }

◆ isAssignedEntry()

ilLPCollection::isAssignedEntry ( int $a_item_id )

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

Referenced by addEntry(), ilLPCollectionOfRepositoryObjects\addEntry(), ilLPCollectionOfRepositoryObjects\getPossibleItems(), ilLPCollectionOfMediaObjects\getTableGUIData(), ilLPCollectionOfLMChapters\getTableGUIData(), ilLPCollectionOfSCOs\getTableGUIData(), and ilLPCollectionOfRepositoryObjects\parseTableGUIItem().

                                                    : bool
     {
         if (is_array($this->items)) {
             return in_array($a_item_id, $this->items);
         }
         return false;
     }

Here is the caller graph for this function:

◆ read()

ilLPCollection::read ( int $a_obj_id )

protected

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

References $items, $res, deleteEntry(), ilDBConstants\FETCHMODE_OBJECT, and validateEntry().

Referenced by __construct().

                                           : void
     {
         $items = array();
         $res = $this->db->query(
             "SELECT * FROM ut_lp_collections" .
             " WHERE obj_id = " . $this->db->quote($a_obj_id, "integer")
         );
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if ($this->validateEntry((int) $row->item_id)) {
                 $items[] = $row->item_id;
             } else {
                 $this->deleteEntry($row->item_id);
             }
         }
         $this->items = $items;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateEntry()

ilLPCollection::validateEntry ( int $a_item_id )

protected

Definition at line 144 of file class.ilLPCollection.php.

Referenced by read().

                                                     : bool
     {
         return true;
     }

Here is the caller graph for this function:

Field Documentation

◆ $db

ilDBInterface ilLPCollection::$db

protected

Definition at line 17 of file class.ilLPCollection.php.

◆ $items

array ilLPCollection::$items = []

protected

Definition at line 15 of file class.ilLPCollection.php.

Referenced by ilLPCollectionOfRepositoryObjects\getGroupedItemsForLPStatus(), getItems(), ilLPCollectionOfMediaObjects\getPossibleItems(), ilLPCollectionOfSCOs\getPossibleItems(), ilLPCollectionOfLMChapters\getPossibleItems(), ilLPCollectionOfRepositoryObjects\getTableGUIData(), ilLPCollectionOfRepositoryObjects\getTableGUItemGroup(), read(), and ilLPCollectionOfRepositoryObjects\read().

◆ $logger

ilLogger ilLPCollection::$logger

protected

Definition at line 18 of file class.ilLPCollection.php.

◆ $mode

int ilLPCollection::$mode

protected

Definition at line 14 of file class.ilLPCollection.php.

Referenced by ilLPCollectionOfMediaObjects\cloneCollection(), cloneCollection(), ilLPCollectionOfSCOs\cloneCollection(), and ilLPCollectionOfRepositoryObjects\cloneCollection().

◆ $obj_id

int ilLPCollection::$obj_id

protected

Definition at line 13 of file class.ilLPCollection.php.

Referenced by ilLPCollectionOfMediaObjects\getPossibleItems(), ilLPCollectionOfSCOs\getPossibleItems(), and ilLPCollectionOfLMChapters\getPossibleItems().

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

Services/Tracking/classes/collection/class.ilLPCollection.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateEntries()

◆ addEntry()

◆ cloneCollection()

◆ deactivateEntries()

◆ delete()

◆ deleteEntry()

◆ getCollectionModes()

◆ getInstanceByMode()

◆ getItems()

◆ hasSelectableItems()

◆ isAssignedEntry()

◆ read()

◆ validateEntry()

Field Documentation

◆ $db

◆ $items

◆ $logger

◆ $mode

◆ $obj_id