ILIAS\Setup\ObjectiveCollection Class Reference

A objective collection is a objective that is achieved once all subobjectives are achieved. More...

Inheritance diagram for ILIAS\Setup\ObjectiveCollection:

Collaboration diagram for ILIAS\Setup\ObjectiveCollection:

Public Member Functions
	__construct (string $label, bool $is_notable, Objective ... $objectives)
	getObjectives ()
	getHash ()
	@inheritdocs More...
	getLabel ()
	@inheritdocs More...
	isNotable ()
	@inheritdocs More...
	getPreconditions (Environment $environment)
	@inheritdocs More...
	achieve (Environment $environment)
	@inheritdocs More...
	isApplicable (Environment $environment)
	@inheritdocs More...
	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
bool	$is_notable
array	$objectives

Detailed Description

A objective collection is a objective that is achieved once all subobjectives are achieved.

Definition at line 26 of file ObjectiveCollection.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\ObjectiveCollection::__construct	(	string	$label,
		bool	$is_notable,
		Objective ...	$objectives
	)

Definition at line 36 of file ObjectiveCollection.php.

    {
        $this->label = $label;
        $this->is_notable = $is_notable;
        $this->objectives = $objectives;
    }

References ILIAS\Setup\ObjectiveCollection\$is_notable, ILIAS\Setup\ObjectiveCollection\$label, and ILIAS\Setup\ObjectiveCollection\$objectives.

Member Function Documentation

achieve()

ILIAS\Setup\ObjectiveCollection::achieve

(

Environment

$environment

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 95 of file ObjectiveCollection.php.

                                                     : Environment
    {
        return $environment;
    }

getHash()

ILIAS\Setup\ObjectiveCollection::getHash

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 54 of file ObjectiveCollection.php.

                             : string
    {
        return hash(
            "sha256",
            get_class($this) .
            implode(
                array_map(
                    fn ($g): string => $g->getHash(),
                    $this->objectives
                )
            )
        );
    }

getLabel()

ILIAS\Setup\ObjectiveCollection::getLabel

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 71 of file ObjectiveCollection.php.

                              : string
    {
        return $this->label;
    }

References ILIAS\Setup\ObjectiveCollection\$label.

getObjectives()

ILIAS\Setup\ObjectiveCollection::getObjectives

(

)

Returns

Objective[]

Definition at line 46 of file ObjectiveCollection.php.

                                   : array
    {
        return $this->objectives;
    }

References ILIAS\Setup\ObjectiveCollection\$objectives.

getPreconditions()

ILIAS\Setup\ObjectiveCollection::getPreconditions

(

Environment

$environment

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 87 of file ObjectiveCollection.php.

                                                              : array
    {
        return $this->objectives;
    }

References ILIAS\Setup\ObjectiveCollection\$objectives.

isApplicable()

ILIAS\Setup\ObjectiveCollection::isApplicable

(

Environment

$environment

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 103 of file ObjectiveCollection.php.

                                                          : bool
    {
        return false;
    }

isNotable()

ILIAS\Setup\ObjectiveCollection::isNotable

(

)

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 79 of file ObjectiveCollection.php.

                               : bool
    {
        return $this->is_notable;
    }

References ILIAS\Setup\ObjectiveCollection\$is_notable.

Field Documentation

$is_notable

bool ILIAS\Setup\ObjectiveCollection::$is_notable

protected

Definition at line 29 of file ObjectiveCollection.php.

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

$label

string ILIAS\Setup\ObjectiveCollection::$label

protected

Definition at line 28 of file ObjectiveCollection.php.

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

$objectives

array ILIAS\Setup\ObjectiveCollection::$objectives

protected

Definition at line 34 of file ObjectiveCollection.php.

Referenced by ILIAS\Setup\ObjectiveCollection\__construct(), ILIAS\Setup\ObjectiveCollection\getObjectives(), and ILIAS\Setup\ObjectiveCollection\getPreconditions().

---

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

• components/ILIAS/Setup/src/ObjectiveCollection.php