ilDatabaseResetStepsObjective Class Reference

Inheritance diagram for ilDatabaseResetStepsObjective:

Collaboration diagram for ilDatabaseResetStepsObjective:

Public Member Functions
	__construct ()
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDatabaseResetStepsObjective::__construct

(

)

Definition at line 26 of file class.ilDatabaseResetStepsObjective.php.

    {
        parent::__construct(
            "This will reset failing steps in the setup progress. However -\n" .
            "those steps failed for a reason!\n" .
            "A step may fail due to a programming error, or, more likely, to some\n" .
            "circumstances in your environment, e.g. inconsistent data in the DB,\n" .
            "missing or unexpected files, etc.. Please double-check for the cause\n" .
            "and only continue if you are certain about and fine with the consequences.\n" .
            "Continue?"
        );
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

achieve()

ilDatabaseResetStepsObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 67 of file class.ilDatabaseResetStepsObjective.php.

                                                           : Setup\Environment
    {
        $environment = parent::achieve($environment);
        $db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);
        $db->manipulate('DELETE FROM il_db_steps WHERE finished IS NULL');
        return $environment;
    }

getHash()

ilDatabaseResetStepsObjective::getHash

(

)

Definition at line 39 of file class.ilDatabaseResetStepsObjective.php.

                             : string
    {
        return hash("sha256", self::class);
    }

getLabel()

ilDatabaseResetStepsObjective::getLabel

(

)

Definition at line 44 of file class.ilDatabaseResetStepsObjective.php.

                              : string
    {
        return "failing update steps are removed.";
    }

getPreconditions()

ilDatabaseResetStepsObjective::getPreconditions

(

Setup\Environment

$environment

)

Returns

\ilDatabaseInitializedObjective[]|\ILIAS\Setup\Objective\ClientIdReadObjective[]|\ilIniFilesPopulatedObjective[]

Definition at line 57 of file class.ilDatabaseResetStepsObjective.php.

                                                                    : array
    {
        $preconditions = [];
        $preconditions[] = new Setup\Objective\ClientIdReadObjective();
        $preconditions[] = new ilIniFilesPopulatedObjective();
        $preconditions[] = new ilDatabaseInitializedObjective();
 
        return $preconditions;
    }

isApplicable()

ilDatabaseResetStepsObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 78 of file class.ilDatabaseResetStepsObjective.php.

                                                                : bool
    {
        $db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);
        $query = 'SELECT class FROM il_db_steps WHERE finished IS NULL';
        return $db->numRows($db->query($query)) > 0;
    }

References $query.

isNotable()

ilDatabaseResetStepsObjective::isNotable

(

)

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

                               : bool
    {
        return true;
    }

---

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

• Services/Database/classes/Setup/class.ilDatabaseResetStepsObjective.php