HandlerProvider::getHandler()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 4
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
eloc 3
c 1
b 0
f 0
nc 2
nop 2
dl 0
loc 7
ccs 4
cts 4
cp 1
crap 2
rs 10
1
<?php
2
3
/*
4
 *  This file is part of the Micro framework package.
5
 *
6
 *  (c) Stanislau Komar <[email protected]>
7
 *
8
 *  For the full copyright and license information, please view the LICENSE
9
 *  file that was distributed with this source code.
10
 */
11
12
namespace Micro\Plugin\Logger\Monolog\Business\Handler;
13
14
use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;
15
use Monolog\Handler\HandlerInterface;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Micro\Plugin\Logger\Mono...andler\HandlerInterface. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
16
17
class HandlerProvider implements HandlerProviderInterface
18
{
19
    /**
20
     * @var array<string, HandlerInterface>
21
     */
22
    private array $handlerCollection;
23
24 1
    public function __construct(private HandlerFactoryInterface $handlerFactory)
25
    {
26 1
        $this->handlerCollection = [];
27
    }
28
29 1
    public function getHandler(LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration, string $handlerName): HandlerInterface
30
    {
31 1
        if (!\array_key_exists($handlerName, $this->handlerCollection)) {
32 1
            $this->handlerCollection[$handlerName] = $this->handlerFactory->create($loggerProviderTypeConfiguration, $handlerName);
33
        }
34
35 1
        return $this->handlerCollection[$handlerName];
36
    }
37
}
38