Inheritance diagram for ilFileSystemAbstractionStorage:

Collaboration diagram for ilFileSystemAbstractionStorage:

Public Member Functions
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...

	fileExists ($a_absolute_path)

	getContainerId ()

	create ()
	Create directory. More...

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

	writeToFile ($a_data, $a_absolute_path)

	deleteFile ($a_absolute_path)

	deleteDirectory ($a_absolute_path)

	delete ()

	copyFile ($a_from, $a_to)

	appendToPath ($a_appendix)

	getStorageType ()

	getPath ()

Static Public Member Functions
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...

static	_copyDirectory ($a_sdir, $a_tdir)

Data Fields
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	STORAGE_SECURED = 3

const	FACTOR = 100

const	MAX_EXPONENT = 3

const	SECURED_DIRECTORY = "sec"

Protected Member Functions
	getLegacyFullAbsolutePath ($relative_path)

	getFileSystemService ()

	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

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

	init ()
	Read path info. More...

Protected Attributes
	$path

Private Member Functions
	createRelativePathForFileSystem ($a_absolute_path)

Private Attributes
	$container_id

	$storage_type

	$path_conversion = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilFileSystemAbstractionStorage::__construct	(	$a_storage_type,
		$a_path_conversion,
		$a_container_id
	)

Constructor.

@access public

Parameters

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

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

    {
        $this->storage_type = $a_storage_type;
        $this->path_conversion = $a_path_conversion;
        $this->container_id = $a_container_id;
 
        // Get path info
        $this->init();
    }

References init().

Here is the call graph for this function:

Member Function Documentation

◆ _copyDirectory()

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

static

Parameters

$a_sdir
$a_tdir

Returns: bool

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

    {
        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 $exception) {
            return false;
        }
    }

◆ _createPathFromId()

static ilFileSystemAbstractionStorage::_createPathFromId	(	$a_container_id,
		$a_name
	)

static

Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5.

Parameters

$a_container_id
$a_name

Returns: string

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

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

References $i, and $path.

Referenced by init().

Here is the caller graph for this function:

◆ appendToPath()

ilFileSystemAbstractionStorage::appendToPath ( $a_appendix )

Parameters

string $a_appendix

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

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

◆ copyFile()

ilFileSystemAbstractionStorage::copyFile	(	$a_from,
		$a_to
	)

Parameters

$a_from
$a_to

Returns: bool

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

    {
        $relative_path_from = $this->createRelativePathForFileSystem($a_from);
        $relative_path_to = $this->createRelativePathForFileSystem($a_to);
        if ($this->getFileSystemService()->has($relative_path_from)) {
            try {
                $this->getFileSystemService()->copy($relative_path_from, $relative_path_to);
            } catch (Exception $e) {
                return false;
            }
        }
 
        return true;
    }

References Vendor\Package\$e, createRelativePathForFileSystem(), getFileSystemService(), and ILIAS\GlobalScreen\has().

Here is the call graph for this function:

◆ create()

ilFileSystemAbstractionStorage::create ( )

Create directory.

@access public

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

    {
        if (!$this->getFileSystemService()->has($this->path)) {
            $this->getFileSystemService()->createDir($this->path);
        }
 
        return true;
    }

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

Here is the call graph for this function:

◆ createRelativePathForFileSystem()

ilFileSystemAbstractionStorage::createRelativePathForFileSystem ( $a_absolute_path )

private

Parameters

$a_absolute_path

Returns: string

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

    {
        $relative_path = ILIAS\Filesystem\Util\LegacyPathHelper::createRelativePath($a_absolute_path);
 
        return $relative_path;
    }

References ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilFileSystemAbstractionStorage::delete ( )

Returns: bool

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

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

References Vendor\Package\$e, getAbsolutePath(), and getFileSystemService().

Here is the call graph for this function:

◆ deleteDirectory()

ilFileSystemAbstractionStorage::deleteDirectory ( $a_absolute_path )

Parameters

$a_absolute_path

Returns: bool

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

    {
        $relative_path = $this->createRelativePathForFileSystem($a_absolute_path);
        if ($this->getFileSystemService()->has($relative_path)) {
            try {
                $this->getFileSystemService()->deleteDir($relative_path);
            } catch (Exception $e) {
                return false;
            }
        }
 
        return true;
    }

References Vendor\Package\$e, createRelativePathForFileSystem(), getFileSystemService(), and ILIAS\GlobalScreen\has().

Here is the call graph for this function:

◆ deleteFile()

ilFileSystemAbstractionStorage::deleteFile ( $a_absolute_path )

Parameters

$a_absolute_path

Returns: bool

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

    {
        $relative_path = $this->createRelativePathForFileSystem($a_absolute_path);
        if ($this->getFileSystemService()->has($relative_path)) {
            try {
                $this->getFileSystemService()->delete($relative_path);
            } catch (Exception $e) {
                return false;
            }
        }
 
        return true;
    }

References Vendor\Package\$e, createRelativePathForFileSystem(), getFileSystemService(), and ILIAS\GlobalScreen\has().

Here is the call graph for this function:

◆ fileExists()

ilFileSystemAbstractionStorage::fileExists ( $a_absolute_path )

Parameters

$a_absolute_path

Returns: bool

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

    {
        $relative_path = $this->createRelativePathForFileSystem($a_absolute_path);
 
        return $this->getFileSystemService()->has($relative_path);
    }

References createRelativePathForFileSystem(), and getFileSystemService().

Here is the call 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 207 of file class.ilFileSystemAbstractionStorage.php.

    {
        return $this->getLegacyAbsolutePath();
    }

References getLegacyAbsolutePath().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContainerId()

ilFileSystemAbstractionStorage::getContainerId ( )

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

    {
        return $this->container_id;
    }

References $container_id.

◆ getFileSystemService()

ilFileSystemAbstractionStorage::getFileSystemService ( )

protected

Returns: \ILIAS\Filesystem\Filesystem

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

    {
        global $DIC;
        switch ($this->getStorageType()) {
            case self::STORAGE_DATA:
                return $DIC->filesystem()->storage();
                break;
            case self::STORAGE_WEB:
            case self::SECURED_DIRECTORY:
                return $DIC->filesystem()->web();
                break;
        }
    }

References $DIC, getStorageType(), SECURED_DIRECTORY, STORAGE_DATA, and STORAGE_WEB.

Referenced by copyFile(), create(), delete(), deleteDirectory(), deleteFile(), fileExists(), getLegacyAbsolutePath(), getLegacyFullAbsolutePath(), and writeToFile().

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 220 of file class.ilFileSystemAbstractionStorage.php.

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

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

Referenced by getAbsolutePath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegacyFullAbsolutePath()

ilFileSystemAbstractionStorage::getLegacyFullAbsolutePath ( $relative_path )

protected

Parameters

$relative_path

Returns: array|mixed|null

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

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

References getFileSystemService().

Here is the call graph for this function:

◆ getPath()

ilFileSystemAbstractionStorage::getPath ( )

Returns: string

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

    {
        return $this->path;
    }

References $path.

◆ getPathPostfix()

ilFileSystemAbstractionStorage::getPathPostfix ( )

abstractprotected

Get directory name.

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

@abstract @access protected

Returns: string directory name

Reimplemented in ilFSStorageFile, and ilFSStorageFile.

Referenced by 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

@abstract @access protected

Returns: string path prefix e.g files

Reimplemented in ilFSStorageFile, and ilFSStorageFile.

Referenced by init().

Here is the caller graph for this function:

◆ getStorageType()

ilFileSystemAbstractionStorage::getStorageType ( )

Returns: int

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

    {
        return $this->storage_type;
    }

References $storage_type.

Referenced by getFileSystemService(), and getLegacyAbsolutePath().

Here is the caller graph for this function:

◆ init()

ilFileSystemAbstractionStorage::init ( )

protected

Read path info.

@access private

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

    {
        switch ($this->storage_type) {
            case self::STORAGE_DATA:
            case self::STORAGE_WEB:
                break;
            case self::STORAGE_SECURED:
                $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;
    }

References $container_id, _createPathFromId(), getPathPostfix(), getPathPrefix(), SECURED_DIRECTORY, STORAGE_DATA, STORAGE_SECURED, and STORAGE_WEB.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeToFile()

ilFileSystemAbstractionStorage::writeToFile	(	$a_data,
		$a_absolute_path
	)

Parameters

$a_data
$a_absolute_path

Returns: bool

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

    {
        $relative_path = $this->createRelativePathForFileSystem($a_absolute_path);
        try {
            $this->getFileSystemService()->write($relative_path, $a_data);
        } catch (Exception $e) {
            return false;
        }
 
        return true;
    }