LogServiceProvider::formatLogConfig() - Code Metrics - JimChenWYU/TimSDK - Measure and Improve Code Quality continuously with Scrutinizer

LogServiceProvider::formatLogConfig() A
last analyzed 2018-06-24 10:01 UTC

↳ Parent: LogServiceProvider

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	4
nop	1
dl	0
loc	44
rs	9.216
c	0
b	0
f	0

<?php
/**
 * Created by PhpStorm.
 * User: lenovo
 * Date: 6/15/2018
 * Time: 9:22 AM
 */

namespace TimSDK\Foundation\ServiceProviders;

use Monolog\Handler\NullHandler;
use Pimple\Container;
use TimSDK\Foundation\Log\LogManager;
use TimSDK\Support\Arr;

class LogServiceProvider extends ServiceProvider
{
    /**
     * Registers services on the given container.
     *
     * This method should only be used to configure services and parameters.
     * It should not get services.
     *
     * @param Container $pimple A container instance
     */
    public function register(Container $pimple)
    {
        $pimple['logger'] = $pimple['log'] = function ($app) {
            $config = $this->formatLogConfig($app);

            if (!empty($config)) {
                $app['config']->merge($config);
            }

            $log = new LogManager($app);

            if (defined('PHPUNIT_RUNNING') || 'cli' === php_sapi_name()) {
                if (Arr::get($config, 'cli_on', false)) {
                    $log->setDefaultDriver('errorlog')
                        ->addChannels([
                            'errorlog' => [
                                'driver' => 'errorlog',
                                'level'  => 'info',
                            ],
                        ]);
                } else {
                    $log->driver()->pushHandler(new NullHandler());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                }
            }

            return $log;
        };
    }

    public function formatLogConfig($app)
    {
        if (empty($app['config']->get('log'))) {
            return [
                'log' => [
                    'cli_on'   => false,
                    'default'  => 'errorlog',
                    'channels' => [
                        'errorlog' => [
                            'driver' => 'errorlog',
                            'level'  => 'debug',
                        ],
                    ],
                ],
            ];
        }
        // 4.0 version
        if (empty($app['config']->get('log.driver'))) {
            return [
                'log' => [
                    'cli_on'   => false,
                    'default'  => 'single',
                    'channels' => [
                        'single' => [
                            'driver' => 'single',
                            'path'   => $app['config']->get('log.file') ?: \sys_get_temp_dir() . '/logs/tim-sdk.log',
                            'level'  => $app['config']->get('log.level', 'debug'),
                        ],
                    ],
                ],
            ];
        }
        $name = $app['config']->get('log.driver');

        return [
            'log' => [
                'cli_on'   => false,
                'default'  => $name,
                'channels' => [
                    $name => $app['config']->get('log'),
                ],
            ],
        ];
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: lenovo
5			* Date: 6/15/2018
6			* Time: 9:22 AM
7			*/
8
9			namespace TimSDK\Foundation\ServiceProviders;
10
11			use Monolog\Handler\NullHandler;
12			use Pimple\Container;
13			use TimSDK\Foundation\Log\LogManager;
14			use TimSDK\Support\Arr;
15
16			class LogServiceProvider extends ServiceProvider
17			{
18			/**
19			* Registers services on the given container.
20			*
21			* This method should only be used to configure services and parameters.
22			* It should not get services.
23			*
24			* @param Container $pimple A container instance
25			*/
26			public function register(Container $pimple)
27			{
28			$pimple['logger'] = $pimple['log'] = function ($app) {
29			$config = $this->formatLogConfig($app);
30
31			if (!empty($config)) {
32			$app['config']->merge($config);
33			}
34
35			$log = new LogManager($app);
36
37			if (defined('PHPUNIT_RUNNING') \|\| 'cli' === php_sapi_name()) {
38			if (Arr::get($config, 'cli_on', false)) {
39			$log->setDefaultDriver('errorlog')
40			->addChannels([
41			'errorlog' => [
42			'driver' => 'errorlog',
43			'level' => 'info',
44			],
45			]);
46			} else {
47			$log->driver()->pushHandler(new NullHandler());
			0 ignored issues – show Bug introduced 2018-06-24 07:56 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Log\LoggerInterface` as the method `pushHandler()` does only exist in the following implementations of said interface: `Monolog\Logger`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
48			}
49			}
50
51			return $log;
52			};
53			}
54
55			public function formatLogConfig($app)
56			{
57			if (empty($app['config']->get('log'))) {
58			return [
59			'log' => [
60			'cli_on' => false,
61			'default' => 'errorlog',
62			'channels' => [
63			'errorlog' => [
64			'driver' => 'errorlog',
65			'level' => 'debug',
66			],
67			],
68			],
69			];
70			}
71			// 4.0 version
72			if (empty($app['config']->get('log.driver'))) {
73			return [
74			'log' => [
75			'cli_on' => false,
76			'default' => 'single',
77			'channels' => [
78			'single' => [
79			'driver' => 'single',
80			'path' => $app['config']->get('log.file') ?: \sys_get_temp_dir() . '/logs/tim-sdk.log',
81			'level' => $app['config']->get('log.level', 'debug'),
82			],
83			],
84			],
85			];
86			}
87			$name = $app['config']->get('log.driver');
88
89			return [
90			'log' => [
91			'cli_on' => false,
92			'default' => $name,
93			'channels' => [
94			$name => $app['config']->get('log'),
95			],
96			],
97			];
98			}
99			}
100

JimChenWYU / TimSDK

LogServiceProvider::formatLogConfig() A last analyzed 2018-06-24 10:01 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

LogServiceProvider::formatLogConfig() A
last analyzed 2018-06-24 10:01 UTC