tao-test/app/generis/common/oatbox/log/LoggerService.php

128 lines
3.5 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2017 (original work) Open Assessment Technologies SA
*
*/
namespace oat\oatbox\log;
use oat\oatbox\service\ConfigurableService;
use Psr\Log\LoggerInterface;
use Psr\Log\LoggerTrait;
use Psr\Log\NullLogger;
class LoggerService extends ConfigurableService implements LoggerInterface
{
use LoggerTrait;
const SERVICE_ID = 'generis/log';
const LOGGER_OPTION = 'logger';
/** @var LoggerInterface */
protected $logger;
/**
* Add a Psr3 logger to LoggerService instance
* Previous and new logger are encapsulated into a LoggerAggregator
*
* @param LoggerInterface $logger
* @return LoggerAggregator|LoggerInterface
*/
public function addLogger(LoggerInterface $logger)
{
if ($this->isLoggerLoaded() && !($this->logger instanceof NullLogger)) {
$logger = new LoggerAggregator([$logger, $this->logger]);
}
$this->logger = $logger;
return $logger;
}
/**
* Get the logger
*
* @return LoggerInterface
*/
public function getLogger()
{
if (!$this->isLoggerLoaded()) {
$this->loadLogger();
}
return $this->logger;
}
/**
* Wrap a log to built logger
*
* @param mixed $level
* @param string $message
* @param array $context
*/
public function log($level, $message, array $context = [])
{
$this->getLogger()->log($level, $message, $context);
}
/**
* Load the logger from configuration
*
* If options does not contain any Psr3 Logger, NullLogger is set by default
*
* @return LoggerInterface
*/
protected function loadLogger()
{
$logger = null;
if ($this->hasOption(self::LOGGER_OPTION)) {
$loggerOptions = $this->getOption(self::LOGGER_OPTION);
if (is_object($loggerOptions)) {
if (is_a($loggerOptions, LoggerInterface::class)) {
$logger = $loggerOptions;
}
} elseif (is_array($loggerOptions) && isset($loggerOptions['class'])) {
$classname = $loggerOptions['class'];
if (is_a($classname, LoggerInterface::class, true)) {
if (isset($loggerOptions['options'])) {
$logger = new $classname($loggerOptions['options']);
} else {
$logger = new $classname();
}
}
}
}
if (!is_null($logger)) {
$this->logger = $logger;
} else {
$this->logger = new NullLogger();
}
return $this->logger;
}
/**
* Check if the logger is loaded from configuration
*
* @return bool
*/
protected function isLoggerLoaded()
{
return $this->logger instanceof LoggerInterface;
}
}