generate()

Complexity

Conditions	5
Paths	12

Size

Total Lines	79
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
function generate(array $options): void
{
    $timeStart = microtime(true);

    $class = $options['class'];
    $instanceVariableName = $options['instanceVariableName'];
    $outputFile = $options['outputFile'];
    $facadeName = $options['facadeName'] ?? null; // If the class has a facade we use that instead of instance variable names

    echo "\033[33mGenerating documentation for $class...\033[0m";

    $reflection = new ReflectionClass($class);

    $methods = $reflection->getMethods(ReflectionMethod::IS_PUBLIC);
    $fileName = (new ReflectionClass($class))->getFileName();

    // Remove methods defined in traits or parent classes
    $methods = array_filter($methods, function (ReflectionMethod $method) use ($fileName) {
        return $method->getFileName() === $fileName;
    });

    // Split methods into static and non-static

    $staticMethods = array_filter($methods, function (ReflectionMethod $method) {
        return $method->isStatic();
    });

    $instanceMethods = array_filter($methods, function (ReflectionMethod $method) {
        return ! $method->isStatic();
    });

    $output = [];

    // Generate static methods
    foreach ($staticMethods as $method) {
        documentMethod($method, $output, $class, $instanceVariableName, $facadeName);
    }

    // Generate instance methods
    foreach ($instanceMethods as $method) {
        documentMethod($method, $output, $class, $instanceVariableName, $facadeName);
    }

    // Assemble end time in milliseconds
    $timeEnd = microtime(true);
    $time = number_format(($timeEnd - $timeStart) * 1000, 2);
    $metadata = sprintf('Generated by HydePHP DocGen script at %s in %sms', date('Y-m-d H:i:s'), $time);

    // Join the output
    $text = implode("\n", $output);
    $startMarker = '<!-- Start generated docs for '.$class.' -->';
    $metadataMarker = "<!-- $metadata -->";
    $endMarker = '<!-- End generated docs for '.$class.' -->';
    $classKebabName = Str::kebab(class_basename($class));
    $baseName = basename($outputFile, '.md');
    $text = "<section id=\"$baseName\">\n\n$startMarker\n$metadataMarker\n\n$text\n$endMarker\n\n</section>\n";

    // Run any post-processing
    $text = postProcess($text);

    // Output the documentation
    // echo $text;

    // Check if any changes were made compared to the existing file (excluding metadata markers)
    if (file_exists($outputFile)) {
        $existingFile = file_get_contents($outputFile);
        $existingFile = preg_replace('/<!-- Generated by HydePHP DocGen script at .* in .*ms -->/', '', $existingFile);
        $compareText = preg_replace('/<!-- Generated by HydePHP DocGen script at .* in .*ms -->/', '', $text);
        if ($existingFile === $compareText) {
            echo "\n\033[37mNo changes made to $outputFile\033[0m\n";

            return;
        }
    }

    // Save the documentation to a file
    file_put_contents($outputFile, $text);

    echo "\n\033[0m Convents saved to ".realpath($outputFile)."\n";
}