PHP Class DeploynautLogFile

Protected Properties

Property	Type	Description
$basePath
$logFile

Method	Description
__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.

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

Return the content of the log file.

public content ( ) : string
return	string

Does the log file exist?

public exists ( ) : boolean
return	boolean

Return log file path, assuming it exists. Returns NULL if nothing found.

public getLogFilePath ( ) : string \| null
return	string \| null

Return the un-sanitised log path.

public getRawFilePath ( ) : string
return	string

Get the sanitised log path.

public getSanitisedLogFilePath ( ) : string
return	string

Set the base path of where logs reside

public setBasePath ( string $path )
$path	string

Set the log filename

public setLogFile ( string $filename )
$filename	string

Write a message line into the log file.

public write ( string $message )
$message	string

protected $basePath

protected $logFile