nystudio107 / craft-units

src/helpers/ClassMapGenerator.php

<?php
/*

You must use "/**" style comments for a file comment

 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace nystudio107\units\helpers;

/**
 * ClassMapGenerator.
 *
 * @author Gyula Sallai <salla016@gmail.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ClassMapGenerator
{
    /**
     * Generate a class map file.
     *
     * @param array|string $dirs Directories or a single path to search in
     * @param string $file The name of the class map file

Expected 7 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public static function dump($dirs, $file)
    {
        $dirs = (array)$dirs;
        $maps = [];
        foreach ($dirs as $dir) {
            $maps = array_merge($maps, static::createMap($dir));
        }
        file_put_contents($file, sprintf('<?php return %s;', var_export($maps, true)));
    }

    /**
     * Iterate over all files in the given directory searching for classes.
     *
     * @param \Iterator|string $dir The directory to search in or an iterator
     *
     * @return array A class map array
     */
    public static function createMap($dir): array
    {
        if (\is_string($dir)) {
            $dir = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($dir));
        }
        $map = [];
        /** @var \Iterator $dir */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        foreach ($dir as $file) {
            if (!$file->isFile()) {
                continue;
            }
            $path = $file->getRealPath() ?: $file->getPathname();
            if ('php' !== pathinfo($path, PATHINFO_EXTENSION)) {
                continue;
            }
            $classes = self::findClasses($path);
            if (\PHP_VERSION_ID >= 70000) {
                // PHP 7 memory manager will not release after token_get_all(), see https://bugs.php.net/70098
                gc_mem_caches();
            }
            foreach ($classes as $class) {
                $map[$class] = $path;
            }
        }

        return $map;
    }

    /**
     * Extract the classes in the given file.
     *
     * @param string $path The file to check
     *
     * @return array The found classes
     */
    private static function findClasses($path): array

Private method name "ClassMapGenerator::findClasses" must be prefixed with an underscore

    {
        $contents = file_get_contents($path);
        $tokens = token_get_all($contents);
        $classes = [];
        $namespace = '';
        for ($i = 0; isset($tokens[$i]); ++$i) {
            $token = $tokens[$i];
            if (!isset($token[1])) {
                continue;
            }
            $class = '';
            switch ($token[0]) {
                case T_NAMESPACE:

Line indented incorrectly; expected 12 spaces, found 16

                    $namespace = '';
                    // If there is a namespace, extract it
                    while (isset($tokens[++$i][1])) {

Line indented incorrectly; expected 16 spaces, found 20

                        if (PHP_MAJOR_VERSION >= 8) {

Line indented incorrectly; expected 20 spaces, found 24

                            if (\in_array($tokens[$i][0], [T_NAME_QUALIFIED], false)) {

Line indented incorrectly; expected 24 spaces, found 28

                                $namespace .= $tokens[$i][1];
                            }

Line indented incorrectly; expected 24 spaces, found 28

                        } else {

Line indented incorrectly; expected 20 spaces, found 24

                            if (\in_array($tokens[$i][0], [T_STRING, T_NS_SEPARATOR], false)) {

Line indented incorrectly; expected 24 spaces, found 28

                                $namespace .= $tokens[$i][1];
                            }

Line indented incorrectly; expected 24 spaces, found 28

                        }

Line indented incorrectly; expected 20 spaces, found 24

                    }

Line indented incorrectly; expected 16 spaces, found 20

                    $namespace .= '\\';
                    break;
                case T_CLASS:

Line indented incorrectly; expected 12 spaces, found 16

                case T_INTERFACE:

Line indented incorrectly; expected 12 spaces, found 16

                case T_TRAIT:

Line indented incorrectly; expected 12 spaces, found 16

                    // Skip usage of ::class constant
                    $isClassConstant = false;
                    for ($j = $i - 1; $j > 0; --$j) {

Line indented incorrectly; expected 16 spaces, found 20

                        if (!isset($tokens[$j][1])) {

Line indented incorrectly; expected 20 spaces, found 24

                            break;
                        }

Line indented incorrectly; expected 20 spaces, found 24

                        if (T_DOUBLE_COLON === $tokens[$j][0]) {

Line indented incorrectly; expected 20 spaces, found 24

                            $isClassConstant = true;
                            break;
                        } elseif (!\in_array($tokens[$j][0], [T_WHITESPACE, T_DOC_COMMENT, T_COMMENT], false)) {

Line indented incorrectly; expected 20 spaces, found 24

                            break;
                        }

Line indented incorrectly; expected 20 spaces, found 24

                    }

Line indented incorrectly; expected 16 spaces, found 20

                    if ($isClassConstant) {

Line indented incorrectly; expected 16 spaces, found 20

                        break;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    // Find the classname
                    while (isset($tokens[++$i][1])) {

Line indented incorrectly; expected 16 spaces, found 20

                        $t = $tokens[$i];
                        if (T_STRING === $t[0]) {

Line indented incorrectly; expected 20 spaces, found 24

                            $class .= $t[1];
                        } elseif ('' !== $class && T_WHITESPACE === $t[0]) {

Line indented incorrectly; expected 20 spaces, found 24

                            break;
                        }

Line indented incorrectly; expected 20 spaces, found 24

                    }

Line indented incorrectly; expected 16 spaces, found 20

                    $classes[] = ltrim($namespace . $class, '\\');
                    break;
                default:

Line indented incorrectly; expected 12 spaces, found 16

                    break;
            }
        }

        return $classes;
    }
}