CSDownloadContext
in package
Tags
Table of Contents
- addItems() : void
- Adds download items to the context.
- addItemsByClassAndIds() : void
- Adds download items based on record class and id list.
- createContext() : CSDownloadContext
- Creates a download context object
- getClasses() : array<string|int, mixed>
- Returns all classes contained by the download items as a unique array.
- getItemIdsForClass() : array<string|int, mixed>
- Returns the download item ids for the specified record class.
- getItems() : array<string|int, mixed>
- Returns all defined download items.
- getLanguageIds() : array<string|int, mixed>
- Returns all language ids for the current context.
- setLanguageIds() : void
- Sets the language ids for the current context.
Methods
addItems()
Adds download items to the context.
public
addItems(array<string|int, mixed> $aItems) : void
Parameters
- $aItems : array<string|int, mixed>
-
A list of download items as CSDownloadContextItem instances.
Tags
Return values
void —addItemsByClassAndIds()
Adds download items based on record class and id list.
public
addItemsByClassAndIds(string $sClass, array<string|int, mixed> $aIds) : void
Parameters
- $sClass : string
-
The record class for the specified id list.
- $aIds : array<string|int, mixed>
-
The record ids to be added as download items.
Tags
Return values
void —createContext()
Creates a download context object
public
static createContext() : CSDownloadContext
Tags
Return values
CSDownloadContext —The created download context
getClasses()
Returns all classes contained by the download items as a unique array.
public
getClasses() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —All unique class names contained in the download items list.
getItemIdsForClass()
Returns the download item ids for the specified record class.
public
getItemIdsForClass(string $sClass) : array<string|int, mixed>
Parameters
- $sClass : string
-
The record class for which ids should be returned.
Tags
Return values
array<string|int, mixed> —The download item ids matching the provided record class
getItems()
Returns all defined download items.
public
getItems() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —A list of all download items for the current context.
getLanguageIds()
Returns all language ids for the current context.
public
getLanguageIds() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —All language ids for the current context.
setLanguageIds()
Sets the language ids for the current context.
public
setLanguageIds(array<string|int, mixed> $aIds) : void
Parameters
- $aIds : array<string|int, mixed>
-
All language ids for the current context.