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 ()
	@inheritdocs More...
	getLabel ()
	@inheritdocs More...
	isNotable ()
	@inheritdocs More...
	getPreconditions (Setup\Environment $environment)
	@inheritdocs More...
	achieve (Setup\Environment $environment)
	@inheritdocs More...
	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
	$callable
	$label
	$is_notable
	$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 15 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 37 of file CallableObjective.php.

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

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

Member Function Documentation

achieve()

ILIAS\Setup\Objective\CallableObjective::achieve

(

Setup\Environment

$environment

)

@inheritdocs

Definition at line 83 of file CallableObjective.php.

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

References $res.

getHash()

ILIAS\Setup\Objective\CallableObjective::getHash

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Reimplemented in ilDatabaseUpdateStep.

Definition at line 48 of file CallableObjective.php.

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

getLabel()

ILIAS\Setup\Objective\CallableObjective::getLabel

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 59 of file CallableObjective.php.

                               : string
    {
        return $this->label;
    }

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

getPreconditions()

ILIAS\Setup\Objective\CallableObjective::getPreconditions

(

Setup\Environment

$environment

)

@inheritdocs

Definition at line 75 of file CallableObjective.php.

                                                                     : array
    {
        return $this->preconditions;
    }

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

isApplicable()

ILIAS\Setup\Objective\CallableObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 95 of file CallableObjective.php.

                                                                 : bool
    {
        return true;
    }

isNotable()

ILIAS\Setup\Objective\CallableObjective::isNotable

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 67 of file CallableObjective.php.

                                : bool
    {
        return $this->is_notable;
    }

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

Field Documentation

$callable

ILIAS\Setup\Objective\CallableObjective::$callable

protected

Definition at line 20 of file CallableObjective.php.

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

$is_notable

ILIAS\Setup\Objective\CallableObjective::$is_notable

protected

Definition at line 30 of file CallableObjective.php.

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

$label

ILIAS\Setup\Objective\CallableObjective::$label

protected

Definition at line 25 of file CallableObjective.php.

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

$preconditions

ILIAS\Setup\Objective\CallableObjective::$preconditions

protected

Definition at line 35 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:

• src/Setup/Objective/CallableObjective.php