ILIAS\Filesystem\Provider\Configuration\LocalConfig Class Reference

This class is used to configure the local filesystem adapter. More...

Collaboration diagram for ILIAS\Filesystem\Provider\Configuration\LocalConfig:

Public Member Functions
	__construct (private string $rootPath, private int $fileAccessPublic=0744, private int $fileAccessPrivate=0700, private int $directoryAccessPublic=0755, private int $directoryAccessPrivate=0700, private int $lockMode=LOCK_EX, private int $linkBehaviour=self::SKIP_LINKS)
	LocalConfig constructor. More...
	getFileAccessPublic ()
	getFileAccessPrivate ()
	getDirectoryAccessPublic ()
	getDirectoryAccessPrivate ()
	getRootPath ()
	getLockMode ()
	getLinkBehaviour ()

Data Fields
const	DISALLOW_LINKS = 1
const	SKIP_LINKS = 2

Detailed Description

This class is used to configure the local filesystem adapter.

Author

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

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 29 of file LocalConfig.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Provider\Configuration\LocalConfig::__construct	(	private string	$rootPath,
		private int	$fileAccessPublic = 0744,
		private int	$fileAccessPrivate = 0700,
		private int	$directoryAccessPublic = 0755,
		private int	$directoryAccessPrivate = 0700,
		private int	$lockMode = LOCK_EX,
		private int	$linkBehaviour = self::SKIP_LINKS
	)

LocalConfig constructor.

Please note that php threads int values with a leading zero as octal values. Therefore the int 0755 equals 493.

The permission mask: ugo u = owner g = group o = other

r = 4 rx = 5 rw = 6 rwx = 7

read = r read-execute = rx read-write = rw read-write-execute = rwx

Example public mask: u = rwx g = r o = r

rwx r– r– which equals 0744

Example private mask: u = rwx g = - o = -

rwx — — which equals 0700

Parameters

string	$rootPath	The path to the new filesystem root.
int	$fileAccessPublic	Public file access mask in octal.
int	$fileAccessPrivate	Private file access mask in octal.
int	$directoryAccessPublic	Public directory access mask in octal.
int	$directoryAccessPrivate	Private directory access mask in octal.
int	$lockMode	Lock modes are defined as build in constants (LOCK_SH, LOCK_EX).
int	$linkBehaviour	The behaviour how filesystem links should be threaded.

Definition at line 87 of file LocalConfig.php.

      {
    }

Member Function Documentation

getDirectoryAccessPrivate()

ILIAS\Filesystem\Provider\Configuration\LocalConfig::getDirectoryAccessPrivate

(

)

Definition at line 121 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\getInstance().

                                               : int
    {
        return $this->directoryAccessPrivate;
    }

Here is the caller graph for this function:

getDirectoryAccessPublic()

ILIAS\Filesystem\Provider\Configuration\LocalConfig::getDirectoryAccessPublic

(

)

Definition at line 114 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\getInstance().

                                              : int
    {
        return $this->directoryAccessPublic;
    }

Here is the caller graph for this function:

getFileAccessPrivate()

ILIAS\Filesystem\Provider\Configuration\LocalConfig::getFileAccessPrivate

(

)

Definition at line 107 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\getInstance().

                                          : int
    {
        return $this->fileAccessPrivate;
    }

Here is the caller graph for this function:

getFileAccessPublic()

ILIAS\Filesystem\Provider\Configuration\LocalConfig::getFileAccessPublic

(

)

Definition at line 100 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\getInstance().

                                         : int
    {
        return $this->fileAccessPublic;
    }

Here is the caller graph for this function:

getLinkBehaviour()

ILIAS\Filesystem\Provider\Configuration\LocalConfig::getLinkBehaviour

(

)

Definition at line 142 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\getInstance().

                                      : int
    {
        return $this->linkBehaviour;
    }

Here is the caller graph for this function:

getLockMode()

ILIAS\Filesystem\Provider\Configuration\LocalConfig::getLockMode

(

)

Definition at line 135 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\getInstance().

                                 : int
    {
        return $this->lockMode;
    }

Here is the caller graph for this function:

getRootPath()

ILIAS\Filesystem\Provider\Configuration\LocalConfig::getRootPath

(

)

Definition at line 128 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\getInstance().

                                 : string
    {
        return $this->rootPath;
    }

Here is the caller graph for this function:

Field Documentation

DISALLOW_LINKS

const ILIAS\Filesystem\Provider\Configuration\LocalConfig::DISALLOW_LINKS = 1

Definition at line 36 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\mapConfigLinkToLocalLinks().

SKIP_LINKS

const ILIAS\Filesystem\Provider\Configuration\LocalConfig::SKIP_LINKS = 2

Definition at line 41 of file LocalConfig.php.

Referenced by ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactory\mapConfigLinkToLocalLinks(), ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactoryTest\testCreationOfFilesystemWithInvalidFileLockModeWhichShouldFail(), and ILIAS\Filesystem\Provider\FlySystem\FlySystemLocalFilesystemFactoryTest\testCreationOfFilesystemWithLinkSkipBehaviourWhichShouldSucceed().

---

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

• components/ILIAS/Filesystem/src/Provider/Configuration/LocalConfig.php