1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
<?php
/**
* Log handling functionality.
*
* @class WC_Log_Handler
* @package WooCommerce\Abstracts
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Abstract WC Log Handler Class
*
* @version 1.0.0
* @package WooCommerce\Abstracts
*/
abstract class WC_Log_Handler implements WC_Log_Handler_Interface {
/**
* Formats a timestamp for use in log messages.
*
* @param int $timestamp Log timestamp.
* @return string Formatted time for use in log entry.
*/
protected static function format_time( $timestamp ) {
return gmdate( 'c', $timestamp );
}
/**
* Builds a log entry text from level, timestamp and message.
*
* @param int $timestamp Log timestamp.
* @param string $level emergency|alert|critical|error|warning|notice|info|debug.
* @param string $message Log message.
* @param array $context Additional information for log handlers.
*
* @return string Formatted log entry.
*/
protected static function format_entry( $timestamp, $level, $message, $context ) {
$time_string = self::format_time( $timestamp );
$level_string = strtoupper( $level );
$entry = "{$time_string} {$level_string} {$message}";
/**
* Filter the formatted log entry before it is written.
*
* @since 3.0.0
*
* @param string $entry The formatted entry.
* @param array $args The raw data that gets assembled into a log entry.
*/
return apply_filters(
'woocommerce_format_log_entry',
$entry,
array(
'timestamp' => $timestamp,
'level' => $level,
'message' => $message,
'context' => $context,
)
);
}
/**
* Get a backtrace that shows where the logging function was called.
*
* @return array
*/
protected static function get_backtrace() {
// Get the filenames of the logging-related classes so we can ignore them.
$ignore_files = array_map(
function( $class ) {
try {
$reflector = new \ReflectionClass( $class );
return $reflector->getFileName();
} catch ( Exception $exception ) {
return null;
}
},
array( wc_get_logger(), self::class, static::class )
);
$backtrace = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_debug_backtrace
$filtered_backtrace = array_filter(
$backtrace,
function( $frame ) use ( $ignore_files ) {
$ignore = isset( $frame['file'] ) && in_array( $frame['file'], $ignore_files, true );
return ! $ignore;
}
);
return array_values( $filtered_backtrace );
}
}
|