MethodFinder::getApi() - Code Metrics - devhelp/piwik-bundle - Measure and Improve Code Quality continuously with Scrutinizer

MethodFinder::getApi() A
last analyzed 2018-02-25 19:15 UTC

↳ Parent: MethodFinder

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1

<?php

namespace Devhelp\PiwikBundle\Command\Param;

use Devhelp\Piwik\Api\Api;
use Devhelp\Piwik\Api\Method\Method;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Finds an api method in a container that is either registered as a service or is available through
 * the given api service by calling getMethod
 */
class MethodFinder
{
    /**
     * @var ContainerInterface
     */
    private $container;

    /**
     * @var LoggerInterface
     */
    private $logger;

    public function __construct(ContainerInterface $container, LoggerInterface $logger = null)
    {
        $this->container = $container;
        $this->logger = $logger ? $logger : new NullLogger();
    }

    /**
     * @param string $methodArg
     * @param string|null $apiName
     * @return Method
     */
    public function find($methodArg, $apiName = null)
    {
        if ($this->container->has($methodArg)) {
            $method = $this->container->get($methodArg);

            $this->logger->debug("$methodArg resolved to a service");

            if ($apiName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $this->logger->warning("'$apiName' api name will be ignored");
            }
        } else {
            $api = $this->getApi($apiName);

            $method = $api->getMethod($methodArg);

            $this->logger->debug("$methodArg resolved to a method name");
        }

        $this->checkIsInstanceOfMethod($methodArg, $method);

        return $method;
    }

    /**
     * @param string|null $apiName
     * @return Api
     */
    private function getApi($apiName)
    {
        $apiServiceId = $this->getApiServiceId($apiName);

        if (!$this->container->has($apiServiceId)) {
            throw new \InvalidArgumentException("'$apiName' api service does not exist");
        }

        return $this->container->get($apiServiceId);
    }

    /**
     * @param string|null $apiName
     * @return string
     */
    private function getApiServiceId($apiName)
    {
        $serviceId = 'devhelp_piwik.api';

        if ($apiName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $serviceId .= '.'.$apiName;
        }

        return $serviceId;
    }

    /**
     * @param string $methodArg
     * @param object $method
     */
    private function checkIsInstanceOfMethod($methodArg, $method)
    {
        if (!$method instanceof Method) {
            throw new \InvalidArgumentException(
                sprintf(
                    "'%s' object is of invalid class, expected Devhelp\\Piwik\\Api\\Method\\Method, got %s",
                    $methodArg,
                    get_class($method)
                )
            );
        }
    }
}


1			<?php
2
3			namespace Devhelp\PiwikBundle\Command\Param;
4
5			use Devhelp\Piwik\Api\Api;
6			use Devhelp\Piwik\Api\Method\Method;
7			use Psr\Log\LoggerInterface;
8			use Psr\Log\NullLogger;
9			use Symfony\Component\DependencyInjection\ContainerInterface;
10
11			/**
12			* Finds an api method in a container that is either registered as a service or is available through
13			* the given api service by calling getMethod
14			*/
15			class MethodFinder
16			{
17			/**
18			* @var ContainerInterface
19			*/
20			private $container;
21
22			/**
23			* @var LoggerInterface
24			*/
25			private $logger;
26
27			public function __construct(ContainerInterface $container, LoggerInterface $logger = null)
28			{
29			$this->container = $container;
30			$this->logger = $logger ? $logger : new NullLogger();
31			}
32
33			/**
34			* @param string $methodArg
35			* @param string\|null $apiName
36			* @return Method
37			*/
38			public function find($methodArg, $apiName = null)
39			{
40			if ($this->container->has($methodArg)) {
41			$method = $this->container->get($methodArg);
42
43			$this->logger->debug("$methodArg resolved to a service");
44
45			if ($apiName) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-21 23:23 UTC by Report Bug Copy Issue Report The expression `$apiName` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
46			$this->logger->warning("'$apiName' api name will be ignored");
47			}
48			} else {
49			$api = $this->getApi($apiName);
50
51			$method = $api->getMethod($methodArg);
52
53			$this->logger->debug("$methodArg resolved to a method name");
54			}
55
56			$this->checkIsInstanceOfMethod($methodArg, $method);
57
58			return $method;
59			}
60
61			/**
62			* @param string\|null $apiName
63			* @return Api
64			*/
65			private function getApi($apiName)
66			{
67			$apiServiceId = $this->getApiServiceId($apiName);
68
69			if (!$this->container->has($apiServiceId)) {
70			throw new \InvalidArgumentException("'$apiName' api service does not exist");
71			}
72
73			return $this->container->get($apiServiceId);
74			}
75
76			/**
77			* @param string\|null $apiName
78			* @return string
79			*/
80			private function getApiServiceId($apiName)
81			{
82			$serviceId = 'devhelp_piwik.api';
83
84			if ($apiName) {
			0 ignored issues – show Bug Best Practice introduced 2016-08-31 21:29 UTC by Report Bug Copy Issue Report The expression `$apiName` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
85			$serviceId .= '.'.$apiName;
86			}
87
88			return $serviceId;
89			}
90
91			/**
92			* @param string $methodArg
93			* @param object $method
94			*/
95			private function checkIsInstanceOfMethod($methodArg, $method)
96			{
97			if (!$method instanceof Method) {
98			throw new \InvalidArgumentException(
99			sprintf(
100			"'%s' object is of invalid class, expected Devhelp\\Piwik\\Api\\Method\\Method, got %s",
101			$methodArg,
102			get_class($method)
103			)
104			);
105			}
106			}
107			}
108

devhelp / piwik-bundle

MethodFinder::getApi() A last analyzed 2018-02-25 19:15 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MethodFinder::getApi() A
last analyzed 2018-02-25 19:15 UTC