ILIAS\LearningSequence\Content\Condition\ConditionHandler Class Reference

Collaboration diagram for ILIAS\LearningSequence\Content\Condition\ConditionHandler:

Public Member Functions
	__construct (protected \ilDBInterface $db, protected \ilLanguage $lng, private ConditionFactory $condition_factory)
	getInputConditionsByRefId (int $lso_ref_id, int $obj_ref_id)
	getOutputConditionsByRefId (int $lso_ref_id, int $obj_ref_id)
	deleteConditionsByRefId (int $lso_ref_id, int $obj_ref_id)
	Deletes all conditions attached to an object that is being removed from the Learning Sequence, regardless of the current operation mode. More...
	deleteConditionsByLSORefId (int $lso_ref_id)
	Deletes all conditions that belong to a Learning Sequence itself. More...
	deleteCondition (int $condition_id)
	Deletes a single condition entry from lso_conditions by its condition id. More...

Protected Member Functions
	formatConditionsForGui (array $db_conditions)
	getConditionsFromDb (int $lso_ref_id, int $obj_ref_id, array $available_classes)

Detailed Description

Definition at line 23 of file class.ilObjLearningSequenceConditionHandler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LearningSequence\Content\Condition\ConditionHandler::__construct	(	protected \ilDBInterface	$db,
		protected \ilLanguage	$lng,
		private ConditionFactory	$condition_factory
	)

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

      {
    }

Member Function Documentation

deleteCondition()

ILIAS\LearningSequence\Content\Condition\ConditionHandler::deleteCondition

(

int

$condition_id

)

Deletes a single condition entry from lso_conditions by its condition id.

Parameters

int

$condition_id

id of the condition to delete

Definition at line 128 of file class.ilObjLearningSequenceConditionHandler.php.

                                                      : void
    {
        $this->db->manipulateF(
            'DELETE FROM lso_conditions WHERE condition_id = %s',
            ['integer'],
            [$condition_id]
        );
    }

Referenced by ILIAS\LearningSequence\Content\Condition\ConditionHandler\deleteConditionsByRefId().

Here is the caller graph for this function:

deleteConditionsByLSORefId()

ILIAS\LearningSequence\Content\Condition\ConditionHandler::deleteConditionsByLSORefId

(

int

$lso_ref_id

)

Deletes all conditions that belong to a Learning Sequence itself.

Besides the generic rows in lso_conditions this also clears all condition-specific payload rows from every lso_c_* table by condition_id.

Definition at line 91 of file class.ilObjLearningSequenceConditionHandler.php.

                                                               : void
    {
        $condition_ids = [];
        $res = $this->db->queryF(
            'SELECT condition_id FROM lso_conditions WHERE lso_ref_id = %s',
            ['integer'],
            [$lso_ref_id]
        );
 
        while ($row = $this->db->fetchAssoc($res)) {
            $condition_ids[] = (int) $row['condition_id'];
        }
 
        if ($condition_ids !== []) {
            foreach ($this->db->listTables() as $table) {
                if (!str_starts_with((string) $table, 'lso_c_')) {
                    continue;
                }
 
                $this->db->manipulate(
                    'DELETE FROM ' . $table . ' WHERE ' . $this->db->in('condition_id', $condition_ids, false, 'integer')
                );
            }
        }
 
        $this->db->manipulateF(
            'DELETE FROM lso_conditions WHERE lso_ref_id = %s',
            ['integer'],
            [$lso_ref_id]
        );
    }

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

Here is the call graph for this function:

deleteConditionsByRefId()

ILIAS\LearningSequence\Content\Condition\ConditionHandler::deleteConditionsByRefId	(	int	$lso_ref_id,
		int	$obj_ref_id
	)

Deletes all conditions attached to an object that is being removed from the Learning Sequence, regardless of the current operation mode.

For every condition found for the deleted object it delegates to the concrete condition instance's public delete() method, which removes both the condition-specific payload (deleteConditionData()) and the generic entry in lso_conditions. If the concrete condition can no longer be resolved, the generic lso_conditions entry is removed as a fallback.

Parameters

int	$lso_ref_id	ref_id of the Learning Sequence object
int	$obj_ref_id	ref_id of the deleted object

Definition at line 63 of file class.ilObjLearningSequenceConditionHandler.php.

                                                                             : void
    {
        $res = $this->db->queryF(
            "SELECT condition_id, type_id FROM lso_conditions WHERE lso_ref_id = %s AND obj_ref_id = %s",
            ['integer', 'integer'],
            [$lso_ref_id, $obj_ref_id]
        );
 
        while ($row = $this->db->fetchAssoc($res)) {
            $condition_id = (int) $row['condition_id'];
 
            try {
                $condition = $this->condition_factory->getConditionInstanceById($condition_id);
                $condition->delete();
            } catch (\Throwable $e) {
                // If the concrete condition can no longer be resolved we still
                // remove the generic lso_conditions entry as a fallback.
                $this->deleteCondition($condition_id);
            }
        }
    }

References Vendor\Package\$e, $res, ILIAS\LearningSequence\Content\Condition\ConditionHandler\deleteCondition(), and ILIAS\Repository\int().

Here is the call graph for this function:

formatConditionsForGui()

ILIAS\LearningSequence\Content\Condition\ConditionHandler::formatConditionsForGui ( array  $db_conditions )

protected

Parameters

array[]

$db_conditions

Returns

array[]

Definition at line 141 of file class.ilObjLearningSequenceConditionHandler.php.

                                                                   : array
    {
        $result = [];
        foreach ($db_conditions as $db_cond) {
            $type_id = $db_cond['type_id'];
            $res = $this->db->queryF(
                "SELECT condition_name FROM lso_condition_types WHERE type_id = %s",
                ['integer'],
                [$type_id]
            );
            $row = $this->db->fetchAssoc($res);
            if ($row) {
                $class = $this->condition_factory->getConditionTypes()->getConditionByName($row['condition_name']);
                if ($class) {
                    try {
                        $condition = $this->condition_factory->getConditionInstanceById((int) $db_cond['condition_id']);
                        $result[] = [
                            'title' => $this->lng->txt((string) $condition->getName()),
                            'value' => $condition instanceof SubtypeAwareInterface
                                ? $condition->getSubtypeLabel($condition->getSubtype())
                                : '',
                            'internal_name' => $row['condition_name']
                        ];
                    } catch (\Throwable $e) {
                        continue;
                    }
                }
            }
        }
        return $result;
    }

References Vendor\Package\$e, $res, ILIAS\LearningSequence\Content\Condition\SubtypeAwareInterface\getSubtypeLabel(), and ILIAS\Repository\lng().

Referenced by ILIAS\LearningSequence\Content\Condition\ConditionHandler\getInputConditionsByRefId(), and ILIAS\LearningSequence\Content\Condition\ConditionHandler\getOutputConditionsByRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

getConditionsFromDb()

ILIAS\LearningSequence\Content\Condition\ConditionHandler::getConditionsFromDb ( int  $lso_ref_id, int  $obj_ref_id, array  $available_classes  )

protected

Returns

array[]

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

                                                                                                      : array
    {
        $names = [];
        foreach ($available_classes as $class) {
            try {
                $reflection = new \ReflectionClass($class);
                if ($reflection->isInstantiable()) {
                    $names[] = AbstractCondition::getIdentifierForClass($class);
                }
            } catch (\Throwable $e) {
                continue;
            }
        }
 
        if (count($names) === 0) {
            return [];
        }
 
        $query = "SELECT c.* 
                  FROM lso_conditions c
                  INNER JOIN lso_condition_types t ON c.type_id = t.type_id
                  WHERE c.lso_ref_id = %s AND c.obj_ref_id = %s AND " . $this->db->in('t.condition_name', $names, false, 'text');
 
        $res = $this->db->queryF($query, ['integer', 'integer'], [$lso_ref_id, $obj_ref_id]);
        $result = [];
        while ($row = $this->db->fetchAssoc($res)) {
            $result[] = $row;
        }
        return $result;
    }

References Vendor\Package\$e, $res, and ILIAS\LearningSequence\Content\Condition\AbstractCondition\getIdentifierForClass().

Referenced by ILIAS\LearningSequence\Content\Condition\ConditionHandler\getInputConditionsByRefId(), and ILIAS\LearningSequence\Content\Condition\ConditionHandler\getOutputConditionsByRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

getInputConditionsByRefId()

ILIAS\LearningSequence\Content\Condition\ConditionHandler::getInputConditionsByRefId	(	int	$lso_ref_id,
		int	$obj_ref_id
	)

Returns

array[]

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

                                                                               : array
    {
        $db_conditions = $this->getConditionsFromDb($lso_ref_id, $obj_ref_id, $this->condition_factory->getConditionTypes()->getAllInputConditions());
        return $this->formatConditionsForGui($db_conditions);
    }

References ILIAS\LearningSequence\Content\Condition\ConditionHandler\formatConditionsForGui(), and ILIAS\LearningSequence\Content\Condition\ConditionHandler\getConditionsFromDb().

Here is the call graph for this function:

getOutputConditionsByRefId()

ILIAS\LearningSequence\Content\Condition\ConditionHandler::getOutputConditionsByRefId	(	int	$lso_ref_id,
		int	$obj_ref_id
	)

Returns

array[]

Definition at line 44 of file class.ilObjLearningSequenceConditionHandler.php.

                                                                                : array
    {
        $db_conditions = $this->getConditionsFromDb($lso_ref_id, $obj_ref_id, $this->condition_factory->getConditionTypes()->getAllOutputConditions());
        return $this->formatConditionsForGui($db_conditions);
    }

References ILIAS\LearningSequence\Content\Condition\ConditionHandler\formatConditionsForGui(), and ILIAS\LearningSequence\Content\Condition\ConditionHandler\getConditionsFromDb().

Here is the call graph for this function:

---

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

• components/ILIAS/LearningSequence/classes/Content/Condition/class.ilObjLearningSequenceConditionHandler.php