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 (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\SavableComponentInterface, craft\base\VolumeInterface, 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\SavableComponentTrait, craft\base\VolumeTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
- 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 (opens new window)
# Public Properties
# fieldLayout
- Type
- craft\models\FieldLayout, null (opens new window)
- Default value
null
- Access
- Read-only
- Since
- 3.5.0
View source (opens new window)
# rootUrl
- Type
- string (opens new window), false (opens new window)
- Default value
null
- Access
- Read-only
The root URL, or false
if there isn’t one
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() (opens new window) | Constructor. |
__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. |
createDir() | Creates a directory. |
createDirectory() | Creates a directory. |
createFileByStream() | Creates a file. |
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. |
deleteDir() | Deletes a directory. |
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. |
folderExists() | Returns whether a folder exists at the given path. |
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. |
getError() | Returns the first error of the specified attribute. |
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. |
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() (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. |
getRootUrl() | Returns the URL to the source, if it’s accessible via HTTP traffic. |
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. |
renameDir() | Renames a directory. |
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() | Save a file from the source's uriPath to a local target path. |
scenarios() (opens new window) | Returns a list of scenarios and the corresponding active attributes. |
setAttributes() (opens new window) | 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. |
updateFileByStream() | Updates a file. |
validate() (opens new window) | Performs the data validation. |
validateFieldLayout() | Validates the field layout. |
validateMultiple() (opens new window) | 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() (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)
# 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() (opens new window)
or be detached using detachBehavior() (opens new window). Anonymous behaviors can not be retrieved or detached.
Behaviors declared in this method will be attached to the component automatically (on demand).
View source (opens new window)
Returns
array (opens new window) – The behavior configurations.
# createDir()
DEPRECATED
Deprecated in 3.6.0. Use createDirectory() instead.
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
# createDirectory()
- Since
- 3.6.0
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
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 (opens new window)
Arguments
$path
(string (opens new window)) – The path of the directory, relative to the source’s root
# deleteDirectory()
- Since
- 3.6.0
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\VolumeException
if something goes wrong
# directoryExists()
Returns whether a directory exists at the given path.
View source (opens new window)
Arguments
$path
(string (opens new window)) – The folder path to check
Returns
# folderExists()
DEPRECATED
Deprecated in 3.7.0. Use directoryExists() instead.
Returns whether a folder exists at the given path.
View source (opens new window)
Arguments
$path
(string (opens new window)) – The folder path to check
Returns
# getFieldLayout()
- Since
- 3.5.0
Returns the volume's field layout, or null
if it doesn’t have one.
View source (opens new window)
Returns
craft\models\FieldLayout, null (opens new window)
# getRootUrl()
Returns the URL to the source, if it’s accessible via HTTP traffic.
The URL should end in a /
.
View source (opens new window)
Returns
string (opens new window), false (opens new window) – 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 (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
# renameDirectory()
- Since
- 3.6.0
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\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 (opens new window)
Returns
void
# Protected Methods
Method | Description |
---|---|
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). |
# 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
# Constants
Constant | Description |
---|---|
SCENARIO_DEFAULT | The name of the default scenario. |