CSMamDownloadLogEntry
extends CSItemDownloadLogEntry
in package
Defines a plain and an abstract API object for the log handling.
The class defines only standard setter and getter methods. It is a plain API object without any connection to the "LogEntry" object!
The object can be called via the API class CSLog::getLogEntry(). After initializing and inserting the information to the API object it can be stored with the function CSLog::addLogEntry();
Tags
Table of Contents
- __construct() : mixed
- CSItemDownloadLogEntry constructor.
- getArchiveName() : string
- Returns the stored download archive name in the API object.
- getBrowser() : string
- Returns the stored browser information in the API object.
- getColorSpace() : int
- Returns whether the preset color space, custom preset color space or the original image color space.
- getContext() : string
- Returns the context in the API object.
- getDateTime() : string
- Returns the datetime of the API log object.
- getDownloadName() : string
- Returns the stored download name in the API object.
- getDownloadType() : string
- Returns the stored download type in the API log object.
- getHeight() : int
- Returns whether the preset height, custom preset height or the original image height.
- getItem() : Item|null
- Returns the stored item in the API log object.
- getItemId() : int
- Returns the stored item id in the API log object.
- getItemLabel() : string
- Returns the label of the stored item in the API log object.
- getLanguageId() : null|int
- Returns the defined language id or the current language id of the item.
- getLevel() : int
- Returns the log level.
- getPreset() : CSMamExportPreset|MamExportPreset|null
- Returns the MAM export preset object.
- getPresetId() : int
- Returns the id of the preset object.
- getPresetLabel() : string
- Returns the label of the preset object or the default label of the custom preset.
- getResolution() : int
- Returns whether the preset resolution, custom preset resolution or the original image resolution.
- getType() : int
- Returns the log type.
- getUser() : CSUser|User|null
- Returns the defined user.
- getUserId() : int
- Returns the id of the defined user.
- getUserName() : string
- Returns the username of the defined user.
- getWidth() : int
- Returns whether the preset width, custom preset width or the original image width.
- setArchiveName() : void
- Sets the archive name to the API log object.
- setBrowser() : void
- Sets the browser to the API log object.
- setContext() : void
- Sets the context to the API log object.
- setCustomPreset() : void
- Sets the custom preset information to the API object.
- setDateTime() : void
- Sets the date time for the current API log object.
- setDownloadName() : void
- Sets the download name to the API log object.
- setDownloadType() : void
- Sets the action type to the API log object.
- setItem() : void
- Sets the current item to the API log object.
- setLanguageId() : mixed
- Sets the language id to the API log object.
- setLevel() : void
- Sets the log level.
- setPreset() : void
- Sets the preset object for the current download.
- setType() : void
- Sets the log type.
- setUser() : void
- Sets the user object for the current API log object.
Methods
__construct()
CSItemDownloadLogEntry constructor.
public
__construct() : mixed
Tags
Return values
mixed —getArchiveName()
Returns the stored download archive name in the API object.
public
getArchiveName() : string
.
Tags
Return values
string —with the stored download archive name.
getBrowser()
Returns the stored browser information in the API object.
public
getBrowser() : string
.
Tags
Return values
string —with the stored browser information (BrowserName, BrowserVersion)
getColorSpace()
Returns whether the preset color space, custom preset color space or the original image color space.
public
getColorSpace() : int
Tags
Return values
int —with the color space.
getContext()
Returns the context in the API object.
public
getContext() : string
.
Tags
Return values
string —with the stored download context.
getDateTime()
Returns the datetime of the API log object.
public
getDateTime() : string
Tags
Return values
string —with the datetime.
getDownloadName()
Returns the stored download name in the API object.
public
getDownloadName() : string
Tags
Return values
string —with the stored download name.
getDownloadType()
Returns the stored download type in the API log object.
public
getDownloadType() : string
Tags
Return values
string —with the stored download type.
getHeight()
Returns whether the preset height, custom preset height or the original image height.
public
getHeight() : int
Tags
Return values
int —with the height.
getItem()
Returns the stored item in the API log object.
public
getItem() : Item|null
Tags
Return values
Item|null —getItemId()
Returns the stored item id in the API log object.
public
getItemId() : int
Tags
Return values
int —with the item id.
getItemLabel()
Returns the label of the stored item in the API log object.
public
getItemLabel() : string
Tags
Return values
string —with the label of the stored item.
getLanguageId()
Returns the defined language id or the current language id of the item.
public
getLanguageId() : null|int
Tags
Return values
null|int —with the stored language id or the current language id.
getLevel()
Returns the log level.
public
getLevel() : int
Tags
Return values
int —with the level of the log.
getPreset()
Returns the MAM export preset object.
public
getPreset() : CSMamExportPreset|MamExportPreset|null
Tags
Return values
CSMamExportPreset|MamExportPreset|null —getPresetId()
Returns the id of the preset object.
public
getPresetId() : int
Tags
Return values
int —with the id of the stored preset object.
getPresetLabel()
Returns the label of the preset object or the default label of the custom preset.
public
getPresetLabel() : string
Tags
Return values
string —with the label of the preset object or the default label of the custom preset.
getResolution()
Returns whether the preset resolution, custom preset resolution or the original image resolution.
public
getResolution() : int
Tags
Return values
int —with the resolution / dpi.
getType()
Returns the log type.
public
getType() : int
Tags
Return values
int —with the type of the log.
getUser()
Returns the defined user.
public
getUser() : CSUser|User|null
If no user has been defined the current user will be returned.
Tags
Return values
CSUser|User|null —the user API log object.
getUserId()
Returns the id of the defined user.
public
getUserId() : int
If no user has been defined the current user id will be returned.
Tags
Return values
int —with the user id of the API log object.
getUserName()
Returns the username of the defined user.
public
getUserName() : string
If no user has been defined the current username will be returned.
Tags
Return values
string —with the username of the API log object.
getWidth()
Returns whether the preset width, custom preset width or the original image width.
public
getWidth() : int
Tags
Return values
int —with the width.
setArchiveName()
Sets the archive name to the API log object.
public
setArchiveName(string $sArchiveName) : void
.
Parameters
- $sArchiveName : string
Tags
Return values
void —setBrowser()
Sets the browser to the API log object.
public
setBrowser(string $sBrowser) : void
Parameters
- $sBrowser : string
-
The browser information.
Tags
Return values
void —setContext()
Sets the context to the API log object.
public
setContext(string $sContext) : void
Parameters
- $sContext : string
-
The download context.
Tags
Return values
void —setCustomPreset()
Sets the custom preset information to the API object.
public
setCustomPreset(int $iWidth, int $iHeight, string $sColorSpace, int $iResolution) : void
Parameters
- $iWidth : int
-
The width in the custom preset configuration.
- $iHeight : int
-
The height in the custom preset configuration.
- $sColorSpace : string
-
The color space in the custom preset configuration.
- $iResolution : int
-
The resolution/dpi in the custom preset configuration.
Tags
Return values
void —setDateTime()
Sets the date time for the current API log object.
public
setDateTime(string $sDateTime) : void
If not set manually the date time will be set automatically in the constructor.
Parameters
- $sDateTime : string
Tags
Return values
void —setDownloadName()
Sets the download name to the API log object.
public
setDownloadName(string $sDownloadName) : void
.
Parameters
- $sDownloadName : string
Tags
Return values
void —setDownloadType()
Sets the action type to the API log object.
public
setDownloadType(int $iDownloadType) : void
Parameters
- $iDownloadType : int
Tags
Return values
void —setItem()
Sets the current item to the API log object.
public
setItem(CSItemApiItem|Item $oItem) : void
Parameters
- $oItem : CSItemApiItem|Item
Tags
Return values
void —setLanguageId()
Sets the language id to the API log object.
public
setLanguageId(int $iLanguageId) : mixed
Parameters
- $iLanguageId : int
Tags
Return values
mixed —setLevel()
Sets the log level.
public
setLevel([int $iLevel = CSLog::LEVEL_MINIMUM ]) : void
Parameters
- $iLevel : int = CSLog::LEVEL_MINIMUM
Tags
Return values
void —setPreset()
Sets the preset object for the current download.
public
setPreset(CSMamExportPreset|MamExportPreset|int $mPreset) : void
Parameters
- $mPreset : CSMamExportPreset|MamExportPreset|int
-
The preset object or the preset id.
Tags
Return values
void —setType()
Sets the log type.
public
setType([int $iType = CSLog::TYPE_NOTE ]) : void
Parameters
- $iType : int = CSLog::TYPE_NOTE
Tags
Return values
void —setUser()
Sets the user object for the current API log object.
public
setUser(User|CSUser $oUser) : void
Parameters
- $oUser : User|CSUser