Completed
Push — master ( 77abb4...5b1cd3 )
by Chris
02:37
created

ConfigurationService   A

Complexity

Total Complexity 5

Size/Duplication

Total Lines 31
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 5
c 1
b 0
f 0
lcom 0
cbo 2
dl 0
loc 31
rs 10

1 Method

Rating   Name   Duplication   Size   Complexity  
B register() 0 23 5
1
<?php
2
namespace Darya\Foundation\Providers;
3
4
use Darya\Foundation\Configuration\Php as Configuration;
5
use Darya\Service\Contracts\Container;
6
use Darya\Service\Contracts\Provider;
7
8
/**
9
 * A service provider that provides HTTP request and response objects.
10
 * 
11
 * Also provides the default PHP session.
12
 * 
13
 * @author Chris Andrew <[email protected]>
14
 */
15
class ConfigurationService implements Provider
16
{
17
	/**
18
	 * Register a global HTTP request, response and session with the container.
19
	 * 
20
	 * @param Container $application
21
	 */
22
	public function register(Container $application)
23
	{
24
		$basePath = $application->get('path');
25
		
26
		$configuration = new Configuration(array(
27
			"$basePath/config/config.default.php",
28
			"$basePath/config/config.php"
29
		));
30
		
31
		$application->set('Darya\Foundation\Configuration', $configuration);
32
		
33
		// Register the configured aliases
34
		foreach ($configuration['aliases'] as $alias => $service) {
35
			$application->alias($alias, $service);
36
		}
37
		
38
		// Register the configured service providers
39
		foreach ($configuration['services'] as $service) {
40
			if (class_exists($service) && is_subclass_of($service, 'Darya\Service\Contracts\Provider')) {
41
				$application->provide($application->create($service));
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Darya\Service\Contracts\Container as the method provide() does only exist in the following implementations of said interface: Darya\Foundation\Application, Darya\Service\Application.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
42
			}
43
		}
44
	}
45
}
46