Nosial/loglib
2
0
Fork 0
Code Issues Pull requests Projects Releases 12 Packages Wiki Activity Actions

Added documentation to FileLogging

Browse source
This commit is contained in:
netkas 2024-10-28 19:38:20 -04:00
parent 8f9333a273
commit 709729df14
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
src/LogLib/Handlers/FileLogging.php
View file

@ -58,6 +58,13 @@ class FileLogging implements LogHandlerInterface
self::getLogger($application)->append($output); self::getLogger($application)->append($output);
} }
/**
* Retrieves the logger instance associated with the given application.
* If the logger does not exist, it initializes a new one and stores it.
*
* @param Application $application The application for which the logger is to be retrieved.
* @return FileLock The logger instance associated with the specified application.
*/
private static function getLogger(Application $application): FileLock private static function getLogger(Application $application): FileLock
{ {
if(!isset(self::$application_logs[$application->getApplicationName()])) if(!isset(self::$application_logs[$application->getApplicationName()]))
@ -68,6 +75,13 @@ class FileLogging implements LogHandlerInterface
return self::$application_logs[$application->getApplicationName()]; return self::$application_logs[$application->getApplicationName()];
} }
/**
* Retrieves the log file path for the specified application.
*
* @param Application $application The application instance for which the log file is to be retrieved.
* @return string The full path of the log file.
* @throws LoggingException If the logging directory is not writable or cannot be created.
*/
private static function getLogFile(Application $application): string private static function getLogFile(Application $application): string
{ {
$logging_directory = $application->getFileLoggingDirectory(); $logging_directory = $application->getFileLoggingDirectory();
@ -92,11 +106,23 @@ class FileLogging implements LogHandlerInterface
return $logging_file; return $logging_file;
} }
/**
* Retrieves the current timestamp formatted as "yd/m/y H:i".
*
* @return string The formatted current timestamp.
*/
private static function getTimestamp(): string private static function getTimestamp(): string
{ {
return date('yd/m/y H:i'); return date('yd/m/y H:i');
} }
/**
* Generates a detailed string representation of a given Throwable object, including its message, code,
* file, line of occurrence, stack trace, and any previous exceptions.
*
* @param Throwable|null $exception The throwable object to process. If null, an empty string is returned.
* @return string A detailed string representation of the throwable object.
*/
private static function outException(?Throwable $exception=null): string private static function outException(?Throwable $exception=null): string
{ {
if($exception === null) if($exception === null)