Volume

Type

Class

Namespace

craft\models

Inherits

craft\models\Volume » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\BaseFsInterface, craft\base\Chippable, craft\base\CpEditable, craft\base\FieldLayoutProviderInterface, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

4.0.0

Volume model class.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
altTranslationKeyFormat	null, string – Alternative text translation key format
altTranslationMethod	string – Alternative text translation method
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
config	array
cpEditUrl	string, null
errors	array – Errors for all attributes or the specified attribute.
fieldLayout	craft\models\FieldLayout
fieldLayoutId	integer, null – Field layout ID
fileList	Generator
firstErrors	array – The first errors.
fs	craft\base\FsInterface
fsHandle	string
handle	string, null – Handle
id	integer, null – ID
iterator	ArrayIterator – An iterator for traversing the items in the list.
name	string, null – Name
rootUrl	string, null
scenario	string – The scenario that this model is in.
sortOrder	integer, null – Sort order
subpath	string
titleTranslationKeyFormat	string, null – Title translation key format
titleTranslationMethod	string – Title translation method
transformFs	craft\base\FsInterface
transformFsHandle	string, null
transformSubpath	string – The subpath to use in the transform filesystem
uiLabel	string
uid	string, null – UID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

altTranslationKeyFormat

Type

null, string

Default value

null

Since

5.0.0

Alternative text translation key format

View source

altTranslationMethod

Type

string

Default value

\craft\base\Field::TRANSLATION_METHOD_NONE

Since

5.0.0

Alternative text translation method

View source

config

Type

array

Default value

null

Access

Read-only

View source

cpEditUrl

Type

string, null

Default value

null

Access

Read-only

View source

fieldLayout

Type

craft\models\FieldLayout

Default value

null

Access

Read-only

View source

fieldLayoutId

Type

integer, null

Default value

null

Field layout ID

View source

fileList

Type

Generator

Default value

null

Access

Read-only

View source

fs

Type

craft\base\FsInterface

Default value

null

View source

fsHandle

Type

string

Default value

null

View source

handle

Type

string, null

Default value

null

Handle

View source

id

Type

integer, null

Default value

null

ID

View source

name

Type

string, null

Default value

null

Name

View source

rootUrl

Type

string, null

Default value

null

Access

Read-only

View source

sortOrder

Type

integer, null

Default value

null

Sort order

View source

subpath

Type

string

Default value

null

Since

5.0.0

View source

titleTranslationKeyFormat

Type

string, null

Default value

null

Title translation key format

View source

titleTranslationMethod

Type

string

Default value

\craft\base\Field::TRANSLATION_METHOD_SITE

Title translation method

View source

transformFs

Type

craft\base\FsInterface

Default value

null

View source

transformFsHandle

Type

string, null

Default value

null

View source

transformSubpath

Type

string

Default value

''

The subpath to use in the transform filesystem

View source

uiLabel

Type

string

Default value

null

Access

Read-only

View source

uid

Type

string, null

Default value

null

UID

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.
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.
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.
createDirectory()	Creates a directory.
createValidators()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
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.
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.
formName()	Returns the form name that this model class should use.
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.
get()	Returns a component by its ID.
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.
getConfig()	Returns the volume’s config.
getCpEditUrl()	Returns the URL to the component’s edit page in the control panel.
getDateModified()	Returns the last time the file was modified.
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 field layout defined by this component.
getFileList()	List files.
getFileSize()	Return 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.
getFs()	Returns the volume’s filesystem.
getFsHandle()	Returns the filesystem handle.
getHandle()	Returns the provider’s handle, which could be used to identify custom fields with ambiguous handles.
getId()
getIterator()	Returns an iterator for traversing the attributes in the model.
getRootUrl()	Returns the root URL for a filesystem, if it has one.
getScenario()	Returns the scenario that this model is used in.
getSubpath()	Returns the volume’s subpath.
getTransformFs()	Returns the volume’s transform filesystem.
getTransformFsHandle()	Returns the transform filesystem handle. If none set, will return the current fs handle.
getUiLabel()	Returns what the component should be called within the control panel.
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.
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.
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()	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setFs()	Set the filesystem.
setFsHandle()	Sets the filesystem handle.
setScenario()	Sets the scenario for the model.
setSubpath()	Sets the volume’s subpath, ensuring it's a string.
setTransformFs()	Set the transform filesystem.
setTransformFsHandle()	Sets the transform filesystem handle.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateFieldLayout()	Validates the field layout.
validateMultiple()	Validates multiple models.
write()	Writes a string to a file.
writeFileFromStream()	Writes a file to a fs from a given stream.

__construct()

Constructor

View source

Arguments

• $config (array)

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)

copyFile()

Copies a file.

View source

Arguments

• $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
• $config (array) – Additional config options to pass on

Throws

• craft\errors\FsException

createDirectory()

Creates a directory.

View source

Arguments

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

Throws

• craft\errors\FsException

deleteDirectory()

Deletes a directory.

View source

Arguments

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

Throws

• craft\errors\FsException

deleteFile()

Deletes a file.

View source

Arguments

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

directoryExists()

Returns whether a directory exists at the given path.

View source

Arguments

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

Returns

boolean

Throws

• craft\errors\FsException

fileExists()

Returns whether a file exists.

View source

Arguments

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

Returns

boolean

Throws

• craft\errors\FsException

get()

Returns a component by its ID.

View source

Arguments

• $id (string, integer)

Returns

static, null

getConfig()

Returns the volume’s config.

View source

Returns

array

getCpEditUrl()

Returns the URL to the component’s edit page in the control panel.

View source

Returns

string, null

getDateModified()

Returns the last time the file was modified.

View source

Arguments

• $uri (string)

Returns

integer

Throws

• craft\errors\FsException

getFieldLayout()

Returns the field layout defined by this component.

View source

Returns

craft\models\FieldLayout

getFileList()

List files.

View source

Arguments

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

Returns

Generator

Throws

• craft\errors\FsException

getFileSize()

Return the file size.

View source

Arguments

• $uri (string)

Returns

integer

Throws

• craft\errors\FsException

getFileStream()

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

View source

Arguments

• $uriPath (string)

Returns

resource

Throws

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

getFs()

Returns the volume’s filesystem.

View source

Returns

craft\base\FsInterface

Throws

• yii\base\InvalidConfigException
  if fsHandle is missing or invalid

getFsHandle()

Returns the filesystem handle.

View source

Arguments

• $parse (boolean) – Whether to parse the name for an alias or environment variable

Returns

string, null

getHandle()

Since

5.0.0

Returns the provider’s handle, which could be used to identify custom fields with ambiguous handles.

View source

Returns

string, null

getId()

View source

getRootUrl()

Returns the root URL for a filesystem, if it has one.

View source

Returns

string, null

getSubpath()

Since

5.0.0

Returns the volume’s subpath.

View source

Arguments

• $ensureTrailing (boolean) – Whether to include a trailing slash

Returns

string

getTransformFs()

Returns the volume’s transform filesystem.

View source

Returns

craft\base\FsInterface

Throws

• yii\base\InvalidConfigException
  if fsHandle is missing or invalid

getTransformFsHandle()

Returns the transform filesystem handle. If none set, will return the current fs handle.

View source

Arguments

• $parse (boolean) – Whether to parse the name for an alias or environment variable

Returns

string, null

getUiLabel()

Returns what the component should be called within the control panel.

View source

Returns

string

read()

Reads contents of a file to a string.

View source

Arguments

• $path (string) – The path of the file

Returns

string

renameDirectory()

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\FsObjectNotFoundException
  if directory cannot be found

renameFile()

Renames a file.

View source

Arguments

• $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
• $config (array) – Additional config options to pass on

Throws

• craft\errors\FsException

setFs()

Set the filesystem.

View source

Arguments

• $fs (craft\base\FsInterface)

setFsHandle()

Sets the filesystem handle.

View source

Arguments

• $handle (string)

setSubpath()

Sets the volume’s subpath, ensuring it's a string.

View source

Arguments

• $subpath (string, null)

Returns

void

setTransformFs()

Set the transform filesystem.

View source

Arguments

• $fs (?\craft\base\FsInterface)

setTransformFsHandle()

Sets the transform filesystem handle.

View source

Arguments

• $handle (string, null)

validateFieldLayout()

Validates the field layout.

View source

write()

Writes a string to a file.

View source

Arguments

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

Throws

• craft\errors\FsException

writeFileFromStream()

Writes a file to a fs from a given stream.

View source

Arguments

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

defineBehaviors()

Since

4.0.0

Returns the behaviors to attach to this class.

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

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

View source

Returns

array

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.