Skip to content

VolumeTrait

Type
Trait
Namespace
craft\base
Implemented by
craft\base\FlysystemVolume, craft\base\Volume, craft\volumes\Local, craft\volumes\MissingVolume, craft\volumes\Temp
Since
3.0.0

VolumeTrait

View source

Public Properties

PropertyDescription
fieldLayoutIdinteger, null – Field layout ID
handlestring, null – Handle
hasUrlsboolean, null – Whether the volume has a public URL
namestring, null – Name
sortOrderinteger, null – Sort order
titleTranslationKeyFormatstring, null – Title translation key format
titleTranslationMethodstring – Title translation method
uidstring, null – UID
urlstring, null – The volume’s URL

fieldLayoutId

Type
integer, null
Default value
null

Field layout ID

View source

handle

Type
string, null
Default value
null

Handle

View source

hasUrls

Type
boolean, null
Default value
null

Whether the volume has a public URL

View source

name

Type
string, null
Default value
null

Name

View source

sortOrder

Type
integer, null
Default value
null

Sort order

View source

titleTranslationKeyFormat

Type
string, null
Default value
null
Since
3.6.0

Title translation key format

View source

titleTranslationMethod

Type
string
Default value
\craft\base\Field::TRANSLATION_METHOD_SITE
Since
3.6.0

Title translation method

View source

uid

Type
string, null
Default value
null

UID

View source

url

Type
string, null
Default value
null

The volume’s URL

View source