src/Core/Logger/Factory/ProfilerLogger.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Logger\Factory;
  23
  24 use Friendica\Core\Config\Capability\IManageConfigValues;
  25 use Friendica\Core\Logger\Type\ProfilerLogger as ProfilerLoggerClass;
  26 use Friendica\Util\Profiler;
  27 use Psr\Log\LoggerInterface;
  28
  29 /**
  30  * The logger factory for the ProfilerLogger
  31  *
  32  * @see ProfilerLoggerClass
  33  */
  34 class ProfilerLogger extends AbstractLoggerTypeFactory
  35 {
  36         /**
  37          * Wraps a given Logger with profiling information in case profiling is enabled
  38          *
  39          * @param IManageConfigValues $config   The system configuration
  40          * @param LoggerInterface     $logger   The given logger class, which should get wrapped
  41          * @param Profiler            $profiler The profiler utility
  42          *
  43          * @return LoggerInterface The PSR-3 compliant logger instance
  44          */
  45         public function create(IManageConfigValues $config, LoggerInterface $logger, Profiler $profiler): LoggerInterface
  46         {
  47                 if ($config->get('system', 'profiling') ?? false) {
  48                         return $logger;
  49                 } else {
  50                         return new ProfilerLoggerClass($logger, $profiler);
  51                 }
  52         }
  53 }