ILIAS\Setup\Objective\Tentatively Class Reference

A wrapper around an objective that attempts to achieve the wrapped objective but won't stop the process on failure. More...

Inheritance diagram for ILIAS\Setup\Objective\Tentatively:

Collaboration diagram for ILIAS\Setup\Objective\Tentatively:

Public Member Functions
	__construct (Setup\Objective $other)
	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
	$other

Detailed Description

A wrapper around an objective that attempts to achieve the wrapped objective but won't stop the process on failure.

Definition at line 13 of file Tentatively.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\Objective\Tentatively::__construct

(

Setup\Objective

$other

)

Definition at line 20 of file Tentatively.php.

References ILIAS\Setup\Objective\Tentatively\$other.

    {
        $this->other = $other;
    }

Member Function Documentation

achieve()

ILIAS\Setup\Objective\Tentatively::achieve

(

Setup\Environment

$environment

)

Definition at line 68 of file Tentatively.php.

References Vendor\Package\$e.

                                                            : Setup\Environment
    {
        try {
            return $this->other->achieve($environment);
        } catch (Setup\UnachievableException $e) {
        }
        return $environment;
    }

getHash()

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

                              : string
    {
        if ($this->other instanceof Tentatively) {
            return $this->other->getHash();
        }
        return "tentatively " . $this->other->getHash();
    }

getLabel()

ILIAS\Setup\Objective\Tentatively::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 33 of file Tentatively.php.

                               : string
    {
        if ($this->other instanceof Tentatively) {
            return $this->other->getLabel();
        }
        return "Tentatively: " . $this->other->getLabel();
    }

getPreconditions()

ILIAS\Setup\Objective\Tentatively::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 49 of file Tentatively.php.

                                                                     : array
    {
        if ($this->other instanceof Tentatively) {
            return $this->other->getPreconditions($environment);
        }
        return array_map(
            function ($p) {
                if ($p instanceof Tentatively) {
                    return $p;
                }
                return new Tentatively($p);
            },
            $this->other->getPreconditions($environment)
        );
    }

isApplicable()

ILIAS\Setup\Objective\Tentatively::isApplicable

(

Setup\Environment

$environment

)

Definition at line 80 of file Tentatively.php.

                                                                 : bool
    {
        return $this->other->isApplicable($environment);
    }

isNotable()

ILIAS\Setup\Objective\Tentatively::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 41 of file Tentatively.php.

                                : bool
    {
        return $this->other->isNotable();
    }

Field Documentation

$other

ILIAS\Setup\Objective\Tentatively::$other

protected

Definition at line 18 of file Tentatively.php.

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

---

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

• src/Setup/Objective/Tentatively.php