craft\volumes\Local » craft\base\FlysystemVolume » craft\base\Volume » craft\base\SavableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\LocalVolumeInterface, 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

The local volume class. Handles the implementation of the local filesystem as a volume in Craft.

See also http://craftcms.com

View source

Public Properties

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
pathstring, null – Path to the root of this sources local folder.
rootPathstring – The root path for the volume
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
uidstring, null – UID
urlstring, null – The volume’s URL
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.


string, null

Path to the root of this sources local folder.

View source



The root path for the volume

View source


string, null

View source

Protected Properties

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

Public Methods

__call()Calls the named method which is not a class method.
__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.
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.
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.
getRootPath()Returns the root path for the volume.
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.



Performs actions after a component is saved.

View source


  • $isNew (boolean) – Whether the component is brand new


Returns the display name of this class.

View source


string – The display name of this class.


Returns the root path for the volume.

View source


string – The root path for the volume


Returns the component’s settings HTML.

An extremely simple implementation would be to directly return some HTML:

return '<textarea name="foo">'.$this->foo.'</textarea>';

For more complex settings, you might prefer to create a template, and render it via craft\web\View::renderTemplate(). For example, the following code would render a template located at src/templates/_settings.html, passing the settings to it:

return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
    'widget' => $this

If you need to tie any JavaScript code to your settings, it’s important to know that any name= and id= attributes within the returned HTML will probably get namespaced, however your JavaScript code will be left untouched. For example, if getSettingsHtml() returns the following HTML:

<textarea id="foo" name="foo"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');

…then it might actually look like this before getting output to the browser:

<textarea id="namespace-foo" name="namespace[foo]"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');

As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s id= attribute was changed from foo to namespace-foo. Before you start adding namespace- to the beginning of your element ID selectors, keep in mind that the actual namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite that simple.

Thankfully, craft\web\View service provides a couple handy methods that can help you deal with this:

So here’s what a getSettingsHtml() method that includes field-targeting JavaScript code might look like:

public function getSettingsHtml()
    // Come up with an ID value for 'foo'
    $id = Craft::$app->getView()->formatInputId('foo');
    // Figure out what that ID is going to be namespaced into
    $namespacedId = Craft::$app->view->namespaceInputId($id);
    // Render and return the input template
    return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
        'id'           => $id,
        'namespacedId' => $namespacedId,
        'widget'       => $this

And the _widget-settings.twig template might look like this:

<textarea id="{{ id }}" name="foo">{{ widget.foo }}</textarea>
<script type="text/javascript">
    var textarea = document.getElementById('{{ namespacedId }}');

The same principles also apply if you’re including your JavaScript code with craft\web\View::registerJs().

View source


string, null


Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source


Renames a directory.

View source


  • $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


Protected Methods

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


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

View source


\League\Flysystem\Adapter\Local – The Flysystem adapter.



Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source




SCENARIO_DEFAULTThe name of the default scenario.