BLUE

Navigation

Breadcrumbs

/ / var / www / multi-event-cfp.bitkit.dk / httpdocs / vendor / zircote / swagger-php / docs

Create

Upload

Tip: You can also drag & drop files anywhere on this page to upload.

Edit File Size: 9.14 KB

/var/www/multi-event-cfp.bitkit.dk/httpdocs/vendor/zircote/swagger-php/docs/refgen.php

Text Base64

<?php declare(strict_types=1);

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

require_once __DIR__ . '/../vendor/autoload.php';

class RefGenerator
{
    const ATTRIBUTES = 'Attributes';
    const ANNOTATIONS = 'Annotations';
    const NO_DETAILS_AVAILABLE = 'No details available.';

protected $scanner;

public function __construct()
    {
        $this->scanner = new TokenScanner();
    }

/**
 *
 */
 public function preamble(string $type): string
 {
 return <<< EOT
# $type

This page is generated automatically from the `swagger-php` sources.

For improvements head over to [GitHub](https://github.com/zircote/swagger-php) and create a PR ;)

In addition to this page, there are also a number of [examples](https://github.com/zircote/swagger-php/tree/master/Examples#readme) which might help you out.

EOT;
    }

/**
     *
     */
    public function classesForType(string $type): array
    {
        $classes = [];
        $dir = new DirectoryIterator(__DIR__ . '/../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 formatHeader(string $name, string $type): string
 {
 return <<< EOT
## [$name](https://github.com/zircote/swagger-php/tree/master/src/$type/$name.php)

EOT;
    }

/**
     *
     */
    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'];

$parameters = $rctor->getParameters();
 if ($parameters) {
 echo PHP_EOL . '#### Parameters' . PHP_EOL;
 echo '<dl>' . PHP_EOL;
 foreach ($parameters as $rp) {
 $parameter = $rp->getName();
 $def = array_key_exists($parameter, $params)
 ? $params[$parameter]
 : '';

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

echo ' <dt>' . $parameter . '' . $var . '</dt>' . PHP_EOL;
 echo ' <dd>';
 echo '' . self::NO_DETAILS_AVAILABLE . '';
 echo '</dd>' . PHP_EOL;
 }
 echo '</dl>' . PHP_EOL;
 }

if ($classDocumentation['see']) {
            echo PHP_EOL . '#### Reference' . 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;

// todo: anchestor properties
        $properties = array_filter($details[$fqdn]['properties'], function ($property) use ($fqdn) {
            return !in_array($property, $fqdn::$_blacklist) && $property[0] != '_';
        });

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

echo ' <dt>' . $property . '' . $var . '</dt>' . PHP_EOL;
 echo ' <dd>';
 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) . '';
 }
 }

echo '</dd>' . PHP_EOL;
 }
 echo '</dl>' . PHP_EOL;
 }

echo PHP_EOL;

return ob_get_clean();
    }

protected function linkFromMarkup(string $see): ?string
    {
        preg_match('/\[([^]]+)]$(.*)$/', $see, $matches);

return 3 == count($matches) ? '<a href="'.$matches[2].'">'.$matches[1].'</a>' : null;
 }

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)));
    }

protected function extractDocumentation($docblock): array
    {
        if (!$docblock) {
            return ['content' => '', 'see' => [], 'var' => '', 'params' => []];
        }

$comment = preg_split('/(\n|\r\n)/', (string)$docblock);

$comment[0] = preg_replace('/[ \t]*\\/\*\*/', '', $comment[0]); // strip '/**'
        $i = count($comment) - 1;
        $comment[$i] = preg_replace('/\*\/[ \t]*$/', '', $comment[$i]); // strip '*/'

$see = [];
        $var = '';
        $params = [];
        $contentLines = [];
        $append = false;
        foreach ($comment as $line) {
            $line = ltrim($line, "\t *");
            if (substr($line, 0, 1) === '@') {
                if (substr($line, 0, 5) === '@see ') {
                    $see[] = trim(substr($line, 5));
                }
                if (substr($line, 0, 5) === '@var ') {
                    $var = trim(substr($line, 5));
                }
                if (substr($line, 0, 7) === '@param ') {
                    preg_match('/^([^\$]+)\$(.+)$/', trim(substr($line, 7)), $match);
                    if (3 == count($match)) {
                        $params[trim($match[2])] = trim($match[1]);
                    }
                }
                continue;
            }

if ($append) {
                $i = count($contentLines) - 1;
                $contentLines[$i] = substr($contentLines[$i], 0, -1) . $line;
            } else {
                $contentLines[] = $line;
            }
            $append = (substr($line, -1) === '\\');
        }
        $content = trim(implode("\n", $contentLines));

return ['content' => $content, 'see' => $see, 'var' => $var, 'params' => $params];
    }
}

// ================================================================================
$refgen = new RefGenerator();

foreach ($refgen->types() as $type) {
    ob_start();

echo $refgen->preamble($type);
    foreach ($refgen->classesForType($type) as $name => $details) {
        echo $refgen->formatHeader($name, $type);
        $method = "format{$type}Details";
        echo $refgen->$method($name, $details['fqdn'], $details['filename']);
    }

file_put_contents(__DIR__ . '/reference/' . strtolower($type) . '.md', ob_get_clean());
}

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 4 × Files: 4

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
.vitepress DIR	-	drwxrwxr-x	2022-04-17 01:42:30	Edit Download recursive recursive
guide DIR	-	drwxrwxr-x	2022-04-17 01:42:30	Edit Download recursive recursive
reference DIR	-	drwxrwxr-x	2022-04-17 01:42:30	Edit Download recursive recursive
snippets DIR	-	drwxrwxr-x	2022-04-17 01:42:30	Edit Download recursive recursive
index.md	1.27 KB	lrw-rw-r--	2022-04-17 01:42:30	Edit Download recursive recursive
package.json	360 B	lrw-rw-r--	2022-04-17 01:42:30	Edit Download recursive recursive
refgen.php	9.14 KB	lrw-rw-r--	2022-04-17 01:42:30	Edit Download recursive recursive
related-projects.md	1.95 KB	lrw-rw-r--	2022-04-17 01:42:30	Edit Download recursive recursive