everon/logger-basic

Set of logger plugins that require no extra vendor dependencies for EveronLogger

3.0.0 2023-08-03 22:54 UTC

Requires

• php: ^8.1
• everon/logger: ^3

Requires (Dev)

• ext-json: *
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10
• popo/generator: ^6
• symfony/var-dumper: ^5|^6

MIT

README

Set of plugins that require no extra vendor dependencies for EveronLogger.

• ErrorLog
• Nullee
• Stream
• Syslog

Plugins

ErrorLog

Sends messages to PHP error_log() handler.

• Configurator

  Everon\Shared\LoggerBasic\Configurator\Plugin\ErrorLogLoggerPluginConfigurator

• Default Options

  'pluginClass' => \Everon\LoggerBasic\Plugin\ErrorLog\ErrorLogLoggerPlugin::class,
  'pluginFactoryClass' => NULL,
  'logLevel' => Level::Debug,
  'shouldBubble' => true,
  'messageType' => \Monolog\Handler\ErrorLogHandler::OPERATING_SYSTEM,
  'expandNewlines' => false,

• Plugin

  Everon\LoggerBasic\Plugin\ErrorLog\ErrorLogLoggerPlugin

• Usage

  use Everon\Shared\Logger\Configurator\Plugin\LoggerConfigurator;
  use Everon\Shared\LoggerBasic\Configurator\Plugin\ErrorLogLoggerPluginConfigurator;
  use Everon\Logger\EveronLoggerFacade;
  
  $errorLogPluginConfigurator = (new ErrorLogLoggerPluginConfigurator)
      ->setLogLevel(Level::Info)
      ->setMessageType(\Monolog\Handler\ErrorLogHandler::OPERATING_SYSTEM)
      ->setExpandNewlines(false);
  
  $configurator = (new LoggerConfigurator)
      ->add($errorLogPluginConfigurator);
  
  $logger = (new EveronLoggerFacade())->buildLogger($configurator);
  
  $logger->info('lorem ipsum');

Nullee

Pretend to send messages

• Configurator

  Everon\Shared\LoggerBasic\Configurator\Plugin\NulleeLoggerPluginConfigurator

• Default Options

  'pluginClass' => \Everon\LoggerBasic\Plugin\Nullee\NulleeLoggerPlugin::class,
  'pluginFactoryClass' => NULL,
  'logLevel' => Level::Debug,
  'shouldBubble' => true,

• Plugin

  Everon\LoggerBasic\Plugin\Nullee\NulleeLoggerPlugin

• Usage

  use Everon\Shared\Logger\Configurator\Plugin\LoggerConfigurator;
  use Everon\Shared\LoggerBasic\Configurator\Plugin\NulleeLoggerPluginConfigurator;
  use Everon\Logger\EveronLoggerFacade;
  
  $nulleePluginConfigurator = (new NulleeLoggerPluginConfigurator)
      ->setLogLevel(Level::Info);
  
  $configurator = (new LoggerConfigurator)
      ->add($nulleePluginConfigurator);
  
  $logger = (new EveronLoggerFacade())->buildLogger($configurator);
  
  $logger->info('lorem ipsum');

Stream

Sends messages to any PHP stream handler.

• Configurator

  Everon\Shared\LoggerBasic\Configurator\Plugin\StreamLoggerPluginConfigurator

• Default Options

  'pluginClass' => \Everon\LoggerBasic\Plugin\Stream\StreamLoggerPlugin::class,
  'pluginFactoryClass' => NULL,
  'logLevel' => Level::Debug,
  'shouldBubble' => true,
  'streamLocation' => NULL,
  'filePermission' => NULL,
  'useLocking' => false,

• Plugin

  Everon\LoggerBasic\Plugin\Stream\StreamLoggerPlugin

• Usage

  use Everon\Shared\Logger\Configurator\Plugin\LoggerConfigurator;
  use Everon\Shared\LoggerBasic\Configurator\Plugin\StreamLoggerPluginConfigurator; 
  use Everon\Logger\EveronLoggerFacade;
  
  $streamPluginConfigurator = (new StreamLoggerPluginConfigurator)
      ->setLogLevel(Level::Info)
      ->setStreamLocation('/tmp/debug.log');
  
  $configurator = (new LoggerConfigurator)
      ->add($streamPluginConfigurator);
  
  $logger = (new EveronLoggerFacade())->buildLogger($configurator);
  
  $logger->info('lorem ipsum');

Syslog

Sends messages to syslog service.

• Configurator

  Everon\Shared\LoggerBasic\Configurator\Plugin\SyslogLoggerPluginConfigurator

• Default Options

  'pluginClass' => \Everon\LoggerBasic\Plugin\Syslog\SyslogLoggerPlugin::class,
  'pluginFactoryClass' => NULL,
  'logLevel' => Level::Debug,
  'shouldBubble' => true,
  'ident' => NULL,
  'facility' => \LOG_LOCAL0,
  'logopts' => \LOG_PID,

• Plugin

  Everon\LoggerBasic\Plugin\Syslog\SyslogLoggerPlugin

• Usage

  use Everon\Shared\Logger\Configurator\Plugin\LoggerConfigurator; 
  use Everon\Shared\LoggerBasic\Configurator\Plugin\SyslogLoggerPluginConfigurator;
  use Everon\Logger\EveronLoggerFacade;
  
  $syslogPluginConfigurator = (new SyslogLoggerPluginConfigurator)
      ->setLogLevel(Level::Info)
      ->setIdent('foo-bar-ident');
  
  $configurator = (new LoggerConfigurator)
      ->add($syslogPluginConfigurator);
  
  $logger = (new EveronLoggerFacade())->buildLogger($configurator);
  
  $logger->info('lorem ipsum');

Requirements

• PHP v8.1.x
• Monolog v3.x

Installation

composer require everon/logger-basic