我想在Laravel项目中找到一个所有模型的列表,作为备份的数据库表。
我想这样做是为了构建一个仪表板,显示所有模型中的数据随时间变化的方式,即如果有用户模型,在过去90天里每天添加或修改了多少用户。
我想建议一种不同的方法,使用PHP反射,而不是依赖于所有模型都将驻留在名为Model的命名空间或目录中。
下面的代码示例收集了所有的应用程序类,验证它们是否真的扩展了Eloquent Model类并且不是抽象的。
<?php
use Illuminate'Container'Container;
use Illuminate'Database'Eloquent'Model;
use Illuminate'Support'Collection;
use Illuminate'Support'Facades'File;
function getModels(): Collection
{
$models = collect(File::allFiles(app_path()))
->map(function ($item) {
$path = $item->getRelativePathName();
$class = sprintf(''%s%s',
Container::getInstance()->getNamespace(),
strtr(substr($path, 0, strrpos($path, '.')), '/', ''''));
return $class;
})
->filter(function ($class) {
$valid = false;
if (class_exists($class)) {
$reflection = new 'ReflectionClass($class);
$valid = $reflection->isSubclassOf(Model::class) &&
!$reflection->isAbstract();
}
return $valid;
});
return $models->values();
}
我会浏览您的文件系统,并从模型文件夹中取出所有php文件。我把我的模型放在app/models文件夹中,所以像这样:
$path = app_path() . "/Models";
function getModels($path){
$out = [];
$results = scandir($path);
foreach ($results as $result) {
if ($result === '.' or $result === '..') continue;
$filename = $path . '/' . $result;
if (is_dir($filename)) {
$out = array_merge($out, getModels($filename));
}else{
$out[] = substr($filename,0,-4);
}
}
return $out;
}
dd(getModels($path));
我刚试过这个,它吐出了我所有模型的完整文件路径。如果你想要的是名称空间和模型名称,你可以去掉字符串,使其只显示名称空间和型号名称。
请注意,这可能会错过引导过程中未在范围内的模型。请参阅下面的编辑
有一种方法可以加载声明的模型,而无需迭代文件系统。由于大多数模型都是在引导后声明的,因此您可以调用get_declared_classes
并过滤模型名称空间的返回,如下所示(我的类在'App'Models
名称空间中):
$models = collect(get_declared_classes())->filter(function ($item) {
return (substr($item, 0, 11) === 'App'Models''');
});
正如@ChronoFish所提到的,这种方法并不是在所有情况下都能调出所有模型。
例如,这在引导生命周期的早期阶段根本不起作用,就像在服务提供商中一样。但即使在工作时,它也可能会错过一些模型,这取决于项目的结构,因为并非所有的类都在范围内。对于我的测试项目,所有模型都已加载,但在更复杂的应用程序中,可能会遗漏大量的类。
感谢您的评论!
我目前正在使用这样的东西:
$appNamespace = Illuminate'Container'Container::getInstance()->getNamespace();
$modelNamespace = 'Models';
$models = collect(File::allFiles(app_path($modelNamespace)))->map(function ($item) use ($appNamespace, $modelNamespace) {
$rel = $item->getRelativePathName();
$class = sprintf(''%s%s%s', $appNamespace, $modelNamespace ? $modelNamespace . '''' : '',
implode('''', explode('/', substr($rel, 0, strrpos($rel, '.')))));
return class_exists($class) ? $class : null;
})->filter();
$modelNamespace
适用于那些为其模型具有不同文件夹和命名空间的人,这是强烈建议的,或者那些使用Laravel 8+的人,其中这是新的默认值。那些只使用Laravel 7或更低版本默认值的人可以将其留空,但随后会拉入应用程序目录中的所有类,而不仅仅是Eloquent模型。
在这种情况下,你可以确保你只通过如下过滤列表来获得型号:
$models->filter(
function ($model) {
return !is_subclass_of($model, Illuminate'Database'Eloquent'Model::class);
}
);
我一直在寻找可读的东西,所以,我编写了这段代码,可以获取所有模型的名称,并可以根据需要设置格式。
<?php
function getModelNames(): array
{
$path = app_path('Models') . '/*.php';
return collect(glob($path))->map(fn ($file) => basename($file, '.php'))->toArray();
}
根据主题答案:
<?php
use Illuminate'Support'Facades'File;
/**
* Get Available models in app.
*
* @return array $models
*/
public static function getAvailableModels()
{
$models = [];
$modelsPath = app_path('Models');
$modelFiles = File::allFiles($modelsPath);
foreach ($modelFiles as $modelFile) {
$models[] = ''App''' . $modelFile->getFilenameWithoutExtension();
}
return $models;
}
一种方法是使用Standard PHP Library (SPL)
递归地列出目录中的所有文件,您可以制作如下函数。
function getModels($path, $namespace){
$out = [];
$iterator = new 'RecursiveIteratorIterator(
new 'RecursiveDirectoryIterator(
$path
), 'RecursiveIteratorIterator::SELF_FIRST
);
foreach ($iterator as $item) {
/**
* @var 'SplFileInfo $item
*/
if($item->isReadable() && $item->isFile() && mb_strtolower($item->getExtension()) === 'php'){
$out[] = $namespace .
str_replace("/", "''", mb_substr($item->getRealPath(), mb_strlen($path), -4));
}
}
return $out;
}
getModels(app_path("Models/"), "App''Models''");
您也可以尝试解决问题:
https://gist.github.com/mohammad425/231242958edb640601108bdea7bcf9ac
这是我的解决方案。不打算在子文件夹中搜索模型。
<?php
use Illuminate'Database'Eloquent'Model;
function getModels(?string $path = null): array
{
$path = $path ?? app_path();
// Se obtienen los archivos en el directorio, sin subdirectorios.
$files = File::files($path);
// Se obtienen los nombres sin rutas ni extensiones.
$filenames = array_map(function ($file): string {
$pathinfo = pathinfo($file);
return $pathinfo['filename'];
}, $files);
$namespace = "'App";
// Se conservan aquellos que sean modelos.
$mapped = array_map(
function ($filename) use ($namespace): ?string {
$class = "{$namespace}''{$filename}";
if (!class_exists($class)) {
return null;
}
$object = new $class;
if (!$object instanceof Model) {
return null;
}
return $class;
},
$filenames
);
// Se filtran los que no son modelos.
$models = array_filter($mapped);
return array_values($models);
}
我认为这更好更简单(不使用反射类)
function get_all_models(): array
{
$namespace = app()->getNamespace() . "Models''";
$files = File::allFiles(app_path('Models'));
return collect($files)
->map(function (SplFileInfo $file) use ($namespace) {
$filePath = str_replace('.' . $file->getExtension(), '', $file->getRelativePathname());
return $namespace . str_replace('/', '''', $filePath);
})
->filter(function ($class) {
return class_exists($class) && is_subclass_of($class, Model::class);
})->values()->toArray();
}