Skip to content

Options to control error logging #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
panrafal wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Options to control error logging #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 41 additions & 8 deletions src/php_error.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1135,6 +1135,10 @@ public static function identifyTypeHTML( $arg, $recurseLevels=1 ) {

private $classNotFoundException;

private $errorLog;
private $errorLogFormat;
private $errorLogTimeFormat;

/**
* = Options =
*
Expand Down Expand Up @@ -1189,6 +1193,23 @@ public static function identifyTypeHTML( $arg, $recurseLevels=1 ) {
* pages too, such as replying with images of JavaScript
* from your PHP. Defaults to true.
*
* - error_log Defines where to log messages.
* FALSE - disables logging
* 0 - logs to the syslog, equivalent of php's error_log($message, 0) (default)
* absolute path - logs to the provided file path, equivalent of php's error_log($message, 3, $path)
* email - sends an email, equivalent of php's error_log($message, 1, $email)
*
* - error_log_format Format of log messages with printf() directives.
* %1$s - timestamp (empty if error_log is set to 0, because syslog is using it's own timestamp)
* %2$s - error message
* %3$s - file
* %4$s - line
* %5$s - stack trace (starts on the newline and is indented)
* Defaults to "%s%s\n %s, %s %s"
*
* - error_log_time_format Format of log's timestamp compatible with strftime()
* Defaults to "[%c] "
*
* @param options Optional, an array of values to customize this handler.
* @throws Exception This is raised if given an options that does *not* exist (so you know that option is meaningless).
*/
Expand Down Expand Up @@ -1249,6 +1270,10 @@ public function __construct( $options=null ) {
$this->displayLineNumber = ErrorHandler::optionsPop( $options, 'display_line_numbers' , false );

$this->htmlOnly = !! ErrorHandler::optionsPop( $options, 'html_only', true );

$this->errorLog = ErrorHandler::optionsPop( $options, 'error_log', 0 );
$this->errorLogFormat = ErrorHandler::optionsPop( $options, 'error_log_format', "%s%s\n %s, %s %s");
$this->errorLogTimeFormat = ErrorHandler::optionsPop( $options, 'error_log_time_format', '[%c] ' );

$this->classNotFoundException = null;

Expand Down Expand Up @@ -2284,17 +2309,25 @@ private function parseStackTrace( $code, $message, $errLine, $errFile, &$stackTr
}

private function logError( $message, $file, $line, $ex=null ) {
if ($this->errorLog === false || !$this->errorLogFormat) return;

$string = "";
$trace = "";
if ( $ex ) {
$trace = $ex->getTraceAsString();
$parts = explode( "\n", $trace );
$trace = " " . join( "\n ", $parts );

if ( ! ErrorHandler::isIIS() ) {
error_log( "$message \n $file, $line \n$trace" );
}
} else {
if ( ! ErrorHandler::isIIS() ) {
error_log( "$message \n $file, $line" );
$trace = PHP_EOL . " " . join( PHP_EOL . " ", $parts );
}
$string = sprintf($this->errorLogFormat, $this->errorLog !== 0 ? strftime($this->errorLogTimeFormat) : '', $message, $file, $line, $trace);
if ($this->errorLog) $string .= PHP_EOL;

if ( ! ErrorHandler::isIIS() ) {
if (is_numeric($this->errorLog)) {
error_log( $string, $this->errorLog );
} elseif (dirname($this->errorLog) && is_dir(dirname($this->errorLog))) {
error_log( $string, 3, $this->errorLog);
} elseif (strpos($this->errorLog, '@') > 0) {
error_log( $string, 1, $this->errorLog );
}
}
}
Expand Down