Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Logger;
Chris@0: 
Chris@0: /**
Chris@0:  * Wrapper methods for the logger factory service.
Chris@0:  *
Chris@0:  * This utility trait should only be used in application-level code, such as
Chris@0:  * classes that would implement ContainerInjectionInterface. Services registered
Chris@0:  * in the Container should not use this trait but inject the appropriate service
Chris@0:  * directly for easier testing.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\DependencyInjection\ContainerInjectionInterface
Chris@0:  */
Chris@0: trait LoggerChannelTrait {
Chris@0: 
Chris@0:   /**
Chris@0:    * The logger channel factory service.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
Chris@0:    */
Chris@0:   protected $loggerFactory;
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the logger for a specific channel.
Chris@0:    *
Chris@0:    * @param string $channel
Chris@0:    *   The name of the channel. Can be any string, but the general practice is
Chris@0:    *   to use the name of the subsystem calling this.
Chris@0:    *
Chris@0:    * @return \Psr\Log\LoggerInterface
Chris@0:    *   The logger for the given channel.
Chris@0:    *
Chris@0:    * @todo Require the use of injected services:
Chris@0:    *   https://www.drupal.org/node/2733703
Chris@0:    */
Chris@0:   protected function getLogger($channel) {
Chris@0:     if (!$this->loggerFactory) {
Chris@0:       $this->loggerFactory = \Drupal::service('logger.factory');
Chris@0:     }
Chris@0:     return $this->loggerFactory->get($channel);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Injects the logger channel factory.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
Chris@0:    *   The logger channel factory service.
Chris@0:    *
Chris@0:    * @return $this
Chris@0:    */
Chris@0:   public function setLoggerFactory(LoggerChannelFactoryInterface $logger_factory) {
Chris@0:     $this->loggerFactory = $logger_factory;
Chris@0: 
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0: }