ilIniFilesPopulatedObjective Class Reference

Inheritance diagram for ilIniFilesPopulatedObjective:

Collaboration diagram for ilIniFilesPopulatedObjective:

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

Protected Member Functions
	getClientDir (string $client_id)
	getClientIniPath (string $client_id)
	getILIASIniPath ()

Detailed Description

Definition at line 7 of file class.ilIniFilesPopulatedObjective.php.

Member Function Documentation

achieve()

ilIniFilesPopulatedObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 45 of file class.ilIniFilesPopulatedObjective.php.

                                                            : Setup\Environment
    {
        $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);
 
        $path = $this->getILIASIniPath();
        if (!file_exists($path)) {
            $ini = new ilIniFile($path);
            $ini->GROUPS = parse_ini_file(__DIR__ . "/../ilias.master.ini.php", true);
            $ini->write();
            $environment = $environment
                ->withResource(Setup\Environment::RESOURCE_ILIAS_INI, $ini);
        }
 
        $path = $this->getClientIniPath($client_id);
        if (!file_exists($path)) {
            $client_ini = new ilIniFile($path);
            $client_ini->GROUPS = parse_ini_file(__DIR__ . "/../client.master.ini.php", true);
            $client_ini->write();
            $environment = $environment
                ->withResource(Setup\Environment::RESOURCE_CLIENT_INI, $client_ini);
        }
 
        return $environment;
    }

References $client_id, $ini, getClientIniPath(), and getILIASIniPath().

Here is the call graph for this function:

getClientDir()

ilIniFilesPopulatedObjective::getClientDir ( string  $client_id )

protected

Definition at line 81 of file class.ilIniFilesPopulatedObjective.php.

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

References $client_id.

Referenced by getClientIniPath(), and getPreconditions().

Here is the caller graph for this function:

getClientIniPath()

ilIniFilesPopulatedObjective::getClientIniPath ( string  $client_id )

protected

Definition at line 86 of file class.ilIniFilesPopulatedObjective.php.

                                                           : string
    {
        return $this->getClientDir($client_id) . "/client.ini.php";
    }

References getClientDir().

Referenced by achieve(), and isApplicable().

Here is the call graph for this function:

Here is the caller graph for this function:

getHash()

ilIniFilesPopulatedObjective::getHash

(

)

Definition at line 9 of file class.ilIniFilesPopulatedObjective.php.

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

getILIASIniPath()

ilIniFilesPopulatedObjective::getILIASIniPath ( )

protected

Definition at line 91 of file class.ilIniFilesPopulatedObjective.php.

                                         : string
    {
        return dirname(__DIR__, 2) . "/ilias.ini.php";
    }

Referenced by achieve(), and isApplicable().

Here is the caller graph for this function:

getLabel()

ilIniFilesPopulatedObjective::getLabel

(

)

Definition at line 14 of file class.ilIniFilesPopulatedObjective.php.

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

getPreconditions()

ilIniFilesPopulatedObjective::getPreconditions

(

Setup\Environment

$environment

)

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

                                                                     : array
    {
        $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);
        if ($client_id === null) {
            throw new \LogicException(
                "Expected a client_id in the environment."
            );
        }
        $client_dir = $this->getClientDir($client_id);
 
        // TODO: This shows an unfortunate connection between the webdir and the
        // client.ini.php. Why does the client.ini reside in the webdir? If we
        // remove the client-feature, the client-ini will go away...
        return [
            new Setup\Objective\DirectoryCreatedObjective(dirname(__DIR__, 2) . "/data"),
            new Setup\Objective\DirectoryCreatedObjective($client_dir),
            new Setup\Condition\CanCreateFilesInDirectoryCondition($client_dir),
            new Setup\Condition\CanCreateFilesInDirectoryCondition(dirname(__DIR__, 2))
        ];
    }

References $client_id, and getClientDir().

Here is the call graph for this function:

isApplicable()

ilIniFilesPopulatedObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 73 of file class.ilIniFilesPopulatedObjective.php.

                                                                 : bool
    {
        $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);
 
        return !file_exists($this->getILIASIniPath())
            || !file_exists($this->getClientIniPath($client_id));
    }

References $client_id, getClientIniPath(), and getILIASIniPath().

Here is the call graph for this function:

isNotable()

ilIniFilesPopulatedObjective::isNotable

(

)

Definition at line 19 of file class.ilIniFilesPopulatedObjective.php.

                                : bool
    {
        return true;
    }

---

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

• setup/classes/class.ilIniFilesPopulatedObjective.php