Inheritance diagram for ILIAS\LearningSequence\Content\Condition\AbstractCondition:

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

Public Member Functions
	check ()
	Checks if the condition is fulfilled. More...

	getAdditionalForm ()
	Returns the additional form for the condition. More...

	getAdditionalDisplayInformation ()
	Returns additional condition-specific information for table overviews. More...

	getValidationMessages ()

	hasValidationMessages ()

	clearValidationMessages ()

	getAdditionalDisplayObjectTitles ()
	Returns condition-specific object titles for table overviews. More...

	applyAdditionalFormData (array $data)
	Applies validated additional form data to the condition before create()/edit(). More...

	getName ()

	setSubtype (string $subtype)

	setupSteps ()
	Returns an array of steps to configure the condition. More...

	getObjRefId ()

	setObjRefId (?int $obj_ref_id)

	getLsoRefId ()

	setLsoRefId (?int $lso_ref_id)

	getConditionId ()

	setConditionId (?int $condition_id)

	setTypeId (?int $type_id)

	getTypeId ()

	create (bool $is_import=false)
	Saves the condition to the DB. More...

	edit ()
	Edits the condition. More...

	delete ()
	Deletes the condition from the database. More...

	setConditionFactory (ConditionFactory $condition_factory)
	Sets the factory which created this condition. More...

	allowMultipleConditionsOfSameType ()
	Determines whether multiple conditions of the same type are allowed for the same object. More...

	supportsDuplicateCheck ()
	Whether create() and edit() check for an identically configured condition, see isDuplicateOf(). More...

	isDuplicateOf (AbstractCondition $other)
	Determines whether this condition is configured identically to the given one. More...

	getStaticInputConditionConstraints ()
	Returns statically analyzable input-condition constraints. More...

	hasStaticInputConfigurationConflict (array $context=[])
	Allows concrete conditions to report static misconfigurations that depend on context information such as the configured start object. More...

	getStaticInputConfigurationIssues (array $context=[])
	Returns static input-configuration issues contributed by this condition. More...

	read ()
	Reads the condition data from the database and populates the properties. More...

	getData ()

	export ()

	import (array $payload, int $new_condition_id)

	setImportMapping (array $mapping)

Static Public Member Functions
static	migrate ()
	Returns an array of table definitions for the condition. More...

static	getIdentifierForClass (string $class)
	Extracts the identifier for the condition type from the class name. More...

Protected Member Functions
	addValidationMessage (string $message)

	buildUrl (string $command, bool $with_configuration_gui=false)
	Builds a URL for the given command. More...

	assertContextSet ()
	Asserts that the context (lso_ref_id and obj_ref_id) is set. More...

	createConditionData (int $condition_id)
	Hook for condition-specific payload persistence during create(). More...

	editConditionData (int $condition_id)
	Hook for condition-specific payload persistence during edit(). More...

	deleteConditionData (int $condition_id)
	Hook for condition-specific payload cleanup during delete(). More...

	assertConditionDataHookImplemented (string $hook_method)
	Ensures condition-specific payload hooks are implemented if migrate() defines extra tables. More...

	getDatabase ()
	Returns the database interface. More...

	getConditionFactory ()
	Returns the factory which created this condition. More...

	getObjectTitleByRefId (int $ref_id)

	getTypeIdFromDb ()
	Returns the type ID for this condition. More...

	conditionTypeExistsInContext (?int $type_id)

	duplicateExistsInContext (?int $type_id)
	Checks whether another condition of the same type on the same object in the same learning sequence is configured identically, see isDuplicateOf(). More...

	getStepCommand ()
	Determines the command to use for the next step based on whether configuration is required. More...

	buildStep (array $additional_parameters=[], ?string $label=null, ?string $command=null,)
	Builds a bulky link for the next step in the condition setup. More...

	requiresConfiguration ()
	Determines whether the condition requires additional configuration. More...

	referencesMissingLsoItems (array $referenced_ref_ids, array $context=[])

	getStaticInputConfigurationConflictAffectedRefIds ()

	getValidLsoRefIds (array $context=[])

	getConfiguredStartRefId (array $context=[])

	getMissingReferencedLsoRefIds (array $referenced_ref_ids, array $context=[])

	getLso ()
	Returns the learning sequence object associated with this condition. More...

	getLsoItems ()
	Returns the items of the learning sequence associated with this condition. More...

	exportPayload ()
	Default export based on migrate() table definitions. More...

	importPayload (array $payload, int $new_condition_id)
	Default import for payload exported by exportPayload(). More...

Protected Attributes
const string	NAME = ''

const string	CREATE_COMMAND = 'createCondition'

const string	CONFIGURE_COMMAND = 'configure'

ilLanguage	$lang

Container	$dic

int	$obj_ref_id = null

int	$lso_ref_id = null

int	$condition_id = null

int	$type_id = null

string	$subtype = null

Factory	$ui_factory

ConditionFactory	$condition_factory = null
	Factory which created this condition, used to resolve other conditions. More...

array	$import_mapping = []

Private Attributes
array	$validation_messages = []

Detailed Description

Definition at line 43 of file AbstractCondition.php.

Member Function Documentation

◆ addValidationMessage()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::addValidationMessage ( string $message )

protected

Definition at line 143 of file AbstractCondition.php.

                                                            : void
    {
        if ($message === '' || in_array($message, $this->validation_messages, true)) {
            return;
        }
 
        $this->validation_messages[] = $message;
    }

References $message.

Here is the caller graph for this function:

◆ allowMultipleConditionsOfSameType()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::allowMultipleConditionsOfSameType ( )

Determines whether multiple conditions of the same type are allowed for the same object.

Override this method in child classes if multiple conditions of the same type are NOT allowed.

Returns: bool

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\AlwaysOutputCondition\AlwaysOutputCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 691 of file AbstractCondition.php.

                                                       : bool
    {
        return true;
    }

Referenced by ilObjLearningSequenceConditionConfigurationGUI\checkIfConditionAlreadyExistsInItem(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\create().

Here is the caller graph for this function:

◆ applyAdditionalFormData()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::applyAdditionalFormData ( array $data )

Applies validated additional form data to the condition before create()/edit().

Parameters

array $data

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 167 of file AbstractCondition.php.

                                                        : void
    {
        // If a condition exposes an additional form it MUST implement this hook
        if (self::migrate()) {
            $method = new \ReflectionMethod(static::class, 'applyAdditionalFormData');
            if ($method->getDeclaringClass()->getName() === self::class) {
                throw new \LogicException(
                    sprintf(
                        $this->lang->txt('lso_exception_additional_form_no_override'),
                        static::class
                    )
                );
            }
        }
    }

◆ assertConditionDataHookImplemented()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::assertConditionDataHookImplemented ( string $hook_method )

protected

Ensures condition-specific payload hooks are implemented if migrate() defines extra tables.

Exceptions

ReflectionException

Definition at line 468 of file AbstractCondition.php.

                                                                              : void
    {
        if (count(static::migrate()) === 0) {
            return;
        }
 
        $method = new ReflectionMethod(static::class, $hook_method);
        if ($method->getDeclaringClass()->getName() === self::class) {
            throw new LogicException(
                sprintf(
                    "%s defines additional migration tables but does not override %s().",
                    static::class,
                    $hook_method
                )
            );
        }
    }

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\create(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\delete(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\edit().

Here is the caller graph for this function:

◆ assertContextSet()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::assertContextSet ( )

protected

Asserts that the context (lso_ref_id and obj_ref_id) is set.

Exceptions

LogicException if the context is not set

Definition at line 431 of file AbstractCondition.php.

                                         : void
    {
        if ($this->lso_ref_id === null || $this->obj_ref_id === null) {
            throw new LogicException(
                "Context not set: lso_ref_id and obj_ref_id must be set before calling this method."
            );
        }
    }

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\create(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\edit(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\setupSteps(), ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\setupSteps(), and ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition\setupSteps().

Here is the caller graph for this function:

◆ buildStep()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::buildStep	(	array	$additional_parameters = `[]`,
		?string	$label = `null`,
		?string	$command = `null`
	)

protected

Builds a bulky link for the next step in the condition setup.

Parameters

array	$additional_parameters,e.g.	subtypes
string \| null	$label
string \| null	$command,e.g.	'save' or 'configure'

Returns: Bulky

Exceptions

ilCtrlException

Definition at line 635 of file AbstractCondition.php.

     : Bulky {
        $this->dic->ctrl()->setParameterByClass(
            ilObjLearningSequenceConditionsGUI::class,
            'type_id',
            $this->getTypeId()
        );
        $this->dic->ctrl()->setParameterByClass(
            ilObjLearningSequenceConditionsGUI::class,
            'item_ref_id',
            (string) $this->obj_ref_id
        );
        $this->dic->ctrl()->setParameterByClass(
            ilObjLearningSequenceConditionsGUI::class,
            'ref_id',
            (string) $this->lso_ref_id
        );
 
        foreach ($additional_parameters as $name => $value) {
            $this->dic->ctrl()->setParameterByClass(
                ilObjLearningSequenceConditionsGUI::class,
                (string) $name,
                (string) $value
            );
        }
 
        $uri = $this->buildUrl($command ?? $this->getStepCommand());
        $this->dic->ctrl()->clearParametersByClass(ilObjLearningSequenceConditionsGUI::class);
 
        return $this->ui_factory->link()->bulky(
            $this->ui_factory->symbol()->icon()->custom('', ''),
            $label ?? $this->lang->txt($this->getName()),
            $uri
        );
    }

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\buildSubtypeStep(), ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition\buildSubtypeStep(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\setupSteps().

Here is the caller graph for this function:

◆ buildUrl()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::buildUrl	(	string	$command,
		bool	$with_configuration_gui = `false`
	)

protected

Builds a URL for the given command.

Parameters

string	$command
bool	$with_configuration_gui

Returns: URI

Exceptions

ilCtrlException

Definition at line 393 of file AbstractCondition.php.

                                                                                      : URI
    {
        $this->dic->ctrl()->setParameterByClass(
            ilObjLearningSequenceConditionsGUI::class,
            'type_id',
            $this->getTypeId()
        );
 
        $route = [
            ilRepositoryGUI::class,
            ilObjLearningSequenceGUI::class,
            ilObjLearningSequenceContentGUI::class,
            ilObjLearningSequenceConditionsGUI::class
        ];
 
        if ($command === self::CONFIGURE_COMMAND || $with_configuration_gui) {
            if ($this->condition_id !== null) {
                $this->dic->ctrl()->setParameterByClass(
                    \ilObjLearningSequenceConditionConfigurationGUI::class,
                    'condition_id',
                    (string) $this->condition_id
                );
            }
            $route[] = \ilObjLearningSequenceConditionConfigurationGUI::class;
        }
 
        $url = $this->dic->ctrl()->getLinkTargetByClass(
            $route,
            $command
        );
        return new URI(ILIAS_HTTP_PATH . '/' . $url);
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\getTypeId().

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\getAdditionalForm(), ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\getAdditionalForm(), ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition\getAdditionalForm(), and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition\getAdditionalForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ check()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::check ( )

abstract

Checks if the condition is fulfilled.

Returns: bool

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\AlwaysOutputCondition\AlwaysOutputCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition, and ConditionTypeRegistryTestUndirectedCondition.

Referenced by ILIAS\LearningSequence\Player\AdaptiveNavigator\checkCondition().

Here is the caller graph for this function:

◆ clearValidationMessages()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::clearValidationMessages ( )

Definition at line 138 of file AbstractCondition.php.

                                             : void
    {
        $this->validation_messages = [];
    }

◆ conditionTypeExistsInContext()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::conditionTypeExistsInContext ( ?int $type_id )

protected

Definition at line 549 of file AbstractCondition.php.

                                                                  : bool
    {
        if ($type_id === null) {
            throw new LogicException('Condition type ID is not set.');
        }
        $res = $this->getDatabase()->queryF(
            'SELECT condition_id FROM lso_conditions WHERE lso_ref_id = %s AND obj_ref_id = %s AND type_id = %s',
            ['integer', 'integer', 'integer'],
            [$this->lso_ref_id, $this->obj_ref_id, $type_id]
        );
 
        return $this->getDatabase()->fetchAssoc($res) !== null;
    }

References $res, ILIAS\LearningSequence\Content\Condition\AbstractCondition\$type_id, and ILIAS\LearningSequence\Content\Condition\AbstractCondition\getDatabase().

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::create ( bool $is_import = false )

Saves the condition to the DB.

Parameters

bool $is_import If true, skips createConditionData() (data will be filled by importPayload())

Exceptions

ReflectionException

Definition at line 289 of file AbstractCondition.php.

                                                   : void
    {
        if ($this->hasValidationMessages()) {
            return;
        }
 
        $this->assertContextSet();
        $this->assertConditionDataHookImplemented('createConditionData');
        $type_id = $this->getTypeId();
 
        if (
            !$this->allowMultipleConditionsOfSameType()
            && $this->conditionTypeExistsInContext($type_id)
        ) {
            $this->addValidationMessage($this->lang->txt('condition_already_exists'));
            return;
        }
 
        // Imports and copies fill the payload later via importPayload(), so the
        // configuration needed for the duplicate check is not available here.
        if (!$is_import && $this->supportsDuplicateCheck() && $this->duplicateExistsInContext($type_id)) {
            $this->addValidationMessage($this->lang->txt('condition_already_exists'));
            return;
        }
 
        $db = $this->getDatabase();
        $condition_id = $db->nextId('lso_conditions');
        $db->insert('lso_conditions', [
            'condition_id' => ['integer', $condition_id],
            'lso_ref_id' => ['integer', $this->lso_ref_id],
            'obj_ref_id' => ['integer', $this->obj_ref_id],
            'type_id' => ['integer', $type_id]
        ]);
 
        $this->condition_id = $condition_id;
 
        // Only call createConditionData if this is NOT an import
        // (during import, data will be filled by importPayload())
        if (!$is_import) {
            $this->createConditionData($condition_id);
        }
    }

Here is the call graph for this function:

◆ createConditionData()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::createConditionData ( int $condition_id )

protected

Hook for condition-specific payload persistence during create().

Override this method if migrate() contributes additional table definitions.

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 444 of file AbstractCondition.php.

                                                             : void
    {
    }

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\create().

Here is the caller graph for this function:

◆ delete()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::delete ( )

Deletes the condition from the database.

Exceptions

ReflectionException

Definition at line 370 of file AbstractCondition.php.

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

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\assertConditionDataHookImplemented(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\deleteConditionData(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\getDatabase().

Here is the call graph for this function:

◆ deleteConditionData()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::deleteConditionData ( int $condition_id )

protected

Hook for condition-specific payload cleanup during delete().

Override this method if migrate() contributes additional table definitions.

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 460 of file AbstractCondition.php.

                                                             : void
    {
    }

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\delete().

Here is the caller graph for this function:

◆ duplicateExistsInContext()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::duplicateExistsInContext ( ?int $type_id )

protected

Checks whether another condition of the same type on the same object in the same learning sequence is configured identically, see isDuplicateOf().

The condition itself is excluded, so editing without changes is possible.

Exceptions

LogicException

Definition at line 570 of file AbstractCondition.php.

                                                              : bool
    {
        if ($type_id === null) {
            throw new LogicException('Condition type ID is not set.');
        }
 
        $db = $this->getDatabase();
        $res = $db->queryF(
            'SELECT condition_id FROM lso_conditions WHERE lso_ref_id = %s AND obj_ref_id = %s AND type_id = %s',
            ['integer', 'integer', 'integer'],
            [$this->lso_ref_id, $this->obj_ref_id, $type_id]
        );
 
        while ($row = $db->fetchAssoc($res)) {
            $condition_id = (int) $row['condition_id'];
            if ($condition_id === $this->condition_id) {
                continue;
            }
 
            try {
                $other = $this->getConditionFactory()->getConditionInstanceById($condition_id);
            } catch (ilException) {
                continue;
            }
 
            if ($this->isDuplicateOf($other)) {
                return true;
            }
        }
 
        return false;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$condition_id, ILIAS\$db, $res, ILIAS\LearningSequence\Content\Condition\AbstractCondition\$type_id, ILIAS\LearningSequence\Content\Condition\AbstractCondition\getConditionFactory(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\getDatabase(), ILIAS\Repository\int(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\isDuplicateOf().

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\create(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\edit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edit()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::edit ( )

Edits the condition.

Exceptions

ReflectionException

Definition at line 336 of file AbstractCondition.php.

                          : void
    {
        if ($this->hasValidationMessages()) {
            return;
        }
 
        $this->assertContextSet();
        $this->assertConditionDataHookImplemented('editConditionData');
        $type_id = $this->getTypeId();
 
        if ($this->supportsDuplicateCheck() && $this->duplicateExistsInContext($type_id)) {
            $this->addValidationMessage($this->lang->txt('condition_already_exists'));
            return;
        }
 
        $this->getDatabase()->update(
            'lso_conditions',
            [
                'lso_ref_id' => ['integer', $this->lso_ref_id],
                'obj_ref_id' => ['integer', $this->obj_ref_id],
                'type_id' => ['integer', $type_id]
            ],
            [
                'condition_id' => ['integer', $this->condition_id]
            ]
        );
 
        $this->editConditionData($this->condition_id);
    }

Here is the call graph for this function:

◆ editConditionData()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::editConditionData ( int $condition_id )

protected

Hook for condition-specific payload persistence during edit().

Override this method if migrate() contributes additional table definitions.

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 452 of file AbstractCondition.php.

                                                           : void
    {
    }

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\edit().

Here is the caller graph for this function:

◆ export()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::export ( )

final

Definition at line 1135 of file AbstractCondition.php.

                                  : array
    {
        return $this->exportPayload();
    }

◆ exportPayload()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::exportPayload ( )

protected

Default export based on migrate() table definitions.

Returns: array<int, array{ table:string, fields:array, rows:array<int, array<string, mixed>> }>

Definition at line 990 of file AbstractCondition.php.

                                      : array
    {
        if ($this->condition_id === null) {
            return [];
        }
 
        $definitions = static::migrate();
        if ($definitions === []) {
            return [];
        }
 
        $db = $this->getDatabase();
        $result = [];
 
        foreach ($definitions as $def) {
            $table = $def->tableName;
            if (!$db->tableExists($table) || !$db->tableColumnExists($table, 'condition_id')) {
                continue;
            }
 
            $res = $db->queryF(
                'SELECT * FROM ' . $table . ' WHERE condition_id = %s',
                ['integer'],
                [$this->condition_id]
            );
 
            $rows = [];
            while ($row = $db->fetchAssoc($res)) {
                $rows[] = $row;
            }
 
            $result[] = [
                'ilias_version_numeric' => defined('ILIAS_VERSION_NUMERIC') ? (int) ILIAS_VERSION_NUMERIC : null,
                'table' => $table,
                'fields' => $def->fields,
                'rows' => $rows,
            ];
        }
 
        return $result;
    }

References ILIAS\$db, $res, ILIAS\Scripts\PHPStan\$rows, ILIAS_VERSION_NUMERIC, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getAdditionalDisplayInformation()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getAdditionalDisplayInformation ( )

Returns additional condition-specific information for table overviews.

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 120 of file AbstractCondition.php.

Referenced by ilLearningSequenceConditionsRetrieval\buildDetails().

Here is the caller graph for this function:

◆ getAdditionalDisplayObjectTitles()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getAdditionalDisplayObjectTitles ( )

Returns condition-specific object titles for table overviews.

Returns: string[]

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, and ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition.

Definition at line 157 of file AbstractCondition.php.

Referenced by ilLearningSequenceConditionsRetrieval\buildDetails().

Here is the caller graph for this function:

◆ getAdditionalForm()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getAdditionalForm ( )

Returns the additional form for the condition.

Has to be implemented by the child class if an additional form is needed.

Returns: FormStandard|null

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 112 of file AbstractCondition.php.

                                       : ?FormStandard
    {
        return null;
    }

◆ getConditionFactory()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getConditionFactory ( )

protected

Returns the factory which created this condition.

A condition which was not created by a factory gets its own one.

Definition at line 509 of file AbstractCondition.php.

                                            : ConditionFactory
    {
        return $this->condition_factory ??= new ConditionFactory(
            $this->dic[ConditionTypes::class],
            $this->getDatabase()
        );
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\getDatabase().

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\duplicateExistsInContext().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConditionId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getConditionId ( )

Returns: int|null

Definition at line 255 of file AbstractCondition.php.

                                    : ?int
    {
        return $this->condition_id;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$condition_id.

◆ getConfiguredStartRefId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getConfiguredStartRefId ( array $context = [] )

protected

Parameters

array<string,mixed> $context

Definition at line 822 of file AbstractCondition.php.

                                                                   : int
    {
        $start_ref_id = (int) ($context['start_ref_id'] ?? 0);
        if ($start_ref_id > 0) {
            return $start_ref_id;
        }
 
        if ($this->getLsoRefId() === null) {
            return 0;
        }
 
        try {
            return (new LSOAdaptiveBoundaries($this->getDatabase()))
                ->getBoundariesFor($this->getLso()->getId())['start_ref_id'] ?? 0;
        } catch (LogicException) {
            return 0;
        }
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getData()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getData ( )

Returns: array

Definition at line 939 of file AbstractCondition.php.

                             : array
    {
        if ($this->condition_id === null) {
            return [];
        }
 
        $definitions = static::migrate();
        if ($definitions === []) {
            return [];
        }
 
        $db = $this->getDatabase();
        $result = [];
 
        foreach ($definitions as $def) {
            $table = $def->tableName;
 
            if (!$db->tableExists($table) || !$db->tableColumnExists($table, 'condition_id')) {
                continue;
            }
 
            $res = $db->queryF(
                'SELECT * FROM ' . $table . ' WHERE condition_id = %s',
                ['integer'],
                [$this->condition_id]
            );
 
            $rows = [];
            while ($row = $db->fetchAssoc($res)) {
                $rows[] = $row;
            }
 
            $result[] = [
                'table' => $table,
                'fields' => $def->fields,
                'rows' => $rows,
            ];
        }
 
        return $result;
    }

References ILIAS\$db, $res, and ILIAS\Scripts\PHPStan\$rows.

◆ getDatabase()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getDatabase ( )

protected

Returns the database interface.

Returns: ilDBInterface

Definition at line 491 of file AbstractCondition.php.

                                    : ilDBInterface
    {
        return $this->dic->database();
    }

Here is the caller graph for this function:

◆ getIdentifierForClass()

static ILIAS\LearningSequence\Content\Condition\AbstractCondition::getIdentifierForClass ( string $class )

static

Extracts the identifier for the condition type from the class name.

Parameters

string $class

Returns: string

Definition at line 609 of file AbstractCondition.php.

                                                               : string
    {
        $parts = explode('\\', $class);
        $short_name = end($parts);
        return preg_replace('/Condition$/', '', $short_name);
    }

Referenced by ILIAS\LearningSequence\Content\Condition\ConditionTypeRegistry\getConditionByName(), ILIAS\LearningSequence\Content\Condition\ConditionHandler\getConditionsFromDb(), ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\getOutputConditionIdForItem(), and ILIAS\LearningSequence\Content\Condition\ConditionTypeRegistry\validate().

Here is the caller graph for this function:

◆ getLso()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getLso ( )

protected

Returns the learning sequence object associated with this condition.

Returns: ilObjLearningSequence

Exceptions

LogicException if the LSO ref id is not set or the object is not an ilObjLearningSequence

Definition at line 865 of file AbstractCondition.php.

                               : ilObjLearningSequence
    {
        $lso_ref_id = $this->getLsoRefId();
        if ($lso_ref_id === null) {
            throw new LogicException("LSO ref id is not set.");
        }
 
        $object = ilObjectFactory::getInstanceByRefId($lso_ref_id);
        if (!$object instanceof ilObjLearningSequence) {
            throw new LogicException("Object is not an ilObjLearningSequence.");
        }
 
        return $object;
    }

References ilObjectFactory\getInstanceByRefId().

Here is the call graph for this function:

◆ getLsoItems()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getLsoItems ( )

protected

Returns the items of the learning sequence associated with this condition.

Returns: \LSItem[]

Definition at line 885 of file AbstractCondition.php.

                                    : array
    {
        return $this->getLso()->getLSItems();
    }

◆ getLsoRefId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getLsoRefId ( )

Returns: int|null

Definition at line 239 of file AbstractCondition.php.

                                 : ?int
    {
        return $this->lso_ref_id;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$lso_ref_id.

◆ getMissingReferencedLsoRefIds()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getMissingReferencedLsoRefIds	(	array	$referenced_ref_ids,
		array	$context = `[]`
	)

protected

Parameters

int[]	$referenced_ref_ids
	array<string,mixed>	$context

Returns: int[]

Definition at line 846 of file AbstractCondition.php.

                                                                                                    : array
    {
        $valid_ref_ids = $this->getValidLsoRefIds($context);
        if ($valid_ref_ids === []) {
            return [];
        }
 
        return array_values(array_filter(
            array_values(array_unique(array_map('intval', $referenced_ref_ids))),
            static fn(int $ref_id): bool => !in_array($ref_id, $valid_ref_ids, true)
        ));
    }

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\getStaticInputConfigurationIssues(), ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\getStaticInputConfigurationIssues(), and ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition\getStaticInputConfigurationIssues().

Here is the caller graph for this function:

◆ getName()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getName ( )

Returns: string|null

Definition at line 186 of file AbstractCondition.php.

                             : ?string
    {
        return static::NAME;
    }

◆ getObjectTitleByRefId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getObjectTitleByRefId ( int $ref_id )

protected

Definition at line 517 of file AbstractCondition.php.

                                                         : string
    {
        $obj_id = \ilObject::_lookupObjId($ref_id);
        if ($obj_id > 0) {
            return \ilObject::_lookupTitle($obj_id);
        }
 
        return sprintf('Ref-ID %d', $ref_id);
    }

References ilObject\_lookupObjId().

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\getAdditionalDisplayObjectTitles(), ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\getAdditionalDisplayObjectTitles(), and ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition\getAdditionalDisplayObjectTitles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjRefId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getObjRefId ( )

Returns: int|null

Definition at line 223 of file AbstractCondition.php.

                                 : ?int
    {
        return $this->obj_ref_id;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$obj_ref_id.

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\getAdditionalForm(), ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\getAdditionalForm(), ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition\getAdditionalForm(), and ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\getRefIdsReferencingMissingPointsOutput().

Here is the caller graph for this function:

◆ getStaticInputConditionConstraints()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getStaticInputConditionConstraints ( )

Returns statically analyzable input-condition constraints.

Returns: array<int, array{kind: string, ref_ids: int[]}>

Definition at line 723 of file AbstractCondition.php.

◆ getStaticInputConfigurationConflictAffectedRefIds()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getStaticInputConfigurationConflictAffectedRefIds ( )

protected

Returns: int[]

Definition at line 781 of file AbstractCondition.php.

                                                                          : array
    {
        $ref_id = (int) $this->getObjRefId();
 
        return $ref_id > 0 ? [$ref_id] : [];
    }

References ILIAS\Repository\int().

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\getStaticInputConfigurationIssues(), ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\getStaticInputConfigurationIssues(), and ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition\getStaticInputConfigurationIssues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStaticInputConfigurationIssues()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getStaticInputConfigurationIssues ( array $context = [] )

Returns static input-configuration issues contributed by this condition.

Parameters

array<string,mixed> $context

Returns: StaticInputConfigurationIssue[]

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, and ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition.

Definition at line 745 of file AbstractCondition.php.

                                                                          : array
    {
        if (!$this->hasStaticInputConfigurationConflict($context)) {
            return [];
        }
 
        $affected_ref_ids = $this->getStaticInputConfigurationConflictAffectedRefIds();
        if ($affected_ref_ids === []) {
            return [];
        }
 
        return [new StaticInputConfigurationIssue(
            'static_input_configuration_conflict',
            $affected_ref_ids,
            details: array_map(
                static fn(int $ref_id): StaticInputConfigurationIssueDetail => new StaticInputConfigurationIssueDetail(
                    $ref_id,
                    'lso_static_input_configuration_conflict_detail'
                ),
                $affected_ref_ids
            )
        )];
    }

Referenced by ilObjLearningSequenceConditionConfigurationGUI\getStaticInputConfigurationMessages().

Here is the caller graph for this function:

◆ getStepCommand()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getStepCommand ( )

protected

Determines the command to use for the next step based on whether configuration is required.

Returns: string

Definition at line 621 of file AbstractCondition.php.

                                       : string
    {
        return $this->requiresConfiguration() ? self::CONFIGURE_COMMAND : self::CREATE_COMMAND;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\CONFIGURE_COMMAND, ILIAS\LearningSequence\Content\Condition\AbstractCondition\CREATE_COMMAND, and ILIAS\LearningSequence\Content\Condition\AbstractCondition\requiresConfiguration().

Here is the call graph for this function:

◆ getTypeId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getTypeId ( )

Returns: int|null

Definition at line 279 of file AbstractCondition.php.

                               : ?int
    {
        return $this->type_id ?: $this->getTypeIdFromDb();
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\getTypeIdFromDb().

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\buildUrl(), ilObjLearningSequenceConditionConfigurationGUI\checkIfConditionAlreadyExistsInItem(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\create(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\edit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeIdFromDb()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getTypeIdFromDb ( )

protected

Returns the type ID for this condition.

Returns: int

Exceptions

LogicException if the condition type is not registered

Definition at line 533 of file AbstractCondition.php.

                                        : int
    {
        $res = $this->getDatabase()->queryF(
            'SELECT type_id FROM lso_condition_types WHERE condition_name = %s',
            ['text'],
            [self::getIdentifierForClass(static::class)]
        );
        $row = $this->getDatabase()->fetchAssoc($res);
 
        if ($row === null) {
            throw new LogicException("Condition type is not registered.");
        }
 
        return (int) $row['type_id'];
    }

References $res, and ILIAS\LearningSequence\Content\Condition\AbstractCondition\getDatabase().

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\getTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidationMessages()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getValidationMessages ( )

Returns: string[]

Definition at line 128 of file AbstractCondition.php.

                                           : array
    {
        return $this->validation_messages;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$validation_messages.

Referenced by ilObjLearningSequenceConditionConfigurationGUI\showValidationMessages(), and ilObjLearningSequenceConditionsGUI\showValidationMessages().

Here is the caller graph for this function:

◆ getValidLsoRefIds()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::getValidLsoRefIds ( array $context = [] )

protected

Parameters

array<string,mixed> $context

Returns: int[]

Definition at line 792 of file AbstractCondition.php.

                                                             : array
    {
        $valid_ref_ids = $context['valid_ref_ids'] ?? null;
        if (is_array($valid_ref_ids) && $valid_ref_ids !== []) {
            return array_values(array_unique(array_filter(
                array_map('intval', $valid_ref_ids),
                static fn(int $ref_id): bool => $ref_id > 0
            )));
        }
 
        if ($this->getLsoRefId() === null) {
            return [];
        }
 
        try {
            return array_values(array_unique(array_filter(
                array_map(
                    static fn(\LSItem $item): int => $item->getRefId(),
                    $this->getLsoItems()
                ),
                static fn(int $ref_id): bool => $ref_id > 0
            )));
        } catch (LogicException) {
            return [];
        }
    }

References LSItem\getRefId().

Here is the call graph for this function:

◆ hasStaticInputConfigurationConflict()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::hasStaticInputConfigurationConflict ( array $context = [] )

Allows concrete conditions to report static misconfigurations that depend on context information such as the configured start object.

Parameters

array<string,mixed> $context

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, and ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition.

Definition at line 734 of file AbstractCondition.php.

                                                                            : bool
    {
        return false;
    }

◆ hasValidationMessages()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::hasValidationMessages ( )

Definition at line 133 of file AbstractCondition.php.

                                           : bool
    {
        return $this->validation_messages !== [];
    }

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\applyAdditionalFormData(), ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition\applyAdditionalFormData(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\create(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\edit().

Here is the caller graph for this function:

◆ import()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::import	(	array	$payload,
		int	$new_condition_id
	)

final

Definition at line 1140 of file AbstractCondition.php.

                                                                       : void
    {
        $this->importPayload($payload, $new_condition_id);
    }

◆ importPayload()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::importPayload	(	array	$payload,
		int	$new_condition_id
	)

protected

Default import for payload exported by exportPayload().

$new_condition_id must already be created in lso_conditions.

The payload comes from an uploaded file and is untrusted: only the tables and columns declared in migrate() of this condition are written, and the column types are taken from these definitions, never from the payload.

Exceptions

RuntimeException if the payload references a table this condition does not own

Definition at line 1042 of file AbstractCondition.php.

                                                                           : void
    {
        $db = $this->getDatabase();
        $ref_mapping = $this->import_mapping;
 
        $definitions = [];
        foreach (static::migrate() as $def) {
            $definitions[$def->tableName] = $def;
        }
 
        foreach ($payload as $tableData) {
            $table = (string) ($tableData['table'] ?? '');
            $rows = is_array($tableData['rows'] ?? null) ? $tableData['rows'] : [];
 
            if (!isset($definitions[$table])) {
                throw new \RuntimeException(
                    "Table '{$table}' is not defined for condition '" . static::class . "'."
                );
            }
 
            $field_map = [];
            foreach ($definitions[$table]->fields as $col_name => $field_def) {
                $field_map[$col_name] = [
                    'type' => $field_def['type'] ?? 'text',
                    'nullable' => !($field_def['notnull'] ?? true),
                ];
            }
 
            if (!$db->tableExists($table)) {
                continue;
            }
 
            $table_has_item_column = $db->tableColumnExists($table, 'item_ref_id');
 
            if ($table_has_item_column && $rows === []) {
                throw new \RuntimeException("Payload for table '{$table}' is empty, but table requires 'item' rows.");
            }
 
            $inserted_item_rows = 0;
 
            foreach ($rows as $row) {
                if (!is_array($row)) {
                    continue;
                }
 
                $insert = [
                    'condition_id' => ['integer', $new_condition_id],
                ];
 
                foreach ($row as $col => $value) {
                    $col = (string) $col;
 
                    // Always enforce the new condition id
                    if ($col === 'condition_id') {
                        continue;
                    }
 
                    // Only import declared columns that actually exist in the target table
                    if (!isset($field_map[$col]) || !$db->tableColumnExists($table, $col)) {
                        continue;
                    }
 
                    $field_info = $field_map[$col];
 
                    // Remap ref_id values using the container refs mapping
                    if ($col === 'item_ref_id') {
                        if (!isset($ref_mapping[$value])) {
                            continue 2;
                        }
 
                        $value = (int) $ref_mapping[$value];
                        $insert['item_ref_id'] = ['integer', $value];
                        $inserted_item_rows++;
                    }
 
                    // Handle NULL values based on field definition
                    if ($value === null) {
                        $insert[$col] = [$field_info['type'], $field_info['nullable'] ? null : ''];
                        continue;
                    }
 
                    $insert[$col] = [$field_info['type'], $value];
                }
 
                $db->insert($table, $insert);
            }
 
            if ($table_has_item_column && $inserted_item_rows === 0) {
                throw new \RuntimeException("No valid 'item' rows imported for item-based table '{$table}'.");
            }
        }
    }

References ILIAS\$db, ILIAS\Scripts\PHPStan\$rows, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ isDuplicateOf()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::isDuplicateOf ( AbstractCondition $other )

Determines whether this condition is configured identically to the given one.

create() and edit() refuse to save a condition that duplicates another condition of the same type on the same object in the same learning sequence. Override this method together with supportsDuplicateCheck() in child classes that allow multiple conditions of the same type, but not with the same configuration.

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition.

Definition at line 713 of file AbstractCondition.php.

                                                           : bool
    {
        return false;
    }

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\duplicateExistsInContext().

Here is the caller graph for this function:

◆ migrate()

static ILIAS\LearningSequence\Content\Condition\AbstractCondition::migrate ( )

static

Returns an array of table definitions for the condition.

It has to be implemented in the concrete condition class if additional tables are needed for the condition.

Returns: TableDefinition[]

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\AlwaysOutputCondition\AlwaysOutputCondition, ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 101 of file AbstractCondition.php.

                                    : array
    {
        return [];
    }

◆ read()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::read ( )

Reads the condition data from the database and populates the properties.

Exceptions

LogicException if the condition id is not set or the condition does not exist

Definition at line 895 of file AbstractCondition.php.

                          : void
    {
        if ($this->condition_id === null) {
            throw new LogicException("Condition id is not set.");
        }
 
        $res = $this->getDatabase()->queryF(
            'SELECT condition_id, lso_ref_id, obj_ref_id, type_id FROM lso_conditions WHERE condition_id = %s',
            ['integer'],
            [$this->condition_id]
        );
        $row = $this->getDatabase()->fetchAssoc($res);
 
        if ($row === null) {
            throw new LogicException("Condition does not exist.");
        }
 
        $this->setLsoRefId((int) $row['lso_ref_id']);
        $this->setObjRefId((int) $row['obj_ref_id']);
        $this->setTypeId((int) $row['type_id']);
        if ($this instanceof SubtypeAwareInterface) {
            $db = $this->dic->database();
            $table_name = "lso_c_{$this->getName()}";
 
            if (
                $db->tableExists($table_name)
                && $db->tableColumnExists($table_name, 'condition_id')
                && $db->tableColumnExists($table_name, 'subtype')
            ) {
                $query = $this->dic->database()->queryF(
                    "SELECT * FROM $table_name WHERE condition_id = %s",
                    ['integer'],
                    [$this->condition_id]
                );
                if ($record = $db->fetchObject($query)) {
                    $this->setSubtype($record->subtype);
                }
            }
        }
    }

References ILIAS\$db, and $res.

◆ referencesMissingLsoItems()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::referencesMissingLsoItems	(	array	$referenced_ref_ids,
		array	$context = `[]`
	)

protected

Parameters

int[]	$referenced_ref_ids
	array<string,mixed>	$context

Definition at line 773 of file AbstractCondition.php.

                                                                                                : bool
    {
        return $this->getMissingReferencedLsoRefIds($referenced_ref_ids, $context) !== [];
    }

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\hasStaticInputConfigurationConflict(), ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\hasStaticInputConfigurationConflict(), and ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition\hasStaticInputConfigurationConflict().

Here is the caller graph for this function:

◆ requiresConfiguration()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::requiresConfiguration ( )

protected

Determines whether the condition requires additional configuration.

Override this method in child classes if configuration is needed.

Returns: bool

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition, ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\PointsOutputCondition\PointsOutputCondition.

Definition at line 680 of file AbstractCondition.php.

                                              : bool
    {
        return false;
    }

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\getStepCommand().

Here is the caller graph for this function:

◆ setConditionFactory()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::setConditionFactory ( ConditionFactory $condition_factory )

Sets the factory which created this condition.

Conditions resolving other conditions use it, so the caches of the factory are shared.

Definition at line 500 of file AbstractCondition.php.

                                                                            : void
    {
        $this->condition_factory = $condition_factory;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$condition_factory.

◆ setConditionId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::setConditionId ( ?int $condition_id )

Parameters

int | null $condition_id

Definition at line 263 of file AbstractCondition.php.

                                                      : void
    {
        $this->condition_id = $condition_id;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$condition_id.

◆ setImportMapping()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::setImportMapping ( array $mapping )

Definition at line 1145 of file AbstractCondition.php.

                                                    : void
    {
        $this->import_mapping = $mapping;
    }

◆ setLsoRefId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::setLsoRefId ( ?int $lso_ref_id )

Parameters

int | null $lso_ref_id

Definition at line 247 of file AbstractCondition.php.

                                                 : void
    {
        $this->lso_ref_id = $lso_ref_id;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$lso_ref_id.

◆ setObjRefId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::setObjRefId ( ?int $obj_ref_id )

Parameters

int | null $obj_ref_id

Definition at line 231 of file AbstractCondition.php.

                                                 : void
    {
        $this->obj_ref_id = $obj_ref_id;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$obj_ref_id.

◆ setSubtype()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::setSubtype ( string $subtype )

Parameters

string $subtype

Definition at line 194 of file AbstractCondition.php.

                                               : void
    {
        if (!$this instanceof SubtypeAwareInterface) {
            throw new LogicException(sprintf("This Condition doesn't support Subtypes: %s", static::class));
        }
 
        if (!in_array($subtype, $this->getSupportedSubtypes(), true)) {
            throw new LogicException(sprintf("The subtype %s isn't supported by the condition", $subtype));
        }
 
        $this->subtype = $subtype;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$subtype.

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\getSubtype(), and ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition\getSubtype().

Here is the caller graph for this function:

◆ setTypeId()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::setTypeId ( ?int $type_id )

Parameters

int | null $type_id

Definition at line 271 of file AbstractCondition.php.

                                            : void
    {
        $this->type_id = $type_id;
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\$type_id.

◆ setupSteps()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::setupSteps ( )

Returns an array of steps to configure the condition.

Has to be implemented by the child class if additional steps are needed.

Returns: array

Exceptions

ilCtrlException

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition, and ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition.

Definition at line 214 of file AbstractCondition.php.

                                : array
    {
        $this->assertContextSet();
        return [$this->buildStep()];
    }

References ILIAS\LearningSequence\Content\Condition\AbstractCondition\assertContextSet(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\buildStep().

Here is the call graph for this function:

◆ supportsDuplicateCheck()

ILIAS\LearningSequence\Content\Condition\AbstractCondition::supportsDuplicateCheck ( )

Whether create() and edit() check for an identically configured condition, see isDuplicateOf().

Off by default, so types without a duplicate check do not load the other conditions of the item.

Reimplemented in ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition.

Definition at line 701 of file AbstractCondition.php.

                                            : bool
    {
        return false;
    }

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\create(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\edit().

Here is the caller graph for this function:

Field Documentation

◆ $condition_factory

ConditionFactory ILIAS\LearningSequence\Content\Condition\AbstractCondition::$condition_factory = null

protected

Factory which created this condition, used to resolve other conditions.

Definition at line 60 of file AbstractCondition.php.

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\setConditionFactory().

◆ $condition_id

int ILIAS\LearningSequence\Content\Condition\AbstractCondition::$condition_id = null

protected

Definition at line 53 of file AbstractCondition.php.

◆ $dic

Container ILIAS\LearningSequence\Content\Condition\AbstractCondition::$dic

protected

Definition at line 50 of file AbstractCondition.php.

◆ $import_mapping

array ILIAS\LearningSequence\Content\Condition\AbstractCondition::$import_mapping = []

protected

Definition at line 67 of file AbstractCondition.php.

◆ $lang

ilLanguage ILIAS\LearningSequence\Content\Condition\AbstractCondition::$lang

protected

Definition at line 49 of file AbstractCondition.php.

◆ $lso_ref_id

int ILIAS\LearningSequence\Content\Condition\AbstractCondition::$lso_ref_id = null

protected

Definition at line 52 of file AbstractCondition.php.

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\getLsoRefId(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\setLsoRefId().

◆ $obj_ref_id

int ILIAS\LearningSequence\Content\Condition\AbstractCondition::$obj_ref_id = null

protected

Definition at line 51 of file AbstractCondition.php.

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\getObjRefId(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\setObjRefId(), ILIAS\LearningSequence\Content\Condition\InputCondition\PointsInputCondition\PointsInputCondition\setSourceRefIds(), and ILIAS\LearningSequence\Content\Condition\InputCondition\SubsetInputCondition\SubsetInputCondition\setSourceRefIds().

◆ $subtype

string ILIAS\LearningSequence\Content\Condition\AbstractCondition::$subtype = null

protected

Definition at line 55 of file AbstractCondition.php.

Referenced by ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\getSubtype(), ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition\getSubtype(), ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\getSubtypeLabel(), ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition\getSubtypeLabel(), ILIAS\LearningSequence\Content\Condition\InputCondition\LearningProgressInputConditions\LearningProgressInputAwareCondition\requireSubtype(), ILIAS\LearningSequence\Content\Condition\OutputCondition\LearningProgressOutputConditions\LearningProgressOutputAwareCondition\requireSubtype(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\setSubtype().

◆ $type_id

int ILIAS\LearningSequence\Content\Condition\AbstractCondition::$type_id = null

protected

Definition at line 54 of file AbstractCondition.php.

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\conditionTypeExistsInContext(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\create(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\duplicateExistsInContext(), ILIAS\LearningSequence\Content\Condition\AbstractCondition\edit(), and ILIAS\LearningSequence\Content\Condition\AbstractCondition\setTypeId().

◆ $ui_factory

Factory ILIAS\LearningSequence\Content\Condition\AbstractCondition::$ui_factory

protected

Definition at line 56 of file AbstractCondition.php.

◆ $validation_messages

array ILIAS\LearningSequence\Content\Condition\AbstractCondition::$validation_messages = []

private

Definition at line 73 of file AbstractCondition.php.

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\getValidationMessages().

◆ CONFIGURE_COMMAND

const string ILIAS\LearningSequence\Content\Condition\AbstractCondition::CONFIGURE_COMMAND = 'configure'

protected

Definition at line 47 of file AbstractCondition.php.

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\getStepCommand().

◆ CREATE_COMMAND

const string ILIAS\LearningSequence\Content\Condition\AbstractCondition::CREATE_COMMAND = 'createCondition'

protected

Definition at line 46 of file AbstractCondition.php.

Referenced by ILIAS\LearningSequence\Content\Condition\AbstractCondition\getStepCommand().

◆ NAME

const string ILIAS\LearningSequence\Content\Condition\AbstractCondition::NAME = ''

protected

Definition at line 45 of file AbstractCondition.php.

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

components/ILIAS/LearningSequence/classes/Content/Condition/AbstractCondition.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ addValidationMessage()

◆ allowMultipleConditionsOfSameType()

◆ applyAdditionalFormData()

◆ assertConditionDataHookImplemented()

◆ assertContextSet()

◆ buildStep()

◆ buildUrl()

◆ check()

◆ clearValidationMessages()

◆ conditionTypeExistsInContext()

◆ create()

◆ createConditionData()

◆ delete()

◆ deleteConditionData()

◆ duplicateExistsInContext()

◆ edit()

◆ editConditionData()

◆ export()

◆ exportPayload()

◆ getAdditionalDisplayInformation()

◆ getAdditionalDisplayObjectTitles()

◆ getAdditionalForm()

◆ getConditionFactory()

◆ getConditionId()

◆ getConfiguredStartRefId()

◆ getData()

◆ getDatabase()

◆ getIdentifierForClass()

◆ getLso()

◆ getLsoItems()

◆ getLsoRefId()

◆ getMissingReferencedLsoRefIds()

◆ getName()

◆ getObjectTitleByRefId()

◆ getObjRefId()

◆ getStaticInputConditionConstraints()

◆ getStaticInputConfigurationConflictAffectedRefIds()

◆ getStaticInputConfigurationIssues()

◆ getStepCommand()

◆ getTypeId()

◆ getTypeIdFromDb()

◆ getValidationMessages()

◆ getValidLsoRefIds()

◆ hasStaticInputConfigurationConflict()

◆ hasValidationMessages()

◆ import()

◆ importPayload()

◆ isDuplicateOf()

◆ migrate()

◆ read()

◆ referencesMissingLsoItems()

◆ requiresConfiguration()

◆ setConditionFactory()

◆ setConditionId()

◆ setImportMapping()

◆ setLsoRefId()

◆ setObjRefId()

◆ setSubtype()

◆ setTypeId()

◆ setupSteps()

◆ supportsDuplicateCheck()

Field Documentation

◆ $condition_factory

◆ $condition_id

◆ $dic

◆ $import_mapping

◆ $lang

◆ $lso_ref_id

◆ $obj_ref_id

◆ $subtype

◆ $type_id

◆ $ui_factory

◆ $validation_messages