OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	08/07/2024 04:34:56 AM	rwxr-xr-x
📄 DocGenerator.php	3.35 KB	08/07/2024 04:34:56 AM	rw-r--r--
📄 ProcGenerator.php	2.98 KB	08/07/2024 04:34:56 AM	rw-r--r--
📄 RefGenerator.php	8.31 KB	08/07/2024 04:34:56 AM	rw-r--r--

Editing: RefGenerator.php

<?php declare(strict_types=1);

/**
 * @license Apache 2.0
 */

namespace OpenApi\Tools\Docs;

use OpenApi\Analysers\TokenScanner;
use OpenApi\Annotations\AbstractAnnotation;

class RefGenerator extends DocGenerator
{
    public const ATTRIBUTES = 'Attributes';
    public const ANNOTATIONS = 'Annotations';

protected $scanner;

public function __construct($projectRoot)
    {
        parent::__construct($projectRoot);

$this->scanner = new TokenScanner();
    }

public function classesForType(string $type): array
    {
        $classes = [];
        $dir = new \DirectoryIterator($this->projectRoot . '/src/' . $type);
        foreach ($dir as $entry) {
            if (!$entry->isFile() || $entry->getExtension() != 'php') {
                continue;
            }
            $class = $entry->getBasename('.php');
            if (in_array($class, ['AbstractAnnotation', 'Operation', 'ParameterTrait', 'OperationTrait'])) {
                continue;
            }
            $classes[$class] = [
                'fqdn' => 'OpenApi\\' . $type . '\\' . $class,
                'filename' => $entry->getPathname(),
            ];
        }

ksort($classes);

return $classes;
    }

public function types(): array
    {
        return [self::ANNOTATIONS, self::ATTRIBUTES];
    }

public function formatAttributesDetails(string $name, string $fqdn, string $filename): string
    {
        $rctor = (new \ReflectionClass($fqdn))->getMethod('__construct');

ob_start();

$rc = new \ReflectionClass($fqdn);
        $classDocumentation = $this->extractDocumentation($rc->getDocComment());
        echo $classDocumentation['content'] . PHP_EOL;

$ctorDocumentation = $this->extractDocumentation($rc->getMethod('__construct')->getDocComment());
        $params = $ctorDocumentation['params'];

$this->treeDetails($fqdn);

$parameters = $rctor->getParameters();
        if ($parameters) {
            echo PHP_EOL . '#### Parameters' . PHP_EOL;
            echo '---' . PHP_EOL;

echo '<dl>' . PHP_EOL;
 foreach ($parameters as $rp) {
 $parameter = $rp->getName();
 $propertyDocumentation = $this->getPropertyDocumentation($fqdn, $parameter);
 $def = array_key_exists($parameter, $params)
 ? $params[$parameter]['type']
 : '';

if ($var = $this->getReflectionType($fqdn, $rp, true, $def)) {
 $var = ' : ' . $var . '';
 }

echo ' <dt>' . $parameter . '' . $var . '</dt>' . PHP_EOL;
 echo ' <dd>';
 $this->propertyDetails($propertyDocumentation);
 echo '</dd>' . PHP_EOL;
 }
 echo '</dl>' . PHP_EOL;
 }

if ($classDocumentation['see']) {
            echo PHP_EOL . '#### Reference' . PHP_EOL;
            echo '---' . PHP_EOL;

foreach ($classDocumentation['see'] as $link) {
                echo '- ' . $link . PHP_EOL;
            }
        }

echo PHP_EOL;

return ob_get_clean();
    }

/**
 * @param class-string<AbstractAnnotation> $fqdn
 */
 public function formatAnnotationsDetails(string $name, string $fqdn, string $filename): string
 {
 $details = $this->scanner->scanFile($filename);

ob_start();

$rc = new \ReflectionClass($fqdn);
        $classDocumentation = $this->extractDocumentation($rc->getDocComment());
        echo $classDocumentation['content'] . PHP_EOL;

$this->treeDetails($fqdn);

$nestedProps = $this->getNestedProperties($fqdn);
        $properties = array_filter($details[$fqdn]['properties'], function ($property) use ($fqdn, $nestedProps) {
            return !in_array($property, $fqdn::$_blacklist) && $property[0] != '_' && !in_array($property, $nestedProps);
        });

if ($properties) {
            echo PHP_EOL . '#### Properties' . PHP_EOL;
            echo '---' . PHP_EOL;

echo '<dl>' . PHP_EOL;
 foreach ($properties as $property) {
 $rp = new \ReflectionProperty($fqdn, $property);
 $propertyDocumentation = $this->getPropertyDocumentation($fqdn, $property);
 if ($var = $this->getReflectionType($fqdn, $rp, false, $propertyDocumentation['var'])) {
 $var = ' : ' . $var . '';
 }

echo ' <dt>' . $property . '' . $var . '</dt>' . PHP_EOL;
 echo ' <dd>';
 $this->propertyDetails($propertyDocumentation);
 echo '</dd>' . PHP_EOL;
 }
 echo '</dl>' . PHP_EOL;
 }

if ($classDocumentation['see']) {
            echo PHP_EOL . '#### Reference' . PHP_EOL;
            echo '---' . PHP_EOL;

foreach ($classDocumentation['see'] as $link) {
                echo '- ' . $link . PHP_EOL;
            }
        }

echo PHP_EOL;

return ob_get_clean();
    }

// ------------------------------------------------------------------------

protected function getPropertyDocumentation(string $fqdn, string $name): array
    {
        try {
            $rp = new \ReflectionProperty(str_replace('Attributes', 'Annotations', $fqdn), $name);
        } catch (\ReflectionException $re) {
            $rp = null;
        }

return $this->extractDocumentation($rp ? $rp->getDocComment() : null);
    }

protected function propertyDetails(array $propertyDocumentation): void
 {
 echo '' . nl2br($propertyDocumentation['content'] ?: self::NO_DETAILS_AVAILABLE) . '';
 if ($propertyDocumentation['see']) {
 $links = [];
 foreach ($propertyDocumentation['see'] as $see) {
 if ($link = $this->linkFromMarkup($see)) {
 $links[] = $link;
 }
 }
 if ($links) {
 echo 'See: ' . implode(', ', $links) . '';
 }
 }

}

/**
 * @param class-string<AbstractAnnotation> $fqdn
 */
 protected function getNestedProperties($fqdn): array
 {
 $props = [];
 foreach ($fqdn::$_nested as $details) {
 $props[] = ((array) $details)[0];
 }

return $props;
    }

/**
 * @param class-string<AbstractAnnotation> $fqdn
 */
 protected function treeDetails($fqdn)
 {
 if ($fqdn::$_parents) {
 echo PHP_EOL . '#### Allowed in' . PHP_EOL;
 echo '---' . PHP_EOL;

$parents = array_map(function (string $parent) {
                $shortName = $this->shortName($parent);

return '<a href="#' . strtolower($shortName) . '">' . $shortName . '</a>';
 }, $fqdn::$_parents);
 echo implode(', ', $parents) . PHP_EOL;
 }

if ($fqdn::$_nested) {
            echo PHP_EOL . '#### Nested elements' . PHP_EOL;
            echo '---' . PHP_EOL;

$nested = array_map(function (string $nested) {
                $shortName = $this->shortName($nested);

return '<a href="#' . strtolower($shortName) . '">' . $shortName . '</a>';
 }, array_keys($fqdn::$_nested));
 echo implode(', ', $nested) . PHP_EOL;
 }
 }

protected function shortName(string $class): string
    {
        return str_replace(['OpenApi\\Annotations\\', 'OpenApi\\Attributes\\'], '', $class);
    }

protected function getReflectionType(string $fqdn, $rp, bool $preferDefault = false, string $def = ''): string
    {
        $var = [];

if ($type = $rp->getType()) {
            if ($type instanceof \ReflectionUnionType) {
                foreach ($type->getTypes() as $type) {
                    $var[] = $type->getName();
                }
            } else {
                $var[] = $type->getName();
            }
            if ($type->allowsNull()) {
                $var[] = 'null';
            }
        }
        if ($def && (!$var || $preferDefault)) {
            if ($preferDefault) {
                $var = [];
            }
            $var = array_merge($var, explode('|', $def));
        }

return implode('|', array_map(function ($item) {
            return htmlentities($item);
        }, array_unique($var)));
    }
}