FlysystemVolume

Type

Abstract Class

Namespace

craft\base

Inherits

craft\base\FlysystemVolume » craft\base\Volume » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\SavableComponentInterface, craft\base\VolumeInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\base\SavableComponentTrait, craft\base\VolumeTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Extended by

craft\volumes\Local, craft\volumes\Temp

FlysystemVolume is the base class for Flysystem-based volume classes.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
dateCreated	DateTime, null – The date that the component was created
dateUpdated	DateTime, null – The date that the component was last updated
errors	array – Errors for all attributes or the specified attribute.
fieldLayout	craft\models\FieldLayout, null
fieldLayoutId	integer, null – Field layout ID
firstErrors	array – The first errors.
handle	string, null – Handle
hasUrls	boolean, null – Whether the volume has a public URL
id	integer, string, null – The component’s ID (could be a temporary one: "new:X")
isNew	boolean – Whether the component is new (unsaved)
iterator	ArrayIterator – An iterator for traversing the items in the list.
name	string, null – Name
rootUrl	string, false – The root URL, or false if there isn’t one
scenario	string – The scenario that this model is in.
settings	array – The component’s settings
settingsHtml	string, null
sortOrder	integer, null – Sort order
titleTranslationKeyFormat	string, null – Title translation key format
titleTranslationMethod	string – Title translation method
uid	string, null – UID
url	string, null – The volume’s URL
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

Protected Properties

Property	Description
foldersHaveTrailingSlashes	boolean – Whether the Flysystem adapter expects folder names to have trailing slashes

foldersHaveTrailingSlashes

Type

boolean

Default value

true

Whether the Flysystem adapter expects folder names to have trailing slashes

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.
addError()	Adds a new error to the specified attribute.
addErrors()	Adds a list of errors.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterDelete()	Performs actions after a component is deleted.
afterSave()	Performs actions after a component is saved.
afterValidate()	This method is invoked after validation ends.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
attributeHints()	Returns the attribute hints.
attributeLabels()	Returns the attribute labels.
attributes()	Returns the list of attribute names.
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.
beforeValidate()	This method is invoked before validation starts.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
clearErrors()	Removes errors for all attributes or a single attribute.
copyFile()	Copies a file.
createDir()	Creates a directory.
createDirectory()	Creates a directory.
createFileByStream()	Creates a file.
createValidators()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
deleteDir()	Deletes a directory.
deleteDirectory()	Deletes a directory.
deleteFile()	Deletes a file.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
directoryExists()	Returns whether a directory exists at the given path.
displayName()	Returns the display name of this class.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
fileExists()	Returns whether a file exists.
folderExists()	Returns whether a folder exists at the given path.
formName()	Returns the form name that this model class should use.
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()	Returns the validators applicable to the current scenario.
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributes()	Returns attribute values.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getDateModified()	Returns the last time the file was modified.
getError()	Returns the first error of the specified attribute.
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFieldLayout()	Returns the volume's field layout, or null if it doesn’t have one.
getFileList()	List files.
getFileMetadata()	Return the metadata about a file.
getFileSize()	Returns the file size.
getFileStream()	Gets a stream ready for reading by a file's URI.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getIsNew()	Returns whether the component is new (unsaved).
getIterator()	Returns an iterator for traversing the attributes in the model.
getRootUrl()	Returns the URL to the source, if it’s accessible via HTTP traffic.
getScenario()	Returns the scenario that this model is used in.
getSettings()	Returns an array of the component’s settings.
getSettingsHtml()	Returns the component’s settings HTML.
getValidators()	Returns all the validators declared in rules().
hasErrors()	Returns a value indicating whether there is any validation error.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
instance()	Returns static class instance, which can be used to obtain meta information.
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()	Returns a value indicating whether the attribute is required.
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.
isSelectable()	Returns whether the component should be selectable in component Type selects.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
off()	Detaches an existing event handler from this component.
offsetExists()	Returns whether there is an element at the specified offset.
offsetGet()	Returns the element at the specified offset.
offsetSet()	Sets the element at the specified offset.
offsetUnset()	Sets the element value at the specified offset to null.
on()	Attaches an event handler to an event.
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.
renameDir()	Renames a directory.
renameDirectory()	Renames a directory.
renameFile()	Renames a file.
rules()	Returns the validation rules for attributes.
safeAttributes()	Returns the attribute names that are safe to be massively assigned in the current scenario.
saveFileLocally()	Save a file from the source's uriPath to a local target path.
scenarios()	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setScenario()	Sets the scenario for the model.
settingsAttributes()	Returns the list of settings attribute names.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
updateFileByStream()	Updates a file.
validate()	Performs the data validation.
validateFieldLayout()	Validates the field layout.
validateMultiple()	Validates multiple models.

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

Throws

• craft\errors\VolumeObjectExistsException
  if a file with such a name exists already
• craft\errors\VolumeObjectNotFoundException
  if the file to be renamed cannot be found
• craft\errors\VolumeException
  if something else goes wrong

createDirectory()

Since

3.6.0

Creates a directory.

View source

Arguments

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

Throws

• craft\errors\VolumeObjectExistsException
  if a directory with such name already exists
• craft\errors\VolumeException
  if something else goes wrong

createFileByStream()

Creates a file.

View source

Arguments

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

Throws

• craft\errors\VolumeObjectExistsException
  if a file already exists at the path on the volume
• craft\errors\VolumeException
  if something else goes wrong

deleteDirectory()

Since

3.6.0

Deletes a directory.

View source

Arguments

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

Throws

• craft\errors\VolumeException
  if something goes wrong

deleteFile()

Deletes a file.

View source

Arguments

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

Throws

• craft\errors\VolumeException
  if something goes wrong

fileExists()

Returns whether a file exists.

View source

Arguments

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

Returns

boolean

folderExists()

Returns whether a folder exists at the given path.

View source

Arguments

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

Returns

boolean

getDateModified()

Since

3.6.0

Returns the last time the file was modified.

View source

Arguments

• $uri (string)

Returns

integer, null

Throws

• craft\errors\VolumeObjectNotFoundException
  if the file cannot be found

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

Returns

array

getFileMetadata()

Return the metadata about a file.

View source

Arguments

• $uri (string) – URI to the file on the volume

Returns

array

Throws

• craft\errors\VolumeObjectNotFoundException
  if the file cannot be found

getFileSize()

Since

3.6.0

Returns the file size.

View source

Arguments

• $uri (string)

Returns

integer, null

Throws

• craft\errors\VolumeObjectNotFoundException
  if the file cannot be found

getFileStream()

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

View source

Arguments

• $uriPath (string)

Returns

resource

Throws

• craft\errors\AssetException
  if a stream cannot be created

renameDirectory()

Since

3.6.0

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

• craft\errors\VolumeObjectNotFoundException
  if a directory with such name already exists
• craft\errors\VolumeObjectExistsException
  if a directory with such name already exists
• craft\errors\VolumeException
  if something else goes wrong

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

Throws

• craft\errors\VolumeObjectExistsException
  if a file with such a name exists already
• craft\errors\VolumeObjectNotFoundException
  if the file to be renamed cannot be found
• craft\errors\VolumeException
  if something else goes wrong

saveFileLocally()

Save a file from the source's uriPath to a local target path.

View source

Arguments

• $uriPath (string)
• $targetPath (string)

Returns

integer – Amount of bytes copied

updateFileByStream()

Updates a file.

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 to the adapter

Throws

• craft\errors\VolumeObjectNotFoundException
  if the file to be updated cannot be found
• craft\errors\VolumeException
  if something else goes wrong

Protected Methods

Method	Description
adapter()	Returns the Flysystem adapter instance.
addFileMetadataToConfig()	Adds file metadata to the config array.
createAdapter()	Creates and returns a Flysystem adapter instance based on the stored settings.
defineRules()	Returns the validation rules for attributes.
extractFieldsFor()	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()	Extracts the root field names from nested fields.
fetchFileMetadata()	Fetch the file metadata from the volume, optionally caching the result.
filesystem()	Returns Flysystem filesystem configured with the Flysystem adapter.
invalidateCdnPath()	Invalidate a CDN path on the volume.
resolveFields()	Determines which fields can be returned by toArray().
visibility()	Returns the visibility setting for the volume.

adapter()

Returns the Flysystem adapter instance.

View source

Returns

\League\Flysystem\AdapterInterface – The Flysystem adapter.

addFileMetadataToConfig()

Adds file metadata to the config array.

View source

Arguments

• $config (array)

Returns

array

createAdapter()

Creates and returns a Flysystem adapter instance based on the stored settings.

View source

Returns

\League\Flysystem\AdapterInterface – The Flysystem adapter.

fetchFileMetadata()

Since

3.6.0

Fetch the file metadata from the volume, optionally caching the result.

View source

Arguments

• $uri (string)
• $bypassCache (false)

Returns

array, false, mixed

Throws

• craft\errors\VolumeObjectNotFoundException

filesystem()

Returns Flysystem filesystem configured with the Flysystem adapter.

View source

Arguments

• $config (array)

Returns

\League\Flysystem\Filesystem – The Flysystem filesystem.

invalidateCdnPath()

Invalidate a CDN path on the volume.

View source

Arguments

• $path (string) – The path to invalidate

Returns

boolean

visibility()

Returns the visibility setting for the volume.

View source

Returns

string

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.