Stores start and end object boundaries of adaptive learning sequences. More...

Collaboration diagram for ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries:

Public Member Functions
	__construct (ilDBInterface $db)
	Creates the boundary repository. More...

	getBoundariesFor (int $lso_obj_id)
	Gets the start and end boundaries of a learning sequence. More...

	setStartRefId (int $lso_obj_id, int $start_ref_id)
	Sets the start object reference ID of a learning sequence. More...

	setEndRefId (int $lso_obj_id, int $end_ref_id)
	Sets the end object reference ID of a learning sequence. More...

	unsetStartRefId (int $lso_obj_id)
	Removes the start object reference ID of a learning sequence. More...

	unsetEndRefId (int $lso_obj_id)
	Removes the end object reference ID of a learning sequence. More...

	removeRefIdFromBoundaries (int $lso_obj_id, int $ref_id)
	Removes a given ref_id from the boundaries of an LSO if it is currently stored as the start and/or end object. More...

Data Fields
const string	TABLE_NAME = 'lso_item_boundaries'

Protected Member Functions
	cleanupIfEmpty (int $lso_obj_id)
	Removes an empty boundary record. More...

Protected Attributes
ilDBInterface	$db
	Database connection. More...

Detailed Description

Stores start and end object boundaries of adaptive learning sequences.

Definition at line 28 of file LSOAdaptiveBoundaries.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::__construct ( ilDBInterface $db )

Creates the boundary repository.

Definition at line 40 of file LSOAdaptiveBoundaries.php.

    {
        $this->db = $db;
    }

References ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\$db.

Member Function Documentation

◆ cleanupIfEmpty()

ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::cleanupIfEmpty ( int $lso_obj_id )

protected

Removes an empty boundary record.

Definition at line 170 of file LSOAdaptiveBoundaries.php.

                                                      : void
    {
        $boundaries = $this->getBoundariesFor($lso_obj_id);
        if ($boundaries['start_ref_id'] === 0 && $boundaries['end_ref_id'] === 0) {
            $this->db->manipulate("DELETE FROM " . self::TABLE_NAME . " WHERE obj_id = " . $this->db->quote($lso_obj_id, 'integer'));
        }
    }

References ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\getBoundariesFor().

Referenced by ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\unsetEndRefId(), and ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\unsetStartRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBoundariesFor()

ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::getBoundariesFor ( int $lso_obj_id )

Gets the start and end boundaries of a learning sequence.

Returns: array{start_ref_id: int, end_ref_id: int}

Definition at line 50 of file LSOAdaptiveBoundaries.php.

                                                     : array
    {
        $query = "SELECT start_ref_id, end_ref_id FROM " . self::TABLE_NAME . " WHERE obj_id = " . $this->db->quote($lso_obj_id, 'integer');
        $res = $this->db->query($query);
        $row = $this->db->fetchAssoc($res);
        if ($row) {
            return [
                'start_ref_id' => (int) ($row['start_ref_id'] ?? 0),
                'end_ref_id' => (int) ($row['end_ref_id'] ?? 0)
            ];
        }
        return ['start_ref_id' => 0, 'end_ref_id' => 0];
    }

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

Referenced by ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\cleanupIfEmpty(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\removeRefIdFromBoundaries(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\setEndRefId(), and ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\setStartRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeRefIdFromBoundaries()

ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::removeRefIdFromBoundaries	(	int	$lso_obj_id,
		int	$ref_id
	)

Removes a given ref_id from the boundaries of an LSO if it is currently stored as the start and/or end object.

Only the affected field(s) are cleared - not the whole row (unless it becomes empty, in which case {

See also: self::cleanupIfEmpty()} removes it). This is used when an object is deleted from the learning sequence so that a dangling start/end reference does not remain in the database.

Parameters

int	$lso_obj_id	obj_id of the learning sequence
int	$ref_id	ref_id of the deleted object

Returns: bool true if a boundary field was actually changed

Definition at line 145 of file LSOAdaptiveBoundaries.php.

                                                                           : bool
    {
        if ($ref_id <= 0) {
            return false;
        }
 
        $boundaries = $this->getBoundariesFor($lso_obj_id);
        $changed = false;
 
        if ($boundaries['start_ref_id'] === $ref_id) {
            $this->unsetStartRefId($lso_obj_id);
            $changed = true;
        }
 
        if ($boundaries['end_ref_id'] === $ref_id) {
            $this->unsetEndRefId($lso_obj_id);
            $changed = true;
        }
 
        return $changed;
    }

References ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\getBoundariesFor(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\unsetEndRefId(), and ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\unsetStartRefId().

Here is the call graph for this function:

◆ setEndRefId()

ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::setEndRefId	(	int	$lso_obj_id,
		int	$end_ref_id
	)

Sets the end object reference ID of a learning sequence.

Definition at line 88 of file LSOAdaptiveBoundaries.php.

                                                                 : void
    {
        $boundaries = $this->getBoundariesFor($lso_obj_id);
        if ($boundaries['start_ref_id'] === 0 && $boundaries['end_ref_id'] === 0) {
            $this->db->insert(self::TABLE_NAME, [
                'obj_id' => ['integer', $lso_obj_id],
                'start_ref_id' => ['integer', null],
                'end_ref_id' => ['integer', $end_ref_id]
            ]);
        } else {
            $this->db->update(
                self::TABLE_NAME,
                ['end_ref_id' => ['integer', $end_ref_id]],
                ['obj_id' => ['integer', $lso_obj_id]]
            );
        }
    }

References ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\getBoundariesFor().

Here is the call graph for this function:

◆ setStartRefId()

ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::setStartRefId	(	int	$lso_obj_id,
		int	$start_ref_id
	)

Sets the start object reference ID of a learning sequence.

Definition at line 67 of file LSOAdaptiveBoundaries.php.

                                                                     : void
    {
        $boundaries = $this->getBoundariesFor($lso_obj_id);
        if ($boundaries['start_ref_id'] === 0 && $boundaries['end_ref_id'] === 0) {
            $this->db->insert(self::TABLE_NAME, [
                'obj_id' => ['integer', $lso_obj_id],
                'start_ref_id' => ['integer', $start_ref_id],
                'end_ref_id' => ['integer', null]
            ]);
        } else {
            $this->db->update(
                self::TABLE_NAME,
                ['start_ref_id' => ['integer', $start_ref_id]],
                ['obj_id' => ['integer', $lso_obj_id]]
            );
        }
    }

References ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\getBoundariesFor().

Here is the call graph for this function:

◆ unsetEndRefId()

ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::unsetEndRefId ( int $lso_obj_id )

Removes the end object reference ID of a learning sequence.

Definition at line 122 of file LSOAdaptiveBoundaries.php.

                                                  : void
    {
        $this->db->update(
            self::TABLE_NAME,
            ['end_ref_id' => ['integer', null]],
            ['obj_id' => ['integer', $lso_obj_id]]
        );
        $this->cleanupIfEmpty($lso_obj_id);
    }

References ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\cleanupIfEmpty().

Referenced by ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\removeRefIdFromBoundaries().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unsetStartRefId()

ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::unsetStartRefId ( int $lso_obj_id )

Removes the start object reference ID of a learning sequence.

Definition at line 109 of file LSOAdaptiveBoundaries.php.

                                                    : void
    {
        $this->db->update(
            self::TABLE_NAME,
            ['start_ref_id' => ['integer', null]],
            ['obj_id' => ['integer', $lso_obj_id]]
        );
        $this->cleanupIfEmpty($lso_obj_id);
    }

References ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\cleanupIfEmpty().

Referenced by ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\removeRefIdFromBoundaries().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db

ilDBInterface ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::$db

protected

Database connection.

Definition at line 35 of file LSOAdaptiveBoundaries.php.

Referenced by ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries\__construct().

◆ TABLE_NAME

const string ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveBoundaries::TABLE_NAME = 'lso_item_boundaries'

Definition at line 30 of file LSOAdaptiveBoundaries.php.

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

components/ILIAS/LearningSequence/classes/Content/Adaptive/LSOAdaptiveBoundaries.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cleanupIfEmpty()

◆ getBoundariesFor()

◆ removeRefIdFromBoundaries()

◆ setEndRefId()

◆ setStartRefId()

◆ unsetEndRefId()

◆ unsetStartRefId()

Field Documentation

◆ $db

◆ TABLE_NAME