BFW\Monolog

Complexity

Total Complexity

18

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	checkHandlerInfos()	0	4	1
A	checkHandlerName()	0	20	4
A	getConfig()	0	3	1
A	addNewHandler()	0	9	1
A	getLogger()	0	3	1
A	getHandlers()	0	3	1
A	getChannelName()	0	3	1
A	__construct()	0	5	1
A	addAllHandlers()	0	19	4
A	checkHandlerArgs()	0	8	3

<?php

namespace BFW;

use \Exception;

/**
 * Class to read monolog config file and instanciate monolog from config
 */
class Monolog
{
    /**
     * @const ERR_HANDLERS_LIST_FORMAT Exception code if config for handlers
     * list have not a correct format
     */
    const ERR_HANDLERS_LIST_FORMAT = 1105001;
    
    /**
     * @const ERR_HANDLER_INFOS_MISSING_NAME Exception code if a handler not
     * have declared name
     */
    const ERR_HANDLER_INFOS_MISSING_NAME = 1105002;
    
    /**
     * @const ERR_HANDLER_NAME_NOT_A_STRING Exception code if a handler name
     * value is not a string
     */
    const ERR_HANDLER_NAME_NOT_A_STRING = 1105003;
    
    /**
     * @const ERR_HANDLER_CLASS_NOT_FOUND Exception code if a handler class
     * has not been found
     */
    const ERR_HANDLER_CLASS_NOT_FOUND = 1105004;
    
    /**
     * @var string $channelName The monolog channel name
     */
    protected $channelName = '';
    
    /**
     * @var \BFW\Config $config The config object containing the handlers list
     */
    protected $config;
    
    /**
     * @var \Monolog\Logger $logger The monolog logger object
     */
    protected $logger;
    
    /**
     * @var array $handlers List of all declared handler
     */
    protected $handlers = [];
    
    /**
     * Populate properties
     * Initialize monolog logger object
     * 
     * @param string $channelName The monolog channel name
     * @param \BFW\Config $config The config object containing handlers list
     */
    public function __construct(string $channelName, \BFW\Config $config)
    {
        $this->channelName = $channelName;
        $this->config      = $config;
        $this->logger      = new \Monolog\Logger($this->channelName);
    }
    
    /**
     * Get accessor to property channelName
     * 
     * @return string
     */
    public function getChannelName(): string
    {
        return $this->channelName;
    }
    
    /**
     * Get accessor to property config
     * 
     * @return \BFW\Config
     */
    public function getConfig(): \BFW\Config
    {
        return $this->config;
    }
    
    /**
     * Get accessor to property logger
     * 
     * @return \Monolog\Logger
     */
    public function getLogger(): \Monolog\Logger
    {
        return $this->logger;
    }
    
    /**
     * Get accessor to property handlers
     * 
     * @return array
     */
    public function getHandlers(): array
    {
        return $this->handlers;
    }
    
    /**
     * Adding all handlers to monolog logger
     * 
     * @param string $configKeyName The key name containing handlers list
     * @param string $configFileName The config file name containing handlers
     * list
     * 
     * @throws \Exception
     * 
     * @return void
     */
    public function addAllHandlers(
        string $configKeyName = 'handlers',
        string $configFileName = 'monolog.php'
    ) {
        $handlers = $this->config->getValue($configKeyName, $configFileName);
        
        if (!is_array($handlers)) {
            throw new Exception(
                'Handlers list into monolog config file should be an array.',
                self::ERR_HANDLERS_LIST_FORMAT
            );
        }
        
        if (array_key_exists('name', $handlers)) {
            $handlers = [$handlers];
        }
        
        foreach ($handlers as $handlerInfos) {
            $this->addNewHandler($handlerInfos);
        }
    }
    
    /**
     * Check and add a new handler to the logger
     * 
     * @param array $handlerInfos Handler infos (name and args)
     * 
     * @throws \Exception
     * 
     * @return void
     */
    public function addNewHandler(array $handlerInfos)
    {
        $this->checkHandlerInfos($handlerInfos);
        
        $handlerClassName = $handlerInfos['name'];
        $handler          = new $handlerClassName(...$handlerInfos['args']);
        
        $this->handlers[] = $handler;
        $this->logger->pushHandler($handler);
    }
    
    /**
     * Check the handler infos
     * 
     * @param array $handlerInfos Handler infos (name and args)
     * 
     * @throws \Exception
     * 
     * @return void
     */
    protected function checkHandlerInfos(array $handlerInfos)
    {
        $this->checkHandlerName($handlerInfos);
        $this->checkHandlerArgs($handlerInfos);
    }
    
    /**
     * Check the handler name
     * 
     * @param array $handlerInfos Handler infos (name and args)
     * 
     * @throws \Exception
     * 
     * @return void
     */
    protected function checkHandlerName(array $handlerInfos)
    {
        if (!array_key_exists('name', $handlerInfos)) {
            throw new Exception(
                'The handler infos should have the property name',
                self::ERR_HANDLER_INFOS_MISSING_NAME
            );
        }
        
        if (!is_string($handlerInfos['name'])) {
            throw new Exception(
                'The handler name should be a string.',
                self::ERR_HANDLER_NAME_NOT_A_STRING
            );
        }
        
        if (!class_exists($handlerInfos['name'])) {
            throw new Exception(
                'The class '.$handlerInfos['name'].' has not been found.',
                self::ERR_HANDLER_CLASS_NOT_FOUND
            );
        }
    }
    
    /**
     * Check the handler arguments list
     * 
     * @param array $handlerInfos Handler infos (name and args)
     * 
     * @return void
     */
    protected function checkHandlerArgs(array &$handlerInfos)
    {
        if (!array_key_exists('args', $handlerInfos)) {
            $handlerInfos['args'] = [];
        }
        
        if (!is_array($handlerInfos['args'])) {
            $handlerInfos['args'] = [$handlerInfos['args']];
        }
    }
}