Contentserv PHP API

CSItemDownloadLogEntry extends CSLogEntry
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.
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.
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.
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.
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.
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.
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)

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.

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.

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.

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
see
CSItemDownloadLog

context constants

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
see
CSItemActionLog

constants for the types.

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
see
CSLog

constants

throws
CSLogException
Return values
void —

setType()

Sets the log type.

public setType([int $iType = CSLog::TYPE_NOTE ]) : void
Parameters
$iType : int = CSLog::TYPE_NOTE
Tags
see
CSLog

constants

Return values
void —

setUser()

Sets the user object for the current API log object.

public setUser(User|CSUser $oUser) : void
Parameters
$oUser : User|CSUser
Tags
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results