LoggerChannelFactory.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Logger/LoggerChannelFactory.php
  2. 8.9.x core/lib/Drupal/Core/Logger/LoggerChannelFactory.php
  3. 10 core/lib/Drupal/Core/Logger/LoggerChannelFactory.php

Namespace

Drupal\Core\Logger

File

core/lib/Drupal/Core/Logger/LoggerChannelFactory.php

View source
<?php

namespace Drupal\Core\Logger;

use Drupal\Core\Session\AccountInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * Defines a factory for logging channels.
 */
class LoggerChannelFactory implements LoggerChannelFactoryInterface {
    
    /**
     * Array of all instantiated logger channels keyed by channel name.
     *
     * @var \Drupal\Core\Logger\LoggerChannelInterface[]
     */
    protected $channels = [];
    
    /**
     * An array of arrays of \Psr\Log\LoggerInterface keyed by priority.
     *
     * @var array
     */
    protected $loggers = [];
    
    /**
     * Constructs a LoggerChannelFactory.
     *
     * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
     *   (optional) The request stack.
     * @param \Drupal\Core\Session\AccountInterface $currentUser
     *   (optional) The current user.
     */
    public function __construct(RequestStack $requestStack, AccountInterface $currentUser) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function get($channel) {
        if (!isset($this->channels[$channel])) {
            $instance = new LoggerChannel($channel);
            // Set the request_stack and current_user services on the channel.
            // It is up to the channel to determine if there is a current request.
            $instance->setRequestStack($this->requestStack);
            $instance->setCurrentUser($this->currentUser);
            // Pass the loggers to the channel.
            $instance->setLoggers($this->loggers);
            $this->channels[$channel] = $instance;
        }
        return $this->channels[$channel];
    }
    
    /**
     * {@inheritdoc}
     */
    public function addLogger(LoggerInterface $logger, $priority = 0) {
        // Store it so we can pass it to potential new logger instances.
        $this->loggers[$priority][] = $logger;
        // Add the logger to already instantiated channels.
        foreach ($this->channels as $channel) {
            $channel->addLogger($logger, $priority);
        }
    }

}

Classes

Title Deprecated Summary
LoggerChannelFactory Defines a factory for logging channels.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.