Contentserv PHP API

CSSystemLogEntry 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
CSLogEntry constructor.
getAcknowledged()  : string
Returns the "Acknowledged" flag.
getDateTime()  : string
Returns the datetime of the API log object.
getDescription()  : string
Returns the log description.
getLevel()  : int
Returns the log level.
getModule()  : string
Returns the module name.
getTitle()  : string
Returns the log title.
getTrace()  : string
Returns the log debug trace.
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.
setAcknowledged()  : void
Sets the flag "Acknowledged".
setDateTime()  : void
Sets the date time for the current API log object.
setDescription()  : void
Sets the description to the API log object.
setLevel()  : void
Sets the log level.
setModule()  : void
Sets the module name to the API log object.
setTitle()  : void
Sets the title to the API log object.
setTrace()  : void
Sets the debug trace to the API log object.
setType()  : void
Sets the log type.
setUser()  : void
Sets the user object for the current API log object.

Methods

__construct()

CSLogEntry constructor.

public __construct() : mixed
Tags
Return values
mixed —

getAcknowledged()

Returns the "Acknowledged" flag.

public getAcknowledged() : string
Tags
Return values
string —

with the stored "Acknowledged" flag in the API log object.

getDateTime()

Returns the datetime of the API log object.

public getDateTime() : string
Tags
Return values
string —

with the datetime.

getDescription()

Returns the log description.

public getDescription() : string
Tags
Return values
string —

with the stored description in the API log object.

getLevel()

Returns the log level.

public getLevel() : int
Tags
Return values
int —

with the level of the log.

getModule()

Returns the module name.

public getModule() : string
Tags
Return values
string —

with the stored module name in the API log object.

getTitle()

Returns the log title.

public getTitle() : string
Tags
Return values
string —

with the stored tile in the API log object.

getTrace()

Returns the log debug trace.

public getTrace() : string
Tags
Return values
string —

with the stored trace in the API log object.

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.

setAcknowledged()

Sets the flag "Acknowledged".

public setAcknowledged(bool $bAcknowledged) : void
Parameters
$bAcknowledged : bool

Whether the log is acknowledged.

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 —

setDescription()

Sets the description to the API log object.

public setDescription(string $sDescription) : void
Parameters
$sDescription : string

The log description.

Tags
Return values
void —

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 —

setModule()

Sets the module name to the API log object.

public setModule(string $sModule) : void
Parameters
$sModule : string

The module name.

Tags
Return values
void —

setTitle()

Sets the title to the API log object.

public setTitle(string $sTitle) : void
Parameters
$sTitle : string

The log title.

Tags
Return values
void —

setTrace()

Sets the debug trace to the API log object.

public setTrace(string $sTrace) : void
Parameters
$sTrace : string

The trace to debug the log message.

Tags
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