ilFileSystemClientDirectoryRenamedObjective Class Reference

Inheritance diagram for ilFileSystemClientDirectoryRenamedObjective:

Collaboration diagram for ilFileSystemClientDirectoryRenamedObjective:

Public Member Functions
	__construct (string $path)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)

Data Fields
const	DEFAULT_CLIENT_ID = "default"

Protected Attributes
string	$path

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilFileSystemClientDirectoryRenamedObjective::__construct

(

string

$path

)

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

References $path.

    {
        $this->path = $path;
    }

Member Function Documentation

achieve()

ilFileSystemClientDirectoryRenamedObjective::achieve

(

Setup\Environment

$environment

)

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

References $client_id.

                                                           : Setup\Environment
    {
        $client_id = $environment->getResource(Setup\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(Setup\CLI\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;
    }

getHash()

ilFileSystemClientDirectoryRenamedObjective::getHash

(

)

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

References $path.

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

getLabel()

ilFileSystemClientDirectoryRenamedObjective::getLabel

(

)

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

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

getPreconditions()

ilFileSystemClientDirectoryRenamedObjective::getPreconditions

(

Setup\Environment

$environment

)

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

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

isApplicable()

ilFileSystemClientDirectoryRenamedObjective::isApplicable

(

Setup\Environment

$environment

)

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

                                                                : bool
    {
        return true;
    }

isNotable()

ilFileSystemClientDirectoryRenamedObjective::isNotable

(

)

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

                               : bool
    {
        return true;
    }

Field Documentation

$path

string ilFileSystemClientDirectoryRenamedObjective::$path

protected

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

Referenced by __construct(), and getHash().

DEFAULT_CLIENT_ID

const ilFileSystemClientDirectoryRenamedObjective::DEFAULT_CLIENT_ID = "default"

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

---

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

• Services/FileSystem/classes/Setup/class.ilFileSystemClientDirectoryRenamedObjective.php