api-platform /
core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 39 | final class IriConverter implements IriConverterInterface |
||
| 40 | { |
||
| 41 | use ClassInfoTrait; |
||
| 42 | |||
| 43 | private $propertyNameCollectionFactory; |
||
| 44 | private $propertyMetadataFactory; |
||
| 45 | private $itemDataProvider; |
||
| 46 | private $routeNameResolver; |
||
| 47 | private $router; |
||
| 48 | private $propertyAccessor; |
||
| 49 | private $identifiersExtractor; |
||
| 50 | private $identifierNormalizer; |
||
| 51 | |||
| 52 | public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ItemDataProviderInterface $itemDataProvider, RouteNameResolverInterface $routeNameResolver, RouterInterface $router, PropertyAccessorInterface $propertyAccessor = null, IdentifiersExtractorInterface $identifiersExtractor = null, IdentifierNormalizerInterface $identifierNormalizer = null) |
||
| 53 | { |
||
| 54 | $this->propertyNameCollectionFactory = $propertyNameCollectionFactory; |
||
| 55 | $this->propertyMetadataFactory = $propertyMetadataFactory; |
||
| 56 | $this->itemDataProvider = $itemDataProvider; |
||
| 57 | $this->routeNameResolver = $routeNameResolver; |
||
| 58 | $this->router = $router; |
||
| 59 | $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor(); |
||
| 60 | $this->identifierNormalizer = $identifierNormalizer; |
||
| 61 | |||
| 62 | if (null === $identifiersExtractor) { |
||
| 63 | @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); |
||
| 64 | $this->identifiersExtractor = new IdentifiersExtractor($this->propertyNameCollectionFactory, $this->propertyMetadataFactory, $this->propertyAccessor); |
||
| 65 | } else { |
||
| 66 | $this->identifiersExtractor = $identifiersExtractor; |
||
| 67 | } |
||
| 68 | } |
||
| 69 | |||
| 70 | /** |
||
| 71 | * {@inheritdoc} |
||
| 72 | */ |
||
| 73 | public function getItemFromIri(string $iri, array $context = []) |
||
| 74 | { |
||
| 75 | try { |
||
| 76 | $parameters = $this->router->match($iri); |
||
| 77 | } catch (RoutingExceptionInterface $e) { |
||
| 78 | throw new InvalidArgumentException(sprintf('No route matches "%s".', $iri), $e->getCode(), $e); |
||
| 79 | } |
||
| 80 | |||
| 81 | if (!isset($parameters['_api_resource_class'], $parameters['id'])) { |
||
| 82 | throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri)); |
||
| 83 | } |
||
| 84 | |||
| 85 | $identifiers = []; |
||
| 86 | |||
| 87 | if ($this->identifierNormalizer) { |
||
| 88 | $identifiers = $this->identifierNormalizer->normalize((string) $parameters['id'], $parameters['_api_resource_class']); |
||
| 89 | } |
||
| 90 | |||
| 91 | if ($item = $this->itemDataProvider->getItem($parameters['_api_resource_class'], $parameters['id'], null, $context, $identifiers)) { |
||
|
|
|||
| 92 | return $item; |
||
| 93 | } |
||
| 94 | |||
| 95 | throw new ItemNotFoundException(sprintf('Item not found for "%s".', $iri)); |
||
| 96 | } |
||
| 97 | |||
| 98 | /** |
||
| 99 | * {@inheritdoc} |
||
| 100 | */ |
||
| 101 | public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface::ABS_PATH): string |
||
| 102 | { |
||
| 103 | $resourceClass = $this->getObjectClass($item); |
||
| 104 | $routeName = $this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM); |
||
| 105 | |||
| 106 | try { |
||
| 107 | $identifiers = $this->generateIdentifiersUrl($this->identifiersExtractor->getIdentifiersFromItem($item)); |
||
| 108 | |||
| 109 | return $this->router->generate($routeName, ['id' => implode(';', $identifiers)], $referenceType); |
||
| 110 | } catch (RuntimeException $e) { |
||
| 111 | throw new InvalidArgumentException(sprintf( |
||
| 112 | 'Unable to generate an IRI for the item of type "%s"', |
||
| 113 | $resourceClass |
||
| 114 | ), $e->getCode(), $e); |
||
| 115 | } catch (RoutingExceptionInterface $e) { |
||
| 116 | throw new InvalidArgumentException(sprintf( |
||
| 117 | 'Unable to generate an IRI for the item of type "%s"', |
||
| 118 | $resourceClass |
||
| 119 | ), $e->getCode(), $e); |
||
| 120 | } |
||
| 121 | } |
||
| 122 | |||
| 123 | /** |
||
| 124 | * {@inheritdoc} |
||
| 125 | */ |
||
| 126 | View Code Duplication | public function getIriFromResourceClass(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): string |
|
| 127 | { |
||
| 128 | try { |
||
| 129 | return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::COLLECTION), [], $referenceType); |
||
| 130 | } catch (RoutingExceptionInterface $e) { |
||
| 131 | throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e); |
||
| 132 | } |
||
| 133 | } |
||
| 134 | |||
| 135 | /** |
||
| 136 | * {@inheritdoc} |
||
| 137 | */ |
||
| 138 | View Code Duplication | public function getItemIriFromResourceClass(string $resourceClass, array $identifiers, int $referenceType = UrlGeneratorInterface::ABS_PATH): string |
|
| 139 | { |
||
| 140 | try { |
||
| 141 | return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM), $identifiers, $referenceType); |
||
| 142 | } catch (RoutingExceptionInterface $e) { |
||
| 143 | throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e); |
||
| 144 | } |
||
| 145 | } |
||
| 146 | |||
| 147 | /** |
||
| 148 | * {@inheritdoc} |
||
| 149 | */ |
||
| 150 | View Code Duplication | public function getSubresourceIriFromResourceClass(string $resourceClass, array $context, int $referenceType = UrlGeneratorInterface::ABS_PATH): string |
|
| 151 | { |
||
| 152 | try { |
||
| 153 | return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::SUBRESOURCE, $context), $context['subresource_identifiers'], $referenceType); |
||
| 154 | } catch (RoutingExceptionInterface $e) { |
||
| 155 | throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e); |
||
| 156 | } |
||
| 157 | } |
||
| 158 | |||
| 159 | /** |
||
| 160 | * Generate the identifier url. |
||
| 161 | * |
||
| 162 | * @param array $identifiers |
||
| 163 | * |
||
| 164 | * @return string[] |
||
| 165 | */ |
||
| 166 | private function generateIdentifiersUrl(array $identifiers): array |
||
| 178 | } |
||
| 179 |
Loading history...
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
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.