ILIAS\Filesystem\Provider\DelegatingFilesystemFactory Class Reference

The delegating filesystem factory delegates the instance creation to the factory of the concrete implementation and applies all necessary decorators. More...

Inheritance diagram for ILIAS\Filesystem\Provider\DelegatingFilesystemFactory:

Collaboration diagram for ILIAS\Filesystem\Provider\DelegatingFilesystemFactory:

Public Member Functions
	__construct (private FilenameSanitizer $sanitizer, private DirectoryPathConfig $directory_path_config)
	DelegatingFilesystemFactory constructor. More...
	getLocal (LocalConfig $config, bool $read_only=false)
	@deprectaed More...
	buildFor (string $fqdn_interface, bool $read_only=false)
	getLocal (LocalConfig $config, bool $read_only=false)
	buildFor (string $fqdn_interface, bool $read_only=false)

Private Attributes
FlySystemFilesystemFactory	$implementation

Detailed Description

The delegating filesystem factory delegates the instance creation to the factory of the concrete implementation and applies all necessary decorators.

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 44 of file DelegatingFilesystemFactory.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Provider\DelegatingFilesystemFactory::__construct	(	private FilenameSanitizer	$sanitizer,
		private DirectoryPathConfig	$directory_path_config
	)

DelegatingFilesystemFactory constructor.

Definition at line 51 of file DelegatingFilesystemFactory.php.

      {
        /*
         * ---------- ABSTRACTION SWITCH -------------
         * Change the factory to switch to another filesystem abstraction!
         * current: FlySystem from the php league
         * -------------------------------------------
         */
        $this->implementation = new FlySystemFilesystemFactory();
    }

Member Function Documentation

buildFor()

ILIAS\Filesystem\Provider\DelegatingFilesystemFactory::buildFor	(	string	$fqdn_interface,
		bool	$read_only = false
	)

Implements ILIAS\Filesystem\Provider\FilesystemFactory.

Definition at line 77 of file DelegatingFilesystemFactory.php.

                                                                             : Filesystem
    {
        $config = match ($fqdn_interface) {
            FilesystemWeb::class => new LocalConfig($this->directory_path_config->getWebDirectoryPath()),
            FilesystemStorage::class => new LocalConfig($this->directory_path_config->getStorageDirectoryPath()),
            FilesystemTemp::class => new LocalConfig($this->directory_path_config->getTempDirectoryPath()),
            FilesystemCustomizing::class => new LocalConfig(
                $this->directory_path_config->getCustomizingDirectoryPath()
            ),
            FilesystemLibs::class => new LocalConfig($this->directory_path_config->getLibsDirectoryPath()),
            FilesystemNodeModules::class => new LocalConfig(
                $this->directory_path_config->getNodeModulesDirectoryPath()
            ),
            default => throw new \InvalidArgumentException("Unknown filesystem interface $fqdn_interface")
        };
 
        // the code directories are never written to at runtime
        $read_only = $read_only || in_array(
            $fqdn_interface,
            [FilesystemLibs::class, FilesystemNodeModules::class],
            true
        );
 
        if ($read_only) {
            return new ReadOnlyDecorator(
                new FilesystemWhitelistDecorator($this->implementation->getLocal($config), $this->sanitizer)
            );
        }
        return new FilesystemWhitelistDecorator($this->implementation->getLocal($config), $this->sanitizer);
    }

getLocal()

ILIAS\Filesystem\Provider\DelegatingFilesystemFactory::getLocal	(	LocalConfig	$config,
		bool	$read_only = false
	)

@deprectaed

Implements ILIAS\Filesystem\Provider\FilesystemFactory.

Definition at line 67 of file DelegatingFilesystemFactory.php.

                                                                          : Filesystem
    {
        if ($read_only) {
            return new ReadOnlyDecorator(
                new FilesystemWhitelistDecorator($this->implementation->getLocal($config), $this->sanitizer)
            );
        }
        return new FilesystemWhitelistDecorator($this->implementation->getLocal($config), $this->sanitizer);
    }

Field Documentation

$implementation

FlySystemFilesystemFactory ILIAS\Filesystem\Provider\DelegatingFilesystemFactory::$implementation

private

Definition at line 46 of file DelegatingFilesystemFactory.php.

---

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

• components/ILIAS/Filesystem/src/Provider/DelegatingFilesystemFactory.php