ilDataCollectionObjective Class Reference

Inheritance diagram for ilDataCollectionObjective:

Collaboration diagram for ilDataCollectionObjective:

Public Member Functions
	__construct (ilDatabaseUpdateSteps $steps)
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
Public Member Functions inherited from ilDatabaseUpdateStepsExecutedObjective
	__construct (protected ilDatabaseUpdateSteps $steps)
	getHash ()
	The hash for the objective is calculated over the classname and the steps that are contained. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	isApplicable (Environment $environment)

Protected Attributes
ilDatabaseUpdateSteps	$steps
Protected Attributes inherited from ilDatabaseUpdateStepsExecutedObjective
string	$steps_class

Additional Inherited Members
Data Fields inherited from ilDatabaseUpdateStepsExecutedObjective
const	STEP_METHOD_PREFIX = "step_"
Protected Member Functions inherited from ilDatabaseUpdateStepsExecutedObjective
	throwStepNotFinishedException (int $started, int $finished)

Detailed Description

Definition at line 24 of file class.ilDataCollectionObjective.php.

Constructor & Destructor Documentation

__construct()

ilDataCollectionObjective::__construct

(

ilDatabaseUpdateSteps

$steps

)

Definition at line 29 of file class.ilDataCollectionObjective.php.

References ILIAS\GlobalScreen\Provider\__construct().

    {
        if ($steps instanceof ilDataCollectionDBUpdateSteps9) {
            parent::__construct($steps);
        } else {
            throw new InvalidArgumentException('$steps must be instance of ilDataCollectionDBUpdateSteps9');
        }
    }

Here is the call graph for this function:

Member Function Documentation

achieve()

ilDataCollectionObjective::achieve

(

Environment

$environment

)

Objectives can be achieved.

They might add resources to the environment when they have been achieved.

This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

Implements ILIAS\Setup\Objective.

Definition at line 49 of file class.ilDataCollectionObjective.php.

References $DIC, and ILIAS\Setup\Environment\getResource().

                                                     : Environment
    {
        global $DIC;
        $DIC = new Container();
        $DIC['lng'] = new ilSetupLanguage('en');
        $DIC['ilDB'] = $environment->getResource(Environment::RESOURCE_DATABASE);
        $DIC['component.factory'] = $environment->getResource(Environment::RESOURCE_COMPONENT_FACTORY);
        $DIC['component.repository'] = $environment->getResource(Environment::RESOURCE_COMPONENT_REPOSITORY);
        return parent::achieve($environment);
    }

Here is the call graph for this function:

getPreconditions()

ilDataCollectionObjective::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 38 of file class.ilDataCollectionObjective.php.

                                                              : array
    {
        return array_merge(
            parent::getPreconditions($environment),
            [
                new ilComponentFactoryExistsObjective(),
                new ilComponentRepositoryExistsObjective()
            ]
        );
    }

Field Documentation

$steps

ilDatabaseUpdateSteps ilDataCollectionObjective::$steps

protected

Definition at line 27 of file class.ilDataCollectionObjective.php.

---

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

• components/ILIAS/DataCollection/classes/Setup/class.ilDataCollectionObjective.php