MergeIntoOpenApi.php

<?php declare(strict_types=1);

/**
 * @license Apache 2.0
 */

namespace OpenApi\Processors;

use OpenApi\Analysis;
use OpenApi\Annotations as OA;
use OpenApi\Context;
use OpenApi\Generator;

/**
 * Merge all <code>@OA\OpenApi</code> annotations into one.
 */
class MergeIntoOpenApi
{
    protected bool $mergeComponents;

    public function __construct(bool $mergeComponents = false)
    {
        $this->mergeComponents = $mergeComponents;
    }

    public function isMergeComponents(): bool
    {
        return $this->mergeComponents;
    }

    /**
     *  If set to <code>true</code> allow multiple `@OA\Components` annotations to be merged.
     */
    public function setMergeComponents(bool $mergeComponents): MergeIntoOpenApi
    {
        $this->mergeComponents = $mergeComponents;

        return $this;
    }

    public function __invoke(Analysis $analysis): void
    {
        // Auto-create the OpenApi annotation.
        if (!$analysis->openapi) {
            $context = new Context(['generated' => true], $analysis->context);
            $analysis->addAnnotation(new OA\OpenApi(['_context' => $context]), $context);
        }

        $openapi = $analysis->openapi;
        $openapi->_analysis = $analysis;

        // Merge annotations into the target openapi
        $merge = [];
        /** @var OA\AbstractAnnotation $annotation */
        foreach ($analysis->annotations as $annotation) {
            if ($annotation === $openapi) {
                continue;
            }

            if ($annotation instanceof OA\OpenApi) {
                $paths = $annotation->paths;
                unset($annotation->paths);
                $openapi->mergeProperties($annotation);
                if (!Generator::isDefault($paths)) {
                    foreach ($paths as $path) {
                        if (Generator::isDefault($openapi->paths)) {
                            $openapi->paths = [];
                        }
                        $openapi->paths[] = $path;
                    }
                }
            } elseif ($annotation instanceof OA\AbstractAnnotation
                && in_array(OA\OpenApi::class, $annotation::$_parents)
                && false === $annotation->_context->is('nested')) {
                // A top-level annotation.
                $merge[] = $annotation;
            }
        }

        if ($this->isMergeComponents()) {

            // merge Components
            $componentsList = array_filter($merge, fn (OA\AbstractAnnotation $annotation): bool => $annotation instanceof OA\Components);
            $firstComponents = $openapi->components;

            if ((!Generator::isDefault($firstComponents) && $componentsList !== []) || count($merge) > 1) {
                if (Generator::isDefault($firstComponents)) {
                    $firstComponents = array_shift($componentsList);
                }

                foreach ($componentsList as $components) {
                    foreach (OA\Components::$_nested as $nested) {
                        if (2 == count($nested)) {
                            $property = $nested[0];
                            if (!Generator::isDefault($components->{$property})) {
                                $firstComponents->merge($components->{$property});
                            }
                        }
                    }

                    $analysis->removeAnnotation($components);
                }

                $merge = array_filter($merge, fn (OA\AbstractAnnotation $annotation): bool => !$annotation instanceof OA\Components);
                $merge[] = $firstComponents;
            }
        }

        $openapi->merge($merge, true);
    }
}