CSActiveScriptLogLink
in package
API Object for the ActiveScriptLogLink Record
Tags
Table of Contents
- __construct() : CSActiveScriptLogLink
- The Constructor
- createLogLink() : CSActiveScriptLogLink
- Creates a new Log entry for a Log
- getActiveScriptLog() : CSActiveScriptLog
- Returns the ActiveScriptLog for this log link
- getActiveScriptLogID() : int
- Returns the ActiveScriptLogID for this log link
- getDescription() : string
- Retrieves the description
- getFileName() : string
- Tells the FileName of this log link
- getFilePath() : string
- Returns the complete file path including file name
- getFolderPrefix() : string
- Tells the FolderPrefix of this log link
- getID() : int
- Retrieves the ID
- getLogLink() : CSActiveScriptLogLink|false
- Tries to find a log link for a given log id
- getLogMessage() : string
- getTarget() : string
- Retrieves the target of the link
- getUrl() : string
- Retrieves the Url
- getValue() : string
- Gets a value
- setActiveScriptLogID() : void
- Sets the ActiveScriptLogID for this log link
- setDescription() : void
- Sets the description
- setFileName() : void
- Sets the FileName of this log link
- setFolderPrefix() : void
- Sets the FolderPrefix of this log link
- setTarget() : void
- Sets the target of the link
- setUrl() : void
- Defines the Url
- setValue() : void
- Sets a value
- store() : void
- Stores the active script log link
Methods
__construct()
The Constructor
public
__construct(mixed $mActiveScriptLogLinkID) : CSActiveScriptLogLink
Parameters
- $mActiveScriptLogLinkID : mixed
-
The ID of the active script log link or the log link record itself
Tags
Return values
CSActiveScriptLogLink —createLogLink()
Creates a new Log entry for a Log
public
static createLogLink(int $iActiveScriptLogID) : CSActiveScriptLogLink
Parameters
- $iActiveScriptLogID : int
-
the Log ID
Tags
Return values
CSActiveScriptLogLink —the log link
getActiveScriptLog()
Returns the ActiveScriptLog for this log link
public
getActiveScriptLog() : CSActiveScriptLog
Tags
Return values
CSActiveScriptLog —getActiveScriptLogID()
Returns the ActiveScriptLogID for this log link
public
getActiveScriptLogID() : int
Tags
Return values
int —the ActiveScriptLogID
getDescription()
Retrieves the description
public
getDescription() : string
Tags
Return values
string —the message
getFileName()
Tells the FileName of this log link
public
getFileName() : string
Tags
Return values
string —the file name
getFilePath()
Returns the complete file path including file name
public
getFilePath() : string
Tags
Return values
string —getFolderPrefix()
Tells the FolderPrefix of this log link
public
getFolderPrefix() : string
Tags
Return values
string —the folder prefix
getID()
Retrieves the ID
public
getID() : int
Tags
Return values
int —The ID
getLogLink()
Tries to find a log link for a given log id
public
static getLogLink(mixed $iActiveScriptLogID) : CSActiveScriptLogLink|false
Parameters
- $iActiveScriptLogID : mixed
Tags
Return values
CSActiveScriptLogLink|false —getLogMessage()
public
getLogMessage() : string
Tags
Return values
string —getTarget()
Retrieves the target of the link
public
getTarget() : string
Tags
Return values
string —the target
getUrl()
Retrieves the Url
public
getUrl() : string
Tags
Return values
string —the url
getValue()
Gets a value
public
getValue(string $name) : string
Parameters
- $name : string
Tags
Return values
string —the value
setActiveScriptLogID()
Sets the ActiveScriptLogID for this log link
public
setActiveScriptLogID(int $iActiveScriptLogID) : void
Parameters
- $iActiveScriptLogID : int
-
the ActiveScriptLogID
Tags
Return values
void —setDescription()
Sets the description
public
setDescription(string $sDescription) : void
Parameters
- $sDescription : string
-
the description
Tags
Return values
void —setFileName()
Sets the FileName of this log link
public
setFileName(string $sFileName) : void
Parameters
- $sFileName : string
-
the file name
Tags
Return values
void —setFolderPrefix()
Sets the FolderPrefix of this log link
public
setFolderPrefix(string $sFolderPrefix) : void
Parameters
- $sFolderPrefix : string
-
the folder prefix
Tags
Return values
void —setTarget()
Sets the target of the link
public
setTarget(string $sTarget) : void
Parameters
- $sTarget : string
-
the target of the link
Tags
Return values
void —setUrl()
Defines the Url
public
setUrl(string $sUrl) : void
Parameters
- $sUrl : string
-
the url
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 link
public
store() : void