IriConverter::generateIdentifiersUrl() - Code Metrics - Inspection of "Fix #1326 (DateFilter before/after filters on befo..." - api-platform/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#1343)

unknown

created 2017-09-04 09:41 UTC

IriConverter::generateIdentifiersUrl() A

↳ Parent: IriConverter

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	12
rs	9.4285
cc	3
eloc	6
nc	3
nop	1

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Symfony\Routing;

use ApiPlatform\Core\Api\IdentifiersExtractor;
use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
use ApiPlatform\Core\Api\IriConverterInterface;
use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Api\UrlGeneratorInterface;
use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use ApiPlatform\Core\Exception\ItemNotFoundException;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Core\Util\ClassInfoTrait;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Symfony\Component\Routing\Exception\ExceptionInterface as RoutingExceptionInterface;
use Symfony\Component\Routing\RouterInterface;

/**
 * {@inheritdoc}
 *
 * @author Kévin Dunglas <[email protected]>
 */
final class IriConverter implements IriConverterInterface
{
    use ClassInfoTrait;

    private $propertyNameCollectionFactory;
    private $propertyMetadataFactory;
    private $itemDataProvider;
    private $routeNameResolver;
    private $router;
    private $propertyAccessor;
    private $identifiersExtractor;

    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ItemDataProviderInterface $itemDataProvider, RouteNameResolverInterface $routeNameResolver, RouterInterface $router, PropertyAccessorInterface $propertyAccessor = null, IdentifiersExtractorInterface $identifiersExtractor = null)
    {
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->itemDataProvider = $itemDataProvider;
        $this->routeNameResolver = $routeNameResolver;
        $this->router = $router;
        $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();

        if (null === $identifiersExtractor) {
            @trigger_error('Not injecting ItemIdentifiersExtractor is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            $this->identifiersExtractor = new IdentifiersExtractor($this->propertyNameCollectionFactory, $this->propertyMetadataFactory, $this->propertyAccessor);
        } else {
            $this->identifiersExtractor = $identifiersExtractor;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getItemFromIri(string $iri, array $context = [])
    {
        try {
            $parameters = $this->router->match($iri);
        } catch (RoutingExceptionInterface $e) {
            throw new InvalidArgumentException(sprintf('No route matches "%s".', $iri), $e->getCode(), $e);
        }

        if (!isset($parameters['_api_resource_class'], $parameters['id'])) {
            throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri));
        }

        if ($item = $this->itemDataProvider->getItem($parameters['_api_resource_class'], $parameters['id'], null, $context)) {
            return $item;
        }

        throw new ItemNotFoundException(sprintf('Item not found for "%s".', $iri));
    }

    /**
     * {@inheritdoc}
     */
    public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
    {
        $resourceClass = $this->getObjectClass($item);
        $routeName = $this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM);

        try {
            $identifiers = $this->generateIdentifiersUrl($this->identifiersExtractor->getIdentifiersFromItem($item));

            return $this->router->generate($routeName, ['id' => implode(';', $identifiers)], $referenceType);
        } catch (RuntimeException $e) {
            throw new InvalidArgumentException(sprintf(
                'Unable to generate an IRI for the item of type "%s"',
                $resourceClass
            ), $e->getCode(), $e);
        } catch (RoutingExceptionInterface $e) {
            throw new InvalidArgumentException(sprintf(
                'Unable to generate an IRI for the item of type "%s"',
                $resourceClass
            ), $e->getCode(), $e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getIriFromResourceClass(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): string

    {
        try {
            return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::COLLECTION), [], $referenceType);
        } catch (RoutingExceptionInterface $e) {
            throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getItemIriFromResourceClass(string $resourceClass, array $identifiers, int $referenceType = UrlGeneratorInterface::ABS_PATH): string

    {
        try {
            return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM), $identifiers, $referenceType);
        } catch (RoutingExceptionInterface $e) {
            throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getSubresourceIriFromResourceClass(string $resourceClass, array $context, int $referenceType = UrlGeneratorInterface::ABS_PATH): string

    {
        try {
            return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::SUBRESOURCE, $context), $context['subresource_identifiers'], $referenceType);

        } catch (RoutingExceptionInterface $e) {
            throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
        }
    }

    /**
     * Generate the identifier url.
     *
     * @param array $identifiers
     *
     * @return string[]
     */
    private function generateIdentifiersUrl(array $identifiers): array
    {
        if (1 === count($identifiers)) {
            return [rawurlencode((string) array_values($identifiers)[0])];
        }

        foreach ($identifiers as $name => $value) {
            $identifiers[$name] = sprintf('%s=%s', $name, $value);
        }

        return $identifiers;
    }
}


1		<?php
2
3		/*
4		* This file is part of the API Platform project.
5		*
6		* (c) Kévin Dunglas <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		declare(strict_types=1);
13
14		namespace ApiPlatform\Core\Bridge\Symfony\Routing;
15
16		use ApiPlatform\Core\Api\IdentifiersExtractor;
17		use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
18		use ApiPlatform\Core\Api\IriConverterInterface;
19		use ApiPlatform\Core\Api\OperationType;
20		use ApiPlatform\Core\Api\UrlGeneratorInterface;
21		use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
22		use ApiPlatform\Core\Exception\InvalidArgumentException;
23		use ApiPlatform\Core\Exception\ItemNotFoundException;
24		use ApiPlatform\Core\Exception\RuntimeException;
25		use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
26		use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
27		use ApiPlatform\Core\Util\ClassInfoTrait;
28		use Symfony\Component\PropertyAccess\PropertyAccess;
29		use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
30		use Symfony\Component\Routing\Exception\ExceptionInterface as RoutingExceptionInterface;
31		use Symfony\Component\Routing\RouterInterface;
32
33		/**
34		* {@inheritdoc}
35		*
36		* @author Kévin Dunglas <[email protected]>
37		*/
38		final class IriConverter implements IriConverterInterface
39		{
40		use ClassInfoTrait;
41
42		private $propertyNameCollectionFactory;
43		private $propertyMetadataFactory;
44		private $itemDataProvider;
45		private $routeNameResolver;
46		private $router;
47		private $propertyAccessor;
48		private $identifiersExtractor;
49
50		public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ItemDataProviderInterface $itemDataProvider, RouteNameResolverInterface $routeNameResolver, RouterInterface $router, PropertyAccessorInterface $propertyAccessor = null, IdentifiersExtractorInterface $identifiersExtractor = null)
51		{
52		$this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
53		$this->propertyMetadataFactory = $propertyMetadataFactory;
54		$this->itemDataProvider = $itemDataProvider;
55		$this->routeNameResolver = $routeNameResolver;
56		$this->router = $router;
57		$this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
58
59		if (null === $identifiersExtractor) {
60		@trigger_error('Not injecting ItemIdentifiersExtractor is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3', E_USER_DEPRECATED);
		1 ignored issue – show Security Best Practice introduced 2017-03-29 14:10 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
61		$this->identifiersExtractor = new IdentifiersExtractor($this->propertyNameCollectionFactory, $this->propertyMetadataFactory, $this->propertyAccessor);
62		} else {
63		$this->identifiersExtractor = $identifiersExtractor;
64		}
65		}
66
67		/**
68		* {@inheritdoc}
69		*/
70		public function getItemFromIri(string $iri, array $context = [])
71		{
72		try {
73		$parameters = $this->router->match($iri);
74		} catch (RoutingExceptionInterface $e) {
75		throw new InvalidArgumentException(sprintf('No route matches "%s".', $iri), $e->getCode(), $e);
76		}
77
78		if (!isset($parameters['_api_resource_class'], $parameters['id'])) {
79		throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri));
80		}
81
82		if ($item = $this->itemDataProvider->getItem($parameters['_api_resource_class'], $parameters['id'], null, $context)) {
83		return $item;
84		}
85
86		throw new ItemNotFoundException(sprintf('Item not found for "%s".', $iri));
87		}
88
89		/**
90		* {@inheritdoc}
91		*/
92		public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
93		{
94		$resourceClass = $this->getObjectClass($item);
95		$routeName = $this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM);
96
97		try {
98		$identifiers = $this->generateIdentifiersUrl($this->identifiersExtractor->getIdentifiersFromItem($item));
99
100		return $this->router->generate($routeName, ['id' => implode(';', $identifiers)], $referenceType);
101		} catch (RuntimeException $e) {
102		throw new InvalidArgumentException(sprintf(
103		'Unable to generate an IRI for the item of type "%s"',
104		$resourceClass
105		), $e->getCode(), $e);
106		} catch (RoutingExceptionInterface $e) {
107		throw new InvalidArgumentException(sprintf(
108		'Unable to generate an IRI for the item of type "%s"',
109		$resourceClass
110		), $e->getCode(), $e);
111		}
112		}
113
114		/**
115		* {@inheritdoc}
116		*/
117	View Code Duplication	public function getIriFromResourceClass(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
		0 ignored issues – show Duplication introduced 2017-04-07 13:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
118		{
119		try {
120		return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::COLLECTION), [], $referenceType);
121		} catch (RoutingExceptionInterface $e) {
122		throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
123		}
124		}
125
126		/**
127		* {@inheritdoc}
128		*/
129	View Code Duplication	public function getItemIriFromResourceClass(string $resourceClass, array $identifiers, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
		0 ignored issues – show Duplication introduced 2017-04-20 17:25 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
130		{
131		try {
132		return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM), $identifiers, $referenceType);
133		} catch (RoutingExceptionInterface $e) {
134		throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
135		}
136		}
137
138		/**
139		* {@inheritdoc}
140		*/
141	View Code Duplication	public function getSubresourceIriFromResourceClass(string $resourceClass, array $context, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
		0 ignored issues – show Duplication introduced 2017-04-07 13:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
142		{
143		try {
144		return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::SUBRESOURCE, $context), $context['subresource_identifiers'], $referenceType);
		0 ignored issues – show Unused Code introduced 2017-05-11 10:16 UTC by Report Bug Copy Issue Report The call to `RouteNameResolverInterface::getRouteName()` has too many arguments starting with `$context`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
145		} catch (RoutingExceptionInterface $e) {
146		throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
147		}
148		}
149
150		/**
151		* Generate the identifier url.
152		*
153		* @param array $identifiers
154		*
155		* @return string[]
156		*/
157		private function generateIdentifiersUrl(array $identifiers): array
158		{
159		if (1 === count($identifiers)) {
160		return [rawurlencode((string) array_values($identifiers)[0])];
161		}
162
163		foreach ($identifiers as $name => $value) {
164		$identifiers[$name] = sprintf('%s=%s', $name, $value);
165		}
166
167		return $identifiers;
168		}
169		}
170

api-platform / core

Pull Request — 2.0 (#1343)

IriConverter::generateIdentifiersUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like