CSDownloadResultItem
in package
This class defines a download result item
Tags
Table of Contents
- addContext() : void
- Adds an optional context for the download item. Depending on the usage it might define subfolders or other parameters.
- createResultItem() : CSDownloadResultItem
- Creates a download result item.
- getContext() : string
- Returns the optional context of the download item.
- getName() : string
- Returns the name of the download file defined in this download item.
- getPath() : string
- Returns the path of the download result item.
- setName() : void
- Sets an alternative name for the download file.
Methods
addContext()
Adds an optional context for the download item. Depending on the usage it might define subfolders or other parameters.
public
addContext(string $sContext) : void
Parameters
- $sContext : string
-
The optional context for the download item.
Tags
Return values
void —createResultItem()
Creates a download result item.
public
static createResultItem(string $sPath) : CSDownloadResultItem
Parameters
- $sPath : string
-
The path to the created download file
Tags
Return values
CSDownloadResultItem —The added download result item
getContext()
Returns the optional context of the download item.
public
getContext() : string
Tags
Return values
string —The context of the download item.
getName()
Returns the name of the download file defined in this download item.
public
getName() : string
Tags
Return values
string —The name of the download file.
getPath()
Returns the path of the download result item.
public
getPath() : string
Tags
Return values
string —Path to the created download file.
setName()
Sets an alternative name for the download file.
public
setName(string $sName) : void
Parameters
- $sName : string
-
The alternative name for the download file.