Class craft\volumes\MissingVolume

Inheritance: craft\volumes\MissingVolume » 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\MissingComponentInterface, craft\base\SavableComponentInterface, craft\base\VolumeInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses Traits: craft\base\MissingComponentTrait, craft\base\SavableComponentTrait, craft\base\VolumeTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/volumes/MissingVolume.php

MissingVolume represents a volume with an invalid class.

Public Properties
Property	Type	Description	Defined By
`$dateCreated`	DateTime, null	The date that the component was created	craft\base\SavableComponentTrait
`$dateUpdated`	DateTime, null	The date that the component was last updated	craft\base\SavableComponentTrait
`$errorMessage`	string, null	The exception message that explains why the component class was invalid	craft\base\MissingComponentTrait
`$expectedType`	string, craft\base\Component, null	The expected component class name.	craft\base\MissingComponentTrait
`$fieldLayoutId`	integer, null	Field layout ID	craft\base\VolumeTrait
`$handle`	string, null	Handle	craft\base\VolumeTrait
`$hasUrls`	boolean, null	Whether the volume has a public URL	craft\base\VolumeTrait
`$id`	integer, string, null	The component’s ID (could be a temporary one: "new:X")	craft\base\SavableComponentTrait
`$name`	string, null	Name	craft\base\VolumeTrait
`$settings`	mixed	The custom settings associated with the component, if it is savable	craft\base\MissingComponentTrait
`$sortOrder`	integer, null	Sort order	craft\base\VolumeTrait
`$url`	string, null	The volume’s URL	craft\base\VolumeTrait

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

Protected Methods
Method	Description	Defined By
`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".	yii\base\ArrayableTrait
`extractRootFields()`	Extracts the root field names from nested fields.	yii\base\ArrayableTrait
`resolveFields()`	Determines which fields can be returned by toArray().	yii\base\ArrayableTrait

Events
Event	Type	Description	Defined By
`EVENT_AFTER_DELETE`	yii\base\Event	The event that is triggered after the component is deleted	craft\base\SavableComponent
`EVENT_AFTER_SAVE`	craft\events\ModelEvent	The event that is triggered after the component is saved	craft\base\SavableComponent
`EVENT_AFTER_VALIDATE`	yii\base\Event	An event raised at the end of validate()	yii\base\Model
`EVENT_BEFORE_DELETE`	craft\events\ModelEvent	The event that is triggered before the component is deleted You may set craft\events\ModelEvent::$isValid to `false` to prevent the component from getting deleted.	craft\base\SavableComponent
`EVENT_BEFORE_SAVE`	craft\events\ModelEvent	The event that is triggered before the component is saved You may set craft\events\ModelEvent::$isValid to `false` to prevent the component from getting saved.	craft\base\SavableComponent
`EVENT_BEFORE_VALIDATE`	yii\base\ModelEvent	An event raised at the beginning of validate().	yii\base\Model
`EVENT_DEFINE_BEHAVIORS`	craft\events\DefineBehaviorsEvent	The event that is triggered when defining the class behaviors	craft\base\Component
`EVENT_INIT`	yii\base\Event	The event that is triggered after the component's init cycle	craft\base\Component

Constants
Constant	Value	Description	Defined By
`SCENARIO_DEFAULT`	'default'	The name of the default scenario.	yii\base\Model

Method Details

`copyFile()` public method #

Copies a file.

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

`$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
throws	craft\errors\VolumeObjectNotFoundException	if the file to be renamed cannot be found
throws	craft\errors\VolumeException	if something else goes wrong

`createDir()` public method #

Creates a directory.

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

`$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
throws	craft\errors\VolumeException	if something else goes wrong

`createFileByStream()` public method #

Creates a file.

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

`$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
throws	craft\errors\VolumeException	if something else goes wrong

`deleteDir()` public method #

Deletes a directory.

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

`$path`	string	The path of the directory, relative to the source’s root
throws	craft\errors\VolumeException	if something goes wrong

`deleteFile()` public method #

Deletes a file.

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

`$path`	string	The path of the file, relative to the source’s root
throws	craft\errors\VolumeException	if something goes wrong

`fileExists()` public method #

Returns whether a file exists.

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

$path string The path of the file, relative to the source’s root

`folderExists()` public method #

Returns whether a folder exists at the given path.

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

$path string The folder path to check

`getFileList()` public method #

List files.

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

`$directory`	string	The path of the directory to list files of
`$recursive`	boolean	Whether to fetch file list recursively

`getFileMetadata()` public method #

Return the metadata about a file.

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

`$uri`	string	URI to the file on the volume
throws	craft\errors\VolumeObjectNotFoundException	if the file cannot be found

`getFileStream()` public method #

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

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

`$uriPath`	string
throws	craft\errors\AssetException	if a stream cannot be created

`getRootUrl()` public method #

Returns the URL to the source, if it’s accessible via HTTP traffic.

public string, false getRootUrl ( )

return	string, false	The root URL, or `false` if there isn’t one

`renameDir()` public method #

Renames a directory.

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

`$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
throws	craft\errors\VolumeObjectExistsException	if a directory with such name already exists
throws	craft\errors\VolumeException	if something else goes wrong

`renameFile()` public method #

Renames a file.

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

`$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
throws	craft\errors\VolumeObjectNotFoundException	if the file to be renamed cannot be found
throws	craft\errors\VolumeException	if something else goes wrong

`saveFileLocally()` public method #

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

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

`$uriPath`	string
`$targetPath`	string
return	integer	Amount of bytes copied

`updateFileByStream()` public method #

Updates a file.

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

`$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
throws	craft\errors\VolumeException	if something else goes wrong

Method Details

copyFile() public method #

createDir() public method #

createFileByStream() public method #

deleteDir() public method #

deleteFile() public method #

fileExists() public method #

folderExists() public method #

getFileList() public method #

getFileMetadata() public method #

getFileStream() public method #

getRootUrl() public method #

renameDir() public method #

renameFile() public method #

saveFileLocally() public method #

updateFileByStream() public method #