FlysystemVolume

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\FlysystemVolume » craft\base\Volume » craft\base\SavableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, 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

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$attributesarray – Attribute values (name => value).
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$dateCreatedDateTime, null – The date that the component was created
$dateUpdatedDateTime, null – The date that the component was last updated
$errorsarray – Errors for all attributes or the specified attribute.
$fieldLayoutIdinteger, null – Field layout ID
$firstErrorsarray – The first errors.
$handlestring, null – Handle
$hasUrlsboolean, null – Whether the volume has a public URL
$idinteger, string, null – The component’s ID (could be a temporary one: "new:X")
$isNewboolean – Whether the component is new
$iteratorArrayIterator – An iterator for traversing the items in the list.
$namestring, null – Name
$rootUrlstring, false – The root URL, or false if there isn’t one
$scenariostring – The scenario that this model is in.
$settingsarray – The component’s settings.
$settingsHtmlstring, null
$sortOrderinteger, null – Sort order
$urlstring, null – The volume’s URL
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

Protected Properties

PropertyDescription
$foldersHaveTrailingSlashesboolean – Whether the Flysystem adapter expects folder names to have trailing slashes

$foldersHaveTrailingSlashes

Type
boolean

Whether the Flysystem adapter expects folder names to have trailing slashes

View source

Signature

protected boolean $foldersHaveTrailingSlashes = true

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
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.
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.
deleteFile()Deletes a file.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
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.
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.
getFileList()List files.
getFileMetadata()Return the metadata about a file.
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.
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.
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()Validates the component.
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

Signature

public void copyFile ( \craft\base\string $path, \craft\base\string $newPath )

createDir()

Creates a directory.

View source

Arguments

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

Throws

Signature

public void createDir ( \craft\base\string $path )

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

Signature

public void createFileByStream ( \craft\base\string $path, $stream, array $config )

deleteDir()

Deletes a directory.

View source

Arguments

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

Throws

Signature

public void deleteDir ( \craft\base\string $path )

deleteFile()

Deletes a file.

View source

Arguments

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

Throws

Signature

public void deleteFile ( \craft\base\string $path )

fileExists()

Returns whether a file exists.

View source

Arguments

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

Returns

boolean

Signature

public boolean fileExists ( \craft\base\string $path )

folderExists()

Returns whether a folder exists at the given path.

View source

Arguments

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

Returns

boolean

Signature

public boolean folderExists ( \craft\base\string $path )

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

Signature

public array getFileList ( \craft\base\string $directory, \craft\base\bool $recursive )

getFileMetadata()

Return the metadata about a file.

View source

Arguments

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

Returns

array

Throws

Signature

public array getFileMetadata ( \craft\base\string $uri )

getFileStream()

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

View source

Arguments

Returns

resource

Throws

Signature

public resource getFileStream ( \craft\base\string $uriPath )

renameDir()

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

Signature

public void renameDir ( \craft\base\string $path, \craft\base\string $newName )

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

Signature

public void renameFile ( \craft\base\string $path, \craft\base\string $newPath )

saveFileLocally()

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

View source

Arguments

Returns

integer – Amount of bytes copied

Signature

public integer saveFileLocally ( \craft\base\string $uriPath, \craft\base\string $targetPath )

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

Signature

public void updateFileByStream ( \craft\base\string $path, $stream, array $config )

Protected Methods

MethodDescription
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.
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.
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.

Signature

protected \League\Flysystem\AdapterInterface adapter ( )

addFileMetadataToConfig()

Adds file metadata to the config array.

View source

Arguments

Returns

array

Signature

protected array addFileMetadataToConfig ( array $config )

createAdapter()

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

View source

Returns

\League\Flysystem\AdapterInterface – The Flysystem adapter.

Signature

protected abstract \League\Flysystem\AdapterInterface createAdapter ( )

filesystem()

Returns Flysystem filesystem configured with the Flysystem adapter.

View source

Arguments

Returns

\League\Flysystem\Filesystem – The Flysystem filesystem.

Signature

protected \League\Flysystem\Filesystem filesystem ( array $config = [] )

invalidateCdnPath()

Invalidate a CDN path on the Volume.

View source

Arguments

  • $path (string) – The path to invalidate

Returns

boolean

Signature

protected boolean invalidateCdnPath ( \craft\base\string $path )

visibility()

Returns the visibility setting for the Volume.

View source

Returns

string

Signature

protected string visibility ( )

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.