1. <?php
  3. /**
  4. * Class Logger.
  5. * A simple logger class for internal tooling.
  6. */
  7. class Logger {
  9. /**
  10. * Log level. Can be 'debug', 'info', 'warning', 'error', 'critical'.
  11. * @var string
  12. */
  13. private string $level = 'info';
  15. /**
  16. * Log file path.
  17. * @var string
  18. */
  19. private string $filePath;
  21. /**
  22. * Logger constructor.
  23. * @param string $filePath The path to the log file.
  24. */
  25. public function __construct(string $filePath) {
  26. $this->filePath = $filePath;
  27. }
  29. /**
  30. * Logs a message to the log file.
  31. * @param string $message The message to log.
  32. * @param string $level The log level (debug, info, warning, error, critical).
  33. * @return bool True on success, false on failure.
  34. */
  35. public function log(string $message, string $level = 'info'): bool {
  36. // Validate log level
  37. $validLevels = ['debug', 'info', 'warning', 'error', 'critical'];
  38. if (!in_array($level, $validLevels)) {
  39. $level = 'info'; // Default to info if invalid
  40. }
  42. // Prepare the log entry
  43. $timestamp = date('Y-m-d H:i:s');
  44. $logEntry = "[$timestamp] [$level] $message\n";
  46. // File open for appending
  47. $fileHandle = fopen($this->filePath, 'a');
  49. if ($fileHandle) {
  50. // Write the log entry to the file
  51. if (fwrite($fileHandle, $logEntry)) {
  52. fclose($fileHandle);
  53. return true; // Log successful
  54. } else {
  55. fclose($fileHandle);
  56. return false; // Log failed
  57. }
  58. } else {
  59. return false; // Failed to open log file.
  60. }
  61. }
  63. /**
  64. * Logs a debug message.
  65. * @param string $message The debug message.
  66. * @return bool True on success, false on failure.
  67. */
  68. public function debug(string $message): bool {
  69. return $this->log($message, 'debug');
  70. }
  72. /**
  73. * Logs an informational message.
  74. * @param string $message The informational message.
  75. * @return bool True on success, false on failure.
  76. */
  77. public function info(string $message): bool {
  78. return $this->log($message, 'info');
  79. }
  81. /**
  82. * Logs a warning message.
  83. * @param string $message The warning message.
  84. * @return bool True on success, false on failure.
  85. */
  86. public function warning(string $message): bool {
  87. return $this->log($message, 'warning');
  88. }
  90. /**
  91. * Logs an error message.
  92. * @param string $message The error message.
  93. * @return bool True on success, false on failure.
  94. */
  95. public function error(string $message): bool {
  96. return $this->log($message, 'error');
  97. }
  99. /**
  100. * Logs a critical message.
  101. * @param string $message The critical message.
  102. * @return bool True on success, false on failure.
  103. */
  104. public function critical(string $message): bool {
  105. return $this->log($message, 'critical');
  106. }
  107. }
  109. ?>

Add your comment