Admin
5 years ago
Commands
5 years ago
Helpers
5 years ago
Migrations
5 years ago
ValueObjects
5 years ago
Assets.php
5 years ago
Log.php
5 years ago
LogFactory.php
5 years ago
LogModel.php
5 years ago
LogRepository.php
5 years ago
LogServiceProvider.php
5 years ago
Log.php
117 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Log; |
| 4 | |
| 5 | use Exception; |
| 6 | |
| 7 | /** |
| 8 | * Class Log |
| 9 | * |
| 10 | * The static facade intended to be the primary way of logging within GiveWP to make life easier. |
| 11 | * |
| 12 | * @package Give\Log |
| 13 | * @since 2.10.0 |
| 14 | * |
| 15 | * @note There are two special keywords used in the context that are representing category and source. |
| 16 | * The default value for the Category is "Core" and for the source is "Give Core" |
| 17 | * If you want to change the category and/or source, you should provide them as context attributes. |
| 18 | * Source and category attributes should be written lowercase. |
| 19 | * |
| 20 | * @example |
| 21 | * |
| 22 | * Log::error( 'Error message', [ |
| 23 | * 'category' => 'Payment', |
| 24 | * 'source' => 'Stripe add-on' |
| 25 | * ] ); |
| 26 | * |
| 27 | * @note Use as many contexts attributes as you need. The more the better. |
| 28 | * |
| 29 | * @example |
| 30 | * |
| 31 | * Log::error( 'Error message', [ |
| 32 | * 'category' => 'Payment', |
| 33 | * 'source' => 'Stripe add-on', |
| 34 | * 'donation_id' => $donationId, |
| 35 | * 'donor_id' => $donorId |
| 36 | * ] ); |
| 37 | * |
| 38 | * @note You can use an array or object as a context attribute value. |
| 39 | * |
| 40 | * @example |
| 41 | * |
| 42 | * try { |
| 43 | * something(); |
| 44 | * } catch ( Exception $exception ) { |
| 45 | * Log::error( 'Something went wrong', [ |
| 46 | * 'exception' => $exception, |
| 47 | * 'additional_info' => [ |
| 48 | * 'donation_id' => $donationId |
| 49 | * ] |
| 50 | * ] ); |
| 51 | * } |
| 52 | * |
| 53 | * |
| 54 | * @method static error( string $message, array $context = [] ) |
| 55 | * @method static warning( string $message, array $context = [] ) |
| 56 | * @method static notice( string $message, array $context = [] ) |
| 57 | * @method static success( string $message, array $context = [] ) |
| 58 | * @method static info( string $message, array $context = [] ) |
| 59 | * @method static http( string $message, array $context = [] ) |
| 60 | * @method static spam( string $message, array $context = [] ) |
| 61 | */ |
| 62 | class Log { |
| 63 | /** |
| 64 | * @param string $type |
| 65 | * @param array $args |
| 66 | */ |
| 67 | public static function __callStatic( $type, $args ) { |
| 68 | list ( $message, $context ) = array_pad( $args, 2, null ); |
| 69 | |
| 70 | if ( is_array( $context ) ) { |
| 71 | // Convert context values to string |
| 72 | $context = array_map( |
| 73 | function ( $item ) { |
| 74 | if ( is_array( $item ) || is_object( $item ) ) { |
| 75 | $item = print_r( $item, true ); |
| 76 | } |
| 77 | |
| 78 | return $item; |
| 79 | }, |
| 80 | $context |
| 81 | ); |
| 82 | |
| 83 | // Default fields |
| 84 | $data = array_filter( |
| 85 | $context, |
| 86 | function ( $key ) { |
| 87 | return array_key_exists( $key, LogFactory::getDefaults() ); |
| 88 | }, |
| 89 | ARRAY_FILTER_USE_KEY |
| 90 | ); |
| 91 | |
| 92 | // Additional context |
| 93 | $data['context'] = array_diff( |
| 94 | $context, |
| 95 | $data |
| 96 | ); |
| 97 | } |
| 98 | |
| 99 | // Set message |
| 100 | if ( ! is_null( $message ) ) { |
| 101 | $data['message'] = $message; |
| 102 | } |
| 103 | |
| 104 | // Set type |
| 105 | $data['type'] = $type; |
| 106 | |
| 107 | try { |
| 108 | $log = LogFactory::makeFromArray( $data ); |
| 109 | $log->save(); |
| 110 | |
| 111 | return $log; |
| 112 | } catch ( Exception $exception ) { |
| 113 | error_log( $exception->getMessage() ); |
| 114 | } |
| 115 | } |
| 116 | } |
| 117 |