1
0
Fork 0
mirror of https://github.com/DanielnetoDotCom/YouPHPTube synced 2025-10-03 01:39:24 +02:00
Oinktube/vendor/zircote/swagger-php/src/Processors/CleanUnusedComponents.php
Daniel Neto 7c9f95b33d Refactor and enhance type hinting across various classes in the Swagger-PHP library
- Updated error handling in TokenScanner to use more descriptive variable names.
- Added return type declarations for methods in Analysis, AbstractAnnotation, Components, Items, License, OpenApi, Operation, Parameter, Response, Schema, Context, Generator, and several processors to improve code clarity and type safety.
- Introduced new PipeOperatorEmulator and VoidCastEmulator classes to support PHP 8.5 features.
- Implemented Pipe binary operator and Void cast node classes to enhance the parser's capabilities.
- Improved array filtering and lambda function type hints for better readability and performance.
- Enhanced the handling of annotations and context in various processors to ensure consistent behavior and reduce potential errors.
2025-08-12 11:19:47 -03:00

123 lines
4.2 KiB
PHP

<?php declare(strict_types=1);
/**
* @license Apache 2.0
*/
namespace OpenApi\Processors;
use OpenApi\Analysis;
use OpenApi\Annotations as OA;
use OpenApi\Generator;
/**
* Tracks the use of all <code>Components</code> and removed unused schemas.
*/
class CleanUnusedComponents
{
use Concerns\AnnotationTrait;
protected bool $enabled;
public function __construct(bool $enabled = false)
{
$this->enabled = $enabled;
}
public function isEnabled(): bool
{
return $this->enabled;
}
/**
* Enables/disables the <code>CleanUnusedComponents</code> processor.
*/
public function setEnabled(bool $enabled): CleanUnusedComponents
{
$this->enabled = $enabled;
return $this;
}
public function __invoke(Analysis $analysis): void
{
if (!$this->enabled || Generator::isDefault($analysis->openapi->components)) {
return;
}
$analysis->annotations = $this->collectAnnotations($analysis->annotations);
// allow multiple runs to catch nested dependencies
for ($ii = 0; $ii < 10; ++$ii) {
if (!$this->cleanup($analysis)) {
break;
}
}
}
protected function cleanup(Analysis $analysis): bool
{
$usedRefs = [];
foreach ($analysis->annotations as $annotation) {
if (property_exists($annotation, 'ref') && !Generator::isDefault($annotation->ref) && $annotation->ref !== null) {
$usedRefs[$annotation->ref] = $annotation->ref;
}
foreach (['allOf', 'anyOf', 'oneOf'] as $sub) {
if (property_exists($annotation, $sub) && !Generator::isDefault($annotation->{$sub})) {
foreach ($annotation->{$sub} as $subElem) {
if (is_object($subElem) && property_exists($subElem, 'ref') && !Generator::isDefault($subElem->ref) && $subElem->ref !== null) {
$usedRefs[$subElem->ref] = $subElem->ref;
}
}
}
}
if ($annotation instanceof OA\OpenApi || $annotation instanceof OA\Operation) {
if (!Generator::isDefault($annotation->security)) {
foreach ($annotation->security as $security) {
foreach (array_keys($security) as $securityName) {
$ref = OA\Components::COMPONENTS_PREFIX . 'securitySchemes/' . $securityName;
$usedRefs[$ref] = $ref;
}
}
}
}
}
$unusedRefs = [];
foreach (OA\Components::$_nested as $nested) {
if (2 == count($nested)) {
// $nested[1] is the name of the property that holds the component name
[$componentType, $nameProperty] = $nested;
if (!Generator::isDefault($analysis->openapi->components->{$componentType})) {
foreach ($analysis->openapi->components->{$componentType} as $component) {
$ref = OA\Components::ref($component);
if (!in_array($ref, $usedRefs)) {
$unusedRefs[$ref] = [$ref, $nameProperty];
}
}
}
}
}
// remove unused
foreach ($unusedRefs as $refDetails) {
[$ref, $nameProperty] = $refDetails;
[$hash, $components, $componentType, $name] = explode('/', $ref);
foreach ($analysis->openapi->components->{$componentType} as $ii => $component) {
if ($component->{$nameProperty} == $name) {
$annotation = $analysis->openapi->components->{$componentType}[$ii];
$this->removeAnnotation($analysis->annotations, $annotation);
unset($analysis->openapi->components->{$componentType}[$ii]);
if (!$analysis->openapi->components->{$componentType}) {
$analysis->openapi->components->{$componentType} = Generator::UNDEFINED;
}
}
}
}
return 0 != count($unusedRefs);
}
}