ILIAS\Filesystem\Util\LegacyPathHelper Class Reference

Class LegacyPathHelper. More...

Collaboration diagram for ILIAS\Filesystem\Util\LegacyPathHelper:

Static Public Member Functions
static	deriveLocationFrom (string $absolute_path)
static	deriveFilesystemFrom (string $absolute_path)
	Tries to fetch the filesystem responsible for the absolute path. More...
static	createRelativePath (string $absolute_path)
	Creates a relative path from an absolute path which starts with a valid storage location. More...

Static Private Member Functions
static	resolveRelativePath (string $possible_path, string $absolute_path)
static	checkPossiblePath (string $possible_path, string $absolute_path)
static	listPaths ()

Detailed Description

Class LegacyPathHelper.

The legacy path helper provides convenient functions for the integration of the filesystem service within legacy components. This class should be deprecated with ILIAS 5.5 or earlier.

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Since

5.3

Version

1.0.0

Definition at line 37 of file LegacyPathHelper.php.

Member Function Documentation

checkPossiblePath()

static ILIAS\Filesystem\Util\LegacyPathHelper::checkPossiblePath ( string  $possible_path, string  $absolute_path  )

staticprivate

Parameters

string	$possible_path
string	$absolute_path

Returns

bool

Definition at line 228 of file LegacyPathHelper.php.

                                                                                           : bool
    {
        $real_possible_path = realpath($possible_path);

        switch (true) {
            case $possible_path === $absolute_path:
                return true;
            case $real_possible_path === $absolute_path:
                return true;
            case is_string($possible_path) && strpos($absolute_path, $possible_path) === 0:
                return true;
            case is_string($real_possible_path) && strpos($absolute_path, $real_possible_path) === 0:
                return true;
            default:
                return false;
        }
    }

createRelativePath()

static ILIAS\Filesystem\Util\LegacyPathHelper::createRelativePath ( string  $absolute_path )

static

Creates a relative path from an absolute path which starts with a valid storage location.

The primary use case for this method is to trim the path after the filesystem was fetch via the deriveFilesystemFrom method.

Parameters

string

$absolute_path

The path which should be trimmed.

Returns

string The trimmed relative path.

Exceptions

Definition at line 144 of file LegacyPathHelper.php.

Referenced by LegacyPathHelperHelper\createRelativePath(), ilFileSystemAbstractionStorage\createRelativePathForFileSystem(), ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction\interaction(), ILIAS\ResourceStorage\StorageHandler\FileSystemBased\AbstractFileSystemStorageHandler\storeStream(), ILIAS\Filesystem\Util\LegacyPathHelperTest\testCreateRelativePathWithInvalidTargetWhichShouldFail(), ILIAS\Filesystem\Util\LegacyPathHelperTest\testCreateRelativePathWithStorageTargetWhichShouldSucceed(), and ILIAS\Filesystem\Util\LegacyPathHelperTest\testCreateRelativePathWithWebTargetWhichShouldSucceed().

                                                                    : string
    {
        [
            $web,
            $webRelativeWithLeadingDot,
            $webRelativeWithoutLeadingDot,
            $storage,
            $customizing,
            $customizingRelativeWithLeadingDot,
            $libs,
            $libsRelativeWithLeadingDot,
            $temp,
            $nodeModules,
            $nodeModulesWithLeadingDot
            ] = self::listPaths();

        switch (true) {
            // web without ./
            case self::checkPossiblePath($webRelativeWithoutLeadingDot, $absolute_path):
                return self::resolveRelativePath($webRelativeWithoutLeadingDot, $absolute_path);
            // web with ./
            case self::checkPossiblePath($webRelativeWithLeadingDot, $absolute_path):
                return self::resolveRelativePath($webRelativeWithLeadingDot, $absolute_path);
            // web/
            case self::checkPossiblePath($web, $absolute_path):
                return self::resolveRelativePath($web, $absolute_path);
            // temp/
            case self::checkPossiblePath($temp, $absolute_path):
                return self::resolveRelativePath($temp, $absolute_path);
            // iliasdata/
            case self::checkPossiblePath($storage, $absolute_path):
                return self::resolveRelativePath($storage, $absolute_path);
            // Customizing/
            case self::checkPossiblePath($customizing, $absolute_path):
                return self::resolveRelativePath($customizing, $absolute_path);
            // ./Customizing/
            case self::checkPossiblePath($customizingRelativeWithLeadingDot, $absolute_path):
                return self::resolveRelativePath($customizingRelativeWithLeadingDot, $absolute_path);
            // libs/
            case self::checkPossiblePath($libs, $absolute_path):
                // ./libs
            case self::checkPossiblePath($libsRelativeWithLeadingDot, $absolute_path):
                return self::resolveRelativePath($libsRelativeWithLeadingDot, $absolute_path);
            // node_modules/
            case self::checkPossiblePath($nodeModules, $absolute_path):
                // ./node_modules
            case self::checkPossiblePath($nodeModulesWithLeadingDot, $absolute_path):
                return self::resolveRelativePath($nodeModulesWithLeadingDot, $absolute_path);
            default:
                throw new \InvalidArgumentException("Invalid path supplied. Path must start with the web, storage, temp, customizing or libs storage location. Path given: '{$absolute_path}'");
        }
    }

Here is the caller graph for this function:

deriveFilesystemFrom()

static ILIAS\Filesystem\Util\LegacyPathHelper::deriveFilesystemFrom ( string  $absolute_path )

static

Tries to fetch the filesystem responsible for the absolute path.

Please note that the function is case sensitive.

Relative paths are also detected for the ILIAS web storage like './data/default'

Parameters

string

$absolute_path

The absolute used for the filesystem search.

Returns

Filesystem The responsible filesystem for the given path.

Exceptions

Definition at line 87 of file LegacyPathHelper.php.

References ILIAS\Filesystem\filesystems().

Referenced by ILIAS\Filesystem\Util\LegacyPathHelperTest\testDeriveFilesystemFromWithAbsoluteLibsTargetWhichShouldSucceed(), ILIAS\Filesystem\Util\LegacyPathHelperTest\testDeriveFilesystemFromWithInvalidTargetWhichShouldFail(), ILIAS\Filesystem\Util\LegacyPathHelperTest\testDeriveFilesystemFromWithRelativeLibsTargetWhichShouldSucceed(), ILIAS\Filesystem\Util\LegacyPathHelperTest\testDeriveFilesystemFromWithStorageTargetWhichShouldSucceed(), and ILIAS\Filesystem\Util\LegacyPathHelperTest\testDeriveFilesystemFromWithWebTargetWhichShouldSucceed().

                                                                      : Filesystem
    {
        [
            $web,
            $webRelativeWithLeadingDot,
            $webRelativeWithoutLeadingDot,
            $storage,
            $customizing,
            $customizingRelativeWithLeadingDot,
            $libs,
            $libsRelativeWithLeadingDot,
            $temp,
            $nodeModules,
            $nodeModulesWithLeadingDot
            ] = self::listPaths();

        switch (true) {
            case self::checkPossiblePath($temp, $absolute_path):
                return self::filesystems()->temp();
            case self::checkPossiblePath($web, $absolute_path):
                return self::filesystems()->web();
            case self::checkPossiblePath($webRelativeWithLeadingDot, $absolute_path):
                return self::filesystems()->web();
            case self::checkPossiblePath($webRelativeWithoutLeadingDot, $absolute_path):
                return self::filesystems()->web();
            case self::checkPossiblePath($storage, $absolute_path):
                return self::filesystems()->storage();
            case self::checkPossiblePath($customizing, $absolute_path):
                return self::filesystems()->customizing();
            case self::checkPossiblePath($customizingRelativeWithLeadingDot, $absolute_path):
                return self::filesystems()->customizing();
            case self::checkPossiblePath($libs, $absolute_path):
                return self::filesystems()->libs();
            case self::checkPossiblePath($libsRelativeWithLeadingDot, $absolute_path):
                return self::filesystems()->libs();
            case self::checkPossiblePath($nodeModules, $absolute_path):
                return self::filesystems()->nodeModules();
            case self::checkPossiblePath($nodeModulesWithLeadingDot, $absolute_path):
                return self::filesystems()->nodeModules();
            default:
                throw new \InvalidArgumentException("Invalid path supplied. Path must start with the web, storage, temp, customizing or libs storage location. Path given: '{$absolute_path}'");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deriveLocationFrom()

static ILIAS\Filesystem\Util\LegacyPathHelper::deriveLocationFrom ( string  $absolute_path )

static

Definition at line 41 of file LegacyPathHelper.php.

Referenced by ILIAS\ResourceStorage\StorageHandler\FileSystemBased\AbstractFileSystemStorageHandler\storeStream().

                                                                    : int
    {
        [
            $web,
            $webRelativeWithLeadingDot,
            $webRelativeWithoutLeadingDot,
            $storage,
            $customizing,
            $customizingRelativeWithLeadingDot,
            $libs,
            $libsRelativeWithLeadingDot,
            $temp,
            $nodeModules,
            $nodeModulesWithLeadingDot
            ] = self::listPaths();

        switch (true) {
            case self::checkPossiblePath($temp, $absolute_path):
                return Location::TEMPORARY;
            case self::checkPossiblePath($web, $absolute_path):
            case self::checkPossiblePath($webRelativeWithLeadingDot, $absolute_path):
            case self::checkPossiblePath($webRelativeWithoutLeadingDot, $absolute_path):
                return Location::WEB;
            case self::checkPossiblePath($storage, $absolute_path):
                return Location::STORAGE;
            case self::checkPossiblePath($customizing, $absolute_path):
            case self::checkPossiblePath($customizingRelativeWithLeadingDot, $absolute_path):
                return Location::CUSTOMIZING;
            default:
                throw new \InvalidArgumentException("Invalid path supplied. Path must start with the web, storage, temp, customizing or libs storage location. Path given: '{$absolute_path}'");
        }
    }

Here is the caller graph for this function:

listPaths()

static ILIAS\Filesystem\Util\LegacyPathHelper::listPaths ( )

staticprivate

Returns

array

Definition at line 250 of file LegacyPathHelper.php.

References CLIENT_DATA_DIR, CLIENT_ID, CLIENT_WEB_DIR, and ILIAS_WEB_DIR.

                                       : array
    {
        $web = CLIENT_WEB_DIR;
        $webRelativeWithLeadingDot = './' . ILIAS_WEB_DIR . '/' . CLIENT_ID;
        $webRelativeWithoutLeadingDot = ILIAS_WEB_DIR . '/' . CLIENT_ID;
        $storage = CLIENT_DATA_DIR;
        $customizing = ILIAS_ABSOLUTE_PATH . '/Customizing';
        $customizingRelativeWithLeadingDot = './Customizing';
        $libs = ILIAS_ABSOLUTE_PATH . '/libs';
        $libsRelativeWithLeadingDot = "./libs";
        $temp = CLIENT_DATA_DIR . "/temp";
        $nodeModules = ILIAS_ABSOLUTE_PATH . '/node_modules';
        $nodeModulesWithLeadingDot = './node_modules';

        return array($web,
                     $webRelativeWithLeadingDot,
                     $webRelativeWithoutLeadingDot,
                     $storage,
                     $customizing,
                     $customizingRelativeWithLeadingDot,
                     $libs,
                     $libsRelativeWithLeadingDot,
                     $temp,
                     $nodeModules,
                     $nodeModulesWithLeadingDot
        );
    }

resolveRelativePath()

static ILIAS\Filesystem\Util\LegacyPathHelper::resolveRelativePath ( string  $possible_path, string  $absolute_path  )

staticprivate

Definition at line 198 of file LegacyPathHelper.php.

                                                                                             : string
    {
        $real_possible_path = realpath($possible_path);

        switch (true) {
            case $possible_path === $absolute_path:
            case $real_possible_path === $absolute_path:
                return "";
            case strpos($absolute_path, $possible_path) === 0:
                return substr(
                    $absolute_path,
                    strlen($possible_path) + 1
                );                             //also remove the trailing slash
            case strpos($absolute_path, $real_possible_path) === 0:
                return substr(
                    $absolute_path,
                    strlen($real_possible_path) + 1
                );                             //also remove the trailing slash
            default:
                throw new \InvalidArgumentException("Invalid path supplied. Path must start with the web, storage, temp, customizing or libs storage location. Path given: '{$absolute_path}'");
        }
    }

---

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

• src/Filesystem/Util/LegacyPathHelper.php