ilFileSystemClientDirectoryRenamedObjective Class Reference

Inheritance diagram for ilFileSystemClientDirectoryRenamedObjective:

Collaboration diagram for ilFileSystemClientDirectoryRenamedObjective:

Public Member Functions
	__construct (protected string $path)
	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)
	@inheritDoc More...
	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...

Data Fields
const	DEFAULT_CLIENT_ID = "default"

Detailed Description

Definition at line 25 of file class.ilFileSystemClientDirectoryRenamedObjective.php.

Constructor & Destructor Documentation

__construct()

ilFileSystemClientDirectoryRenamedObjective::__construct

(

protected string

$path

)

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

    {
    }

Member Function Documentation

achieve()

ilFileSystemClientDirectoryRenamedObjective::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

LogicException if there are unfullfilled preconditions.

Exceptions

RuntimeException if there are missing resources.

Implements ILIAS\Setup\Objective.

Definition at line 55 of file class.ilFileSystemClientDirectoryRenamedObjective.php.

                                                     : Environment
    {
        $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);
 
        $old_name = $this->path . DIRECTORY_SEPARATOR . $client_id;
        $new_name = $this->path . DIRECTORY_SEPARATOR . self::DEFAULT_CLIENT_ID;
 
        if ($environment->hasConfigFor(InstallCommand::IMPORT)) {
            $old_name = $this->path . DIRECTORY_SEPARATOR . self::DEFAULT_CLIENT_ID;
            $new_name = $this->path . DIRECTORY_SEPARATOR . $client_id;
        }
 
        rename($old_name, $new_name);
 
        return $environment;
    }

References $client_id, DEFAULT_CLIENT_ID, ILIAS\Setup\Environment\getResource(), and ILIAS\Setup\Environment\hasConfigFor().

Here is the call graph for this function:

getHash()

ilFileSystemClientDirectoryRenamedObjective::getHash

(

)

Get a hash for this objective.

The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implements ILIAS\Setup\Objective.

Definition at line 33 of file class.ilFileSystemClientDirectoryRenamedObjective.php.

                             : string
    {
        return hash("sha256", self::class) . $this->path;
    }

References $path.

getLabel()

ilFileSystemClientDirectoryRenamedObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

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

                              : string
    {
        return "Switch client names for export/import";
    }

getPreconditions()

ilFileSystemClientDirectoryRenamedObjective::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 48 of file class.ilFileSystemClientDirectoryRenamedObjective.php.

                                                              : array
    {
        return [
            new ilIniFilesPopulatedObjective()
        ];
    }

isApplicable()

ilFileSystemClientDirectoryRenamedObjective::isApplicable

(

Environment

$environment

)

@inheritDoc

Implements ILIAS\Setup\Objective.

Definition at line 75 of file class.ilFileSystemClientDirectoryRenamedObjective.php.

                                                          : bool
    {
        return true;
    }

isNotable()

ilFileSystemClientDirectoryRenamedObjective::isNotable

(

)

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 43 of file class.ilFileSystemClientDirectoryRenamedObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

DEFAULT_CLIENT_ID

const ilFileSystemClientDirectoryRenamedObjective::DEFAULT_CLIENT_ID = "default"

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

Referenced by achieve().

---

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

• components/ILIAS/Filesystem/classes/Setup/class.ilFileSystemClientDirectoryRenamedObjective.php