CSOpenSearchDownloadContext
in package
This class defines an open search download context
Tags
Table of Contents
- createContext() : CSOpenSearchDownloadContext
- Creates an open search download context for the specified type.
- getClass() : string
- Returns the class for the download context.
- getIds() : array<string|int, mixed>
- Returns the ids of the download context.
- getLanguageId() : int
- Returns the language id for the current download context.
- getPresetId() : int
- Returns the preset id for the current download context.
- getType() : string
- Returns the type of the download context.
- matchesPreset() : bool
- Checks if the provided preset matches the download context.
- setIds() : void
- Sets the ids for the current download context.
- setLanguageId() : void
- Sets the language id for the current download context.
- setPresetId() : void
- Sets the preset id for the current download context.
Methods
createContext()
Creates an open search download context for the specified type.
public
static createContext(string $sType) : CSOpenSearchDownloadContext
Parameters
- $sType : string
-
The download type.
Tags
Return values
CSOpenSearchDownloadContext —The created download context
getClass()
Returns the class for the download context.
public
getClass() : string
Tags
Return values
string —The class of the download context
getIds()
Returns the ids of the download context.
public
getIds() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getLanguageId()
Returns the language id for the current download context.
public
getLanguageId() : int
Tags
Return values
int —The language id for the current download context.
getPresetId()
Returns the preset id for the current download context.
public
getPresetId() : int
Tags
Return values
int —The preset id for the current download context.
getType()
Returns the type of the download context.
public
getType() : string
Tags
Return values
string —The type of the download context.
matchesPreset()
Checks if the provided preset matches the download context.
public
matchesPreset(string $sPreset) : bool
Parameters
- $sPreset : string
-
The preset to check if it matches the download context.
Tags
Return values
bool —True if preset matches the download context, otherwise false.
setIds()
Sets the ids for the current download context.
public
setIds(array<string|int, mixed> $aIds) : void
Parameters
- $aIds : array<string|int, mixed>
-
The ids for the current download context.
Tags
Return values
void —setLanguageId()
Sets the language id for the current download context.
public
setLanguageId(int $iLanguageId) : void
Parameters
- $iLanguageId : int
-
The language id for the current download context.
Tags
Return values
void —setPresetId()
Sets the preset id for the current download context.
public
setPresetId(int $iPresetId) : void
Parameters
- $iPresetId : int
-
The preset id for the current download context.