Read the client id of the installation from the data directory. More...

Inheritance diagram for ILIAS\Setup\Objective\ClientIdReadObjective:

Collaboration diagram for ILIAS\Setup\Objective\ClientIdReadObjective:

Public Member Functions
	getHash ()
	Uses hashed Path. More...

	getLabel ()
	@inheritdocs More...

	isNotable ()
	Defaults to 'true'. 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 Member Functions
	getDataDirectoryPath ()

	scanDirectory (string $path)

	isDirectory (string $path)

Detailed Description

Read the client id of the installation from the data directory.

ATTENTION: This might be placed better in some service, rather then being located here in the Setup-library. Currently I don't know where, though. Maybe we also might be able to remove this altogether if the multi-client code has been removed.

Definition at line 32 of file ClientIdReadObjective.php.

Member Function Documentation

◆ achieve()

ILIAS\Setup\Objective\ClientIdReadObjective::achieve ( Setup\Environment $environment )

@inheritdocs

Definition at line 73 of file ClientIdReadObjective.php.

                                                           : Setup\Environment
    {
        $dir = $this->getDataDirectoryPath();
        $candidates = array_filter(
            $this->scanDirectory($dir),
            function ($c) use ($dir): bool {
                if ($c == "." || $c == "..") {
                    return false;
                }
                return $this->isDirectory($dir . "/" . $c);
            }
        );
 
        if (count($candidates) == 0) {
            throw new Setup\UnachievableException(
                "There are no directories in the webdata-dir at '$dir'. " .
                "Probably ILIAS is not installed."
            );
        }
 
        if (count($candidates) != 1) {
            $ilias_version = ILIAS_VERSION_NUMERIC;
 
            throw new Setup\UnachievableException(
                "There is more than one directory in the webdata-dir at '$dir'. " .
                "Probably this is an ILIAS installation that uses clients. Clients " .
                "are not supported anymore since ILIAS $ilias_version " .
                "(see: https://docu.ilias.de/goto.php?target=wiki_1357_Setup_-_Abandon_Multi_Client)"
            );
        }
 
        $client_id = array_shift($candidates);
        return $environment->withResource(Setup\Environment::RESOURCE_CLIENT_ID, $client_id);
    }

References $c, ILIAS\$client_id, ILIAS\Setup\Objective\ClientIdReadObjective\getDataDirectoryPath(), ILIAS_VERSION_NUMERIC, ILIAS\Setup\Objective\ClientIdReadObjective\isDirectory(), ILIAS\Setup\Environment\RESOURCE_CLIENT_ID, and ILIAS\Setup\Objective\ClientIdReadObjective\scanDirectory().

Here is the call graph for this function:

◆ getDataDirectoryPath()

ILIAS\Setup\Objective\ClientIdReadObjective::getDataDirectoryPath ( )

protected

Definition at line 108 of file ClientIdReadObjective.php.

                                             : string
    {
        return dirname(__DIR__, 3) . "/data";
    }

Referenced by ILIAS\Setup\Objective\ClientIdReadObjective\achieve().

Here is the caller graph for this function:

◆ getHash()

ILIAS\Setup\Objective\ClientIdReadObjective::getHash ( )

Uses hashed Path.

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 39 of file ClientIdReadObjective.php.

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

◆ getLabel()

ILIAS\Setup\Objective\ClientIdReadObjective::getLabel ( )

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 47 of file ClientIdReadObjective.php.

                              : string
    {
        return "Read client-id from data-directory.";
    }

◆ getPreconditions()

ILIAS\Setup\Objective\ClientIdReadObjective::getPreconditions ( Setup\Environment $environment )

@inheritdocs

Definition at line 65 of file ClientIdReadObjective.php.

◆ isApplicable()

ILIAS\Setup\Objective\ClientIdReadObjective::isApplicable ( Setup\Environment $environment )

@inheritDoc

Definition at line 126 of file ClientIdReadObjective.php.

                                                                : bool
    {
        return $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID) === null;
    }

References ILIAS\Setup\Environment\RESOURCE_CLIENT_ID.

◆ isDirectory()

ILIAS\Setup\Objective\ClientIdReadObjective::isDirectory ( string $path )

protected

Definition at line 118 of file ClientIdReadObjective.php.

                                                : bool
    {
        return is_dir($path);
    }

References $path.

Referenced by ILIAS\Setup\Objective\ClientIdReadObjective\achieve().

Here is the caller graph for this function:

◆ isNotable()

ILIAS\Setup\Objective\ClientIdReadObjective::isNotable ( )

Defaults to 'true'.

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 57 of file ClientIdReadObjective.php.

                               : bool
    {
        return false;
    }

◆ scanDirectory()

ILIAS\Setup\Objective\ClientIdReadObjective::scanDirectory ( string $path )

protected

Definition at line 113 of file ClientIdReadObjective.php.

                                                  : array
    {
        return scandir($path);
    }

References $path.

Referenced by ILIAS\Setup\Objective\ClientIdReadObjective\achieve().

Here is the caller graph for this function:

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

src/Setup/Objective/ClientIdReadObjective.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ achieve()

◆ getDataDirectoryPath()

◆ getHash()

◆ getLabel()

◆ getPreconditions()

◆ isApplicable()

◆ isDirectory()

◆ isNotable()

◆ scanDirectory()