Skip to content

BaseFsInterface

Type
Interface
Namespace
craft\base
Implemented by
craft\base\FsInterface, craft\models\Volume
Since
4.4.0

BaseFsInterface defines the common interface to be implemented by filesystem classes and volume model.

View source

Public Methods

MethodDescription
copyFile()Copies a file.
createDirectory()Creates a directory.
deleteDirectory()Deletes a directory.
deleteFile()Deletes a file.
directoryExists()Returns whether a directory exists at the given path.
fileExists()Returns whether a file exists.
getDateModified()Returns the last time the file was modified.
getFileList()List files.
getFileSize()Return the file size.
getFileStream()Gets a stream ready for reading by a file's URI.
getRootUrl()Returns the root URL for a filesystem, if it has one.
read()Reads contents of a file to a string.
renameDirectory()Renames a directory.
renameFile()Renames a file.
write()Writes a string to a file.
writeFileFromStream()Writes a file to a fs from a given stream.

copyFile()

Copies a file.

View source

Arguments

  • $path (string) – The path of the file, relative to the source’s root
  • $newPath (string) – The path of the new file, relative to the source’s root
  • $config (array) – Additional config options to pass on

Throws

createDirectory()

Creates a directory.

View source

Arguments

  • $path (string) – The path of the directory, relative to the source’s root
  • $config (array) – The config to use

Throws

deleteDirectory()

Deletes a directory.

View source

Arguments

  • $path (string) – The path of the directory, relative to the source’s root

Throws

deleteFile()

Deletes a file.

View source

Arguments

  • $path (string) – The path of the file, relative to the source’s root

directoryExists()

Returns whether a directory exists at the given path.

View source

Arguments

  • $path (string) – The directory path to check

Returns

boolean

Throws

fileExists()

Returns whether a file exists.

View source

Arguments

  • $path (string) – The path of the file, relative to the source’s root

Returns

boolean

Throws

getDateModified()

Returns the last time the file was modified.

View source

Arguments

Returns

integer

Throws

getFileList()

List files.

View source

Arguments

  • $directory (string) – The path of the directory to list files of
  • $recursive (boolean) – Whether to fetch file list recursively, defaults to true

Returns

Generator

Throws

getFileSize()

Return the file size.

View source

Arguments

Returns

integer

Throws

getFileStream()

Gets a stream ready for reading by a file's URI.

View source

Arguments

Returns

resource

Throws

getRootUrl()

Returns the root URL for a filesystem, if it has one.

View source

Returns

string, null

read()

Reads contents of a file to a string.

View source

Arguments

  • $path (string) – The path of the file

Returns

string

renameDirectory()

Renames a directory.

View source

Arguments

  • $path (string) – The path of the directory, relative to the source’s root
  • $newName (string) – The new path of the directory, relative to the source’s root

Throws

renameFile()

Renames a file.

View source

Arguments

  • $path (string) – The old path of the file, relative to the source’s root
  • $newPath (string) – The new path of the file, relative to the source’s root
  • $config (array) – Additional config options to pass on

Throws

write()

Writes a string to a file.

View source

Arguments

  • $path (string) – The path of the file
  • $contents (string) – The file contents to write
  • $config (array) – Additional config options to pass on

Throws

writeFileFromStream()

Writes a file to a fs from a given stream.

View source

Arguments

  • $path (string) – The path of the file, relative to the source’s root
  • $stream (resource) – The new contents of the file as a stream
  • $config (array) – Additional config options to pass on

Throws