com\setasign\SetaSite\FileSystem

FilesystemManager Interface FilesystemInterface

File: /SetaSite/src/FileSystem/FilesystemManager.php

Class hierarchy

Implements

Summary

Constants

FILETYPE_DIRECTORY

public const FilesystemInterface::FILETYPE_DIRECTORY = 'directory'

FILETYPE_FILE

public const FilesystemInterface::FILETYPE_FILE = 'file'

FILETYPE_FILESYSTEM

public const FilesystemInterface::FILETYPE_FILESYSTEM = 'filesystem'

Properties

$filesystems


Methods

__construct()

public FilesystemManager::__construct (
FilesystemFactoryInterface $filesystemFactory,
array|\Traversable $config
)
Parameters
$filesystemFactory: FilesystemFactoryInterface
 
$config: array|\Traversable
 
Exceptions

Throws \com\setasign\SetaSite\Exception If there is an error while building the filesystem.

createDirectory()

public FilesystemManager::createDirectory (
?string $path,
string $directoryName
): void
Parameters
$path: ?string
 
$directoryName: string
 
Exceptions

Throws InvalidPathException

Throws FilesystemException

createFile()

Parameters
$path: ?string
 
$file: \com\setasign\SetaFramework\FileSystem\File
 
Exceptions

Throws FilesystemException

Throws InvalidPathException

delete()

public FilesystemManager::delete (
string $path
): void
Parameters
$path: string
 
Exceptions

Throws InvalidPathException

Throws FilesystemException

getAlternativeExternalPath()

public FilesystemManager::getAlternativeExternalPath (
string $path
): ?string
Parameters
$path: string
 
Exceptions

Throws InvalidPathException

getFile()

Parameters
$path: string
 
Exceptions

Throws InvalidPathException

Throws FilesystemException

getFiles()

public FilesystemManager::getFiles (
?string $path = null,
?array $allowedExtensions = null
): array
Parameters
$path: ?string

The internal path to the directory. Null is the root path.

$allowedExtensions: ?array
 
Exceptions

Throws InvalidPathException

getFilesystem()

Parameters
$name: string
 

getName()

public FilesystemManager::getName (
void
): string

isDirectory()

public FilesystemManager::isDirectory (
string $path
): bool
Parameters
$path: string
 

isFile()

public FilesystemManager::isFile (
string $path
): bool
Parameters
$path: string
 

isFileSystem()

public FilesystemManager::isFileSystem (
string $path
): bool
Parameters
$path: string
 

rename()

public FilesystemManager::rename (
string $path,
string $newPath
): void
Parameters
$path: string
 
$newPath: string
 
Exceptions

Throws InvalidPathException

Throws FilesystemException

splitPath()

protected FilesystemManager::splitPath (
string $path
): array
Parameters
$path: string