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 25 of file class.ilLPCollection.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in ilLPCollectionOfRepositoryObjects.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ activateEntries()

ilLPCollection::activateEntries ( array $a_item_ids )

Parameters

int[] $a_item_ids

Reimplemented in ilLPCollectionOfRepositoryObjects.

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

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

◆ addEntry()

ilLPCollection::addEntry ( int $a_item_id )

protected

Reimplemented in ilLPCollectionOfRepositoryObjects.

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

                                               : 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;
    }

◆ cloneCollection()

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

Reimplemented in ilLPCollectionOfRepositoryObjects, and ilLPCollectionOfSCOs.

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

                                                                     : 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.');
    }

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

Here is the call graph for this function:

◆ deactivateEntries()

ilLPCollection::deactivateEntries ( array $a_item_ids )

Parameters

int[] $a_item_ids

Reimplemented in ilLPCollectionOfRepositoryObjects.

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

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

◆ delete()

ilLPCollection::delete ( )

Definition at line 141 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

Reimplemented in ilLPCollectionOfRepositoryObjects.

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

                                                  : 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;
    }

◆ getCollectionModes()

static ilLPCollection::getCollectionModes ( )

static

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

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

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.

◆ getInstanceByMode()

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

static

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

     : ?ilLPCollection {
        $path = "components/ILIAS/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;
    }

References 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().

Here is the caller graph for this function:

◆ getItems()

ilLPCollection::getItems ( )

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

                              : array
    {
        return $this->items;
    }

◆ hasSelectableItems()

ilLPCollection::hasSelectableItems ( )

Reimplemented in ilLPCollectionOfObjectives.

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

                                        : bool
    {
        return true;
    }

◆ isAssignedEntry()

ilLPCollection::isAssignedEntry ( int $a_item_id )

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

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

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

Here is the caller graph for this function:

◆ read()

ilLPCollection::read ( int $a_obj_id )

protected

Reimplemented in ilLPCollectionOfObjectives, and ilLPCollectionOfRepositoryObjects.

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

                                          : 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;
    }

References $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __construct().

Here is the caller graph for this function:

◆ validateEntry()

ilLPCollection::validateEntry ( int $a_item_id )

protected

Reimplemented in ilLPCollectionOfRepositoryObjects.

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

                                                    : bool
    {
        return true;
    }

Field Documentation

◆ $db

ilDBInterface ilLPCollection::$db

protected

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

◆ $items

array ilLPCollection::$items = []

protected

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

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

◆ $logger

ilLogger ilLPCollection::$logger

protected

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

◆ $mode

int ilLPCollection::$mode

protected

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

Referenced by ilLPCollectionOfMediaObjects\cloneCollection().

◆ $obj_id

int ilLPCollection::$obj_id

protected

Definition at line 27 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:

components/ILIAS/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