OXIESEC PANEL
- Current Dir:
/
/
var
/
www
/
reader
/
API
/
vendor
/
zircote
/
swagger-php
/
src
/
Processors
Server IP: 139.59.38.164
Upload:
Create Dir:
Name
Size
Modified
Perms
📁
..
-
08/07/2024 04:34:30 AM
rwxr-xr-x
📄
AugmentParameters.php
3.21 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
AugmentProperties.php
8.44 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
AugmentRefs.php
3.88 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
AugmentRequestBody.php
1.43 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
AugmentSchemas.php
5.42 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
BuildPaths.php
2.21 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
CleanUnmerged.php
995 bytes
08/07/2024 04:34:30 AM
rw-r--r--
📄
CleanUnusedComponents.php
3.56 KB
08/07/2024 04:34:30 AM
rw-r--r--
📁
Concerns
-
08/07/2024 04:34:51 AM
rwxr-xr-x
📄
DocBlockDescriptions.php
3.1 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
ExpandClasses.php
1.68 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
ExpandEnums.php
3.64 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
ExpandInterfaces.php
2.09 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
ExpandTraits.php
3.54 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
MergeIntoComponents.php
1.08 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
MergeIntoOpenApi.php
1.88 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
MergeJsonContent.php
2.07 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
MergeXmlContent.php
2.05 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
OperationId.php
2.1 KB
08/07/2024 04:34:30 AM
rw-r--r--
📄
ProcessorInterface.php
151 bytes
08/07/2024 04:34:30 AM
rw-r--r--
Editing: DocBlockDescriptions.php
Close
<?php declare(strict_types=1); /** * @license Apache 2.0 */ namespace OpenApi\Processors; use OpenApi\Analysis; use OpenApi\Annotations as OA; use OpenApi\Generator; /** * Checks if the annotation has a summary and/or description property * and uses the text in the comment block (above the annotations) as summary and/or description. * * Use `null`, for example: `@Annotation(description=null)`, if you don't want the annotation to have a description. */ class DocBlockDescriptions implements ProcessorInterface { use Concerns\DocblockTrait; public function __invoke(Analysis $analysis) { /** @var OA\AbstractAnnotation $annotation */ foreach ($analysis->annotations as $annotation) { if (property_exists($annotation, '_context') === false) { // only annotations with context continue; } if (!$this->isRoot($annotation)) { // only top-level annotations continue; } $hasSummary = property_exists($annotation, 'summary'); $hasDescription = property_exists($annotation, 'description'); if (!$hasSummary && !$hasDescription) { continue; } if ($hasSummary && $hasDescription) { $this->summaryAndDescription($annotation); } elseif ($hasDescription) { $this->description($annotation); } } } /** * @param OA\Operation|OA\Property|OA\Parameter|OA\Schema $annotation */ protected function description(OA\AbstractAnnotation $annotation): void { if (!Generator::isDefault($annotation->description)) { if ($annotation->description === null) { $annotation->description = Generator::UNDEFINED; } return; } $annotation->description = $this->extractContent($annotation->_context->comment); } /** * @param OA\Operation|OA\Property|OA\Parameter|OA\Schema $annotation */ protected function summaryAndDescription(OA\AbstractAnnotation $annotation): void { $ignoreSummary = !Generator::isDefault($annotation->summary); $ignoreDescription = !Generator::isDefault($annotation->description); if ($annotation->summary === null) { $ignoreSummary = true; $annotation->summary = Generator::UNDEFINED; } if ($annotation->description === null) { $annotation->description = Generator::UNDEFINED; $ignoreDescription = true; } if ($ignoreSummary && $ignoreDescription) { return; } if ($ignoreSummary) { $annotation->description = $this->extractContent($annotation->_context->comment); } elseif ($ignoreDescription) { $annotation->summary = $this->extractContent($annotation->_context->comment); } else { $annotation->summary = $this->extractSummary($annotation->_context->comment); $annotation->description = $this->extractDescription($annotation->_context->comment); } } }