ilIniFilesLoadedObjective Class Reference

Inheritance diagram for ilIniFilesLoadedObjective:

Collaboration diagram for ilIniFilesLoadedObjective:

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

Static Public Attributes
static bool	$might_populate_ini_files_as_well = true

Protected Member Functions
	getClientDir ($client_id)

Detailed Description

Definition at line 23 of file class.ilIniFilesLoadedObjective.php.

Member Function Documentation

achieve()

ilIniFilesLoadedObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 71 of file class.ilIniFilesLoadedObjective.php.

                                                           : Setup\Environment
    {
        $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);
        if ($client_id === null) {
            throw new Setup\UnachievableException(
                "To initialize the ini-files, we need a client id, but it does not " .
                "exist in the environment."
            );
        }
 
        if ($environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI) == null) {
            $path = dirname(__DIR__, 4) . "/ilias.ini.php";
            $ini = new ilIniFile($path);
            $ini->read();
            $environment = $environment
                ->withResource(Setup\Environment::RESOURCE_ILIAS_INI, $ini);
        }
 
        if ($environment->getResource(Setup\Environment::RESOURCE_CLIENT_INI) == null) {
            $path = $this->getClientDir($client_id) . "/client.ini.php";
            $client_ini = new ilIniFile($path);
            $client_ini->read();
            $environment = $environment
                ->withResource(Setup\Environment::RESOURCE_CLIENT_INI, $client_ini);
        }
 
        return $environment;
    }

References $client_id, $ini, $path, and getClientDir().

Here is the call graph for this function:

getClientDir()

ilIniFilesLoadedObjective::getClientDir (   $client_id )

protected

Definition at line 111 of file class.ilIniFilesLoadedObjective.php.

                                               : string
    {
        return dirname(__DIR__, 4) . "/public/data/$client_id";
    }

Referenced by achieve().

Here is the caller graph for this function:

getHash()

ilIniFilesLoadedObjective::getHash

(

)

Definition at line 42 of file class.ilIniFilesLoadedObjective.php.

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

getLabel()

ilIniFilesLoadedObjective::getLabel

(

)

Definition at line 47 of file class.ilIniFilesLoadedObjective.php.

                              : string
    {
        return "The ilias.ini.php and client.ini.php are loaded";
    }

getPreconditions()

ilIniFilesLoadedObjective::getPreconditions

(

Setup\Environment

$environment

)

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

                                                                    : array
    {
        if (self::$might_populate_ini_files_as_well) {
            return [
                new Setup\Objective\ClientIdReadObjective(),
                new ilIniFilesPopulatedObjective()
            ];
        } else {
            return [
                new Setup\Objective\ClientIdReadObjective(),
            ];
        }
    }

isApplicable()

ilIniFilesLoadedObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 103 of file class.ilIniFilesLoadedObjective.php.

                                                                : bool
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
        $client_ini = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_INI);
 
        return is_null($ini) || is_null($client_ini);
    }

References $ini.

isNotable()

ilIniFilesLoadedObjective::isNotable

(

)

Definition at line 52 of file class.ilIniFilesLoadedObjective.php.

                               : bool
    {
        return false;
    }

Field Documentation

$might_populate_ini_files_as_well

bool ilIniFilesLoadedObjective::$might_populate_ini_files_as_well = true

static

Definition at line 40 of file class.ilIniFilesLoadedObjective.php.

Referenced by ILIAS\Setup\CLI\StatusCommand\getMetrics().

---

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

• components/ILIAS/setup_/classes/class.ilIniFilesLoadedObjective.php