ilLSPostCondition Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilLSPostCondition:

Public Member Functions
	__construct (int $ref_id, string $operator, ?string $value=null)
	getRefId ()
	withRefId (int $ref_id)
	getConditionOperator ()
	withConditionOperator (string $operator)
	getValue ()
	withValue (string $value)

Protected Attributes
int	$ref_id
string	$operator
string	$value

Static Protected Attributes
static	$known_operators

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning A PostCondition does restrict the progression of a user through the learning sequence. Thus, instead of saying "You may only _visit_ this object if you did this", a PostCondition says "you may only _leave_ this object if you did this".

LSPostConditions are being applied by the LearningSequenceConditionController.

Definition at line 28 of file class.ilLSPostCondition.php.

Constructor & Destructor Documentation

__construct()

ilLSPostCondition::__construct	(	int	$ref_id,
		string	$operator,
		?string	$value = null
	)

Definition at line 43 of file class.ilLSPostCondition.php.

      {
        if (!in_array($operator, self::$known_operators)) {
            throw new \InvalidArgumentException(
                "Unknown operator: $operator"
            );
        }
 
        $this->ref_id = $ref_id;
        $this->operator = $operator;
        $this->value = $value;
    }

References $operator, $ref_id, and $value.

Member Function Documentation

getConditionOperator()

ilLSPostCondition::getConditionOperator

(

)

Definition at line 71 of file class.ilLSPostCondition.php.

                                          : string
    {
        return $this->operator;
    }

References $operator.

getRefId()

ilLSPostCondition::getRefId

(

)

Definition at line 59 of file class.ilLSPostCondition.php.

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by ilLSPostConditionDB\upsert().

Here is the caller graph for this function:

getValue()

ilLSPostCondition::getValue

(

)

Definition at line 89 of file class.ilLSPostCondition.php.

                              : ?string
    {
        return $this->value;
    }

References $value.

withConditionOperator()

ilLSPostCondition::withConditionOperator

(

string

$operator

)

Definition at line 76 of file class.ilLSPostCondition.php.

                                                           : ilLSPostCondition
    {
        if (!in_array($operator, self::$known_operators)) {
            throw new \InvalidArgumentException(
                "Unknown operator: $operator"
            );
        }
 
        $clone = clone $this;
        $clone->operator = $operator;
        return $clone;
    }

References $operator.

withRefId()

ilLSPostCondition::withRefId

(

int

$ref_id

)

Definition at line 64 of file class.ilLSPostCondition.php.

                                          : self
    {
        $clone = clone $this;
        $clone->ref_id = $ref_id;
        return $clone;
    }

References $ref_id.

withValue()

ilLSPostCondition::withValue

(

string

$value

)

Definition at line 94 of file class.ilLSPostCondition.php.

                                            : ilLSPostCondition
    {
        $clone = clone $this;
        $clone->value = $value;
        return $clone;
    }

References $value.

Field Documentation

$known_operators

ilLSPostCondition::$known_operators

staticprotected

Initial value:

= [
        "always",
        "failed",
        "finished",
        "learning_progress",
        "not_finished",
        "passed"
    ]

Definition at line 30 of file class.ilLSPostCondition.php.

$operator

string ilLSPostCondition::$operator

protected

Definition at line 40 of file class.ilLSPostCondition.php.

Referenced by __construct(), getConditionOperator(), and withConditionOperator().

$ref_id

int ilLSPostCondition::$ref_id

protected

Definition at line 39 of file class.ilLSPostCondition.php.

Referenced by __construct(), getRefId(), and withRefId().

$value

string ilLSPostCondition::$value

protected

Definition at line 41 of file class.ilLSPostCondition.php.

Referenced by __construct(), getValue(), and withValue().

---

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

• Modules/LearningSequence/classes/PostConditions/class.ilLSPostCondition.php