mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7917cce7c9 | ||
|
|
6627cb9587 | ||
|
|
3b03e4055d | ||
|
|
a227fca325 |
+6
-1
@@ -2,9 +2,14 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.12.1...master)
|
||||
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.12.2...master)
|
||||
--------------
|
||||
|
||||
2022-02-08, 2.12.2
|
||||
------------------
|
||||
### Fixed
|
||||
- Remove composer dependecy, use copy of ClassMapGenerator [#1313 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1313)
|
||||
|
||||
2022-01-24, 2.12.1
|
||||
------------------
|
||||
### Fixed
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
# Laravel IDE Helper Generator
|
||||
|
||||
[![Latest Version on Packagist][ico-version]][link-packagist]
|
||||
[![Software License][ico-license]](LICENSE.md)
|
||||
[![Build Status][ico-gha]][link-gha]
|
||||
[![Total Downloads][ico-downloads]][link-downloads]
|
||||
[](https://github.com/barryvdh/laravel-ide-helper/actions)
|
||||
[](http://choosealicense.com/licenses/mit/)
|
||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||
[](https://fruitcake.nl/)
|
||||
|
||||
**Complete PHPDocs, directly from the source**
|
||||
|
||||
@@ -439,10 +440,3 @@ Lumen 5.1+ will read this file for configuration parameters if it is present, an
|
||||
|
||||
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
||||
|
||||
[ico-version]: https://img.shields.io/packagist/v/barryvdh/laravel-ide-helper.svg?style=flat-square
|
||||
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
|
||||
[ico-gha]: https://github.com/barryvdh/laravel-ide-helper/workflows/Tests/badge.svg
|
||||
[ico-downloads]: https://img.shields.io/packagist/dt/barryvdh/laravel-ide-helper.svg?style=flat-square
|
||||
[link-packagist]: https://packagist.org/packages/barryvdh/laravel-ide-helper
|
||||
[link-gha]: https://github.com/barryvdh/laravel-ide-helper/actions
|
||||
[link-downloads]: https://packagist.org/packages/barryvdh/laravel-ide-helper
|
||||
|
||||
+4
-1
@@ -23,7 +23,7 @@
|
||||
"php": "^7.3 || ^8.0",
|
||||
"ext-json": "*",
|
||||
"barryvdh/reflection-docblock": "^2.0.6",
|
||||
"composer/composer": "^1.10.23 || ^2.1.9",
|
||||
"composer/pcre": "^1.0",
|
||||
"doctrine/dbal": "^2.6 || ^3",
|
||||
"illuminate/console": "^8 || ^9",
|
||||
"illuminate/filesystem": "^8 || ^9",
|
||||
@@ -58,6 +58,9 @@
|
||||
}
|
||||
},
|
||||
"config": {
|
||||
"allow-plugins": {
|
||||
"composer/package-versions-deprecated": true
|
||||
},
|
||||
"sort-packages": true
|
||||
},
|
||||
"extra": {
|
||||
|
||||
@@ -0,0 +1,415 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of Composer.
|
||||
*
|
||||
* (c) Nils Adermann <[email protected]>
|
||||
* Jordi Boggiano <[email protected]>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is copied from the Symfony package to composer/composer and then copied again here.
|
||||
*
|
||||
* (c) Fabien Potencier <[email protected]>
|
||||
*/
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper;
|
||||
|
||||
use Composer\Pcre\Preg;
|
||||
use Symfony\Component\Finder\Finder;
|
||||
|
||||
/**
|
||||
* ClassMapGenerator
|
||||
*
|
||||
* @author Gyula Sallai <[email protected]>
|
||||
* @author Jordi Boggiano <[email protected]>
|
||||
*/
|
||||
class ClassMapGenerator
|
||||
{
|
||||
/** @var array<array{name: string, length: int, pattern: non-empty-string}> */
|
||||
private static $typeConfig;
|
||||
|
||||
/** @var non-empty-string */
|
||||
private static $restPattern;
|
||||
|
||||
/**
|
||||
* Generate a class map file
|
||||
*
|
||||
* @param \Traversable<string>|array<string> $dirs Directories or a single path to search in
|
||||
* @param string $file The name of the class map file
|
||||
* @return void
|
||||
*/
|
||||
public static function dump($dirs, $file)
|
||||
{
|
||||
$maps = [];
|
||||
|
||||
foreach ($dirs as $dir) {
|
||||
$maps = array_merge($maps, static::createMap($dir));
|
||||
}
|
||||
|
||||
file_put_contents($file, sprintf('<?php return %s;', var_export($maps, true)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the given path is absolute
|
||||
*
|
||||
* @param string $path
|
||||
* @return bool
|
||||
*
|
||||
* @see \Composer\Util\Filesystem
|
||||
* @author Jordi Boggiano <[email protected]>
|
||||
* @author Johannes M. Schmitt <[email protected]>
|
||||
*/
|
||||
public static function isAbsolutePath($path)
|
||||
{
|
||||
return substr($path, 0, 1) === '/' || substr($path, 1, 1) === ':' || substr($path, 0, 2) === '\\\\';
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalize a path. This replaces backslashes with slashes, removes ending
|
||||
* slash and collapses redundant separators and up-level references.
|
||||
*
|
||||
* @param string $path Path to the file or directory
|
||||
* @return string
|
||||
*
|
||||
* @see \Composer\Util\Filesystem
|
||||
* @author Jordi Boggiano <[email protected]>
|
||||
* @author Johannes M. Schmitt <[email protected]>
|
||||
*/
|
||||
public static function normalizePath($path)
|
||||
{
|
||||
$parts = [];
|
||||
$path = strtr($path, '\\', '/');
|
||||
$prefix = '';
|
||||
$absolute = false;
|
||||
|
||||
// extract a prefix being a protocol://, protocol:, protocol://drive: or simply drive:
|
||||
if (preg_match('{^( [0-9a-z]{2,}+: (?: // (?: [a-z]: )? )? | [a-z]: )}ix', $path, $match)) {
|
||||
$prefix = $match[1];
|
||||
$path = substr($path, strlen($prefix));
|
||||
}
|
||||
|
||||
if (substr($path, 0, 1) === '/') {
|
||||
$absolute = true;
|
||||
$path = substr($path, 1);
|
||||
}
|
||||
|
||||
$up = false;
|
||||
foreach (explode('/', $path) as $chunk) {
|
||||
if ('..' === $chunk && ($absolute || $up)) {
|
||||
array_pop($parts);
|
||||
$up = !(empty($parts) || '..' === end($parts));
|
||||
} elseif ('.' !== $chunk && '' !== $chunk) {
|
||||
$parts[] = $chunk;
|
||||
$up = '..' !== $chunk;
|
||||
}
|
||||
}
|
||||
|
||||
return $prefix . ($absolute ? '/' : '') . implode('/', $parts);
|
||||
}
|
||||
|
||||
/**
|
||||
* Iterate over all files in the given directory searching for classes
|
||||
*
|
||||
* @param \Traversable<\SplFileInfo>|string|array<string> $path The path to search in or an iterator
|
||||
* @param string $excluded Regex that matches file paths to be excluded from the classmap
|
||||
* @param ?\Composer\IO\IOInterface $io IO object
|
||||
* @param ?string $namespace Optional namespace prefix to filter by
|
||||
* @param ?string $autoloadType psr-0|psr-4 Optional autoload standard to use mapping rules
|
||||
* @param array<string, true> $scannedFiles
|
||||
* @return array<class-string, string> A class map array
|
||||
* @throws \RuntimeException When the path is neither an existing file nor directory
|
||||
*/
|
||||
public static function createMap($path, $excluded = null, $io = null, $namespace = null, $autoloadType = null, &$scannedFiles = [])
|
||||
{
|
||||
$basePath = $path;
|
||||
if (is_string($path)) {
|
||||
if (is_file($path)) {
|
||||
$path = [new \SplFileInfo($path)];
|
||||
} elseif (is_dir($path) || strpos($path, '*') !== false) {
|
||||
$path = Finder::create()->files()->followLinks()->name('/\.(php|inc|hh)$/')->in($path);
|
||||
} else {
|
||||
throw new \RuntimeException(
|
||||
'Could not scan for classes inside "' . $path .
|
||||
'" which does not appear to be a file nor a folder'
|
||||
);
|
||||
}
|
||||
} elseif (null !== $autoloadType) {
|
||||
throw new \RuntimeException('Path must be a string when specifying an autoload type');
|
||||
}
|
||||
|
||||
$map = [];
|
||||
$cwd = realpath(getcwd());
|
||||
|
||||
foreach ($path as $file) {
|
||||
$filePath = $file->getPathname();
|
||||
if (!in_array(pathinfo($filePath, PATHINFO_EXTENSION), ['php', 'inc', 'hh'])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!self::isAbsolutePath($filePath)) {
|
||||
$filePath = $cwd . '/' . $filePath;
|
||||
$filePath = self::normalizePath($filePath);
|
||||
} else {
|
||||
$filePath = Preg::replace('{[\\\\/]{2,}}', '/', $filePath);
|
||||
}
|
||||
|
||||
$realPath = realpath($filePath);
|
||||
|
||||
// if a list of scanned files is given, avoid scanning twice the same file to save cycles and avoid generating warnings
|
||||
// in case a PSR-0/4 declaration follows another more specific one, or a classmap declaration, which covered this file already
|
||||
if (isset($scannedFiles[$realPath])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// check the realpath of the file against the excluded paths as the path might be a symlink and the excluded path is realpath'd so symlink are resolved
|
||||
if ($excluded && Preg::isMatch($excluded, strtr($realPath, '\\', '/'))) {
|
||||
continue;
|
||||
}
|
||||
// check non-realpath of file for directories symlink in project dir
|
||||
if ($excluded && Preg::isMatch($excluded, strtr($filePath, '\\', '/'))) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$classes = self::findClasses($filePath);
|
||||
if (null !== $autoloadType) {
|
||||
$classes = self::filterByNamespace($classes, $filePath, $namespace, $autoloadType, $basePath, $io);
|
||||
|
||||
// if no valid class was found in the file then we do not mark it as scanned as it might still be matched by another rule later
|
||||
if ($classes) {
|
||||
$scannedFiles[$realPath] = true;
|
||||
}
|
||||
} else {
|
||||
// classmap autoload rules always collect all classes so for these we definitely do not want to scan again
|
||||
$scannedFiles[$realPath] = true;
|
||||
}
|
||||
|
||||
foreach ($classes as $class) {
|
||||
// skip classes not within the given namespace prefix
|
||||
if (null === $autoloadType && null !== $namespace && '' !== $namespace && 0 !== strpos($class, $namespace)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!isset($map[$class])) {
|
||||
$map[$class] = $filePath;
|
||||
} elseif ($io && $map[$class] !== $filePath && !Preg::isMatch('{/(test|fixture|example|stub)s?/}i', strtr($map[$class] . ' ' . $filePath, '\\', '/'))) {
|
||||
$io->writeError(
|
||||
'<warning>Warning: Ambiguous class resolution, "' . $class . '"' .
|
||||
' was found in both "' . $map[$class] . '" and "' . $filePath . '", the first will be used.</warning>'
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $map;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove classes which could not have been loaded by namespace autoloaders
|
||||
*
|
||||
* @param array<int, class-string> $classes found classes in given file
|
||||
* @param string $filePath current file
|
||||
* @param string $baseNamespace prefix of given autoload mapping
|
||||
* @param string $namespaceType psr-0|psr-4
|
||||
* @param string $basePath root directory of given autoload mapping
|
||||
* @param ?\Composer\IO\IOInterface $io IO object
|
||||
* @return array<int, class-string> valid classes
|
||||
*/
|
||||
private static function filterByNamespace($classes, $filePath, $baseNamespace, $namespaceType, $basePath, $io)
|
||||
{
|
||||
$validClasses = [];
|
||||
$rejectedClasses = [];
|
||||
|
||||
$realSubPath = substr($filePath, strlen($basePath) + 1);
|
||||
$dotPosition = strrpos($realSubPath, '.');
|
||||
$realSubPath = substr($realSubPath, 0, $dotPosition === false ? PHP_INT_MAX : $dotPosition);
|
||||
|
||||
foreach ($classes as $class) {
|
||||
// silently skip if ns doesn't have common root
|
||||
if ('' !== $baseNamespace && 0 !== strpos($class, $baseNamespace)) {
|
||||
continue;
|
||||
}
|
||||
// transform class name to file path and validate
|
||||
if ('psr-0' === $namespaceType) {
|
||||
$namespaceLength = strrpos($class, '\\');
|
||||
if (false !== $namespaceLength) {
|
||||
$namespace = substr($class, 0, $namespaceLength + 1);
|
||||
$className = substr($class, $namespaceLength + 1);
|
||||
$subPath = str_replace('\\', DIRECTORY_SEPARATOR, $namespace)
|
||||
. str_replace('_', DIRECTORY_SEPARATOR, $className);
|
||||
} else {
|
||||
$subPath = str_replace('_', DIRECTORY_SEPARATOR, $class);
|
||||
}
|
||||
} elseif ('psr-4' === $namespaceType) {
|
||||
$subNamespace = ('' !== $baseNamespace) ? substr($class, strlen($baseNamespace)) : $class;
|
||||
$subPath = str_replace('\\', DIRECTORY_SEPARATOR, $subNamespace);
|
||||
} else {
|
||||
throw new \RuntimeException("namespaceType must be psr-0 or psr-4, $namespaceType given");
|
||||
}
|
||||
if ($subPath === $realSubPath) {
|
||||
$validClasses[] = $class;
|
||||
} else {
|
||||
$rejectedClasses[] = $class;
|
||||
}
|
||||
}
|
||||
// warn only if no valid classes, else silently skip invalid
|
||||
if (empty($validClasses)) {
|
||||
foreach ($rejectedClasses as $class) {
|
||||
if ($io) {
|
||||
$io->writeError("<warning>Class $class located in " . Preg::replace('{^' . preg_quote(getcwd()) . '}', '.', $filePath, 1) . " does not comply with $namespaceType autoloading standard. Skipping.</warning>");
|
||||
}
|
||||
}
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
return $validClasses;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the classes in the given file
|
||||
*
|
||||
* @param string $path The file to check
|
||||
* @throws \RuntimeException
|
||||
* @return array<int, class-string> The found classes
|
||||
*/
|
||||
private static function findClasses($path)
|
||||
{
|
||||
$extraTypes = self::getExtraTypes();
|
||||
|
||||
// Use @ here instead of Silencer to actively suppress 'unhelpful' output
|
||||
// @link https://github.com/composer/composer/pull/4886
|
||||
$contents = @php_strip_whitespace($path);
|
||||
if (!$contents) {
|
||||
if (!file_exists($path)) {
|
||||
$message = 'File at "%s" does not exist, check your classmap definitions';
|
||||
} elseif (!is_readable($path)) {
|
||||
$message = 'File at "%s" is not readable, check its permissions';
|
||||
} elseif ('' === trim((string) file_get_contents($path))) {
|
||||
// The input file was really empty and thus contains no classes
|
||||
return [];
|
||||
} else {
|
||||
$message = 'File at "%s" could not be parsed as PHP, it may be binary or corrupted';
|
||||
}
|
||||
$error = error_get_last();
|
||||
if (isset($error['message'])) {
|
||||
$message .= PHP_EOL . 'The following message may be helpful:' . PHP_EOL . $error['message'];
|
||||
}
|
||||
throw new \RuntimeException(sprintf($message, $path));
|
||||
}
|
||||
|
||||
// return early if there is no chance of matching anything in this file
|
||||
Preg::matchAll('{\b(?:class|interface|trait' . $extraTypes . ')\s}i', $contents, $matches);
|
||||
if (!$matches) {
|
||||
return [];
|
||||
}
|
||||
|
||||
// strip heredocs/nowdocs
|
||||
$contents = preg_replace('{<<<[ \t]*([\'"]?)(\w+)\\1(?:\r\n|\n|\r)(?:.*?)(?:\r\n|\n|\r)(?:\s*)\\2(?=\s+|[;,.)])}s', 'null', $contents);
|
||||
// strip strings
|
||||
$contents = preg_replace('{"[^"\\\\]*+(\\\\.[^"\\\\]*+)*+"|\'[^\'\\\\]*+(\\\\.[^\'\\\\]*+)*+\'}s', 'null', $contents);
|
||||
// strip leading non-php code if needed
|
||||
if (substr($contents, 0, 2) !== '<?') {
|
||||
$contents = preg_replace('{^.+?<\?}s', '<?', $contents, 1, $replacements);
|
||||
if ($replacements === 0) {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
// strip non-php blocks in the file
|
||||
$contents = preg_replace('{\?>(?:[^<]++|<(?!\?))*+<\?}s', '?><?', $contents);
|
||||
// strip trailing non-php code if needed
|
||||
$pos = strrpos($contents, '?>');
|
||||
if (false !== $pos && false === strpos(substr($contents, $pos), '<?')) {
|
||||
$contents = substr($contents, 0, $pos);
|
||||
}
|
||||
// strip comments if short open tags are in the file
|
||||
if (preg_match('{(<\?)(?!(php|hh))}i', $contents)) {
|
||||
$contents = preg_replace('{//.* | /\*(?:[^*]++|\*(?!/))*\*/}x', '', $contents);
|
||||
}
|
||||
|
||||
Preg::matchAll('{
|
||||
(?:
|
||||
\b(?<![\$:>])(?P<type>class|interface|trait' . $extraTypes . ') \s++ (?P<name>[a-zA-Z_\x7f-\xff:][a-zA-Z0-9_\x7f-\xff:\-]*+)
|
||||
| \b(?<![\$:>])(?P<ns>namespace) (?P<nsname>\s++[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+(?:\s*+\\\\\s*+[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+)*+)? \s*+ [\{;]
|
||||
)
|
||||
}ix', $contents, $matches);
|
||||
|
||||
$classes = [];
|
||||
$namespace = '';
|
||||
|
||||
for ($i = 0, $len = count($matches['type']); $i < $len; $i++) {
|
||||
if (!empty($matches['ns'][$i])) {
|
||||
$namespace = str_replace([' ', "\t", "\r", "\n"], '', $matches['nsname'][$i]) . '\\';
|
||||
} else {
|
||||
$name = $matches['name'][$i];
|
||||
// skip anon classes extending/implementing
|
||||
if ($name === 'extends' || $name === 'implements') {
|
||||
continue;
|
||||
}
|
||||
if ($name[0] === ':') {
|
||||
// This is an XHP class, https://github.com/facebook/xhp
|
||||
$name = 'xhp' . substr(str_replace(['-', ':'], ['_', '__'], $name), 1);
|
||||
} elseif ($matches['type'][$i] === 'enum') {
|
||||
// something like:
|
||||
// enum Foo: int { HERP = '123'; }
|
||||
// The regex above captures the colon, which isn't part of
|
||||
// the class name.
|
||||
// or:
|
||||
// enum Foo:int { HERP = '123'; }
|
||||
// The regex above captures the colon and type, which isn't part of
|
||||
// the class name.
|
||||
$colonPos = strrpos($name, ':');
|
||||
if (false !== $colonPos) {
|
||||
$name = substr($name, 0, $colonPos);
|
||||
}
|
||||
}
|
||||
$classes[] = ltrim($namespace . $name, '\\');
|
||||
}
|
||||
}
|
||||
|
||||
return $classes;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
private static function getExtraTypes()
|
||||
{
|
||||
static $extraTypes = null;
|
||||
|
||||
if (null === $extraTypes) {
|
||||
$extraTypes = '';
|
||||
if (PHP_VERSION_ID >= 80100 || (defined('HHVM_VERSION') && version_compare(HHVM_VERSION, '3.3', '>='))) {
|
||||
$extraTypes .= '|enum';
|
||||
}
|
||||
|
||||
self::setTypeConfig(array_merge(['class', 'interface', 'trait'], array_filter(explode('|', $extraTypes))));
|
||||
}
|
||||
|
||||
return $extraTypes;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string[] $types
|
||||
* @return void
|
||||
*
|
||||
* @see \Composer\Autoload\PhpFileCleaner
|
||||
* @author Jordi Boggiano <[email protected]>
|
||||
* @author Johannes M. Schmitt <[email protected]>
|
||||
*/
|
||||
private static function setTypeConfig($types)
|
||||
{
|
||||
foreach ($types as $type) {
|
||||
self::$typeConfig[$type[0]] = [
|
||||
'name' => $type,
|
||||
'length' => strlen($type),
|
||||
'pattern' => '{.\b(?<![\$:>])' . $type . '\s++[a-zA-Z_\x7f-\xff:][a-zA-Z0-9_\x7f-\xff:\-]*+}Ais',
|
||||
];
|
||||
}
|
||||
|
||||
self::$restPattern = '{[^?"\'</' . implode('', array_keys(self::$typeConfig)) . ']+}A';
|
||||
}
|
||||
}
|
||||
@@ -11,12 +11,12 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\ClassMapGenerator;
|
||||
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||
use Barryvdh\Reflection\DocBlock;
|
||||
use Barryvdh\Reflection\DocBlock\Context;
|
||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||
use Barryvdh\Reflection\DocBlock\Tag;
|
||||
use Composer\Autoload\ClassMapGenerator;
|
||||
use Doctrine\DBAL\Exception as DBALException;
|
||||
use Doctrine\DBAL\Types\Type;
|
||||
use Illuminate\Console\Command;
|
||||
|
||||
Reference in New Issue
Block a user