Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:core:messagelog

This is an old revision of the document!


MessageLog

Layer: Core · Source: lib/core/MessageLog.php:17 (lines 17–230)


final class MessageLog

MessageLog

Docblock Metadata

^ Tag ^ Value ^
| ''@category'' | Core Class |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |

Inheritance

No parent, interface or trait. This is a root type.

Constants (0)

None.

Properties (0)

None declared.

Methods (5)

^ Visibility ^ Method ^ Summary ^ Line ^
| public static | ''contentMessage()'' | contentMessage | 30 |
| public static | ''messageException()'' | messageException | 82 |
| public static | ''messageError()'' | messageError | 139 |
| private static | ''writeMessageToFile()'' | (undocumented) | 165 |
| private static | ''errorCodeMessage()'' | (undocumented) | 189 |

contentMessage()

public static function contentMessage($responseCode, $contentMessage = null, $privilege = null)

lines 30–72 (43)

contentMessage

^ Parameter ^ Type ^ Default ^ Description ^
| ''$responseCode'' | ''(untyped)'' | //required// | //none// |
| ''$contentMessage'' | ''(untyped)'' | ''null'' | //none// |
| ''$privilege'' | ''(untyped)'' | ''null'' | //none// |

Returns: (none declared) — string

messageException()

public static function messageException($exception, $logPath)

lines 82–127 (46)

messageException

^ Parameter ^ Type ^ Default ^ Description ^
| ''$exception'' | ''(untyped)'' | //required// | //none// |
| ''$logPath'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared) — string|void – return string or void

messageError()

public static function messageError($code, $description, $logPath, $file = null, $line = null)

lines 139–163 (25)

messageError

^ Parameter ^ Type ^ Default ^ Description ^
| ''$code'' | ''(untyped)'' | //required// | //none// |
| ''$description'' | ''(untyped)'' | //required// | //none// |
| ''$logPath'' | ''(untyped)'' | //required// | //none// |
| ''$file'' | ''(untyped)'' | ''null'' | //none// |
| ''$line'' | ''(untyped)'' | ''null'' | //none// |

Returns: (none declared)

writeMessageToFile()

private static function writeMessageToFile($data, $logPath)

lines 165–187 (23)

^ Parameter ^ Type ^ Default ^ Description ^
| ''$data'' | ''(untyped)'' | //required// | //none// |
| ''$logPath'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared)

errorCodeMessage()

private static function errorCodeMessage($code)

lines 189–229 (41)

^ Parameter ^ Type ^ Default ^ Description ^
| ''$code'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared)


This page is generated from source by 'tools/gendoc'. Edits will be overwritten.

scriptlog/lib/core/messagelog.1790413762.txt.gz · Last modified: by admin