123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Payment\Model\Method;
- use Magento\Payment\Gateway\ConfigInterface;
- use Psr\Log\LoggerInterface;
- /**
- * Class Logger for payment related information (request, response, etc.) which is used for debug.
- *
- * @api
- * @since 100.0.2
- */
- class Logger
- {
- const DEBUG_KEYS_MASK = '****';
- /**
- * @var LoggerInterface
- */
- protected $logger;
- /**
- * @var ConfigInterface
- */
- private $config;
- /**
- * @param LoggerInterface $logger
- * @param ConfigInterface|null $config
- */
- public function __construct(
- LoggerInterface $logger,
- ConfigInterface $config = null
- ) {
- $this->logger = $logger;
- $this->config = $config;
- }
- /**
- * Logs payment related information used for debug
- *
- * @param array $data
- * @param array|null $maskKeys
- * @param bool|null $forceDebug
- * @return void
- */
- public function debug(array $data, array $maskKeys = null, $forceDebug = null)
- {
- $maskKeys = $maskKeys !== null ? $maskKeys : $this->getDebugReplaceFields();
- $debugOn = $forceDebug !== null ? $forceDebug : $this->isDebugOn();
- if ($debugOn === true) {
- $data = $this->filterDebugData(
- $data,
- $maskKeys
- );
- $this->logger->debug(var_export($data, true));
- }
- }
- /**
- * Returns configured keys to be replaced with mask
- *
- * @return array
- */
- private function getDebugReplaceFields()
- {
- if ($this->config && $this->config->getValue('debugReplaceKeys')) {
- return explode(',', $this->config->getValue('debugReplaceKeys'));
- }
- return [];
- }
- /**
- * Whether debug is enabled in configuration
- *
- * @return bool
- */
- private function isDebugOn()
- {
- return $this->config && (bool)$this->config->getValue('debug');
- }
- /**
- * Recursive filter data by private conventions
- *
- * @param array $debugData
- * @param array $debugReplacePrivateDataKeys
- * @return array
- */
- protected function filterDebugData(array $debugData, array $debugReplacePrivateDataKeys)
- {
- $debugReplacePrivateDataKeys = array_map('strtolower', $debugReplacePrivateDataKeys);
- foreach (array_keys($debugData) as $key) {
- if (in_array(strtolower($key), $debugReplacePrivateDataKeys)) {
- $debugData[$key] = self::DEBUG_KEYS_MASK;
- } elseif (is_array($debugData[$key])) {
- $debugData[$key] = $this->filterDebugData($debugData[$key], $debugReplacePrivateDataKeys);
- }
- }
- return $debugData;
- }
- }
|