ParamConverterManager::add() - Code Metrics - Inspection of "Require symfony/config component" - mediamonks/drupal-controller-annotations - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-1.x ( 082f3b...0421f5 )

unknown

created 2017-08-14 09:46 UTC

ParamConverterManager::add() A

↳ Parent: ParamConverterManager

Complexity

Conditions	4
Paths	6

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	4.0312

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	14
ccs	7
cts	8
cp	0.875
rs	9.2
cc	4
eloc	7
nc	6
nop	3
crap	4.0312

<?php

namespace Drupal\controller_annotations\Request\ParamConverter;

use Drupal\controller_annotations\Configuration\ConfigurationInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Managers converters.
 *
 * @author Fabien Potencier <[email protected]>
 * @author Henrik Bjornskov <[email protected]>
 */
class ParamConverterManager
{
    /**
     * @var array
     */
    protected $converters = array();

    /**
     * @var array
     */
    protected $namedConverters = array();

    /**
     * Applies all converters to the passed configurations and stops when a
     * converter is applied it will move on to the next configuration and so on.
     *
     * @param Request      $request
     * @param array|object $configurations
     */
    public function apply(Request $request, $configurations)
    {
        if (is_object($configurations)) {
            $configurations = array($configurations);
        }

        foreach ($configurations as $configuration) {
            $this->applyConverter($request, $configuration);
        }
    }

    /**
     * Apply converter on request based on the given configuration.
     *
     * @param Request                $request
     * @param ConfigurationInterface $configuration
     */
    protected function applyConverter(Request $request, ConfigurationInterface $configuration)
    {
        $value = $request->attributes->get($configuration->getName());
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.
    }
}
        $className = $configuration->getClass();
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.
    }
}

        // If the value is already an instance of the class we are trying to convert it into
        // we should continue as no conversion is required
        if (is_object($value) && $value instanceof $className) {
            return;
        }

        if ($converterName = $configuration->getConverter()) {
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.
    }
}
            if (!isset($this->namedConverters[$converterName])) {
                throw new \RuntimeException(sprintf(
                    "No converter named '%s' found for conversion of parameter '%s'.",
                    $converterName, $configuration->getName()
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.
    }
}
                ));
            }

            $converter = $this->namedConverters[$converterName];

            if (!$converter->supports($configuration)) {
                throw new \RuntimeException(sprintf(
                    "Converter '%s' does not support conversion of parameter '%s'.",
                    $converterName, $configuration->getName()
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.
    }
}
                ));
            }

            $converter->apply($request, $configuration);

            return;
        }

        foreach ($this->all() as $converter) {
            if ($converter->supports($configuration)) {
                if ($converter->apply($request, $configuration)) {
                    return;
                }
            }
        }
    }

    /**
     * Adds a parameter converter.
     *
     * Converters match either explicitly via $name or by iteration over all
     * converters with a $priority. If you pass a $priority = null then the
     * added converter will not be part of the iteration chain and can only
     * be invoked explicitly.
     *
     * @param ParamConverterInterface $converter A ParamConverterInterface instance
     * @param int                     $priority  The priority (between -10 and 10).
     * @param string                  $name      Name of the converter.
     */
    public function add(ParamConverterInterface $converter, $priority = 0, $name = null)
    {
        if ($priority !== null) {
            if (!isset($this->converters[$priority])) {
                $this->converters[$priority] = array();
            }

            $this->converters[$priority][] = $converter;
        }

        if (null !== $name) {
            $this->namedConverters[$name] = $converter;
        }
    }

   /**
    * Returns all registered param converters.
    *
    * @return array An array of param converters
    */
   public function all()
   {
       krsort($this->converters);

       $converters = array();
       foreach ($this->converters as $all) {
           $converters = array_merge($converters, $all);
       }

       return $converters;
   }
}


1		<?php
2
3		namespace Drupal\controller_annotations\Request\ParamConverter;
4
5		use Drupal\controller_annotations\Configuration\ConfigurationInterface;
6		use Symfony\Component\HttpFoundation\Request;
7
8		/**
9		* Managers converters.
10		*
11		* @author Fabien Potencier <[email protected]>
12		* @author Henrik Bjornskov <[email protected]>
13		*/
14		class ParamConverterManager
15		{
16		/**
17		* @var array
18		*/
19		protected $converters = array();
20
21		/**
22		* @var array
23		*/
24		protected $namedConverters = array();
25
26		/**
27		* Applies all converters to the passed configurations and stops when a
28		* converter is applied it will move on to the next configuration and so on.
29		*
30		* @param Request $request
31		* @param array\|object $configurations
32		*/
33	6	public function apply(Request $request, $configurations)
34		{
35	6	if (is_object($configurations)) {
36		$configurations = array($configurations);
37		}
38
39	6	foreach ($configurations as $configuration) {
40		$this->applyConverter($request, $configuration);
41		}
42	6	}
43
44		/**
45		* Apply converter on request based on the given configuration.
46		*
47		* @param Request $request
48		* @param ConfigurationInterface $configuration
49		*/
50		protected function applyConverter(Request $request, ConfigurationInterface $configuration)
51		{
52		$value = $request->attributes->get($configuration->getName());
		0 ignored issues – show Bug introduced 2017-08-14 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Drupal\controller_annota...\ConfigurationInterface` as the method `getName()` does only exist in the following implementations of said interface: `Drupal\controller_annota...guration\ParamConverter`. 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...
53		$className = $configuration->getClass();
		0 ignored issues – show Bug introduced 2017-08-14 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Drupal\controller_annota...\ConfigurationInterface` as the method `getClass()` does only exist in the following implementations of said interface: `Drupal\controller_annota...guration\ParamConverter`. 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...
54
55		// If the value is already an instance of the class we are trying to convert it into
56		// we should continue as no conversion is required
57		if (is_object($value) && $value instanceof $className) {
58		return;
59		}
60
61		if ($converterName = $configuration->getConverter()) {
		0 ignored issues – show Bug introduced 2017-08-14 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Drupal\controller_annota...\ConfigurationInterface` as the method `getConverter()` does only exist in the following implementations of said interface: `Drupal\controller_annota...guration\ParamConverter`. 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...
62		if (!isset($this->namedConverters[$converterName])) {
63		throw new \RuntimeException(sprintf(
64		"No converter named '%s' found for conversion of parameter '%s'.",
65		$converterName, $configuration->getName()
		0 ignored issues – show Bug introduced 2017-08-14 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Drupal\controller_annota...\ConfigurationInterface` as the method `getName()` does only exist in the following implementations of said interface: `Drupal\controller_annota...guration\ParamConverter`. 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...
66		));
67		}
68
69		$converter = $this->namedConverters[$converterName];
70
71		if (!$converter->supports($configuration)) {
72		throw new \RuntimeException(sprintf(
73		"Converter '%s' does not support conversion of parameter '%s'.",
74		$converterName, $configuration->getName()
		0 ignored issues – show Bug introduced 2017-08-14 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Drupal\controller_annota...\ConfigurationInterface` as the method `getName()` does only exist in the following implementations of said interface: `Drupal\controller_annota...guration\ParamConverter`. 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...
75		));
76		}
77
78		$converter->apply($request, $configuration);
79
80		return;
81		}
82
83		foreach ($this->all() as $converter) {
84		if ($converter->supports($configuration)) {
85		if ($converter->apply($request, $configuration)) {
86		return;
87		}
88		}
89		}
90		}
91
92		/**
93		* Adds a parameter converter.
94		*
95		* Converters match either explicitly via $name or by iteration over all
96		* converters with a $priority. If you pass a $priority = null then the
97		* added converter will not be part of the iteration chain and can only
98		* be invoked explicitly.
99		*
100		* @param ParamConverterInterface $converter A ParamConverterInterface instance
101		* @param int $priority The priority (between -10 and 10).
102		* @param string $name Name of the converter.
103		*/
104	6	public function add(ParamConverterInterface $converter, $priority = 0, $name = null)
105		{
106	6	if ($priority !== null) {
107	6	if (!isset($this->converters[$priority])) {
108	6	$this->converters[$priority] = array();
109		}
110
111	6	$this->converters[$priority][] = $converter;
112		}
113
114	6	if (null !== $name) {
115		$this->namedConverters[$name] = $converter;
116		}
117	6	}
118
119		/**
120		* Returns all registered param converters.
121		*
122		* @return array An array of param converters
123		*/
124		public function all()
125		{
126		krsort($this->converters);
127
128		$converters = array();
129		foreach ($this->converters as $all) {
130		$converters = array_merge($converters, $all);
131		}
132
133		return $converters;
134		}
135		}
136

mediamonks / drupal-controller-annotations

Push — 8.x-1.x ( 082f3b...0421f5 )

ParamConverterManager::add() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like