Local

Type

Class

Namespace

craft\fs

Inherits

craft\fs\Local » craft\base\Fs » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\FsInterface, craft\base\LocalFsInterface, craft\base\ModelInterface, craft\base\SavableComponentInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)

Uses traits

craft\base\ClonefixTrait, craft\base\FsTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)

Extended by

craft\fs\Temp

Since

4.0.0

Local represents a local filesystem.

View source (opens new window)

Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
dateCreated	DateTime (opens new window), null (opens new window) – The date that the component was created
dateUpdated	DateTime (opens new window), null (opens new window) – The date that the component was last updated
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
fileList
firstErrors (opens new window)	array (opens new window) – The first errors.
handle	string (opens new window), null (opens new window) – Handle
hasUrls	boolean (opens new window) – Whether the volume has a public URL
id	integer (opens new window), string (opens new window), null (opens new window) – The component’s ID (could be a temporary one: "new:X")
isNew	boolean (opens new window) – Whether the component is new (unsaved)
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
name	string (opens new window), null (opens new window) – Name
oldHandle	string (opens new window), null (opens new window) – Old handle
path	string (opens new window), null (opens new window) – Path to the root of this sources local folder.
rootPath	string (opens new window)
rootUrl	null (opens new window), string (opens new window)
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
settings	array (opens new window) – The component’s settings
settingsHtml	mixed
uid	string (opens new window), null (opens new window) – UID
url	string (opens new window), null (opens new window) – The volume’s URL
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

fileList

Default value

null

Access

Read-only

View source (opens new window)

path

Type

string (opens new window), null (opens new window)

Default value

null

Path to the root of this sources local folder.

View source (opens new window)

rootPath

Type

string (opens new window)

Default value

null

View source (opens new window)

settingsHtml

Type

mixed

Default value

null

View source (opens new window)

Protected Properties

Property	Description
showHasUrlSetting	boolean (opens new window) – Whether the “Files in this filesystem have public URLs” setting should be shown.
showUrlSetting	boolean (opens new window) – Whether the “Base URL” setting should be shown.
visibilityMap	int[][] – Visibility map

visibilityMap

Type

int[][]

Default value

[ self::VISIBILITY_FILE => [ self::VISIBILITY_DEFAULT => 0644, self::VISIBILITY_PUBLIC => 0644, self::VISIBILITY_HIDDEN => 0600, ], self::VISIBILITY_DIR => [ self::VISIBILITY_DEFAULT => 0775, self::VISIBILITY_PUBLIC => 0775, self::VISIBILITY_HIDDEN => 0700, ], ]

Visibility map

View source (opens new window)

Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone()
__construct()
__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.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	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() (opens new window)	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels()	Returns the attribute labels.
attributes() (opens new window)	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() (opens new window)	This method is invoked before validation starts.
behaviors()	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.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
copyFile()
createDirectory()
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes()	Returns the names of any attributes that should hold DateTime (opens new window) values.
deleteDirectory()
deleteFile()
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
directoryExists()
displayName()	Returns the display name of this class.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window)	Returns the list of fields that can be expanded further and returned by toArray() (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()
formName() (opens new window)	Returns the form name that this model class should use.
generateAttributeLabel() (opens new window)	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window)	Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window)	Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window)	Returns the text label for the specified attribute.
getAttributes() (opens new window)	Returns attribute values.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getDateModified()
getErrorSummary() (opens new window)	Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window)	Returns the errors for all attributes or a single attribute.
getFileList()
getFileSize()
getFileStream()
getFirstError() (opens new window)	Returns the first error of the specified attribute.
getFirstErrors() (opens new window)	Returns the first error of every attribute in the model.
getIsNew()	Returns whether the component is new (unsaved).
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getRootPath()	Return the root path of the FS.
getRootUrl()
getScenario() (opens new window)	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.
getShowHasUrlSetting()	Returns whether the “Files in this filesystem have public URLs” setting should be shown.
getShowUrlSetting()	Returns whether the “Base URL” setting should be shown.
getValidators() (opens new window)	Returns all the validators declared in rules() (opens new window).
hasErrors()	Returns a value indicating whether there is any validation error.
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()	Initializes the object.
instance() (opens new window)	Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window)	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	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() (opens new window)	Populates the model with input data.
loadMultiple() (opens new window)	Populates a set of models with the data from end user.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists() (opens new window)	Returns whether there is an element at the specified offset.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Sets the element value at the specified offset to null.
on() (opens new window)	Attaches an event handler to an event.
onUnsafeAttribute() (opens new window)	This method is invoked when an unsafe attribute is being massively assigned.
read()
renameDirectory()
renameFile()
rules()	Returns the validation rules for attributes.
safeAttributes() (opens new window)	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window)	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setScenario() (opens new window)	Sets the scenario for the model.
settingsAttributes()	Returns the list of settings attribute names.
toArray() (opens new window)	Converts the model into an array.
trigger() (opens new window)	Triggers an event.
validate() (opens new window)	Performs the data validation.
validateMultiple() (opens new window)	Validates multiple models.
validatePath()
write()
writeFileFromStream()

__construct()

View source (opens new window)

Arguments

• $config

afterSave()

Performs actions after a component is saved.

View source (opens new window)

Arguments

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

attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel() (opens new window). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

View source (opens new window)

Returns

array (opens new window) – Attribute labels (name => label)

copyFile()

View source (opens new window)

Arguments

• $path
• $newPath

createDirectory()

View source (opens new window)

Arguments

• $path
• $config

deleteDirectory()

View source (opens new window)

Arguments

• $path

deleteFile()

View source (opens new window)

Arguments

• $path

directoryExists()

View source (opens new window)

Arguments

• $path

displayName()

Returns the display name of this class.

View source (opens new window)

Returns

string (opens new window) – The display name of this class.

fileExists()

View source (opens new window)

Arguments

• $path

getDateModified()

View source (opens new window)

Arguments

• $uri

getFileList()

View source (opens new window)

Arguments

• $directory
• $recursive

getFileSize()

View source (opens new window)

Arguments

• $uri

getFileStream()

View source (opens new window)

Arguments

• $uriPath

getRootPath()

Return the root path of the FS.

View source (opens new window)

Returns

string (opens new window)

getSettingsHtml()

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');
</script>

…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');
</script>

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 provides a couple handy methods that can help you deal with this:

• craft\web\View::namespaceInputId() will give you the namespaced version of a given ID.
• craft\web\View::namespaceInputName() will give you the namespaced version of a given input name.

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

public function getSettingsHtml(): ?string
{
    // Figure out what the ID is going to be namespaced into
    $id = 'foo';
    $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 }}');
</script>

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

View source (opens new window)

Returns

string (opens new window), null (opens new window)

init()

Initializes the object.

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

View source (opens new window)

read()

View source (opens new window)

Arguments

• $path

renameDirectory()

View source (opens new window)

Arguments

• $path
• $newName

renameFile()

View source (opens new window)

Arguments

• $path
• $newPath

validatePath()

Since

4.4.6

View source (opens new window)

Arguments

• $attribute (string (opens new window))
• $params (array (opens new window), null (opens new window))
• $validator (yii\validators\InlineValidator (opens new window))

Returns

void

write()

View source (opens new window)

Arguments

• $path
• $contents
• $config

writeFileFromStream()

View source (opens new window)

Arguments

• $path
• $stream
• $config

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
extractFieldsFor() (opens new window)	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() (opens new window)	Extracts the root field names from nested fields.
getRecursiveIterator()	Create the recursive iterator for traversing file system.
prefixPath()	Prefix the path with the root path.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).
resolveVisibility()	Resolve visibility by a config array and type.

defineRules()

Since

3.4.0

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 (opens new window)

Returns

array (opens new window)

getRecursiveIterator()

Create the recursive iterator for traversing file system.

View source (opens new window)

Arguments

• $targetDir (string (opens new window))

Returns

RecursiveIteratorIterator (opens new window)

prefixPath()

Prefix the path with the root path.

View source (opens new window)

Arguments

• $path (string (opens new window))

Returns

string (opens new window)

Throws

• craft\errors\FsException
  if path is not contained.

resolveVisibility()

Resolve visibility by a config array and type.

View source (opens new window)

Arguments

• $type (string (opens new window))
• $config (array (opens new window))

Returns

integer (opens new window)

Constants

Constant	Description
CONFIG_MIMETYPE
CONFIG_VISIBILITY
SCENARIO_DEFAULT	The name of the default scenario.
VISIBILITY_DEFAULT
VISIBILITY_DIR
VISIBILITY_FILE
VISIBILITY_HIDDEN
VISIBILITY_PUBLIC