lxbfYeaa/PayPal-PHP-SDK
Archived
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-SDK
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enabled Factory to Inject Logger

Browse Source
This commit is contained in:
Jay Patel
2016-04-11 15:45:49 -05:00
parent 557fb3718f
commit c0c307f267
8 changed files with 143 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
lib/PayPal/Core/PayPalLoggingLevel.php
View File

@@ -1,26 +0,0 @@
<?php
namespace PayPal\Core;
/**
* Logging Levels.
* Class containing all the constants for Logging Levels.
*/
class PayPalLoggingLevel
{
// DEBUG Logging Level
const DEBUG = 4;
// FINE Logging Level
const FINE = 3;
// INFO Logging Level
const INFO = 2;
// WARN Logging Level
const WARN = 1;
// ERROR Logging Level
const ERROR = 0;
}

106
lib/PayPal/Core/PayPalLoggingManager.php
View File

@@ -1,7 +1,8 @@
<?php
namespace PayPal\Core;
use PayPal\Log\PayPalLogger;
use PayPal\Log\PayPalLogFactory;
use Psr\Log\LoggerInterface;
/**
@@ -11,32 +12,10 @@ use Psr\Log\LoggerInterface;
*/
class PayPalLoggingManager
{
/**
* Default Logging Level
* @var array of logging manager instances with class name as key
*/
const DEFAULT_LOGGING_LEVEL = 0;
/**
* Logger Name
* @var string
*/
private $loggerName;
/**
* Log Enabled
*
* @var bool
*/
private $isLoggingEnabled;
/**
* Configured Logging Level
*
* @var int|mixed
*/
private $loggingLevel;
private static $instances = array();
/**
* The logger to be used for all messages
@@ -45,6 +24,13 @@ class PayPalLoggingManager
*/
private $logger;
/**
* Logger Name
*
* @var string
*/
private $loggerName;
/**
* Returns the singleton object
*
@@ -53,45 +39,32 @@ class PayPalLoggingManager
*/
public static function getInstance($loggerName = __CLASS__)
{
$instance = new self();
$instance->setLoggerName($loggerName);
if (array_key_exists($loggerName, PayPalLoggingManager::$instances)) {
return PayPalLoggingManager::$instances[$loggerName];
}
$instance = new self($loggerName);
PayPalLoggingManager::$instances[$loggerName] = $instance;
return $instance;
}
/**
* Sets Logger Name. Generally defaulted to Logging Class
*
* @param string $loggerName
*/
public function setLoggerName($loggerName = __CLASS__)
{
$this->loggerName = $loggerName;
}
/**
* Default Constructor
*
* @param string $loggerName Generally represents the class name.
*/
public function __construct()
private function __construct($loggerName)
{
$config = PayPalConfigManager::getInstance()->getConfigHashmap();
$this->isLoggingEnabled = (array_key_exists('log.LogEnabled', $config) && $config['log.LogEnabled'] == '1');
if ($this->isLoggingEnabled) {
$loggingLevel = strtoupper($config['log.LogLevel']);
$this->setupLogger($config);
$this->loggingLevel =
(isset($loggingLevel) && defined(__NAMESPACE__ . "\\PayPalLoggingLevel::$loggingLevel")) ?
constant(__NAMESPACE__ . "\\PayPalLoggingLevel::$loggingLevel") :
PayPalLoggingManager::DEFAULT_LOGGING_LEVEL;
if (!empty($config)) {
// Checks if custom factory defined, and is it an implementation of @PayPalLogFactory
$factory = array_key_exists('log.AdapterFactory', $config) && in_array('PayPal\Log\PayPalLogFactory', class_implements($config['log.AdapterFactory'])) ? $config['log.AdapterFactory'] : '\PayPal\Log\PayPalDefaultLogFactory';
/** @var PayPalLogFactory $factoryInstance */
$factoryInstance = new $factory();
$this->logger = $factoryInstance->getLogger($loggerName);
$this->loggerName = $loggerName;
}
}
private function setupLogger($config = array()) {
// Checks if custom adapter defined, and is it an implementation of @LoggerInterface
$loggingAdapter = array_key_exists('log.Adapter', $config) && in_array('\Psr\Log\LoggerInterface', class_implements($config['log.Adapter']))? $config['log.Adapter'] : '\PayPal\Log\PayPalLogger';
$this->logger = new $loggingAdapter();
}
/**
* Log Error
*
@@ -99,9 +72,7 @@ class PayPalLoggingManager
*/
public function error($message)
{
if ($this->isLoggingEnabled && $this->loggingLevel >= PayPalLoggingLevel::ERROR) {
$this->logger->error($message);
}
$this->logger->error($message);
}
/**
@@ -111,10 +82,7 @@ class PayPalLoggingManager
*/
public function warning($message)
{
if ($this->isLoggingEnabled && $this->loggingLevel >= PayPalLoggingLevel::WARN) {
$this->logger->warning($message);
}
$this->logger->warning($message);
}
/**
@@ -124,9 +92,7 @@ class PayPalLoggingManager
*/
public function info($message)
{
if ($this->isLoggingEnabled && $this->loggingLevel >= PayPalLoggingLevel::INFO) {
$this->logger->info($message);
}
$this->logger->info($message);
}
/**
@@ -140,20 +106,16 @@ class PayPalLoggingManager
}
/**
* Log Fine
* Log Debug
*
* @param string $message
*/
public function debug($message)
{
if ($this->isLoggingEnabled) {
$config = PayPalConfigManager::getInstance()->getConfigHashmap();
// Check if logging in live
if (array_key_exists('mode', $config) && $config['mode'] == 'live' && $this->loggingLevel >= PayPalLoggingLevel::DEBUG) {
$this->logger->error("Not allowed to keep 'Debug' level for Live Environments. Reduced to 'INFO'");
} elseif (PayPalLoggingLevel::DEBUG <= $this->loggingLevel) {
$this->logger->debug($message);
}
$config = PayPalConfigManager::getInstance()->getConfigHashmap();
// Disable debug in live mode.
if (array_key_exists('mode', $config) && $config['mode'] != 'live') {
$this->logger->debug($message);
}
}