Handles conditions for accesses to different ILIAS objects. More...

Collaboration diagram for ilConditionHandler:

Public Member Functions
	__construct ()
	constructor @access public More...

	setReferenceHandlingType ($a_type)
	set reference handling type More...

	getReferenceHandlingType ()
	get reference handling type More...

	setErrorMessage ($a_msg)

	getErrorMessage ()

	setTargetRefId ($a_target_ref_id)
	set target ref id More...

	getTargetRefId ()
	get target ref id More...

	setTargetObjId ($a_target_obj_id)
	set target object id More...

	getTargetObjId ()
	get target obj id More...

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

	getTargetType ()
	get target obj type More...

	setTriggerRefId ($a_trigger_ref_id)
	set trigger ref id More...

	getTriggerRefId ()
	get target ref id More...

	setTriggerObjId ($a_trigger_obj_id)
	set trigger object id More...

	getTriggerObjId ()
	get trigger obj id More...

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

	getTriggerType ()
	get trigger obj type More...

	setOperator ($a_operator)
	set operator More...

	getOperator ()
	get operator More...

	setValue ($a_value)
	set value More...

	getValue ()
	get value More...

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

	getObligatory ()
	Get obligatory status. More...

	setHiddenStatus ($a_status)

	getHiddenStatus ()

	enableAutomaticValidation ($a_validate=true)
	enable automated validation More...

	getTriggerTypes ()
	get all possible trigger types NOT STATIC @access public More...

	getOperatorsByTargetType ($a_type)
	Get operators by target type. More...

	storeCondition ()
	store new condition in database NOT STATIC @access public More...

	checkExists ()

	updateCondition ($a_id)
	update condition More...

	updateHiddenStatus ($a_status)
	Update hidden status @global type $ilDB. More...

	delete ($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 ($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 ($a_id)
	delete condition More...

	preloadConditionsForTargetRecords ($a_type, $a_obj_ids)
	Preload conditions for target records. More...

	_getCondition ($a_id)

	_checkCondition ($a_id, $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...

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

	validate ()

	checkCircle ($a_ref_id, $a_obj_id)

Static Public Member Functions
static	_isReferenceHandlingOptional ($a_type)
	is reference handling optional More...

static	lookupHiddenStatusByTarget ($a_target_ref_id)
	Lookup hidden status @global type $ilDB. More...

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

static	_getDistinctTargetRefIds ()
	Get all target ref ids. More...

static	_deleteTargetConditionsByRefId ($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...

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

	_getConditionsOfTrigger ($a_trigger_obj_type, $a_trigger_id)
	get all conditions of trigger object More...

static	_getConditionsOfTarget ($a_target_ref_id, $a_target_obj_id, $a_target_type="")
	get all conditions of target object More...

static	getOptionalConditionsOfTarget ($a_target_ref_id, $a_target_obj_id, $a_obj_type='')
	Get optional conditions. More...

static	calculateRequiredTriggers ($a_target_ref_id, $a_target_obj_id, $a_target_obj_type='', $a_force_update=false)
	calculate number of obligatory items More...

static	saveNumberOfRequiredTriggers ($a_target_ref_id, $a_target_obj_id, $a_num)
	Save number of obigatory triggers. More...

static	cloneDependencies ($a_src_ref_id, $a_target_ref_id, $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	UNIQUE_CONDITIONS = 1

const	SHARED_CONDITIONS = 0

	$db

	$lng

	$error_message

	$target_obj_id

	$target_ref_id

	$target_type

	$trigger_obj_id

	$trigger_ref_id

	$trigger_type

	$operator

	$value

	$validation

	$conditions

Static Public Attributes
static	$cond_for_target_cache = array()

static	$cond_target_rows = array()

Private Attributes
	$obligatory = true

	$hidden_status = FALSE

Detailed Description

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" | "qst", ... trigger_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" | "pg", ... target_id object or reference id of target object

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 66 of file class.ilConditionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilConditionHandler::__construct ( )

constructor @access public

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

        {
                global $ilDB,$lng;
 
                $this->db =& $ilDB;
                $this->lng =& $lng;
                $this->validation = true;
        }

References $ilDB, and $lng.

Member Function Documentation

◆ _adjustMovedObjectConditions()

static ilConditionHandler::_adjustMovedObjectConditions ( $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

@access public

Parameters

int	reference id of moved object

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

        {
                global $tree;
                
                if($tree->checkForParentType($a_ref_id,'crs'))
                {
                        // Nothing to do
                        return true;
                }
                
                // Need another implementation that has better performance
                $childs = $tree->getSubTree($tree->getNodeData($a_ref_id),false);
                $conditions = self::_getDistinctTargetRefIds();
                
                foreach(array_intersect($conditions,$childs) as $target_ref)
                {
                        if(!$tree->checkForParentType($target_ref,'crs'))
                        {
                                self::_deleteTargetConditionsByRefId($target_ref);
                        }
                }
                return true;
        }

References $conditions, _deleteTargetConditionsByRefId(), and _getDistinctTargetRefIds().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkAllConditionsOfTarget()

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

checks wether all conditions of a target object are fulfilled

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

        {
                global $ilBench,$ilUser,$tree;
                
                $a_usr_id = $a_usr_id ? $a_usr_id : $ilUser->getId();
 
                $conditions = ilConditionHandler::_getConditionsOfTarget($a_target_ref_id,$a_target_id, $a_target_type);
 
                if(!count($conditions))
                {
                        return true;
                }
 
                // @todo check this
                include_once './Services/Container/classes/class.ilMemberViewSettings.php';
                if(ilMemberViewSettings::getInstance()->isActive())
                {
                        return true;
                }
 
                // First check obligatory conditions
                $optional = self::getOptionalConditionsOfTarget($a_target_ref_id, $a_target_id, $a_target_type);
                $num_required = self::calculateRequiredTriggers($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 = ilConditionHandler::_checkCondition($condition['id'],$a_usr_id);
 
                        if($check)
                        {
                                ++$passed;
                                if($passed >= $num_required)
                                {
                                        return true;
                                }
                        }
                        else
                        {
                                if(!count($optional))
                                {
                                        return false;
                                }
                        }
                }
                // not all optional conditions passed
                return false;
        }

References $conditions, $ilBench, $ilUser, _checkCondition(), _getConditionsOfTarget(), calculateRequiredTriggers(), ilMemberViewSettings\getInstance(), and getOptionalConditionsOfTarget().

Referenced by ilObjContentObject\_checkPreconditionsOfPage(), ilContainerObjectiveGUI\addItemDetails(), ilAccessHandler\doConditionCheck(), ilRepositoryExplorerGUI\getChildsOfNode(), ilObjCourseListGUI\initItem(), ilObjCourseReferenceListGUI\initItem(), ilRepositoryExplorer\isClickable(), ilRepositoryExplorerGUI\isNodeClickable(), ilRepositoryExplorer\showChilds(), and ilCourseContentGUI\showStartObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkCondition()

ilConditionHandler::_checkCondition	(	$a_id,
		$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)

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

        {
                global $ilUser, $objDefinition;
                
                $a_usr_id = $a_usr_id ? $a_usr_id : $ilUser->getId();
                
                $condition = ilConditionHandler::_getCondition($a_id);
                
                // check lp 
                if($condition['operator'] == self::OPERATOR_LP)
                {
                        include_once './Services/Tracking/classes/class.ilLPStatus.php';
                        return ilLPStatus::_hasUserCompleted($condition['trigger_obj_id'], $a_usr_id);
                }
                
                switch($condition['trigger_type'])
                {
                        case 'crsg':
                                include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
                                return ilObjCourseGrouping::_checkCondition($condition['trigger_obj_id'],$condition['operator'],$condition['value'],$a_usr_id);
                }
                
                $class = $objDefinition->getClassName($condition['trigger_type']);
                $location = $objDefinition->getLocation($condition['trigger_type']);
                $full_class = "ilObj".$class."Access";
                include_once($location."/class.".$full_class.".php");
 
                $fullfilled = call_user_func(
                                array($full_class, 'checkCondition'),
                                $condition['trigger_obj_id'],
                                $condition['operator'],
                                $condition['value'],
                                $a_usr_id
                );
                return $fullfilled;
        }

References $ilUser, $location, ilObjCourseGrouping\_checkCondition(), _getCondition(), and ilLPStatus\_hasUserCompleted().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _deleteTargetConditionsByRefId()

static ilConditionHandler::_deleteTargetConditionsByRefId ( $a_target_ref_id )

static

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

@access public

Parameters

int	ref id of target

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

        {
                global $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;
        }

References $ilDB, $query, and $res.

Referenced by _adjustMovedObjectConditions(), and ilRBACTest\testConditions().

Here is the caller graph for this function:

◆ _getCondition()

ilConditionHandler::_getCondition ( $a_id )

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

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by _checkCondition(), ilConditionHandlerGUI\askDelete(), ilConditionHandlerGUI\edit(), ilConditionHandlerGUI\initFormCondition(), ilRBACTest\testConditions(), and ilConditionHandlerGUI\updateCondition().

Here is the caller graph for this function:

◆ _getConditionsOfTarget()

static ilConditionHandler::_getConditionsOfTarget	(	$a_target_ref_id,
		$a_target_obj_id,
		$a_target_type = `""`
	)

static

get all conditions of target object

Parameters

$a_target_ref_id	target reference id
$a_target_obj_id	target object id
$a_target_type	target object type (must be provided only if object is not derived from ilObject and therefore stored in object_data; this is e.g. the case for chapters (type = "st"))

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

        {
                global $ilDB, $ilBench;
 
                // 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))
                        {
                                $rows[] = $row;
                        }
                }
 
                reset($rows);
                $conditions = array();
                foreach ($rows as $row)
                {
                        if ($row["ref_handling"] == self::UNIQUE_CONDITIONS)
                        {
                                if ($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;
        }

References $conditions, $ilBench, $ilDB, $query, $res, $row, and ilObject\_lookupType().

Referenced by ilConditionHandlerGUI\__getConditionsOfTarget(), _checkAllConditionsOfTarget(), ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGrouping\_getGroupingCourseIds(), ilObjCourseGrouping\_getGroupingItems(), ilObjContentObject\_getMissingPreconditionsOfPage(), ilObjContentObject\_getMissingPreconditionsTopChapter(), calculateRequiredTriggers(), checkCircle(), cloneDependencies(), ilAccessHandler\doConditionCheck(), getOptionalConditionsOfTarget(), ilObjectListGUI\insertPreconditions(), ilConditionHandlerGUI\listConditions(), ilConditionHandlerGUI\saveObligatoryList(), ilConditionHandlerGUI\saveObligatorySettings(), ilConditionHandlerGUI\showObligatoryForm(), and ilRBACTest\testConditions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getConditionsOfTrigger()

ilConditionHandler::_getConditionsOfTrigger	(	$a_trigger_obj_type,
		$a_trigger_id
	)

static

get all conditions of trigger object

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

        {
                global $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);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $tmp_array['id']                        = $row->condition_id;
                        $tmp_array['target_ref_id'] = $row->target_ref_id;
                        $tmp_array['target_obj_id'] = $row->target_obj_id;
                        $tmp_array['target_type']       = $row->target_type;
                        $tmp_array['trigger_ref_id'] = $row->trigger_ref_id;
                        $tmp_array['trigger_obj_id'] = $row->trigger_obj_id;
                        $tmp_array['trigger_type']      = $row->trigger_type;
                        $tmp_array['operator']          = $row->operator;
                        $tmp_array['value']                     = $row->value;
                        $tmp_array['ref_handling']  = $row->ref_handling;
                        $tmp_array['obligatory']        = $row->obligatory;
                        $tmp_array['hidden_status'] = $row->hidden_status;
 
                        $conditions[] = $tmp_array;
                        unset($tmp_array);
                }
 
                return $conditions ? $conditions : array();
        }

References $conditions, $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGrouping\_getGroupingCourseIds(), ilObjCourseGrouping\_getGroupingItems(), ilScormLP\checkSCORMPreconditions(), ilObjCourseGrouping\deassign(), ilObjCourseGrouping\getAssignedItems(), and ilRBACTest\testConditions().

Here is the caller graph for this function:

◆ _getDistinctTargetRefIds()

static ilConditionHandler::_getDistinctTargetRefIds ( )

static

Get all target ref ids.

@access public

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

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by _adjustMovedObjectConditions(), and ilRBACTest\testConditions().

Here is the caller graph for this function:

◆ _isReferenceHandlingOptional()

static ilConditionHandler::_isReferenceHandlingOptional ( $a_type )

static

is reference handling optional

@access public

Parameters

string target type ILIAS obj type

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

        {
                switch($a_type)
                {
                        case 'st':
                                return true;
                        
                        default:
                                return false;
                }
        }

Referenced by ilConditionHandlerGUI\initFormCondition().

Here is the caller graph for this function:

◆ calculateRequiredTriggers()

static ilConditionHandler::calculateRequiredTriggers	(	$a_target_ref_id,
		$a_target_obj_id,
		$a_target_obj_type = `''`,
		$a_force_update = `false`
	)

static

calculate number of obligatory items

Parameters

int	$a_target_ref_id
int	$a_target_obj_id

Returns: int

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

        {
                global $ilDB;
 
                // Get all conditions
                $all = self::_getConditionsOfTarget($a_target_ref_id,$a_target_obj_id,$a_target_obj_type);
                $opt = self::getOptionalConditionsOfTarget($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 and
                        $set_obl < count($all) and
                        $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;
        }

References $ilDB, $result, _getConditionsOfTarget(), getOptionalConditionsOfTarget(), and saveNumberOfRequiredTriggers().

Referenced by _checkAllConditionsOfTarget(), cloneDependencies(), ilObjectListGUI\parseConditions(), ilConditionHandlerGUI\saveObligatoryList(), and ilConditionHandlerGUI\showObligatoryForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkCircle()

ilConditionHandler::checkCircle	(	$a_ref_id,
		$a_obj_id
	)

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

        {
                foreach(ilConditionHandler::_getConditionsOfTarget($a_ref_id,$a_obj_id) as $condition)
                {
                        if($condition['trigger_obj_id'] == $this->target_obj_id and $condition['operator'] == $this->getOperator())
                        {
                                $this->circle = true;
                                break;
                        }
                        else
                        {
                                $this->checkCircle($condition['trigger_ref_id'],$condition['trigger_obj_id']);
                        }
                }
                return $this->circle;
        }

References _getConditionsOfTarget(), checkCircle(), and getOperator().

Referenced by checkCircle(), and validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkExists()

ilConditionHandler::checkExists ( )

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

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

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

Here is the call graph for this function:

◆ cloneDependencies()

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

static

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

        {               
                include_once './Services/CopyWizard/classes/class.ilCopyWizardOptions.php';
                $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
                $mappings = $cwo->getMappings();
 
                $valid = 0;
                $conditions = ilConditionHandler::_getConditionsOfTarget($a_src_ref_id, ilObject::_lookupObjId($a_src_ref_id));
                foreach($conditions as $con)
                {
                        if($mappings[$con['trigger_ref_id']])
                        {
                                $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::lookupHiddenStatusByTarget($a_src_ref_id));
                                
                                if($newCondition->storeCondition())
                                {
                                        $valid++;
                                }
                        }
                }
                if($valid)
                {
                        $tgt_obj_id = ilObject::_lookupObjId($a_target_ref_id);
                        
                        // num_obligatory
                        self::calculateRequiredTriggers($a_target_ref_id, $tgt_obj_id, ilObject::_lookupType($tgt_obj_id), true);
                }
        }

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

Referenced by ilObject\cloneDependencies().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilConditionHandler::delete ( $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 629 of file class.ilConditionHandler.php.

        {
                global $ilDB;
                
                $query = "DELETE FROM conditions WHERE ".
                        "target_ref_id = ".$ilDB->quote($a_ref_id,'integer')." ".
                        "OR trigger_ref_id = ".$ilDB->quote($a_ref_id,'integer');
                $res = $ilDB->manipulate($query);
 
                return true;
        }

References $ilDB, $query, and $res.

◆ deleteByObjId()

ilConditionHandler::deleteByObjId ( $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 644 of file class.ilConditionHandler.php.

        {
                global $ilDB;
                
                $query = "DELETE FROM conditions WHERE ".
                        "target_obj_id = ".$ilDB->quote($a_obj_id,'integer')." ".
                        "OR trigger_obj_id = ".$ilDB->quote($a_obj_id,'integer');
                $res = $ilDB->manipulate($query);
 
                return true;
        }

References $ilDB, $query, and $res.

◆ deleteCondition()

ilConditionHandler::deleteCondition ( $a_id )

delete condition

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

        {
                global $ilDB;
 
                $query = "DELETE FROM conditions ".
                        "WHERE condition_id = ".$ilDB->quote($a_id,'integer');
                $res = $ilDB->manipulate($query);
 
                return true;
        }

References $ilDB, $query, and $res.

Referenced by storeCondition().

Here is the caller graph for this function:

◆ enableAutomaticValidation()

ilConditionHandler::enableAutomaticValidation ( $a_validate = true )

enable automated validation

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

        {
                $this->validation = $a_validate;
        }

◆ getErrorMessage()

ilConditionHandler::getErrorMessage ( )

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

        {
                return $this->error_message;
        }

References $error_message.

◆ getHiddenStatus()

ilConditionHandler::getHiddenStatus ( )

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

        {
                return $this->hidden_status;
        }

References $hidden_status.

Referenced by storeCondition().

Here is the caller graph for this function:

◆ getObligatory()

ilConditionHandler::getObligatory ( )

Get obligatory status.

Returns: obligatory status

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

        {
                return (bool) $this->obligatory;
        }

References $obligatory.

Referenced by storeCondition(), and updateCondition().

Here is the caller graph for this function:

◆ getOperator()

ilConditionHandler::getOperator ( )

get operator

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

        {
                return $this->operator;
        }

References $operator.

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

Here is the caller graph for this function:

◆ getOperatorsByTargetType()

ilConditionHandler::getOperatorsByTargetType ( $a_type )

Get operators by target type.

Parameters

string $a_type

Returns: type

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

        {
                global $objDefinition;
                
                switch($a_type)
                {
                        case 'crsg':
                                return array('not_member');
                }
                
                $class = $objDefinition->getClassName($a_type);
                $location = $objDefinition->getLocation($a_type);
                $full_class = "ilObj".$class."Access";
                include_once($location."/class.".$full_class.".php");
                
                include_once './Services/AccessControl/interfaces/interface.ilConditionHandling.php';
                
                $reflection = new ReflectionClass($full_class);
                if(!$reflection->implementsInterface('ilConditionHandling'))
                {
                        return array();
                }
                
                
                $operators = call_user_func(
                                array($full_class, 'getConditionOperators'),
                                $a_type
                );
                
                // Add operator lp 
                include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
                if(ilObjUserTracking::_enabledLearningProgress())
                {
                        // only if object type has lp
                        include_once("Services/Object/classes/class.ilObjectLP.php");
                        if(ilObjectLP::isSupportedObjectType($a_type))
                        {                       
                                array_unshift($operators,self::OPERATOR_LP);
                        }
                }
                return $operators;
        }

References $location, ilObjUserTracking\_enabledLearningProgress(), and ilObjectLP\isSupportedObjectType().

Referenced by getTriggerTypes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOptionalConditionsOfTarget()

static ilConditionHandler::getOptionalConditionsOfTarget	(	$a_target_ref_id,
		$a_target_obj_id,
		$a_obj_type = `''`
	)

static

Get optional conditions.

Parameters

int	$a_target_ref_id
int	$a_target_obj_id

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

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

References $conditions, and _getConditionsOfTarget().

Referenced by _checkAllConditionsOfTarget(), calculateRequiredTriggers(), ilConditionHandlerGUI\listConditions(), ilObjectListGUI\parseConditions(), ilConditionHandlerGUI\saveObligatorySettings(), and ilConditionHandlerGUI\showObligatoryForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReferenceHandlingType()

ilConditionHandler::getReferenceHandlingType ( )

get reference handling type

@access public

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

        {
                return (int) $this->condition_reference_type;
        }

Referenced by storeCondition(), and updateCondition().

Here is the caller graph for this function:

◆ getTargetObjId()

ilConditionHandler::getTargetObjId ( )

get target obj id

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

        {
                return $this->target_obj_id;
        }

References $target_obj_id.

Referenced by checkExists(), and storeCondition().

Here is the caller graph for this function:

◆ getTargetRefId()

ilConditionHandler::getTargetRefId ( )

get target ref id

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

        {
                return $this->target_ref_id;
        }

References $target_ref_id.

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

Here is the caller graph for this function:

◆ getTargetType()

ilConditionHandler::getTargetType ( )

get target obj type

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

        {
                return $this->target_type;
        }

References $target_type.

Referenced by storeCondition().

Here is the caller graph for this function:

◆ getTriggerObjId()

ilConditionHandler::getTriggerObjId ( )

get trigger obj id

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

        {
                return $this->trigger_obj_id;
        }

References $trigger_obj_id.

Referenced by checkExists(), and storeCondition().

Here is the caller graph for this function:

◆ getTriggerRefId()

ilConditionHandler::getTriggerRefId ( )

get target ref id

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

        {
                return $this->trigger_ref_id;
        }

References $trigger_ref_id.

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

Here is the caller graph for this function:

◆ getTriggerType()

ilConditionHandler::getTriggerType ( )

get trigger obj type

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

        {
                return $this->trigger_type;
        }

References $trigger_type.

Referenced by storeCondition().

Here is the caller graph for this function:

◆ getTriggerTypes()

ilConditionHandler::getTriggerTypes ( )

get all possible trigger types NOT STATIC @access public

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

        {
                global $objDefinition;
                
                $trigger_types =  array('crs','exc','tst','sahs', 'svy', 'lm');
 
                foreach($objDefinition->getPlugins() as $p_type => $p_info)
                {
                        if(@include_once $p_info['location'].'/class.ilObj'.$p_info['class_name'].'Access.php')
                        {
                                include_once './Services/AccessControl/interfaces/interface.ilConditionHandling.php';
                                $name = 'ilObj'.$p_info['class_name'].'Access';
                                $refection = new ReflectionClass($name);
                                if($refection->implementsInterface('ilConditionHandling'))
                                {
                                        $trigger_types[] = $p_type;
                                }
                        }
                }
                
                
                $active_triggers = array();
                foreach($trigger_types as $type)
                {
                        if(count($this->getOperatorsByTargetType($type)))
                        {
                                $active_triggers[] = $type;
                        }
                }
                
                
                
                
                return $active_triggers;
        }

References getOperatorsByTargetType().

Here is the call graph for this function:

◆ getValue()

ilConditionHandler::getValue ( )

get value

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

        {
                return $this->value;
        }

References $value.

Referenced by storeCondition(), and updateCondition().

Here is the caller graph for this function:

◆ lookupHiddenStatusByTarget()

static ilConditionHandler::lookupHiddenStatusByTarget ( $a_target_ref_id )

static

Lookup hidden status @global type $ilDB.

Parameters

type $a_target_ref_id

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

        {
                global $ilDB;
                
                $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(DB_FETCHMODE_OBJECT))
                {
                        return $row->hidden_status;
                }
                return FALSE;
        }

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilConditionHandlerGUI\assign(), ilAccessHandler\doConditionCheck(), and ilConditionHandlerGUI\showObligatoryForm().

Here is the caller graph for this function:

◆ preloadConditionsForTargetRecords()

ilConditionHandler::preloadConditionsForTargetRecords	(	$a_type,
		$a_obj_ids
	)

Preload conditions for target records.

Parameters

return

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

        {
                global $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))
                        {
                                self::$cond_target_rows[$a_type.":".$row["target_obj_id"]][]
                                        = $row;
                        }
                        // init obj ids without any record
                        foreach ($a_obj_ids as $obj_id)
                        {
                                if (!is_array(self::$cond_target_rows[$a_type.":".$obj_id]))
                                {
                                        self::$cond_target_rows[$a_type.":".$obj_id] = array();
                                }
                        }
                }
        }

References $ilDB, $res, and $row.

Referenced by ilObjectListGUIPreloader\preload().

Here is the caller graph for this function:

◆ saveNumberOfRequiredTriggers()

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

static

Save number of obigatory triggers.

Parameters

int	$a_target_ref_id
int	$a_target_obj_id

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

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

References $ilDB, and $query.

Referenced by calculateRequiredTriggers(), and ilConditionHandlerGUI\saveObligatorySettings().

Here is the caller graph for this function:

◆ setErrorMessage()

ilConditionHandler::setErrorMessage ( $a_msg )

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

        {
                $this->error_message = $a_msg;
        }

Referenced by validate().

Here is the caller graph for this function:

◆ setHiddenStatus()

ilConditionHandler::setHiddenStatus ( $a_status )

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

        {
                $this->hidden_status = $a_status;
        }

◆ setObligatory()

ilConditionHandler::setObligatory ( $a_obl )

Set obligatory status.

Parameters

bool $a_obl

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

        {
                $this->obligatory = $a_obl;
        }

◆ setOperator()

ilConditionHandler::setOperator ( $a_operator )

set operator

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

        {
                return $this->operator = $a_operator;
        }

◆ setReferenceHandlingType()

ilConditionHandler::setReferenceHandlingType ( $a_type )

set reference handling type

Parameters

int	@access public

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

        {
                return $this->condition_reference_type = $a_type;               
        }

◆ setTargetObjId()

ilConditionHandler::setTargetObjId ( $a_target_obj_id )

set target object id

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

        {
                return $this->target_obj_id = $a_target_obj_id;
        }

◆ setTargetRefId()

ilConditionHandler::setTargetRefId ( $a_target_ref_id )

set target ref id

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

        {
                return $this->target_ref_id = $a_target_ref_id;
        }

◆ setTargetType()

ilConditionHandler::setTargetType ( $a_target_type )

set target object type

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

        {
                return $this->target_type = $a_target_type;
        }

◆ setTriggerObjId()

ilConditionHandler::setTriggerObjId ( $a_trigger_obj_id )

set trigger object id

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

        {
                return $this->trigger_obj_id = $a_trigger_obj_id;
        }

◆ setTriggerRefId()

ilConditionHandler::setTriggerRefId ( $a_trigger_ref_id )

set trigger ref id

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

        {
                return $this->trigger_ref_id = $a_trigger_ref_id;
        }

◆ setTriggerType()

ilConditionHandler::setTriggerType ( $a_trigger_type )

set trigger object type

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

        {
                return $this->trigger_type = $a_trigger_type;
        }

◆ setValue()

ilConditionHandler::setValue ( $a_value )

set value

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

        {
                return $this->value = $a_value;
        }

◆ storeCondition()

ilConditionHandler::storeCondition ( )

store new condition in database NOT STATIC @access public

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

        {
                global $ilDB;
                
                // first insert, then validate: it's easier to check for circles if the new condition is in the db table
                $next_id = $ilDB->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 ('.
                        $ilDB->quote($next_id,'integer').','.
                        $ilDB->quote($this->getTargetRefId(),'integer').",".
                        $ilDB->quote($this->getTargetObjId(),'integer').",".
                        $ilDB->quote($this->getTargetType(),'text').",".
                        $ilDB->quote($this->getTriggerRefId(),'integer').",".
                        $ilDB->quote($this->getTriggerObjId(),'integer').",".
                        $ilDB->quote($this->getTriggerType(),'text').",".
                        $ilDB->quote($this->getOperator(),'text').",".
                        $ilDB->quote($this->getValue(),'text').", ".
                        $ilDB->quote($this->getReferenceHandlingType(),'integer').', '.
                        $ilDB->quote($this->getObligatory(),'integer').', '.
                        $ilDB->quote($this->getHiddenStatus(),'integer').' '.
                        ')';
 
                $res = $ilDB->manipulate($query);
 
                if ($this->validation && !$this->validate())
                {
                        $this->deleteCondition($next_id);
                        return false;
                }
                return true;
        }

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

Here is the call graph for this function:

◆ updateCondition()

ilConditionHandler::updateCondition ( $a_id )

update condition

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

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

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

Here is the call graph for this function:

◆ updateHiddenStatus()

ilConditionHandler::updateHiddenStatus ( $a_status )

Update hidden status @global type $ilDB.

Parameters

type	$a_target_ref_id
type	$a_status

Returns: boolean

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

        {
                global $ilDB;
                
                $query = 'UPDATE conditions SET '.
                                'hidden_status = '.$ilDB->quote($a_status,'integer').' '.
                                'WHERE target_ref_id = '.$ilDB->quote($this->getTargetRefId(),'integer');
                $ilDB->manipulate($query);
                return TRUE;
        }

References $ilDB, $query, and getTargetRefId().

Here is the call graph for this function:

◆ updateObligatory()

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

static

Toggle condition obligatory status.

Parameters

int	$a_id
bool	$a_status

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

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

References $ilDB, $query, and $res.

Referenced by ilConditionHandlerGUI\saveObligatoryList(), and ilConditionHandlerGUI\saveObligatorySettings().

Here is the caller graph for this function:

◆ validate()

ilConditionHandler::validate ( )

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

        {
                global $ilDB;
                
                // check if obj_id is already assigned
                $trigger_obj =& ilObjectFactory::getInstanceByRefId($this->getTriggerRefId());
                $target_obj =& ilObjectFactory::getInstanceByRefId($this->getTargetRefId());
 
 
                $query = "SELECT * FROM conditions WHERE ".
                        "trigger_ref_id = ".$ilDB->quote($trigger_obj->getRefId(),'integer')." ".
                        "AND target_ref_id = ".$ilDB->quote($target_obj->getRefId(),'integer');
 
                $res = $this->db->query($query);
                if($res->numRows() > 1)
                {
                        $this->setErrorMessage($this->lng->txt('condition_already_assigned'));
 
                        unset($trigger_obj);
                        unset($target_obj);
                        return false;
                }
 
                // 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);
                        unset($target_obj);
                        return false;
                }                       
                return true;
        }