IDownloadable
in
This interface defines a downloadable item
Tags
Table of Contents
- downloadForContext() : CSDownloadResult
- Returns the download result for the provided context.
- getDownloadNameForContext() : string
- Defines the download name for the provided context.
- mayDownloadForContext() : bool
- Defines whether the download is available for the provided context.
Methods
downloadForContext()
Returns the download result for the provided context.
public
downloadForContext(CSDownloadContext $oContext) : CSDownloadResult
.
Parameters
- $oContext : CSDownloadContext
-
The download context
Tags
Return values
CSDownloadResult —The download result containing information about the files to be downloaded.
getDownloadNameForContext()
Defines the download name for the provided context.
public
getDownloadNameForContext(CSDownloadContext $oContext) : string
Parameters
- $oContext : CSDownloadContext
-
The download context. This value can be null, which means that a "global" name is requested that is most likely shown to an user (in selection lists or other ways to select presets).
Tags
Return values
string —The download name for the provided context.
mayDownloadForContext()
Defines whether the download is available for the provided context.
public
mayDownloadForContext(CSDownloadContext $oContext) : bool
Parameters
- $oContext : CSDownloadContext
-
The download context
Tags
Return values
bool —True, if download is available, otherwise false.