ilFileSystemDirectoryCopiedRecursivelyObjective Class Reference

Inheritance diagram for ilFileSystemDirectoryCopiedRecursivelyObjective:

Collaboration diagram for ilFileSystemDirectoryCopiedRecursivelyObjective:

Public Member Functions
	__construct (string $source_folder, string $target_folder, bool $data_dir=false, bool $bare=false)
	Copies a directory from ILIAS root or from the outer ILIAS data directory depending on the flag $data_dir. More...
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)

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

Protected Attributes
string	$source_folder
string	$target_folder
bool	$data_dir
bool	$bare

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilFileSystemDirectoryCopiedRecursivelyObjective::__construct	(	string	$source_folder,
		string	$target_folder,
		bool	$data_dir = false,
		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 38 of file class.ilFileSystemDirectoryCopiedRecursivelyObjective.php.

References $bare, $data_dir, $source_folder, and $target_folder.

      {
        $this->source_folder = $source_folder;
        $this->target_folder = $target_folder;
        $this->data_dir = $data_dir;
        $this->bare = $bare;
    }

Member Function Documentation

deleteDirRecursive()

ilFileSystemDirectoryCopiedRecursivelyObjective::deleteDirRecursive ( string  $path )

protected

Definition at line 153 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

(

)

Definition at line 53 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

(

)

Definition at line 61 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

(

Setup\Environment

$environment

)

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

References $ini, $source_folder, and deleteDirRecursive().

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

Here is the call graph for this function:

getSourceName()

ilFileSystemDirectoryCopiedRecursivelyObjective::getSourceName ( string  $source )

protected

Definition at line 169 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

(

)

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

                               : bool
    {
        return true;
    }

Field Documentation

$bare

bool ilFileSystemDirectoryCopiedRecursivelyObjective::$bare

protected

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

Referenced by __construct().

$data_dir

bool ilFileSystemDirectoryCopiedRecursivelyObjective::$data_dir

protected

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

Referenced by __construct().

$source_folder

string ilFileSystemDirectoryCopiedRecursivelyObjective::$source_folder

protected

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

Referenced by __construct(), and getPreconditions().

$target_folder

string ilFileSystemDirectoryCopiedRecursivelyObjective::$target_folder

protected

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

Referenced by __construct().

---

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

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