PHP Класс DeploynautLogFile

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$basePath
$logFile

Открытые методы

Метод Описание
__construct ( string $logFile, string | null $basePath = null )
content ( ) : string Return the content of the log file.
exists ( ) : boolean Does the log file exist?
getLogFilePath ( ) : string | null Return log file path, assuming it exists. Returns NULL if nothing found.
getRawFilePath ( ) : string Return the un-sanitised log path.
getSanitisedLogFilePath ( ) : string Get the sanitised log path.
setBasePath ( string $path ) Set the base path of where logs reside
setLogFile ( string $filename ) Set the log filename
write ( string $message ) Write a message line into the log file.

Описание методов

__construct() публичный Метод

public __construct ( string $logFile, string | null $basePath = null )
$logFile string The log filename
$basePath string | null Base path of where logs reside. Defaults to DEPLOYNAUT_LOG_PATH

content() публичный Метод

Return the content of the log file.
public content ( ) : string
Результат string

exists() публичный Метод

Does the log file exist?
public exists ( ) : boolean
Результат boolean

getLogFilePath() публичный Метод

Return log file path, assuming it exists. Returns NULL if nothing found.
public getLogFilePath ( ) : string | null
Результат string | null

getRawFilePath() публичный Метод

Return the un-sanitised log path.
public getRawFilePath ( ) : string
Результат string

getSanitisedLogFilePath() публичный Метод

Get the sanitised log path.
public getSanitisedLogFilePath ( ) : string
Результат string

setBasePath() публичный Метод

Set the base path of where logs reside
public setBasePath ( string $path )
$path string

setLogFile() публичный Метод

Set the log filename
public setLogFile ( string $filename )
$filename string

write() публичный Метод

Write a message line into the log file.
public write ( string $message )
$message string

Описание свойств

$basePath защищенное свойство

protected $basePath

$logFile защищенное свойство

protected $logFile