Volume

Type

Abstract Class

Namespace

craft\base

Inherits

craft\base\Volume » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, 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\base\FlysystemVolume, craft\volumes\Local, craft\volumes\MissingVolume, craft\volumes\Temp

Volume is the base class for classes representing volumes in terms of objects.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
dateCreated	DateTime, null – The date that the component was created
dateUpdated	DateTime, null – The date that the component was last updated
errors	array – Errors for all attributes or the specified attribute.
fieldLayout	craft\models\FieldLayout, null
fieldLayoutId	integer, null – Field layout ID
firstErrors	array – The first errors.
handle	string, null – Handle
hasUrls	boolean, null – Whether the volume has a public URL
id	integer, string, null – The component’s ID (could be a temporary one: "new:X")
isNew	boolean – Whether the component is new (unsaved)
iterator	ArrayIterator – An iterator for traversing the items in the list.
name	string, null – Name
rootUrl	string, false – The root URL, or false if there isn’t one
scenario	string – The scenario that this model is in.
settings	array – The component’s settings
settingsHtml	string, null
sortOrder	integer, null – Sort order
titleTranslationKeyFormat	string, null – Title translation key format
titleTranslationMethod	string – Title translation method
uid	string, null – UID
url	string, null – The volume’s URL
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

fieldLayout

Type

craft\models\FieldLayout, null

Default value

null

Access

Read-only

Since

3.5.0

View source

rootUrl

Type

string, false

Default value

null

Access

Read-only

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

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be 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.
createDirectory()	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.
deleteDirectory()	Deletes a directory.
deleteFile()	Deletes a file.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	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()	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.
getDateModified()	Returns the last time the file was modified.
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.
getFieldLayout()	Returns the volume's field layout, or null if it doesn’t have one.
getFileList()	List files.
getFileMetadata()	Return the metadata about a file.
getFileSize()	Returns the file size.
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 for this component.
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.
renameDirectory()	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()	Performs the data validation.
validateFieldLayout()	Validates the field layout.
validateMultiple()	Validates multiple models.

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

Returns

array – Attribute labels (name => label)

behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source

Returns

array – The behavior configurations.

createDir()

DEPRECATED

Deprecated in 3.6.0. Use createDirectory() instead.

Creates a directory.

View source

Arguments

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

createDirectory()

Since

3.6.0

Creates a directory.

View source

Arguments

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

deleteDir()

DEPRECATED

Deprecated in 3.6.0. Use deleteDirectory() instead.

Deletes a directory.

View source

Arguments

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

deleteDirectory()

Since

3.6.0

Deletes a directory.

View source

Arguments

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

Throws

• craft\errors\VolumeException
  if something goes wrong

directoryExists()

Returns whether a directory exists at the given path.

View source

Arguments

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

Returns

boolean

folderExists()

DEPRECATED

Deprecated in 3.7.0. Use directoryExists() instead.

Returns whether a folder exists at the given path.

View source

Arguments

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

Returns

boolean

getFieldLayout()

Since

3.5.0

Returns the volume's field layout, or null if it doesn’t have one.

View source

Returns

craft\models\FieldLayout, null

getRootUrl()

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

The URL should end in a /.

View source

Returns

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

renameDir()

DEPRECATED

Deprecated in 3.6.0. Use renameDirectory() instead.

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

renameDirectory()

Since

3.6.0

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

• craft\errors\VolumeObjectNotFoundException
  if a directory with such name already exists
• craft\errors\VolumeObjectExistsException
  if a directory with such name already exists
• craft\errors\VolumeException
  if something else goes wrong

validateFieldLayout()

Since

3.7.0

Validates the field layout.

View source

Returns

void

Protected Methods

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

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

Returns

array

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.