ILIAS\Setup\Objective\CallableObjective Class Reference

A callable objective wraps a callable into an objective. More...

Inheritance diagram for ILIAS\Setup\Objective\CallableObjective:

Collaboration diagram for ILIAS\Setup\Objective\CallableObjective:

Public Member Functions
	__construct (callable $callable, string $label, bool $is_notable, Setup\Objective ... $preconditions)
	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 (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	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
	$callable
string	$label
bool	$is_notable
array	$preconditions

Detailed Description

A callable objective wraps a callable into an objective.

The callable receives the environment as parameter. It may return an updated version of the environment, other results will be discarded.

Definition at line 31 of file CallableObjective.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\Objective\CallableObjective::__construct	(	callable	$callable,
		string	$label,
		bool	$is_notable,
		Setup\Objective ...	$preconditions
	)

Definition at line 47 of file CallableObjective.php.

References ILIAS\Setup\Objective\CallableObjective\$callable, ILIAS\Setup\Objective\CallableObjective\$is_notable, ILIAS\Setup\Objective\CallableObjective\$label, and ILIAS\Setup\Objective\CallableObjective\$preconditions.

    {
        $this->callable = $callable;
        $this->label = $label;
        $this->is_notable = $is_notable;
        $this->preconditions = $preconditions;
    }

Member Function Documentation

achieve()

ILIAS\Setup\Objective\CallableObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 78 of file CallableObjective.php.

References $res.

                                                           : Setup\Environment
    {
        $res = call_user_func($this->callable, $environment);
        if ($res instanceof Setup\Environment) {
            return $res;
        }
        return $environment;
    }

getHash()

ILIAS\Setup\Objective\CallableObjective::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 55 of file CallableObjective.php.

                             : string
    {
        return hash(
            "sha256",
            spl_object_hash($this)
        );
    }

getLabel()

ILIAS\Setup\Objective\CallableObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 63 of file CallableObjective.php.

References ILIAS\Setup\Objective\CallableObjective\$label.

                              : string
    {
        return $this->label;
    }

getPreconditions()

ILIAS\Setup\Objective\CallableObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 73 of file CallableObjective.php.

References ILIAS\Setup\Objective\CallableObjective\$preconditions.

                                                                    : array
    {
        return $this->preconditions;
    }

isApplicable()

ILIAS\Setup\Objective\CallableObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 87 of file CallableObjective.php.

                                                                : bool
    {
        return true;
    }

isNotable()

ILIAS\Setup\Objective\CallableObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 68 of file CallableObjective.php.

References ILIAS\Setup\Objective\CallableObjective\$is_notable.

                               : bool
    {
        return $this->is_notable;
    }

Field Documentation

$callable

ILIAS\Setup\Objective\CallableObjective::$callable

protected

Definition at line 36 of file CallableObjective.php.

Referenced by ILIAS\Setup\Objective\CallableObjective\__construct().

$is_notable

bool ILIAS\Setup\Objective\CallableObjective::$is_notable

protected

Definition at line 40 of file CallableObjective.php.

Referenced by ILIAS\Setup\Objective\CallableObjective\__construct(), and ILIAS\Setup\Objective\CallableObjective\isNotable().

$label

string ILIAS\Setup\Objective\CallableObjective::$label

protected

Definition at line 38 of file CallableObjective.php.

Referenced by ILIAS\Setup\Objective\CallableObjective\__construct(), and ILIAS\Setup\Objective\CallableObjective\getLabel().

$preconditions

array ILIAS\Setup\Objective\CallableObjective::$preconditions

protected

Definition at line 45 of file CallableObjective.php.

Referenced by ILIAS\Setup\Objective\CallableObjective\__construct(), and ILIAS\Setup\Objective\CallableObjective\getPreconditions().

---

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

• components/ILIAS/Setup/src/Objective/CallableObjective.php