CSFileUploadParam
in package
Tags
Table of Contents
- getAdditionalParam() : mixed
- Returns a parameter.
- getAdditionalParams() : array<string|int, mixed>
- Returns additional parameters (POST Parameters) with which the GuiUploadRestservice was called.
- getFileConfigDataArray() : array<string|int, mixed>
- Returns an array with file config data.
- getFileConfigDataValue() : mixed|null
- Returns a value for given key form file config data array.
- getFileDuplicate() : bool
- Returns file duplicate options.
- getFileName() : string
- Returns the file name option.
- getFileNamePrefix() : string
- Returns the file name prefix option.
- getFileOverwrite() : null
- Returns file overwrite option
- getMamFileId() : string|int
- Returns MamFile ID (might be also a path (MamPath) to a MamFile)
- getUploadFolder() : string
- Returns the upload folder option
- hasMamFileInformation() : bool
- Checks if MamFile information (options) are stored.
- setAdditionalParam() : $this
- Sets an additional parameter.
- setAdditionalParams() : $this
- Sets additional parameters (POST Parameters)
- setFileConfigDataArray() : $this
- Sets file config data array
- setFileDuplicate() : $this
- Sets the option for file duplicate
- setFileName() : $this
- Sets the file name option.
- setFileNamePrefix() : $this
- Sets the file name prefix option
- setFileOverwrite() : $this
- Sets file overwrite option
- setMamFileId() : $this
- Sets the MamFile ID (or a MamPath to a file in the MAM).
- setUploadFolder() : $this
- Sets the upload folder option
Methods
getAdditionalParam()
Returns a parameter.
public
getAdditionalParam(mixed $sKey) : mixed
Parameters
- $sKey : mixed
Tags
Return values
mixed —getAdditionalParams()
Returns additional parameters (POST Parameters) with which the GuiUploadRestservice was called.
public
getAdditionalParams() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getFileConfigDataArray()
Returns an array with file config data.
public
getFileConfigDataArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getFileConfigDataValue()
Returns a value for given key form file config data array.
public
getFileConfigDataValue(string $sKey) : mixed|null
Parameters
- $sKey : string
Tags
Return values
mixed|null —Returns null if given key is unknown.
getFileDuplicate()
Returns file duplicate options.
public
getFileDuplicate() : bool
Tags
Return values
bool —getFileName()
Returns the file name option.
public
getFileName() : string
Tags
Return values
string —getFileNamePrefix()
Returns the file name prefix option.
public
getFileNamePrefix() : string
Tags
Return values
string —getFileOverwrite()
Returns file overwrite option
public
getFileOverwrite() : null
Tags
Return values
null —getMamFileId()
Returns MamFile ID (might be also a path (MamPath) to a MamFile)
public
getMamFileId() : string|int
Tags
Return values
string|int —getUploadFolder()
Returns the upload folder option
public
getUploadFolder() : string
Tags
Return values
string —hasMamFileInformation()
Checks if MamFile information (options) are stored.
public
hasMamFileInformation() : bool
Tags
Return values
bool —setAdditionalParam()
Sets an additional parameter.
public
setAdditionalParam(mixed $sKey, mixed $mValue) : $this
Parameters
- $sKey : mixed
- $mValue : mixed
Tags
Return values
$this —setAdditionalParams()
Sets additional parameters (POST Parameters)
public
setAdditionalParams(mixed $aPostVars) : $this
Parameters
- $aPostVars : mixed
Tags
Return values
$this —setFileConfigDataArray()
Sets file config data array
public
setFileConfigDataArray(array<string|int, mixed> $aData) : $this
Parameters
- $aData : array<string|int, mixed>
Tags
Return values
$this —setFileDuplicate()
Sets the option for file duplicate
public
setFileDuplicate(bool $bDuplicate) : $this
Parameters
- $bDuplicate : bool
Tags
Return values
$this —setFileName()
Sets the file name option.
public
setFileName(string $sFileName) : $this
Parameters
- $sFileName : string
Tags
Return values
$this —setFileNamePrefix()
Sets the file name prefix option
public
setFileNamePrefix(mixed $sFileNamePrefix) : $this
Parameters
- $sFileNamePrefix : mixed
Tags
Return values
$this —setFileOverwrite()
Sets file overwrite option
public
setFileOverwrite(bool $bOverwrite) : $this
Parameters
- $bOverwrite : bool
Tags
Return values
$this —setMamFileId()
Sets the MamFile ID (or a MamPath to a file in the MAM).
public
setMamFileId(string|int $mMamFileIdOrPath) : $this
Parameters
- $mMamFileIdOrPath : string|int
Tags
Return values
$this —setUploadFolder()
Sets the upload folder option
public
setUploadFolder(string $sUploadFolderPath) : $this
Parameters
- $sUploadFolderPath : string