class StorageLocation implements StorageLocationInterface (View source)

Properties

protected $fslName
protected $fslConfiguration
protected $fslID
protected $files
protected $fslIsDefault

Methods

int
getID()

No description

string
getName()

No description

string
getDisplayName(string $format = 'html')

Returns the display name for this storage location (localized and escaped accordingly to $format)

setName(string $fslName)

No description

setIsDefault(bool $fslIsDefault)

No description

bool
isDefault()

No description

setConfigurationObject($configuration)

No description

getTypeObject()

No description

Filesystem
getFileSystemObject()

Returns the proper file system object for the current storage location, by mapping it through Flysystem.

clearCache()

Clear the Flysystem cache.

mixed
delete()

Delete this storage location

mixed
save()

Save a storage location

Details

int getID()

Return Value

int

string getName()

Return Value

string

string getDisplayName(string $format = 'html')

Returns the display name for this storage location (localized and escaped accordingly to $format)

Parameters

string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.

Return Value

string

setName(string $fslName)

Parameters

string $fslName

setIsDefault(bool $fslIsDefault)

Parameters

bool $fslIsDefault

ConfigurationInterface getConfigurationObject()

Return Value

ConfigurationInterface

bool isDefault()

Return Value

bool

setConfigurationObject($configuration)

Parameters

$configuration

getTypeObject()

Filesystem getFileSystemObject()

Returns the proper file system object for the current storage location, by mapping it through Flysystem.

Return Value

Filesystem

clearCache()

Clear the Flysystem cache.

mixed delete()

Delete this storage location

Return Value

mixed

mixed save()

Save a storage location

Return Value

mixed