VolumeFolder

Type

Class

Namespace

craft\models

Inherits

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

Implements

ArrayAccess, IteratorAggregate, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

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

Since

3.0.0

The VolumeFolder model class.

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.
children	craft\models\VolumeFolder[]
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
fs	craft\base\FsInterface
hasChildren	boolean
id	integer, null – ID
iterator	ArrayIterator – An iterator for traversing the items in the list.
name	string, null – Name
parent	craft\models\VolumeFolder, null
parentId	integer, string, null – Parent ID
path	string, null – Path
scenario	string – The scenario that this model is in.
sourcePathInfo	array, null
uid	string, null – UID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.
volume	craft\models\Volume
volumeId	integer, null – Volume ID

children

Type

craft\models\VolumeFolder[]

Default value

null

View source

fs

Type

craft\base\FsInterface

Default value

null

Since

5.0.0

View source

hasChildren

Type

boolean

Default value

null

Since

4.4.0

View source

id

Type

integer, null

Default value

null

ID

View source

name

Type

string, null

Default value

null

Name

View source

parent

Type

craft\models\VolumeFolder, null

Default value

null

View source

parentId

Type

integer, string, null

Default value

null

Parent ID

View source

path

Type

string, null

Default value

null

Path

View source

sourcePathInfo

Type

array, null

Default value

null

Access

Read-only

Since

4.4.0

View source

uid

Type

string, null

Default value

null

UID

View source

volume

Type

craft\models\Volume

Default value

null

View source

volumeId

Type

integer, null

Default value

null

Volume ID

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()
__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.
__toString()	Use the folder name as the string representation.
__unset()	Sets a component property to be null.
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.
addChild()	Add a child folder manually.
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.
createValidators()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
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.
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.
getChildren()	Get this folder's children.
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getFs()	Return the filesystem this folder belongs to.
getHasChildren()	Returns whether the folder has any child folders.
getIterator()	Returns an iterator for traversing the attributes in the model.
getParent()
getScenario()	Returns the scenario that this model is used in.
getSourcePathInfo()	Returns info about the folder for an element index’s source path configuration.
getValidators()	Returns all the validators declared in rules().
getVolume()	Returns the volume this folder belongs to.
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.
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.
setChildren()	Set the child folders.
setFs()	Sets the filesystem this folder belongs to.
setHasChildren()	Sets whether the folder has any child folders.
setScenario()	Sets the scenario for the model.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

__toString()

Use the folder name as the string representation.

View source

Returns

string

addChild()

Add a child folder manually.

View source

Arguments

• $folder (craft\models\VolumeFolder)

getChildren()

Get this folder's children.

View source

Returns

craft\models\VolumeFolder[]

getFs()

Since

5.0.0

Return the filesystem this folder belongs to.

View source

Returns

craft\base\FsInterface

getHasChildren()

Since

4.4.0

Returns whether the folder has any child folders.

View source

Returns

boolean

getParent()

View source

Returns

craft\models\VolumeFolder, null

getSourcePathInfo()

Since

4.4.0

Returns info about the folder for an element index’s source path configuration.

View source

Returns

array, null

getVolume()

Returns the volume this folder belongs to.

View source

Returns

craft\models\Volume

Throws

• yii\base\InvalidConfigException
  if volumeId is invalid

setChildren()

Set the child folders.

View source

Arguments

• $children (craft\models\VolumeFolder[])

setFs()

Since

5.0.0

Sets the filesystem this folder belongs to.

View source

Arguments

• $fs (craft\base\FsInterface)

setHasChildren()

Since

4.4.0

Sets whether the folder has any child folders.

View source

Arguments

• $value (boolean)

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

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.