Contentserv PHP API

CSActiveScriptLog
in package

API Object for the ActiveScriptLog Record

Tags
since

CS15.0

access

public

Table of Contents

__construct()  : CSActiveScriptLog
The Constructor
createLog()  : CSActiveScriptLog
Creates a new Log entry for a Job
getActiveScriptJob()  : CSActiveScriptJob
Returns the ActiveScriptJob for this log
getActiveScriptJobID()  : int
Returns the ActiveScriptJobs ID for this log
getID()  : int
Retrieves the ID
getLogLink()  : CSActiveScriptLogLink|false
Returns the log link if available for this log
getLogsUrl()  : string
Creates a url that shows the logs for a Job
getMessage()  : string
Retrieves the message
getStatus()  : int
Tells the status of this log
getStatusColor()  : string
Gives the color name that should be used for the current status in CSS sheets
getStatusIcon()  : string
Gives the icon that should be used for the current status
getStatusLabel()  : string
Tells the status of this log as formatted string
getStatusName()  : string
Tells the non localized status of this log as formatted string
getTimestamp()  : float
Retrieves the Timestamp as float when the Log was created
getValue()  : string
Gets a value
setActiveScriptJobID()  : void
Sets the ActiveScriptJobs ID for this log
setMessage()  : void
Sets the message
setStatus()  : void
Sets the status of this job
setTimestamp()  : void
Defines the Timestamp as float seconds when the Log was created
setValue()  : void
Sets a value
store()  : void
Stores the active script log

Methods

getActiveScriptJobID()

Returns the ActiveScriptJobs ID for this log

public getActiveScriptJobID() : int
Tags
Return values
int —

the ActiveScriptJobID

getID()

Retrieves the ID

public getID() : int
Tags
Return values
int —

The ID

getLogsUrl()

Creates a url that shows the logs for a Job

public static getLogsUrl([int $ActiveScriptJobID = '' ][, mixed $base = 'relative' ]) : string
Parameters
$ActiveScriptJobID : int = ''

the Job ID, if empty the JobID can be appended afterwards

$base : mixed = 'relative'
Tags
Return values
string —

the URL

getMessage()

Retrieves the message

public getMessage() : string
Tags
Return values
string —

the message

getStatus()

Tells the status of this log

public getStatus() : int
Tags
Return values
int —

the status as one of the CSActiveScript::ACTIVE_SCRIPT_STATUS_* constants

getStatusColor()

Gives the color name that should be used for the current status in CSS sheets

public getStatusColor() : string
Tags
Return values
string —

the color name like purple or red, which should be used as css classes

getStatusIcon()

Gives the icon that should be used for the current status

public getStatusIcon() : string
Tags
Return values
string —

the icon relative to the admin

getStatusLabel()

Tells the status of this log as formatted string

public getStatusLabel([string $language = null ]) : string
Parameters
$language : string = null

the short name of the language if the name should be translated

Tags
Return values
string —

the status name as one of the CSActiveScript::ACTIVE_SCRIPT_STATUS_* constants

getStatusName()

Tells the non localized status of this log as formatted string

public getStatusName() : string
Tags
Return values
string —

the non localized status name as one of the CSActiveScript::ACTIVE_SCRIPT_STATUS_* constants

getTimestamp()

Retrieves the Timestamp as float when the Log was created

public getTimestamp() : float
Tags
Return values
float —

the timestamp as formatted string

getValue()

Gets a value

public getValue(string $name) : string
Parameters
$name : string
Tags
Return values
string —

the value

setActiveScriptJobID()

Sets the ActiveScriptJobs ID for this log

public setActiveScriptJobID(int $iActiveScriptJobID) : void
Parameters
$iActiveScriptJobID : int

the ActiveScriptJobID

Tags
Return values
void —

setMessage()

Sets the message

public setMessage(string $sMessage) : void
Parameters
$sMessage : string

the message

Tags
Return values
void —

setStatus()

Sets the status of this job

public setStatus(mixed $iStatus) : void
Parameters
$iStatus : mixed
Tags
Return values
void —

setTimestamp()

Defines the Timestamp as float seconds when the Log was created

public setTimestamp(string $fTimestamp) : void
Parameters
$fTimestamp : string

the start as float seconds since 1970

Tags
Return values
void —

setValue()

Sets a value

public setValue(string $name, string $value) : void
Parameters
$name : string
$value : string
Tags
Return values
void —

store()

Stores the active script log

public store() : void
Tags
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results