Exception
2 weeks ago
WooCommerceCapture.php
2 weeks ago
WooCommerceHandler.php
2 weeks ago
WooCommerceMonologPlugin.php
2 weeks ago
WooCommerceCapture.php
133 lines
| 1 | <?php |
| 2 | |
| 3 | namespace FSVendor\WPDesk\Logger\WC; |
| 4 | |
| 5 | use FSVendor\Monolog\Logger; |
| 6 | use FSVendor\WPDesk\Logger\WC\Exception\WCLoggerAlreadyCaptured; |
| 7 | /** |
| 8 | * Can capture default WooCommerce logger |
| 9 | * |
| 10 | * @package WPDesk\Logger |
| 11 | */ |
| 12 | class WooCommerceCapture |
| 13 | { |
| 14 | const WOOCOMMERCE_LOGGER_FILTER = 'woocommerce_logging_class'; |
| 15 | const WOOCOMMERCE_AFTER_IS_LOADED_ACTION = 'woocommerce_loaded'; |
| 16 | /** @var string Minimal version of WooCommerce supported by logger capture */ |
| 17 | const SUPPORTED_WC_VERSION = '3.5.0'; |
| 18 | /** |
| 19 | * Is logger filter captured by library. |
| 20 | * |
| 21 | * @var bool |
| 22 | */ |
| 23 | private $isCaptured = \false; |
| 24 | /** |
| 25 | * Our monolog |
| 26 | * |
| 27 | * @var Logger |
| 28 | */ |
| 29 | private $monolog; |
| 30 | /** |
| 31 | * Original WC Logger |
| 32 | * |
| 33 | * @var \WC_Logger_Interface |
| 34 | */ |
| 35 | private $originalWCLogger; |
| 36 | /** |
| 37 | * WordPress hook function to return our logger |
| 38 | * |
| 39 | * @var ?callable |
| 40 | */ |
| 41 | private $captureHookFunction; |
| 42 | /** |
| 43 | * WordPress hook function to return original wc logger |
| 44 | * |
| 45 | * @var ?callable |
| 46 | */ |
| 47 | private $freeHookFunction; |
| 48 | public function __construct(Logger $monolog) |
| 49 | { |
| 50 | $this->monolog = $monolog; |
| 51 | } |
| 52 | /** |
| 53 | * Prepares callable property captureHookFunction. |
| 54 | * For it to work WC have to be loaded |
| 55 | */ |
| 56 | private function prepareCaptureHookCallable() |
| 57 | { |
| 58 | $monolog = $this->monolog; |
| 59 | if ($this->captureHookFunction === null) { |
| 60 | $this->captureHookFunction = function () use ($monolog) { |
| 61 | return new WooCommerceMonologPlugin($monolog, $this->originalWCLogger); |
| 62 | }; |
| 63 | $this->monolog->pushHandler(new WooCommerceHandler($this->originalWCLogger)); |
| 64 | } |
| 65 | } |
| 66 | /** |
| 67 | * Is this version of WooCommerce is supported by logger capture |
| 68 | * |
| 69 | * @return bool |
| 70 | */ |
| 71 | public static function isSupportedWCVersion() |
| 72 | { |
| 73 | return class_exists(\WooCommerce::class) && version_compare(\WooCommerce::instance()->version, self::SUPPORTED_WC_VERSION, '>='); |
| 74 | } |
| 75 | /** |
| 76 | * Capture WooCommerce logger and inject our decorated Logger |
| 77 | */ |
| 78 | public function captureWcLogger() |
| 79 | { |
| 80 | if (self::isSupportedWCVersion()) { |
| 81 | if ($this->isCaptured) { |
| 82 | throw new WCLoggerAlreadyCaptured('Try to free wc logger first.'); |
| 83 | } |
| 84 | if ($this->isWooCommerceLoggerAvailable()) { |
| 85 | $this->prepareFreeHookCallable(); |
| 86 | $this->prepareCaptureHookCallable(); |
| 87 | remove_filter(self::WOOCOMMERCE_LOGGER_FILTER, $this->freeHookFunction); |
| 88 | add_filter(self::WOOCOMMERCE_LOGGER_FILTER, $this->captureHookFunction); |
| 89 | $this->isCaptured = \true; |
| 90 | } elseif (function_exists('add_action')) { |
| 91 | add_action(self::WOOCOMMERCE_AFTER_IS_LOADED_ACTION, [$this, 'captureWcLogger']); |
| 92 | } else { |
| 93 | $this->monolog->alert('Cannot capture WC - WordPress is not available.'); |
| 94 | } |
| 95 | } else { |
| 96 | $this->monolog->alert('Cannot capture WC - WooCommerce version is not supported.'); |
| 97 | } |
| 98 | } |
| 99 | /** |
| 100 | * Can i fetch WC Logger? |
| 101 | * |
| 102 | * @return bool |
| 103 | */ |
| 104 | private function isWooCommerceLoggerAvailable() |
| 105 | { |
| 106 | return function_exists('wc_get_logger'); |
| 107 | } |
| 108 | /** |
| 109 | * Prepares callable property freeHookFunction. |
| 110 | * For it to work WC have to be loaded |
| 111 | */ |
| 112 | private function prepareFreeHookCallable() |
| 113 | { |
| 114 | if ($this->freeHookFunction === null) { |
| 115 | $this->originalWCLogger = $logger = wc_get_logger(); |
| 116 | $this->freeHookFunction = function () use ($logger) { |
| 117 | return $logger; |
| 118 | }; |
| 119 | } |
| 120 | } |
| 121 | /** |
| 122 | * Remove WooCommerce logger injection |
| 123 | */ |
| 124 | public function freeWcLogger() |
| 125 | { |
| 126 | if ($this->isCaptured) { |
| 127 | remove_filter(self::WOOCOMMERCE_LOGGER_FILTER, $this->captureHookFunction); |
| 128 | add_filter(self::WOOCOMMERCE_LOGGER_FILTER, $this->freeHookFunction); |
| 129 | $this->isCaptured = \false; |
| 130 | } |
| 131 | } |
| 132 | } |
| 133 |