FsInterface

Type
Interface
Namespace
craft\base
Extends
craft\base\SavableComponentInterface
Implemented by
craft\base\Fs, craft\fs\Local, craft\fs\MissingFs, craft\fs\Temp
Since
4.0.0

FieldInterface defines the common interface to be implemented by filesystem classes.

A class implementing this interface should also use craft\base\SavableComponentTrait and craft\base\FsTrait.

View source (opens new window)

# Public Methods

Method Description
afterDelete() Performs actions after a component is deleted.
afterSave() Performs actions after a component is saved.
beforeApplyDelete() Performs actions before a component delete is applied to the database.
beforeDelete() Performs actions before a component is deleted.
beforeSave() Performs actions before a component is saved.
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.
displayName() Returns the display name of this class.
extraFields() (opens new window) Returns the list of additional fields that can be returned by toArray() (opens new window) in addition to those listed in fields() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
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.
getIsNew() Returns whether the component is new (unsaved).
getSettings() Returns an array of the component’s settings.
getSettingsHtml() Returns the component’s settings HTML.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isSelectable() Returns whether the component should be selectable in component Type selects.
read() Reads contents of a file to a string.
renameDirectory() Renames a directory.
renameFile() Renames a file.
settingsAttributes() Returns the list of settings attribute names.
toArray() (opens new window) Converts the object into an array.
write() Writes a string to a file.
writeFileFromStream() Writes a file to a fs from a given stream.

# copyFile()

Copies a file.

View source (opens new window)

Arguments

Throws

# createDirectory()

Creates a directory.

View source (opens new window)

Arguments

Throws

# deleteDirectory()

Deletes a directory.

View source (opens new window)

Arguments

Throws

# deleteFile()

Deletes a file.

View source (opens new window)

Arguments

# directoryExists()

Returns whether a directory exists at the given path.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# fileExists()

Returns whether a file exists.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# getDateModified()

Returns the last time the file was modified.

View source (opens new window)

Arguments

Returns

integer (opens new window)

Throws

# getFileList()

List files.

View source (opens new window)

Arguments

Returns

Generator (opens new window)

Throws

# getFileSize()

Return the file size.

View source (opens new window)

Arguments

Returns

integer (opens new window)

Throws

# getFileStream()

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

View source (opens new window)

Arguments

Returns

resource (opens new window)

Throws

# read()

Reads contents of a file to a string.

View source (opens new window)

Arguments

Returns

string (opens new window)

# renameDirectory()

Renames a directory.

View source (opens new window)

Arguments

Throws

# renameFile()

Renames a file.

View source (opens new window)

Arguments

Throws

# write()

Writes a string to a file.

View source (opens new window)

Arguments

Throws

# writeFileFromStream()

Writes a file to a fs from a given stream.

View source (opens new window)

Arguments

Throws