INTERNAL CLASS: Please do not use in consumer code. More...

Collaboration diagram for ilConditionHandler:

Public Member Functions
	__construct ()

	setReferenceHandlingType (int $a_type)

	getReferenceHandlingType ()

	setErrorMessage (string $a_msg)

	getErrorMessage ()

	setTargetRefId (int $a_target_ref_id)

	getTargetRefId ()

	setTargetObjId (int $a_target_obj_id)

	getTargetObjId ()

	setTargetType (string $a_target_type)
	set target object type More...

	getTargetType ()
	get target obj type More...

	setTriggerRefId (int $a_trigger_ref_id)

	getTriggerRefId ()

	setTriggerObjId (int $a_trigger_obj_id)

	getTriggerObjId ()

	setTriggerType (string $a_trigger_type)
	set trigger object type More...

	getTriggerType ()
	get trigger obj type More...

	setOperator (string $a_operator)

	getOperator ()

	setValue (string $a_value)

	getValue ()

	setObligatory (bool $a_obl)
	Set obligatory status. More...

	getObligatory ()
	Get obligatory status. More...

	setHiddenStatus (bool $a_status)

	getHiddenStatus ()

	enableAutomaticValidation (bool $a_validate=true)

	getTriggerTypes ()

	getOperatorsByTriggerType (string $a_type)

	storeCondition ()
	store new condition in database More...

	checkExists ()

	updateCondition (int $a_id)

	updateHiddenStatus (bool $a_status)

	delete (int $a_ref_id)
	delete all trigger and target entries This method is called from ilObject::delete() if an object os removed from trash More...

	deleteByObjId (int $a_obj_id)
	delete all trigger and target entries This method is called from ilObject::delete() if an object is removed from trash More...

	deleteCondition (int $a_id)

Static Public Member Functions
static	resetCache ()

static	_isReferenceHandlingOptional (string $a_type)

static	lookupPersistedHiddenStatusByTarget (int $a_target_ref_id)

static	_adjustMovedObjectConditions (int $a_ref_id)
	In the moment it is not allowed to create preconditions on objects that are located outside of a course. More...

static	updateObligatory (int $a_id, bool $a_status)
	Toggle condition obligatory status. More...

static	getNumberOfConditionsOfTrigger (string $a_trigger_obj_type, int $a_trigger_id)
	get all conditions of trigger object More...

static	_getPersistedConditionsOfTrigger (string $a_trigger_obj_type, int $a_trigger_id)
	Get all persisted conditions of trigger object Note: This only gets persisted conditions NOT (dynamic) conditions send by the parent container logic. More...

static	_getPersistedConditionsOfTarget (int $a_target_ref_id, int $a_target_obj_id, string $a_target_type="")
	get all persisted conditions of target object More...

static	preloadPersistedConditionsForTargetRecords (string $a_type, array $a_obj_ids)

static	_getCondition (int $a_id)

static	_checkCondition (array $condition, int $a_usr_id=0)
	checks wether a single condition is fulfilled every trigger object type must implement a static method _checkCondition($a_operator, $a_value) More...

static	getEffectiveOptionalConditionsOfTarget (int $a_target_ref_id, int $a_target_obj_id, string $a_obj_type='')

static	getPersistedOptionalConditionsOfTarget (int $a_target_ref_id, int $a_target_obj_id, string $a_obj_type='')

static	lookupObligatoryConditionsOfTarget (int $a_target_ref_id, int $a_target_obj_id)

static	calculateEffectiveRequiredTriggers (int $a_target_ref_id, int $a_target_obj_id, string $a_target_obj_type='')

static	calculatePersistedRequiredTriggers (int $a_target_ref_id, int $a_target_obj_id, string $a_target_obj_type='', bool $a_force_update=false)

static	saveNumberOfRequiredTriggers (int $a_target_ref_id, int $a_target_obj_id, int $a_num)

static	_checkAllConditionsOfTarget (int $a_target_ref_id, int $a_target_id, string $a_target_type="", int $a_usr_id=0)
	checks wether all conditions of a target object are fulfilled More...

static	cloneDependencies (int $a_src_ref_id, int $a_target_ref_id, int $a_copy_id)

Data Fields
const	OPERATOR_PASSED = 'passed'

const	OPERATOR_FINISHED = 'finished'

const	OPERATOR_NOT_FINISHED = 'not_finished'

const	OPERATOR_NOT_MEMBER = 'not_member'

const	OPERATOR_FAILED = 'failed'

const	OPERATOR_LP = 'learning_progress'

const	OPERATOR_ACCREDITED_OR_PASSED = 'accredited_or_passed'

const	OPERATOR_RESULT_RANGE_PERCENTAGE = 'result_range_percentage'

const	UNIQUE_CONDITIONS = 1

const	SHARED_CONDITIONS = 0

Static Public Attributes
static array	$cond_for_target_cache = array()

static array	$cond_target_rows = array()

Protected Member Functions
	validate ()

	checkCircle (int $a_ref_id, int $a_obj_id)

Static Protected Member Functions
static	_getDistinctTargetRefIds ()

static	_deleteTargetConditionsByRefId (int $a_target_ref_id)
	Delete conditions by target ref id Note: only conditions on the target type are deleted Conditions on e.g chapters are not handled. More...

Protected Attributes
ilDBInterface	$db

ilLanguage	$lng

ilObjectDefinition	$objDefinition

ilTree	$tree

ilLogger	$logger

string	$error_message = ''

int	$target_obj_id = 0

int	$target_ref_id = 0

string	$target_type = ''

int	$trigger_obj_id = 0

int	$trigger_ref_id = 0

string	$trigger_type = ''

string	$operator=''

string	$value = ''

bool	$validation = true

Private Attributes
int	$condition_reference_type = 0

bool	$circle = false

bool	$obligatory = true

bool	$hidden_status = false

Detailed Description

INTERNAL CLASS: Please do not use in consumer code.

Handles conditions for accesses to different ILIAS objects A condition consists of four elements:

a trigger object, e.g. a test or a survey question
an operator, e.g. "=", "<", "passed"
an (optional) value, e.g. "5"
a target object, e.g. a learning module If a condition is fulfilled for a certain user, (s)he may access the target object. This first implementation handles only one access type per object, which is usually "read" access. A possible future extension may implement different access types. The condition data is stored in the database table "condition" (Note: This table must not be accessed directly from other classes. The data should be accessed via the interface of class ilCondition.) cond_id INT condition id trigger_obj_type VARCHAR(10) "crs" | "tst" | ... trigger_ref_id INT obj id of trigger object (only exception where this is 0 are currently (5.3) course groupings this might be refactored trigger_obj_id INT obj id of trigger object operator varchar(10 "=", "<", ">", ">=", "<=", "passed", "contains", ... value VARCHAR(10) optional value target_obj_type VARCHAR(10) "lm" | "frm" | "st", "lobj", ... target_obj_id object id of target object target_ref_id reference id of target object Special current targets (5.3)
learning objectives: type: "lobj"; obj_id: objective id; ref_id: ref id of course
lm chapters: type: "st"; obj_id: chapter id, ref_id: ref id of learning module Trigger objects are always stored with their object id (if a test has been passed by a user, he doesn't need to repeat it in other contexts. But target objects are usually stored with their reference id if available, otherwise, if they are non-referenced objects (e.g. (survey) questions) they are stored with their object id. Stefan Meyer 10-08-2004 In addition we store the ref_id of the trigger object to allow the target object to link to the triggered object. But it's not possible to assign two or more linked (same obj_id) triggered objects to a target object Examples: Learning module 5 may only be accessed, if test 6 has been passed: trigger_obj_type "tst" trigger_id 6 (object id) trigger_ref_id 117 operator "passed" value target_obj_type "lm" target_id 5 (reference id) Survey question 10 should only be presented, if survey question 8 is answered with a value greater than 4. trigger_obj_type "qst" trigger_id 8 (question (instance) object id) trigger_ref_id 117 operator ">" value "4" target_obj_type "lm" target_id 10 (question (instance) object id)
Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version
$Id$

Definition at line 77 of file class.ilConditionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilConditionHandler::__construct ( )

Definition at line 121 of file class.ilConditionHandler.php.

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

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->lng = $DIC->language();
         $this->objDefinition = $DIC['objDefinition'];
         $this->tree = $DIC->repositoryTree();
         $this->logger = $DIC->logger()->ac();
         $this->validation = true;
     }

Here is the call graph for this function:

Member Function Documentation

◆ _adjustMovedObjectConditions()

static ilConditionHandler::_adjustMovedObjectConditions ( int $a_ref_id )

static

In the moment it is not allowed to create preconditions on objects that are located outside of a course.

Therefore, after moving an object: check for parent type 'crs'. if that fails delete preconditions

Todo:: check if something needs to be done here

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

Referenced by ilSoapObjectAdministration\moveObject(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), and ilChatroomInstaller\setChatroomSettings().

                                                                       : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ _checkAllConditionsOfTarget()

static ilConditionHandler::_checkAllConditionsOfTarget	(	int	$a_target_ref_id,
		int	$a_target_id,
		string	$a_target_type = `""`,
		int	$a_usr_id = `0`
	)

static

checks wether all conditions of a target object are fulfilled

Todo:: check member view passthrough

Definition at line 1012 of file class.ilConditionHandler.php.

References $check, $DIC, ilMemberViewSettings\getInstance(), and ilTree\isDeleted().

Referenced by ilObjContentObject\_checkPreconditionsOfPage(), ilAccess\doConditionCheck(), ilRepositoryExplorerGUI\getChildsOfNode(), ilObjStudyProgrammeReferenceListGUI\initItem(), ilRepositoryExplorer\isClickable(), ilRepositoryExplorer\showChilds(), and ilCourseContentGUI\showStartObjects().

      : bool {
         global $DIC;
 
         $ilUser = $DIC['ilUser'];
         $tree = $DIC['tree'];
         $logger = $DIC->logger()->ac();
 
         $a_usr_id = $a_usr_id ?: $ilUser->getId();
         $conditions = self::_getEffectiveConditionsOfTarget(
             $a_target_ref_id,
             $a_target_id,
             $a_target_type
         );
         if (!count($conditions)) {
             return true;
         }
 
         if (ilMemberViewSettings::getInstance()->isActive()) {
             return true;
         }
 
         // First check obligatory conditions
         $optional = self::getEffectiveOptionalConditionsOfTarget($a_target_ref_id, $a_target_id, $a_target_type);
         $num_required = self::calculateEffectiveRequiredTriggers($a_target_ref_id, $a_target_id, $a_target_type);
         $passed = 0;
         foreach ($conditions as $condition) {
             if ($tree->isDeleted($condition['trigger_ref_id'])) {
                 continue;
             }
             $check = self::_checkCondition($condition, $a_usr_id);
 
             if ($check) {
                 ++$passed;
             } else {
                 // #0027223 if condition is obligatory => return false
                 if ($condition['obligatory']) {
                     return false;
                 }
             }
         }
         return $passed >= $num_required;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkCondition()

static ilConditionHandler::_checkCondition	(	array	$condition,
		int	$a_usr_id = `0`
	)

static

checks wether a single condition is fulfilled every trigger object type must implement a static method _checkCondition($a_operator, $a_value)

Definition at line 830 of file class.ilConditionHandler.php.

References $DIC, $location, ilObjCourseGrouping\_checkCondition(), ilLPStatus\_hasUserCompleted(), ilObjectDefinition\getClassName(), and ilObjectDefinition\getLocation().

Referenced by ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), ilInfoScreenGUI\addPreconditionSection(), and ilObjectListGUI\parseConditions().

                                                                                : bool
     {
         global $DIC;
 
         $ilUser = $DIC['ilUser'];
         $objDefinition = $DIC['objDefinition'];
         $a_usr_id = $a_usr_id ?: $ilUser->getId();
 
         // check lp
         if ($condition['operator'] === self::OPERATOR_LP) {
             return ilLPStatus::_hasUserCompleted($condition['trigger_obj_id'], $a_usr_id);
         }
         switch ($condition['trigger_type']) {
             case 'crsg':
                 return ilObjCourseGrouping::_checkCondition(
                     (int) $condition['trigger_obj_id'],
                     (string) $condition['operator'],
                     (string) $condition['value'],
                     (int) $a_usr_id
                 );
         }
         $class = $objDefinition->getClassName($condition['trigger_type']);
         $location = $objDefinition->getLocation($condition['trigger_type']);
         $full_class = "ilObj" . $class . "Access";
 
         if (!(is_a($full_class, "ilConditionHandling", true))) {
             return false;
         }
 
         $fullfilled = call_user_func(
             array($full_class, 'checkCondition'),
             (int) $condition['trigger_obj_id'],
             (string) $condition['operator'],
             (string) $condition['value'],
             (int) $a_usr_id
         );
         return $fullfilled;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _deleteTargetConditionsByRefId()

static ilConditionHandler::_deleteTargetConditionsByRefId ( int $a_target_ref_id )

staticprotected

Delete conditions by target ref id Note: only conditions on the target type are deleted Conditions on e.g chapters are not handled.

Definition at line 226 of file class.ilConditionHandler.php.

References $DIC, $ilDB, and $res.

                                                                                   : bool
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "DELETE FROM conditions " .
             "WHERE target_ref_id = " . $ilDB->quote($a_target_ref_id, 'integer') . " " .
             "AND target_type != 'st' ";
         $res = $ilDB->manipulate($query);
         return true;
     }

◆ _getCondition()

static ilConditionHandler::_getCondition ( int $a_id )

static

Definition at line 796 of file class.ilConditionHandler.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilConditionHandlerGUI\confirmDeleteConditionTrigger(), ilConditionHandlerGUI\edit(), ilConditionHandlerGUI\editConditionTrigger(), ilConditionHandlerGUI\initConditionTriggerForm(), ilConditionHandlerGUI\initFormCondition(), ilConditionHandlerGUI\updateCondition(), and ilConditionHandlerGUI\updateConditionTrigger().

                                                    : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM conditions " .
             "WHERE condition_id = " . $ilDB->quote($a_id, 'integer');
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $tmp_array['id'] = (int) $row->condition_id;
             $tmp_array['target_ref_id'] = (int) $row->target_ref_id;
             $tmp_array['target_obj_id'] = (int) $row->target_obj_id;
             $tmp_array['target_type'] = (string) $row->target_type;
             $tmp_array['trigger_ref_id'] = (int) $row->trigger_ref_id;
             $tmp_array['trigger_obj_id'] = (int) $row->trigger_obj_id;
             $tmp_array['trigger_type'] = (string) $row->trigger_type;
             $tmp_array['operator'] = (string) $row->operator;
             $tmp_array['value'] = (string) $row->value;
             $tmp_array['ref_handling'] = (int) $row->ref_handling;
             $tmp_array['obligatory'] = (bool) $row->obligatory;
             $tmp_array['hidden_status'] = (bool) $row->hidden_status;
             $tmp_array['num_obligatory'] = (int) $row->num_obligatory;
             return $tmp_array;
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getDistinctTargetRefIds()

static ilConditionHandler::_getDistinctTargetRefIds ( )

staticprotected

Returns: int[]

Definition at line 206 of file class.ilConditionHandler.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

                                                         : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT DISTINCT target_ref_id ref FROM conditions ";
         $res = $ilDB->query($query);
         $ref_ids = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $ref_ids[] = (int) $row->ref;
         }
         return $ref_ids;
     }

Here is the call graph for this function:

◆ _getPersistedConditionsOfTarget()

static ilConditionHandler::_getPersistedConditionsOfTarget	(	int	$a_target_ref_id,
		int	$a_target_obj_id,
		string	$a_target_type = `""`
	)

static

get all persisted conditions of target object

Returns: array<int, array<string, mixed>>

Definition at line 688 of file class.ilConditionHandler.php.

References $DIC, $ilDB, $res, ilObject\_lookupType(), and ILIAS\Repository\int().

Referenced by ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGrouping\_getGroupingCourseIds(), ilObjCourseGrouping\_getGroupingItems(), ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), ilConditionHandlerGUI\adjustConditionsAfterDeletion(), ilConditionHandlerGUI\confirmDeleteConditionTrigger(), ilConditionHandlerGUI\getConditionsOfTarget(), ilConditionHandlerGUI\initCompulsoryForm(), ILIAS\Conditions\Configuration\ConditionTriggerProvider\read(), ilConditionHandlerGUI\saveCompulsoryForm(), ilConditionHandlerGUI\saveCompulsoryStatus(), and ilConditionHandlerGUI\showObligatoryForm().

      : array {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         // get type if no type given
         if ($a_target_type === "") {
             $a_target_type = ilObject::_lookupType($a_target_obj_id);
         }
 
         // check conditions for target cache
         if (isset(self::$cond_for_target_cache[$a_target_ref_id . ":" . $a_target_obj_id . ":" .
             $a_target_type])) {
             return self::$cond_for_target_cache[$a_target_ref_id . ":" . $a_target_obj_id . ":" .
             $a_target_type];
         }
 
         // check rows cache
         if (isset(self::$cond_target_rows[$a_target_type . ":" . $a_target_obj_id])) {
             $rows = self::$cond_target_rows[$a_target_type . ":" . $a_target_obj_id];
         } else {
             // query data from db
             $query = "SELECT * FROM conditions " .
                 "WHERE target_obj_id = " . $ilDB->quote($a_target_obj_id, 'integer') . " " .
                 " AND target_type = " . $ilDB->quote($a_target_type, 'text');
 
             $res = $ilDB->query($query);
             $rows = array();
             while ($row = $ilDB->fetchAssoc($res)) {
                 $item = [];
                 $item['condition_id'] = (int) $row['condition_id'];
                 $item['target_ref_id'] = (int) $row['target_ref_id'];
                 $item['target_obj_id'] = (int) $row['target_obj_id'];
                 $item['trigger_ref_id'] = (int) $row['trigger_ref_id'];
                 $item['trigger_obj_id'] = (int) $row['trigger_obj_id'];
                 $item['target_type'] = (string) $row['target_type'];
                 $item['trigger_type'] = (string) $row['trigger_type'];
                 $item['operator'] = (string) $row['operator'];
                 $item['value'] = (string) $row['value'];
                 $item['ref_handling'] = (int) $row['ref_handling'];
                 $item['obligatory'] = (bool) $row['obligatory'];
                 $item['num_obligatory'] = (int) $row['num_obligatory'];
                 $item['hidden_status'] = (bool) $row['hidden_status'];
 
                 $rows[] = $item;
             }
         }
 
         reset($rows);
         $conditions = [];
         foreach ($rows as $row) {
             if (($row["ref_handling"] == self::UNIQUE_CONDITIONS) && $row["target_ref_id"] != $a_target_ref_id) {
                 continue;
             }
 
             $row["id"] = $row["condition_id"];
             $conditions[] = $row;
         }
         // write conditions for target cache
         self::$cond_for_target_cache[$a_target_ref_id . ":" . $a_target_obj_id . ":" .
         $a_target_type] = $conditions;
         return $conditions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getPersistedConditionsOfTrigger()

static ilConditionHandler::_getPersistedConditionsOfTrigger	(	string	$a_trigger_obj_type,
		int	$a_trigger_id
	)

static

Get all persisted conditions of trigger object Note: This only gets persisted conditions NOT (dynamic) conditions send by the parent container logic.

Returns: array<int, array<string, mixed>>

Definition at line 584 of file class.ilConditionHandler.php.

References $c, $DIC, $ilDB, $location, $obligatory, $res, ilObject\_lookupObjId(), ilObject\_lookupType(), ilDBConstants\FETCHMODE_OBJECT, ilTree\getParentId(), and ILIAS\Repository\int().

Referenced by ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGrouping\_getGroupingCourseIds(), ilObjCourseGrouping\_getGroupingItems(), and ilObjCourseGrouping\getAssignedItems().

                                                                                                           : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM conditions " .
             "WHERE trigger_obj_id = " . $ilDB->quote($a_trigger_id, 'integer') . " " .
             " AND trigger_type = " . $ilDB->quote($a_trigger_obj_type, 'text');
 
         $res = $ilDB->query($query);
         $conditions = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $tmp_array = [];
             $tmp_array['id'] = (int) $row->condition_id;
             $tmp_array['target_ref_id'] = (int) $row->target_ref_id;
             $tmp_array['target_obj_id'] = (int) $row->target_obj_id;
             $tmp_array['target_type'] = (string) $row->target_type;
             $tmp_array['trigger_ref_id'] = (int) $row->trigger_ref_id;
             $tmp_array['trigger_obj_id'] = (int) $row->trigger_obj_id;
             $tmp_array['trigger_type'] = (string) $row->trigger_type;
             $tmp_array['operator'] = (string) $row->operator;
             $tmp_array['value'] = (string) $row->value;
             $tmp_array['ref_handling'] = (int) $row->ref_handling;
             $tmp_array['obligatory'] = (bool) $row->obligatory;
             $tmp_array['hidden_status'] = (bool) $row->hidden_status;
             $conditions[] = $tmp_array;
         }
         return $conditions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isReferenceHandlingOptional()

static ilConditionHandler::_isReferenceHandlingOptional ( string $a_type )

static

Parameters

string target type ILIAS obj type

Definition at line 142 of file class.ilConditionHandler.php.

References $DIC, $location, ilObject\_lookupObjId(), ilObject\_lookupType(), and ilTree\getParentId().

Referenced by ilConditionHandlerGUI\initFormCondition().

                                                                        : bool
     {
         return $a_type === 'st';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateEffectiveRequiredTriggers()

static ilConditionHandler::calculateEffectiveRequiredTriggers	(	int	$a_target_ref_id,
		int	$a_target_obj_id,
		string	$a_target_obj_type = `''`
	)

static

Definition at line 922 of file class.ilConditionHandler.php.

References $DIC, and $ilDB.

Referenced by ilInfoScreenGUI\addPreconditionSection(), and ilObjectListGUI\parseConditions().

      : int {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         // Get all conditions
         $all = self::_getEffectiveConditionsOfTarget($a_target_ref_id, $a_target_obj_id, $a_target_obj_type);
         $opt = self::getEffectiveOptionalConditionsOfTarget($a_target_ref_id, $a_target_obj_id, $a_target_obj_type);
 
         $set_obl = 0;
         if (isset($all[0])) {
             $set_obl = $all[0]['num_obligatory'];
         }
 
         // existing value is valid
         if ($set_obl > 0 &&
             $set_obl < count($all) &&
             $set_obl > (count($all) - count($opt) + 1)) {
             return $set_obl;
         }
 
         if (count($opt)) {
             $result = count($all) - count($opt) + 1;
         } else {
             $result = count($all);
         }
         return $result;
     }

Here is the caller graph for this function:

◆ calculatePersistedRequiredTriggers()

static ilConditionHandler::calculatePersistedRequiredTriggers	(	int	$a_target_ref_id,
		int	$a_target_obj_id,
		string	$a_target_obj_type = `''`,
		bool	$a_force_update = `false`
	)

static

Definition at line 955 of file class.ilConditionHandler.php.

References $DIC, and $ilDB.

Referenced by ilConditionHandlerGUI\saveCompulsoryStatus().

      : int {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         // Get all conditions
 
         self::resetCache();
         $all = self::_getPersistedConditionsOfTarget($a_target_ref_id, $a_target_obj_id, $a_target_obj_type);
         $opt = self::getPersistedOptionalConditionsOfTarget($a_target_ref_id, $a_target_obj_id, $a_target_obj_type);
 
         $set_obl = 0;
         if (isset($all[0])) {
             $set_obl = $all[0]['num_obligatory'];
         }
 
         // existing value is valid
         if ($set_obl > 0 &&
             $set_obl < count($all) &&
             $set_obl > (count($all) - count($opt) + 1)) {
             return $set_obl;
         }
 
         if (count($opt)) {
             $result = count($all) - count($opt) + 1;
         } else {
             $result = count($all);
         }
         if ($a_force_update) {
             self::saveNumberOfRequiredTriggers($a_target_ref_id, $a_target_obj_id, $result);
         }
         return $result;
     }

Here is the caller graph for this function:

◆ checkCircle()

ilConditionHandler::checkCircle	(	int	$a_ref_id,
		int	$a_obj_id
	)

protected

Definition at line 1082 of file class.ilConditionHandler.php.

References $circle, and getOperator().

Referenced by validate().

                                                                 : bool
     {
         foreach (self::_getPersistedConditionsOfTarget($a_ref_id, $a_obj_id) as $condition) {
             if ($condition['trigger_obj_id'] == $this->target_obj_id && $condition['operator'] === $this->getOperator()) {
                 $this->circle = true;
                 break;
             }
 
             $this->checkCircle($condition['trigger_ref_id'], $condition['trigger_obj_id']);
         }
         return $this->circle;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkExists()

ilConditionHandler::checkExists ( )

Definition at line 486 of file class.ilConditionHandler.php.

References $res, getOperator(), getTargetObjId(), getTargetRefId(), getTriggerObjId(), and getTriggerRefId().

                                  : bool
     {
         $query = "SELECT * FROM conditions " .
             "WHERE target_ref_id = " . $this->db->quote($this->getTargetRefId(), 'integer') . " " .
             "AND target_obj_id = " . $this->db->quote($this->getTargetObjId(), 'integer') . " " .
             "AND trigger_ref_id = " . $this->db->quote($this->getTriggerRefId(), 'integer') . " " .
             "AND trigger_obj_id = " . $this->db->quote($this->getTriggerObjId(), 'integer') . " " .
             "AND operator = " . $this->db->quote($this->getOperator(), 'text');
         $res = $this->db->query($query);
         return (bool) $res->numRows();
     }

Here is the call graph for this function:

◆ cloneDependencies()

static ilConditionHandler::cloneDependencies	(	int	$a_src_ref_id,
		int	$a_target_ref_id,
		int	$a_copy_id
	)

static

Definition at line 1095 of file class.ilConditionHandler.php.

References $valid, ilCopyWizardOptions\_getInstance(), ilObject\_lookupObjId(), and ilObject\_lookupType().

Referenced by ilObject\cloneDependencies().

                                                                                                      : void
     {
         $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
         $mappings = $cwo->getMappings();
 
         $valid = 0;
         $conditions = self::_getPersistedConditionsOfTarget(
             $a_src_ref_id,
             ilObject::_lookupObjId($a_src_ref_id)
         );
         foreach ($conditions as $con) {
             if ($mappings[$con['trigger_ref_id']] ?? false) {
                 $newCondition = new ilConditionHandler();
 
                 $target_obj = ilObject::_lookupObjId($a_target_ref_id);
                 $target_typ = ilObject::_lookupType($target_obj);
 
                 $newCondition->setTargetRefId($a_target_ref_id);
                 $newCondition->setTargetObjId($target_obj);
                 $newCondition->setTargetType($target_typ);
 
                 $trigger_ref = $mappings[$con['trigger_ref_id']];
                 $trigger_obj = ilObject::_lookupObjId($trigger_ref);
                 $trigger_typ = ilObject::_lookupType($trigger_obj);
 
                 $newCondition->setTriggerRefId($trigger_ref);
                 $newCondition->setTriggerObjId($trigger_obj);
                 $newCondition->setTriggerType($trigger_typ);
                 $newCondition->setOperator($con['operator']);
                 $newCondition->setValue($con['value']);
                 $newCondition->setReferenceHandlingType($con['ref_handling']);
                 $newCondition->setObligatory($con['obligatory']);
 
                 // :TODO: not sure about this
                 $newCondition->setHiddenStatus(self::lookupPersistedHiddenStatusByTarget($a_src_ref_id));
 
                 if ($newCondition->storeCondition()) {
                     $valid++;
 
                     //Copy num_obligatory, to be checked below
                     self::saveNumberOfRequiredTriggers(
                         $a_target_ref_id,
                         $target_obj,
                         $con['num_obligatory']
                     );
                 }
             }
         }
         if ($valid) {
             $tgt_obj_id = ilObject::_lookupObjId($a_target_ref_id);
 
             // num_obligatory
             self::calculatePersistedRequiredTriggers(
                 $a_target_ref_id,
                 $tgt_obj_id,
                 ilObject::_lookupType($tgt_obj_id),
                 true
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilConditionHandler::delete ( int $a_ref_id )

delete all trigger and target entries This method is called from ilObject::delete() if an object os removed from trash

Definition at line 536 of file class.ilConditionHandler.php.

References $res.

                                          : void
     {
         $query = "DELETE FROM conditions WHERE " .
             "target_ref_id = " . $this->db->quote($a_ref_id, 'integer') . " " .
             "OR trigger_ref_id = " . $this->db->quote($a_ref_id, 'integer');
         $res = $this->db->manipulate($query);
     }

◆ deleteByObjId()

ilConditionHandler::deleteByObjId ( int $a_obj_id )

delete all trigger and target entries This method is called from ilObject::delete() if an object is removed from trash

Definition at line 548 of file class.ilConditionHandler.php.

References $res.

                                                 : void
     {
         $query = "DELETE FROM conditions WHERE " .
             "target_obj_id = " . $this->db->quote($a_obj_id, 'integer') . " " .
             "OR trigger_obj_id = " . $this->db->quote($a_obj_id, 'integer');
         $res = $this->db->manipulate($query);
     }

◆ deleteCondition()

ilConditionHandler::deleteCondition ( int $a_id )

Definition at line 556 of file class.ilConditionHandler.php.

References $res.

Referenced by storeCondition().

                                               : void
     {
         $query = "DELETE FROM conditions " .
             "WHERE condition_id = " . $this->db->quote($a_id, 'integer');
         $res = $this->db->manipulate($query);
     }

Here is the caller graph for this function:

◆ enableAutomaticValidation()

ilConditionHandler::enableAutomaticValidation ( bool $a_validate = true )

Definition at line 377 of file class.ilConditionHandler.php.

                                                                       : void
     {
         $this->validation = $a_validate;
     }

◆ getEffectiveOptionalConditionsOfTarget()

static ilConditionHandler::getEffectiveOptionalConditionsOfTarget	(	int	$a_target_ref_id,
		int	$a_target_obj_id,
		string	$a_obj_type = `''`
	)

static

Definition at line 869 of file class.ilConditionHandler.php.

Referenced by ilInfoScreenGUI\addPreconditionSection(), and ilObjectListGUI\parseConditions().

      : array {
         $conditions = self::_getEffectiveConditionsOfTarget($a_target_ref_id, $a_target_obj_id);
 
         $opt = array();
         foreach ($conditions as $con) {
             if ($con['obligatory']) {
                 continue;
             }
             $opt[] = $con;
         }
         return $opt;
     }

Here is the caller graph for this function:

◆ getErrorMessage()

ilConditionHandler::getErrorMessage ( )

Definition at line 254 of file class.ilConditionHandler.php.

References $error_message.

                                      : string
     {
         return $this->error_message;
     }

◆ getHiddenStatus()

ilConditionHandler::getHiddenStatus ( )

Definition at line 372 of file class.ilConditionHandler.php.

References $hidden_status.

Referenced by storeCondition().

                                      : bool
     {
         return $this->hidden_status;
     }

Here is the caller graph for this function:

◆ getNumberOfConditionsOfTrigger()

static ilConditionHandler::getNumberOfConditionsOfTrigger	(	string	$a_trigger_obj_type,
		int	$a_trigger_id
	)

static

get all conditions of trigger object

Definition at line 566 of file class.ilConditionHandler.php.

References $DIC, $res, ilDBConstants\FETCHMODE_OBJECT, ilDBInterface\query(), ilDBInterface\quote(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ilScormLP\checkSCORMPreconditions().

                                                                                                         : int
     {
         global $DIC;
         $db = $DIC->database();
 
         $query = 'select count(*) num from conditions ' .
             'where trigger_obj_id = ' . $db->quote($a_trigger_id, ilDBConstants::T_INTEGER) . ' ' .
             'and trigger_type = ' . $db->quote($a_trigger_obj_type, ilDBConstants::T_TEXT);
         $res = $db->query($query);
         $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
         return (int) $row->num;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObligatory()

ilConditionHandler::getObligatory ( )

Get obligatory status.

Definition at line 362 of file class.ilConditionHandler.php.

References $obligatory.

Referenced by storeCondition(), and updateCondition().

                                    : bool
     {
         return $this->obligatory;
     }

Here is the caller graph for this function:

◆ getOperator()

ilConditionHandler::getOperator ( )

Definition at line 336 of file class.ilConditionHandler.php.

Referenced by checkCircle(), checkExists(), storeCondition(), and updateCondition().

                                  : string
     {
         return $this->operator;
     }

Here is the caller graph for this function:

◆ getOperatorsByTriggerType()

ilConditionHandler::getOperatorsByTriggerType ( string $a_type )

Returns: string[]

Definition at line 419 of file class.ilConditionHandler.php.

References $DIC, $location, ilObjUserTracking\_enabledLearningProgress(), ilObjectDefinition\getClassName(), ilObjectDefinition\getLocation(), and ilObjectLP\isSupportedObjectType().

Referenced by getTriggerTypes().

                                                              : array
     {
         global $DIC;
 
         $objDefinition = $DIC['objDefinition'];
 
         if ($a_type === 'crsg') {
             return ['not_member'];
         }
 
         $class = $objDefinition->getClassName($a_type);
         $location = $objDefinition->getLocation($a_type);
         $full_class = "ilObj" . $class . "Access";
         $reflection = new ReflectionClass($full_class);
         if ($reflection->implementsInterface('ilConditionHandling')) {
             $operators = call_user_func(
                 array($full_class, 'getConditionOperators'),
                 $a_type
             );
         } else {
             $operators = [];
         }
 
         // Add operator lp
         if (ilObjUserTracking::_enabledLearningProgress()) {
             // only if object type has lp
 
             if (ilObjectLP::isSupportedObjectType($a_type)) {
                 array_unshift($operators, self::OPERATOR_LP);
             }
         }
         return $operators;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPersistedOptionalConditionsOfTarget()

static ilConditionHandler::getPersistedOptionalConditionsOfTarget	(	int	$a_target_ref_id,
		int	$a_target_obj_id,
		string	$a_obj_type = `''`
	)

static

Definition at line 886 of file class.ilConditionHandler.php.

Referenced by ilConditionHandlerGUI\adjustConditionsAfterDeletion(), ilConditionHandlerGUI\initCompulsoryForm(), ilConditionHandlerGUI\listConditions(), and ilConditionHandlerGUI\saveCompulsoryForm().

      : array {
         $conditions = self::_getPersistedConditionsOfTarget($a_target_ref_id, $a_target_obj_id);
 
         $opt = array();
         foreach ($conditions as $con) {
             if ($con['obligatory']) {
                 continue;
             }
             $opt[] = $con;
         }
         return $opt;
     }

Here is the caller graph for this function:

◆ getReferenceHandlingType()

ilConditionHandler::getReferenceHandlingType ( )

Definition at line 244 of file class.ilConditionHandler.php.

References $condition_reference_type.

Referenced by storeCondition(), and updateCondition().

                                               : int
     {
         return $this->condition_reference_type;
     }

Here is the caller graph for this function:

◆ getTargetObjId()

ilConditionHandler::getTargetObjId ( )

Definition at line 274 of file class.ilConditionHandler.php.

References $target_obj_id.

Referenced by checkExists(), and storeCondition().

                                     : int
     {
         return $this->target_obj_id;
     }

Here is the caller graph for this function:

◆ getTargetRefId()

ilConditionHandler::getTargetRefId ( )

Definition at line 264 of file class.ilConditionHandler.php.

References $target_ref_id.

Referenced by checkExists(), storeCondition(), updateCondition(), updateHiddenStatus(), and validate().

                                     : int
     {
         return $this->target_ref_id;
     }

Here is the caller graph for this function:

◆ getTargetType()

ilConditionHandler::getTargetType ( )

get target obj type

Definition at line 290 of file class.ilConditionHandler.php.

References $target_type.

Referenced by storeCondition().

                                    : string
     {
         return $this->target_type;
     }

Here is the caller graph for this function:

◆ getTriggerObjId()

ilConditionHandler::getTriggerObjId ( )

Definition at line 310 of file class.ilConditionHandler.php.

References $trigger_obj_id.

Referenced by checkExists(), and storeCondition().

                                      : int
     {
         return $this->trigger_obj_id;
     }

Here is the caller graph for this function:

◆ getTriggerRefId()

ilConditionHandler::getTriggerRefId ( )

Definition at line 300 of file class.ilConditionHandler.php.

References $trigger_ref_id.

Referenced by checkExists(), storeCondition(), and validate().

                                      : int
     {
         return $this->trigger_ref_id;
     }

Here is the caller graph for this function:

◆ getTriggerType()

ilConditionHandler::getTriggerType ( )

get trigger obj type

Definition at line 326 of file class.ilConditionHandler.php.

References $trigger_type.

Referenced by storeCondition().

                                     : string
     {
         return $this->trigger_type;
     }

Here is the caller graph for this function:

◆ getTriggerTypes()

ilConditionHandler::getTriggerTypes ( )

Definition at line 382 of file class.ilConditionHandler.php.

References Vendor\Package\$e, ilObjUserTracking\_enabledLearningProgress(), getOperatorsByTriggerType(), ilObjectLP\isSupportedObjectType(), and ILIAS\Repository\logger().

                                      : array
     {
         $trigger_types = array('crs', 'exc', 'tst', 'sahs', 'svy', 'lm', 'iass', 'prg', 'copa', 'lti', 'cmix');
 
         // Add operator lp trigger
         if (ilObjUserTracking::_enabledLearningProgress()) {
             // only if object type has lp
             foreach ($this->objDefinition->getAllRepositoryTypes() as $t) {
                 if (ilObjectLP::isSupportedObjectType($t) && !in_array($t, $trigger_types, true)) {
                     $trigger_types[] = $t;
                 }
             }
         }
         foreach ($this->objDefinition->getPlugins() as $p_type => $p_info) {
             try {
                 $name = 'ilObj' . $p_info['class_name'] . 'Access';
                 $reflection = new ReflectionClass($name);
                 if ($reflection->implementsInterface('ilConditionHandling')) {
                     $trigger_types[] = $p_type;
                 }
             } catch (ReflectionException $e) {
                 $this->logger->warning('Cannot create instance for ' . $name);
                 $this->logger->warning($e->getMessage());
             }
         }
         $active_triggers = array();
         foreach ($trigger_types as $type) {
             if (count($this->getOperatorsByTriggerType($type))) {
                 $active_triggers[] = $type;
             }
         }
         return $active_triggers;
     }

Here is the call graph for this function:

◆ getValue()

ilConditionHandler::getValue ( )

Definition at line 346 of file class.ilConditionHandler.php.

References $value.

Referenced by storeCondition(), and updateCondition().

                               : string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ lookupObligatoryConditionsOfTarget()

static ilConditionHandler::lookupObligatoryConditionsOfTarget	(	int	$a_target_ref_id,
		int	$a_target_obj_id
	)

static

Definition at line 903 of file class.ilConditionHandler.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilConditionHandlerGUI\adjustConditionsAfterDeletion(), ilConditionHandlerGUI\initCompulsoryForm(), and ilConditionHandlerGUI\showObligatoryForm().

                                                                                                          : int
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = 'SELECT max(num_obligatory) obl from conditions WHERE ' .
             'target_ref_id = ' . $ilDB->quote($a_target_ref_id, 'integer') . ' ' .
             'AND target_obj_id = ' . $ilDB->quote($a_target_obj_id, 'integer') . ' ' .
             'GROUP BY (num_obligatory)';
         $res = $ilDB->query($query);
 
         $obl = 0;
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $obl = (int) $row->obl;
         }
         return $obl;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupPersistedHiddenStatusByTarget()

static ilConditionHandler::lookupPersistedHiddenStatusByTarget ( int $a_target_ref_id )

static

Definition at line 177 of file class.ilConditionHandler.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilConditionHandlerGUI\assign(), ilConditionHandlerGUI\initCompulsoryForm(), ilConditionHandlerGUI\saveConditionTrigger(), and ilConditionHandlerGUI\showObligatoryForm().

                                                                                     : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'SELECT hidden_status FROM conditions ' .
             'WHERE target_ref_id = ' . $ilDB->quote($a_target_ref_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return (bool) $row->hidden_status;
         }
         return false;
     }

Here is the caller graph for this function:

◆ preloadPersistedConditionsForTargetRecords()

static ilConditionHandler::preloadPersistedConditionsForTargetRecords	(	string	$a_type,
		array	$a_obj_ids
	)

static

Parameters

int[] $a_obj_ids

Definition at line 759 of file class.ilConditionHandler.php.

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

Referenced by ilObjectListGUIPreloader\preload().

                                                                                                        : void
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         if (is_array($a_obj_ids) && count($a_obj_ids) > 0) {
             $res = $ilDB->query("SELECT * FROM conditions " .
                 "WHERE " . $ilDB->in("target_obj_id", $a_obj_ids, false, "integer") .
                 " AND target_type = " . $ilDB->quote($a_type, 'text'));
             $rows = array();
             while ($row = $ilDB->fetchAssoc($res)) {
                 $item = [];
                 $item['condition_id'] = (int) $row['condition_id'];
                 $item['target_ref_id'] = (int) $row['target_ref_id'];
                 $item['target_obj_id'] = (int) $row['target_obj_id'];
                 $item['trigger_ref_id'] = (int) $row['trigger_ref_id'];
                 $item['trigger_obj_id'] = (int) $row['trigger_obj_id'];
                 $item['target_type'] = (string) $row['target_type'];
                 $item['trigger_type'] = (string) $row['trigger_type'];
                 $item['operator'] = (string) $row['operator'];
                 $item['value'] = (string) $row['value'];
                 $item['ref_handling'] = (int) $row['ref_handling'];
                 $item['obligatory'] = (bool) $row['obligatory'];
                 $item['num_obligatory'] = (int) $row['num_obligatory'];
                 $item['hidden_status'] = (bool) $row['hidden_status'];
                 self::$cond_target_rows[$a_type . ":" . $row["target_obj_id"]][] = $item;
             }
             // init obj ids without any record
             foreach ($a_obj_ids as $obj_id) {
                 if (!isset(self::$cond_target_rows[$a_type . ":" . $obj_id])) {
                     self::$cond_target_rows[$a_type . ":" . $obj_id] = array();
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCache()

static ilConditionHandler::resetCache ( )

static

Definition at line 133 of file class.ilConditionHandler.php.

                                        : void
     {
         self::$cond_for_target_cache = [];
         self::$cond_target_rows = [];
     }

◆ saveNumberOfRequiredTriggers()

static ilConditionHandler::saveNumberOfRequiredTriggers	(	int	$a_target_ref_id,
		int	$a_target_obj_id,
		int	$a_num
	)

static

Definition at line 994 of file class.ilConditionHandler.php.

References $DIC, and $ilDB.

Referenced by ilConditionHandlerGUI\adjustConditionsAfterDeletion(), and ilConditionHandlerGUI\saveCompulsoryForm().

                                                                                                                : void
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = 'UPDATE conditions ' .
             'SET num_obligatory = ' . $ilDB->quote($a_num, 'integer') . ' ' .
             'WHERE target_ref_id = ' . $ilDB->quote($a_target_ref_id, 'integer') . ' ' .
             'AND target_obj_id = ' . $ilDB->quote($a_target_obj_id, 'integer');
 
         $ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ setErrorMessage()

ilConditionHandler::setErrorMessage ( string $a_msg )

Definition at line 249 of file class.ilConditionHandler.php.

Referenced by validate().

                                                   : void
     {
         $this->error_message = $a_msg;
     }

Here is the caller graph for this function:

◆ setHiddenStatus()

ilConditionHandler::setHiddenStatus ( bool $a_status )

Definition at line 367 of file class.ilConditionHandler.php.

                                                    : void
     {
         $this->hidden_status = $a_status;
     }

◆ setObligatory()

ilConditionHandler::setObligatory ( bool $a_obl )

Set obligatory status.

Definition at line 354 of file class.ilConditionHandler.php.

                                               : void
     {
         $this->obligatory = $a_obl;
     }

◆ setOperator()

ilConditionHandler::setOperator ( string $a_operator )

Definition at line 331 of file class.ilConditionHandler.php.

                                                    : void
     {
         $this->operator = $a_operator;
     }

◆ setReferenceHandlingType()

ilConditionHandler::setReferenceHandlingType ( int $a_type )

Definition at line 239 of file class.ilConditionHandler.php.

                                                          : void
     {
         $this->condition_reference_type = $a_type;
     }

◆ setTargetObjId()

ilConditionHandler::setTargetObjId ( int $a_target_obj_id )

Definition at line 269 of file class.ilConditionHandler.php.

                                                         : void
     {
         $this->target_obj_id = $a_target_obj_id;
     }

◆ setTargetRefId()

ilConditionHandler::setTargetRefId ( int $a_target_ref_id )

Definition at line 259 of file class.ilConditionHandler.php.

                                                         : void
     {
         $this->target_ref_id = $a_target_ref_id;
     }

◆ setTargetType()

ilConditionHandler::setTargetType ( string $a_target_type )

set target object type

Definition at line 282 of file class.ilConditionHandler.php.

                                                         : void
     {
         $this->target_type = $a_target_type;
     }

◆ setTriggerObjId()

ilConditionHandler::setTriggerObjId ( int $a_trigger_obj_id )

Definition at line 305 of file class.ilConditionHandler.php.

                                                           : void
     {
         $this->trigger_obj_id = $a_trigger_obj_id;
     }

◆ setTriggerRefId()

ilConditionHandler::setTriggerRefId ( int $a_trigger_ref_id )

Definition at line 295 of file class.ilConditionHandler.php.

                                                           : void
     {
         $this->trigger_ref_id = $a_trigger_ref_id;
     }

◆ setTriggerType()

ilConditionHandler::setTriggerType ( string $a_trigger_type )

set trigger object type

Definition at line 318 of file class.ilConditionHandler.php.

                                                           : void
     {
         $this->trigger_type = $a_trigger_type;
     }

◆ setValue()

ilConditionHandler::setValue ( string $a_value )

Definition at line 341 of file class.ilConditionHandler.php.

                                              : void
     {
         $this->value = $a_value;
     }

◆ storeCondition()

ilConditionHandler::storeCondition ( )

store new condition in database

Definition at line 456 of file class.ilConditionHandler.php.

References $res, deleteCondition(), getHiddenStatus(), getObligatory(), getOperator(), getReferenceHandlingType(), getTargetObjId(), getTargetRefId(), getTargetType(), getTriggerObjId(), getTriggerRefId(), getTriggerType(), getValue(), and validate().

                                     : bool
     {
         // first insert, then validate: it's easier to check for circles if the new condition is in the db table
         $next_id = $this->db->nextId('conditions');
         $query = 'INSERT INTO conditions (condition_id,target_ref_id,target_obj_id,target_type,' .
             'trigger_ref_id,trigger_obj_id,trigger_type,operator,value,ref_handling,obligatory,hidden_status) ' .
             'VALUES (' .
             $this->db->quote($next_id, 'integer') . ',' .
             $this->db->quote($this->getTargetRefId(), 'integer') . "," .
             $this->db->quote($this->getTargetObjId(), 'integer') . "," .
             $this->db->quote($this->getTargetType(), 'text') . "," .
             $this->db->quote($this->getTriggerRefId(), 'integer') . "," .
             $this->db->quote($this->getTriggerObjId(), 'integer') . "," .
             $this->db->quote($this->getTriggerType(), 'text') . "," .
             $this->db->quote($this->getOperator(), 'text') . "," .
             $this->db->quote($this->getValue(), 'text') . ", " .
             $this->db->quote($this->getReferenceHandlingType(), 'integer') . ', ' .
             $this->db->quote($this->getObligatory(), 'integer') . ', ' .
             $this->db->quote($this->getHiddenStatus(), 'integer') . ' ' .
             ')';
 
         $res = $this->db->manipulate($query);
 
         if ($this->validation && !$this->validate()) {
             $this->deleteCondition($next_id);
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ updateCondition()

ilConditionHandler::updateCondition ( int $a_id )

Definition at line 498 of file class.ilConditionHandler.php.

References $res, getObligatory(), getOperator(), getReferenceHandlingType(), getTargetRefId(), and getValue().

                                               : void
     {
         $query = "UPDATE conditions SET " .
             "target_ref_id = " . $this->db->quote($this->getTargetRefId(), 'integer') . ", " .
             "operator = " . $this->db->quote($this->getOperator(), 'text') . ", " .
             "value = " . $this->db->quote($this->getValue(), 'text') . ", " .
             "ref_handling = " . $this->db->quote($this->getReferenceHandlingType(), 'integer') . ", " .
             'obligatory = ' . $this->db->quote($this->getObligatory(), 'integer') . ' ' .
             "WHERE condition_id = " . $this->db->quote($a_id, 'integer');
         $res = $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ updateHiddenStatus()

ilConditionHandler::updateHiddenStatus ( bool $a_status )

Definition at line 510 of file class.ilConditionHandler.php.

References getTargetRefId().

                                                       : void
     {
         $query = 'UPDATE conditions SET ' .
             'hidden_status = ' . $this->db->quote($a_status, 'integer') . ' ' .
             'WHERE target_ref_id = ' . $this->db->quote($this->getTargetRefId(), 'integer');
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ updateObligatory()

static ilConditionHandler::updateObligatory	(	int	$a_id,
		bool	$a_status
	)

static

Toggle condition obligatory status.

Definition at line 521 of file class.ilConditionHandler.php.

References $DIC, $ilDB, and $res.

Referenced by ilConditionHandlerGUI\adjustConditionsAfterDeletion(), ilConditionHandlerGUI\saveCompulsoryForm(), and ilConditionHandlerGUI\saveCompulsoryStatus().

                                                                       : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = "UPDATE conditions SET " .
             'obligatory = ' . $ilDB->quote($a_status, 'integer') . ' ' .
             "WHERE condition_id = " . $ilDB->quote($a_id, 'integer');
         $res = $ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ validate()

ilConditionHandler::validate ( )

protected

Definition at line 1061 of file class.ilConditionHandler.php.

References checkCircle(), ilObjectFactory\getInstanceByRefId(), getTargetRefId(), getTriggerRefId(), ILIAS\Repository\lng(), null, and setErrorMessage().

Referenced by storeCondition().

                                  : bool
     {
         // check if obj_id is already assigned
         $trigger_obj = ilObjectFactory::getInstanceByRefId($this->getTriggerRefId());
         $target_obj = ilObjectFactory::getInstanceByRefId($this->getTargetRefId());
 
         if ($trigger_obj !== null && $target_obj !== null) {
             // check for circle
             $this->target_obj_id = $target_obj->getId();
 
             if ($this->checkCircle($this->getTargetRefId(), $target_obj->getId())) {
                 $this->setErrorMessage($this->lng->txt('condition_circle_created'));
 
                 unset($trigger_obj, $target_obj);
                 return false;
             }
             return true;
         }
         return false;
     }