ilFileSystemDirectoryCopiedRecursivelyObjective Class Reference

Inheritance diagram for ilFileSystemDirectoryCopiedRecursivelyObjective:

Collaboration diagram for ilFileSystemDirectoryCopiedRecursivelyObjective:

Public Member Functions
	__construct (protected string $source_folder, protected string $target_folder, protected bool $data_dir=false, protected bool $bare=false)
	Copies a directory from ILIAS root or from the outer ILIAS data directory depending on the flag $data_dir. More...
	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. 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. Exceptions UnachievableException if the objective is not achievable Returns Objective[] More...
Public Member Functions inherited from ILIAS\Setup\Objective
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Protected Member Functions
	deleteDirRecursive (string $path)
	getSourceName (string $source)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilFileSystemDirectoryCopiedRecursivelyObjective::__construct	(	protected string	$source_folder,
		protected string	$target_folder,
		protected bool	$data_dir = false,
		protected bool	$bare = false
	)

Copies a directory from ILIAS root or from the outer ILIAS data directory depending on the flag $data_dir.

With $source_folder you can select the directory to copy from selected root directory. Empty string for $source_folder means copy the whole root directory. $target_folder should always be the path wehre to copy into. Set the bare flag true to copy from $source_folder to $target_folder on whole filesystem.

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

    {
    }

Member Function Documentation

deleteDirRecursive()

ilFileSystemDirectoryCopiedRecursivelyObjective::deleteDirRecursive ( string  $path )

protected

Definition at line 141 of file class.ilFileSystemDirectoryCopiedRecursivelyObjective.php.

Referenced by getPreconditions().

                                                       : void
    {
        $files = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
            RecursiveIteratorIterator::CHILD_FIRST
        );

        foreach ($files as $file_info) {
            if ($file_info->isDir()) {
                rmdir($file_info->getRealPath());
                continue;
            }
            unlink($file_info->getRealPath());
        }
    }

Here is the caller graph for this function:

getHash()

ilFileSystemDirectoryCopiedRecursivelyObjective::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 41 of file class.ilFileSystemDirectoryCopiedRecursivelyObjective.php.

References getSourceName().

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

Here is the call graph for this function:

getLabel()

ilFileSystemDirectoryCopiedRecursivelyObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

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

References getSourceName().

                              : string
    {
        $source = $this->getSourceName($this->source_folder);
        return "Copy directory from $source to $this->target_folder.";
    }

Here is the call graph for this function:

getPreconditions()

ilFileSystemDirectoryCopiedRecursivelyObjective::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 66 of file class.ilFileSystemDirectoryCopiedRecursivelyObjective.php.

References $ini, ILIAS\Setup\Objective\achieve(), deleteDirRecursive(), ILIAS\Setup\Environment\getResource(), and ILIAS\Setup\Objective\isApplicable().

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

Here is the call graph for this function:

getSourceName()

ilFileSystemDirectoryCopiedRecursivelyObjective::getSourceName ( string  $source )

protected

Definition at line 157 of file class.ilFileSystemDirectoryCopiedRecursivelyObjective.php.

Referenced by getHash(), and getLabel().

                                                    : string
    {
        if ($source !== "") {
            return $source;
        }

        if ($this->data_dir) {
            return "ilias data dir";
        }

        return "ilias root";
    }

Here is the caller graph for this function:

isNotable()

ilFileSystemDirectoryCopiedRecursivelyObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 58 of file class.ilFileSystemDirectoryCopiedRecursivelyObjective.php.

                               : bool
    {
        return true;
    }

---

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

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