CSMamObjectstorageDriver
extends CSMamDriver
in package
Tags
Table of Contents
- __construct() : mixed
- addEditorFields() : void
- cleanupFileTemporaries() : void
- getConfigurationForVolume() : CSObjectStorageConfiguration
- Returns the object storage configuration for the given MAM volume.
- getLocalMacBinary() : string
- getLocalPath() : string
- getLocalZip() : string
- getServiceType() : int
- Returns the configured service type of the current MAM volume driver.
- getStreamParameters() : array<string|int, mixed>
- getStreamPath() : string
- getSyncResult() : CSSyncResult
- getVolumeCachePath() : string
- getVolumePathWithBaseDirectory() : string
- Returns the volume path of the given folder path with the corresponding base directory.
- hasLowRes() : string|null
- hasSyncFile() : bool
- hasSyncFolder() : bool
- hasWriteAccess() : bool
- isAvailable() : bool
- isEditableRemotely() : bool|string
- isRemoteStorage() : bool
- isValidVolumePath() : bool
- onSyncEvent() : void
- prepareStorageForVolume() : void
Methods
__construct()
public
__construct(mixed $oMamVolume) : mixed
Parameters
- $oMamVolume : mixed
Tags
Return values
mixed —addEditorFields()
public
addEditorFields(CSGuiEditorDialog $oGuiEditor) : void
Parameters
- $oGuiEditor : CSGuiEditorDialog
Tags
Return values
void —cleanupFileTemporaries()
public
cleanupFileTemporaries(MamFile $oMamFile) : void
Parameters
- $oMamFile : MamFile
Tags
Return values
void —getConfigurationForVolume()
Returns the object storage configuration for the given MAM volume.
public
getConfigurationForVolume(MamVolume $oVolume) : CSObjectStorageConfiguration
Parameters
- $oVolume : MamVolume
-
The target MAM volume, which should be used to load the configuration.
Tags
Return values
CSObjectStorageConfiguration —getLocalMacBinary()
public
getLocalMacBinary(MamFile $oMamFile[, string $sDownloadContext = '' ]) : string
Parameters
- $oMamFile : MamFile
- $sDownloadContext : string = ''
Tags
Return values
string —getLocalPath()
public
getLocalPath(MamFile $oMamFile) : string
Parameters
- $oMamFile : MamFile
Tags
Return values
string —getLocalZip()
public
getLocalZip(MamFile $oMamFile[, bool $bFilesOnly = true ][, string $sDownloadContext = '' ]) : string
Parameters
- $oMamFile : MamFile
- $bFilesOnly : bool = true
- $sDownloadContext : string = ''
Tags
Return values
string —getServiceType()
Returns the configured service type of the current MAM volume driver.
public
final getServiceType() : int
Tags
Return values
int —getStreamParameters()
public
getStreamParameters(CSMamDriverFile $oDriverFile) : array<string|int, mixed>
Parameters
- $oDriverFile : CSMamDriverFile
Tags
Return values
array<string|int, mixed> —getStreamPath()
public
getStreamPath(CSMamDriverFile $oDriverFile) : string
Parameters
- $oDriverFile : CSMamDriverFile
Tags
Return values
string —getSyncResult()
public
getSyncResult([MamFile|null $oMamFile = null ][, bool $bForceCompleteSynchronisation = false ]) : CSSyncResult
Parameters
- $oMamFile : MamFile|null = null
- $bForceCompleteSynchronisation : bool = false
Tags
Return values
CSSyncResult —getVolumeCachePath()
public
getVolumeCachePath() : string
Tags
Return values
string —getVolumePathWithBaseDirectory()
Returns the volume path of the given folder path with the corresponding base directory.
public
final getVolumePathWithBaseDirectory(CSMamDriverFile $oDriverFile[, bool $bReturnFolderPath = false ][, bool $bExcludeProjectName = false ]) : string
Parameters
- $oDriverFile : CSMamDriverFile
-
The target MAM driver file.
- $bReturnFolderPath : bool = false
-
Whether the folder path or the file path should be returned.
- $bExcludeProjectName : bool = false
-
Whether the project name in the base directory should be excluded.
Tags
Return values
string —hasLowRes()
public
hasLowRes(MamFile $oMamFile[, array<string|int, mixed> $aLowResExtensions = array('jpg') ]) : string|null
Parameters
- $oMamFile : MamFile
- $aLowResExtensions : array<string|int, mixed> = array('jpg')
Tags
Return values
string|null —hasSyncFile()
public
hasSyncFile(CSSyncModifiedFile $oSyncFile) : bool
Parameters
- $oSyncFile : CSSyncModifiedFile
Tags
Return values
bool —hasSyncFolder()
public
hasSyncFolder(CSSyncModifiedFolder $oSyncFolder) : bool
Parameters
- $oSyncFolder : CSSyncModifiedFolder
Tags
Return values
bool —hasWriteAccess()
public
hasWriteAccess() : bool
Tags
Return values
bool —isAvailable()
public
isAvailable() : bool
Tags
Return values
bool —isEditableRemotely()
public
isEditableRemotely(MamFile $oMamFile) : bool|string
Parameters
- $oMamFile : MamFile
Tags
Return values
bool|string —isRemoteStorage()
public
isRemoteStorage() : bool
Tags
Return values
bool —isValidVolumePath()
public
isValidVolumePath(string $sVolumePath) : bool
Parameters
- $sVolumePath : string
Tags
Return values
bool —onSyncEvent()
public
onSyncEvent(string $sEventType, array<string|int, mixed> $aArguments) : void
Parameters
- $sEventType : string
- $aArguments : array<string|int, mixed>
Tags
Return values
void —prepareStorageForVolume()
public
prepareStorageForVolume(MamVolume $oVolume[, bool $bIsClone = false ]) : void
Parameters
- $oVolume : MamVolume
- $bIsClone : bool = false