StubsGenerator.php

<?php
namespace StubsGenerator;

use PhpParser\Error;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor\NameResolver;
use PhpParser\ParserFactory;
use RuntimeException;
use Symfony\Component\Finder\Finder;

/**
 * Given a collection of PHP files, this class extracts function, class,
 * interface, trait, and variable declarations, allowing them to be operated on
 * or pretty-printed.
 */
class StubsGenerator
{
    /**
     * Function symbol type.
     *
     * @var int
     */
    public const FUNCTIONS = 1;

    /**
     * Class symbol type.
     *
     * @var int
     */
    public const CLASSES = 2;

    /**
     * Trait symbol type.
     *
     * @var int
     */
    public const TRAITS = 4;

    /**
     * Interface symbol type.
     *
     * @var int
     */
    public const INTERFACES = 8;

    /**
     * Global variable symbol type; will only include global variables with a
     * doc comment.
     *
     * @var int
     */
    public const DOCUMENTED_GLOBALS = 16;

    /**
     * Global variable symbol type; will only include global variables without a
     * doc comment.
     *
     * @var int
     */
    public const UNDOCUMENTED_GLOBALS = 32;

    /**
     * Shortcut to include both documented and undocumented global variables.
     *
     * @var int
     */
    public const GLOBALS = self::DOCUMENTED_GLOBALS | self::UNDOCUMENTED_GLOBALS;

    /**
     * Constant symbol type.
     *
     * @var int
     */
    public const CONSTANTS = 64;

    /**
     * The default set of symbol types.
     *
     * @var int
     */
    public const DEFAULT = self::FUNCTIONS | self::CLASSES | self::TRAITS | self::INTERFACES | self::DOCUMENTED_GLOBALS | self::CONSTANTS;

    /**
     * Shortcut to include every symbol type.
     *
     * @var int
     */
    public const ALL = self::FUNCTIONS | self::CLASSES | self::TRAITS | self::INTERFACES | self::GLOBALS | self::CONSTANTS;

    /** @var int */
    private $symbols;
    /** @var array */
    private $config;

    /**
     * @param int $symbols Bitmask of symbol types to include in the stubs.
     */
    public function __construct(int $symbols = self::DEFAULT, array $config = [])
    {
        $this->symbols = $symbols;
        $this->config = $config;
    }

    /**
     * Iterates through all the files found by the `$finder` and returns
     * pretty-printed stubs.
     *
     * @param Finder $finder The set of files to generate (merged) stubs for.
     * @param NodeVisitor $visitor The optional node visitor to override the default.
     *
     * @return Result
     */
    public function generate(Finder $finder, NodeVisitor $visitor = null): Result
    {
        $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);

        if (!($visitor instanceof NodeVisitor)) {
            $visitor = new NodeVisitor;
        }

        $visitor->init($this->symbols, $this->config);

        $traverser = new NodeTraverser();
        $traverser->addVisitor(new NameResolver());
        $traverser->addVisitor($visitor);

        $unparsed = [];
        foreach ($finder as $file) {
            $stmts = null;
            try {
                $stmts = $parser->parse($file->getContents());
            } catch (Error|RuntimeException $e) {
                $unparsed[$file->getPathname()] = $e;
            }

            if ($stmts) {
                $traverser->traverse($stmts);
            }
        }

        return new Result($visitor, $unparsed);
    }
}