Fs

Type
Class
Namespace
craft\services
Inherits
craft\services\Fs » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
4.0.0

Filesystems service.

An instance of the service is available via \craft\base\ApplicationTrait::getfs().

View source (opens new window)

# Public Properties

Property Description
allFilesystemTypes string (opens new window)[] – All registered filesystem types
allFilesystems craft\base\FsInterface[] – All filesystems
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.

# allFilesystemTypes

Type
string (opens new window)[]
Default value
null

All registered filesystem types

View source (opens new window)

# allFilesystems

Type
craft\base\FsInterface[]
Default value
null

All filesystems

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window) This method is called after the object is created by cloning an existing one.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__serialize() Serializer
__set() (opens new window) Sets the value of a component property.
__unset() (opens new window) Sets a component property to be null.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
behaviors() (opens new window) Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
createFilesystem() Creates a filesystem from a given config.
createFilesystemConfig() Returns the config for the given filesystem.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getAllFilesystemTypes() Returns all registered filesystem types.
getAllFilesystems() Returns all filesystems.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getFilesystemByHandle() Returns a filesystem by its handle.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined for this component.
init() (opens new window) Initializes the object.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
removeFilesystem() Removes a filesystem.
saveFilesystem() Creates or updates a filesystem.
trigger() (opens new window) Triggers an event.

# __serialize()

Serializer

View source (opens new window)

# createFilesystem()

Creates a filesystem from a given config.

View source (opens new window)

Arguments

Returns

\craft\services\T – The filesystem

# createFilesystemConfig()

Returns the config for the given filesystem.

View source (opens new window)

Arguments

Returns

array (opens new window)

# getAllFilesystemTypes()

Returns all registered filesystem types.

View source (opens new window)

Returns

string (opens new window)[]

# getAllFilesystems()

Returns all filesystems.

View source (opens new window)

Returns

craft\base\FsInterface[]

# getFilesystemByHandle()

Returns a filesystem by its handle.

View source (opens new window)

Arguments

Returns

craft\base\FsInterface, null (opens new window)

# removeFilesystem()

Removes a filesystem.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# saveFilesystem()

Creates or updates a filesystem.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the filesystem was saved successfully

Throws

# Events

# EVENT_REGISTER_FILESYSTEM_TYPES

Type
craft\events\RegisterComponentTypesEvent

The event that is triggered when registering filesystem types.

# EVENT_RENAME_FILESYSTEM

Type
craft\events\FsEvent

The event that is triggered after a filesystem is renamed.