ApiPlatform\Core\Swagger\ApiDocumentationBuilder::getApiDocumentation()

Complexity

Conditions	16
Paths	772

Size

Total Lines	93
Code Lines	56

Duplication

Lines	8
Ratio	8.6 %

Importance

Changes

0

<?php
    public function getApiDocumentation()
    {
        $classes = [];
        $itemOperations = [];
        $itemOperationsDocs = [];
        $properties = [];

        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

            $shortName = $resourceMetadata->getShortName();
            $prefixedShortName = ($iri = $resourceMetadata->getIri()) ? $iri : '#'.$shortName;

            $class = [
                'name' => $shortName,
                'externalDocs' => [
                    'url' => $prefixedShortName,
                ],
            ];

            if ($description = $resourceMetadata->getDescription()) {
                $class = [
                    'name' => $shortName,
                    'description' => $description,
                    'externalDocs' => [
                        'url' => $prefixedShortName,
                    ],
                ];
            }

            $attributes = $resourceMetadata->getAttributes();
            $context = [];

            if (isset($attributes['normalization_context']['groups'])) {
                $context['serializer_groups'] = $attributes['normalization_context']['groups'];
            }

            if (isset($attributes['denormalization_context']['groups'])) {

This code seems to be duplicated across your project.

                $context['serializer_groups'] = isset($context['serializer_groups']) ? array_merge($context['serializer_groups'], $attributes['denormalization_context']['groups']) : $context['serializer_groups'];
            }

            foreach ($this->propertyNameCollectionFactory->create($resourceClass, $context) as $propertyName) {
                $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName);

                if ($propertyMetadata->isIdentifier() && !$propertyMetadata->isWritable()) {

The expression $propertyMetadata->isWritable() of type null|boolean is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

                    continue;
                }

                $property[$propertyName] = [

$property was never initialized. Although not strictly required by PHP, it is generally a good practice to add $property = array(); before regardless.

                    'type' => $this->getRange($propertyMetadata),
                ];

                $required = [];

                if ($propertyMetadata->isRequired()) {
                    $required = array_merge($required, [$propertyName]);
                }

                if (0 !== count($required)) {
                    $properties[$shortName]['required'] = $required;
                }

                $properties[$shortName]['type'] = 'object';
                $properties[$shortName]['properties'] = $property;

The variable $property does not seem to be defined for all execution paths leading up to this point.

            }

            if ($operations = $resourceMetadata->getItemOperations()) {

This code seems to be duplicated across your project.

                foreach ($operations as $operationName => $itemOperation) {
                    $itemOperations = array_merge($itemOperations, $this->getSwaggerOperation($resourceClass, $resourceMetadata, $operationName, $itemOperation, $prefixedShortName, false));
                }
            }
            $itemOperationsDocs[$this->iriConverter->getIriFromResourceClass($resourceClass)] = $itemOperations;
            $classes[] = $class;
        }

        $doc['swagger'] = '2.0';

$doc was never initialized. Although not strictly required by PHP, it is generally a good practice to add $doc = array(); before regardless.

        if ('' !== $this->title) {
            $doc['info']['title'] = $this->title;
        }

        if ('' !== $this->description) {
            $doc['info']['description'] = $this->description;
        }
        $doc['host'] = $this->urlGenerator->generate('api_jsonld_entrypoint');
        $doc['basePath'] = $this->urlGenerator->generate('api_jsonld_entrypoint');
        $doc['definitions'] = $properties;
        $doc['externalDocs'] = ['description' => 'Find more about api-platform', 'url' => 'docs'];
        $doc['tags'] = $classes;
        $doc['schemes'] = ['http']; // more schema ?
        $doc['paths'] = $itemOperationsDocs;

        return $doc;
    }