ValidationServiceProvider::register() - Code Metrics - Inspection of "add environment variable for test env" - kot13/bootstrapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4f3de5...9b9e7a )

by Pavel

created 2017-02-18 09:27 UTC

ValidationServiceProvider::register() A

↳ Parent: ValidationServiceProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	11
nc	1
nop	1
dl	0
loc	21
rs	9.3142
c	0
b	0
f	0

<?php

namespace App\Providers;

use Illuminate\Translation\FileLoader;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Translation\Translator;
use Illuminate\Validation\DatabasePresenceVerifier;
use Illuminate\Validation\Factory;
use Pimple\Container;

final class ValidationServiceProvider extends BaseServiceProvider
{
    /**
     * Register validation service provider.
     *
     * @param Container $container
     */
    public function register(Container $container)
    {
        $config = $container['settings'];

        // translation
        $container['translator'] = function (Container $c) use ($config) {

            $translation_file_loader = new FileLoader(new Filesystem, $config['translate']['path']);

            $translator              = new Translator($translation_file_loader, $config['translate']['locale']);

            return $translator;
        };

        // validation
        $container['validation'] = function (Container $c) use ($config) {
            $validation = new Factory($c->get('translator'));
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $presence   = new DatabasePresenceVerifier($c->get('databaseManager'));
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $validation->setPresenceVerifier($presence);

            return $validation;
        };
    }
}


Push — master ( 4f3de5...9b9e7a )

ValidationServiceProvider::register() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace App\Providers;
4
5			use Illuminate\Translation\FileLoader;
6			use Illuminate\Filesystem\Filesystem;
7			use Illuminate\Translation\Translator;
8			use Illuminate\Validation\DatabasePresenceVerifier;
9			use Illuminate\Validation\Factory;
10			use Pimple\Container;
11
12			final class ValidationServiceProvider extends BaseServiceProvider
13			{
14			/**
15			* Register validation service provider.
16			*
17			* @param Container $container
18			*/
19			public function register(Container $container)
20			{
21			$config = $container['settings'];
22
23			// translation
24			$container['translator'] = function (Container $c) use ($config) {
			0 ignored issues – show Unused Code introduced 2017-02-18 09:33 UTC by Report Bug Copy Issue Report The parameter `$c` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Comprehensibility introduced 2017-02-18 09:33 UTC by Report Bug Copy Issue Report Avoid variables with short names like $c. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
25			$translation_file_loader = new FileLoader(new Filesystem, $config['translate']['path']);
			0 ignored issues – show Comprehensibility Naming introduced 2017-02-18 09:33 UTC by Report Bug Copy Issue Report The variable name `$translation_file_loader` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
26			$translator = new Translator($translation_file_loader, $config['translate']['locale']);
27
28			return $translator;
29			};
30
31			// validation
32			$container['validation'] = function (Container $c) use ($config) {
33			$validation = new Factory($c->get('translator'));
			0 ignored issues – show Bug introduced 2017-02-18 09:33 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Pimple\Container` as the method `get()` does only exist in the following sub-classes of `Pimple\Container`: `Slim\Container`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
34			$presence = new DatabasePresenceVerifier($c->get('databaseManager'));
			0 ignored issues – show Bug introduced 2017-02-18 09:33 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Pimple\Container` as the method `get()` does only exist in the following sub-classes of `Pimple\Container`: `Slim\Container`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
35			$validation->setPresenceVerifier($presence);
36
37			return $validation;
38			};
39			}
40			}
41

kot13 / bootstrapi

Push — master ( 4f3de5...9b9e7a )

ValidationServiceProvider::register() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like