MissingFs

Type

Class

Namespace

craft\fs

Inherits

craft\fs\MissingFs » 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\MissingComponentInterface, 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\MissingComponentTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)

Since

4.0.0

MissingFs represents a filesystem with an invalid class.

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
errorMessage	string (opens new window), null (opens new window) – The exception message that explains why the component class was invalid
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
expectedType	class-string<\craft\base\FsInterface>
fileList	Generator (opens new window)
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
placeholderHtml	string (opens new window)
rootUrl	false (opens new window)
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
settings	array (opens new window), null (opens new window) – The custom settings associated with the component, if it is savable
settingsHtml	string (opens new window), null (opens new window)
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.

expectedType

Type

class-string<\craft\base\FsInterface>

Default value

null

View source (opens new window)

fileList

Type

Generator (opens new window)

Default value

null

Access

Read-only

View source (opens new window)

rootUrl

Type

false (opens new window)

Default value

null

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()	Copies a file.
createDirectory()	Creates a directory.
createFallback()	Creates a new component of a given type based on this one’s properties.
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()	Deletes a directory.
deleteFile()	Deletes a file.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	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() (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()	Returns whether a file exists.
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()	Returns the last time the file was modified.
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()	List files.
getFileSize()	Return the file size.
getFileStream()	Gets a stream ready for reading by a file's URI.
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.
getPlaceholderHtml()	Displays an error message (and possibly a plugin install button) in place of the normal component UI.
getRootUrl()	Return the root URL for a filesystem or null if the filesystem does not have any.
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.
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()	Reads contents of a file to a string.
renameDirectory()	Renames a directory.
renameFile()	Renames a file.
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.
saveFileLocally()
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.
write()	Writes a string to a file.
writeFileFromStream()	Writes a file to a fs from a given stream.

copyFile()

Copies a file.

View source (opens new window)

Arguments

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

Throws

• craft\errors\FsException

createDirectory()

Creates a directory.

View source (opens new window)

Arguments

• $path (string (opens new window)) – The path of the directory, relative to the source’s root
• $config (array (opens new window)) – The config to use

Throws

• craft\errors\FsException

deleteDirectory()

Deletes a directory.

View source (opens new window)

Arguments

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

Throws

• craft\errors\FsException

deleteFile()

Deletes a file.

View source (opens new window)

Arguments

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

directoryExists()

Returns whether a directory exists at the given path.

View source (opens new window)

Arguments

• $path (string (opens new window)) – The directory path to check

Returns

boolean (opens new window)

Throws

• craft\errors\FsException

fileExists()

Returns whether a file exists.

View source (opens new window)

Arguments

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

Returns

boolean (opens new window)

Throws

• craft\errors\FsException

getDateModified()

Returns the last time the file was modified.

View source (opens new window)

Arguments

• $uri (string (opens new window))

Returns

integer (opens new window)

Throws

• craft\errors\FsException

getFileList()

List files.

View source (opens new window)

Arguments

• $directory (string (opens new window)) – The path of the directory to list files of
• $recursive (boolean (opens new window)) – Whether to fetch file list recursively, defaults to true

Returns

Generator (opens new window)

Throws

• craft\errors\FsException

getFileSize()

Return the file size.

View source (opens new window)

Arguments

• $uri (string (opens new window))

Returns

integer (opens new window)

Throws

• craft\errors\FsException

getFileStream()

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

View source (opens new window)

Arguments

• $uriPath (string (opens new window))

Returns

resource (opens new window)

Throws

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

getRootUrl()

Return the root URL for a filesystem or null if the filesystem does not have any.

View source (opens new window)

Returns

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

read()

Reads contents of a file to a string.

View source (opens new window)

Arguments

• $path (string (opens new window)) – The path of the file

Returns

string (opens new window)

renameDirectory()

Renames a directory.

View source (opens new window)

Arguments

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

Throws

• craft\errors\FsObjectNotFoundException
  if directory cannot be found

renameFile()

Renames a file.

View source (opens new window)

Arguments

• $path (string (opens new window)) – The old path of the file, relative to the source’s root
• $newPath (string (opens new window)) – The new path of the file, relative to the source’s root

Throws

• craft\errors\FsException

saveFileLocally()

View source (opens new window)

Arguments

• $uriPath
• $targetPath

write()

Writes a string to a file.

View source (opens new window)

Arguments

• $path (string (opens new window)) – The path of the file
• $contents (string (opens new window)) – The file contents to write
• $config (array (opens new window)) – Additional config options to pass on

Throws

• craft\errors\FsException

writeFileFromStream()

Writes a file to a fs from a given stream.

View source (opens new window)

Arguments

• $path (string (opens new window)) – The path of the file, relative to the source’s root
• $stream (resource (opens new window)) – The new contents of the file as a stream
• $config (array (opens new window)) – Additional config options to pass on

Throws

• craft\errors\FsException

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.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).

Constants

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