Inheritance diagram for ilFileSystemAbstractionStorage:

Collaboration diagram for ilFileSystemAbstractionStorage:

Public Member Functions
	__construct (private int $storage_type, private bool $path_conversion, private int $container_id)
	Constructor. More...

	fileExists (string $a_absolute_path)

	getContainerId ()

	writeToFile (string $a_data, $a_absolute_path)

	copyFile (string $a_from, string $a_to)

	create ()

	getAbsolutePath ()
	Calculates the full path on the filesystem. More...

	delete ()

	deleteDirectory (string $a_abs_name)

	deleteFile (string $a_abs_name)

	appendToPath (string $a_appendix)

	getStorageType ()

	getPath ()

Static Public Member Functions
static	createPathFromId (int $a_container_id, string $a_name)

static	_copyDirectory (string $a_sdir, string $a_tdir)

Data Fields
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	STORAGE_SECURED = 3

Protected Member Functions
	getLegacyFullAbsolutePath (string $relative_path)

	getFileSystemService ()

	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

	getLegacyAbsolutePath ()
	Calculates the absolute filesystem storage location. More...

	init ()

Protected Attributes
string	$path = null

Filesystems	$file_system_service

Private Member Functions
	createRelativePathForFileSystem (string $a_absolute_path)

Private Attributes
const	FACTOR = 100

const	MAX_EXPONENT = 3

const	SECURED_DIRECTORY = "sec"

Detailed Description

Deprecated:: Will be removed in ILIAS 10.

Use ILIAS ResourceStorageService as replacement.

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

Constructor & Destructor Documentation

◆ __construct()

ilFileSystemAbstractionStorage::__construct	(	private int	$storage_type,
		private bool	$path_conversion,
		private int	$container_id
	)

Constructor.

Parameters

$a_storage_type	int storage type
$a_path_conversion	bool En/Disable automatic path conversion. If enabled files with id 123 will be stored in directory files/1/file_123 object id of container
$a_container_id	int (e.g file_id or mob_id)

Definition at line 48 of file class.ilFileSystemAbstractionStorage.php.

References $DIC, and init().

     {
         global $DIC;
         $this->file_system_service = $DIC->filesystem();
 
         // Get path info
         $this->init();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _copyDirectory()

static ilFileSystemAbstractionStorage::_copyDirectory	(	string	$a_sdir,
		string	$a_tdir
	)

static

Definition at line 238 of file class.ilFileSystemAbstractionStorage.php.

Referenced by ilFSStorageCourse\_clone().

                                                                          : bool
     {
         try {
             $sourceFS = LegacyPathHelper::deriveFilesystemFrom($a_sdir);
             $targetFS = LegacyPathHelper::deriveFilesystemFrom($a_tdir);
 
             $sourceDir = LegacyPathHelper::createRelativePath($a_sdir);
             $targetDir = LegacyPathHelper::createRelativePath($a_tdir);
 
             // check if arguments are directories
             if (!$sourceFS->hasDir($sourceDir)) {
                 return false;
             }
 
             $sourceList = $sourceFS->listContents($sourceDir, true);
 
             foreach ($sourceList as $item) {
                 if ($item->isDir()) {
                     continue;
                 }
 
                 $itemPath = $targetDir . '/' . substr($item->getPath(), strlen($sourceDir));
                 $stream = $sourceFS->readStream($sourceDir);
                 $targetFS->writeStream($itemPath, $stream);
             }
 
             return true;
         } catch (\Exception) {
             return false;
         }
     }

Here is the caller graph for this function:

◆ appendToPath()

ilFileSystemAbstractionStorage::appendToPath ( string $a_appendix )

Definition at line 270 of file class.ilFileSystemAbstractionStorage.php.

Referenced by ilFSStorageMail\__construct().

                                                     : void
     {
         $this->path .= $a_appendix;
     }

Here is the caller graph for this function:

◆ copyFile()

ilFileSystemAbstractionStorage::copyFile	(	string	$a_from,
		string	$a_to
	)

Deprecated:: Please use StorageService or FilesystemService for all file opertion

Definition at line 128 of file class.ilFileSystemAbstractionStorage.php.

References getPathPostfix(), and getPathPrefix().

                                                           : bool
     {
         if (@file_exists($a_from)) {
             @copy($a_from, $a_to);
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ create()

ilFileSystemAbstractionStorage::create ( )

Definition at line 150 of file class.ilFileSystemAbstractionStorage.php.

References getFileSystemService(), and ILIAS\GlobalScreen\has().

Referenced by ilLearningSequenceFilesystem\__construct(), and ilRestFileStorage\init().

                             : void
     {
         if (!$this->getFileSystemService()->has($this->path)) {
             $this->getFileSystemService()->createDir($this->path);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPathFromId()

static ilFileSystemAbstractionStorage::createPathFromId	(	int	$a_container_id,
		string	$a_name
	)

static

Definition at line 87 of file class.ilFileSystemAbstractionStorage.php.

                                                                                 : string
     {
         $path = [];
         $found = false;
         $num = $a_container_id;
         $path_string = '';
         for ($i = self::MAX_EXPONENT; $i > 0; $i--) {
             $factor = self::FACTOR ** $i;
             if (($tmp = (int) ($num / $factor)) or $found) {
                 $path[] = $tmp;
                 $num %= $factor;
                 $found = true;
             }
         }
 
         if ($path !== []) {
             $path_string = (implode('/', $path) . '/');
         }
 
         return $path_string . $a_name . '_' . $a_container_id;
     }

Here is the caller graph for this function:

◆ createRelativePathForFileSystem()

ilFileSystemAbstractionStorage::createRelativePathForFileSystem ( string $a_absolute_path )

private

Definition at line 285 of file class.ilFileSystemAbstractionStorage.php.

Referenced by deleteDirectory(), deleteFile(), and fileExists().

                                                                              : string
     {
         $relative_path = LegacyPathHelper::createRelativePath($a_absolute_path);
 
         return $relative_path;
     }

Here is the caller graph for this function:

◆ delete()

ilFileSystemAbstractionStorage::delete ( )

Definition at line 213 of file class.ilFileSystemAbstractionStorage.php.

References getAbsolutePath(), and getFileSystemService().

                             : bool
     {
         try {
             $this->getFileSystemService()->deleteDir($this->getAbsolutePath());
         } catch (Exception) {
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ deleteDirectory()

ilFileSystemAbstractionStorage::deleteDirectory ( string $a_abs_name )

Definition at line 224 of file class.ilFileSystemAbstractionStorage.php.

References createRelativePathForFileSystem(), and getFileSystemService().

                                                        : bool
     {
         $path = $this->createRelativePathForFileSystem($a_abs_name);
         $this->getFileSystemService()->deleteDir($path);
         return !$this->getFileSystemService()->has($path);
     }

Here is the call graph for this function:

◆ deleteFile()

ilFileSystemAbstractionStorage::deleteFile ( string $a_abs_name )

Definition at line 231 of file class.ilFileSystemAbstractionStorage.php.

References createRelativePathForFileSystem(), and getFileSystemService().

Referenced by ilLearningSequenceFilesystem\delete_image(), ilIndividualAssessmentFileStorage\deleteAllFilesBut(), ilFSStorageGroup\deleteMemberExportFile(), ilFSStoragePRG\deleteMemberExportFile(), and ilFSStorageCourse\deleteMemberExportFile().

                                                   : bool
     {
         $path = $this->createRelativePathForFileSystem($a_abs_name);
         $this->getFileSystemService()->delete($path);
         return !$this->getFileSystemService()->has($path);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fileExists()

ilFileSystemAbstractionStorage::fileExists ( string $a_absolute_path )

Definition at line 57 of file class.ilFileSystemAbstractionStorage.php.

References createRelativePathForFileSystem(), and getFileSystemService().

Referenced by ilFSStorageGroup\hasMemberExportFile(), ilFSStoragePRG\hasMemberExportFile(), and ilFSStorageCourse\hasMemberExportFile().

                                                        : bool
     {
         return $this->getFileSystemService()->has($this->createRelativePathForFileSystem($a_absolute_path));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAbsolutePath()

ilFileSystemAbstractionStorage::getAbsolutePath ( )

Calculates the full path on the filesystem.

This method is filesystem aware and will create the absolute path if it's not already existing.

Returns: string Absolute filesystem path.

Exceptions

IOException Thrown if the absolute path could not be created.

Definition at line 166 of file class.ilFileSystemAbstractionStorage.php.

References getLegacyAbsolutePath().

Referenced by ilLearningSequenceFilesystem\__construct(), ilFSStorageSession\createDirectory(), delete(), ilFSStorageCourse\getInfoDirectory(), ilFSStoragePRG\getMemberExportDirectory(), ilFSStorageGroup\getMemberExportDirectory(), ilFSStorageCourse\getMemberExportDirectory(), ilFSStorageMail\getRelativePathExMailDirectory(), and ilLearningSequenceFilesystem\getStoragePath().

                                      : string
     {
         return rtrim($this->getLegacyAbsolutePath(), "/");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContainerId()

ilFileSystemAbstractionStorage::getContainerId ( )

Definition at line 82 of file class.ilFileSystemAbstractionStorage.php.

Referenced by ilFSStoragePRG\getMemberExportFiles(), ilFSStorageGroup\getMemberExportFiles(), and ilFSStorageCourse\getMemberExportFiles().

                                     : int
     {
         return $this->container_id;
     }

Here is the caller graph for this function:

◆ getFileSystemService()

ilFileSystemAbstractionStorage::getFileSystemService ( )

protected

Definition at line 69 of file class.ilFileSystemAbstractionStorage.php.

References getStorageType().

Referenced by ilTestProcessLockFileStorage\create(), ilAssQuestionProcessLockFileStorage\create(), create(), delete(), deleteDirectory(), deleteFile(), fileExists(), getLegacyAbsolutePath(), and getLegacyFullAbsolutePath().

                                              : Filesystem
     {
         switch ($this->getStorageType()) {
             case self::STORAGE_DATA:
                 return $this->file_system_service->storage();
             case self::STORAGE_WEB:
             case self::STORAGE_SECURED:
             case self::SECURED_DIRECTORY:
                 return $this->file_system_service->web();
         }
         throw new LogicException('cannot determine correct filesystem');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegacyAbsolutePath()

ilFileSystemAbstractionStorage::getLegacyAbsolutePath ( )

protected

Calculates the absolute filesystem storage location.

Returns: string The absolute path.

Exceptions

IOException Thrown if the directory could not be created.

Definition at line 178 of file class.ilFileSystemAbstractionStorage.php.

References CLIENT_DATA_DIR, CLIENT_WEB_DIR, getFileSystemService(), getStorageType(), and ILIAS\GlobalScreen\has().

Referenced by getAbsolutePath().

                                               : string
     {
         if (!$this->getFileSystemService()->has($this->path)) {
             $this->getFileSystemService()->createDir($this->path);
         }
 
         if ($this->getStorageType() === self::STORAGE_DATA) {
             return rtrim(CLIENT_DATA_DIR, '/') . '/' . ltrim((string) $this->path, '/');
         }
         return rtrim(CLIENT_WEB_DIR, '/') . '/' . ltrim((string) $this->path, '/');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegacyFullAbsolutePath()

ilFileSystemAbstractionStorage::getLegacyFullAbsolutePath ( string $relative_path )

protected

Definition at line 62 of file class.ilFileSystemAbstractionStorage.php.

References getFileSystemService().

                                                                        : string
     {
         $stream = $this->getFileSystemService()->readStream($relative_path);
 
         return $stream->getMetadata('uri');
     }

Here is the call graph for this function:

◆ getPath()

ilFileSystemAbstractionStorage::getPath ( )

Definition at line 280 of file class.ilFileSystemAbstractionStorage.php.

References $path.

Referenced by ilTestProcessLockFileStorage\create(), ilRestFileStorage\createFile(), ilRestFileStorage\deleteDeprecated(), ilRestFileStorage\getFile(), ilRestFileStorage\getStoredFilePath(), and ilRestFileStorage\storeFileForRest().

                              : string
     {
         return $this->path;
     }

Here is the caller graph for this function:

◆ getPathPostfix()

ilFileSystemAbstractionStorage::getPathPostfix ( )

abstractprotected

Get directory name.

E.g for files => file Only relative path, no trailing slash '_<obj_id>' will be appended automatically

Referenced by copyFile(), and init().

Here is the caller graph for this function:

◆ getPathPrefix()

ilFileSystemAbstractionStorage::getPathPrefix ( )

abstractprotected

Get path prefix.

Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files

Referenced by copyFile(), and init().

Here is the caller graph for this function:

◆ getStorageType()

ilFileSystemAbstractionStorage::getStorageType ( )

Definition at line 275 of file class.ilFileSystemAbstractionStorage.php.

Referenced by getFileSystemService(), getLegacyAbsolutePath(), and ilFSStorageMail\getRelativePathExMailDirectory().

                                     : int
     {
         return $this->storage_type;
     }

Here is the caller graph for this function:

◆ init()

ilFileSystemAbstractionStorage::init ( )

protected

Definition at line 190 of file class.ilFileSystemAbstractionStorage.php.

References getPathPostfix(), and getPathPrefix().

Referenced by __construct().

                              : bool
     {
         switch ($this->storage_type) {
             case self::STORAGE_DATA:
             case self::STORAGE_WEB:
                 break;
             case self::STORAGE_SECURED:
                 $this->path = rtrim($this->path ?? '', '/') . '/' . self::SECURED_DIRECTORY . '/';
                 break;
         }
 
         // Append path prefix
         $this->path .= ($this->getPathPrefix() . '/');
 
         if ($this->path_conversion) {
             $this->path .= self::createPathFromId($this->container_id, $this->getPathPostfix());
         } else {
             $this->path .= ($this->getPathPostfix() . '_' . $this->container_id);
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeToFile()

ilFileSystemAbstractionStorage::writeToFile	(	string	$a_data,
			$a_absolute_path
	)

Deprecated:: Please use StorageService or FilesystemService for all file opertion

Definition at line 112 of file class.ilFileSystemAbstractionStorage.php.

Referenced by ilFSStorageGroup\addMemberExportFile(), ilFSStorageCourse\addMemberExportFile(), and ilFSStoragePRG\addMemberExportFile().

     {
         if (!$fp = @fopen($a_absolute_path, 'w+')) {
             return false;
         }
         if (@fwrite($fp, $a_data) === false) {
             @fclose($fp);
             return false;
         }
         @fclose($fp);
         return true;
     }