A condition that can't be met by ILIAS itself needs to be met by some external means. More...

Inheritance diagram for ILIAS\Setup\Condition\ExternalConditionObjective:

Collaboration diagram for ILIAS\Setup\Condition\ExternalConditionObjective:

Public Member Functions
	__construct (string $label, \Closure $condition, ?string $message=null, bool $block_setup=false)

	getHash ()
	Get a hash for this objective.The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same. More...

	getLabel ()
	Get a label that describes this objective. More...

	isNotable ()
	Get to know if this is an interesting objective for a human. More...

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Public Member Functions inherited from ILIAS\Setup\Objective
	getHash ()
	Get a hash for this objective. More...

	getLabel ()
	Get a label that describes this objective. More...

	isNotable ()
	Get to know if this is an interesting objective for a human. More...

	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...

	achieve (Environment $environment)
	Objectives can be achieved. More...

	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Protected Attributes
string	$label

Closure	$condition

string	$message

bool	$block_setup

Detailed Description

A condition that can't be met by ILIAS itself needs to be met by some external means.

ATTENTION: Two ExternalConditionObjectives are considered to be identical if the label is identical. I.e., getHash does not use the actual condition or the message.

Definition at line 32 of file ExternalConditionObjective.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\Condition\ExternalConditionObjective::__construct	(	string	$label,
		\Closure	$condition,
		?string	$message = `null`,
		bool	$block_setup = `false`
	)

Parameters

callable $condition needs to be function from Environment to bool.

Definition at line 42 of file ExternalConditionObjective.php.

      {
        $this->condition = $condition;
        $this->label = $label;
        $this->message = $message;
        $this->block_setup = $block_setup;
    }

References ILIAS\Setup\Condition\ExternalConditionObjective\$block_setup, ILIAS\Setup\Condition\ExternalConditionObjective\$condition, ILIAS\Setup\Condition\ExternalConditionObjective\$label, and ILIAS\Setup\Condition\ExternalConditionObjective\$message.

Member Function Documentation

◆ achieve()

ILIAS\Setup\Condition\ExternalConditionObjective::achieve ( Setup\Environment $environment )

Definition at line 92 of file ExternalConditionObjective.php.

                                                           : Setup\Environment
    {
        if (($this->condition)($environment)) {
            return $environment;
        }
 
        if ($this->message) {
            $admin_interaction = $environment->getResource(Setup\Environment::RESOURCE_ADMIN_INTERACTION);
            $admin_interaction->inform($this->message);
        }
        if ($this->block_setup) {
            throw new Setup\NotExecutableException("An external condition was not met: $this->label");
        }
 
        throw new Setup\UnachievableException("An external condition was not met: $this->label");
    }

References ILIAS\Setup\Environment\getResource(), and ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION.

Here is the call graph for this function:

◆ getHash()

ILIAS\Setup\Condition\ExternalConditionObjective::getHash ( )

Get a hash for this objective.The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implements ILIAS\Setup\Objective.

Definition at line 57 of file ExternalConditionObjective.php.

                             : string
    {
        return hash(
            "sha256",
            get_class($this) . "::" . $this->label
        );
    }

◆ getLabel()

ILIAS\Setup\Condition\ExternalConditionObjective::getLabel ( )

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 68 of file ExternalConditionObjective.php.

                              : string
    {
        return $this->label;
    }

References ILIAS\Setup\Condition\ExternalConditionObjective\$label.

◆ getPreconditions()

ILIAS\Setup\Condition\ExternalConditionObjective::getPreconditions ( Setup\Environment $environment )

Definition at line 84 of file ExternalConditionObjective.php.

◆ isApplicable()

ILIAS\Setup\Condition\ExternalConditionObjective::isApplicable ( Setup\Environment $environment )

@inheritDoc

Definition at line 112 of file ExternalConditionObjective.php.

                                                                : bool
    {
        return true;
    }

◆ isNotable()

ILIAS\Setup\Condition\ExternalConditionObjective::isNotable ( )

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 76 of file ExternalConditionObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

◆ $block_setup

bool ILIAS\Setup\Condition\ExternalConditionObjective::$block_setup

protected

Definition at line 37 of file ExternalConditionObjective.php.

Referenced by ILIAS\Setup\Condition\ExternalConditionObjective\__construct(), and ILIAS\Setup\Condition\PHPVersionCondition\__construct().

◆ $condition

Closure ILIAS\Setup\Condition\ExternalConditionObjective::$condition

protected

Definition at line 35 of file ExternalConditionObjective.php.

Referenced by ILIAS\Setup\Condition\ExternalConditionObjective\__construct().

◆ $label

string ILIAS\Setup\Condition\ExternalConditionObjective::$label

protected

Definition at line 34 of file ExternalConditionObjective.php.

Referenced by ILIAS\Setup\Condition\ExternalConditionObjective\__construct(), and ILIAS\Setup\Condition\ExternalConditionObjective\getLabel().

◆ $message

string ILIAS\Setup\Condition\ExternalConditionObjective::$message

protected

Definition at line 36 of file ExternalConditionObjective.php.

Referenced by ILIAS\Setup\Condition\ExternalConditionObjective\__construct().

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

components/ILIAS/Setup/src/Condition/ExternalConditionObjective.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ achieve()

◆ getHash()

◆ getLabel()

◆ getPreconditions()

◆ isApplicable()

◆ isNotable()

Field Documentation

◆ $block_setup

◆ $condition

◆ $label

◆ $message